1133ddf18f813f3e8eab9a423b682175b6e05363
[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 "OpenSSL" "building Exim with"
1890 .cindex "GnuTLS" "building Exim with"
1891 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1892 command as per RFC 2487. It can also support clients that expect to
1893 start a TLS session immediately on connection to a non-standard port (see the
1894 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1895 line option).
1896
1897 If you want to build Exim with TLS support, you must first install either the
1898 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1899 implementing SSL.
1900
1901 .new
1902 If you do not want TLS support you should set
1903 .code
1904 DISABLE_TLS=yes
1905 .endd
1906 in &_Local/Makefile_&.
1907 .wen
1908
1909 If OpenSSL is installed, you should set
1910 .code
1911 USE_OPENSL=yes
1912 TLS_LIBS=-lssl -lcrypto
1913 .endd
1914 in &_Local/Makefile_&. You may also need to specify the locations of the
1915 OpenSSL library and include files. For example:
1916 .code
1917 USE_OPENSL=yes
1918 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1919 TLS_INCLUDE=-I/usr/local/openssl/include/
1920 .endd
1921 .cindex "pkg-config" "OpenSSL"
1922 If you have &'pkg-config'& available, then instead you can just use:
1923 .code
1924 USE_OPENSL=yes
1925 USE_OPENSSL_PC=openssl
1926 .endd
1927 .cindex "USE_GNUTLS"
1928 If GnuTLS is installed, you should set
1929 .code
1930 USE_GNUTLS=yes
1931 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1932 .endd
1933 in &_Local/Makefile_&, and again you may need to specify the locations of the
1934 library and include files. For example:
1935 .code
1936 USE_GNUTLS=yes
1937 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1938 TLS_INCLUDE=-I/usr/gnu/include
1939 .endd
1940 .cindex "pkg-config" "GnuTLS"
1941 If you have &'pkg-config'& available, then instead you can just use:
1942 .code
1943 USE_GNUTLS=yes
1944 USE_GNUTLS_PC=gnutls
1945 .endd
1946
1947 You do not need to set TLS_INCLUDE if the relevant directory is already
1948 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1949 given in chapter &<<CHAPTLS>>&.
1950
1951
1952
1953
1954 .section "Use of tcpwrappers" "SECID27"
1955
1956 .cindex "tcpwrappers, building Exim to support"
1957 .cindex "USE_TCP_WRAPPERS"
1958 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1959 .cindex "tcp_wrappers_daemon_name"
1960 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1961 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1962 alternative to Exim's own checking facilities for installations that are
1963 already making use of &'tcpwrappers'& for other purposes. To do this, you
1964 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1965 &_tcpd.h_& to be available at compile time, and also ensure that the library
1966 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1967 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1968 you might have
1969 .code
1970 USE_TCP_WRAPPERS=yes
1971 CFLAGS=-O -I/usr/local/include
1972 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1973 .endd
1974 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1975 files is &"exim"&. For example, the line
1976 .code
1977 exim : LOCAL  192.168.1.  .friendly.domain.example
1978 .endd
1979 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1980 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1981 All other connections are denied. The daemon name used by &'tcpwrappers'&
1982 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1983 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1984 configure file. Consult the &'tcpwrappers'& documentation for
1985 further details.
1986
1987
1988 .section "Including support for IPv6" "SECID28"
1989 .cindex "IPv6" "including support for"
1990 Exim contains code for use on systems that have IPv6 support. Setting
1991 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1992 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1993 where the IPv6 support is not fully integrated into the normal include and
1994 library files.
1995
1996 Two different types of DNS record for handling IPv6 addresses have been
1997 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1998 currently seen as the mainstream. Another record type called A6 was proposed
1999 as better than AAAA because it had more flexibility. However, it was felt to be
2000 over-complex, and its status was reduced to &"experimental"&.
2001 Exim used to
2002 have a compile option for including A6 record support but this has now been
2003 withdrawn.
2004
2005
2006
2007 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2008 .cindex "lookup modules"
2009 .cindex "dynamic modules"
2010 .cindex ".so building"
2011 On some platforms, Exim supports not compiling all lookup types directly into
2012 the main binary, instead putting some into external modules which can be loaded
2013 on demand.
2014 This permits packagers to build Exim with support for lookups with extensive
2015 library dependencies without requiring all users to install all of those
2016 dependencies.
2017 Most, but not all, lookup types can be built this way.
2018
2019 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2020 installed; Exim will only load modules from that directory, as a security
2021 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2022 for your OS; see &_OS/Makefile-Linux_& for an example.
2023 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2024 see &_src/EDITME_& for details.
2025
2026 Then, for each module to be loaded dynamically, define the relevant
2027 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2028 For example, this will build in lsearch but load sqlite and mysql support
2029 on demand:
2030 .code
2031 LOOKUP_LSEARCH=yes
2032 LOOKUP_SQLITE=2
2033 LOOKUP_MYSQL=2
2034 .endd
2035
2036
2037 .section "The building process" "SECID29"
2038 .cindex "build directory"
2039 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2040 created, run &'make'& at the top level. It determines the architecture and
2041 operating system types, and creates a build directory if one does not exist.
2042 For example, on a Sun system running Solaris 8, the directory
2043 &_build-SunOS5-5.8-sparc_& is created.
2044 .cindex "symbolic link" "to source files"
2045 Symbolic links to relevant source files are installed in the build directory.
2046
2047 If this is the first time &'make'& has been run, it calls a script that builds
2048 a make file inside the build directory, using the configuration files from the
2049 &_Local_& directory. The new make file is then passed to another instance of
2050 &'make'&. This does the real work, building a number of utility scripts, and
2051 then compiling and linking the binaries for the Exim monitor (if configured), a
2052 number of utility programs, and finally Exim itself. The command &`make
2053 makefile`& can be used to force a rebuild of the make file in the build
2054 directory, should this ever be necessary.
2055
2056 If you have problems building Exim, check for any comments there may be in the
2057 &_README_& file concerning your operating system, and also take a look at the
2058 FAQ, where some common problems are covered.
2059
2060
2061
2062 .section 'Output from &"make"&' "SECID283"
2063 The output produced by the &'make'& process for compile lines is often very
2064 unreadable, because these lines can be very long. For this reason, the normal
2065 output is suppressed by default, and instead output similar to that which
2066 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2067 each module that is being compiled or linked. However, it is still possible to
2068 get the full output, by calling &'make'& like this:
2069 .code
2070 FULLECHO='' make -e
2071 .endd
2072 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2073 command reflection in &'make'&. When you ask for the full output, it is
2074 given in addition to the short output.
2075
2076
2077
2078 .section "Overriding build-time options for Exim" "SECToverride"
2079 .cindex "build-time options, overriding"
2080 The main make file that is created at the beginning of the building process
2081 consists of the concatenation of a number of files which set configuration
2082 values, followed by a fixed set of &'make'& instructions. If a value is set
2083 more than once, the last setting overrides any previous ones. This provides a
2084 convenient way of overriding defaults. The files that are concatenated are, in
2085 order:
2086 .display
2087 &_OS/Makefile-Default_&
2088 &_OS/Makefile-_&<&'ostype'&>
2089 &_Local/Makefile_&
2090 &_Local/Makefile-_&<&'ostype'&>
2091 &_Local/Makefile-_&<&'archtype'&>
2092 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2093 &_OS/Makefile-Base_&
2094 .endd
2095 .cindex "&_Local/Makefile_&"
2096 .cindex "building Exim" "operating system type"
2097 .cindex "building Exim" "architecture type"
2098 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2099 architecture type. &_Local/Makefile_& is required to exist, and the building
2100 process fails if it is absent. The other three &_Local_& files are optional,
2101 and are often not needed.
2102
2103 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2104 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2105 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2106 values are used, thereby providing a means of forcing particular settings.
2107 Otherwise, the scripts try to get values from the &%uname%& command. If this
2108 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2109 of &'ad hoc'& transformations are then applied, to produce the standard names
2110 that Exim expects. You can run these scripts directly from the shell in order
2111 to find out what values are being used on your system.
2112
2113
2114 &_OS/Makefile-Default_& contains comments about the variables that are set
2115 therein. Some (but not all) are mentioned below. If there is something that
2116 needs changing, review the contents of this file and the contents of the make
2117 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2118 default values are.
2119
2120
2121 .cindex "building Exim" "overriding default settings"
2122 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2123 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2124 need to change the original files. Instead, you should make the changes by
2125 putting the new values in an appropriate &_Local_& file. For example,
2126 .cindex "Tru64-Unix build-time settings"
2127 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2128 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2129 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2130 called with the option &%-std1%&, to make it recognize some of the features of
2131 Standard C that Exim uses. (Most other compilers recognize Standard C by
2132 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2133 containing the lines
2134 .code
2135 CC=cc
2136 CFLAGS=-std1
2137 .endd
2138 If you are compiling for just one operating system, it may be easier to put
2139 these lines directly into &_Local/Makefile_&.
2140
2141 Keeping all your local configuration settings separate from the distributed
2142 files makes it easy to transfer them to new versions of Exim simply by copying
2143 the contents of the &_Local_& directory.
2144
2145
2146 .cindex "NIS lookup type" "including support for"
2147 .cindex "NIS+ lookup type" "including support for"
2148 .cindex "LDAP" "including support for"
2149 .cindex "lookup" "inclusion in binary"
2150 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2151 lookup, but not all systems have these components installed, so the default is
2152 not to include the relevant code in the binary. All the different kinds of file
2153 and database lookup that Exim supports are implemented as separate code modules
2154 which are included only if the relevant compile-time options are set. In the
2155 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2156 .code
2157 LOOKUP_LDAP=yes
2158 LOOKUP_NIS=yes
2159 LOOKUP_NISPLUS=yes
2160 .endd
2161 and similar settings apply to the other lookup types. They are all listed in
2162 &_src/EDITME_&. In many cases the relevant include files and interface
2163 libraries need to be installed before compiling Exim.
2164 .cindex "cdb" "including support for"
2165 However, there are some optional lookup types (such as cdb) for which
2166 the code is entirely contained within Exim, and no external include
2167 files or libraries are required. When a lookup type is not included in the
2168 binary, attempts to configure Exim to use it cause runtime configuration
2169 errors.
2170
2171 .cindex "pkg-config" "lookups"
2172 .cindex "pkg-config" "authenticators"
2173 Many systems now use a tool called &'pkg-config'& to encapsulate information
2174 about how to compile against a library; Exim has some initial support for
2175 being able to use pkg-config for lookups and authenticators.  For any given
2176 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2177 variable with the &`_PC`& suffix in the name and assign as the value the
2178 name of the package to be queried.  The results of querying via the
2179 &'pkg-config'& command will be added to the appropriate Makefile variables
2180 with &`+=`& directives, so your version of &'make'& will need to support that
2181 syntax.  For instance:
2182 .code
2183 LOOKUP_SQLITE=yes
2184 LOOKUP_SQLITE_PC=sqlite3
2185 AUTH_GSASL=yes
2186 AUTH_GSASL_PC=libgsasl
2187 AUTH_HEIMDAL_GSSAPI=yes
2188 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2189 .endd
2190
2191 .cindex "Perl" "including support for"
2192 Exim can be linked with an embedded Perl interpreter, allowing Perl
2193 subroutines to be called during string expansion. To enable this facility,
2194 .code
2195 EXIM_PERL=perl.o
2196 .endd
2197 must be defined in &_Local/Makefile_&. Details of this facility are given in
2198 chapter &<<CHAPperl>>&.
2199
2200 .cindex "X11 libraries, location of"
2201 The location of the X11 libraries is something that varies a lot between
2202 operating systems, and there may be different versions of X11 to cope
2203 with. Exim itself makes no use of X11, but if you are compiling the Exim
2204 monitor, the X11 libraries must be available.
2205 The following three variables are set in &_OS/Makefile-Default_&:
2206 .code
2207 X11=/usr/X11R6
2208 XINCLUDE=-I$(X11)/include
2209 XLFLAGS=-L$(X11)/lib
2210 .endd
2211 These are overridden in some of the operating-system configuration files. For
2212 example, in &_OS/Makefile-SunOS5_& there is
2213 .code
2214 X11=/usr/openwin
2215 XINCLUDE=-I$(X11)/include
2216 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2217 .endd
2218 If you need to override the default setting for your operating system, place a
2219 definition of all three of these variables into your
2220 &_Local/Makefile-<ostype>_& file.
2221
2222 .cindex "EXTRALIBS"
2223 If you need to add any extra libraries to the link steps, these can be put in a
2224 variable called EXTRALIBS, which appears in all the link commands, but by
2225 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2226 command for linking the main Exim binary, and not for any associated utilities.
2227
2228 .cindex "DBM libraries" "configuration for building"
2229 There is also DBMLIB, which appears in the link commands for binaries that
2230 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2231 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2232 binary, and which can be used, for example, to include additional X11
2233 libraries.
2234
2235 .cindex "configuration file" "editing"
2236 The make file copes with rebuilding Exim correctly if any of the configuration
2237 files are edited. However, if an optional configuration file is deleted, it is
2238 necessary to touch the associated non-optional file (that is,
2239 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2240
2241
2242 .section "OS-specific header files" "SECID30"
2243 .cindex "&_os.h_&"
2244 .cindex "building Exim" "OS-specific C header files"
2245 The &_OS_& directory contains a number of files with names of the form
2246 &_os.h-<ostype>_&. These are system-specific C header files that should not
2247 normally need to be changed. There is a list of macro settings that are
2248 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2249 are porting Exim to a new operating system.
2250
2251
2252
2253 .section "Overriding build-time options for the monitor" "SECID31"
2254 .cindex "building Eximon"
2255 A similar process is used for overriding things when building the Exim monitor,
2256 where the files that are involved are
2257 .display
2258 &_OS/eximon.conf-Default_&
2259 &_OS/eximon.conf-_&<&'ostype'&>
2260 &_Local/eximon.conf_&
2261 &_Local/eximon.conf-_&<&'ostype'&>
2262 &_Local/eximon.conf-_&<&'archtype'&>
2263 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2264 .endd
2265 .cindex "&_Local/eximon.conf_&"
2266 As with Exim itself, the final three files need not exist, and in this case the
2267 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2268 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2269 variables of the same name, preceded by EXIMON_. For example, setting
2270 EXIMON_LOG_DEPTH in the environment overrides the value of
2271 LOG_DEPTH at runtime.
2272 .ecindex IIDbuex
2273
2274
2275 .section "Installing Exim binaries and scripts" "SECID32"
2276 .cindex "installing Exim"
2277 .cindex "BIN_DIRECTORY"
2278 The command &`make install`& runs the &(exim_install)& script with no
2279 arguments. The script copies binaries and utility scripts into the directory
2280 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2281 .cindex "setuid" "installing Exim with"
2282 The install script copies files only if they are newer than the files they are
2283 going to replace. The Exim binary is required to be owned by root and have the
2284 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2285 install`& as root so that it can set up the Exim binary in this way. However, in
2286 some special situations (for example, if a host is doing no local deliveries)
2287 it may be possible to run Exim without making the binary setuid root (see
2288 chapter &<<CHAPsecurity>>& for details).
2289
2290 .cindex "CONFIGURE_FILE"
2291 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2292 in &_Local/Makefile_&. If this names a single file, and the file does not
2293 exist, the default configuration file &_src/configure.default_& is copied there
2294 by the installation script. If a runtime configuration file already exists, it
2295 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2296 alternative files, no default is installed.
2297
2298 .cindex "system aliases file"
2299 .cindex "&_/etc/aliases_&"
2300 One change is made to the default configuration file when it is installed: the
2301 default configuration contains a router that references a system aliases file.
2302 The path to this file is set to the value specified by
2303 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2304 If the system aliases file does not exist, the installation script creates it,
2305 and outputs a comment to the user.
2306
2307 The created file contains no aliases, but it does contain comments about the
2308 aliases a site should normally have. Mail aliases have traditionally been
2309 kept in &_/etc/aliases_&. However, some operating systems are now using
2310 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2311 Exim's configuration if necessary.
2312
2313 The default configuration uses the local host's name as the only local domain,
2314 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2315 running as the local user. System aliases and &_.forward_& files in users' home
2316 directories are supported, but no NIS or NIS+ support is configured. Domains
2317 other than the name of the local host are routed using the DNS, with delivery
2318 over SMTP.
2319
2320 It is possible to install Exim for special purposes (such as building a binary
2321 distribution) in a private part of the file system. You can do this by a
2322 command such as
2323 .code
2324 make DESTDIR=/some/directory/ install
2325 .endd
2326 This has the effect of pre-pending the specified directory to all the file
2327 paths, except the name of the system aliases file that appears in the default
2328 configuration. (If a default alias file is created, its name &'is'& modified.)
2329 For backwards compatibility, ROOT is used if DESTDIR is not set,
2330 but this usage is deprecated.
2331
2332 .cindex "installing Exim" "what is not installed"
2333 Running &'make install'& does not copy the Exim 4 conversion script
2334 &'convert4r4'&. You will probably run this only once if you are
2335 upgrading from Exim 3. None of the documentation files in the &_doc_&
2336 directory are copied, except for the info files when you have set
2337 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2338
2339 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2340 to their names. The Exim binary itself, however, is handled differently. It is
2341 installed under a name that includes the version number and the compile number,
2342 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2343 called &_exim_& to point to the binary. If you are updating a previous version
2344 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2345 from the directory (as seen by other processes).
2346
2347 .cindex "installing Exim" "testing the script"
2348 If you want to see what the &'make install'& will do before running it for
2349 real, you can pass the &%-n%& option to the installation script by this
2350 command:
2351 .code
2352 make INSTALL_ARG=-n install
2353 .endd
2354 The contents of the variable INSTALL_ARG are passed to the installation
2355 script. You do not need to be root to run this test. Alternatively, you can run
2356 the installation script directly, but this must be from within the build
2357 directory. For example, from the top-level Exim directory you could use this
2358 command:
2359 .code
2360 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2361 .endd
2362 .cindex "installing Exim" "install script options"
2363 There are two other options that can be supplied to the installation script.
2364
2365 .ilist
2366 &%-no_chown%& bypasses the call to change the owner of the installed binary
2367 to root, and the call to make it a setuid binary.
2368 .next
2369 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2370 installed binary.
2371 .endlist
2372
2373 INSTALL_ARG can be used to pass these options to the script. For example:
2374 .code
2375 make INSTALL_ARG=-no_symlink install
2376 .endd
2377 The installation script can also be given arguments specifying which files are
2378 to be copied. For example, to install just the Exim binary, and nothing else,
2379 without creating the symbolic link, you could use:
2380 .code
2381 make INSTALL_ARG='-no_symlink exim' install
2382 .endd
2383
2384
2385
2386 .section "Installing info documentation" "SECTinsinfdoc"
2387 .cindex "installing Exim" "&'info'& documentation"
2388 Not all systems use the GNU &'info'& system for documentation, and for this
2389 reason, the Texinfo source of Exim's documentation is not included in the main
2390 distribution. Instead it is available separately from the FTP site (see section
2391 &<<SECTavail>>&).
2392
2393 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2394 source of the documentation is found in the source tree, running &`make
2395 install`& automatically builds the info files and installs them.
2396
2397
2398
2399 .section "Setting up the spool directory" "SECID33"
2400 .cindex "spool directory" "creating"
2401 When it starts up, Exim tries to create its spool directory if it does not
2402 exist. The Exim uid and gid are used for the owner and group of the spool
2403 directory. Sub-directories are automatically created in the spool directory as
2404 necessary.
2405
2406
2407
2408
2409 .section "Testing" "SECID34"
2410 .cindex "testing" "installation"
2411 Having installed Exim, you can check that the runtime configuration file is
2412 syntactically valid by running the following command, which assumes that the
2413 Exim binary directory is within your PATH environment variable:
2414 .code
2415 exim -bV
2416 .endd
2417 If there are any errors in the configuration file, Exim outputs error messages.
2418 Otherwise it outputs the version number and build date,
2419 the DBM library that is being used, and information about which drivers and
2420 other optional code modules are included in the binary.
2421 Some simple routing tests can be done by using the address testing option. For
2422 example,
2423 .display
2424 &`exim -bt`& <&'local username'&>
2425 .endd
2426 should verify that it recognizes a local mailbox, and
2427 .display
2428 &`exim -bt`& <&'remote address'&>
2429 .endd
2430 a remote one. Then try getting it to deliver mail, both locally and remotely.
2431 This can be done by passing messages directly to Exim, without going through a
2432 user agent. For example:
2433 .code
2434 exim -v postmaster@your.domain.example
2435 From: user@your.domain.example
2436 To: postmaster@your.domain.example
2437 Subject: Testing Exim
2438
2439 This is a test message.
2440 ^D
2441 .endd
2442 The &%-v%& option causes Exim to output some verification of what it is doing.
2443 In this case you should see copies of three log lines, one for the message's
2444 arrival, one for its delivery, and one containing &"Completed"&.
2445
2446 .cindex "delivery" "problems with"
2447 If you encounter problems, look at Exim's log files (&'mainlog'& and
2448 &'paniclog'&) to see if there is any relevant information there. Another source
2449 of information is running Exim with debugging turned on, by specifying the
2450 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2451 with debugging turned on by a command of the form
2452 .display
2453 &`exim -d -M`& <&'exim-message-id'&>
2454 .endd
2455 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2456 produces rather a lot of output, but you can cut this down to specific areas.
2457 For example, if you use &%-d-all+route%& only the debugging information
2458 relevant to routing is included. (See the &%-d%& option in chapter
2459 &<<CHAPcommandline>>& for more details.)
2460
2461 .cindex '&"sticky"& bit'
2462 .cindex "lock files"
2463 One specific problem that has shown up on some sites is the inability to do
2464 local deliveries into a shared mailbox directory, because it does not have the
2465 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2466 writing to a mailbox file, and if it cannot create the lock file, the delivery
2467 is deferred. You can get round this either by setting the &"sticky bit"& on the
2468 directory, or by setting a specific group for local deliveries and allowing
2469 that group to create files in the directory (see the comments above the
2470 &(local_delivery)& transport in the default configuration file). Another
2471 approach is to configure Exim not to use lock files, but just to rely on
2472 &[fcntl()]& locking instead. However, you should do this only if all user
2473 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2474 see chapter &<<CHAPappendfile>>&.
2475
2476 One thing that cannot be tested on a system that is already running an MTA is
2477 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2478 &%-oX%& option can be used to run an Exim daemon that listens on some other
2479 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2480 &'exim_checkaccess'& utility can be used to check out policy controls on
2481 incoming SMTP mail.
2482
2483 Testing a new version on a system that is already running Exim can most easily
2484 be done by building a binary with a different CONFIGURE_FILE setting. From
2485 within the runtime configuration, all other file and directory names
2486 that Exim uses can be altered, in order to keep it entirely clear of the
2487 production version.
2488
2489
2490 .section "Replacing another MTA with Exim" "SECID35"
2491 .cindex "replacing another MTA"
2492 Building and installing Exim for the first time does not of itself put it in
2493 general use. The name by which the system's MTA is called by mail user agents
2494 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2495 operating system), and it is necessary to make this name point to the &'exim'&
2496 binary in order to get the user agents to pass messages to Exim. This is
2497 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2498 or &_/usr/lib/sendmail_&
2499 .cindex "symbolic link" "to &'exim'& binary"
2500 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2501 privilege and executable status from the old MTA. It is then necessary to stop
2502 and restart the mailer daemon, if one is running.
2503
2504 .cindex "FreeBSD, MTA indirection"
2505 .cindex "&_/etc/mail/mailer.conf_&"
2506 Some operating systems have introduced alternative ways of switching MTAs. For
2507 example, if you are running FreeBSD, you need to edit the file
2508 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2509 described. A typical example of the contents of this file for running Exim is
2510 as follows:
2511 .code
2512 sendmail            /usr/exim/bin/exim
2513 send-mail           /usr/exim/bin/exim
2514 mailq               /usr/exim/bin/exim -bp
2515 newaliases          /usr/bin/true
2516 .endd
2517 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2518 your Exim installation is &"live"&. Check it by sending a message from your
2519 favourite user agent.
2520
2521 You should consider what to tell your users about the change of MTA. Exim may
2522 have different capabilities to what was previously running, and there are
2523 various operational differences such as the text of messages produced by
2524 command line options and in bounce messages. If you allow your users to make
2525 use of Exim's filtering capabilities, you should make the document entitled
2526 &'Exim's interface to mail filtering'& available to them.
2527
2528
2529
2530 .section "Upgrading Exim" "SECID36"
2531 .cindex "upgrading Exim"
2532 If you are already running Exim on your host, building and installing a new
2533 version automatically makes it available to MUAs, or any other programs that
2534 call the MTA directly. However, if you are running an Exim daemon, you do need
2535 .cindex restart "on HUP signal"
2536 .cindex signal "HUP, to restart"
2537 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2538 new binary. You do not need to stop processing mail in order to install a new
2539 version of Exim. The install script does not modify an existing runtime
2540 configuration file.
2541
2542
2543
2544
2545 .section "Stopping the Exim daemon on Solaris" "SECID37"
2546 .cindex "Solaris" "stopping Exim on"
2547 The standard command for stopping the mailer daemon on Solaris is
2548 .code
2549 /etc/init.d/sendmail stop
2550 .endd
2551 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2552 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2553 for the text &"sendmail"&; this is not present because the actual program name
2554 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2555 solution is to replace the line that finds the process id with something like
2556 .code
2557 pid=`cat /var/spool/exim/exim-daemon.pid`
2558 .endd
2559 to obtain the daemon's pid directly from the file that Exim saves it in.
2560
2561 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2562 still be received from local processes, and if automatic delivery is configured
2563 (the normal case), deliveries will still occur.
2564
2565
2566
2567
2568 . ////////////////////////////////////////////////////////////////////////////
2569 . ////////////////////////////////////////////////////////////////////////////
2570
2571 .chapter "The Exim command line" "CHAPcommandline"
2572 .scindex IIDclo1 "command line" "options"
2573 .scindex IIDclo2 "options" "command line"
2574 Exim's command line takes the standard Unix form of a sequence of options,
2575 each starting with a hyphen character, followed by a number of arguments. The
2576 options are compatible with the main options of Sendmail, and there are also
2577 some additional options, some of which are compatible with Smail 3. Certain
2578 combinations of options do not make sense, and provoke an error if used.
2579 The form of the arguments depends on which options are set.
2580
2581
2582 .section "Setting options by program name" "SECID38"
2583 .cindex "&'mailq'&"
2584 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2585 were present before any other options.
2586 The &%-bp%& option requests a listing of the contents of the mail queue on the
2587 standard output.
2588 This feature is for compatibility with some systems that contain a command of
2589 that name in one of the standard libraries, symbolically linked to
2590 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2591
2592 .cindex "&'rsmtp'&"
2593 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2594 were present before any other options, for compatibility with Smail. The
2595 &%-bS%& option is used for reading in a number of messages in batched SMTP
2596 format.
2597
2598 .cindex "&'rmail'&"
2599 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2600 &%-oee%& options were present before any other options, for compatibility with
2601 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2602
2603 .cindex "&'runq'&"
2604 .cindex "queue runner"
2605 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2606 were present before any other options, for compatibility with Smail. The &%-q%&
2607 option causes a single queue runner process to be started.
2608
2609 .cindex "&'newaliases'&"
2610 .cindex "alias file" "building"
2611 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2612 If Exim is called under the name &'newaliases'& it behaves as if the option
2613 &%-bi%& were present before any other options, for compatibility with Sendmail.
2614 This option is used for rebuilding Sendmail's alias file. Exim does not have
2615 the concept of a single alias file, but can be configured to run a given
2616 command if called with the &%-bi%& option.
2617
2618
2619 .section "Trusted and admin users" "SECTtrustedadmin"
2620 Some Exim options are available only to &'trusted users'& and others are
2621 available only to &'admin users'&. In the description below, the phrases &"Exim
2622 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2623 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2624 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2625
2626 .ilist
2627 .cindex "trusted users" "definition of"
2628 .cindex "user" "trusted definition of"
2629 The trusted users are root, the Exim user, any user listed in the
2630 &%trusted_users%& configuration option, and any user whose current group or any
2631 supplementary group is one of those listed in the &%trusted_groups%&
2632 configuration option. Note that the Exim group is not automatically trusted.
2633
2634 .cindex '&"From"& line'
2635 .cindex "envelope from"
2636 .cindex "envelope sender"
2637 Trusted users are always permitted to use the &%-f%& option or a leading
2638 &"From&~"& line to specify the envelope sender of a message that is passed to
2639 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2640 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2641 users to set envelope senders.
2642
2643 .cindex "&'From:'& header line"
2644 .cindex "&'Sender:'& header line"
2645 .cindex "header lines" "From:"
2646 .cindex "header lines" "Sender:"
2647 For a trusted user, there is never any check on the contents of the &'From:'&
2648 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2649 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2650
2651 Trusted users may also specify a host name, host address, interface address,
2652 protocol name, ident value, and authentication data when submitting a message
2653 locally. Thus, they are able to insert messages into Exim's queue locally that
2654 have the characteristics of messages received from a remote host. Untrusted
2655 users may in some circumstances use &%-f%&, but can never set the other values
2656 that are available to trusted users.
2657 .next
2658 .cindex "user" "admin definition of"
2659 .cindex "admin user" "definition of"
2660 The admin users are root, the Exim user, and any user that is a member of the
2661 Exim group or of any group listed in the &%admin_groups%& configuration option.
2662 The current group does not have to be one of these groups.
2663
2664 Admin users are permitted to list the queue, and to carry out certain
2665 operations on messages, for example, to force delivery failures. It is also
2666 necessary to be an admin user in order to see the full information provided by
2667 the Exim monitor, and full debugging output.
2668
2669 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2670 Exim to attempt delivery of messages on its queue is restricted to admin users.
2671 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2672 option false (that is, specifying &%no_prod_requires_admin%&).
2673
2674 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2675 is restricted to admin users unless &%queue_list_requires_admin%& is set
2676 false.
2677 .endlist
2678
2679
2680 &*Warning*&: If you configure your system so that admin users are able to
2681 edit Exim's configuration file, you are giving those users an easy way of
2682 getting root. There is further discussion of this issue at the start of chapter
2683 &<<CHAPconf>>&.
2684
2685
2686
2687
2688 .section "Command line options" "SECID39"
2689 Exim's command line options are described in alphabetical order below. If none
2690 of the options that specifies a specific action (such as starting the daemon or
2691 a queue runner, or testing an address, or receiving a message in a specific
2692 format, or listing the queue) are present, and there is at least one argument
2693 on the command line, &%-bm%& (accept a local message on the standard input,
2694 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2695 outputs a brief message about itself and exits.
2696
2697 . ////////////////////////////////////////////////////////////////////////////
2698 . Insert a stylized XML comment here, to identify the start of the command line
2699 . options. This is for the benefit of the Perl script that automatically
2700 . creates a man page for the options.
2701 . ////////////////////////////////////////////////////////////////////////////
2702
2703 .literal xml
2704 <!-- === Start of command line options === -->
2705 .literal off
2706
2707
2708 .vlist
2709 .vitem &%--%&
2710 .oindex "--"
2711 .cindex "options" "command line; terminating"
2712 This is a pseudo-option whose only purpose is to terminate the options and
2713 therefore to cause subsequent command line items to be treated as arguments
2714 rather than options, even if they begin with hyphens.
2715
2716 .vitem &%--help%&
2717 .oindex "&%--help%&"
2718 This option causes Exim to output a few sentences stating what it is.
2719 The same output is generated if the Exim binary is called with no options and
2720 no arguments.
2721
2722 .vitem &%--version%&
2723 .oindex "&%--version%&"
2724 This option is an alias for &%-bV%& and causes version information to be
2725 displayed.
2726
2727 .vitem &%-Ac%& &&&
2728        &%-Am%&
2729 .oindex "&%-Ac%&"
2730 .oindex "&%-Am%&"
2731 These options are used by Sendmail for selecting configuration files and are
2732 ignored by Exim.
2733
2734 .vitem &%-B%&<&'type'&>
2735 .oindex "&%-B%&"
2736 .cindex "8-bit characters"
2737 .cindex "Sendmail compatibility" "8-bit characters"
2738 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2739 clean; it ignores this option.
2740
2741 .vitem &%-bd%&
2742 .oindex "&%-bd%&"
2743 .cindex "daemon"
2744 .cindex "SMTP" "listener"
2745 .cindex "queue runner"
2746 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2747 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2748 that the daemon should also initiate periodic queue runs.
2749
2750 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2751 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2752 disconnect from the controlling terminal. When running this way, it can be
2753 stopped by pressing ctrl-C.
2754
2755 By default, Exim listens for incoming connections to the standard SMTP port on
2756 all the host's running interfaces. However, it is possible to listen on other
2757 ports, on multiple ports, and only on specific interfaces. Chapter
2758 &<<CHAPinterfaces>>& contains a description of the options that control this.
2759
2760 When a listening daemon
2761 .cindex "daemon" "process id (pid)"
2762 .cindex "pid (process id)" "of daemon"
2763 is started without the use of &%-oX%& (that is, without overriding the normal
2764 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2765 in Exim's spool directory. This location can be overridden by setting
2766 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2767 running as root.
2768
2769 When &%-oX%& is used on the command line to start a listening daemon, the
2770 process id is not written to the normal pid file path. However, &%-oP%& can be
2771 used to specify a path on the command line if a pid file is required.
2772
2773 The SIGHUP signal
2774 .cindex "SIGHUP"
2775 .cindex restart "on HUP signal"
2776 .cindex signal "HUP, to restart"
2777 .cindex "daemon" "restarting"
2778 .cindex signal "to reload configuration"
2779 .cindex daemon "reload configuration"
2780 .cindex reload configuration
2781 can be used to cause the daemon to re-execute itself. This should be done
2782 whenever Exim's configuration file, or any file that is incorporated into it by
2783 means of the &%.include%& facility, is changed, and also whenever a new version
2784 of Exim is installed. It is not necessary to do this when other files that are
2785 referenced from the configuration (for example, alias files) are changed,
2786 because these are reread each time they are used.
2787
2788 .vitem &%-bdf%&
2789 .oindex "&%-bdf%&"
2790 This option has the same effect as &%-bd%& except that it never disconnects
2791 from the controlling terminal, even when no debugging is specified.
2792
2793 .vitem &%-be%&
2794 .oindex "&%-be%&"
2795 .cindex "testing" "string expansion"
2796 .cindex "expansion" "testing"
2797 Run Exim in expansion testing mode. Exim discards its root privilege, to
2798 prevent ordinary users from using this mode to read otherwise inaccessible
2799 files. If no arguments are given, Exim runs interactively, prompting for lines
2800 of data. Otherwise, it processes each argument in turn.
2801
2802 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2803 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2804 used without command line arguments. If successful, it uses the &[readline()]&
2805 function, which provides extensive line-editing facilities, for reading the
2806 test data. A line history is supported.
2807
2808 Long expansion expressions can be split over several lines by using backslash
2809 continuations. As in Exim's runtime configuration, white space at the start of
2810 continuation lines is ignored. Each argument or data line is passed through the
2811 string expansion mechanism, and the result is output. Variable values from the
2812 configuration file (for example, &$qualify_domain$&) are available, but no
2813 message-specific values (such as &$message_exim_id$&) are set, because no message
2814 is being processed (but see &%-bem%& and &%-Mset%&).
2815
2816 &*Note*&: If you use this mechanism to test lookups, and you change the data
2817 files or databases you are using, you must exit and restart Exim before trying
2818 the same lookup again. Otherwise, because each Exim process caches the results
2819 of lookups, you will just get the same result as before.
2820
2821 Macro processing is done on lines before string-expansion: new macros can be
2822 defined and macros will be expanded.
2823 Because macros in the config file are often used for secrets, those are only
2824 available to admin users.
2825
2826 .vitem &%-bem%&&~<&'filename'&>
2827 .oindex "&%-bem%&"
2828 .cindex "testing" "string expansion"
2829 .cindex "expansion" "testing"
2830 This option operates like &%-be%& except that it must be followed by the name
2831 of a file. For example:
2832 .code
2833 exim -bem /tmp/testmessage
2834 .endd
2835 The file is read as a message (as if receiving a locally-submitted non-SMTP
2836 message) before any of the test expansions are done. Thus, message-specific
2837 variables such as &$message_size$& and &$header_from:$& are available. However,
2838 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2839 recipients are read from the headers in the normal way, and are shown in the
2840 &$recipients$& variable. Note that recipients cannot be given on the command
2841 line, because further arguments are taken as strings to expand (just like
2842 &%-be%&).
2843
2844 .vitem &%-bF%&&~<&'filename'&>
2845 .oindex "&%-bF%&"
2846 .cindex "system filter" "testing"
2847 .cindex "testing" "system filter"
2848 This option is the same as &%-bf%& except that it assumes that the filter being
2849 tested is a system filter. The additional commands that are available only in
2850 system filters are recognized.
2851
2852 .vitem &%-bf%&&~<&'filename'&>
2853 .oindex "&%-bf%&"
2854 .cindex "filter" "testing"
2855 .cindex "testing" "filter file"
2856 .cindex "forward file" "testing"
2857 .cindex "testing" "forward file"
2858 .cindex "Sieve filter" "testing"
2859 This option runs Exim in user filter testing mode; the file is the filter file
2860 to be tested, and a test message must be supplied on the standard input. If
2861 there are no message-dependent tests in the filter, an empty file can be
2862 supplied.
2863
2864 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2865 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2866 filter and a user filter in the same run. For example:
2867 .code
2868 exim -bF /system/filter -bf /user/filter </test/message
2869 .endd
2870 This is helpful when the system filter adds header lines or sets filter
2871 variables that are used by the user filter.
2872
2873 If the test filter file does not begin with one of the special lines
2874 .code
2875 # Exim filter
2876 # Sieve filter
2877 .endd
2878 it is taken to be a normal &_.forward_& file, and is tested for validity under
2879 that interpretation. See sections &<<SECTitenonfilred>>& to
2880 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2881 redirection lists.
2882
2883 The result of an Exim command that uses &%-bf%&, provided no errors are
2884 detected, is a list of the actions that Exim would try to take if presented
2885 with the message for real. More details of filter testing are given in the
2886 separate document entitled &'Exim's interfaces to mail filtering'&.
2887
2888 When testing a filter file,
2889 .cindex "&""From""& line"
2890 .cindex "envelope from"
2891 .cindex "envelope sender"
2892 .oindex "&%-f%&" "for filter testing"
2893 the envelope sender can be set by the &%-f%& option,
2894 or by a &"From&~"& line at the start of the test message. Various parameters
2895 that would normally be taken from the envelope recipient address of the message
2896 can be set by means of additional command line options (see the next four
2897 options).
2898
2899 .vitem &%-bfd%&&~<&'domain'&>
2900 .oindex "&%-bfd%&"
2901 .vindex "&$qualify_domain$&"
2902 This sets the domain of the recipient address when a filter file is being
2903 tested by means of the &%-bf%& option. The default is the value of
2904 &$qualify_domain$&.
2905
2906 .vitem &%-bfl%&&~<&'local&~part'&>
2907 .oindex "&%-bfl%&"
2908 This sets the local part of the recipient address when a filter file is being
2909 tested by means of the &%-bf%& option. The default is the username of the
2910 process that calls Exim. A local part should be specified with any prefix or
2911 suffix stripped, because that is how it appears to the filter when a message is
2912 actually being delivered.
2913
2914 .vitem &%-bfp%&&~<&'prefix'&>
2915 .oindex "&%-bfp%&"
2916 .cindex affix "filter testing"
2917 This sets the prefix of the local part of the recipient address when a filter
2918 file is being tested by means of the &%-bf%& option. The default is an empty
2919 prefix.
2920
2921 .vitem &%-bfs%&&~<&'suffix'&>
2922 .oindex "&%-bfs%&"
2923 .cindex affix "filter testing"
2924 This sets the suffix of the local part of the recipient address when a filter
2925 file is being tested by means of the &%-bf%& option. The default is an empty
2926 suffix.
2927
2928 .vitem &%-bh%&&~<&'IP&~address'&>
2929 .oindex "&%-bh%&"
2930 .cindex "testing" "incoming SMTP"
2931 .cindex "SMTP" "testing incoming"
2932 .cindex "testing" "relay control"
2933 .cindex "relaying" "testing configuration"
2934 .cindex "policy control" "testing"
2935 .cindex "debugging" "&%-bh%& option"
2936 This option runs a fake SMTP session as if from the given IP address, using the
2937 standard input and output. The IP address may include a port number at the end,
2938 after a full stop. For example:
2939 .code
2940 exim -bh 10.9.8.7.1234
2941 exim -bh fe80::a00:20ff:fe86:a061.5678
2942 .endd
2943 When an IPv6 address is given, it is converted into canonical form. In the case
2944 of the second example above, the value of &$sender_host_address$& after
2945 conversion to the canonical form is
2946 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2947
2948 Comments as to what is going on are written to the standard error file. These
2949 include lines beginning with &"LOG"& for anything that would have been logged.
2950 This facility is provided for testing configuration options for incoming
2951 messages, to make sure they implement the required policy. For example, you can
2952 test your relay controls using &%-bh%&.
2953
2954 &*Warning 1*&:
2955 .cindex "RFC 1413"
2956 You can test features of the configuration that rely on ident (RFC 1413)
2957 information by using the &%-oMt%& option. However, Exim cannot actually perform
2958 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2959 connection.
2960
2961 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2962 are also skipped when testing using &%-bh%&. If you want these callouts to
2963 occur, use &%-bhc%& instead.
2964
2965 Messages supplied during the testing session are discarded, and nothing is
2966 written to any of the real log files. There may be pauses when DNS (and other)
2967 lookups are taking place, and of course these may time out. The &%-oMi%& option
2968 can be used to specify a specific IP interface and port if this is important,
2969 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2970 session were authenticated.
2971
2972 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2973 output just states whether a given recipient address from a given host is
2974 acceptable or not. See section &<<SECTcheckaccess>>&.
2975
2976 Features such as authentication and encryption, where the client input is not
2977 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2978 specialized SMTP test program such as
2979 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2980
2981 .vitem &%-bhc%&&~<&'IP&~address'&>
2982 .oindex "&%-bhc%&"
2983 This option operates in the same way as &%-bh%&, except that address
2984 verification callouts are performed if required. This includes consulting and
2985 updating the callout cache database.
2986
2987 .vitem &%-bi%&
2988 .oindex "&%-bi%&"
2989 .cindex "alias file" "building"
2990 .cindex "building alias file"
2991 .cindex "Sendmail compatibility" "&%-bi%& option"
2992 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2993 Exim does not have the concept of a single alias file, and so it cannot mimic
2994 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2995 tend to appear in various scripts such as NIS make files, so the option must be
2996 recognized.
2997
2998 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2999 configuration option is run, under the uid and gid of the caller of Exim. If
3000 the &%-oA%& option is used, its value is passed to the command as an argument.
3001 The command set by &%bi_command%& may not contain arguments. The command can
3002 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3003 if this is required. If the &%bi_command%& option is not set, calling Exim with
3004 &%-bi%& is a no-op.
3005
3006 . // Keep :help first, then the rest in alphabetical order
3007 .vitem &%-bI:help%&
3008 .oindex "&%-bI:help%&"
3009 .cindex "querying exim information"
3010 We shall provide various options starting &`-bI:`& for querying Exim for
3011 information.  The output of many of these will be intended for machine
3012 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3013 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3014 options shall cause Exim to exit after producing the requested output.
3015
3016 .vitem &%-bI:dscp%&
3017 .oindex "&%-bI:dscp%&"
3018 .cindex "DSCP" "values"
3019 This option causes Exim to emit an alphabetically sorted list of all
3020 recognised DSCP names.
3021
3022 .vitem &%-bI:sieve%&
3023 .oindex "&%-bI:sieve%&"
3024 .cindex "Sieve filter" "capabilities"
3025 This option causes Exim to emit an alphabetically sorted list of all supported
3026 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3027 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3028 &`SIEVE`& capability response line.  As the precise list may depend upon
3029 compile-time build options, which this option will adapt to, this is the only
3030 way to guarantee a correct response.
3031
3032 .vitem &%-bm%&
3033 .oindex "&%-bm%&"
3034 .cindex "local message reception"
3035 This option runs an Exim receiving process that accepts an incoming,
3036 locally-generated message on the standard input. The recipients are given as the
3037 command arguments (except when &%-t%& is also present &-- see below). Each
3038 argument can be a comma-separated list of RFC 2822 addresses. This is the
3039 default option for selecting the overall action of an Exim call; it is assumed
3040 if no other conflicting option is present.
3041
3042 If any addresses in the message are unqualified (have no domain), they are
3043 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3044 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3045 suppressing this for special cases.
3046
3047 Policy checks on the contents of local messages can be enforced by means of
3048 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3049
3050 .cindex "return code" "for &%-bm%&"
3051 The return code is zero if the message is successfully accepted. Otherwise, the
3052 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3053
3054 The format
3055 .cindex "message" "format"
3056 .cindex "format" "message"
3057 .cindex "&""From""& line"
3058 .cindex "UUCP" "&""From""& line"
3059 .cindex "Sendmail compatibility" "&""From""& line"
3060 of the message must be as defined in RFC 2822, except that, for
3061 compatibility with Sendmail and Smail, a line in one of the forms
3062 .code
3063 From sender Fri Jan  5 12:55 GMT 1997
3064 From sender Fri, 5 Jan 97 12:55:01
3065 .endd
3066 (with the weekday optional, and possibly with additional text after the date)
3067 is permitted to appear at the start of the message. There appears to be no
3068 authoritative specification of the format of this line. Exim recognizes it by
3069 matching against the regular expression defined by the &%uucp_from_pattern%&
3070 option, which can be changed if necessary.
3071
3072 .oindex "&%-f%&" "overriding &""From""& line"
3073 The specified sender is treated as if it were given as the argument to the
3074 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3075 preference to the address taken from the message. The caller of Exim must be a
3076 trusted user for the sender of a message to be set in this way.
3077
3078 .vitem &%-bmalware%&&~<&'filename'&>
3079 .oindex "&%-bmalware%&"
3080 .cindex "testing", "malware"
3081 .cindex "malware scan test"
3082 This debugging option causes Exim to scan the given file or directory
3083 (depending on the used scanner interface),
3084 using the malware scanning framework.  The option of &%av_scanner%& influences
3085 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3086 the expansion should have defaults which apply to this invocation.  ACLs are
3087 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3088 will never be populated and &%-bmalware%& will fail.
3089
3090 Exim will have changed working directory before resolving the filename, so
3091 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3092 user when it tries to open the file, rather than as the invoking user.
3093 This option requires admin privileges.
3094
3095 The &%-bmalware%& option will not be extended to be more generally useful,
3096 there are better tools for file-scanning.  This option exists to help
3097 administrators verify their Exim and AV scanner configuration.
3098
3099 .vitem &%-bnq%&
3100 .oindex "&%-bnq%&"
3101 .cindex "address qualification, suppressing"
3102 By default, Exim automatically qualifies unqualified addresses (those
3103 without domains) that appear in messages that are submitted locally (that
3104 is, not over TCP/IP). This qualification applies both to addresses in
3105 envelopes, and addresses in header lines. Sender addresses are qualified using
3106 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3107 defaults to the value of &%qualify_domain%&).
3108
3109 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3110 being used to re-submit messages that originally came from remote hosts after
3111 content scanning, you probably do not want to qualify unqualified addresses in
3112 header lines. (Such lines will be present only if you have not enabled a header
3113 syntax check in the appropriate ACL.)
3114
3115 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3116 messages that originate on the local host. When this is used, unqualified
3117 addresses in the envelope provoke errors (causing message rejection) and
3118 unqualified addresses in header lines are left alone.
3119
3120
3121 .vitem &%-bP%&
3122 .oindex "&%-bP%&"
3123 .cindex "configuration options" "extracting"
3124 .cindex "options" "configuration &-- extracting"
3125 If this option is given with no arguments, it causes the values of all Exim's
3126 main configuration options to be written to the standard output. The values
3127 of one or more specific options can be requested by giving their names as
3128 arguments, for example:
3129 .code
3130 exim -bP qualify_domain hold_domains
3131 .endd
3132 .cindex "hiding configuration option values"
3133 .cindex "configuration options" "hiding value of"
3134 .cindex "options" "hiding value of"
3135 However, any option setting that is preceded by the word &"hide"& in the
3136 configuration file is not shown in full, except to an admin user. For other
3137 users, the output is as in this example:
3138 .code
3139 mysql_servers = <value not displayable>
3140 .endd
3141 If &%config%& is given as an argument, the config is
3142 output, as it was parsed, any include file resolved, any comment removed.
3143
3144 If &%config_file%& is given as an argument, the name of the runtime
3145 configuration file is output. (&%configure_file%& works too, for
3146 backward compatibility.)
3147 If a list of configuration files was supplied, the value that is output here
3148 is the name of the file that was actually used.
3149
3150 .cindex "options" "hiding name of"
3151 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3152 name will not be output.
3153
3154 .cindex "daemon" "process id (pid)"
3155 .cindex "pid (process id)" "of daemon"
3156 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3157 directories where log files and daemon pid files are written are output,
3158 respectively. If these values are unset, log files are written in a
3159 sub-directory of the spool directory called &%log%&, and the pid file is
3160 written directly into the spool directory.
3161
3162 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3163 .code
3164 exim -bP +local_domains
3165 .endd
3166 it searches for a matching named list of any type (domain, host, address, or
3167 local part) and outputs what it finds.
3168
3169 .cindex "options" "router &-- extracting"
3170 .cindex "options" "transport &-- extracting"
3171 .cindex "options" "authenticator &-- extracting"
3172 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3173 followed by the name of an appropriate driver instance, the option settings for
3174 that driver are output. For example:
3175 .code
3176 exim -bP transport local_delivery
3177 .endd
3178 The generic driver options are output first, followed by the driver's private
3179 options. A list of the names of drivers of a particular type can be obtained by
3180 using one of the words &%router_list%&, &%transport_list%&, or
3181 &%authenticator_list%&, and a complete list of all drivers with their option
3182 settings can be obtained by using &%routers%&, &%transports%&, or
3183 &%authenticators%&.
3184
3185 .cindex "environment"
3186 If &%environment%& is given as an argument, the set of environment
3187 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3188 variables.
3189
3190 .cindex "options" "macro &-- extracting"
3191 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3192 are available, similarly to the drivers.  Because macros are sometimes used
3193 for storing passwords, this option is restricted.
3194 The output format is one item per line.
3195 For the "-bP macro <name>" form, if no such macro is found
3196 the exit status will be nonzero.
3197
3198 .vitem &%-bp%&
3199 .oindex "&%-bp%&"
3200 .cindex "queue" "listing messages in"
3201 .cindex "listing" "messages in the queue"
3202 This option requests a listing of the contents of the mail queue on the
3203 standard output. If the &%-bp%& option is followed by a list of message ids,
3204 just those messages are listed. By default, this option can be used only by an
3205 admin user. However, the &%queue_list_requires_admin%& option can be set false
3206 to allow any user to see the queue.
3207
3208 Each message in the queue is displayed as in the following example:
3209 .code
3210 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3211           red.king@looking-glass.fict.example
3212           <other addresses>
3213 .endd
3214 .cindex "message" "size in queue listing"
3215 .cindex "size" "of message"
3216 The first line contains the length of time the message has been in the queue
3217 (in this case 25 minutes), the size of the message (2.9K), the unique local
3218 identifier for the message, and the message sender, as contained in the
3219 envelope. For bounce messages, the sender address is empty, and appears as
3220 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3221 the default sender address, the user's login name is shown in parentheses
3222 before the sender address.
3223
3224 .cindex "frozen messages" "in queue listing"
3225 If the message is frozen (attempts to deliver it are suspended) then the text
3226 &"*** frozen ***"& is displayed at the end of this line.
3227
3228 The recipients of the message (taken from the envelope, not the headers) are
3229 displayed on subsequent lines. Those addresses to which the message has already
3230 been delivered are marked with the letter D. If an original address gets
3231 expanded into several addresses via an alias or forward file, the original is
3232 displayed with a D only when deliveries for all of its child addresses are
3233 complete.
3234
3235
3236 .vitem &%-bpa%&
3237 .oindex "&%-bpa%&"
3238 This option operates like &%-bp%&, but in addition it shows delivered addresses
3239 that were generated from the original top level address(es) in each message by
3240 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3241 of just &"D"&.
3242
3243
3244 .vitem &%-bpc%&
3245 .oindex "&%-bpc%&"
3246 .cindex "queue" "count of messages on"
3247 This option counts the number of messages in the queue, and writes the total
3248 to the standard output. It is restricted to admin users, unless
3249 &%queue_list_requires_admin%& is set false.
3250
3251
3252 .vitem &%-bpr%&
3253 .oindex "&%-bpr%&"
3254 This option operates like &%-bp%&, but the output is not sorted into
3255 chronological order of message arrival. This can speed it up when there are
3256 lots of messages in the queue, and is particularly useful if the output is
3257 going to be post-processed in a way that doesn't need the sorting.
3258
3259 .vitem &%-bpra%&
3260 .oindex "&%-bpra%&"
3261 This option is a combination of &%-bpr%& and &%-bpa%&.
3262
3263 .vitem &%-bpru%&
3264 .oindex "&%-bpru%&"
3265 This option is a combination of &%-bpr%& and &%-bpu%&.
3266
3267
3268 .vitem &%-bpu%&
3269 .oindex "&%-bpu%&"
3270 This option operates like &%-bp%& but shows only undelivered top-level
3271 addresses for each message displayed. Addresses generated by aliasing or
3272 forwarding are not shown, unless the message was deferred after processing by a
3273 router with the &%one_time%& option set.
3274
3275
3276 .vitem &%-brt%&
3277 .oindex "&%-brt%&"
3278 .cindex "testing" "retry configuration"
3279 .cindex "retry" "configuration testing"
3280 This option is for testing retry rules, and it must be followed by up to three
3281 arguments. It causes Exim to look for a retry rule that matches the values
3282 and to write it to the standard output. For example:
3283 .code
3284 exim -brt bach.comp.mus.example
3285 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3286 .endd
3287 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3288 argument, which is required, can be a complete address in the form
3289 &'local_part@domain'&, or it can be just a domain name. If the second argument
3290 contains a dot, it is interpreted as an optional second domain name; if no
3291 retry rule is found for the first argument, the second is tried. This ties in
3292 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3293 rule is found that matches the host, one that matches the mail domain is
3294 sought. Finally, an argument that is the name of a specific delivery error, as
3295 used in setting up retry rules, can be given. For example:
3296 .code
3297 exim -brt haydn.comp.mus.example quota_3d
3298 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3299 .endd
3300
3301 .vitem &%-brw%&
3302 .oindex "&%-brw%&"
3303 .cindex "testing" "rewriting"
3304 .cindex "rewriting" "testing"
3305 This option is for testing address rewriting rules, and it must be followed by
3306 a single argument, consisting of either a local part without a domain, or a
3307 complete address with a fully qualified domain. Exim outputs how this address
3308 would be rewritten for each possible place it might appear. See chapter
3309 &<<CHAPrewrite>>& for further details.
3310
3311 .vitem &%-bS%&
3312 .oindex "&%-bS%&"
3313 .cindex "SMTP" "batched incoming"
3314 .cindex "batched SMTP input"
3315 This option is used for batched SMTP input, which is an alternative interface
3316 for non-interactive local message submission. A number of messages can be
3317 submitted in a single run. However, despite its name, this is not really SMTP
3318 input. Exim reads each message's envelope from SMTP commands on the standard
3319 input, but generates no responses. If the caller is trusted, or
3320 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3321 believed; otherwise the sender is always the caller of Exim.
3322
3323 The message itself is read from the standard input, in SMTP format (leading
3324 dots doubled), terminated by a line containing just a single dot. An error is
3325 provoked if the terminating dot is missing. A further message may then follow.
3326
3327 As for other local message submissions, the contents of incoming batch SMTP
3328 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3329 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3330 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3331
3332 Some other SMTP commands are recognized in the input. HELO and EHLO act
3333 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3334 QUIT quits, ignoring the rest of the standard input.
3335
3336 .cindex "return code" "for &%-bS%&"
3337 If any error is encountered, reports are written to the standard output and
3338 error streams, and Exim gives up immediately. The return code is 0 if no error
3339 was detected; it is 1 if one or more messages were accepted before the error
3340 was detected; otherwise it is 2.
3341
3342 More details of input using batched SMTP are given in section
3343 &<<SECTincomingbatchedSMTP>>&.
3344
3345 .vitem &%-bs%&
3346 .oindex "&%-bs%&"
3347 .cindex "SMTP" "local input"
3348 .cindex "local SMTP input"
3349 This option causes Exim to accept one or more messages by reading SMTP commands
3350 on the standard input, and producing SMTP replies on the standard output. SMTP
3351 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3352 Some user agents use this interface as a way of passing locally-generated
3353 messages to the MTA.
3354
3355 In
3356 .cindex "sender" "source of"
3357 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3358 set, the senders of messages are taken from the SMTP MAIL commands.
3359 Otherwise the content of these commands is ignored and the sender is set up as
3360 the calling user. Unqualified addresses are automatically qualified using
3361 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3362 &%-bnq%& option is used.
3363
3364 .cindex "inetd"
3365 The
3366 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3367 using a listening daemon. Exim can distinguish the two cases by checking
3368 whether the standard input is a TCP/IP socket. When Exim is called from
3369 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3370 above concerning senders and qualification do not apply. In this situation,
3371 Exim behaves in exactly the same way as it does when receiving a message via
3372 the listening daemon.
3373
3374 .vitem &%-bt%&
3375 .oindex "&%-bt%&"
3376 .cindex "testing" "addresses"
3377 .cindex "address" "testing"
3378 This option runs Exim in address testing mode, in which each argument is taken
3379 as a recipient address to be tested for deliverability. The results are
3380 written to the standard output. If a test fails, and the caller is not an admin
3381 user, no details of the failure are output, because these might contain
3382 sensitive information such as usernames and passwords for database lookups.
3383
3384 If no arguments are given, Exim runs in an interactive manner, prompting with a
3385 right angle bracket for addresses to be tested.
3386
3387 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3388 &[readline()]& function, because it is running as &'root'& and there are
3389 security issues.
3390
3391 Each address is handled as if it were the recipient address of a message
3392 (compare the &%-bv%& option). It is passed to the routers and the result is
3393 written to the standard output. However, any router that has
3394 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3395 genuine routing tests if your first router passes everything to a scanner
3396 program.
3397
3398 .cindex "return code" "for &%-bt%&"
3399 The return code is 2 if any address failed outright; it is 1 if no address
3400 failed outright but at least one could not be resolved for some reason. Return
3401 code 0 is given only when all addresses succeed.
3402
3403 .cindex "duplicate addresses"
3404 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3405 addresses after routing is complete, so that only one delivery takes place.
3406 This does not happen when testing with &%-bt%&; the full results of routing are
3407 always shown.
3408
3409 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3410 routers in the configuration makes any tests on the sender address of a
3411 message,
3412 .oindex "&%-f%&" "for address testing"
3413 you can use the &%-f%& option to set an appropriate sender when running
3414 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3415 default qualifying domain. However, if you have set up (for example) routers
3416 whose behaviour depends on the contents of an incoming message, you cannot test
3417 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3418 doing such tests.
3419
3420 .vitem &%-bV%&
3421 .oindex "&%-bV%&"
3422 .cindex "version number of Exim"
3423 This option causes Exim to write the current version number, compilation
3424 number, and compilation date of the &'exim'& binary to the standard output.
3425 It also lists the DBM library that is being used, the optional modules (such as
3426 specific lookup types), the drivers that are included in the binary, and the
3427 name of the runtime configuration file that is in use.
3428
3429 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3430 configuration file. However, this is a static check only. It cannot check
3431 values that are to be expanded. For example, although a misspelt ACL verb is
3432 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3433 alone to discover (for example) all the typos in the configuration; some
3434 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3435 dynamic testing facilities.
3436
3437 .vitem &%-bv%&
3438 .oindex "&%-bv%&"
3439 .cindex "verifying address" "using &%-bv%&"
3440 .cindex "address" "verification"
3441 This option runs Exim in address verification mode, in which each argument is
3442 taken as a recipient address to be verified by the routers. (This does
3443 not involve any verification callouts). During normal operation, verification
3444 happens mostly as a consequence processing a &%verify%& condition in an ACL
3445 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3446 including callouts, see the &%-bh%& and &%-bhc%& options.
3447
3448 If verification fails, and the caller is not an admin user, no details of the
3449 failure are output, because these might contain sensitive information such as
3450 usernames and passwords for database lookups.
3451
3452 If no arguments are given, Exim runs in an interactive manner, prompting with a
3453 right angle bracket for addresses to be verified.
3454
3455 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3456 &[readline()]& function, because it is running as &'exim'& and there are
3457 security issues.
3458
3459 Verification differs from address testing (the &%-bt%& option) in that routers
3460 that have &%no_verify%& set are skipped, and if the address is accepted by a
3461 router that has &%fail_verify%& set, verification fails. The address is
3462 verified as a recipient if &%-bv%& is used; to test verification for a sender
3463 address, &%-bvs%& should be used.
3464
3465 If the &%-v%& option is not set, the output consists of a single line for each
3466 address, stating whether it was verified or not, and giving a reason in the
3467 latter case. Without &%-v%&, generating more than one address by redirection
3468 causes verification to end successfully, without considering the generated
3469 addresses. However, if just one address is generated, processing continues,
3470 and the generated address must verify successfully for the overall verification
3471 to succeed.
3472
3473 When &%-v%& is set, more details are given of how the address has been handled,
3474 and in the case of address redirection, all the generated addresses are also
3475 considered. Verification may succeed for some and fail for others.
3476
3477 The
3478 .cindex "return code" "for &%-bv%&"
3479 return code is 2 if any address failed outright; it is 1 if no address
3480 failed outright but at least one could not be resolved for some reason. Return
3481 code 0 is given only when all addresses succeed.
3482
3483 If any of the routers in the configuration makes any tests on the sender
3484 address of a message, you should use the &%-f%& option to set an appropriate
3485 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3486 calling user at the default qualifying domain.
3487
3488 .vitem &%-bvs%&
3489 .oindex "&%-bvs%&"
3490 This option acts like &%-bv%&, but verifies the address as a sender rather
3491 than a recipient address. This affects any rewriting and qualification that
3492 might happen.
3493
3494 .vitem &%-bw%&
3495 .oindex "&%-bw%&"
3496 .cindex "daemon"
3497 .cindex "inetd"
3498 .cindex "inetd" "wait mode"
3499 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3500 similarly to the &%-bd%& option.  All port specifications on the command-line
3501 and in the configuration file are ignored.  Queue-running may not be specified.
3502
3503 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3504 listening for connections.  This permits the system to start up and have
3505 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3506 each port only when the first connection is received.
3507
3508 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3509 which the daemon will exit, which should cause inetd to listen once more.
3510
3511 .vitem &%-C%&&~<&'filelist'&>
3512 .oindex "&%-C%&"
3513 .cindex "configuration file" "alternate"
3514 .cindex "CONFIGURE_FILE"
3515 .cindex "alternate configuration file"
3516 This option causes Exim to find the runtime configuration file from the given
3517 list instead of from the list specified by the CONFIGURE_FILE
3518 compile-time setting. Usually, the list will consist of just a single filename,
3519 but it can be a colon-separated list of names. In this case, the first
3520 file that exists is used. Failure to open an existing file stops Exim from
3521 proceeding any further along the list, and an error is generated.
3522
3523 When this option is used by a caller other than root, and the list is different
3524 from the compiled-in list, Exim gives up its root privilege immediately, and
3525 runs with the real and effective uid and gid set to those of the caller.
3526 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3527 file contains a list of full pathnames, one per line, for configuration files
3528 which are trusted. Root privilege is retained for any configuration file so
3529 listed, as long as the caller is the Exim user (or the user specified in the
3530 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3531 not writeable by inappropriate users or groups.
3532
3533 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3534 configuration using &%-C%& right through message reception and delivery,
3535 even if the caller is root. The reception works, but by that time, Exim is
3536 running as the Exim user, so when it re-executes to regain privilege for the
3537 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3538 test reception and delivery using two separate commands (one to put a message
3539 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3540
3541 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3542 prefix string with which any file named in a &%-C%& command line option
3543 must start. In addition, the filename must not contain the sequence &`/../`&.
3544 However, if the value of the &%-C%& option is identical to the value of
3545 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3546 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3547 unset, any filename can be used with &%-C%&.
3548
3549 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3550 to a directory to which only root has access. This prevents someone who has
3551 broken into the Exim account from running a privileged Exim with an arbitrary
3552 configuration file.
3553
3554 The &%-C%& facility is useful for ensuring that configuration files are
3555 syntactically correct, but cannot be used for test deliveries, unless the
3556 caller is privileged, or unless it is an exotic configuration that does not
3557 require privilege. No check is made on the owner or group of the files
3558 specified by this option.
3559
3560
3561 .vitem &%-D%&<&'macro'&>=<&'value'&>
3562 .oindex "&%-D%&"
3563 .cindex "macro" "setting on command line"
3564 This option can be used to override macro definitions in the configuration file
3565 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3566 unprivileged caller, it causes Exim to give up its root privilege.
3567 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3568 completely disabled, and its use causes an immediate error exit.
3569
3570 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3571 colon-separated list of macros which are considered safe and, if &%-D%& only
3572 supplies macros from this list, and the values are acceptable, then Exim will
3573 not give up root privilege if the caller is root, the Exim run-time user, or
3574 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3575 to be removed in the future.  Acceptable values for the macros satisfy the
3576 regexp: &`^[A-Za-z0-9_/.-]*$`&
3577
3578 The entire option (including equals sign if present) must all be within one
3579 command line item. &%-D%& can be used to set the value of a macro to the empty
3580 string, in which case the equals sign is optional. These two commands are
3581 synonymous:
3582 .code
3583 exim -DABC  ...
3584 exim -DABC= ...
3585 .endd
3586 To include spaces in a macro definition item, quotes must be used. If you use
3587 quotes, spaces are permitted around the macro name and the equals sign. For
3588 example:
3589 .code
3590 exim '-D ABC = something' ...
3591 .endd
3592 &%-D%& may be repeated up to 10 times on a command line.
3593 Only macro names up to 22 letters long can be set.
3594
3595
3596 .vitem &%-d%&<&'debug&~options'&>
3597 .oindex "&%-d%&"
3598 .cindex "debugging" "list of selectors"
3599 .cindex "debugging" "&%-d%& option"
3600 This option causes debugging information to be written to the standard
3601 error stream. It is restricted to admin users because debugging output may show
3602 database queries that contain password information. Also, the details of users'
3603 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3604 writes an error message to the standard error stream and exits with a non-zero
3605 return code.
3606
3607 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3608 standard debugging data is output. This can be reduced, or increased to include
3609 some more rarely needed information, by directly following &%-d%& with a string
3610 made up of names preceded by plus or minus characters. These add or remove sets
3611 of debugging data, respectively. For example, &%-d+filter%& adds filter
3612 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3613 no spaces are allowed in the debug setting. The available debugging categories
3614 are:
3615 .display
3616 &`acl            `& ACL interpretation
3617 &`auth           `& authenticators
3618 &`deliver        `& general delivery logic
3619 &`dns            `& DNS lookups (see also resolver)
3620 &`dnsbl          `& DNS black list (aka RBL) code
3621 &`exec           `& arguments for &[execv()]& calls
3622 &`expand         `& detailed debugging for string expansions
3623 &`filter         `& filter handling
3624 &`hints_lookup   `& hints data lookups
3625 &`host_lookup    `& all types of name-to-IP address handling
3626 &`ident          `& ident lookup
3627 &`interface      `& lists of local interfaces
3628 &`lists          `& matching things in lists
3629 &`load           `& system load checks
3630 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3631                     &<<CHAPlocalscan>>&)
3632 &`lookup         `& general lookup code and all lookups
3633 &`memory         `& memory handling
3634 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3635 &`pid            `& modifier: add pid to debug output lines
3636 &`process_info   `& setting info for the process log
3637 &`queue_run      `& queue runs
3638 &`receive        `& general message reception logic
3639 &`resolver       `& turn on the DNS resolver's debugging output
3640 &`retry          `& retry handling
3641 &`rewrite        `& address rewriting
3642 &`route          `& address routing
3643 &`timestamp      `& modifier: add timestamp to debug output lines
3644 &`tls            `& TLS logic
3645 &`transport      `& transports
3646 &`uid            `& changes of uid/gid and looking up uid/gid
3647 &`verify         `& address verification logic
3648 &`all            `& almost all of the above (see below), and also &%-v%&
3649 .endd
3650 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3651 for &`-all`&. The reason for this is that &`+all`& is something that people
3652 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3653 is included, an awful lot of output that is very rarely of interest is
3654 generated, so it now has to be explicitly requested. However, &`-all`& does
3655 turn everything off.
3656
3657 .cindex "resolver, debugging output"
3658 .cindex "DNS resolver, debugging output"
3659 The &`resolver`& option produces output only if the DNS resolver was compiled
3660 with DEBUG enabled. This is not the case in some operating systems. Also,
3661 unfortunately, debugging output from the DNS resolver is written to stdout
3662 rather than stderr.
3663
3664 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3665 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3666 However, the &`pid`& selector is forced when debugging is turned on for a
3667 daemon, which then passes it on to any re-executed Exims. Exim also
3668 automatically adds the pid to debug lines when several remote deliveries are
3669 run in parallel.
3670
3671 The &`timestamp`& selector causes the current time to be inserted at the start
3672 of all debug output lines. This can be useful when trying to track down delays
3673 in processing.
3674
3675 .cindex debugging "UTF-8 in"
3676 .cindex UTF-8 "in debug output"
3677 The &`noutf8`& selector disables the use of
3678 UTF-8 line-drawing characters to group related information.
3679 When disabled. ascii-art is used instead.
3680 Using the &`+all`& option does not set this modifier,
3681
3682 If the &%debug_print%& option is set in any driver, it produces output whenever
3683 any debugging is selected, or if &%-v%& is used.
3684
3685 .vitem &%-dd%&<&'debug&~options'&>
3686 .oindex "&%-dd%&"
3687 This option behaves exactly like &%-d%& except when used on a command that
3688 starts a daemon process. In that case, debugging is turned off for the
3689 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3690 behaviour of the daemon without creating as much output as full debugging does.
3691
3692 .vitem &%-dropcr%&
3693 .oindex "&%-dropcr%&"
3694 This is an obsolete option that is now a no-op. It used to affect the way Exim
3695 handled CR and LF characters in incoming messages. What happens now is
3696 described in section &<<SECTlineendings>>&.
3697
3698 .vitem &%-E%&
3699 .oindex "&%-E%&"
3700 .cindex "bounce message" "generating"
3701 This option specifies that an incoming message is a locally-generated delivery
3702 failure report. It is used internally by Exim when handling delivery failures
3703 and is not intended for external use. Its only effect is to stop Exim
3704 generating certain messages to the postmaster, as otherwise message cascades
3705 could occur in some situations. As part of the same option, a message id may
3706 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3707 new message contains the id, following &"R="&, as a cross-reference.
3708
3709 .vitem &%-e%&&'x'&
3710 .oindex "&%-e%&&'x'&"
3711 There are a number of Sendmail options starting with &%-oe%& which seem to be
3712 called by various programs without the leading &%o%& in the option. For
3713 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3714 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3715
3716 .vitem &%-F%&&~<&'string'&>
3717 .oindex "&%-F%&"
3718 .cindex "sender" "name"
3719 .cindex "name" "of sender"
3720 This option sets the sender's full name for use when a locally-generated
3721 message is being accepted. In the absence of this option, the user's &'gecos'&
3722 entry from the password data is used. As users are generally permitted to alter
3723 their &'gecos'& entries, no security considerations are involved. White space
3724 between &%-F%& and the <&'string'&> is optional.
3725
3726 .vitem &%-f%&&~<&'address'&>
3727 .oindex "&%-f%&"
3728 .cindex "sender" "address"
3729 .cindex "address" "sender"
3730 .cindex "trusted users"
3731 .cindex "envelope from"
3732 .cindex "envelope sender"
3733 .cindex "user" "trusted"
3734 This option sets the address of the envelope sender of a locally-generated
3735 message (also known as the return path). The option can normally be used only
3736 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3737 users to use it.
3738
3739 Processes running as root or the Exim user are always trusted. Other
3740 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3741 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3742 of a local message is set to the caller's login name at the default qualify
3743 domain.
3744
3745 There is one exception to the restriction on the use of &%-f%&: an empty sender
3746 can be specified by any user, trusted or not, to create a message that can
3747 never provoke a bounce. An empty sender can be specified either as an empty
3748 string, or as a pair of angle brackets with nothing between them, as in these
3749 examples of shell commands:
3750 .code
3751 exim -f '<>' user@domain
3752 exim -f "" user@domain
3753 .endd
3754 In addition, the use of &%-f%& is not restricted when testing a filter file
3755 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3756 &%-bv%& options.
3757
3758 Allowing untrusted users to change the sender address does not of itself make
3759 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3760 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3761 though this can be overridden by setting &%no_local_from_check%&.
3762
3763 White
3764 .cindex "&""From""& line"
3765 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3766 given as two arguments or one combined argument). The sender of a
3767 locally-generated message can also be set (when permitted) by an initial
3768 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3769 if &%-f%& is also present, it overrides &"From&~"&.
3770
3771 .vitem &%-G%&
3772 .oindex "&%-G%&"
3773 .cindex "submission fixups, suppressing (command-line)"
3774 This option is equivalent to an ACL applying:
3775 .code
3776 control = suppress_local_fixups
3777 .endd
3778 for every message received.  Note that Sendmail will complain about such
3779 bad formatting, where Exim silently just does not fix it up.  This may change
3780 in future.
3781
3782 As this affects audit information, the caller must be a trusted user to use
3783 this option.
3784
3785 .vitem &%-h%&&~<&'number'&>
3786 .oindex "&%-h%&"
3787 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3788 This option is accepted for compatibility with Sendmail, but has no effect. (In
3789 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3790 headers.)
3791
3792 .vitem &%-i%&
3793 .oindex "&%-i%&"
3794 .cindex "Solaris" "&'mail'& command"
3795 .cindex "dot" "in incoming non-SMTP message"
3796 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3797 line by itself should not terminate an incoming, non-SMTP message. I can find
3798 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3799 command in Solaris 2.4 uses it. See also &%-ti%&.
3800
3801 .vitem &%-L%&&~<&'tag'&>
3802 .oindex "&%-L%&"
3803 .cindex "syslog" "process name; set with flag"
3804 This option is equivalent to setting &%syslog_processname%& in the config
3805 file and setting &%log_file_path%& to &`syslog`&.
3806 Its use is restricted to administrators.  The configuration file has to be
3807 read and parsed, to determine access rights, before this is set and takes
3808 effect, so early configuration file errors will not honour this flag.
3809
3810 The tag should not be longer than 32 characters.
3811
3812 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3813 .oindex "&%-M%&"
3814 .cindex "forcing delivery"
3815 .cindex "delivery" "forcing attempt"
3816 .cindex "frozen messages" "forcing delivery"
3817 This option requests Exim to run a delivery attempt on each message in turn. If
3818 any of the messages are frozen, they are automatically thawed before the
3819 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3820 and &%hold_domains%& are ignored.
3821
3822 Retry
3823 .cindex "hints database" "overriding retry hints"
3824 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3825 the normal retry time has not yet been reached. This option requires the caller
3826 to be an admin user. However, there is an option called &%prod_requires_admin%&
3827 which can be set false to relax this restriction (and also the same requirement
3828 for the &%-q%&, &%-R%&, and &%-S%& options).
3829
3830 The deliveries happen synchronously, that is, the original Exim process does
3831 not terminate until all the delivery attempts have finished. No output is
3832 produced unless there is a serious error. If you want to see what is happening,
3833 use the &%-v%& option as well, or inspect Exim's main log.
3834
3835 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3836 .oindex "&%-Mar%&"
3837 .cindex "message" "adding recipients"
3838 .cindex "recipient" "adding"
3839 This option requests Exim to add the addresses to the list of recipients of the
3840 message (&"ar"& for &"add recipients"&). The first argument must be a message
3841 id, and the remaining ones must be email addresses. However, if the message is
3842 active (in the middle of a delivery attempt), it is not altered. This option
3843 can be used only by an admin user.
3844
3845 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3846         &~<&'message&~id'&>"
3847 .oindex "&%-MC%&"
3848 .cindex "SMTP" "passed connection"
3849 .cindex "SMTP" "multiple deliveries"
3850 .cindex "multiple SMTP deliveries"
3851 This option is not intended for use by external callers. It is used internally
3852 by Exim to invoke another instance of itself to deliver a waiting message using
3853 an existing SMTP connection, which is passed as the standard input. Details are
3854 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3855 must be root or the Exim user in order to use it.
3856
3857 .vitem &%-MCA%&
3858 .oindex "&%-MCA%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option. It signifies that the
3861 connection to the remote host has been authenticated.
3862
3863 .vitem &%-MCD%&
3864 .oindex "&%-MCD%&"
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-MC%& option. It signifies that the
3867 remote host supports the ESMTP &_DSN_& extension.
3868
3869 .vitem &%-MCG%&&~<&'queue&~name'&>
3870 .oindex "&%-MCG%&"
3871 This option is not intended for use by external callers. It is used internally
3872 by Exim in conjunction with the &%-MC%& option. It signifies that an
3873 alternate queue is used, named by the following argument.
3874
3875 .vitem &%-MCK%&
3876 .oindex "&%-MCK%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-MC%& option. It signifies that a
3879 remote host supports the ESMTP &_CHUNKING_& extension.
3880
3881 .vitem &%-MCP%&
3882 .oindex "&%-MCP%&"
3883 This option is not intended for use by external callers. It is used internally
3884 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3885 which Exim is connected supports pipelining.
3886
3887 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3888 .oindex "&%-MCQ%&"
3889 This option is not intended for use by external callers. It is used internally
3890 by Exim in conjunction with the &%-MC%& option when the original delivery was
3891 started by a queue runner. It passes on the process id of the queue runner,
3892 together with the file descriptor number of an open pipe. Closure of the pipe
3893 signals the final completion of the sequence of processes that are passing
3894 messages through the same SMTP connection.
3895
3896 .vitem &%-MCS%&
3897 .oindex "&%-MCS%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3900 SMTP SIZE option should be used on messages delivered down the existing
3901 connection.
3902
3903 .vitem &%-MCT%&
3904 .oindex "&%-MCT%&"
3905 This option is not intended for use by external callers. It is used internally
3906 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3907 host to which Exim is connected supports TLS encryption.
3908
3909 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3910 .oindex "&%-MCt%&"
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3913 connection is being proxied by a parent process for handling TLS encryption.
3914 The arguments give the local address and port being proxied, and the TLS cipher.
3915
3916 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3917 .oindex "&%-Mc%&"
3918 .cindex "hints database" "not overridden by &%-Mc%&"
3919 .cindex "delivery" "manually started &-- not forced"
3920 This option requests Exim to run a delivery attempt on each message, in turn,
3921 but unlike the &%-M%& option, it does check for retry hints, and respects any
3922 that are found. This option is not very useful to external callers. It is
3923 provided mainly for internal use by Exim when it needs to re-invoke itself in
3924 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3925 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3926 respects retry times and other options such as &%hold_domains%& that are
3927 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3928 If you want to run a specific delivery as if in a queue run, you should use
3929 &%-q%& with a message id argument. A distinction between queue run deliveries
3930 and other deliveries is made in one or two places.
3931
3932 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3933 .oindex "&%-Mes%&"
3934 .cindex "message" "changing sender"
3935 .cindex "sender" "changing"
3936 This option requests Exim to change the sender address in the message to the
3937 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3938 &"edit sender"&). There must be exactly two arguments. The first argument must
3939 be a message id, and the second one an email address. However, if the message
3940 is active (in the middle of a delivery attempt), its status is not altered.
3941 This option can be used only by an admin user.
3942
3943 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3944 .oindex "&%-Mf%&"
3945 .cindex "freezing messages"
3946 .cindex "message" "manually freezing"
3947 This option requests Exim to mark each listed message as &"frozen"&. This
3948 prevents any delivery attempts taking place until the message is &"thawed"&,
3949 either manually or as a result of the &%auto_thaw%& configuration option.
3950 However, if any of the messages are active (in the middle of a delivery
3951 attempt), their status is not altered. This option can be used only by an admin
3952 user.
3953
3954 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3955 .oindex "&%-Mg%&"
3956 .cindex "giving up on messages"
3957 .cindex "message" "abandoning delivery attempts"
3958 .cindex "delivery" "abandoning further attempts"
3959 This option requests Exim to give up trying to deliver the listed messages,
3960 including any that are frozen. However, if any of the messages are active,
3961 their status is not altered. For non-bounce messages, a delivery error message
3962 is sent to the sender, containing the text &"cancelled by administrator"&.
3963 Bounce messages are just discarded. This option can be used only by an admin
3964 user.
3965
3966 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3967 .oindex "&%-Mmad%&"
3968 .cindex "delivery" "cancelling all"
3969 This option requests Exim to mark all the recipient addresses in the messages
3970 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3971 message is active (in the middle of a delivery attempt), its status is not
3972 altered. This option can be used only by an admin user.
3973
3974 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3975 .oindex "&%-Mmd%&"
3976 .cindex "delivery" "cancelling by address"
3977 .cindex "recipient" "removing"
3978 .cindex "removing recipients"
3979 This option requests Exim to mark the given addresses as already delivered
3980 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3981 the remaining ones must be email addresses. These are matched to recipient
3982 addresses in the message in a case-sensitive manner. If the message is active
3983 (in the middle of a delivery attempt), its status is not altered. This option
3984 can be used only by an admin user.
3985
3986 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3987 .oindex "&%-Mrm%&"
3988 .cindex "removing messages"
3989 .cindex "abandoning mail"
3990 .cindex "message" "manually discarding"
3991 This option requests Exim to remove the given messages from the queue. No
3992 bounce messages are sent; each message is simply forgotten. However, if any of
3993 the messages are active, their status is not altered. This option can be used
3994 only by an admin user or by the user who originally caused the message to be
3995 placed in the queue.
3996
3997 . .new
3998 . .vitem &%-MS%&
3999 . .oindex "&%-MS%&"
4000 . .cindex REQUIRETLS
4001 . This option is used to request REQUIRETLS processing on the message.
4002 . It is used internally by Exim in conjunction with -E when generating
4003 . a bounce message.
4004 . .wen
4005
4006 .vitem &%-Mset%&&~<&'message&~id'&>
4007 .oindex "&%-Mset%&"
4008 .cindex "testing" "string expansion"
4009 .cindex "expansion" "testing"
4010 This option is useful only in conjunction with &%-be%& (that is, when testing
4011 string expansions). Exim loads the given message from its spool before doing
4012 the test expansions, thus setting message-specific variables such as
4013 &$message_size$& and the header variables. The &$recipients$& variable is made
4014 available. This feature is provided to make it easier to test expansions that
4015 make use of these variables. However, this option can be used only by an admin
4016 user. See also &%-bem%&.
4017
4018 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4019 .oindex "&%-Mt%&"
4020 .cindex "thawing messages"
4021 .cindex "unfreezing messages"
4022 .cindex "frozen messages" "thawing"
4023 .cindex "message" "thawing frozen"
4024 This option requests Exim to &"thaw"& any of the listed messages that are
4025 &"frozen"&, so that delivery attempts can resume. However, if any of the
4026 messages are active, their status is not altered. This option can be used only
4027 by an admin user.
4028
4029 .vitem &%-Mvb%&&~<&'message&~id'&>
4030 .oindex "&%-Mvb%&"
4031 .cindex "listing" "message body"
4032 .cindex "message" "listing body of"
4033 This option causes the contents of the message body (-D) spool file to be
4034 written to the standard output. This option can be used only by an admin user.
4035
4036 .vitem &%-Mvc%&&~<&'message&~id'&>
4037 .oindex "&%-Mvc%&"
4038 .cindex "message" "listing in RFC 2822 format"
4039 .cindex "listing" "message in RFC 2822 format"
4040 This option causes a copy of the complete message (header lines plus body) to
4041 be written to the standard output in RFC 2822 format. This option can be used
4042 only by an admin user.
4043
4044 .vitem &%-Mvh%&&~<&'message&~id'&>
4045 .oindex "&%-Mvh%&"
4046 .cindex "listing" "message headers"
4047 .cindex "header lines" "listing"
4048 .cindex "message" "listing header lines"
4049 This option causes the contents of the message headers (-H) spool file to be
4050 written to the standard output. This option can be used only by an admin user.
4051
4052 .vitem &%-Mvl%&&~<&'message&~id'&>
4053 .oindex "&%-Mvl%&"
4054 .cindex "listing" "message log"
4055 .cindex "message" "listing message log"
4056 This option causes the contents of the message log spool file to be written to
4057 the standard output. This option can be used only by an admin user.
4058
4059 .vitem &%-m%&
4060 .oindex "&%-m%&"
4061 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4062 treats it that way too.
4063
4064 .vitem &%-N%&
4065 .oindex "&%-N%&"
4066 .cindex "debugging" "&%-N%& option"
4067 .cindex "debugging" "suppressing delivery"
4068 This is a debugging option that inhibits delivery of a message at the transport
4069 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4070 it just doesn't actually transport the message, but instead behaves as if it
4071 had successfully done so. However, it does not make any updates to the retry
4072 database, and the log entries for deliveries are flagged with &"*>"& rather
4073 than &"=>"&.
4074
4075 Because &%-N%& discards any message to which it applies, only root or the Exim
4076 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4077 words, an ordinary user can use it only when supplying an incoming message to
4078 which it will apply. Although transportation never fails when &%-N%& is set, an
4079 address may be deferred because of a configuration problem on a transport, or a
4080 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4081 the message, and applies to any subsequent delivery attempts that may happen
4082 for that message.
4083
4084 .vitem &%-n%&
4085 .oindex "&%-n%&"
4086 This option is interpreted by Sendmail to mean &"no aliasing"&.
4087 For normal modes of operation, it is ignored by Exim.
4088 When combined with &%-bP%& it makes the output more terse (suppresses
4089 option names, environment values and config pretty printing).
4090
4091 .vitem &%-O%&&~<&'data'&>
4092 .oindex "&%-O%&"
4093 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4094 Exim.
4095
4096 .vitem &%-oA%&&~<&'file&~name'&>
4097 .oindex "&%-oA%&"
4098 .cindex "Sendmail compatibility" "&%-oA%& option"
4099 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4100 alternative alias filename. Exim handles &%-bi%& differently; see the
4101 description above.
4102
4103 .vitem &%-oB%&&~<&'n'&>
4104 .oindex "&%-oB%&"
4105 .cindex "SMTP" "passed connection"
4106 .cindex "SMTP" "multiple deliveries"
4107 .cindex "multiple SMTP deliveries"
4108 This is a debugging option which limits the maximum number of messages that can
4109 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4110 transport. If <&'n'&> is omitted, the limit is set to 1.
4111
4112 .vitem &%-odb%&
4113 .oindex "&%-odb%&"
4114 .cindex "background delivery"
4115 .cindex "delivery" "in the background"
4116 This option applies to all modes in which Exim accepts incoming messages,
4117 including the listening daemon. It requests &"background"& delivery of such
4118 messages, which means that the accepting process automatically starts a
4119 delivery process for each message received, but does not wait for the delivery
4120 processes to finish.
4121
4122 When all the messages have been received, the reception process exits,
4123 leaving the delivery processes to finish in their own time. The standard output
4124 and error streams are closed at the start of each delivery process.
4125 This is the default action if none of the &%-od%& options are present.
4126
4127 If one of the queueing options in the configuration file
4128 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4129 overrides it if &%queue_only_override%& is set true, which is the default
4130 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4131
4132 .vitem &%-odf%&
4133 .oindex "&%-odf%&"
4134 .cindex "foreground delivery"
4135 .cindex "delivery" "in the foreground"
4136 This option requests &"foreground"& (synchronous) delivery when Exim has
4137 accepted a locally-generated message. (For the daemon it is exactly the same as
4138 &%-odb%&.) A delivery process is automatically started to deliver the message,
4139 and Exim waits for it to complete before proceeding.
4140
4141 The original Exim reception process does not finish until the delivery
4142 process for the final message has ended. The standard error stream is left open
4143 during deliveries.
4144
4145 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4146 false and one of the queueing options in the configuration file is in effect.
4147
4148 If there is a temporary delivery error during foreground delivery, the
4149 message is left in the queue for later delivery, and the original reception
4150 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4151 restricted configuration that never queues messages.
4152
4153
4154 .vitem &%-odi%&
4155 .oindex "&%-odi%&"
4156 This option is synonymous with &%-odf%&. It is provided for compatibility with
4157 Sendmail.
4158
4159 .vitem &%-odq%&
4160 .oindex "&%-odq%&"
4161 .cindex "non-immediate delivery"
4162 .cindex "delivery" "suppressing immediate"
4163 .cindex "queueing incoming messages"
4164 This option applies to all modes in which Exim accepts incoming messages,
4165 including the listening daemon. It specifies that the accepting process should
4166 not automatically start a delivery process for each message received. Messages
4167 are placed in the queue, and remain there until a subsequent queue runner
4168 process encounters them. There are several configuration options (such as
4169 &%queue_only%&) that can be used to queue incoming messages under certain
4170 conditions. This option overrides all of them and also &%-odqs%&. It always
4171 forces queueing.
4172
4173 .vitem &%-odqs%&
4174 .oindex "&%-odqs%&"
4175 .cindex "SMTP" "delaying delivery"
4176 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4177 However, like &%-odb%& and &%-odi%&, this option has no effect if
4178 &%queue_only_override%& is false and one of the queueing options in the
4179 configuration file is in effect.
4180
4181 When &%-odqs%& does operate, a delivery process is started for each incoming
4182 message, in the background by default, but in the foreground if &%-odi%& is
4183 also present. The recipient addresses are routed, and local deliveries are done
4184 in the normal way. However, if any SMTP deliveries are required, they are not
4185 done at this time, so the message remains in the queue until a subsequent queue
4186 runner process encounters it. Because routing was done, Exim knows which
4187 messages are waiting for which hosts, and so a number of messages for the same
4188 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4189 configuration option has the same effect for specific domains. See also the
4190 &%-qq%& option.
4191
4192 .vitem &%-oee%&
4193 .oindex "&%-oee%&"
4194 .cindex "error" "reporting"
4195 If an error is detected while a non-SMTP message is being received (for
4196 example, a malformed address), the error is reported to the sender in a mail
4197 message.
4198
4199 .cindex "return code" "for &%-oee%&"
4200 Provided
4201 this error message is successfully sent, the Exim receiving process
4202 exits with a return code of zero. If not, the return code is 2 if the problem
4203 is that the original message has no recipients, or 1 for any other error.
4204 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4205
4206 .vitem &%-oem%&
4207 .oindex "&%-oem%&"
4208 .cindex "error" "reporting"
4209 .cindex "return code" "for &%-oem%&"
4210 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4211 return code, whether or not the error message was successfully sent.
4212 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4213
4214 .vitem &%-oep%&
4215 .oindex "&%-oep%&"
4216 .cindex "error" "reporting"
4217 If an error is detected while a non-SMTP message is being received, the
4218 error is reported by writing a message to the standard error file (stderr).
4219 .cindex "return code" "for &%-oep%&"
4220 The return code is 1 for all errors.
4221
4222 .vitem &%-oeq%&
4223 .oindex "&%-oeq%&"
4224 .cindex "error" "reporting"
4225 This option is supported for compatibility with Sendmail, but has the same
4226 effect as &%-oep%&.
4227
4228 .vitem &%-oew%&
4229 .oindex "&%-oew%&"
4230 .cindex "error" "reporting"
4231 This option is supported for compatibility with Sendmail, but has the same
4232 effect as &%-oem%&.
4233
4234 .vitem &%-oi%&
4235 .oindex "&%-oi%&"
4236 .cindex "dot" "in incoming non-SMTP message"
4237 This option, which has the same effect as &%-i%&, specifies that a dot on a
4238 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4239 single dot does terminate, though Exim does no special processing for other
4240 lines that start with a dot. This option is set by default if Exim is called as
4241 &'rmail'&. See also &%-ti%&.
4242
4243 .vitem &%-oitrue%&
4244 .oindex "&%-oitrue%&"
4245 This option is treated as synonymous with &%-oi%&.
4246
4247 .vitem &%-oMa%&&~<&'host&~address'&>
4248 .oindex "&%-oMa%&"
4249 .cindex "sender" "host address, specifying for local message"
4250 A number of options starting with &%-oM%& can be used to set values associated
4251 with remote hosts on locally-submitted messages (that is, messages not received
4252 over TCP/IP). These options can be used by any caller in conjunction with the
4253 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4254 other circumstances, they are ignored unless the caller is trusted.
4255
4256 The &%-oMa%& option sets the sender host address. This may include a port
4257 number at the end, after a full stop (period). For example:
4258 .code
4259 exim -bs -oMa 10.9.8.7.1234
4260 .endd
4261 An alternative syntax is to enclose the IP address in square brackets,
4262 followed by a colon and the port number:
4263 .code
4264 exim -bs -oMa [10.9.8.7]:1234
4265 .endd
4266 The IP address is placed in the &$sender_host_address$& variable, and the
4267 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4268 are present on the command line, the sender host IP address is taken from
4269 whichever one is last.
4270
4271 .vitem &%-oMaa%&&~<&'name'&>
4272 .oindex "&%-oMaa%&"
4273 .cindex "authentication" "name, specifying for local message"
4274 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4275 option sets the value of &$sender_host_authenticated$& (the authenticator
4276 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4277 This option can be used with &%-bh%& and &%-bs%& to set up an
4278 authenticated SMTP session without actually using the SMTP AUTH command.
4279
4280 .vitem &%-oMai%&&~<&'string'&>
4281 .oindex "&%-oMai%&"
4282 .cindex "authentication" "id, specifying for local message"
4283 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4284 option sets the value of &$authenticated_id$& (the id that was authenticated).
4285 This overrides the default value (the caller's login id, except with &%-bh%&,
4286 where there is no default) for messages from local sources. See chapter
4287 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4288
4289 .vitem &%-oMas%&&~<&'address'&>
4290 .oindex "&%-oMas%&"
4291 .cindex "authentication" "sender, specifying for local message"
4292 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4293 option sets the authenticated sender value in &$authenticated_sender$&. It
4294 overrides the sender address that is created from the caller's login id for
4295 messages from local sources, except when &%-bh%& is used, when there is no
4296 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4297 specified on a MAIL command overrides this value. See chapter
4298 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4299
4300 .vitem &%-oMi%&&~<&'interface&~address'&>
4301 .oindex "&%-oMi%&"
4302 .cindex "interface" "address, specifying for local message"
4303 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4304 option sets the IP interface address value. A port number may be included,
4305 using the same syntax as for &%-oMa%&. The interface address is placed in
4306 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4307
4308 .vitem &%-oMm%&&~<&'message&~reference'&>
4309 .oindex "&%-oMm%&"
4310 .cindex "message reference" "message reference, specifying for local message"
4311 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4312 option sets the message reference, e.g. message-id, and is logged during
4313 delivery. This is useful when some kind of audit trail is required to tie
4314 messages together. The format of the message reference is checked and will
4315 abort if the format is invalid. The option will only be accepted if exim is
4316 running in trusted mode, not as any regular user.
4317
4318 The best example of a message reference is when Exim sends a bounce message.
4319 The message reference is the message-id of the original message for which Exim
4320 is sending the bounce.
4321
4322 .vitem &%-oMr%&&~<&'protocol&~name'&>
4323 .oindex "&%-oMr%&"
4324 .cindex "protocol, specifying for local message"
4325 .vindex "&$received_protocol$&"
4326 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4327 option sets the received protocol value that is stored in
4328 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4329 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4330 SMTP protocol names (see the description of &$received_protocol$& in section
4331 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4332 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4333 be set by &%-oMr%&. Repeated use of this option is not supported.
4334
4335 .vitem &%-oMs%&&~<&'host&~name'&>
4336 .oindex "&%-oMs%&"
4337 .cindex "sender" "host name, specifying for local message"
4338 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4339 option sets the sender host name in &$sender_host_name$&. When this option is
4340 present, Exim does not attempt to look up a host name from an IP address; it
4341 uses the name it is given.
4342
4343 .vitem &%-oMt%&&~<&'ident&~string'&>
4344 .oindex "&%-oMt%&"
4345 .cindex "sender" "ident string, specifying for local message"
4346 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4347 option sets the sender ident value in &$sender_ident$&. The default setting for
4348 local callers is the login id of the calling process, except when &%-bh%& is
4349 used, when there is no default.
4350
4351 .vitem &%-om%&
4352 .oindex "&%-om%&"
4353 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4354 In Sendmail, this option means &"me too"&, indicating that the sender of a
4355 message should receive a copy of the message if the sender appears in an alias
4356 expansion. Exim always does this, so the option does nothing.
4357
4358 .vitem &%-oo%&
4359 .oindex "&%-oo%&"
4360 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4361 This option is ignored. In Sendmail it specifies &"old style headers"&,
4362 whatever that means.
4363
4364 .vitem &%-oP%&&~<&'path'&>
4365 .oindex "&%-oP%&"
4366 .cindex "pid (process id)" "of daemon"
4367 .cindex "daemon" "process id (pid)"
4368 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4369 value. The option specifies the file to which the process id of the daemon is
4370 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4371 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4372 because in those cases, the normal pid file is not used.
4373
4374 .vitem &%-or%&&~<&'time'&>
4375 .oindex "&%-or%&"
4376 .cindex "timeout" "for non-SMTP input"
4377 This option sets a timeout value for incoming non-SMTP messages. If it is not
4378 set, Exim will wait forever for the standard input. The value can also be set
4379 by the &%receive_timeout%& option. The format used for specifying times is
4380 described in section &<<SECTtimeformat>>&.
4381
4382 .vitem &%-os%&&~<&'time'&>
4383 .oindex "&%-os%&"
4384 .cindex "timeout" "for SMTP input"
4385 .cindex "SMTP" "input timeout"
4386 This option sets a timeout value for incoming SMTP messages. The timeout
4387 applies to each SMTP command and block of data. The value can also be set by
4388 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4389 for specifying times is described in section &<<SECTtimeformat>>&.
4390
4391 .vitem &%-ov%&
4392 .oindex "&%-ov%&"
4393 This option has exactly the same effect as &%-v%&.
4394
4395 .vitem &%-oX%&&~<&'number&~or&~string'&>
4396 .oindex "&%-oX%&"
4397 .cindex "TCP/IP" "setting listening ports"
4398 .cindex "TCP/IP" "setting listening interfaces"
4399 .cindex "port" "receiving TCP/IP"
4400 This option is relevant only when the &%-bd%& (start listening daemon) option
4401 is also given. It controls which ports and interfaces the daemon uses. Details
4402 of the syntax, and how it interacts with configuration file options, are given
4403 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4404 file is written unless &%-oP%& is also present to specify a pid filename.
4405
4406 .vitem &%-pd%&
4407 .oindex "&%-pd%&"
4408 .cindex "Perl" "starting the interpreter"
4409 This option applies when an embedded Perl interpreter is linked with Exim (see
4410 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4411 option, forcing the starting of the interpreter to be delayed until it is
4412 needed.
4413
4414 .vitem &%-ps%&
4415 .oindex "&%-ps%&"
4416 .cindex "Perl" "starting the interpreter"
4417 This option applies when an embedded Perl interpreter is linked with Exim (see
4418 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4419 option, forcing the starting of the interpreter to occur as soon as Exim is
4420 started.
4421
4422 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4423 .oindex "&%-p%&"
4424 For compatibility with Sendmail, this option is equivalent to
4425 .display
4426 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4427 .endd
4428 It sets the incoming protocol and host name (for trusted callers). The
4429 host name and its colon can be omitted when only the protocol is to be set.
4430 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4431 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4432 or &`s`& using this option (but that does not seem a real limitation).
4433 Repeated use of this option is not supported.
4434
4435 .vitem &%-q%&
4436 .oindex "&%-q%&"
4437 .cindex "queue runner" "starting manually"
4438 This option is normally restricted to admin users. However, there is a
4439 configuration option called &%prod_requires_admin%& which can be set false to
4440 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4441 and &%-S%& options).
4442
4443 .cindex "queue runner" "description of operation"
4444 If other commandline options do not specify an action,
4445 the &%-q%& option starts one queue runner process. This scans the queue of
4446 waiting messages, and runs a delivery process for each one in turn. It waits
4447 for each delivery process to finish before starting the next one. A delivery
4448 process may not actually do any deliveries if the retry times for the addresses
4449 have not been reached. Use &%-qf%& (see below) if you want to override this.
4450
4451 If
4452 .cindex "SMTP" "passed connection"
4453 .cindex "SMTP" "multiple deliveries"
4454 .cindex "multiple SMTP deliveries"
4455 the delivery process spawns other processes to deliver other messages down
4456 passed SMTP connections, the queue runner waits for these to finish before
4457 proceeding.
4458
4459 When all the queued messages have been considered, the original queue runner
4460 process terminates. In other words, a single pass is made over the waiting
4461 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4462 this to be repeated periodically.
4463
4464 Exim processes the waiting messages in an unpredictable order. It isn't very
4465 random, but it is likely to be different each time, which is all that matters.
4466 If one particular message screws up a remote MTA, other messages to the same
4467 MTA have a chance of getting through if they get tried first.
4468
4469 It is possible to cause the messages to be processed in lexical message id
4470 order, which is essentially the order in which they arrived, by setting the
4471 &%queue_run_in_order%& option, but this is not recommended for normal use.
4472
4473 .vitem &%-q%&<&'qflags'&>
4474 The &%-q%& option may be followed by one or more flag letters that change its
4475 behaviour. They are all optional, but if more than one is present, they must
4476 appear in the correct order. Each flag is described in a separate item below.
4477
4478 .vitem &%-qq...%&
4479 .oindex "&%-qq%&"
4480 .cindex "queue" "double scanning"
4481 .cindex "queue" "routing"
4482 .cindex "routing" "whole queue before delivery"
4483 An option starting with &%-qq%& requests a two-stage queue run. In the first
4484 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4485 every domain. Addresses are routed, local deliveries happen, but no remote
4486 transports are run.
4487
4488 .cindex "hints database" "remembering routing"
4489 The hints database that remembers which messages are waiting for specific hosts
4490 is updated, as if delivery to those hosts had been deferred. After this is
4491 complete, a second, normal queue scan happens, with routing and delivery taking
4492 place as normal. Messages that are routed to the same host should mostly be
4493 delivered down a single SMTP
4494 .cindex "SMTP" "passed connection"
4495 .cindex "SMTP" "multiple deliveries"
4496 .cindex "multiple SMTP deliveries"
4497 connection because of the hints that were set up during the first queue scan.
4498 This option may be useful for hosts that are connected to the Internet
4499 intermittently.
4500
4501 .vitem &%-q[q]i...%&
4502 .oindex "&%-qi%&"
4503 .cindex "queue" "initial delivery"
4504 If the &'i'& flag is present, the queue runner runs delivery processes only for
4505 those messages that haven't previously been tried. (&'i'& stands for &"initial
4506 delivery"&.) This can be helpful if you are putting messages in the queue using
4507 &%-odq%& and want a queue runner just to process the new messages.
4508
4509 .vitem &%-q[q][i]f...%&
4510 .oindex "&%-qf%&"
4511 .cindex "queue" "forcing delivery"
4512 .cindex "delivery" "forcing in queue run"
4513 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4514 message, whereas without &'f'& only those non-frozen addresses that have passed
4515 their retry times are tried.
4516
4517 .vitem &%-q[q][i]ff...%&
4518 .oindex "&%-qff%&"
4519 .cindex "frozen messages" "forcing delivery"
4520 If &'ff'& is present, a delivery attempt is forced for every message, whether
4521 frozen or not.
4522
4523 .vitem &%-q[q][i][f[f]]l%&
4524 .oindex "&%-ql%&"
4525 .cindex "queue" "local deliveries only"
4526 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4527 be done. If a message requires any remote deliveries, it remains in the queue
4528 for later delivery.
4529
4530 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4531 .oindex "&%-qG%&"
4532 .cindex queue named
4533 .cindex "named queues"
4534 .cindex "queue" "delivering specific messages"
4535 If the &'G'& flag and a name is present, the queue runner operates on the
4536 queue with the given name rather than the default queue.
4537 The name should not contain a &'/'& character.
4538 For a periodic queue run (see below)
4539 append to the name a slash and a time value.
4540
4541 If other commandline options specify an action, a &'-qG<name>'& option
4542 will specify a queue to operate on.
4543 For example:
4544 .code
4545 exim -bp -qGquarantine
4546 mailq -qGquarantine
4547 exim -qGoffpeak -Rf @special.domain.example
4548 .endd
4549
4550 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4551 When scanning the queue, Exim can be made to skip over messages whose ids are
4552 lexically less than a given value by following the &%-q%& option with a
4553 starting message id. For example:
4554 .code
4555 exim -q 0t5C6f-0000c8-00
4556 .endd
4557 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4558 second message id is given, messages whose ids are lexically greater than it
4559 are also skipped. If the same id is given twice, for example,
4560 .code
4561 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4562 .endd
4563 just one delivery process is started, for that message. This differs from
4564 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4565 that it counts as a delivery from a queue run. Note that the selection
4566 mechanism does not affect the order in which the messages are scanned. There
4567 are also other ways of selecting specific sets of messages for delivery in a
4568 queue run &-- see &%-R%& and &%-S%&.
4569
4570 .vitem &%-q%&<&'qflags'&><&'time'&>
4571 .cindex "queue runner" "starting periodically"
4572 .cindex "periodic queue running"
4573 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4574 starting a queue runner process at intervals specified by the given time value
4575 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4576 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4577 single daemon process handles both functions. A common way of starting up a
4578 combined daemon at system boot time is to use a command such as
4579 .code
4580 /usr/exim/bin/exim -bd -q30m
4581 .endd
4582 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4583 process every 30 minutes.
4584
4585 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4586 pid file is written unless one is explicitly requested by the &%-oP%& option.
4587
4588 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4589 .oindex "&%-qR%&"
4590 This option is synonymous with &%-R%&. It is provided for Sendmail
4591 compatibility.
4592
4593 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4594 .oindex "&%-qS%&"
4595 This option is synonymous with &%-S%&.
4596
4597 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4598 .oindex "&%-R%&"
4599 .cindex "queue runner" "for specific recipients"
4600 .cindex "delivery" "to given domain"
4601 .cindex "domain" "delivery to"
4602 The <&'rsflags'&> may be empty, in which case the white space before the string
4603 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4604 which are the possible values for <&'rsflags'&>. White space is required if
4605 <&'rsflags'&> is not empty.
4606
4607 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4608 perform a single queue run, except that, when scanning the messages on the
4609 queue, Exim processes only those that have at least one undelivered recipient
4610 address containing the given string, which is checked in a case-independent
4611 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4612 regular expression; otherwise it is a literal string.
4613
4614 If you want to do periodic queue runs for messages with specific recipients,
4615 you can combine &%-R%& with &%-q%& and a time value. For example:
4616 .code
4617 exim -q25m -R @special.domain.example
4618 .endd
4619 This example does a queue run for messages with recipients in the given domain
4620 every 25 minutes. Any additional flags that are specified with &%-q%& are
4621 applied to each queue run.
4622
4623 Once a message is selected for delivery by this mechanism, all its addresses
4624 are processed. For the first selected message, Exim overrides any retry
4625 information and forces a delivery attempt for each undelivered address. This
4626 means that if delivery of any address in the first message is successful, any
4627 existing retry information is deleted, and so delivery attempts for that
4628 address in subsequently selected messages (which are processed without forcing)
4629 will run. However, if delivery of any address does not succeed, the retry
4630 information is updated, and in subsequently selected messages, the failing
4631 address will be skipped.
4632
4633 .cindex "frozen messages" "forcing delivery"
4634 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4635 all selected messages, not just the first; frozen messages are included when
4636 &'ff'& is present.
4637
4638 The &%-R%& option makes it straightforward to initiate delivery of all messages
4639 to a given domain after a host has been down for some time. When the SMTP
4640 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4641 effect is to run Exim with the &%-R%& option, but it can be configured to run
4642 an arbitrary command instead.
4643
4644 .vitem &%-r%&
4645 .oindex "&%-r%&"
4646 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4647
4648 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4649 .oindex "&%-S%&"
4650 .cindex "delivery" "from given sender"
4651 .cindex "queue runner" "for specific senders"
4652 This option acts like &%-R%& except that it checks the string against each
4653 message's sender instead of against the recipients. If &%-R%& is also set, both
4654 conditions must be met for a message to be selected. If either of the options
4655 has &'f'& or &'ff'& in its flags, the associated action is taken.
4656
4657 .vitem &%-Tqt%&&~<&'times'&>
4658 .oindex "&%-Tqt%&"
4659 This is an option that is exclusively for use by the Exim testing suite. It is not
4660 recognized when Exim is run normally. It allows for the setting up of explicit
4661 &"queue times"& so that various warning/retry features can be tested.
4662
4663 .vitem &%-t%&
4664 .oindex "&%-t%&"
4665 .cindex "recipient" "extracting from header lines"
4666 .cindex "&'Bcc:'& header line"
4667 .cindex "&'Cc:'& header line"
4668 .cindex "&'To:'& header line"
4669 When Exim is receiving a locally-generated, non-SMTP message on its standard
4670 input, the &%-t%& option causes the recipients of the message to be obtained
4671 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4672 from the command arguments. The addresses are extracted before any rewriting
4673 takes place and the &'Bcc:'& header line, if present, is then removed.
4674
4675 .cindex "Sendmail compatibility" "&%-t%& option"
4676 If the command has any arguments, they specify addresses to which the message
4677 is &'not'& to be delivered. That is, the argument addresses are removed from
4678 the recipients list obtained from the headers. This is compatible with Smail 3
4679 and in accordance with the documented behaviour of several versions of
4680 Sendmail, as described in man pages on a number of operating systems (e.g.
4681 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4682 argument addresses to those obtained from the headers, and the O'Reilly
4683 Sendmail book documents it that way. Exim can be made to add argument addresses
4684 instead of subtracting them by setting the option
4685 &%extract_addresses_remove_arguments%& false.
4686
4687 .cindex "&%Resent-%& header lines" "with &%-t%&"
4688 If there are any &%Resent-%& header lines in the message, Exim extracts
4689 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4690 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4691 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4692 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4693
4694 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4695 message is resent several times). The RFC also specifies that they should be
4696 added at the front of the message, and separated by &'Received:'& lines. It is
4697 not at all clear how &%-t%& should operate in the present of multiple sets,
4698 nor indeed exactly what constitutes a &"set"&.
4699 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4700 are often added at the end of the header, and if a message is resent more than
4701 once, it is common for the original set of &%Resent-%& headers to be renamed as
4702 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4703
4704 .vitem &%-ti%&
4705 .oindex "&%-ti%&"
4706 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4707 compatibility with Sendmail.
4708
4709 .vitem &%-tls-on-connect%&
4710 .oindex "&%-tls-on-connect%&"
4711 .cindex "TLS" "use without STARTTLS"
4712 .cindex "TLS" "automatic start"
4713 This option is available when Exim is compiled with TLS support. It forces all
4714 incoming SMTP connections to behave as if the incoming port is listed in the
4715 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4716 &<<CHAPTLS>>& for further details.
4717
4718
4719 .vitem &%-U%&
4720 .oindex "&%-U%&"
4721 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4722 Sendmail uses this option for &"initial message submission"&, and its
4723 documentation states that in future releases, it may complain about
4724 syntactically invalid messages rather than fixing them when this flag is not
4725 set. Exim ignores this option.
4726
4727 .vitem &%-v%&
4728 .oindex "&%-v%&"
4729 This option causes Exim to write information to the standard error stream,
4730 describing what it is doing. In particular, it shows the log lines for
4731 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4732 dialogue is shown. Some of the log lines shown may not actually be written to
4733 the log if the setting of &%log_selector%& discards them. Any relevant
4734 selectors are shown with each log line. If none are shown, the logging is
4735 unconditional.
4736
4737 .vitem &%-x%&
4738 .oindex "&%-x%&"
4739 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4740 National Language Support extended characters in the body of the mail item"&).
4741 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4742 this option.
4743
4744 .vitem &%-X%&&~<&'logfile'&>
4745 .oindex "&%-X%&"
4746 This option is interpreted by Sendmail to cause debug information to be sent
4747 to the named file.  It is ignored by Exim.
4748
4749 .vitem &%-z%&&~<&'log-line'&>
4750 .oindex "&%-z%&"
4751 This option writes its argument to Exim's logfile.
4752 Use is restricted to administrators; the intent is for operational notes.
4753 Quotes should be used to maintain a multi-word item as a single argument,
4754 under most shells.
4755 .endlist
4756
4757 .ecindex IIDclo1
4758 .ecindex IIDclo2
4759
4760
4761 . ////////////////////////////////////////////////////////////////////////////
4762 . Insert a stylized DocBook comment here, to identify the end of the command
4763 . line options. This is for the benefit of the Perl script that automatically
4764 . creates a man page for the options.
4765 . ////////////////////////////////////////////////////////////////////////////
4766
4767 .literal xml
4768 <!-- === End of command line options === -->
4769 .literal off
4770
4771
4772
4773
4774
4775 . ////////////////////////////////////////////////////////////////////////////
4776 . ////////////////////////////////////////////////////////////////////////////
4777
4778
4779 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4780          "The runtime configuration file"
4781
4782 .cindex "runtime configuration"
4783 .cindex "configuration file" "general description"
4784 .cindex "CONFIGURE_FILE"
4785 .cindex "configuration file" "errors in"
4786 .cindex "error" "in configuration file"
4787 .cindex "return code" "for bad configuration"
4788 Exim uses a single runtime configuration file that is read whenever an Exim
4789 binary is executed. Note that in normal operation, this happens frequently,
4790 because Exim is designed to operate in a distributed manner, without central
4791 control.
4792
4793 If a syntax error is detected while reading the configuration file, Exim
4794 writes a message on the standard error, and exits with a non-zero return code.
4795 The message is also written to the panic log. &*Note*&: Only simple syntax
4796 errors can be detected at this time. The values of any expanded options are
4797 not checked until the expansion happens, even when the expansion does not
4798 actually alter the string.
4799
4800 The name of the configuration file is compiled into the binary for security
4801 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4802 most configurations, this specifies a single file. However, it is permitted to
4803 give a colon-separated list of filenames, in which case Exim uses the first
4804 existing file in the list.
4805
4806 .cindex "EXIM_USER"
4807 .cindex "EXIM_GROUP"
4808 .cindex "CONFIGURE_OWNER"
4809 .cindex "CONFIGURE_GROUP"
4810 .cindex "configuration file" "ownership"
4811 .cindex "ownership" "configuration file"
4812 The runtime configuration file must be owned by root or by the user that is
4813 specified at compile time by the CONFIGURE_OWNER option (if set). The
4814 configuration file must not be world-writeable, or group-writeable unless its
4815 group is the root group or the one specified at compile time by the
4816 CONFIGURE_GROUP option.
4817
4818 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4819 to root, anybody who is able to edit the runtime configuration file has an
4820 easy way to run commands as root. If you specify a user or group in the
4821 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4822 who are members of that group will trivially be able to obtain root privileges.
4823
4824 Up to Exim version 4.72, the runtime configuration file was also permitted to
4825 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4826 since it offered a simple privilege escalation for any attacker who managed to
4827 compromise the Exim user account.
4828
4829 A default configuration file, which will work correctly in simple situations,
4830 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4831 defines just one filename, the installation process copies the default
4832 configuration to a new file of that name if it did not previously exist. If
4833 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4834 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4835 configuration.
4836
4837
4838
4839 .section "Using a different configuration file" "SECID40"
4840 .cindex "configuration file" "alternate"
4841 A one-off alternate configuration can be specified by the &%-C%& command line
4842 option, which may specify a single file or a list of files. However, when
4843 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4844 unless the argument for &%-C%& is identical to the built-in value from
4845 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4846 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4847 is useful mainly for checking the syntax of configuration files before
4848 installing them. No owner or group checks are done on a configuration file
4849 specified by &%-C%&, if root privilege has been dropped.
4850
4851 Even the Exim user is not trusted to specify an arbitrary configuration file
4852 with the &%-C%& option to be used with root privileges, unless that file is
4853 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4854 testing a configuration using &%-C%& right through message reception and
4855 delivery, even if the caller is root. The reception works, but by that time,
4856 Exim is running as the Exim user, so when it re-execs to regain privilege for
4857 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4858 can test reception and delivery using two separate commands (one to put a
4859 message in the queue, using &%-odq%&, and another to do the delivery, using
4860 &%-M%&).
4861
4862 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4863 prefix string with which any file named in a &%-C%& command line option must
4864 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4865 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4866 filename can be used with &%-C%&.
4867
4868 One-off changes to a configuration can be specified by the &%-D%& command line
4869 option, which defines and overrides values for macros used inside the
4870 configuration file. However, like &%-C%&, the use of this option by a
4871 non-privileged user causes Exim to discard its root privilege.
4872 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4873 completely disabled, and its use causes an immediate error exit.
4874
4875 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4876 to declare certain macro names trusted, such that root privilege will not
4877 necessarily be discarded.
4878 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4879 considered safe and, if &%-D%& only supplies macros from this list, and the
4880 values are acceptable, then Exim will not give up root privilege if the caller
4881 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4882 transition mechanism and is expected to be removed in the future.  Acceptable
4883 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4884
4885 Some sites may wish to use the same Exim binary on different machines that
4886 share a file system, but to use different configuration files on each machine.
4887 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4888 looks for a file whose name is the configuration filename followed by a dot
4889 and the machine's node name, as obtained from the &[uname()]& function. If this
4890 file does not exist, the standard name is tried. This processing occurs for
4891 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4892
4893 In some esoteric situations different versions of Exim may be run under
4894 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4895 help with this. See the comments in &_src/EDITME_& for details.
4896
4897
4898
4899 .section "Configuration file format" "SECTconffilfor"
4900 .cindex "configuration file" "format of"
4901 .cindex "format" "configuration file"
4902 Exim's configuration file is divided into a number of different parts. General
4903 option settings must always appear at the start of the file. The other parts
4904 are all optional, and may appear in any order. Each part other than the first
4905 is introduced by the word &"begin"& followed by at least one literal
4906 space, and the name of the part. The optional parts are:
4907
4908 .ilist
4909 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4910 &<<CHAPACL>>&).
4911 .next
4912 .cindex "AUTH" "configuration"
4913 &'authenticators'&: Configuration settings for the authenticator drivers. These
4914 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4915 .next
4916 &'routers'&: Configuration settings for the router drivers. Routers process
4917 addresses and determine how the message is to be delivered (see chapters
4918 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4919 .next
4920 &'transports'&: Configuration settings for the transport drivers. Transports
4921 define mechanisms for copying messages to destinations (see chapters
4922 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4923 .next
4924 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4925 If there is no retry section, or if it is empty (that is, no retry rules are
4926 defined), Exim will not retry deliveries. In this situation, temporary errors
4927 are treated the same as permanent errors. Retry rules are discussed in chapter
4928 &<<CHAPretry>>&.
4929 .next
4930 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4931 when new addresses are generated during delivery. Rewriting is discussed in
4932 chapter &<<CHAPrewrite>>&.
4933 .next
4934 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4935 want to use this feature, you must set
4936 .code
4937 LOCAL_SCAN_HAS_OPTIONS=yes
4938 .endd
4939 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4940 facility are given in chapter &<<CHAPlocalscan>>&.
4941 .endlist
4942
4943 .cindex "configuration file" "leading white space in"
4944 .cindex "configuration file" "trailing white space in"
4945 .cindex "white space" "in configuration file"
4946 Leading and trailing white space in configuration lines is always ignored.
4947
4948 Blank lines in the file, and lines starting with a # character (ignoring
4949 leading white space) are treated as comments and are ignored. &*Note*&: A
4950 # character other than at the beginning of a line is not treated specially,
4951 and does not introduce a comment.
4952
4953 Any non-comment line can be continued by ending it with a backslash. Note that
4954 the general rule for white space means that trailing white space after the
4955 backslash and leading white space at the start of continuation
4956 lines is ignored. Comment lines beginning with # (but not empty lines) may
4957 appear in the middle of a sequence of continuation lines.
4958
4959 A convenient way to create a configuration file is to start from the
4960 default, which is supplied in &_src/configure.default_&, and add, delete, or
4961 change settings as required.
4962
4963 The ACLs, retry rules, and rewriting rules have their own syntax which is
4964 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4965 respectively. The other parts of the configuration file have some syntactic
4966 items in common, and these are described below, from section &<<SECTcos>>&
4967 onwards. Before that, the inclusion, macro, and conditional facilities are
4968 described.
4969
4970
4971
4972 .section "File inclusions in the configuration file" "SECID41"
4973 .cindex "inclusions in configuration file"
4974 .cindex "configuration file" "including other files"
4975 .cindex "&`.include`& in configuration file"
4976 .cindex "&`.include_if_exists`& in configuration file"
4977 You can include other files inside Exim's runtime configuration file by
4978 using this syntax:
4979 .display
4980 &`.include`& <&'filename'&>
4981 &`.include_if_exists`& <&'filename'&>
4982 .endd
4983 on a line by itself. Double quotes round the filename are optional. If you use
4984 the first form, a configuration error occurs if the file does not exist; the
4985 second form does nothing for non-existent files.
4986 The first form allows a relative name. It is resolved relative to
4987 the directory of the including file. For the second form an absolute filename
4988 is required.
4989
4990 Includes may be nested to any depth, but remember that Exim reads its
4991 configuration file often, so it is a good idea to keep them to a minimum.
4992 If you change the contents of an included file, you must HUP the daemon,
4993 because an included file is read only when the configuration itself is read.
4994
4995 The processing of inclusions happens early, at a physical line level, so, like
4996 comment lines, an inclusion can be used in the middle of an option setting,
4997 for example:
4998 .code
4999 hosts_lookup = a.b.c \
5000                .include /some/file
5001 .endd
5002 Include processing happens after macro processing (see below). Its effect is to
5003 process the lines of the included file as if they occurred inline where the
5004 inclusion appears.
5005
5006
5007
5008 .section "Macros in the configuration file" "SECTmacrodefs"
5009 .cindex "macro" "description of"
5010 .cindex "configuration file" "macros"
5011 If a line in the main part of the configuration (that is, before the first
5012 &"begin"& line) begins with an upper case letter, it is taken as a macro
5013 definition, and must be of the form
5014 .display
5015 <&'name'&> = <&'rest of line'&>
5016 .endd
5017 The name must consist of letters, digits, and underscores, and need not all be
5018 in upper case, though that is recommended. The rest of the line, including any
5019 continuations, is the replacement text, and has leading and trailing white
5020 space removed. Quotes are not removed. The replacement text can never end with
5021 a backslash character, but this doesn't seem to be a serious limitation.
5022
5023 Macros may also be defined between router, transport, authenticator, or ACL
5024 definitions. They may not, however, be defined within an individual driver or
5025 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5026
5027 .section "Macro substitution" "SECID42"
5028 Once a macro is defined, all subsequent lines in the file (and any included
5029 files) are scanned for the macro name; if there are several macros, the line is
5030 scanned for each, in turn, in the order in which the macros are defined. The
5031 replacement text is not re-scanned for the current macro, though it is scanned
5032 for subsequently defined macros. For this reason, a macro name may not contain
5033 the name of a previously defined macro as a substring. You could, for example,
5034 define
5035 .display
5036 &`ABCD_XYZ = `&<&'something'&>
5037 &`ABCD = `&<&'something else'&>
5038 .endd
5039 but putting the definitions in the opposite order would provoke a configuration
5040 error. Macro expansion is applied to individual physical lines from the file,
5041 before checking for line continuation or file inclusion (see above). If a line
5042 consists solely of a macro name, and the expansion of the macro is empty, the
5043 line is ignored. A macro at the start of a line may turn the line into a
5044 comment line or a &`.include`& line.
5045
5046
5047 .section "Redefining macros" "SECID43"
5048 Once defined, the value of a macro can be redefined later in the configuration
5049 (or in an included file). Redefinition is specified by using &'=='& instead of
5050 &'='&. For example:
5051 .code
5052 MAC =  initial value
5053 ...
5054 MAC == updated value
5055 .endd
5056 Redefinition does not alter the order in which the macros are applied to the
5057 subsequent lines of the configuration file. It is still the same order in which
5058 the macros were originally defined. All that changes is the macro's value.
5059 Redefinition makes it possible to accumulate values. For example:
5060 .code
5061 MAC =  initial value
5062 ...
5063 MAC == MAC and something added
5064 .endd
5065 This can be helpful in situations where the configuration file is built
5066 from a number of other files.
5067
5068 .section "Overriding macro values" "SECID44"
5069 The values set for macros in the configuration file can be overridden by the
5070 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5071 used, unless called by root or the Exim user. A definition on the command line
5072 using the &%-D%& option causes all definitions and redefinitions within the
5073 file to be ignored.
5074
5075
5076
5077 .section "Example of macro usage" "SECID45"
5078 As an example of macro usage, consider a configuration where aliases are looked
5079 up in a MySQL database. It helps to keep the file less cluttered if long
5080 strings such as SQL statements are defined separately as macros, for example:
5081 .code
5082 ALIAS_QUERY = select mailbox from user where \
5083               login='${quote_mysql:$local_part}';
5084 .endd
5085 This can then be used in a &(redirect)& router setting like this:
5086 .code
5087 data = ${lookup mysql{ALIAS_QUERY}}
5088 .endd
5089 In earlier versions of Exim macros were sometimes used for domain, host, or
5090 address lists. In Exim 4 these are handled better by named lists &-- see
5091 section &<<SECTnamedlists>>&.
5092
5093
5094 .section "Builtin macros" "SECTbuiltinmacros"
5095 Exim defines some macros depending on facilities available, which may
5096 differ due to build-time definitions and from one release to another.
5097 All of these macros start with an underscore.
5098 They can be used to conditionally include parts of a configuration
5099 (see below).
5100
5101 The following classes of macros are defined:
5102 .display
5103 &` _HAVE_*                    `&  build-time defines
5104 &` _DRIVER_ROUTER_*           `&  router drivers
5105 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5106 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5107 &` _LOG_*                     `&  log_selector values
5108 &` _OPT_MAIN_*                `&  main config options
5109 &` _OPT_ROUTERS_*             `&  generic router options
5110 &` _OPT_TRANSPORTS_*          `&  generic transport options
5111 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5112 &` _OPT_ROUTER_*_*            `&  private router options
5113 &` _OPT_TRANSPORT_*_*         `&  private transport options
5114 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5115 .endd
5116
5117 Use an &"exim -bP macros"& command to get the list of macros.
5118
5119
5120 .section "Conditional skips in the configuration file" "SECID46"
5121 .cindex "configuration file" "conditional skips"
5122 .cindex "&`.ifdef`&"
5123 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5124 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5125 portions of the configuration file. The processing happens whenever the file is
5126 read (that is, when an Exim binary starts to run).
5127
5128 The implementation is very simple. Instances of the first four directives must
5129 be followed by text that includes the names of one or macros. The condition
5130 that is tested is whether or not any macro substitution has taken place in the
5131 line. Thus:
5132 .code
5133 .ifdef AAA
5134 message_size_limit = 50M
5135 .else
5136 message_size_limit = 100M
5137 .endif
5138 .endd
5139 sets a message size limit of 50M if the macro &`AAA`& is defined
5140 (or &`A`& or &`AA`&), and 100M
5141 otherwise. If there is more than one macro named on the line, the condition
5142 is true if any of them are defined. That is, it is an &"or"& condition. To
5143 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5144
5145 Although you can use a macro expansion to generate one of these directives,
5146 it is not very useful, because the condition &"there was a macro substitution
5147 in this line"& will always be true.
5148
5149 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5150 to clarify complicated nestings.
5151
5152
5153
5154 .section "Common option syntax" "SECTcos"
5155 .cindex "common option syntax"
5156 .cindex "syntax of common options"
5157 .cindex "configuration file" "common option syntax"
5158 For the main set of options, driver options, and &[local_scan()]& options,
5159 each setting is on a line by itself, and starts with a name consisting of
5160 lower-case letters and underscores. Many options require a data value, and in
5161 these cases the name must be followed by an equals sign (with optional white
5162 space) and then the value. For example:
5163 .code
5164 qualify_domain = mydomain.example.com
5165 .endd
5166 .cindex "hiding configuration option values"
5167 .cindex "configuration options" "hiding value of"
5168 .cindex "options" "hiding value of"
5169 Some option settings may contain sensitive data, for example, passwords for
5170 accessing databases. To stop non-admin users from using the &%-bP%& command
5171 line option to read these values, you can precede the option settings with the
5172 word &"hide"&. For example:
5173 .code
5174 hide mysql_servers = localhost/users/admin/secret-password
5175 .endd
5176 For non-admin users, such options are displayed like this:
5177 .code
5178 mysql_servers = <value not displayable>
5179 .endd
5180 If &"hide"& is used on a driver option, it hides the value of that option on
5181 all instances of the same driver.
5182
5183 The following sections describe the syntax used for the different data types
5184 that are found in option settings.
5185
5186
5187 .section "Boolean options" "SECID47"
5188 .cindex "format" "boolean"
5189 .cindex "boolean configuration values"
5190 .oindex "&%no_%&&'xxx'&"
5191 .oindex "&%not_%&&'xxx'&"
5192 Options whose type is given as boolean are on/off switches. There are two
5193 different ways of specifying such options: with and without a data value. If
5194 the option name is specified on its own without data, the switch is turned on;
5195 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5196 boolean options may be followed by an equals sign and one of the words
5197 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5198 the following two settings have exactly the same effect:
5199 .code
5200 queue_only
5201 queue_only = true
5202 .endd
5203 The following two lines also have the same (opposite) effect:
5204 .code
5205 no_queue_only
5206 queue_only = false
5207 .endd
5208 You can use whichever syntax you prefer.
5209
5210
5211
5212
5213 .section "Integer values" "SECID48"
5214 .cindex "integer configuration values"
5215 .cindex "format" "integer"
5216 If an option's type is given as &"integer"&, the value can be given in decimal,
5217 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5218 number is assumed. Otherwise, it is treated as an octal number unless it starts
5219 with the characters &"0x"&, in which case the remainder is interpreted as a
5220 hexadecimal number.
5221
5222 If an integer value is followed by the letter K, it is multiplied by 1024; if
5223 it is followed by the letter M, it is multiplied by 1024x1024;
5224 if by the letter G, 1024x1024x1024.
5225 When the values
5226 of integer option settings are output, values which are an exact multiple of
5227 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5228 and M. The printing style is independent of the actual input format that was
5229 used.
5230
5231
5232 .section "Octal integer values" "SECID49"
5233 .cindex "integer format"
5234 .cindex "format" "octal integer"
5235 If an option's type is given as &"octal integer"&, its value is always
5236 interpreted as an octal number, whether or not it starts with the digit zero.
5237 Such options are always output in octal.
5238
5239
5240 .section "Fixed point numbers" "SECID50"
5241 .cindex "fixed point configuration values"
5242 .cindex "format" "fixed point"
5243 If an option's type is given as &"fixed-point"&, its value must be a decimal
5244 integer, optionally followed by a decimal point and up to three further digits.
5245
5246
5247
5248 .section "Time intervals" "SECTtimeformat"
5249 .cindex "time interval" "specifying in configuration"
5250 .cindex "format" "time interval"
5251 A time interval is specified as a sequence of numbers, each followed by one of
5252 the following letters, with no intervening white space:
5253
5254 .table2 30pt
5255 .irow &%s%& seconds
5256 .irow &%m%& minutes
5257 .irow &%h%& hours
5258 .irow &%d%& days
5259 .irow &%w%& weeks
5260 .endtable
5261
5262 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5263 intervals are output in the same format. Exim does not restrict the values; it
5264 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5265
5266
5267
5268 .section "String values" "SECTstrings"
5269 .cindex "string" "format of configuration values"
5270 .cindex "format" "string"
5271 If an option's type is specified as &"string"&, the value can be specified with
5272 or without double-quotes. If it does not start with a double-quote, the value
5273 consists of the remainder of the line plus any continuation lines, starting at
5274 the first character after any leading white space, with trailing white space
5275 removed, and with no interpretation of the characters in the string. Because
5276 Exim removes comment lines (those beginning with #) at an early stage, they can
5277 appear in the middle of a multi-line string. The following two settings are
5278 therefore equivalent:
5279 .code
5280 trusted_users = uucp:mail
5281 trusted_users = uucp:\
5282                 # This comment line is ignored
5283                 mail
5284 .endd
5285 .cindex "string" "quoted"
5286 .cindex "escape characters in quoted strings"
5287 If a string does start with a double-quote, it must end with a closing
5288 double-quote, and any backslash characters other than those used for line
5289 continuation are interpreted as escape characters, as follows:
5290
5291 .table2 100pt
5292 .irow &`\\`&                     "single backslash"
5293 .irow &`\n`&                     "newline"
5294 .irow &`\r`&                     "carriage return"
5295 .irow &`\t`&                     "tab"
5296 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5297 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5298                                    character"
5299 .endtable
5300
5301 If a backslash is followed by some other character, including a double-quote
5302 character, that character replaces the pair.
5303
5304 Quoting is necessary only if you want to make use of the backslash escapes to
5305 insert special characters, or if you need to specify a value with leading or
5306 trailing spaces. These cases are rare, so quoting is almost never needed in
5307 current versions of Exim. In versions of Exim before 3.14, quoting was required
5308 in order to continue lines, so you may come across older configuration files
5309 and examples that apparently quote unnecessarily.
5310
5311
5312 .section "Expanded strings" "SECID51"
5313 .cindex "expansion" "definition of"
5314 Some strings in the configuration file are subjected to &'string expansion'&,
5315 by which means various parts of the string may be changed according to the
5316 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5317 is as just described; in particular, the handling of backslashes in quoted
5318 strings is done as part of the input process, before expansion takes place.
5319 However, backslash is also an escape character for the expander, so any
5320 backslashes that are required for that reason must be doubled if they are
5321 within a quoted configuration string.
5322
5323
5324 .section "User and group names" "SECID52"
5325 .cindex "user name" "format of"
5326 .cindex "format" "user name"
5327 .cindex "groups" "name format"
5328 .cindex "format" "group name"
5329 User and group names are specified as strings, using the syntax described
5330 above, but the strings are interpreted specially. A user or group name must
5331 either consist entirely of digits, or be a name that can be looked up using the
5332 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5333
5334
5335 .section "List construction" "SECTlistconstruct"
5336 .cindex "list" "syntax of in configuration"
5337 .cindex "format" "list item in configuration"
5338 .cindex "string" "list, definition of"
5339 The data for some configuration options is a list of items, with colon as the
5340 default separator. Many of these options are shown with type &"string list"& in
5341 the descriptions later in this document. Others are listed as &"domain list"&,
5342 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5343 are all the same; however, those other than &"string list"& are subject to
5344 particular kinds of interpretation, as described in chapter
5345 &<<CHAPdomhosaddlists>>&.
5346
5347 In all these cases, the entire list is treated as a single string as far as the
5348 input syntax is concerned. The &%trusted_users%& setting in section
5349 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5350 in a list, it must be entered as two colons. Leading and trailing white space
5351 on each item in a list is ignored. This makes it possible to include items that
5352 start with a colon, and in particular, certain forms of IPv6 address. For
5353 example, the list
5354 .code
5355 local_interfaces = 127.0.0.1 : ::::1
5356 .endd
5357 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5358
5359 &*Note*&: Although leading and trailing white space is ignored in individual
5360 list items, it is not ignored when parsing the list. The space after the first
5361 colon in the example above is necessary. If it were not there, the list would
5362 be interpreted as the two items 127.0.0.1:: and 1.
5363
5364 .section "Changing list separators" "SECTlistsepchange"
5365 .cindex "list separator" "changing"
5366 .cindex "IPv6" "addresses in lists"
5367 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5368 introduced to allow the separator character to be changed. If a list begins
5369 with a left angle bracket, followed by any punctuation character, that
5370 character is used instead of colon as the list separator. For example, the list
5371 above can be rewritten to use a semicolon separator like this:
5372 .code
5373 local_interfaces = <; 127.0.0.1 ; ::1
5374 .endd
5375 This facility applies to all lists, with the exception of the list in
5376 &%log_file_path%&. It is recommended that the use of non-colon separators be
5377 confined to circumstances where they really are needed.
5378
5379 .cindex "list separator" "newline as"
5380 .cindex "newline" "as list separator"
5381 It is also possible to use newline and other control characters (those with
5382 code values less than 32, plus DEL) as separators in lists. Such separators
5383 must be provided literally at the time the list is processed. For options that
5384 are string-expanded, you can write the separator using a normal escape
5385 sequence. This will be processed by the expander before the string is
5386 interpreted as a list. For example, if a newline-separated list of domains is
5387 generated by a lookup, you can process it directly by a line such as this:
5388 .code
5389 domains = <\n ${lookup mysql{.....}}
5390 .endd
5391 This avoids having to change the list separator in such data. You are unlikely
5392 to want to use a control character as a separator in an option that is not
5393 expanded, because the value is literal text. However, it can be done by giving
5394 the value in quotes. For example:
5395 .code
5396 local_interfaces = "<\n 127.0.0.1 \n ::1"
5397 .endd
5398 Unlike printing character separators, which can be included in list items by
5399 doubling, it is not possible to include a control character as data when it is
5400 set as the separator. Two such characters in succession are interpreted as
5401 enclosing an empty list item.
5402
5403
5404
5405 .section "Empty items in lists" "SECTempitelis"
5406 .cindex "list" "empty item in"
5407 An empty item at the end of a list is always ignored. In other words, trailing
5408 separator characters are ignored. Thus, the list in
5409 .code
5410 senders = user@domain :
5411 .endd
5412 contains only a single item. If you want to include an empty string as one item
5413 in a list, it must not be the last item. For example, this list contains three
5414 items, the second of which is empty:
5415 .code
5416 senders = user1@domain : : user2@domain
5417 .endd
5418 &*Note*&: There must be white space between the two colons, as otherwise they
5419 are interpreted as representing a single colon data character (and the list
5420 would then contain just one item). If you want to specify a list that contains
5421 just one, empty item, you can do it as in this example:
5422 .code
5423 senders = :
5424 .endd
5425 In this case, the first item is empty, and the second is discarded because it
5426 is at the end of the list.
5427
5428
5429
5430
5431 .section "Format of driver configurations" "SECTfordricon"
5432 .cindex "drivers" "configuration format"
5433 There are separate parts in the configuration for defining routers, transports,
5434 and authenticators. In each part, you are defining a number of driver
5435 instances, each with its own set of options. Each driver instance is defined by
5436 a sequence of lines like this:
5437 .display
5438 <&'instance name'&>:
5439   <&'option'&>
5440   ...
5441   <&'option'&>
5442 .endd
5443 In the following example, the instance name is &(localuser)&, and it is
5444 followed by three options settings:
5445 .code
5446 localuser:
5447   driver = accept
5448   check_local_user
5449   transport = local_delivery
5450 .endd
5451 For each driver instance, you specify which Exim code module it uses &-- by the
5452 setting of the &%driver%& option &-- and (optionally) some configuration
5453 settings. For example, in the case of transports, if you want a transport to
5454 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5455 a local file you would use the &(appendfile)& driver. Each of the drivers is
5456 described in detail in its own separate chapter later in this manual.
5457
5458 You can have several routers, transports, or authenticators that are based on
5459 the same underlying driver (each must have a different instance name).
5460
5461 The order in which routers are defined is important, because addresses are
5462 passed to individual routers one by one, in order. The order in which
5463 transports are defined does not matter at all. The order in which
5464 authenticators are defined is used only when Exim, as a client, is searching
5465 them to find one that matches an authentication mechanism offered by the
5466 server.
5467
5468 .cindex "generic options"
5469 .cindex "options" "generic &-- definition of"
5470 Within a driver instance definition, there are two kinds of option: &'generic'&
5471 and &'private'&. The generic options are those that apply to all drivers of the
5472 same type (that is, all routers, all transports or all authenticators). The
5473 &%driver%& option is a generic option that must appear in every definition.
5474 .cindex "private options"
5475 The private options are special for each driver, and none need appear, because
5476 they all have default values.
5477
5478 The options may appear in any order, except that the &%driver%& option must
5479 precede any private options, since these depend on the particular driver. For
5480 this reason, it is recommended that &%driver%& always be the first option.
5481
5482 Driver instance names, which are used for reference in log entries and
5483 elsewhere, can be any sequence of letters, digits, and underscores (starting
5484 with a letter) and must be unique among drivers of the same type. A router and
5485 a transport (for example) can each have the same name, but no two router
5486 instances can have the same name. The name of a driver instance should not be
5487 confused with the name of the underlying driver module. For example, the
5488 configuration lines:
5489 .code
5490 remote_smtp:
5491   driver = smtp
5492 .endd
5493 create an instance of the &(smtp)& transport driver whose name is
5494 &(remote_smtp)&. The same driver code can be used more than once, with
5495 different instance names and different option settings each time. A second
5496 instance of the &(smtp)& transport, with different options, might be defined
5497 thus:
5498 .code
5499 special_smtp:
5500   driver = smtp
5501   port = 1234
5502   command_timeout = 10s
5503 .endd
5504 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5505 these transport instances from routers, and these names would appear in log
5506 lines.
5507
5508 Comment lines may be present in the middle of driver specifications. The full
5509 list of option settings for any particular driver instance, including all the
5510 defaulted values, can be extracted by making use of the &%-bP%& command line
5511 option.
5512
5513
5514
5515
5516
5517
5518 . ////////////////////////////////////////////////////////////////////////////
5519 . ////////////////////////////////////////////////////////////////////////////
5520
5521 .chapter "The default configuration file" "CHAPdefconfil"
5522 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5523 .cindex "default" "configuration file &""walk through""&"
5524 The default configuration file supplied with Exim as &_src/configure.default_&
5525 is sufficient for a host with simple mail requirements. As an introduction to
5526 the way Exim is configured, this chapter &"walks through"& the default
5527 configuration, giving brief explanations of the settings. Detailed descriptions
5528 of the options are given in subsequent chapters. The default configuration file
5529 itself contains extensive comments about ways you might want to modify the
5530 initial settings. However, note that there are many options that are not
5531 mentioned at all in the default configuration.
5532
5533
5534
5535 .section "Macros" "SECTdefconfmacros"
5536 All macros should be defined before any options.
5537
5538 One macro is specified, but commented out, in the default configuration:
5539 .code
5540 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5541 .endd
5542 If all off-site mail is expected to be delivered to a "smarthost", then set the
5543 hostname here and uncomment the macro.  This will affect which router is used
5544 later on.  If this is left commented out, then Exim will perform direct-to-MX
5545 deliveries using a &(dnslookup)& router.
5546
5547 In addition to macros defined here, Exim includes a number of built-in macros
5548 to enable configuration to be guarded by a binary built with support for a
5549 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5550
5551
5552 .section "Main configuration settings" "SECTdefconfmain"
5553 The main (global) configuration option settings section must always come first
5554 in the file, after the macros.
5555 The first thing you'll see in the file, after some initial comments, is the line
5556 .code
5557 # primary_hostname =
5558 .endd
5559 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5560 to know the official, fully qualified name of your host, and this is where you
5561 can specify it. However, in most cases you do not need to set this option. When
5562 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5563
5564 The first three non-comment configuration lines are as follows:
5565 .code
5566 domainlist local_domains    = @
5567 domainlist relay_to_domains =
5568 hostlist   relay_from_hosts = 127.0.0.1
5569 .endd
5570 These are not, in fact, option settings. They are definitions of two named
5571 domain lists and one named host list. Exim allows you to give names to lists of
5572 domains, hosts, and email addresses, in order to make it easier to manage the
5573 configuration file (see section &<<SECTnamedlists>>&).
5574
5575 The first line defines a domain list called &'local_domains'&; this is used
5576 later in the configuration to identify domains that are to be delivered
5577 on the local host.
5578
5579 .cindex "@ in a domain list"
5580 There is just one item in this list, the string &"@"&. This is a special form
5581 of entry which means &"the name of the local host"&. Thus, if the local host is
5582 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5583 be delivered locally. Because the local host's name is referenced indirectly,
5584 the same configuration file can be used on different hosts.
5585
5586 The second line defines a domain list called &'relay_to_domains'&, but the
5587 list itself is empty. Later in the configuration we will come to the part that
5588 controls mail relaying through the local host; it allows relaying to any
5589 domains in this list. By default, therefore, no relaying on the basis of a mail
5590 domain is permitted.
5591
5592 The third line defines a host list called &'relay_from_hosts'&. This list is
5593 used later in the configuration to permit relaying from any host or IP address
5594 that matches the list. The default contains just the IP address of the IPv4
5595 loopback interface, which means that processes on the local host are able to
5596 submit mail for relaying by sending it over TCP/IP to that interface. No other
5597 hosts are permitted to submit messages for relaying.
5598
5599 Just to be sure there's no misunderstanding: at this point in the configuration
5600 we aren't actually setting up any controls. We are just defining some domains
5601 and hosts that will be used in the controls that are specified later.
5602
5603 The next two configuration lines are genuine option settings:
5604 .code
5605 acl_smtp_rcpt = acl_check_rcpt
5606 acl_smtp_data = acl_check_data
5607 .endd
5608 These options specify &'Access Control Lists'& (ACLs) that are to be used
5609 during an incoming SMTP session for every recipient of a message (every RCPT
5610 command), and after the contents of the message have been received,
5611 respectively. The names of the lists are &'acl_check_rcpt'& and
5612 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5613 section of the configuration. The RCPT ACL controls which recipients are
5614 accepted for an incoming message &-- if a configuration does not provide an ACL
5615 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5616 contents of a message to be checked.
5617
5618 Two commented-out option settings are next:
5619 .code
5620 # av_scanner = clamd:/tmp/clamd
5621 # spamd_address = 127.0.0.1 783
5622 .endd
5623 These are example settings that can be used when Exim is compiled with the
5624 content-scanning extension. The first specifies the interface to the virus
5625 scanner, and the second specifies the interface to SpamAssassin. Further
5626 details are given in chapter &<<CHAPexiscan>>&.
5627
5628 Three more commented-out option settings follow:
5629 .code
5630 # tls_advertise_hosts = *
5631 # tls_certificate = /etc/ssl/exim.crt
5632 # tls_privatekey = /etc/ssl/exim.pem
5633 .endd
5634 These are example settings that can be used when Exim is compiled with
5635 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5636 first one specifies the list of clients that are allowed to use TLS when
5637 connecting to this server; in this case, the wildcard means all clients. The
5638 other options specify where Exim should find its TLS certificate and private
5639 key, which together prove the server's identity to any clients that connect.
5640 More details are given in chapter &<<CHAPTLS>>&.
5641
5642 Another two commented-out option settings follow:
5643 .code
5644 # daemon_smtp_ports = 25 : 465 : 587
5645 # tls_on_connect_ports = 465
5646 .endd
5647 .cindex "port" "465 and 587"
5648 .cindex "port" "for message submission"
5649 .cindex "message" "submission, ports for"
5650 .cindex "submissions protocol"
5651 .cindex "smtps protocol"
5652 .cindex "ssmtp protocol"
5653 .cindex "SMTP" "submissions protocol"
5654 .cindex "SMTP" "ssmtp protocol"
5655 .cindex "SMTP" "smtps protocol"
5656 These options provide better support for roaming users who wish to use this
5657 server for message submission. They are not much use unless you have turned on
5658 TLS (as described in the previous paragraph) and authentication (about which
5659 more in section &<<SECTdefconfauth>>&).
5660 Mail submission from mail clients (MUAs) should be separate from inbound mail
5661 to your domain (MX delivery) for various good reasons (eg, ability to impose
5662 much saner TLS protocol and ciphersuite requirements without unintended
5663 consequences).
5664 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5665 which uses STARTTLS, so this is the &"submission"& port.
5666 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5667 which should be used in preference to 587.
5668 You should also consider deploying SRV records to help clients find
5669 these ports.
5670 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5671
5672 Two more commented-out options settings follow:
5673 .code
5674 # qualify_domain =
5675 # qualify_recipient =
5676 .endd
5677 The first of these specifies a domain that Exim uses when it constructs a
5678 complete email address from a local login name. This is often needed when Exim
5679 receives a message from a local process. If you do not set &%qualify_domain%&,
5680 the value of &%primary_hostname%& is used. If you set both of these options,
5681 you can have different qualification domains for sender and recipient
5682 addresses. If you set only the first one, its value is used in both cases.
5683
5684 .cindex "domain literal" "recognizing format"
5685 The following line must be uncommented if you want Exim to recognize
5686 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5687 (an IP address within square brackets) instead of a named domain.
5688 .code
5689 # allow_domain_literals
5690 .endd
5691 The RFCs still require this form, but many people think that in the modern
5692 Internet it makes little sense to permit mail to be sent to specific hosts by
5693 quoting their IP addresses. This ancient format has been used by people who
5694 try to abuse hosts by using them for unwanted relaying. However, some
5695 people believe there are circumstances (for example, messages addressed to
5696 &'postmaster'&) where domain literals are still useful.
5697
5698 The next configuration line is a kind of trigger guard:
5699 .code
5700 never_users = root
5701 .endd
5702 It specifies that no delivery must ever be run as the root user. The normal
5703 convention is to set up &'root'& as an alias for the system administrator. This
5704 setting is a guard against slips in the configuration.
5705 The list of users specified by &%never_users%& is not, however, the complete
5706 list; the build-time configuration in &_Local/Makefile_& has an option called
5707 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5708 contents of &%never_users%& are added to this list. By default
5709 FIXED_NEVER_USERS also specifies root.
5710
5711 When a remote host connects to Exim in order to send mail, the only information
5712 Exim has about the host's identity is its IP address. The next configuration
5713 line,
5714 .code
5715 host_lookup = *
5716 .endd
5717 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5718 in order to get a host name. This improves the quality of the logging
5719 information, but if you feel it is too expensive, you can remove it entirely,
5720 or restrict the lookup to hosts on &"nearby"& networks.
5721 Note that it is not always possible to find a host name from an IP address,
5722 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5723 unreachable.
5724
5725 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5726 1413 (hence their names):
5727 .code
5728 rfc1413_hosts = *
5729 rfc1413_query_timeout = 0s
5730 .endd
5731 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5732 Few hosts offer RFC1413 service these days; calls have to be
5733 terminated by a timeout and this needlessly delays the startup
5734 of an incoming SMTP connection.
5735 If you have hosts for which you trust RFC1413 and need this
5736 information, you can change this.
5737
5738 This line enables an efficiency SMTP option.  It is negotiated by clients
5739 and not expected to cause problems but can be disabled if needed.
5740 .code
5741 prdr_enable = true
5742 .endd
5743
5744 When Exim receives messages over SMTP connections, it expects all addresses to
5745 be fully qualified with a domain, as required by the SMTP definition. However,
5746 if you are running a server to which simple clients submit messages, you may
5747 find that they send unqualified addresses. The two commented-out options:
5748 .code
5749 # sender_unqualified_hosts =
5750 # recipient_unqualified_hosts =
5751 .endd
5752 show how you can specify hosts that are permitted to send unqualified sender
5753 and recipient addresses, respectively.
5754
5755 The &%log_selector%& option is used to increase the detail of logging
5756 over the default:
5757 .code
5758 log_selector = +smtp_protocol_error +smtp_syntax_error \
5759                +tls_certificate_verified
5760 .endd
5761
5762 The &%percent_hack_domains%& option is also commented out:
5763 .code
5764 # percent_hack_domains =
5765 .endd
5766 It provides a list of domains for which the &"percent hack"& is to operate.
5767 This is an almost obsolete form of explicit email routing. If you do not know
5768 anything about it, you can safely ignore this topic.
5769
5770 The next two settings in the main part of the default configuration are
5771 concerned with messages that have been &"frozen"& on Exim's queue. When a
5772 message is frozen, Exim no longer continues to try to deliver it. Freezing
5773 occurs when a bounce message encounters a permanent failure because the sender
5774 address of the original message that caused the bounce is invalid, so the
5775 bounce cannot be delivered. This is probably the most common case, but there
5776 are also other conditions that cause freezing, and frozen messages are not
5777 always bounce messages.
5778 .code
5779 ignore_bounce_errors_after = 2d
5780 timeout_frozen_after = 7d
5781 .endd
5782 The first of these options specifies that failing bounce messages are to be
5783 discarded after 2 days in the queue. The second specifies that any frozen
5784 message (whether a bounce message or not) is to be timed out (and discarded)
5785 after a week. In this configuration, the first setting ensures that no failing
5786 bounce message ever lasts a week.
5787
5788 Exim queues it's messages in a spool directory. If you expect to have
5789 large queues, you may consider using this option. It splits the spool
5790 directory into subdirectories to avoid file system degradation from
5791 many files in a single directory, resulting in better performance.
5792 Manual manipulation of queued messages becomes more complex (though fortunately
5793 not often needed).
5794 .code
5795 # split_spool_directory = true
5796 .endd
5797
5798 In an ideal world everybody follows the standards. For non-ASCII
5799 messages RFC 2047 is a standard, allowing a maximum line length of 76
5800 characters. Exim adheres that standard and won't process messages which
5801 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5802 In particular, the Exim maintainers have had multiple reports of
5803 problems from Russian administrators of issues until they disable this
5804 check, because of some popular, yet buggy, mail composition software.
5805 .code
5806 # check_rfc2047_length = false
5807 .endd
5808
5809 If you need to be strictly RFC compliant you may wish to disable the
5810 8BITMIME advertisement. Use this, if you exchange mails with systems
5811 that are not 8-bit clean.
5812 .code
5813 # accept_8bitmime = false
5814 .endd
5815
5816 Libraries you use may depend on specific environment settings.  This
5817 imposes a security risk (e.g. PATH). There are two lists:
5818 &%keep_environment%& for the variables to import as they are, and
5819 &%add_environment%& for variables we want to set to a fixed value.
5820 Note that TZ is handled separately, by the $%timezone%$ runtime
5821 option and by the TIMEZONE_DEFAULT buildtime option.
5822 .code
5823 # keep_environment = ^LDAP
5824 # add_environment = PATH=/usr/bin::/bin
5825 .endd
5826
5827
5828 .section "ACL configuration" "SECID54"
5829 .cindex "default" "ACLs"
5830 .cindex "&ACL;" "default configuration"
5831 In the default configuration, the ACL section follows the main configuration.
5832 It starts with the line
5833 .code
5834 begin acl
5835 .endd
5836 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5837 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5838 and &%acl_smtp_data%& above.
5839
5840 .cindex "RCPT" "ACL for"
5841 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5842 RCPT command specifies one of the message's recipients. The ACL statements
5843 are considered in order, until the recipient address is either accepted or
5844 rejected. The RCPT command is then accepted or rejected, according to the
5845 result of the ACL processing.
5846 .code
5847 acl_check_rcpt:
5848 .endd
5849 This line, consisting of a name terminated by a colon, marks the start of the
5850 ACL, and names it.
5851 .code
5852 accept  hosts = :
5853 .endd
5854 This ACL statement accepts the recipient if the sending host matches the list.
5855 But what does that strange list mean? It doesn't actually contain any host
5856 names or IP addresses. The presence of the colon puts an empty item in the
5857 list; Exim matches this only if the incoming message did not come from a remote
5858 host, because in that case, the remote hostname is empty. The colon is
5859 important. Without it, the list itself is empty, and can never match anything.
5860
5861 What this statement is doing is to accept unconditionally all recipients in
5862 messages that are submitted by SMTP from local processes using the standard
5863 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5864 manner.
5865 .code
5866 deny    message       = Restricted characters in address
5867         domains       = +local_domains
5868         local_parts   = ^[.] : ^.*[@%!/|]
5869
5870 deny    message       = Restricted characters in address
5871         domains       = !+local_domains
5872         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5873 .endd
5874 These statements are concerned with local parts that contain any of the
5875 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5876 Although these characters are entirely legal in local parts (in the case of
5877 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5878 in Internet mail addresses.
5879
5880 The first three have in the past been associated with explicitly routed
5881 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5882 option). Addresses containing these characters are regularly tried by spammers
5883 in an attempt to bypass relaying restrictions, and also by open relay testing
5884 programs. Unless you really need them it is safest to reject these characters
5885 at this early stage. This configuration is heavy-handed in rejecting these
5886 characters for all messages it accepts from remote hosts. This is a deliberate
5887 policy of being as safe as possible.
5888
5889 The first rule above is stricter, and is applied to messages that are addressed
5890 to one of the local domains handled by this host. This is implemented by the
5891 first condition, which restricts it to domains that are listed in the
5892 &'local_domains'& domain list. The &"+"& character is used to indicate a
5893 reference to a named list. In this configuration, there is just one domain in
5894 &'local_domains'&, but in general there may be many.
5895
5896 The second condition on the first statement uses two regular expressions to
5897 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5898 or &"|"&. If you have local accounts that include these characters, you will
5899 have to modify this rule.
5900
5901 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5902 allows them because they have been encountered in practice. (Consider the
5903 common convention of local parts constructed as
5904 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5905 the author of Exim, who has no second initial.) However, a local part starting
5906 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5907 filename (for example, for a mailing list). This is also true for local parts
5908 that contain slashes. A pipe symbol can also be troublesome if the local part
5909 is incorporated unthinkingly into a shell command line.
5910
5911 The second rule above applies to all other domains, and is less strict. This
5912 allows your own users to send outgoing messages to sites that use slashes
5913 and vertical bars in their local parts. It blocks local parts that begin
5914 with a dot, slash, or vertical bar, but allows these characters within the
5915 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5916 and &"!"& is blocked, as before. The motivation here is to prevent your users
5917 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5918 .code
5919 accept  local_parts   = postmaster
5920         domains       = +local_domains
5921 .endd
5922 This statement, which has two conditions, accepts an incoming address if the
5923 local part is &'postmaster'& and the domain is one of those listed in the
5924 &'local_domains'& domain list. The &"+"& character is used to indicate a
5925 reference to a named list. In this configuration, there is just one domain in
5926 &'local_domains'&, but in general there may be many.
5927
5928 The presence of this statement means that mail to postmaster is never blocked
5929 by any of the subsequent tests. This can be helpful while sorting out problems
5930 in cases where the subsequent tests are incorrectly denying access.
5931 .code
5932 require verify        = sender
5933 .endd
5934 This statement requires the sender address to be verified before any subsequent
5935 ACL statement can be used. If verification fails, the incoming recipient
5936 address is refused. Verification consists of trying to route the address, to
5937 see if a bounce message could be delivered to it. In the case of remote
5938 addresses, basic verification checks only the domain, but &'callouts'& can be
5939 used for more verification if required. Section &<<SECTaddressverification>>&
5940 discusses the details of address verification.
5941 .code
5942 accept  hosts         = +relay_from_hosts
5943         control       = submission
5944 .endd
5945 This statement accepts the address if the message is coming from one of the
5946 hosts that are defined as being allowed to relay through this host. Recipient
5947 verification is omitted here, because in many cases the clients are dumb MUAs
5948 that do not cope well with SMTP error responses. For the same reason, the
5949 second line specifies &"submission mode"& for messages that are accepted. This
5950 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5951 messages that are deficient in some way, for example, because they lack a
5952 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5953 probably add recipient verification here, and disable submission mode.
5954 .code
5955 accept  authenticated = *
5956         control       = submission
5957 .endd
5958 This statement accepts the address if the client host has authenticated itself.
5959 Submission mode is again specified, on the grounds that such messages are most
5960 likely to come from MUAs. The default configuration does not define any
5961 authenticators, though it does include some nearly complete commented-out
5962 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5963 fact authenticate until you complete the authenticator definitions.
5964 .code
5965 require message = relay not permitted
5966         domains = +local_domains : +relay_to_domains
5967 .endd
5968 This statement rejects the address if its domain is neither a local domain nor
5969 one of the domains for which this host is a relay.
5970 .code
5971 require verify = recipient
5972 .endd
5973 This statement requires the recipient address to be verified; if verification
5974 fails, the address is rejected.
5975 .code
5976 # deny    message     = rejected because $sender_host_address \
5977 #                       is in a black list at $dnslist_domain\n\
5978 #                       $dnslist_text
5979 #         dnslists    = black.list.example
5980 #
5981 # warn    dnslists    = black.list.example
5982 #         add_header  = X-Warning: $sender_host_address is in \
5983 #                       a black list at $dnslist_domain
5984 #         log_message = found in $dnslist_domain
5985 .endd
5986 These commented-out lines are examples of how you could configure Exim to check
5987 sending hosts against a DNS black list. The first statement rejects messages
5988 from blacklisted hosts, whereas the second just inserts a warning header
5989 line.
5990 .code
5991 # require verify = csa
5992 .endd
5993 This commented-out line is an example of how you could turn on client SMTP
5994 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5995 records.
5996 .code
5997 accept
5998 .endd
5999 The final statement in the first ACL unconditionally accepts any recipient
6000 address that has successfully passed all the previous tests.
6001 .code
6002 acl_check_data:
6003 .endd
6004 This line marks the start of the second ACL, and names it. Most of the contents
6005 of this ACL are commented out:
6006 .code
6007 # deny    malware   = *
6008 #         message   = This message contains a virus \
6009 #                     ($malware_name).
6010 .endd
6011 These lines are examples of how to arrange for messages to be scanned for
6012 viruses when Exim has been compiled with the content-scanning extension, and a
6013 suitable virus scanner is installed. If the message is found to contain a
6014 virus, it is rejected with the given custom error message.
6015 .code
6016 # warn    spam      = nobody
6017 #         message   = X-Spam_score: $spam_score\n\
6018 #                     X-Spam_score_int: $spam_score_int\n\
6019 #                     X-Spam_bar: $spam_bar\n\
6020 #                     X-Spam_report: $spam_report
6021 .endd
6022 These lines are an example of how to arrange for messages to be scanned by
6023 SpamAssassin when Exim has been compiled with the content-scanning extension,
6024 and SpamAssassin has been installed. The SpamAssassin check is run with
6025 &`nobody`& as its user parameter, and the results are added to the message as a
6026 series of extra header line. In this case, the message is not rejected,
6027 whatever the spam score.
6028 .code
6029 accept
6030 .endd
6031 This final line in the DATA ACL accepts the message unconditionally.
6032
6033
6034 .section "Router configuration" "SECID55"
6035 .cindex "default" "routers"
6036 .cindex "routers" "default"
6037 The router configuration comes next in the default configuration, introduced
6038 by the line
6039 .code
6040 begin routers
6041 .endd
6042 Routers are the modules in Exim that make decisions about where to send
6043 messages. An address is passed to each router, in turn, until it is either
6044 accepted, or failed. This means that the order in which you define the routers
6045 matters. Each router is fully described in its own chapter later in this
6046 manual. Here we give only brief overviews.
6047 .code
6048 # domain_literal:
6049 #   driver = ipliteral
6050 #   domains = !+local_domains
6051 #   transport = remote_smtp
6052 .endd
6053 .cindex "domain literal" "default router"
6054 This router is commented out because the majority of sites do not want to
6055 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6056 you uncomment this router, you also need to uncomment the setting of
6057 &%allow_domain_literals%& in the main part of the configuration.
6058
6059 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6060 macro has been defined, per
6061 .code
6062 .ifdef ROUTER_SMARTHOST
6063 smarthost:
6064 #...
6065 .else
6066 dnslookup:
6067 #...
6068 .endif
6069 .endd
6070
6071 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6072 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6073 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6074 skip these routers because of the &%domains%& option.
6075
6076 .code
6077 smarthost:
6078   driver = manualroute
6079   domains = ! +local_domains
6080   transport = smarthost_smtp
6081   route_data = ROUTER_SMARTHOST
6082   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6083   no_more
6084 .endd
6085 This router only handles mail which is not to any local domains; this is
6086 specified by the line
6087 .code
6088 domains = ! +local_domains
6089 .endd
6090 The &%domains%& option lists the domains to which this router applies, but the
6091 exclamation mark is a negation sign, so the router is used only for domains
6092 that are not in the domain list called &'local_domains'& (which was defined at
6093 the start of the configuration). The plus sign before &'local_domains'&
6094 indicates that it is referring to a named list. Addresses in other domains are
6095 passed on to the following routers.
6096
6097 The name of the router driver is &(manualroute)& because we are manually
6098 specifying how mail should be routed onwards, instead of using DNS MX.
6099 While the name of this router instance is arbitrary, the &%driver%& option must
6100 be one of the driver modules that is in the Exim binary.
6101
6102 With no pre-conditions other than &%domains%&, all mail for non-local domains
6103 will be handled by this router, and the &%no_more%& setting will ensure that no
6104 other routers will be used for messages matching the pre-conditions.  See
6105 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6106 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6107 and the macro supplies the value; the address is then queued for the
6108 &(smarthost_smtp)& transport.
6109
6110 .code
6111 dnslookup:
6112   driver = dnslookup
6113   domains = ! +local_domains
6114   transport = remote_smtp
6115   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6116 .ifdef _HAVE_DNSSEC
6117   dnssec_request_domains = *
6118 .endif
6119   no_more
6120 .endd
6121 The &%domains%& option behaves as per smarthost, above.
6122
6123 The name of the router driver is &(dnslookup)&,
6124 and is specified by the &%driver%& option. Do not be confused by the fact that
6125 the name of this router instance is the same as the name of the driver. The
6126 instance name is arbitrary, but the name set in the &%driver%& option must be
6127 one of the driver modules that is in the Exim binary.
6128
6129 The &(dnslookup)& router routes addresses by looking up their domains in the
6130 DNS in order to obtain a list of hosts to which the address is routed. If the
6131 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6132 specified by the &%transport%& option. If the router does not find the domain
6133 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6134 the address fails and is bounced.
6135
6136 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6137 be entirely ignored. This option is present because a number of cases have been
6138 encountered where MX records in the DNS point to host names
6139 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6140 Completely ignoring these IP addresses causes Exim to fail to route the
6141 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6142 continue to try to deliver the message periodically until the address timed
6143 out.
6144 .code
6145 system_aliases:
6146   driver = redirect
6147   allow_fail
6148   allow_defer
6149   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6150 # user = exim
6151   file_transport = address_file
6152   pipe_transport = address_pipe
6153 .endd
6154 Control reaches this and subsequent routers only for addresses in the local
6155 domains. This router checks to see whether the local part is defined as an
6156 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6157 data that it looks up from that file. If no data is found for the local part,
6158 the value of the &%data%& option is empty, causing the address to be passed to
6159 the next router.
6160
6161 &_/etc/aliases_& is a conventional name for the system aliases file that is
6162 often used. That is why it is referenced by from the default configuration
6163 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6164 &_Local/Makefile_& before building Exim.
6165 .code
6166 userforward:
6167   driver = redirect
6168   check_local_user
6169 # local_part_suffix = +* : -*
6170 # local_part_suffix_optional
6171   file = $home/.forward
6172 # allow_filter
6173   no_verify
6174   no_expn
6175   check_ancestor
6176   file_transport = address_file
6177   pipe_transport = address_pipe
6178   reply_transport = address_reply
6179 .endd
6180 This is the most complicated router in the default configuration. It is another
6181 redirection router, but this time it is looking for forwarding data set up by
6182 individual users. The &%check_local_user%& setting specifies a check that the
6183 local part of the address is the login name of a local user. If it is not, the
6184 router is skipped. The two commented options that follow &%check_local_user%&,
6185 namely:
6186 .code
6187 # local_part_suffix = +* : -*
6188 # local_part_suffix_optional
6189 .endd
6190 .vindex "&$local_part_suffix$&"
6191 show how you can specify the recognition of local part suffixes. If the first
6192 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6193 by any sequence of characters, is removed from the local part and placed in the
6194 variable &$local_part_suffix$&. The second suffix option specifies that the
6195 presence of a suffix in the local part is optional. When a suffix is present,
6196 the check for a local login uses the local part with the suffix removed.
6197
6198 When a local user account is found, the file called &_.forward_& in the user's
6199 home directory is consulted. If it does not exist, or is empty, the router
6200 declines. Otherwise, the contents of &_.forward_& are interpreted as
6201 redirection data (see chapter &<<CHAPredirect>>& for more details).
6202
6203 .cindex "Sieve filter" "enabling in default router"
6204 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6205 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6206 is commented out by default), the contents of the file are interpreted as a set
6207 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6208 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6209 separate document entitled &'Exim's interfaces to mail filtering'&.
6210
6211 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6212 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6213 There are two reasons for doing this:
6214
6215 .olist
6216 Whether or not a local user has a &_.forward_& file is not really relevant when
6217 checking an address for validity; it makes sense not to waste resources doing
6218 unnecessary work.
6219 .next
6220 More importantly, when Exim is verifying addresses or handling an EXPN
6221 command during an SMTP session, it is running as the Exim user, not as root.
6222 The group is the Exim group, and no additional groups are set up.
6223 It may therefore not be possible for Exim to read users' &_.forward_& files at
6224 this time.
6225 .endlist
6226
6227 The setting of &%check_ancestor%& prevents the router from generating a new
6228 address that is the same as any previous address that was redirected. (This
6229 works round a problem concerning a bad interaction between aliasing and
6230 forwarding &-- see section &<<SECTredlocmai>>&).
6231
6232 The final three option settings specify the transports that are to be used when
6233 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6234 auto-reply, respectively. For example, if a &_.forward_& file contains
6235 .code
6236 a.nother@elsewhere.example, /home/spqr/archive
6237 .endd
6238 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6239 transport.
6240 .code
6241 localuser:
6242   driver = accept
6243   check_local_user
6244 # local_part_suffix = +* : -*
6245 # local_part_suffix_optional
6246   transport = local_delivery
6247 .endd
6248 The final router sets up delivery into local mailboxes, provided that the local
6249 part is the name of a local login, by accepting the address and assigning it to
6250 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6251 routers, so the address is bounced. The commented suffix settings fulfil the
6252 same purpose as they do for the &(userforward)& router.
6253
6254
6255 .section "Transport configuration" "SECID56"
6256 .cindex "default" "transports"
6257 .cindex "transports" "default"
6258 Transports define mechanisms for actually delivering messages. They operate
6259 only when referenced from routers, so the order in which they are defined does
6260 not matter. The transports section of the configuration starts with
6261 .code
6262 begin transports
6263 .endd
6264 Two remote transports and four local transports are defined.
6265 .code
6266 remote_smtp:
6267   driver = smtp
6268   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6269 .ifdef _HAVE_PRDR
6270   hosts_try_prdr = *
6271 .endif
6272 .endd
6273 This transport is used for delivering messages over SMTP connections.
6274 The list of remote hosts comes from the router.
6275 The &%message_size_limit%& usage is a hack to avoid sending on messages
6276 with over-long lines.  The built-in macro _HAVE_DANE guards configuration
6277 to use DANE for delivery;
6278 see section &<<SECDANE>>& for more details.
6279
6280 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6281 negotiated between client and server and not expected to cause problems
6282 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6283 use of the &%hosts_try_prdr%& configuration option.
6284
6285 The other remote transport is used when delivering to a specific smarthost
6286 with whom there must be some kind of existing relationship, instead of the
6287 usual federated system.
6288
6289 .code
6290 smarthost_smtp:
6291   driver = smtp
6292   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6293   multi_domain
6294   #
6295 .ifdef _HAVE_TLS
6296   # Comment out any of these which you have to, then file a Support
6297   # request with your smarthost provider to get things fixed:
6298   hosts_require_tls = *
6299   tls_verify_hosts = *
6300   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6301   # have to comment it out then this will at least log whether you succeed
6302   # or not:
6303   tls_try_verify_hosts = *
6304   #
6305   # The SNI name should match the name which we'll expect to verify;
6306   # many mail systems don't use SNI and this doesn't matter, but if it does,
6307   # we need to send a name which the remote site will recognize.
6308   # This _should_ be the name which the smarthost operators specified as
6309   # the hostname for sending your mail to.
6310   tls_sni = ROUTER_SMARTHOST
6311   #
6312 .ifdef _HAVE_OPENSSL
6313   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6314 .endif
6315 .ifdef _HAVE_GNUTLS
6316   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6317 .endif
6318 .endif
6319 .ifdef _HAVE_PRDR
6320   hosts_try_prdr = *
6321 .endif
6322 .endd
6323 After the same &%message_size_limit%& hack, we then specify that this Transport
6324 can handle messages to multiple domains in one run.  The assumption here is
6325 that you're routing all non-local mail to the same place and that place is
6326 happy to take all messages from you as quickly as possible.
6327 All other options depend upon built-in macros; if Exim was built without TLS support
6328 then no other options are defined.
6329 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6330 and versions using the &%tls_require_ciphers%& option, where the value to be
6331 used depends upon the library providing TLS.
6332 Beyond that, the options adopt the stance that you should have TLS support available
6333 from your smarthost on today's Internet, so we turn on requiring TLS for the
6334 mail to be delivered, and requiring that the certificate be valid, and match
6335 the expected hostname.  The &%tls_sni%& option can be used by service providers
6336 to select an appropriate certificate to present to you and here we re-use the
6337 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6338 You want to specify the hostname which you'll expect to validate for, and that
6339 should not be subject to insecure tampering via DNS results.
6340
6341 For the &%hosts_try_prdr%& option see the previous transport.
6342
6343 All other options are defaulted.
6344 .code
6345 local_delivery:
6346   driver = appendfile
6347   file = /var/mail/$local_part
6348   delivery_date_add
6349   envelope_to_add
6350   return_path_add
6351 # group = mail
6352 # mode = 0660
6353 .endd
6354 This &(appendfile)& transport is used for local delivery to user mailboxes in
6355 traditional BSD mailbox format. By default it runs under the uid and gid of the
6356 local user, which requires the sticky bit to be set on the &_/var/mail_&
6357 directory. Some systems use the alternative approach of running mail deliveries
6358 under a particular group instead of using the sticky bit. The commented options
6359 show how this can be done.
6360
6361 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6362 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6363 similarly-named options above.
6364 .code
6365 address_pipe:
6366   driver = pipe
6367   return_output
6368 .endd
6369 This transport is used for handling deliveries to pipes that are generated by
6370 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6371 option specifies that any output on stdout or stderr generated by the pipe is to
6372 be returned to the sender.
6373 .code
6374 address_file:
6375   driver = appendfile
6376   delivery_date_add
6377   envelope_to_add
6378   return_path_add
6379 .endd
6380 This transport is used for handling deliveries to files that are generated by
6381 redirection. The name of the file is not specified in this instance of
6382 &(appendfile)&, because it comes from the &(redirect)& router.
6383 .code
6384 address_reply:
6385   driver = autoreply
6386 .endd
6387 This transport is used for handling automatic replies generated by users'
6388 filter files.
6389
6390
6391
6392 .section "Default retry rule" "SECID57"
6393 .cindex "retry" "default rule"
6394 .cindex "default" "retry rule"
6395 The retry section of the configuration file contains rules which affect the way
6396 Exim retries deliveries that cannot be completed at the first attempt. It is
6397 introduced by the line
6398 .code
6399 begin retry
6400 .endd
6401 In the default configuration, there is just one rule, which applies to all
6402 errors:
6403 .code
6404 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6405 .endd
6406 This causes any temporarily failing address to be retried every 15 minutes for
6407 2 hours, then at intervals starting at one hour and increasing by a factor of
6408 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6409 is not delivered after 4 days of temporary failure, it is bounced. The time is
6410 measured from first failure, not from the time the message was received.
6411
6412 If the retry section is removed from the configuration, or is empty (that is,
6413 if no retry rules are defined), Exim will not retry deliveries. This turns
6414 temporary errors into permanent errors.
6415
6416
6417 .section "Rewriting configuration" "SECID58"
6418 The rewriting section of the configuration, introduced by
6419 .code
6420 begin rewrite
6421 .endd
6422 contains rules for rewriting addresses in messages as they arrive. There are no
6423 rewriting rules in the default configuration file.
6424
6425
6426
6427 .section "Authenticators configuration" "SECTdefconfauth"
6428 .cindex "AUTH" "configuration"
6429 The authenticators section of the configuration, introduced by
6430 .code
6431 begin authenticators
6432 .endd
6433 defines mechanisms for the use of the SMTP AUTH command. The default
6434 configuration file contains two commented-out example authenticators
6435 which support plaintext username/password authentication using the
6436 standard PLAIN mechanism and the traditional but non-standard LOGIN
6437 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6438 to support most MUA software.
6439
6440 The example PLAIN authenticator looks like this:
6441 .code
6442 #PLAIN:
6443 #  driver                  = plaintext
6444 #  server_set_id           = $auth2
6445 #  server_prompts          = :
6446 #  server_condition        = Authentication is not yet configured
6447 #  server_advertise_condition = ${if def:tls_in_cipher }
6448 .endd
6449 And the example LOGIN authenticator looks like this:
6450 .code
6451 #LOGIN:
6452 #  driver                  = plaintext
6453 #  server_set_id           = $auth1
6454 #  server_prompts          = <| Username: | Password:
6455 #  server_condition        = Authentication is not yet configured
6456 #  server_advertise_condition = ${if def:tls_in_cipher }
6457 .endd
6458
6459 The &%server_set_id%& option makes Exim remember the authenticated username
6460 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6461 &%server_prompts%& option configures the &(plaintext)& authenticator so
6462 that it implements the details of the specific authentication mechanism,
6463 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6464 when Exim offers authentication to clients; in the examples, this is only
6465 when TLS or SSL has been started, so to enable the authenticators you also
6466 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6467
6468 The &%server_condition%& setting defines how to verify that the username and
6469 password are correct. In the examples it just produces an error message.
6470 To make the authenticators work, you can use a string expansion
6471 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6472
6473 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6474 usercode and password are in different positions.
6475 Chapter &<<CHAPplaintext>>& covers both.
6476
6477 .ecindex IIDconfiwal
6478
6479
6480
6481 . ////////////////////////////////////////////////////////////////////////////
6482 . ////////////////////////////////////////////////////////////////////////////
6483
6484 .chapter "Regular expressions" "CHAPregexp"
6485
6486 .cindex "regular expressions" "library"
6487 .cindex "PCRE"
6488 Exim supports the use of regular expressions in many of its options. It
6489 uses the PCRE regular expression library; this provides regular expression
6490 matching that is compatible with Perl 5. The syntax and semantics of
6491 regular expressions is discussed in
6492 online Perl manpages, in
6493 many Perl reference books, and also in
6494 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6495 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6496 . --- the http: URL here redirects to another page with the ISBN in the URL
6497 . --- where trying to use https: just redirects back to http:, so sticking
6498 . --- to the old URL for now.  2018-09-07.
6499
6500 The documentation for the syntax and semantics of the regular expressions that
6501 are supported by PCRE is included in the PCRE distribution, and no further
6502 description is included here. The PCRE functions are called from Exim using
6503 the default option settings (that is, with no PCRE options set), except that
6504 the PCRE_CASELESS option is set when the matching is required to be
6505 case-insensitive.
6506
6507 In most cases, when a regular expression is required in an Exim configuration,
6508 it has to start with a circumflex, in order to distinguish it from plain text
6509 or an &"ends with"& wildcard. In this example of a configuration setting, the
6510 second item in the colon-separated list is a regular expression.
6511 .code
6512 domains = a.b.c : ^\\d{3} : *.y.z : ...
6513 .endd
6514 The doubling of the backslash is required because of string expansion that
6515 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6516 of this issue, and a way of avoiding the need for doubling backslashes. The
6517 regular expression that is eventually used in this example contains just one
6518 backslash. The circumflex is included in the regular expression, and has the
6519 normal effect of &"anchoring"& it to the start of the string that is being
6520 matched.
6521
6522 There are, however, two cases where a circumflex is not required for the
6523 recognition of a regular expression: these are the &%match%& condition in a
6524 string expansion, and the &%matches%& condition in an Exim filter file. In
6525 these cases, the relevant string is always treated as a regular expression; if
6526 it does not start with a circumflex, the expression is not anchored, and can
6527 match anywhere in the subject string.
6528
6529 In all cases, if you want a regular expression to match at the end of a string,
6530 you must code the $ metacharacter to indicate this. For example:
6531 .code
6532 domains = ^\\d{3}\\.example
6533 .endd
6534 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6535 You need to use:
6536 .code
6537 domains = ^\\d{3}\\.example\$
6538 .endd
6539 if you want &'example'& to be the top-level domain. The backslash before the
6540 $ is needed because string expansion also interprets dollar characters.
6541
6542
6543
6544 . ////////////////////////////////////////////////////////////////////////////
6545 . ////////////////////////////////////////////////////////////////////////////
6546
6547 .chapter "File and database lookups" "CHAPfdlookup"
6548 .scindex IIDfidalo1 "file" "lookups"
6549 .scindex IIDfidalo2 "database" "lookups"
6550 .cindex "lookup" "description of"
6551 Exim can be configured to look up data in files or databases as it processes
6552 messages. Two different kinds of syntax are used:
6553
6554 .olist
6555 A string that is to be expanded may contain explicit lookup requests. These
6556 cause parts of the string to be replaced by data that is obtained from the
6557 lookup. Lookups of this type are conditional expansion items. Different results
6558 can be defined for the cases of lookup success and failure. See chapter
6559 &<<CHAPexpand>>&, where string expansions are described in detail.
6560 The key for the lookup is specified as part of the string expansion.
6561 .next
6562 Lists of domains, hosts, and email addresses can contain lookup requests as a
6563 way of avoiding excessively long linear lists. In this case, the data that is
6564 returned by the lookup is often (but not always) discarded; whether the lookup
6565 succeeds or fails is what really counts. These kinds of list are described in
6566 chapter &<<CHAPdomhosaddlists>>&.
6567 The key for the lookup is given by the context in which the list is expanded.
6568 .endlist
6569
6570 String expansions, lists, and lookups interact with each other in such a way
6571 that there is no order in which to describe any one of them that does not
6572 involve references to the others. Each of these three chapters makes more sense
6573 if you have read the other two first. If you are reading this for the first
6574 time, be aware that some of it will make a lot more sense after you have read
6575 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6576
6577 .section "Examples of different lookup syntax" "SECID60"
6578 It is easy to confuse the two different kinds of lookup, especially as the
6579 lists that may contain the second kind are always expanded before being
6580 processed as lists. Therefore, they may also contain lookups of the first kind.
6581 Be careful to distinguish between the following two examples:
6582 .code
6583 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6584 domains = lsearch;/some/file
6585 .endd
6586 The first uses a string expansion, the result of which must be a domain list.
6587 No strings have been specified for a successful or a failing lookup; the
6588 defaults in this case are the looked-up data and an empty string, respectively.
6589 The expansion takes place before the string is processed as a list, and the
6590 file that is searched could contain lines like this:
6591 .code
6592 192.168.3.4: domain1:domain2:...
6593 192.168.1.9: domain3:domain4:...
6594 .endd
6595 When the lookup succeeds, the result of the expansion is a list of domains (and
6596 possibly other types of item that are allowed in domain lists).
6597
6598 In the second example, the lookup is a single item in a domain list. It causes
6599 Exim to use a lookup to see if the domain that is being processed can be found
6600 in the file. The file could contains lines like this:
6601 .code
6602 domain1:
6603 domain2:
6604 .endd
6605 Any data that follows the keys is not relevant when checking that the domain
6606 matches the list item.
6607
6608 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6609 Consider a file containing lines like this:
6610 .code
6611 192.168.5.6: lsearch;/another/file
6612 .endd
6613 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6614 first &%domains%& setting above generates the second setting, which therefore
6615 causes a second lookup to occur.
6616
6617 The rest of this chapter describes the different lookup types that are
6618 available. Any of them can be used in any part of the configuration where a
6619 lookup is permitted.
6620
6621
6622 .section "Lookup types" "SECID61"
6623 .cindex "lookup" "types of"
6624 .cindex "single-key lookup" "definition of"
6625 Two different types of data lookup are implemented:
6626
6627 .ilist
6628 The &'single-key'& type requires the specification of a file in which to look,
6629 and a single key to search for. The key must be a non-empty string for the
6630 lookup to succeed. The lookup type determines how the file is searched.
6631 .next
6632 .cindex "query-style lookup" "definition of"
6633 The &'query-style'& type accepts a generalized database query. No particular
6634 key value is assumed by Exim for query-style lookups. You can use whichever
6635 Exim variables you need to construct the database query.
6636 .endlist
6637
6638 The code for each lookup type is in a separate source file that is included in
6639 the binary of Exim only if the corresponding compile-time option is set. The
6640 default settings in &_src/EDITME_& are:
6641 .code
6642 LOOKUP_DBM=yes
6643 LOOKUP_LSEARCH=yes
6644 .endd
6645 which means that only linear searching and DBM lookups are included by default.
6646 For some types of lookup (e.g. SQL databases), you need to install appropriate
6647 libraries and header files before building Exim.
6648
6649
6650
6651
6652 .section "Single-key lookup types" "SECTsinglekeylookups"
6653 .cindex "lookup" "single-key types"
6654 .cindex "single-key lookup" "list of types"
6655 The following single-key lookup types are implemented:
6656
6657 .ilist
6658 .cindex "cdb" "description of"
6659 .cindex "lookup" "cdb"
6660 .cindex "binary zero" "in lookup key"
6661 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6662 string without a terminating binary zero. The cdb format is designed for
6663 indexed files that are read frequently and never updated, except by total
6664 re-creation. As such, it is particularly suitable for large files containing
6665 aliases or other indexed data referenced by an MTA. Information about cdb and
6666 tools for building the files can be found in several places:
6667 .display
6668 &url(https://cr.yp.to/cdb.html)
6669 &url(http://www.corpit.ru/mjt/tinycdb.html)
6670 &url(https://packages.debian.org/stable/utils/freecdb)
6671 &url(https://github.com/philpennock/cdbtools) (in Go)
6672 .endd
6673 . --- 2018-09-07: corpit.ru http:-only
6674 A cdb distribution is not needed in order to build Exim with cdb support,
6675 because the code for reading cdb files is included directly in Exim itself.
6676 However, no means of building or testing cdb files is provided with Exim, so
6677 you need to obtain a cdb distribution in order to do this.
6678 .next
6679 .cindex "DBM" "lookup type"
6680 .cindex "lookup" "dbm"
6681 .cindex "binary zero" "in lookup key"
6682 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6683 DBM file by looking up the record with the given key. A terminating binary
6684 zero is included in the key that is passed to the DBM library. See section
6685 &<<SECTdb>>& for a discussion of DBM libraries.
6686
6687 .cindex "Berkeley DB library" "file format"
6688 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6689 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6690 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6691 the DB_UNKNOWN option. This enables it to handle any of the types of database
6692 that the library supports, and can be useful for accessing DBM files created by
6693 other applications. (For earlier DB versions, DB_HASH is always used.)
6694 .next
6695 .cindex "lookup" "dbmjz"
6696 .cindex "lookup" "dbm &-- embedded NULs"
6697 .cindex "sasldb2"
6698 .cindex "dbmjz lookup type"
6699 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6700 interpreted as an Exim list; the elements of the list are joined together with
6701 ASCII NUL characters to form the lookup key.  An example usage would be to
6702 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6703 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6704 &(cram_md5)& authenticator.
6705 .next
6706 .cindex "lookup" "dbmnz"
6707 .cindex "lookup" "dbm &-- terminating zero"
6708 .cindex "binary zero" "in lookup key"
6709 .cindex "Courier"
6710 .cindex "&_/etc/userdbshadow.dat_&"
6711 .cindex "dbmnz lookup type"
6712 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6713 is not included in the key that is passed to the DBM library. You may need this
6714 if you want to look up data in files that are created by or shared with some
6715 other application that does not use terminating zeros. For example, you need to
6716 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6717 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6718 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6719 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6720 .next
6721 .cindex "lookup" "dsearch"
6722 .cindex "dsearch lookup type"
6723 &(dsearch)&: The given file must be a directory; this is searched for an entry
6724 whose name is the key by calling the &[lstat()]& function. The key may not
6725 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6726 the lookup is the name of the entry, which may be a file, directory,
6727 symbolic link, or any other kind of directory entry. An example of how this
6728 lookup can be used to support virtual domains is given in section
6729 &<<SECTvirtualdomains>>&.
6730 .next
6731 .cindex "lookup" "iplsearch"
6732 .cindex "iplsearch lookup type"
6733 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6734 terminated by a colon or white space or the end of the line. The keys in the
6735 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6736 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6737 being interpreted as a key terminator. For example:
6738 .code
6739 1.2.3.4:           data for 1.2.3.4
6740 192.168.0.0/16:    data for 192.168.0.0/16
6741 "abcd::cdab":      data for abcd::cdab
6742 "abcd:abcd::/32"   data for abcd:abcd::/32
6743 .endd
6744 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6745 file is searched linearly, using the CIDR masks where present, until a matching
6746 key is found. The first key that matches is used; there is no attempt to find a
6747 &"best"& match. Apart from the way the keys are matched, the processing for
6748 &(iplsearch)& is the same as for &(lsearch)&.
6749
6750 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6751 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6752 lookup types support only literal keys.
6753
6754 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6755 the implicit key is the host's IP address rather than its name (see section
6756 &<<SECThoslispatsikey>>&).
6757
6758 .new
6759 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6760 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6761 notation before executing the lookup.)
6762 .wen
6763 .next
6764 .new
6765 .cindex lookup json
6766 .cindex json "lookup type"
6767 .cindex JSON expansions
6768 &(json)&: The given file is a text file with a JSON structure.
6769 An element of the structure is extracted, defined by the search key.
6770 The key is a list of subelement selectors
6771 (colon-separated by default but changeable in the usual way)
6772 which are applied in turn to select smaller and smaller portions
6773 of the JSON structure.
6774 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6775 nunbered array element is selected.
6776 Otherwise it must apply to a JSON object; the named element is selected.
6777 The final resulting element can be a simple JSON type or a JSON object
6778 or array; for the latter two a string-representation os the JSON
6779 is returned.
6780 For elements of type string, the returned value is de-quoted.
6781 .wen
6782 .next
6783 .cindex "linear search"
6784 .cindex "lookup" "lsearch"
6785 .cindex "lsearch lookup type"
6786 .cindex "case sensitivity" "in lsearch lookup"
6787 &(lsearch)&: The given file is a text file that is searched linearly for a
6788 line beginning with the search key, terminated by a colon or white space or the
6789 end of the line. The search is case-insensitive; that is, upper and lower case
6790 letters are treated as the same. The first occurrence of the key that is found
6791 in the file is used.
6792
6793 White space between the key and the colon is permitted. The remainder of the
6794 line, with leading and trailing white space removed, is the data. This can be
6795 continued onto subsequent lines by starting them with any amount of white
6796 space, but only a single space character is included in the data at such a
6797 junction. If the data begins with a colon, the key must be terminated by a
6798 colon, for example:
6799 .code
6800 baduser:  :fail:
6801 .endd
6802 Empty lines and lines beginning with # are ignored, even if they occur in the
6803 middle of an item. This is the traditional textual format of alias files. Note
6804 that the keys in an &(lsearch)& file are literal strings. There is no
6805 wildcarding of any kind.
6806
6807 .cindex "lookup" "lsearch &-- colons in keys"
6808 .cindex "white space" "in lsearch key"
6809 In most &(lsearch)& files, keys are not required to contain colons or #
6810 characters, or white space. However, if you need this feature, it is available.
6811 If a key begins with a doublequote character, it is terminated only by a
6812 matching quote (or end of line), and the normal escaping rules apply to its
6813 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6814 quoted keys (exactly as for unquoted keys). There is no special handling of
6815 quotes for the data part of an &(lsearch)& line.
6816
6817 .next
6818 .cindex "NIS lookup type"
6819 .cindex "lookup" "NIS"
6820 .cindex "binary zero" "in lookup key"
6821 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6822 the given key, without a terminating binary zero. There is a variant called
6823 &(nis0)& which does include the terminating binary zero in the key. This is
6824 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6825 aliases; the full map names must be used.
6826
6827 .next
6828 .cindex "wildlsearch lookup type"
6829 .cindex "lookup" "wildlsearch"
6830 .cindex "nwildlsearch lookup type"
6831 .cindex "lookup" "nwildlsearch"
6832 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6833 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6834 the file may be wildcarded. The difference between these two lookup types is
6835 that for &(wildlsearch)&, each key in the file is string-expanded before being
6836 used, whereas for &(nwildlsearch)&, no expansion takes place.
6837
6838 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6839 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6840 file that are regular expressions can be made case-sensitive by the use of
6841 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6842
6843 . ==== As this is a nested list, any displays it contains must be indented
6844 . ==== as otherwise they are too far to the left.
6845
6846 .olist
6847 The string may begin with an asterisk to mean &"ends with"&. For example:
6848 .code
6849     *.a.b.c       data for anything.a.b.c
6850     *fish         data for anythingfish
6851 .endd
6852 .next
6853 The string may begin with a circumflex to indicate a regular expression. For
6854 example, for &(wildlsearch)&:
6855 .code
6856     ^\N\d+\.a\.b\N    data for <digits>.a.b
6857 .endd
6858 Note the use of &`\N`& to disable expansion of the contents of the regular
6859 expression. If you are using &(nwildlsearch)&, where the keys are not
6860 string-expanded, the equivalent entry is:
6861 .code
6862     ^\d+\.a\.b        data for <digits>.a.b
6863 .endd
6864 The case-insensitive flag is set at the start of compiling the regular
6865 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6866 For example, to make the entire pattern case-sensitive:
6867 .code
6868     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6869 .endd
6870
6871 If the regular expression contains white space or colon characters, you must
6872 either quote it (see &(lsearch)& above), or represent these characters in other
6873 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6874 colon. This may be easier than quoting, because if you quote, you have to
6875 escape all the backslashes inside the quotes.
6876
6877 &*Note*&: It is not possible to capture substrings in a regular expression
6878 match for later use, because the results of all lookups are cached. If a lookup
6879 is repeated, the result is taken from the cache, and no actual pattern matching
6880 takes place. The values of all the numeric variables are unset after a
6881 &((n)wildlsearch)& match.
6882
6883 .next
6884 Although I cannot see it being of much use, the general matching function that
6885 is used to implement &((n)wildlsearch)& means that the string may begin with a
6886 lookup name terminated by a semicolon, and followed by lookup data. For
6887 example:
6888 .code
6889     cdb;/some/file  data for keys that match the file
6890 .endd
6891 The data that is obtained from the nested lookup is discarded.
6892 .endlist olist
6893
6894 Keys that do not match any of these patterns are interpreted literally. The
6895 continuation rules for the data are the same as for &(lsearch)&, and keys may
6896 be followed by optional colons.
6897
6898 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6899 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6900 lookup types support only literal keys.
6901
6902 .next
6903 .cindex "lookup" "spf"
6904 If Exim is built with SPF support, manual lookups can be done
6905 (as opposed to the standard ACL condition method.
6906 For details see section &<<SECSPF>>&.
6907 .endlist ilist
6908
6909
6910 .section "Query-style lookup types" "SECTquerystylelookups"
6911 .cindex "lookup" "query-style types"
6912 .cindex "query-style lookup" "list of types"
6913 The supported query-style lookup types are listed below. Further details about
6914 many of them are given in later sections.
6915
6916 .ilist
6917 .cindex "DNS" "as a lookup type"
6918 .cindex "lookup" "DNS"
6919 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6920 are given in the supplied query. The resulting data is the contents of the
6921 records. See section &<<SECTdnsdb>>&.
6922 .next
6923 .cindex "InterBase lookup type"
6924 .cindex "lookup" "InterBase"
6925 &(ibase)&: This does a lookup in an InterBase database.
6926 .next
6927 .cindex "LDAP" "lookup type"
6928 .cindex "lookup" "LDAP"
6929 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6930 returns attributes from a single entry. There is a variant called &(ldapm)&
6931 that permits values from multiple entries to be returned. A third variant
6932 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6933 any attribute values. See section &<<SECTldap>>&.
6934 .next
6935 .cindex "MySQL" "lookup type"
6936 .cindex "lookup" "MySQL"
6937 &(mysql)&: The format of the query is an SQL statement that is passed to a
6938 MySQL database. See section &<<SECTsql>>&.
6939 .next
6940 .cindex "NIS+ lookup type"
6941 .cindex "lookup" "NIS+"
6942 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6943 the field to be returned. See section &<<SECTnisplus>>&.
6944 .next
6945 .cindex "Oracle" "lookup type"
6946 .cindex "lookup" "Oracle"
6947 &(oracle)&: The format of the query is an SQL statement that is passed to an
6948 Oracle database. See section &<<SECTsql>>&.
6949 .next
6950 .cindex "lookup" "passwd"
6951 .cindex "passwd lookup type"
6952 .cindex "&_/etc/passwd_&"
6953 &(passwd)& is a query-style lookup with queries that are just user names. The
6954 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6955 success, the result string is the same as you would get from an &(lsearch)&
6956 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6957 password value. For example:
6958 .code
6959 *:42:42:King Rat:/home/kr:/bin/bash
6960 .endd
6961 .next
6962 .cindex "PostgreSQL lookup type"
6963 .cindex "lookup" "PostgreSQL"
6964 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6965 PostgreSQL database. See section &<<SECTsql>>&.
6966
6967 .next
6968 .cindex "Redis lookup type"
6969 .cindex lookup Redis
6970 &(redis)&: The format of the query is either a simple get or simple set,
6971 passed to a Redis database. See section &<<SECTsql>>&.
6972
6973 .next
6974 .cindex "sqlite lookup type"
6975 .cindex "lookup" "sqlite"
6976 &(sqlite)&: The format of the query is a filename followed by an SQL statement
6977 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6978
6979 .next
6980 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6981 not likely to be useful in normal operation.
6982 .next
6983 .cindex "whoson lookup type"
6984 .cindex "lookup" "whoson"
6985 . --- still http:-only, 2018-09-07
6986 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6987 allows a server to check whether a particular (dynamically allocated) IP
6988 address is currently allocated to a known (trusted) user and, optionally, to
6989 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6990 at one time for &"POP before SMTP"& authentication, but that approach has been
6991 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6992 &"POP before SMTP"& checking using ACL statements such as
6993 .code
6994 require condition = \
6995   ${lookup whoson {$sender_host_address}{yes}{no}}
6996 .endd
6997 The query consists of a single IP address. The value returned is the name of
6998 the authenticated user, which is stored in the variable &$value$&. However, in
6999 this example, the data in &$value$& is not used; the result of the lookup is
7000 one of the fixed strings &"yes"& or &"no"&.
7001 .endlist
7002
7003
7004
7005 .section "Temporary errors in lookups" "SECID63"
7006 .cindex "lookup" "temporary error in"
7007 Lookup functions can return temporary error codes if the lookup cannot be
7008 completed. For example, an SQL or LDAP database might be unavailable. For this
7009 reason, it is not advisable to use a lookup that might do this for critical
7010 options such as a list of local domains.
7011
7012 When a lookup cannot be completed in a router or transport, delivery
7013 of the message (to the relevant address) is deferred, as for any other
7014 temporary error. In other circumstances Exim may assume the lookup has failed,
7015 or may give up altogether.
7016
7017
7018
7019 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7020 .cindex "wildcard lookups"
7021 .cindex "lookup" "default values"
7022 .cindex "lookup" "wildcard"
7023 .cindex "lookup" "* added to type"
7024 .cindex "default" "in single-key lookups"
7025 In this context, a &"default value"& is a value specified by the administrator
7026 that is to be used if a lookup fails.
7027
7028 &*Note:*& This section applies only to single-key lookups. For query-style
7029 lookups, the facilities of the query language must be used. An attempt to
7030 specify a default for a query-style lookup provokes an error.
7031
7032 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7033 and the initial lookup fails, the key &"*"& is looked up in the file to
7034 provide a default value. See also the section on partial matching below.
7035
7036 .cindex "*@ with single-key lookup"
7037 .cindex "lookup" "*@ added to type"
7038 .cindex "alias file" "per-domain default"
7039 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7040 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7041 character, a second lookup is done with everything before the last @ replaced
7042 by *. This makes it possible to provide per-domain defaults in alias files
7043 that include the domains in the keys. If the second lookup fails (or doesn't
7044 take place because there is no @ in the key), &"*"& is looked up.
7045 For example, a &(redirect)& router might contain:
7046 .code
7047 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7048 .endd
7049 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7050 looks up these keys, in this order:
7051 .code
7052 jane@eyre.example
7053 *@eyre.example
7054 *
7055 .endd
7056 The data is taken from whichever key it finds first. &*Note*&: In an
7057 &(lsearch)& file, this does not mean the first of these keys in the file. A
7058 complete scan is done for each key, and only if it is not found at all does
7059 Exim move on to try the next key.
7060
7061
7062
7063 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7064 .cindex "partial matching"
7065 .cindex "wildcard lookups"
7066 .cindex "lookup" "partial matching"
7067 .cindex "lookup" "wildcard"
7068 .cindex "asterisk" "in search type"
7069 The normal operation of a single-key lookup is to search the file for an exact
7070 match with the given key. However, in a number of situations where domains are
7071 being looked up, it is useful to be able to do partial matching. In this case,
7072 information in the file that has a key starting with &"*."& is matched by any
7073 domain that ends with the components that follow the full stop. For example, if
7074 a key in a DBM file is
7075 .code
7076 *.dates.fict.example
7077 .endd
7078 then when partial matching is enabled this is matched by (amongst others)
7079 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7080 by &'dates.fict.example'&, if that does not appear as a separate key in the
7081 file.
7082
7083 &*Note*&: Partial matching is not available for query-style lookups. It is
7084 also not available for any lookup items in address lists (see section
7085 &<<SECTaddresslist>>&).
7086
7087 Partial matching is implemented by doing a series of separate lookups using
7088 keys constructed by modifying the original subject key. This means that it can
7089 be used with any of the single-key lookup types, provided that
7090 partial matching keys
7091 beginning with a special prefix (default &"*."&) are included in the data file.
7092 Keys in the file that do not begin with the prefix are matched only by
7093 unmodified subject keys when partial matching is in use.
7094
7095 Partial matching is requested by adding the string &"partial-"& to the front of
7096 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7097 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7098 is added at the start of the subject key, and it is looked up again. If that
7099 fails, further lookups are tried with dot-separated components removed from the
7100 start of the subject key, one-by-one, and &"*."& added on the front of what
7101 remains.
7102
7103 A minimum number of two non-* components are required. This can be adjusted
7104 by including a number before the hyphen in the search type. For example,
7105 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7106 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7107 subject key is &'2250.dates.fict.example'& then the following keys are looked
7108 up when the minimum number of non-* components is two:
7109 .code
7110 2250.dates.fict.example
7111 *.2250.dates.fict.example
7112 *.dates.fict.example
7113 *.fict.example
7114 .endd
7115 As soon as one key in the sequence is successfully looked up, the lookup
7116 finishes.
7117
7118 .cindex "lookup" "partial matching &-- changing prefix"
7119 .cindex "prefix" "for partial matching"
7120 The use of &"*."& as the partial matching prefix is a default that can be
7121 changed. The motivation for this feature is to allow Exim to operate with file
7122 formats that are used by other MTAs. A different prefix can be supplied in
7123 parentheses instead of the hyphen after &"partial"&. For example:
7124 .code
7125 domains = partial(.)lsearch;/some/file
7126 .endd
7127 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7128 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7129 components is unchanged). The prefix may consist of any punctuation characters
7130 other than a closing parenthesis. It may be empty, for example:
7131 .code
7132 domains = partial1()cdb;/some/file
7133 .endd
7134 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7135 &`a.b.c`&, &`b.c`&, and &`c`&.
7136
7137 If &"partial0"& is specified, what happens at the end (when the lookup with
7138 just one non-wild component has failed, and the original key is shortened right
7139 down to the null string) depends on the prefix:
7140
7141 .ilist
7142 If the prefix has zero length, the whole lookup fails.
7143 .next
7144 If the prefix has length 1, a lookup for just the prefix is done. For
7145 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7146 .next
7147 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7148 remainder is looked up. With the default prefix, therefore, the final lookup is
7149 for &"*"& on its own.
7150 .next
7151 Otherwise, the whole prefix is looked up.
7152 .endlist
7153
7154
7155 If the search type ends in &"*"& or &"*@"& (see section
7156 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7157 this implies happens after all partial lookups have failed. If &"partial0"& is
7158 specified, adding &"*"& to the search type has no effect with the default
7159 prefix, because the &"*"& key is already included in the sequence of partial
7160 lookups. However, there might be a use for lookup types such as
7161 &"partial0(.)lsearch*"&.
7162
7163 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7164 in domain lists and the like. Partial matching works only in terms of
7165 dot-separated components; a key such as &`*fict.example`&
7166 in a database file is useless, because the asterisk in a partial matching
7167 subject key is always followed by a dot.
7168
7169
7170
7171
7172 .section "Lookup caching" "SECID64"
7173 .cindex "lookup" "caching"
7174 .cindex "caching" "lookup data"
7175 Exim caches all lookup results in order to avoid needless repetition of
7176 lookups. However, because (apart from the daemon) Exim operates as a collection
7177 of independent, short-lived processes, this caching applies only within a
7178 single Exim process. There is no inter-process lookup caching facility.
7179
7180 For single-key lookups, Exim keeps the relevant files open in case there is
7181 another lookup that needs them. In some types of configuration this can lead to
7182 many files being kept open for messages with many recipients. To avoid hitting
7183 the operating system limit on the number of simultaneously open files, Exim
7184 closes the least recently used file when it needs to open more files than its
7185 own internal limit, which can be changed via the &%lookup_open_max%& option.
7186
7187 The single-key lookup files are closed and the lookup caches are flushed at
7188 strategic points during delivery &-- for example, after all routing is
7189 complete.
7190
7191
7192
7193
7194 .section "Quoting lookup data" "SECID65"
7195 .cindex "lookup" "quoting"
7196 .cindex "quoting" "in lookups"
7197 When data from an incoming message is included in a query-style lookup, there
7198 is the possibility of special characters in the data messing up the syntax of
7199 the query. For example, a NIS+ query that contains
7200 .code
7201 [name=$local_part]
7202 .endd
7203 will be broken if the local part happens to contain a closing square bracket.
7204 For NIS+, data can be enclosed in double quotes like this:
7205 .code
7206 [name="$local_part"]
7207 .endd
7208 but this still leaves the problem of a double quote in the data. The rule for
7209 NIS+ is that double quotes must be doubled. Other lookup types have different
7210 rules, and to cope with the differing requirements, an expansion operator
7211 of the following form is provided:
7212 .code
7213 ${quote_<lookup-type>:<string>}
7214 .endd
7215 For example, the safest way to write the NIS+ query is
7216 .code
7217 [name="${quote_nisplus:$local_part}"]
7218 .endd
7219 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7220 operator can be used for all lookup types, but has no effect for single-key
7221 lookups, since no quoting is ever needed in their key strings.
7222
7223
7224
7225
7226 .section "More about dnsdb" "SECTdnsdb"
7227 .cindex "dnsdb lookup"
7228 .cindex "lookup" "dnsdb"
7229 .cindex "DNS" "as a lookup type"
7230 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7231 of a record type and a domain name, separated by an equals sign. For example,
7232 an expansion string could contain:
7233 .code
7234 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7235 .endd
7236 If the lookup succeeds, the result is placed in &$value$&, which in this case
7237 is used on its own as the result. If the lookup does not succeed, the
7238 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7239 &<<SECTforexpfai>>& for an explanation of what this means.
7240
7241 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7242 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7243 If no type is given, TXT is assumed.
7244
7245 For any record type, if multiple records are found, the data is returned as a
7246 concatenation, with newline as the default separator. The order, of course,
7247 depends on the DNS resolver. You can specify a different separator character
7248 between multiple records by putting a right angle-bracket followed immediately
7249 by the new separator at the start of the query. For example:
7250 .code
7251 ${lookup dnsdb{>: a=host1.example}}
7252 .endd
7253 It is permitted to specify a space as the separator character. Further
7254 white space is ignored.
7255 For lookup types that return multiple fields per record,
7256 an alternate field separator can be specified using a comma after the main
7257 separator character, followed immediately by the field separator.
7258
7259 .cindex "PTR record" "in &(dnsdb)& lookup"
7260 When the type is PTR,
7261 the data can be an IP address, written as normal; inversion and the addition of
7262 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7263 .code
7264 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7265 .endd
7266 If the data for a PTR record is not a syntactically valid IP address, it is not
7267 altered and nothing is added.
7268
7269 .cindex "MX record" "in &(dnsdb)& lookup"
7270 .cindex "SRV record" "in &(dnsdb)& lookup"
7271 For an MX lookup, both the preference value and the host name are returned for
7272 each record, separated by a space. For an SRV lookup, the priority, weight,
7273 port, and host name are returned for each record, separated by spaces.
7274 The field separator can be modified as above.
7275
7276 .cindex "TXT record" "in &(dnsdb)& lookup"
7277 .cindex "SPF record" "in &(dnsdb)& lookup"
7278 For TXT records with multiple items of data, only the first item is returned,
7279 unless a field separator is specified.
7280 To concatenate items without a separator, use a semicolon instead.
7281 For SPF records the
7282 default behaviour is to concatenate multiple items without using a separator.
7283 .code
7284 ${lookup dnsdb{>\n,: txt=a.b.example}}
7285 ${lookup dnsdb{>\n; txt=a.b.example}}
7286 ${lookup dnsdb{spf=example.org}}
7287 .endd
7288 It is permitted to specify a space as the separator character. Further
7289 white space is ignored.
7290
7291 .cindex "SOA record" "in &(dnsdb)& lookup"
7292 For an SOA lookup, while no result is obtained the lookup is redone with
7293 successively more leading components dropped from the given domain.
7294 Only the primary-nameserver field is returned unless a field separator is
7295 specified.
7296 .code
7297 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7298 .endd
7299
7300 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7301 .cindex "dnsdb modifiers"
7302 .cindex "modifiers" "dnsdb"
7303 .cindex "options" "dnsdb"
7304 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7305 each followed by a comma,
7306 that may appear before the record type.
7307
7308 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7309 temporary DNS error for any of them, the behaviour is controlled by
7310 a defer-option modifier.
7311 The possible keywords are
7312 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7313 With &"strict"& behaviour, any temporary DNS error causes the
7314 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7315 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7316 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7317 error causes the whole lookup to defer only if none of the other lookups
7318 succeed. The default is &"lax"&, so the following lookups are equivalent:
7319 .code
7320 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7321 ${lookup dnsdb{a=one.host.com:two.host.com}}
7322 .endd
7323 Thus, in the default case, as long as at least one of the DNS lookups
7324 yields some data, the lookup succeeds.
7325
7326 .cindex "DNSSEC" "dns lookup"
7327 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7328 The possible keywords are
7329 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7330 With &"strict"& or &"lax"& DNSSEC information is requested
7331 with the lookup.
7332 With &"strict"& a response from the DNS resolver that
7333 is not labelled as authenticated data
7334 is treated as equivalent to a temporary DNS error.
7335 The default is &"lax"&.
7336
7337 See also the &$lookup_dnssec_authenticated$& variable.
7338
7339 .cindex timeout "dns lookup"
7340 .cindex "DNS" timeout
7341 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7342 The form is &"retrans_VAL"& where VAL is an Exim time specification
7343 (e.g. &"5s"&).
7344 The default value is set by the main configuration option &%dns_retrans%&.
7345
7346 Retries for the dnsdb lookup can be controlled by a retry modifier.
7347 The form if &"retry_VAL"& where VAL is an integer.
7348 The default count is set by the main configuration option &%dns_retry%&.
7349
7350 .cindex caching "of dns lookup"
7351 .cindex TTL "of dns lookup"
7352 .cindex DNS TTL
7353 Dnsdb lookup results are cached within a single process (and its children).
7354 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7355 value of the set of returned DNS records.
7356
7357
7358 .section "Pseudo dnsdb record types" "SECID66"
7359 .cindex "MX record" "in &(dnsdb)& lookup"
7360 By default, both the preference value and the host name are returned for
7361 each MX record, separated by a space. If you want only host names, you can use
7362 the pseudo-type MXH:
7363 .code
7364 ${lookup dnsdb{mxh=a.b.example}}
7365 .endd
7366 In this case, the preference values are omitted, and just the host names are
7367 returned.
7368
7369 .cindex "name server for enclosing domain"
7370 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7371 records on the given domain, but if none are found, it removes the first
7372 component of the domain name, and tries again. This process continues until NS
7373 records are found or there are no more components left (or there is a DNS
7374 error). In other words, it may return the name servers for a top-level domain,
7375 but it never returns the root name servers. If there are no NS records for the
7376 top-level domain, the lookup fails. Consider these examples:
7377 .code
7378 ${lookup dnsdb{zns=xxx.quercite.com}}
7379 ${lookup dnsdb{zns=xxx.edu}}
7380 .endd
7381 Assuming that in each case there are no NS records for the full domain name,
7382 the first returns the name servers for &%quercite.com%&, and the second returns
7383 the name servers for &%edu%&.
7384
7385 You should be careful about how you use this lookup because, unless the
7386 top-level domain does not exist, the lookup always returns some host names. The
7387 sort of use to which this might be put is for seeing if the name servers for a
7388 given domain are on a blacklist. You can probably assume that the name servers
7389 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7390 such a list.
7391
7392 .cindex "CSA" "in &(dnsdb)& lookup"
7393 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7394 records according to the CSA rules, which are described in section
7395 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7396 not sufficient because of the extra parent domain search behaviour of CSA. The
7397 result of a successful lookup such as:
7398 .code
7399 ${lookup dnsdb {csa=$sender_helo_name}}
7400 .endd
7401 has two space-separated fields: an authorization code and a target host name.
7402 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7403 authorization required but absent, or &"?"& for unknown.
7404
7405 .cindex "A+" "in &(dnsdb)& lookup"
7406 The pseudo-type A+ performs an AAAA
7407 and then an A lookup.  All results are returned; defer processing
7408 (see below) is handled separately for each lookup.  Example:
7409 .code
7410 ${lookup dnsdb {>; a+=$sender_helo_name}}
7411 .endd
7412
7413
7414 .section "Multiple dnsdb lookups" "SECID67"
7415 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7416 However, you can specify a list of domains or IP addresses in a single
7417 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7418 the default separator, but with the ability to change this. For example:
7419 .code
7420 ${lookup dnsdb{one.domain.com:two.domain.com}}
7421 ${lookup dnsdb{a=one.host.com:two.host.com}}
7422 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7423 .endd
7424 In order to retain backwards compatibility, there is one special case: if
7425 the lookup type is PTR and no change of separator is specified, Exim looks
7426 to see if the rest of the string is precisely one IPv6 address. In this
7427 case, it does not treat it as a list.
7428
7429 The data from each lookup is concatenated, with newline separators by default,
7430 in the same way that multiple DNS records for a single item are handled. A
7431 different separator can be specified, as described above.
7432
7433
7434
7435
7436 .section "More about LDAP" "SECTldap"
7437 .cindex "LDAP" "lookup, more about"
7438 .cindex "lookup" "LDAP"
7439 .cindex "Solaris" "LDAP"
7440 The original LDAP implementation came from the University of Michigan; this has
7441 become &"Open LDAP"&, and there are now two different releases. Another
7442 implementation comes from Netscape, and Solaris 7 and subsequent releases
7443 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7444 the lookup function level, their error handling is different. For this reason
7445 it is necessary to set a compile-time variable when building Exim with LDAP, to
7446 indicate which LDAP library is in use. One of the following should appear in
7447 your &_Local/Makefile_&:
7448 .code
7449 LDAP_LIB_TYPE=UMICHIGAN
7450 LDAP_LIB_TYPE=OPENLDAP1
7451 LDAP_LIB_TYPE=OPENLDAP2
7452 LDAP_LIB_TYPE=NETSCAPE
7453 LDAP_LIB_TYPE=SOLARIS
7454 .endd
7455 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7456 same interface as the University of Michigan version.
7457
7458 There are three LDAP lookup types in Exim. These behave slightly differently in
7459 the way they handle the results of a query:
7460
7461 .ilist
7462 &(ldap)& requires the result to contain just one entry; if there are more, it
7463 gives an error.
7464 .next
7465 &(ldapdn)& also requires the result to contain just one entry, but it is the
7466 Distinguished Name that is returned rather than any attribute values.
7467 .next
7468 &(ldapm)& permits the result to contain more than one entry; the attributes
7469 from all of them are returned.
7470 .endlist
7471
7472
7473 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7474 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7475 the data returned by a successful lookup is described in the next section.
7476 First we explain how LDAP queries are coded.
7477
7478
7479 .section "Format of LDAP queries" "SECTforldaque"
7480 .cindex "LDAP" "query format"
7481 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7482 the configuration of a &(redirect)& router one might have this setting:
7483 .code
7484 data = ${lookup ldap \
7485   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7486   c=UK?mailbox?base?}}
7487 .endd
7488 .cindex "LDAP" "with TLS"
7489 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7490 secure (encrypted) LDAP connections. The second of these ensures that an
7491 encrypted TLS connection is used.
7492
7493 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7494 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7495 See the &%ldap_start_tls%& option.
7496
7497 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7498 controlled. Every part of the TLS configuration can be configured by settings in
7499 &_exim.conf_&. Depending on the version of the client libraries installed on
7500 your system, some of the initialization may have required setting options in
7501 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7502 certificates. This revealed a nuance where the current UID that exim was
7503 running as could affect which config files it read. With Exim 4.83, these
7504 methods become optional, only taking effect if not specifically set in
7505 &_exim.conf_&.
7506
7507
7508 .section "LDAP quoting" "SECID68"
7509 .cindex "LDAP" "quoting"
7510 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7511 and the second because the LDAP query is represented as a URL. Furthermore,
7512 within an LDAP query, two different kinds of quoting are required. For this
7513 reason, there are two different LDAP-specific quoting operators.
7514
7515 The &%quote_ldap%& operator is designed for use on strings that are part of
7516 filter specifications. Conceptually, it first does the following conversions on
7517 the string:
7518 .code
7519 *   =>   \2A
7520 (   =>   \28
7521 )   =>   \29
7522 \   =>   \5C
7523 .endd
7524 in accordance with RFC 2254. The resulting string is then quoted according
7525 to the rules for URLs, that is, all non-alphanumeric characters except
7526 .code
7527 ! $ ' - . _ ( ) * +
7528 .endd
7529 are converted to their hex values, preceded by a percent sign. For example:
7530 .code
7531 ${quote_ldap: a(bc)*, a<yz>; }
7532 .endd
7533 yields
7534 .code
7535 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7536 .endd
7537 Removing the URL quoting, this is (with a leading and a trailing space):
7538 .code
7539 a\28bc\29\2A, a<yz>;
7540 .endd
7541 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7542 base DN specifications in queries. Conceptually, it first converts the string
7543 by inserting a backslash in front of any of the following characters:
7544 .code
7545 , + " \ < > ;
7546 .endd
7547 It also inserts a backslash before any leading spaces or # characters, and
7548 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7549 is then quoted according to the rules for URLs. For example:
7550 .code
7551 ${quote_ldap_dn: a(bc)*, a<yz>; }
7552 .endd
7553 yields
7554 .code
7555 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7556 .endd
7557 Removing the URL quoting, this is (with a trailing space):
7558 .code
7559 \ a(bc)*\, a\<yz\>\;\
7560 .endd
7561 There are some further comments about quoting in the section on LDAP
7562 authentication below.
7563
7564
7565 .section "LDAP connections" "SECID69"
7566 .cindex "LDAP" "connections"
7567 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7568 is in use, via a Unix domain socket. The example given above does not specify
7569 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7570 by starting it with
7571 .code
7572 ldap://<hostname>:<port>/...
7573 .endd
7574 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7575 used. When no server is specified in a query, a list of default servers is
7576 taken from the &%ldap_default_servers%& configuration option. This supplies a
7577 colon-separated list of servers which are tried in turn until one successfully
7578 handles a query, or there is a serious error. Successful handling either
7579 returns the requested data, or indicates that it does not exist. Serious errors
7580 are syntactical, or multiple values when only a single value is expected.
7581 Errors which cause the next server to be tried are connection failures, bind
7582 failures, and timeouts.
7583
7584 For each server name in the list, a port number can be given. The standard way
7585 of specifying a host and port is to use a colon separator (RFC 1738). Because
7586 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7587 doubled. For example
7588 .code
7589 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7590 .endd
7591 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7592 to the LDAP library with no server name, and the library's default (normally
7593 the local host) is used.
7594
7595 If you are using the OpenLDAP library, you can connect to an LDAP server using
7596 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7597 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7598 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7599 not available.
7600
7601 For this type of connection, instead of a host name for the server, a pathname
7602 for the socket is required, and the port number is not relevant. The pathname
7603 can be specified either as an item in &%ldap_default_servers%&, or inline in
7604 the query. In the former case, you can have settings such as
7605 .code
7606 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7607 .endd
7608 When the pathname is given in the query, you have to escape the slashes as
7609 &`%2F`& to fit in with the LDAP URL syntax. For example:
7610 .code
7611 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7612 .endd
7613 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7614 a pathname, it uses the Unix domain socket code, even if the query actually
7615 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7616 socket connection. This behaviour means that you can use a setting of
7617 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7618 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7619 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7620 backup host.
7621
7622 If an explicit &`ldapi`& type is given in a query when a host name is
7623 specified, an error is diagnosed. However, if there are more items in
7624 &%ldap_default_servers%&, they are tried. In other words:
7625
7626 .ilist
7627 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7628 interface.
7629 .next
7630 Using &`ldapi`& with a host name causes an error.
7631 .endlist
7632
7633
7634 Using &`ldapi`& with no host or path in the query, and no setting of
7635 &%ldap_default_servers%&, does whatever the library does by default.
7636
7637
7638
7639 .section "LDAP authentication and control information" "SECID70"
7640 .cindex "LDAP" "authentication"
7641 The LDAP URL syntax provides no way of passing authentication and other control
7642 information to the server. To make this possible, the URL in an LDAP query may
7643 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7644 spaces. If a value contains spaces it must be enclosed in double quotes, and
7645 when double quotes are used, backslash is interpreted in the usual way inside
7646 them. The following names are recognized:
7647 .display
7648 &`DEREFERENCE`&  set the dereferencing parameter
7649 &`NETTIME    `&  set a timeout for a network operation
7650 &`USER       `&  set the DN, for authenticating the LDAP bind
7651 &`PASS       `&  set the password, likewise
7652 &`REFERRALS  `&  set the referrals parameter
7653 &`SERVERS    `&  set alternate server list for this query only
7654 &`SIZE       `&  set the limit for the number of entries returned
7655 &`TIME       `&  set the maximum waiting time for a query
7656 .endd
7657 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7658 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7659 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7660 library from trying to follow referrals issued by the LDAP server.
7661
7662 .cindex LDAP timeout
7663 .cindex timeout "LDAP lookup"
7664 The name CONNECT is an obsolete name for NETTIME, retained for
7665 backwards compatibility. This timeout (specified as a number of seconds) is
7666 enforced from the client end for operations that can be carried out over a
7667 network. Specifically, it applies to network connections and calls to the
7668 &'ldap_result()'& function. If the value is greater than zero, it is used if
7669 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7670 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7671 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7672 Netscape SDK; for OpenLDAP no action is taken.
7673
7674 The TIME parameter (also a number of seconds) is passed to the server to
7675 set a server-side limit on the time taken to complete a search.
7676
7677 The SERVERS parameter allows you to specify an alternate list of ldap servers
7678 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7679 default list of ldap servers, and a single lookup can specify a single ldap
7680 server to use.  But when you need to do a lookup with a list of servers that is
7681 different than the default list (maybe different order, maybe a completely
7682 different set of servers), the SERVERS parameter allows you to specify this
7683 alternate list (colon-separated).
7684
7685 Here is an example of an LDAP query in an Exim lookup that uses some of these
7686 values. This is a single line, folded to fit on the page:
7687 .code
7688 ${lookup ldap
7689   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7690   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7691   {$value}fail}
7692 .endd
7693 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7694 any of the auxiliary data. Exim configuration settings that include lookups
7695 which contain password information should be preceded by &"hide"& to prevent
7696 non-admin users from using the &%-bP%& option to see their values.
7697
7698 The auxiliary data items may be given in any order. The default is no
7699 connection timeout (the system timeout is used), no user or password, no limit
7700 on the number of entries returned, and no time limit on queries.
7701
7702 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7703 removes any URL quoting that it may contain before passing it LDAP. Apparently
7704 some libraries do this for themselves, but some do not. Removing the URL
7705 quoting has two advantages:
7706
7707 .ilist
7708 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7709 DNs as with DNs inside actual queries.
7710 .next
7711 It permits spaces inside USER= DNs.
7712 .endlist
7713
7714 For example, a setting such as
7715 .code
7716 USER=cn=${quote_ldap_dn:$1}
7717 .endd
7718 should work even if &$1$& contains spaces.
7719
7720 Expanded data for the PASS= value should be quoted using the &%quote%&
7721 expansion operator, rather than the LDAP quote operators. The only reason this
7722 field needs quoting is to ensure that it conforms to the Exim syntax, which
7723 does not allow unquoted spaces. For example:
7724 .code
7725 PASS=${quote:$3}
7726 .endd
7727 The LDAP authentication mechanism can be used to check passwords as part of
7728 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7729 &<<CHAPexpand>>&.
7730
7731
7732
7733 .section "Format of data returned by LDAP" "SECID71"
7734 .cindex "LDAP" "returned data formats"
7735 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7736 as a sequence of values, for example
7737 .code
7738 cn=manager,o=University of Cambridge,c=UK
7739 .endd
7740 The &(ldap)& lookup type generates an error if more than one entry matches the
7741 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7742 the result between the data from different entries. It is possible for multiple
7743 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7744 you know that whatever values are returned all came from a single entry in the
7745 directory.
7746
7747 In the common case where you specify a single attribute in your LDAP query, the
7748 result is not quoted, and does not contain the attribute name. If the attribute
7749 has multiple values, they are separated by commas. Any comma that is
7750 part of an attribute's value is doubled.
7751
7752 If you specify multiple attributes, the result contains space-separated, quoted
7753 strings, each preceded by the attribute name and an equals sign. Within the
7754 quotes, the quote character, backslash, and newline are escaped with
7755 backslashes, and commas are used to separate multiple values for the attribute.
7756 Any commas in attribute values are doubled
7757 (permitting treatment of the values as a comma-separated list).
7758 Apart from the escaping, the string within quotes takes the same form as the
7759 output when a single attribute is requested. Specifying no attributes is the
7760 same as specifying all of an entry's attributes.
7761
7762 Here are some examples of the output format. The first line of each pair is an
7763 LDAP query, and the second is the data that is returned. The attribute called
7764 &%attr1%& has two values, one of them with an embedded comma, whereas
7765 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7766 (they have SUP &%attr%& in their schema definitions).
7767
7768 .code
7769 ldap:///o=base?attr1?sub?(uid=fred)
7770 value1.1,value1,,2
7771
7772 ldap:///o=base?attr2?sub?(uid=fred)
7773 value two
7774
7775 ldap:///o=base?attr?sub?(uid=fred)
7776 value1.1,value1,,2,value two
7777
7778 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7779 attr1="value1.1,value1,,2" attr2="value two"
7780
7781 ldap:///o=base??sub?(uid=fred)
7782 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7783 .endd
7784 You can
7785 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7786 results of LDAP lookups.
7787 The &%extract%& operator in string expansions can be used to pick out
7788 individual fields from data that consists of &'key'&=&'value'& pairs.
7789 The &%listextract%& operator should be used to pick out individual values
7790 of attributes, even when only a single value is expected.
7791 The doubling of embedded commas allows you to use the returned data as a
7792 comma separated list (using the "<," syntax for changing the input list separator).
7793
7794
7795
7796
7797 .section "More about NIS+" "SECTnisplus"
7798 .cindex "NIS+ lookup type"
7799 .cindex "lookup" "NIS+"
7800 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7801 and field name. If this is given, the result of a successful query is the
7802 contents of the named field; otherwise the result consists of a concatenation
7803 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7804 values containing spaces are quoted. For example, the query
7805 .code
7806 [name=mg1456],passwd.org_dir
7807 .endd
7808 might return the string
7809 .code
7810 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7811 home=/home/mg1456 shell=/bin/bash shadow=""
7812 .endd
7813 (split over two lines here to fit on the page), whereas
7814 .code
7815 [name=mg1456],passwd.org_dir:gcos
7816 .endd
7817 would just return
7818 .code
7819 Martin Guerre
7820 .endd
7821 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7822 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7823 operator is to double any quote characters within the text.
7824
7825
7826
7827 .section "SQL lookups" "SECTsql"
7828 .cindex "SQL lookup types"
7829 .cindex "MySQL" "lookup type"
7830 .cindex "PostgreSQL lookup type"
7831 .cindex "lookup" "MySQL"
7832 .cindex "lookup" "PostgreSQL"
7833 .cindex "Oracle" "lookup type"
7834 .cindex "lookup" "Oracle"
7835 .cindex "InterBase lookup type"
7836 .cindex "lookup" "InterBase"
7837 .cindex "Redis lookup type"
7838 .cindex lookup Redis
7839 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7840 and SQLite
7841 databases. Queries for these databases contain SQL statements, so an example
7842 might be
7843 .code
7844 ${lookup mysql{select mailbox from users where id='userx'}\
7845   {$value}fail}
7846 .endd
7847 If the result of the query contains more than one field, the data for each
7848 field in the row is returned, preceded by its name, so the result of
7849 .code
7850 ${lookup pgsql{select home,name from users where id='userx'}\
7851   {$value}}
7852 .endd
7853 might be
7854 .code
7855 home=/home/userx name="Mister X"
7856 .endd
7857 Empty values and values containing spaces are double quoted, with embedded
7858 quotes escaped by a backslash. If the result of the query contains just one
7859 field, the value is passed back verbatim, without a field name, for example:
7860 .code
7861 Mister X
7862 .endd
7863 If the result of the query yields more than one row, it is all concatenated,
7864 with a newline between the data for each row.
7865
7866
7867 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7868 .cindex "MySQL" "lookup type"
7869 .cindex "PostgreSQL lookup type"
7870 .cindex "lookup" "MySQL"
7871 .cindex "lookup" "PostgreSQL"
7872 .cindex "Oracle" "lookup type"
7873 .cindex "lookup" "Oracle"
7874 .cindex "InterBase lookup type"
7875 .cindex "lookup" "InterBase"
7876 .cindex "Redis lookup type"
7877 .cindex lookup Redis
7878 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7879 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7880 or &%redis_servers%&
7881 option (as appropriate) must be set to a colon-separated list of server
7882 information.
7883 (For MySQL and PostgreSQL, the global option need not be set if all
7884 queries contain their own server information &-- see section
7885 &<<SECTspeserque>>&.)
7886 For all but Redis
7887 each item in the list is a slash-separated list of four
7888 items: host name, database name, user name, and password. In the case of
7889 Oracle, the host name field is used for the &"service name"&, and the database
7890 name field is not used and should be empty. For example:
7891 .code
7892 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7893 .endd
7894 Because password data is sensitive, you should always precede the setting with
7895 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7896 option. Here is an example where two MySQL servers are listed:
7897 .code
7898 hide mysql_servers = localhost/users/root/secret:\
7899                      otherhost/users/root/othersecret
7900 .endd
7901 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7902 because this is a colon-separated list, the colon has to be doubled. For each
7903 query, these parameter groups are tried in order until a connection is made and
7904 a query is successfully processed. The result of a query may be that no data is
7905 found, but that is still a successful query. In other words, the list of
7906 servers provides a backup facility, not a list of different places to look.
7907
7908 For Redis the global option need not be specified if all queries contain their
7909 own server information &-- see section &<<SECTspeserque>>&.
7910 If specified, the option must be set to a colon-separated list of server
7911 information.
7912 Each item in the list is a slash-separated list of three items:
7913 host, database number, and password.
7914 .olist
7915 The host is required and may be either an IPv4 address and optional
7916 port number (separated by a colon, which needs doubling due to the
7917 higher-level list), or a Unix socket pathname enclosed in parentheses
7918 .next
7919 The database number is optional; if present that number is selected in the backend
7920 .next
7921 The password is optional; if present it is used to authenticate to the backend
7922 .endlist
7923
7924 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7925 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7926 respectively, and the characters single-quote, double-quote, and backslash
7927 itself are escaped with backslashes.
7928
7929 The &%quote_redis%& expansion operator
7930 escapes whitespace and backslash characters with a backslash.
7931
7932 .section "Specifying the server in the query" "SECTspeserque"
7933 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7934 it is possible to specify a list of servers with an individual query. This is
7935 done by starting the query with
7936 .display
7937 &`servers=`&&'server1:server2:server3:...'&&`;`&
7938 .endd
7939 Each item in the list may take one of two forms:
7940 .olist
7941 If it contains no slashes it is assumed to be just a host name. The appropriate
7942 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7943 of the same name, and the remaining parameters (database, user, password) are
7944 taken from there.
7945 .next
7946 If it contains any slashes, it is taken as a complete parameter set.
7947 .endlist
7948 The list of servers is used in exactly the same way as the global list.
7949 Once a connection to a server has happened and a query has been
7950 successfully executed, processing of the lookup ceases.
7951
7952 This feature is intended for use in master/slave situations where updates
7953 are occurring and you want to update the master rather than a slave. If the
7954 master is in the list as a backup for reading, you might have a global setting
7955 like this:
7956 .code
7957 mysql_servers = slave1/db/name/pw:\
7958                 slave2/db/name/pw:\
7959                 master/db/name/pw
7960 .endd
7961 In an updating lookup, you could then write:
7962 .code
7963 ${lookup mysql{servers=master; UPDATE ...} }
7964 .endd
7965 That query would then be sent only to the master server. If, on the other hand,
7966 the master is not to be used for reading, and so is not present in the global
7967 option, you can still update it by a query of this form:
7968 .code
7969 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7970 .endd
7971
7972
7973 .section "Special MySQL features" "SECID73"
7974 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7975 causes a connection to the server on the local host by means of a Unix domain
7976 socket. An alternate socket can be specified in parentheses.
7977 An option group name for MySQL option files can be specified in square brackets;
7978 the default value is &"exim"&.
7979 The full syntax of each item in &%mysql_servers%& is:
7980 .display
7981 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7982   <&'database'&>/<&'user'&>/<&'password'&>
7983 .endd
7984 Any of the four sub-parts of the first field can be omitted. For normal use on
7985 the local host it can be left blank or set to just &"localhost"&.
7986
7987 No database need be supplied &-- but if it is absent here, it must be given in
7988 the queries.
7989
7990 If a MySQL query is issued that does not request any data (an insert, update,
7991 or delete command), the result of the lookup is the number of rows affected.
7992
7993 &*Warning*&: This can be misleading. If an update does not actually change
7994 anything (for example, setting a field to the value it already has), the result
7995 is zero because no rows are affected.
7996
7997
7998 .section "Special PostgreSQL features" "SECID74"
7999 PostgreSQL lookups can also use Unix domain socket connections to the database.
8000 This is usually faster and costs less CPU time than a TCP/IP connection.
8001 However it can be used only if the mail server runs on the same machine as the
8002 database server. A configuration line for PostgreSQL via Unix domain sockets
8003 looks like this:
8004 .code
8005 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8006 .endd
8007 In other words, instead of supplying a host name, a path to the socket is
8008 given. The path name is enclosed in parentheses so that its slashes aren't
8009 visually confused with the delimiters for the other server parameters.
8010
8011 If a PostgreSQL query is issued that does not request any data (an insert,
8012 update, or delete command), the result of the lookup is the number of rows
8013 affected.
8014
8015 .section "More about SQLite" "SECTsqlite"
8016 .cindex "lookup" "SQLite"
8017 .cindex "sqlite lookup type"
8018 SQLite is different to the other SQL lookups because a filename is required in
8019 addition to the SQL query. An SQLite database is a single file, and there is no
8020 daemon as in the other SQL databases. The interface to Exim requires the name
8021 of the file, as an absolute path, to be given at the start of the query. It is
8022 separated from the query by white space. This means that the path name cannot
8023 contain white space. Here is a lookup expansion example:
8024 .code
8025 ${lookup sqlite {/some/thing/sqlitedb \
8026   select name from aliases where id='userx';}}
8027 .endd
8028 In a list, the syntax is similar. For example:
8029 .code
8030 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8031    select * from relays where ip='$sender_host_address';
8032 .endd
8033 The only character affected by the &%quote_sqlite%& operator is a single
8034 quote, which it doubles.
8035
8036 .cindex timeout SQLite
8037 .cindex sqlite "lookup timeout"
8038 The SQLite library handles multiple simultaneous accesses to the database
8039 internally. Multiple readers are permitted, but only one process can
8040 update at once. Attempts to access the database while it is being updated
8041 are rejected after a timeout period, during which the SQLite library
8042 waits for the lock to be released. In Exim, the default timeout is set
8043 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8044 option.
8045
8046 .section "More about Redis" "SECTredis"
8047 .cindex "lookup" "Redis"
8048 .cindex "redis lookup type"
8049 Redis is a non-SQL database. Commands are simple get and set.
8050 Examples:
8051 .code
8052 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8053 ${lookup redis{get keyname}}
8054 .endd
8055
8056 As of release 4.91, "lightweight" support for Redis Cluster is available.
8057 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8058 of which must be reachable from the running exim instance. If the cluster has
8059 master/slave replication, the list must contain all the master and slave
8060 servers.
8061
8062 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8063 immediately follow the redirection but treats the response as a DEFER, moving on
8064 to the next server in the &%redis_servers%& list until the correct server is
8065 reached.
8066
8067 .ecindex IIDfidalo1
8068 .ecindex IIDfidalo2
8069
8070
8071 . ////////////////////////////////////////////////////////////////////////////
8072 . ////////////////////////////////////////////////////////////////////////////
8073
8074 .chapter "Domain, host, address, and local part lists" &&&
8075          "CHAPdomhosaddlists" &&&
8076          "Domain, host, and address lists"
8077 .scindex IIDdohoadli "lists of domains; hosts; etc."
8078 A number of Exim configuration options contain lists of domains, hosts,
8079 email addresses, or local parts. For example, the &%hold_domains%& option
8080 contains a list of domains whose delivery is currently suspended. These lists
8081 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8082 arguments to expansion conditions such as &%match_domain%&.
8083
8084 Each item in one of these lists is a pattern to be matched against a domain,
8085 host, email address, or local part, respectively. In the sections below, the
8086 different types of pattern for each case are described, but first we cover some
8087 general facilities that apply to all four kinds of list.
8088
8089 Note that other parts of Exim use a &'string list'& which does not
8090 support all the complexity available in
8091 domain, host, address and local part lists.
8092
8093
8094
8095 .section "Expansion of lists" "SECTlistexpand"
8096 .cindex "expansion" "of lists"
8097 Each list is expanded as a single string before it is used.
8098
8099 &'Exception: the router headers_remove option, where list-item
8100 splitting is done before string-expansion.'&
8101
8102 The result of
8103 expansion must be a list, possibly containing empty items, which is split up
8104 into separate items for matching. By default, colon is the separator character,
8105 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8106 &<<SECTempitelis>>& for details of the list syntax; the second of these
8107 discusses the way to specify empty list items.
8108
8109
8110 If the string expansion is forced to fail, Exim behaves as if the item it is
8111 testing (domain, host, address, or local part) is not in the list. Other
8112 expansion failures cause temporary errors.
8113
8114 If an item in a list is a regular expression, backslashes, dollars and possibly
8115 other special characters in the expression must be protected against
8116 misinterpretation by the string expander. The easiest way to do this is to use
8117 the &`\N`& expansion feature to indicate that the contents of the regular
8118 expression should not be expanded. For example, in an ACL you might have:
8119 .code
8120 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8121                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8122 .endd
8123 The first item is a regular expression that is protected from expansion by
8124 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8125 senders based on the receiving domain.
8126
8127
8128
8129
8130 .section "Negated items in lists" "SECID76"
8131 .cindex "list" "negation"
8132 .cindex "negation" "in lists"
8133 Items in a list may be positive or negative. Negative items are indicated by a
8134 leading exclamation mark, which may be followed by optional white space. A list
8135 defines a set of items (domains, etc). When Exim processes one of these lists,
8136 it is trying to find out whether a domain, host, address, or local part
8137 (respectively) is in the set that is defined by the list. It works like this:
8138
8139 The list is scanned from left to right. If a positive item is matched, the
8140 subject that is being checked is in the set; if a negative item is matched, the
8141 subject is not in the set. If the end of the list is reached without the
8142 subject having matched any of the patterns, it is in the set if the last item
8143 was a negative one, but not if it was a positive one. For example, the list in
8144 .code
8145 domainlist relay_to_domains = !a.b.c : *.b.c
8146 .endd
8147 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8148 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8149 list is positive. However, if the setting were
8150 .code
8151 domainlist relay_to_domains = !a.b.c
8152 .endd
8153 then all domains other than &'a.b.c'& would match because the last item in the
8154 list is negative. In other words, a list that ends with a negative item behaves
8155 as if it had an extra item &`:*`& on the end.
8156
8157 Another way of thinking about positive and negative items in lists is to read
8158 the connector as &"or"& after a positive item and as &"and"& after a negative
8159 item.
8160
8161
8162
8163 .section "File names in lists" "SECTfilnamlis"
8164 .cindex "list" "filename in"
8165 If an item in a domain, host, address, or local part list is an absolute
8166 filename (beginning with a slash character), each line of the file is read and
8167 processed as if it were an independent item in the list, except that further
8168 filenames are not allowed,
8169 and no expansion of the data from the file takes place.
8170 Empty lines in the file are ignored, and the file may also contain comment
8171 lines:
8172
8173 .ilist
8174 For domain and host lists, if a # character appears anywhere in a line of the
8175 file, it and all following characters are ignored.
8176 .next
8177 Because local parts may legitimately contain # characters, a comment in an
8178 address list or local part list file is recognized only if # is preceded by
8179 white space or the start of the line. For example:
8180 .code
8181 not#comment@x.y.z   # but this is a comment
8182 .endd
8183 .endlist
8184
8185 Putting a filename in a list has the same effect as inserting each line of the
8186 file as an item in the list (blank lines and comments excepted). However, there
8187 is one important difference: the file is read each time the list is processed,
8188 so if its contents vary over time, Exim's behaviour changes.
8189
8190 If a filename is preceded by an exclamation mark, the sense of any match
8191 within the file is inverted. For example, if
8192 .code
8193 hold_domains = !/etc/nohold-domains
8194 .endd
8195 and the file contains the lines
8196 .code
8197 !a.b.c
8198 *.b.c
8199 .endd
8200 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8201 any domain matching &`*.b.c`& is not.
8202
8203
8204
8205 .section "An lsearch file is not an out-of-line list" "SECID77"
8206 As will be described in the sections that follow, lookups can be used in lists
8207 to provide indexed methods of checking list membership. There has been some
8208 confusion about the way &(lsearch)& lookups work in lists. Because
8209 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8210 sometimes thought that it is allowed to contain wild cards and other kinds of
8211 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8212 always fixed strings, just as for any other single-key lookup type.
8213
8214 If you want to use a file to contain wild-card patterns that form part of a
8215 list, just give the filename on its own, without a search type, as described
8216 in the previous section. You could also use the &(wildlsearch)& or
8217 &(nwildlsearch)&, but there is no advantage in doing this.
8218
8219
8220
8221
8222 .section "Named lists" "SECTnamedlists"
8223 .cindex "named lists"
8224 .cindex "list" "named"
8225 A list of domains, hosts, email addresses, or local parts can be given a name
8226 which is then used to refer to the list elsewhere in the configuration. This is
8227 particularly convenient if the same list is required in several different
8228 places. It also allows lists to be given meaningful names, which can improve
8229 the readability of the configuration. For example, it is conventional to define
8230 a domain list called &'local_domains'& for all the domains that are handled
8231 locally on a host, using a configuration line such as
8232 .code
8233 domainlist local_domains = localhost:my.dom.example
8234 .endd
8235 Named lists are referenced by giving their name preceded by a plus sign, so,
8236 for example, a router that is intended to handle local domains would be
8237 configured with the line
8238 .code
8239 domains = +local_domains
8240 .endd
8241 The first router in a configuration is often one that handles all domains
8242 except the local ones, using a configuration with a negated item like this:
8243 .code
8244 dnslookup:
8245   driver = dnslookup
8246   domains = ! +local_domains
8247   transport = remote_smtp
8248   no_more
8249 .endd
8250 The four kinds of named list are created by configuration lines starting with
8251 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8252 respectively. Then there follows the name that you are defining, followed by an
8253 equals sign and the list itself. For example:
8254 .code
8255 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8256 addresslist bad_senders = cdb;/etc/badsenders
8257 .endd
8258 A named list may refer to other named lists:
8259 .code
8260 domainlist  dom1 = first.example : second.example
8261 domainlist  dom2 = +dom1 : third.example
8262 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8263 .endd
8264 &*Warning*&: If the last item in a referenced list is a negative one, the
8265 effect may not be what you intended, because the negation does not propagate
8266 out to the higher level. For example, consider:
8267 .code
8268 domainlist  dom1 = !a.b
8269 domainlist  dom2 = +dom1 : *.b
8270 .endd
8271 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8272 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8273 means it matches the second list as well. The effect is not the same as
8274 .code
8275 domainlist  dom2 = !a.b : *.b
8276 .endd
8277 where &'x.y'& does not match. It's best to avoid negation altogether in
8278 referenced lists if you can.
8279
8280 Named lists may have a performance advantage. When Exim is routing an
8281 address or checking an incoming message, it caches the result of tests on named
8282 lists. So, if you have a setting such as
8283 .code
8284 domains = +local_domains
8285 .endd
8286 on several of your routers
8287 or in several ACL statements,
8288 the actual test is done only for the first one. However, the caching works only
8289 if there are no expansions within the list itself or any sublists that it
8290 references. In other words, caching happens only for lists that are known to be
8291 the same each time they are referenced.
8292
8293 By default, there may be up to 16 named lists of each type. This limit can be
8294 extended by changing a compile-time variable. The use of domain and host lists
8295 is recommended for concepts such as local domains, relay domains, and relay
8296 hosts. The default configuration is set up like this.
8297
8298
8299
8300 .section "Named lists compared with macros" "SECID78"
8301 .cindex "list" "named compared with macro"
8302 .cindex "macro" "compared with named list"
8303 At first sight, named lists might seem to be no different from macros in the
8304 configuration file. However, macros are just textual substitutions. If you
8305 write
8306 .code
8307 ALIST = host1 : host2
8308 auth_advertise_hosts = !ALIST
8309 .endd
8310 it probably won't do what you want, because that is exactly the same as
8311 .code
8312 auth_advertise_hosts = !host1 : host2
8313 .endd
8314 Notice that the second host name is not negated. However, if you use a host
8315 list, and write
8316 .code
8317 hostlist alist = host1 : host2
8318 auth_advertise_hosts = ! +alist
8319 .endd
8320 the negation applies to the whole list, and so that is equivalent to
8321 .code
8322 auth_advertise_hosts = !host1 : !host2
8323 .endd
8324
8325
8326 .section "Named list caching" "SECID79"
8327 .cindex "list" "caching of named"
8328 .cindex "caching" "named lists"
8329 While processing a message, Exim caches the result of checking a named list if
8330 it is sure that the list is the same each time. In practice, this means that
8331 the cache operates only if the list contains no $ characters, which guarantees
8332 that it will not change when it is expanded. Sometimes, however, you may have
8333 an expanded list that you know will be the same each time within a given
8334 message. For example:
8335 .code
8336 domainlist special_domains = \
8337            ${lookup{$sender_host_address}cdb{/some/file}}
8338 .endd
8339 This provides a list of domains that depends only on the sending host's IP
8340 address. If this domain list is referenced a number of times (for example,
8341 in several ACL lines, or in several routers) the result of the check is not
8342 cached by default, because Exim does not know that it is going to be the
8343 same list each time.
8344
8345 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8346 cache the result anyway. For example:
8347 .code
8348 domainlist_cache special_domains = ${lookup{...
8349 .endd
8350 If you do this, you should be absolutely sure that caching is going to do
8351 the right thing in all cases. When in doubt, leave it out.
8352
8353
8354
8355 .section "Domain lists" "SECTdomainlist"
8356 .cindex "domain list" "patterns for"
8357 .cindex "list" "domain list"
8358 Domain lists contain patterns that are to be matched against a mail domain.
8359 The following types of item may appear in domain lists:
8360
8361 .ilist
8362 .cindex "primary host name"
8363 .cindex "host name" "matched in domain list"
8364 .oindex "&%primary_hostname%&"
8365 .cindex "domain list" "matching primary host name"
8366 .cindex "@ in a domain list"
8367 If a pattern consists of a single @ character, it matches the local host name,
8368 as set by the &%primary_hostname%& option (or defaulted). This makes it
8369 possible to use the same configuration file on several different hosts that
8370 differ only in their names.
8371 .next
8372 .cindex "@[] in a domain list"
8373 .cindex "domain list" "matching local IP interfaces"
8374 .cindex "domain literal"
8375 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8376 in square brackets (as in an email address that contains a domain literal), but
8377 only if that IP address is recognized as local for email routing purposes. The
8378 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8379 control which of a host's several IP addresses are treated as local.
8380 In today's Internet, the use of domain literals is controversial.
8381 .next
8382 .cindex "@mx_any"
8383 .cindex "@mx_primary"
8384 .cindex "@mx_secondary"
8385 .cindex "domain list" "matching MX pointers to local host"
8386 If a pattern consists of the string &`@mx_any`& it matches any domain that
8387 has an MX record pointing to the local host or to any host that is listed in
8388 .oindex "&%hosts_treat_as_local%&"
8389 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8390 are similar, except that the first matches only when a primary MX target is the
8391 local host, and the second only when no primary MX target is the local host,
8392 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8393 preference value &-- there may of course be more than one of them.
8394
8395 The MX lookup that takes place when matching a pattern of this type is
8396 performed with the resolver options for widening names turned off. Thus, for
8397 example, a single-component domain will &'not'& be expanded by adding the
8398 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8399 options of the &(dnslookup)& router for a discussion of domain widening.
8400
8401 Sometimes you may want to ignore certain IP addresses when using one of these
8402 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8403 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8404 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8405 on a router). For example:
8406 .code
8407 domains = @mx_any/ignore=127.0.0.1
8408 .endd
8409 This example matches any domain that has an MX record pointing to one of
8410 the local host's IP addresses other than 127.0.0.1.
8411
8412 The list of IP addresses is in fact processed by the same code that processes
8413 host lists, so it may contain CIDR-coded network specifications and it may also
8414 contain negative items.
8415
8416 Because the list of IP addresses is a sublist within a domain list, you have to
8417 be careful about delimiters if there is more than one address. Like any other
8418 list, the default delimiter can be changed. Thus, you might have:
8419 .code
8420 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8421           an.other.domain : ...
8422 .endd
8423 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8424 involved, it is easiest to change the delimiter for the main list as well:
8425 .code
8426 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8427           an.other.domain ? ...
8428 .endd
8429 .next
8430 .cindex "asterisk" "in domain list"
8431 .cindex "domain list" "asterisk in"
8432 .cindex "domain list" "matching &""ends with""&"
8433 If a pattern starts with an asterisk, the remaining characters of the pattern
8434 are compared with the terminating characters of the domain. The use of &"*"& in
8435 domain lists differs from its use in partial matching lookups. In a domain
8436 list, the character following the asterisk need not be a dot, whereas partial
8437 matching works only in terms of dot-separated components. For example, a domain
8438 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8439 &'cipher.key.ex'&.
8440
8441 .next
8442 .cindex "regular expressions" "in domain list"
8443 .cindex "domain list" "matching regular expression"
8444 If a pattern starts with a circumflex character, it is treated as a regular
8445 expression, and matched against the domain using a regular expression matching
8446 function. The circumflex is treated as part of the regular expression.
8447 Email domains are case-independent, so this regular expression match is by
8448 default case-independent, but you can make it case-dependent by starting it
8449 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8450 are given in chapter &<<CHAPregexp>>&.
8451
8452 &*Warning*&: Because domain lists are expanded before being processed, you
8453 must escape any backslash and dollar characters in the regular expression, or
8454 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8455 it is not to be expanded (unless you really do want to build a regular
8456 expression by expansion, of course).
8457 .next
8458 .cindex "lookup" "in domain list"
8459 .cindex "domain list" "matching by lookup"
8460 If a pattern starts with the name of a single-key lookup type followed by a
8461 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8462 must be a filename in a suitable format for the lookup type. For example, for
8463 &"cdb;"& it must be an absolute path:
8464 .code
8465 domains = cdb;/etc/mail/local_domains.cdb
8466 .endd
8467 The appropriate type of lookup is done on the file using the domain name as the
8468 key. In most cases, the data that is looked up is not used; Exim is interested
8469 only in whether or not the key is present in the file. However, when a lookup
8470 is used for the &%domains%& option on a router
8471 or a &%domains%& condition in an ACL statement, the data is preserved in the
8472 &$domain_data$& variable and can be referred to in other router options or
8473 other statements in the same ACL.
8474
8475 .next
8476 Any of the single-key lookup type names may be preceded by
8477 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8478 .code
8479 domains = partial-dbm;/partial/domains
8480 .endd
8481 This causes partial matching logic to be invoked; a description of how this
8482 works is given in section &<<SECTpartiallookup>>&.
8483
8484 .next
8485 .cindex "asterisk" "in lookup type"
8486 Any of the single-key lookup types may be followed by an asterisk. This causes
8487 a default lookup for a key consisting of a single asterisk to be done if the
8488 original lookup fails. This is not a useful feature when using a domain list to
8489 select particular domains (because any domain would match), but it might have
8490 value if the result of the lookup is being used via the &$domain_data$&
8491 expansion variable.
8492 .next
8493 If the pattern starts with the name of a query-style lookup type followed by a
8494 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8495 pattern must be an appropriate query for the lookup type, as described in
8496 chapter &<<CHAPfdlookup>>&. For example:
8497 .code
8498 hold_domains = mysql;select domain from holdlist \
8499   where domain = '${quote_mysql:$domain}';
8500 .endd
8501 In most cases, the data that is looked up is not used (so for an SQL query, for
8502 example, it doesn't matter what field you select). Exim is interested only in
8503 whether or not the query succeeds. However, when a lookup is used for the
8504 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8505 variable and can be referred to in other options.
8506 .next
8507 .cindex "domain list" "matching literal domain name"
8508 If none of the above cases apply, a caseless textual comparison is made
8509 between the pattern and the domain.
8510 .endlist
8511
8512 Here is an example that uses several different kinds of pattern:
8513 .code
8514 domainlist funny_domains = \
8515   @ : \
8516   lib.unseen.edu : \
8517   *.foundation.fict.example : \
8518   \N^[1-2]\d{3}\.fict\.example$\N : \
8519   partial-dbm;/opt/data/penguin/book : \
8520   nis;domains.byname : \
8521   nisplus;[name=$domain,status=local],domains.org_dir
8522 .endd
8523 There are obvious processing trade-offs among the various matching modes. Using
8524 an asterisk is faster than a regular expression, and listing a few names
8525 explicitly probably is too. The use of a file or database lookup is expensive,
8526 but may be the only option if hundreds of names are required. Because the
8527 patterns are tested in order, it makes sense to put the most commonly matched
8528 patterns earlier.
8529
8530
8531
8532 .section "Host lists" "SECThostlist"
8533 .cindex "host list" "patterns in"
8534 .cindex "list" "host list"
8535 Host lists are used to control what remote hosts are allowed to do. For
8536 example, some hosts may be allowed to use the local host as a relay, and some
8537 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8538 two different ways, by name or by IP address. In a host list, some types of
8539 pattern are matched to a host name, and some are matched to an IP address.
8540 You need to be particularly careful with this when single-key lookups are
8541 involved, to ensure that the right value is being used as the key.
8542
8543
8544 .section "Special host list patterns" "SECID80"
8545 .cindex "empty item in hosts list"
8546 .cindex "host list" "empty string in"
8547 If a host list item is the empty string, it matches only when no remote host is
8548 involved. This is the case when a message is being received from a local
8549 process using SMTP on the standard input, that is, when a TCP/IP connection is
8550 not used.
8551
8552 .cindex "asterisk" "in host list"
8553 The special pattern &"*"& in a host list matches any host or no host. Neither
8554 the IP address nor the name is actually inspected.
8555
8556
8557
8558 .section "Host list patterns that match by IP address" "SECThoslispatip"
8559 .cindex "host list" "matching IP addresses"
8560 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8561 the incoming address actually appears in the IPv6 host as
8562 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8563 list, it is converted into a traditional IPv4 address first. (Not all operating
8564 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8565 concerns.)
8566
8567 The following types of pattern in a host list check the remote host by
8568 inspecting its IP address:
8569
8570 .ilist
8571 If the pattern is a plain domain name (not a regular expression, not starting
8572 with *, not a lookup of any kind), Exim calls the operating system function
8573 to find the associated IP address(es). Exim uses the newer
8574 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8575 This typically causes a forward DNS lookup of the name. The result is compared
8576 with the IP address of the subject host.
8577
8578 If there is a temporary problem (such as a DNS timeout) with the host name
8579 lookup, a temporary error occurs. For example, if the list is being used in an
8580 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8581 temporary SMTP error code. If no IP address can be found for the host name,
8582 what happens is described in section &<<SECTbehipnot>>& below.
8583
8584 .next
8585 .cindex "@ in a host list"
8586 If the pattern is &"@"&, the primary host name is substituted and used as a
8587 domain name, as just described.
8588
8589 .next
8590 If the pattern is an IP address, it is matched against the IP address of the
8591 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8592 IPv6 addresses can be given in colon-separated format, but the colons have to
8593 be doubled so as not to be taken as item separators when the default list
8594 separator is used. IPv6 addresses are recognized even when Exim is compiled
8595 without IPv6 support. This means that if they appear in a host list on an
8596 IPv4-only host, Exim will not treat them as host names. They are just addresses
8597 that can never match a client host.
8598
8599 .next
8600 .cindex "@[] in a host list"
8601 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8602 the local host. For example, if the local host is an IPv4 host with one
8603 interface address 10.45.23.56, these two ACL statements have the same effect:
8604 .code
8605 accept hosts = 127.0.0.1 : 10.45.23.56
8606 accept hosts = @[]
8607 .endd
8608 .next
8609 .cindex "CIDR notation"
8610 If the pattern is an IP address followed by a slash and a mask length (for
8611 example 10.11.42.0/24), it is matched against the IP address of the subject
8612 host under the given mask. This allows, an entire network of hosts to be
8613 included (or excluded) by a single item. The mask uses CIDR notation; it
8614 specifies the number of address bits that must match, starting from the most
8615 significant end of the address.
8616
8617 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8618 of a range of addresses. It is the number of bits in the network portion of the
8619 address. The above example specifies a 24-bit netmask, so it matches all 256
8620 addresses in the 10.11.42.0 network. An item such as
8621 .code
8622 192.168.23.236/31
8623 .endd
8624 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8625 32 for an IPv4 address is the same as no mask at all; just a single address
8626 matches.
8627
8628 Here is another example which shows an IPv4 and an IPv6 network:
8629 .code
8630 recipient_unqualified_hosts = 192.168.0.0/16: \
8631                               3ffe::ffff::836f::::/48
8632 .endd
8633 The doubling of list separator characters applies only when these items
8634 appear inline in a host list. It is not required when indirecting via a file.
8635 For example:
8636 .code
8637 recipient_unqualified_hosts = /opt/exim/unqualnets
8638 .endd
8639 could make use of a file containing
8640 .code
8641 172.16.0.0/12
8642 3ffe:ffff:836f::/48
8643 .endd
8644 to have exactly the same effect as the previous example. When listing IPv6
8645 addresses inline, it is usually more convenient to use the facility for
8646 changing separator characters. This list contains the same two networks:
8647 .code
8648 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8649                                  3ffe:ffff:836f::/48
8650 .endd
8651 The separator is changed to semicolon by the leading &"<;"& at the start of the
8652 list.
8653 .endlist
8654
8655
8656
8657 .section "Host list patterns for single-key lookups by host address" &&&
8658          "SECThoslispatsikey"
8659 .cindex "host list" "lookup of IP address"
8660 When a host is to be identified by a single-key lookup of its complete IP
8661 address, the pattern takes this form:
8662 .display
8663 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8664 .endd
8665 For example:
8666 .code
8667 hosts_lookup = net-cdb;/hosts-by-ip.db
8668 .endd
8669 The text form of the IP address of the subject host is used as the lookup key.
8670 IPv6 addresses are converted to an unabbreviated form, using lower case
8671 letters, with dots as separators because colon is the key terminator in
8672 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8673 quoting the keys, but this is a facility that was added later.] The data
8674 returned by the lookup is not used.
8675
8676 .cindex "IP address" "masking"
8677 .cindex "host list" "masked IP address"
8678 Single-key lookups can also be performed using masked IP addresses, using
8679 patterns of this form:
8680 .display
8681 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8682 .endd
8683 For example:
8684 .code
8685 net24-dbm;/networks.db
8686 .endd
8687 The IP address of the subject host is masked using <&'number'&> as the mask
8688 length. A textual string is constructed from the masked value, followed by the
8689 mask, and this is used as the lookup key. For example, if the host's IP address
8690 is 192.168.34.6, the key that is looked up for the above example is
8691 &"192.168.34.0/24"&.
8692
8693 When an IPv6 address is converted to a string, dots are normally used instead
8694 of colons, so that keys in &(lsearch)& files need not contain colons (which
8695 terminate &(lsearch)& keys). This was implemented some time before the ability
8696 to quote keys was made available in &(lsearch)& files. However, the more
8697 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8698 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8699 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8700 converted using colons and not dots.
8701 .new
8702 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8703 addresses are always used.
8704 The latter are converted to IPv4 addresses, in dotted-quad form.
8705 .wen
8706
8707 Ideally, it would be nice to tidy up this anomalous situation by changing to
8708 colons in all cases, given that quoting is now available for &(lsearch)&.
8709 However, this would be an incompatible change that might break some existing
8710 configurations.
8711
8712 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8713 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8714 the former case the key strings include the mask value, whereas in the latter
8715 case the IP address is used on its own.
8716
8717
8718
8719 .section "Host list patterns that match by host name" "SECThoslispatnam"
8720 .cindex "host" "lookup failures"
8721 .cindex "unknown host name"
8722 .cindex "host list" "matching host name"
8723 There are several types of pattern that require Exim to know the name of the
8724 remote host. These are either wildcard patterns or lookups by name. (If a
8725 complete hostname is given without any wildcarding, it is used to find an IP
8726 address to match against, as described in section &<<SECThoslispatip>>&
8727 above.)
8728
8729 If the remote host name is not already known when Exim encounters one of these
8730 patterns, it has to be found from the IP address.
8731 Although many sites on the Internet are conscientious about maintaining reverse
8732 DNS data for their hosts, there are also many that do not do this.
8733 Consequently, a name cannot always be found, and this may lead to unwanted
8734 effects. Take care when configuring host lists with wildcarded name patterns.
8735 Consider what will happen if a name cannot be found.
8736
8737 Because of the problems of determining host names from IP addresses, matching
8738 against host names is not as common as matching against IP addresses.
8739
8740 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8741 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8742 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8743 are done can be changed by setting the &%host_lookup_order%& option. For
8744 security, once Exim has found one or more names, it looks up the IP addresses
8745 for these names and compares them with the IP address that it started with.
8746 Only those names whose IP addresses match are accepted. Any other names are
8747 discarded. If no names are left, Exim behaves as if the host name cannot be
8748 found. In the most common case there is only one name and one IP address.
8749
8750 There are some options that control what happens if a host name cannot be
8751 found. These are described in section &<<SECTbehipnot>>& below.
8752
8753 .cindex "host" "alias for"
8754 .cindex "alias for host"
8755 As a result of aliasing, hosts may have more than one name. When processing any
8756 of the following types of pattern, all the host's names are checked:
8757
8758 .ilist
8759 .cindex "asterisk" "in host list"
8760 If a pattern starts with &"*"& the remainder of the item must match the end of
8761 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8762 &'.b.c'&. This special simple form is provided because this is a very common
8763 requirement. Other kinds of wildcarding require the use of a regular
8764 expression.
8765 .next
8766 .cindex "regular expressions" "in host list"
8767 .cindex "host list" "regular expression in"
8768 If the item starts with &"^"& it is taken to be a regular expression which is
8769 matched against the host name. Host names are case-independent, so this regular
8770 expression match is by default case-independent, but you can make it
8771 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8772 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8773 example,
8774 .code
8775 ^(a|b)\.c\.d$
8776 .endd
8777 is a regular expression that matches either of the two hosts &'a.c.d'& or
8778 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8779 that backslash and dollar characters are not misinterpreted as part of the
8780 string expansion. The simplest way to do this is to use &`\N`& to mark that
8781 part of the string as non-expandable. For example:
8782 .code
8783 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8784 .endd
8785 &*Warning*&: If you want to match a complete host name, you must include the
8786 &`$`& terminating metacharacter in the regular expression, as in the above
8787 example. Without it, a match at the start of the host name is all that is
8788 required.
8789 .endlist
8790
8791
8792
8793
8794 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8795 .cindex "host" "lookup failures, permanent"
8796 While processing a host list, Exim may need to look up an IP address from a
8797 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8798 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8799 behaviour when it fails to find the information it is seeking is the same.
8800
8801 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8802 apply to temporary DNS errors, whose handling is described in the next section.
8803
8804 .cindex "&`+include_unknown`&"
8805 .cindex "&`+ignore_unknown`&"
8806 Exim parses a host list from left to right. If it encounters a permanent
8807 lookup failure in any item in the host list before it has found a match,
8808 Exim treats it as a failure and the default behavior is as if the host
8809 does not match the list. This may not always be what you want to happen.
8810 To change Exim's behaviour, the special items &`+include_unknown`& or
8811 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8812 not recognized in an indirected file).
8813
8814 .ilist
8815 If any item that follows &`+include_unknown`& requires information that
8816 cannot found, Exim behaves as if the host does match the list. For example,
8817 .code
8818 host_reject_connection = +include_unknown:*.enemy.ex
8819 .endd
8820 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8821 any hosts whose name it cannot find.
8822
8823 .next
8824 If any item that follows &`+ignore_unknown`& requires information that cannot
8825 be found, Exim ignores that item and proceeds to the rest of the list. For
8826 example:
8827 .code
8828 accept hosts = +ignore_unknown : friend.example : \
8829                192.168.4.5
8830 .endd
8831 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8832 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8833 name can be found for 192.168.4.5, it is rejected.
8834 .endlist
8835
8836 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8837 list. The effect of each one lasts until the next, or until the end of the
8838 list.
8839
8840 .section "Mixing wildcarded host names and addresses in host lists" &&&
8841          "SECTmixwilhos"
8842 .cindex "host list" "mixing names and addresses in"
8843
8844 This section explains the host/ip processing logic with the same concepts
8845 as the previous section, but specifically addresses what happens when a
8846 wildcarded hostname is one of the items in the hostlist.
8847
8848 .ilist
8849 If you have name lookups or wildcarded host names and
8850 IP addresses in the same host list, you should normally put the IP
8851 addresses first. For example, in an ACL you could have:
8852 .code
8853 accept hosts = 10.9.8.7 : *.friend.example
8854 .endd
8855 The reason you normally would order it this way lies in the
8856 left-to-right way that Exim processes lists.  It can test IP addresses
8857 without doing any DNS lookups, but when it reaches an item that requires
8858 a host name, it fails if it cannot find a host name to compare with the
8859 pattern. If the above list is given in the opposite order, the
8860 &%accept%& statement fails for a host whose name cannot be found, even
8861 if its IP address is 10.9.8.7.
8862
8863 .next
8864 If you really do want to do the name check first, and still recognize the IP
8865 address, you can rewrite the ACL like this:
8866 .code
8867 accept hosts = *.friend.example
8868 accept hosts = 10.9.8.7
8869 .endd
8870 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8871 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8872 &`+ignore_unknown`&, which was discussed in depth in the first example in
8873 this section.
8874 .endlist
8875
8876
8877 .section "Temporary DNS errors when looking up host information" &&&
8878          "SECTtemdnserr"
8879 .cindex "host" "lookup failures, temporary"
8880 .cindex "&`+include_defer`&"
8881 .cindex "&`+ignore_defer`&"
8882 A temporary DNS lookup failure normally causes a defer action (except when
8883 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8884 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8885 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8886 section. These options should be used with care, probably only in non-critical
8887 host lists such as whitelists.
8888
8889
8890
8891 .section "Host list patterns for single-key lookups by host name" &&&
8892          "SECThoslispatnamsk"
8893 .cindex "unknown host name"
8894 .cindex "host list" "matching host name"
8895 If a pattern is of the form
8896 .display
8897 <&'single-key-search-type'&>;<&'search-data'&>
8898 .endd
8899 for example
8900 .code
8901 dbm;/host/accept/list
8902 .endd
8903 a single-key lookup is performed, using the host name as its key. If the
8904 lookup succeeds, the host matches the item. The actual data that is looked up
8905 is not used.
8906
8907 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8908 keys in the file, not IP addresses. If you want to do lookups based on IP
8909 addresses, you must precede the search type with &"net-"& (see section
8910 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8911 two items in the same list, one doing an address lookup and one doing a name
8912 lookup, both using the same file.
8913
8914
8915
8916 .section "Host list patterns for query-style lookups" "SECID81"
8917 If a pattern is of the form
8918 .display
8919 <&'query-style-search-type'&>;<&'query'&>
8920 .endd
8921 the query is obeyed, and if it succeeds, the host matches the item. The actual
8922 data that is looked up is not used. The variables &$sender_host_address$& and
8923 &$sender_host_name$& can be used in the query. For example:
8924 .code
8925 hosts_lookup = pgsql;\
8926   select ip from hostlist where ip='$sender_host_address'
8927 .endd
8928 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8929 can use the &%sg%& expansion item to change this if you need to. If you want to
8930 use masked IP addresses in database queries, you can use the &%mask%& expansion
8931 operator.
8932
8933 If the query contains a reference to &$sender_host_name$&, Exim automatically
8934 looks up the host name if it has not already done so. (See section
8935 &<<SECThoslispatnam>>& for comments on finding host names.)
8936
8937 Historical note: prior to release 4.30, Exim would always attempt to find a
8938 host name before running the query, unless the search type was preceded by
8939 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8940 still recognized for query-style lookups, but its presence or absence has no
8941 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8942 See section &<<SECThoslispatsikey>>&.)
8943
8944
8945
8946
8947
8948 .section "Address lists" "SECTaddresslist"
8949 .cindex "list" "address list"
8950 .cindex "address list" "empty item"
8951 .cindex "address list" "patterns"
8952 Address lists contain patterns that are matched against mail addresses. There
8953 is one special case to be considered: the sender address of a bounce message is
8954 always empty. You can test for this by providing an empty item in an address
8955 list. For example, you can set up a router to process bounce messages by
8956 using this option setting:
8957 .code
8958 senders = :
8959 .endd
8960 The presence of the colon creates an empty item. If you do not provide any
8961 data, the list is empty and matches nothing. The empty sender can also be
8962 detected by a regular expression that matches an empty string,
8963 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8964
8965 Non-empty items in an address list can be straightforward email addresses. For
8966 example:
8967 .code
8968 senders = jbc@askone.example : hs@anacreon.example
8969 .endd
8970 A certain amount of wildcarding is permitted. If a pattern contains an @
8971 character, but is not a regular expression and does not begin with a
8972 semicolon-terminated lookup type (described below), the local part of the
8973 subject address is compared with the local part of the pattern, which may start
8974 with an asterisk. If the local parts match, the domain is checked in exactly
8975 the same way as for a pattern in a domain list. For example, the domain can be
8976 wildcarded, refer to a named list, or be a lookup:
8977 .code
8978 deny senders = *@*.spamming.site:\
8979                *@+hostile_domains:\
8980                bozo@partial-lsearch;/list/of/dodgy/sites:\
8981                *@dbm;/bad/domains.db
8982 .endd
8983 .cindex "local part" "starting with !"
8984 .cindex "address list" "local part starting with !"
8985 If a local part that begins with an exclamation mark is required, it has to be
8986 specified using a regular expression, because otherwise the exclamation mark is
8987 treated as a sign of negation, as is standard in lists.
8988
8989 If a non-empty pattern that is not a regular expression or a lookup does not
8990 contain an @ character, it is matched against the domain part of the subject
8991 address. The only two formats that are recognized this way are a literal
8992 domain, or a domain pattern that starts with *. In both these cases, the effect
8993 is the same as if &`*@`& preceded the pattern. For example:
8994 .code
8995 deny senders = enemy.domain : *.enemy.domain
8996 .endd
8997
8998 The following kinds of more complicated address list pattern can match any
8999 address, including the empty address that is characteristic of bounce message
9000 senders:
9001
9002 .ilist
9003 .cindex "regular expressions" "in address list"
9004 .cindex "address list" "regular expression in"
9005 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9006 done against the complete address, with the pattern as the regular expression.
9007 You must take care that backslash and dollar characters are not misinterpreted
9008 as part of the string expansion. The simplest way to do this is to use &`\N`&
9009 to mark that part of the string as non-expandable. For example:
9010 .code
9011 deny senders = \N^.*this.*@example\.com$\N : \
9012                \N^\d{8}.+@spamhaus.example$\N : ...
9013 .endd
9014 The &`\N`& sequences are removed by the expansion, so these items do indeed
9015 start with &"^"& by the time they are being interpreted as address patterns.
9016
9017 .next
9018 .cindex "address list" "lookup for complete address"
9019 Complete addresses can be looked up by using a pattern that starts with a
9020 lookup type terminated by a semicolon, followed by the data for the lookup. For
9021 example:
9022 .code
9023 deny senders = cdb;/etc/blocked.senders : \
9024   mysql;select address from blocked where \
9025   address='${quote_mysql:$sender_address}'
9026 .endd
9027 Both query-style and single-key lookup types can be used. For a single-key
9028 lookup type, Exim uses the complete address as the key. However, empty keys are
9029 not supported for single-key lookups, so a match against the empty address
9030 always fails. This restriction does not apply to query-style lookups.
9031
9032 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9033 cannot be used, and is ignored if specified, with an entry being written to the
9034 panic log.
9035 .cindex "*@ with single-key lookup"
9036 However, you can configure lookup defaults, as described in section
9037 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9038 default. For example, with this lookup:
9039 .code
9040 accept senders = lsearch*@;/some/file
9041 .endd
9042 the file could contains lines like this:
9043 .code
9044 user1@domain1.example
9045 *@domain2.example
9046 .endd
9047 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9048 that are tried is:
9049 .code
9050 nimrod@jaeger.example
9051 *@jaeger.example
9052 *
9053 .endd
9054 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9055 would mean that every address matches, thus rendering the test useless.
9056
9057 &*Warning 2*&: Do not confuse these two kinds of item:
9058 .code
9059 deny recipients = dbm*@;/some/file
9060 deny recipients = *@dbm;/some/file
9061 .endd
9062 The first does a whole address lookup, with defaulting, as just described,
9063 because it starts with a lookup type. The second matches the local part and
9064 domain independently, as described in a bullet point below.
9065 .endlist
9066
9067
9068 The following kinds of address list pattern can match only non-empty addresses.
9069 If the subject address is empty, a match against any of these pattern types
9070 always fails.
9071
9072
9073 .ilist
9074 .cindex "@@ with single-key lookup"
9075 .cindex "address list" "@@ lookup type"
9076 .cindex "address list" "split local part and domain"
9077 If a pattern starts with &"@@"& followed by a single-key lookup item
9078 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9079 split into a local part and a domain. The domain is looked up in the file. If
9080 it is not found, there is no match. If it is found, the data that is looked up
9081 from the file is treated as a colon-separated list of local part patterns, each
9082 of which is matched against the subject local part in turn.
9083
9084 .cindex "asterisk" "in address list"
9085 The lookup may be a partial one, and/or one involving a search for a default
9086 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9087 patterns that are looked up can be regular expressions or begin with &"*"&, or
9088 even be further lookups. They may also be independently negated. For example,
9089 with
9090 .code
9091 deny senders = @@dbm;/etc/reject-by-domain
9092 .endd
9093 the data from which the DBM file is built could contain lines like
9094 .code
9095 baddomain.com:  !postmaster : *
9096 .endd
9097 to reject all senders except &%postmaster%& from that domain.
9098
9099 .cindex "local part" "starting with !"
9100 If a local part that actually begins with an exclamation mark is required, it
9101 has to be specified using a regular expression. In &(lsearch)& files, an entry
9102 may be split over several lines by indenting the second and subsequent lines,
9103 but the separating colon must still be included at line breaks. White space
9104 surrounding the colons is ignored. For example:
9105 .code
9106 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9107   spammer3 : spammer4
9108 .endd
9109 As in all colon-separated lists in Exim, a colon can be included in an item by
9110 doubling.
9111
9112 If the last item in the list starts with a right angle-bracket, the remainder
9113 of the item is taken as a new key to look up in order to obtain a continuation
9114 list of local parts. The new key can be any sequence of characters. Thus one
9115 might have entries like
9116 .code
9117 aol.com: spammer1 : spammer 2 : >*
9118 xyz.com: spammer3 : >*
9119 *:       ^\d{8}$
9120 .endd
9121 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9122 local parts for all domains, in addition to the specific local parts listed for
9123 each domain. Of course, using this feature costs another lookup each time a
9124 chain is followed, but the effort needed to maintain the data is reduced.
9125
9126 .cindex "loop" "in lookups"
9127 It is possible to construct loops using this facility, and in order to catch
9128 them, the chains may be no more than fifty items long.
9129
9130 .next
9131 The @@<&'lookup'&> style of item can also be used with a query-style
9132 lookup, but in this case, the chaining facility is not available. The lookup
9133 can only return a single list of local parts.
9134 .endlist
9135
9136 &*Warning*&: There is an important difference between the address list items
9137 in these two examples:
9138 .code
9139 senders = +my_list
9140 senders = *@+my_list
9141 .endd
9142 In the first one, &`my_list`& is a named address list, whereas in the second
9143 example it is a named domain list.
9144
9145
9146
9147
9148 .section "Case of letters in address lists" "SECTcasletadd"
9149 .cindex "case of local parts"
9150 .cindex "address list" "case forcing"
9151 .cindex "case forcing in address lists"
9152 Domains in email addresses are always handled caselessly, but for local parts
9153 case may be significant on some systems (see &%caseful_local_part%& for how
9154 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9155 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9156 blocking lists should be done in a case-independent manner. Since most address
9157 lists in Exim are used for this kind of control, Exim attempts to do this by
9158 default.
9159
9160 The domain portion of an address is always lowercased before matching it to an
9161 address list. The local part is lowercased by default, and any string
9162 comparisons that take place are done caselessly. This means that the data in
9163 the address list itself, in files included as plain filenames, and in any file
9164 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9165 keys in files that are looked up by a search type other than &(lsearch)& (which
9166 works caselessly) must be in lower case, because these lookups are not
9167 case-independent.
9168
9169 .cindex "&`+caseful`&"
9170 To allow for the possibility of caseful address list matching, if an item in
9171 an address list is the string &"+caseful"&, the original case of the local
9172 part is restored for any comparisons that follow, and string comparisons are no
9173 longer case-independent. This does not affect the domain, which remains in
9174 lower case. However, although independent matches on the domain alone are still
9175 performed caselessly, regular expressions that match against an entire address
9176 become case-sensitive after &"+caseful"& has been seen.
9177
9178
9179
9180 .section "Local part lists" "SECTlocparlis"
9181 .cindex "list" "local part list"
9182 .cindex "local part" "list"
9183 Case-sensitivity in local part lists is handled in the same way as for address
9184 lists, as just described. The &"+caseful"& item can be used if required. In a
9185 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9186 set false, the subject is lowercased and the matching is initially
9187 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9188 matching in the local part list, but not elsewhere in the router. If
9189 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9190 option is case-sensitive from the start.
9191
9192 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9193 comments are handled in the same way as address lists &-- they are recognized
9194 only if the # is preceded by white space or the start of the line.
9195 Otherwise, local part lists are matched in the same way as domain lists, except
9196 that the special items that refer to the local host (&`@`&, &`@[]`&,
9197 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9198 Refer to section &<<SECTdomainlist>>& for details of the other available item
9199 types.
9200 .ecindex IIDdohoadli
9201
9202
9203
9204
9205 . ////////////////////////////////////////////////////////////////////////////
9206 . ////////////////////////////////////////////////////////////////////////////
9207
9208 .chapter "String expansions" "CHAPexpand"
9209 .scindex IIDstrexp "expansion" "of strings"
9210 Many strings in Exim's runtime configuration are expanded before use. Some of
9211 them are expanded every time they are used; others are expanded only once.
9212
9213 When a string is being expanded it is copied verbatim from left to right except
9214 .cindex expansion "string concatenation"
9215 when a dollar or backslash character is encountered. A dollar specifies the
9216 start of a portion of the string that is interpreted and replaced as described
9217 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9218 escape character, as described in the following section.
9219
9220 Whether a string is expanded depends upon the context.  Usually this is solely
9221 dependent upon the option for which a value is sought; in this documentation,
9222 options for which string expansion is performed are marked with &dagger; after
9223 the data type.  ACL rules always expand strings.  A couple of expansion
9224 conditions do not expand some of the brace-delimited branches, for security
9225 reasons,
9226 .new
9227 .cindex "tainted data" expansion
9228 .cindex expansion "tainted data"
9229 and expansion of data deriving from the sender (&"tainted data"&)
9230 is not permitted.
9231 .wen
9232
9233
9234
9235 .section "Literal text in expanded strings" "SECTlittext"
9236 .cindex "expansion" "including literal text"
9237 An uninterpreted dollar can be included in an expanded string by putting a
9238 backslash in front of it. A backslash can be used to prevent any special
9239 character being treated specially in an expansion, including backslash itself.
9240 If the string appears in quotes in the configuration file, two backslashes are
9241 required because the quotes themselves cause interpretation of backslashes when
9242 the string is read in (see section &<<SECTstrings>>&).
9243
9244 .cindex "expansion" "non-expandable substrings"
9245 A portion of the string can specified as non-expandable by placing it between
9246 two occurrences of &`\N`&. This is particularly useful for protecting regular
9247 expressions, which often contain backslashes and dollar signs. For example:
9248 .code
9249 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9250 .endd
9251 On encountering the first &`\N`&, the expander copies subsequent characters
9252 without interpretation until it reaches the next &`\N`& or the end of the
9253 string.
9254
9255
9256
9257 .section "Character escape sequences in expanded strings" "SECID82"
9258 .cindex "expansion" "escape sequences"
9259 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9260 expanded string is recognized as an escape sequence for the character newline,
9261 carriage return, or tab, respectively. A backslash followed by up to three
9262 octal digits is recognized as an octal encoding for a single character, and a
9263 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9264 encoding.
9265
9266 These escape sequences are also recognized in quoted strings when they are read
9267 in. Their interpretation in expansions as well is useful for unquoted strings,
9268 and for other cases such as looked-up strings that are then expanded.
9269
9270
9271 .section "Testing string expansions" "SECID83"
9272 .cindex "expansion" "testing"
9273 .cindex "testing" "string expansion"
9274 .oindex "&%-be%&"
9275 Many expansions can be tested by calling Exim with the &%-be%& option. This
9276 takes the command arguments, or lines from the standard input if there are no
9277 arguments, runs them through the string expansion code, and writes the results
9278 to the standard output. Variables based on configuration values are set up, but
9279 since no message is being processed, variables such as &$local_part$& have no
9280 value. Nevertheless the &%-be%& option can be useful for checking out file and
9281 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9282 and &%nhash%&.
9283
9284 Exim gives up its root privilege when it is called with the &%-be%& option, and
9285 instead runs under the uid and gid it was called with, to prevent users from
9286 using &%-be%& for reading files to which they do not have access.
9287
9288 .oindex "&%-bem%&"
9289 If you want to test expansions that include variables whose values are taken
9290 from a message, there are two other options that can be used. The &%-bem%&
9291 option is like &%-be%& except that it is followed by a filename. The file is
9292 read as a message before doing the test expansions. For example:
9293 .code
9294 exim -bem /tmp/test.message '$h_subject:'
9295 .endd
9296 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9297 Exim message identifier. For example:
9298 .code
9299 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9300 .endd
9301 This loads the message from Exim's spool before doing the test expansions, and
9302 is therefore restricted to admin users.
9303
9304
9305 .section "Forced expansion failure" "SECTforexpfai"
9306 .cindex "expansion" "forced failure"
9307 A number of expansions that are described in the following section have
9308 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9309 (which are sometimes called &"curly brackets"&). Which of the two strings is
9310 used depends on some condition that is evaluated as part of the expansion. If,
9311 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9312 the entire string expansion fails in a way that can be detected by the code
9313 that requested the expansion. This is called &"forced expansion failure"&, and
9314 its consequences depend on the circumstances. In some cases it is no different
9315 from any other expansion failure, but in others a different action may be
9316 taken. Such variations are mentioned in the documentation of the option that is
9317 being expanded.
9318
9319
9320
9321
9322 .section "Expansion items" "SECTexpansionitems"
9323 The following items are recognized in expanded strings. White space may be used
9324 between sub-items that are keywords or substrings enclosed in braces inside an
9325 outer set of braces, to improve readability. &*Warning*&: Within braces,
9326 white space is significant.
9327
9328 .vlist
9329 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9330 .cindex "expansion" "variables"
9331 Substitute the contents of the named variable, for example:
9332 .code
9333 $local_part
9334 ${domain}
9335 .endd
9336 The second form can be used to separate the name from subsequent alphanumeric
9337 characters. This form (using braces) is available only for variables; it does
9338 &'not'& apply to message headers. The names of the variables are given in
9339 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9340 given, the expansion fails.
9341
9342 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9343 .cindex "expansion" "operators"
9344 The string is first itself expanded, and then the operation specified by
9345 <&'op'&> is applied to it. For example:
9346 .code
9347 ${lc:$local_part}
9348 .endd
9349 The string starts with the first character after the colon, which may be
9350 leading white space. A list of operators is given in section &<<SECTexpop>>&
9351 below. The operator notation is used for simple expansion items that have just
9352 one argument, because it reduces the number of braces and therefore makes the
9353 string easier to understand.
9354
9355 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9356 This item inserts &"basic"& header lines. It is described with the &%header%&
9357 expansion item below.
9358
9359
9360 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9361 .cindex "expansion" "calling an acl"
9362 .cindex "&%acl%&" "call from expansion"
9363 The name and zero to nine argument strings are first expanded separately.  The expanded
9364 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9365 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9366 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9367 and may use the variables; if another acl expansion is used the values
9368 are restored after it returns.  If the ACL sets
9369 a value using a "message =" modifier and returns accept or deny, the value becomes
9370 the result of the expansion.
9371 If no message is set and the ACL returns accept or deny
9372 the expansion result is an empty string.
9373 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9374
9375
9376 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9377 .cindex authentication "results header"
9378 .cindex headers "authentication-results:"
9379 .cindex authentication "expansion item"
9380 This item returns a string suitable for insertion as an
9381 &'Authentication-Results:'&
9382 header line.
9383 The given <&'authserv-id'&> is included in the result; typically this
9384 will be a domain name identifying the system performing the authentications.
9385 Methods that might be present in the result include:
9386 .code
9387 none
9388 iprev
9389 auth
9390 spf
9391 dkim
9392 .endd
9393
9394 Example use (as an ACL modifier):
9395 .code
9396       add_header = :at_start:${authresults {$primary_hostname}}
9397 .endd
9398 This is safe even if no authentication results are available.
9399
9400
9401 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9402        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9403 .cindex "expansion" "extracting certificate fields"
9404 .cindex "&%certextract%&" "certificate fields"
9405 .cindex "certificate" "extracting fields"
9406 The <&'certificate'&> must be a variable of type certificate.
9407 The field name is expanded and used to retrieve the relevant field from
9408 the certificate.  Supported fields are:
9409 .display
9410 &`version        `&
9411 &`serial_number  `&
9412 &`subject        `& RFC4514 DN
9413 &`issuer         `& RFC4514 DN
9414 &`notbefore      `& time
9415 &`notafter       `& time
9416 &`sig_algorithm  `&
9417 &`signature      `&
9418 &`subj_altname   `& tagged list
9419 &`ocsp_uri       `& list
9420 &`crl_uri        `& list
9421 .endd
9422 If the field is found,
9423 <&'string2'&> is expanded, and replaces the whole item;
9424 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9425 variable &$value$& contains the value that has been extracted. Afterwards, it
9426 is restored to any previous value it might have had.
9427
9428 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9429 key is not found. If {<&'string2'&>} is also omitted, the value that was
9430 extracted is used.
9431
9432 Some field names take optional modifiers, appended and separated by commas.
9433
9434 The field selectors marked as "RFC4514" above
9435 output a Distinguished Name string which is
9436 not quite
9437 parseable by Exim as a comma-separated tagged list
9438 (the exceptions being elements containing commas).
9439 RDN elements of a single type may be selected by
9440 a modifier of the type label; if so the expansion
9441 result is a list (newline-separated by default).
9442 The separator may be changed by another modifier of
9443 a right angle-bracket followed immediately by the new separator.
9444 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9445
9446 The field selectors marked as "time" above
9447 take an optional modifier of "int"
9448 for which the result is the number of seconds since epoch.
9449 Otherwise the result is a human-readable string
9450 in the timezone selected by the main "timezone" option.
9451
9452 The field selectors marked as "list" above return a list,
9453 newline-separated by default,
9454 (embedded separator characters in elements are doubled).
9455 The separator may be changed by a modifier of
9456 a right angle-bracket followed immediately by the new separator.
9457
9458 The field selectors marked as "tagged" above
9459 prefix each list element with a type string and an equals sign.
9460 Elements of only one type may be selected by a modifier
9461 which is one of "dns", "uri" or "mail";
9462 if so the element tags are omitted.
9463
9464 If not otherwise noted field values are presented in human-readable form.
9465
9466 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9467        {*&<&'arg'&>&*}...}*&"
9468 .cindex &%dlfunc%&
9469 This expansion dynamically loads and then calls a locally-written C function.
9470 This functionality is available only if Exim is compiled with
9471 .code
9472 EXPAND_DLFUNC=yes
9473 .endd
9474 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9475 object so that it doesn't reload the same object file in the same Exim process
9476 (but of course Exim does start new processes frequently).
9477
9478 There may be from zero to eight arguments to the function. When compiling
9479 a local function that is to be called in this way, &_local_scan.h_& should be
9480 included. The Exim variables and functions that are defined by that API
9481 are also available for dynamically loaded functions. The function itself
9482 must have the following type:
9483 .code
9484 int dlfunction(uschar **yield, int argc, uschar *argv[])
9485 .endd
9486 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9487 function should return one of the following values:
9488
9489 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9490 into the expanded string that is being built.
9491
9492 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9493 from &'yield'&, if it is set.
9494
9495 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9496 taken from &'yield'& if it is set.
9497
9498 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9499
9500 When compiling a function that is to be used in this way with gcc,
9501 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9502 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9503
9504
9505 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9506 .cindex "expansion" "extracting value from environment"
9507 .cindex "environment" "values from"
9508 The key is first expanded separately, and leading and trailing white space
9509 removed.
9510 This is then searched for as a name in the environment.
9511 If a variable is found then its value is placed in &$value$&
9512 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9513
9514 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9515 appear, for example:
9516 .code
9517 ${env{USER}{$value} fail }
9518 .endd
9519 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9520 {<&'string1'&>} must be present for &"fail"& to be recognized.
9521
9522 If {<&'string2'&>} is omitted an empty string is substituted on
9523 search failure.
9524 If {<&'string1'&>} is omitted the search result is substituted on
9525 search success.
9526
9527 The environment is adjusted by the &%keep_environment%& and
9528 &%add_environment%& main section options.
9529
9530
9531 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9532        {*&<&'string3'&>&*}}*&"
9533 .cindex "expansion" "extracting substrings by key"
9534 .cindex "&%extract%&" "substrings by key"
9535 The key and <&'string1'&> are first expanded separately. Leading and trailing
9536 white space is removed from the key (but not from any of the strings). The key
9537 must not be empty and must not consist entirely of digits.
9538 The expanded <&'string1'&> must be of the form:
9539 .display
9540 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9541 .endd
9542 .vindex "&$value$&"
9543 where the equals signs and spaces (but not both) are optional. If any of the
9544 values contain white space, they must be enclosed in double quotes, and any
9545 values that are enclosed in double quotes are subject to escape processing as
9546 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9547 for the value that corresponds to the key. The search is case-insensitive. If
9548 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9549 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9550 variable &$value$& contains the value that has been extracted. Afterwards, it
9551 is restored to any previous value it might have had.
9552
9553 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9554 key is not found. If {<&'string2'&>} is also omitted, the value that was
9555 extracted is used. Thus, for example, these two expansions are identical, and
9556 yield &"2001"&:
9557 .code
9558 ${extract{gid}{uid=1984 gid=2001}}
9559 ${extract{gid}{uid=1984 gid=2001}{$value}}
9560 .endd
9561 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9562 appear, for example:
9563 .code
9564 ${extract{Z}{A=... B=...}{$value} fail }
9565 .endd
9566 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9567 {<&'string2'&>} must be present for &"fail"& to be recognized.
9568
9569 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9570        {*&<&'string3'&>&*}}*&" &&&
9571        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9572        {*&<&'string3'&>&*}}*&"
9573 .cindex "expansion" "extracting from JSON object"
9574 .cindex JSON expansions
9575 The key and <&'string1'&> are first expanded separately. Leading and trailing
9576 white space is removed from the key (but not from any of the strings). The key
9577 must not be empty and must not consist entirely of digits.
9578 The expanded <&'string1'&> must be of the form:
9579 .display
9580 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9581 .endd
9582 .vindex "&$value$&"
9583 The braces, commas and colons, and the quoting of the member name are required;
9584 the spaces are optional.
9585 Matching of the key against the member names is done case-sensitively.
9586 For the &"json"& variant,
9587 if a returned value is a JSON string, it retains its leading and
9588 trailing quotes.
9589 .new
9590 For the &"jsons"& variant, which is intended for use with JSON strings, the
9591 leading and trailing quotes are removed from the returned value.
9592 .wen
9593 . XXX should be a UTF-8 compare
9594
9595 The results of matching are handled as above.
9596
9597
9598 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9599         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9600 .cindex "expansion" "extracting substrings by number"
9601 .cindex "&%extract%&" "substrings by number"
9602 The <&'number'&> argument must consist entirely of decimal digits,
9603 apart from leading and trailing white space, which is ignored.
9604 This is what distinguishes this form of &%extract%& from the previous kind. It
9605 behaves in the same way, except that, instead of extracting a named field, it
9606 extracts from <&'string1'&> the field whose number is given as the first
9607 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9608 <&'string3'&> as before.
9609
9610 The fields in the string are separated by any one of the characters in the
9611 separator string. These may include space or tab characters.
9612 The first field is numbered one. If the number is negative, the fields are
9613 counted from the end of the string, with the rightmost one numbered -1. If the
9614 number given is zero, the entire string is returned. If the modulus of the
9615 number is greater than the number of fields in the string, the result is the
9616 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9617 provided. For example:
9618 .code
9619 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9620 .endd
9621 yields &"42"&, and
9622 .code
9623 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9624 .endd
9625 yields &"99"&. Two successive separators mean that the field between them is
9626 empty (for example, the fifth field above).
9627
9628
9629 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9630         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9631        "&*${extract jsons{*&<&'number'&>&*}}&&&
9632         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9633 .cindex "expansion" "extracting from JSON array"
9634 .cindex JSON expansions
9635 The <&'number'&> argument must consist entirely of decimal digits,
9636 apart from leading and trailing white space, which is ignored.
9637
9638 Field selection and result handling is as above;
9639 there is no choice of field separator.
9640 For the &"json"& variant,
9641 if a returned value is a JSON string, it retains its leading and
9642 trailing quotes.
9643 .new
9644 For the &"jsons"& variant, which is intended for use with JSON strings, the
9645 leading and trailing quotes are removed from the returned value.
9646 .wen
9647
9648
9649 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9650 .cindex "list" "selecting by condition"
9651 .cindex "expansion" "selecting from list by condition"
9652 .vindex "&$item$&"
9653 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9654 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9655 For each item
9656 in this list, its value is place in &$item$&, and then the condition is
9657 evaluated. If the condition is true, &$item$& is added to the output as an
9658 item in a new list; if the condition is false, the item is discarded. The
9659 separator used for the output list is the same as the one used for the
9660 input, but a separator setting is not included in the output. For example:
9661 .code
9662 ${filter{a:b:c}{!eq{$item}{b}}}
9663 .endd
9664 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9665 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9666
9667
9668 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9669 .cindex "hash function" "textual"
9670 .cindex "expansion" "textual hash"
9671 This is a textual hashing function, and was the first to be implemented in
9672 early versions of Exim. In current releases, there are other hashing functions
9673 (numeric, MD5, and SHA-1), which are described below.
9674
9675 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9676 <&'n'&>. If you are using fixed values for these numbers, that is, if
9677 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9678 use the simpler operator notation that avoids some of the braces:
9679 .code
9680 ${hash_<n>_<m>:<string>}
9681 .endd
9682 The second number is optional (in both notations). If <&'n'&> is greater than
9683 or equal to the length of the string, the expansion item returns the string.
9684 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9685 function to the string. The new string consists of characters taken from the
9686 first <&'m'&> characters of the string
9687 .code
9688 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9689 .endd
9690 If <&'m'&> is not present the value 26 is used, so that only lower case
9691 letters appear. For example:
9692 .display
9693 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9694 &`$hash{5}{monty}}           `&   yields  &`monty`&
9695 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9696 .endd
9697
9698 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9699         &*$h_*&<&'header&~name'&>&*:*&" &&&
9700        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9701         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9702        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9703         &*$lh_*&<&'header&~name'&>&*:*&"
9704        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9705         &*$rh_*&<&'header&~name'&>&*:*&"
9706 .cindex "expansion" "header insertion"
9707 .vindex "&$header_$&"
9708 .vindex "&$bheader_$&"
9709 .vindex "&$lheader_$&"
9710 .vindex "&$rheader_$&"
9711 .cindex "header lines" "in expansion strings"
9712 .cindex "header lines" "character sets"
9713 .cindex "header lines" "decoding"
9714 Substitute the contents of the named message header line, for example
9715 .code
9716 $header_reply-to:
9717 .endd
9718 The newline that terminates a header line is not included in the expansion, but
9719 internal newlines (caused by splitting the header line over several physical
9720 lines) may be present.
9721
9722 The difference between the four pairs of expansions is in the way
9723 the data in the header line is interpreted.
9724
9725 .ilist
9726 .cindex "white space" "in header lines"
9727 &%rheader%& gives the original &"raw"& content of the header line, with no
9728 processing at all, and without the removal of leading and trailing white space.
9729
9730 .next
9731 .cindex "list" "of header lines"
9732 &%lheader%& gives a colon-separated list, one element per header when there
9733 are multiple headers with a given name.
9734 Any embedded colon characters within an element are doubled, so normal Exim
9735 list-processing facilities can be used.
9736 The terminating newline of each element is removed; in other respects
9737 the content is &"raw"&.
9738
9739 .next
9740 .cindex "base64 encoding" "in header lines"
9741 &%bheader%& removes leading and trailing white space, and then decodes base64
9742 or quoted-printable MIME &"words"& within the header text, but does no
9743 character set translation. If decoding of what looks superficially like a MIME
9744 &"word"& fails, the raw string is returned. If decoding
9745 .cindex "binary zero" "in header line"
9746 produces a binary zero character, it is replaced by a question mark &-- this is
9747 what Exim does for binary zeros that are actually received in header lines.
9748
9749 .next
9750 &%header%& tries to translate the string as decoded by &%bheader%& to a
9751 standard character set. This is an attempt to produce the same string as would
9752 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9753 returned. Translation is attempted only on operating systems that support the
9754 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9755 a system Makefile or in &_Local/Makefile_&.
9756 .endlist ilist
9757
9758 In a filter file, the target character set for &%header%& can be specified by a
9759 command of the following form:
9760 .code
9761 headers charset "UTF-8"
9762 .endd
9763 This command affects all references to &$h_$& (or &$header_$&) expansions in
9764 subsequently obeyed filter commands. In the absence of this command, the target
9765 character set in a filter is taken from the setting of the &%headers_charset%&
9766 option in the runtime configuration. The value of this option defaults to the
9767 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9768 ISO-8859-1.
9769
9770 Header names follow the syntax of RFC 2822, which states that they may contain
9771 any printing characters except space and colon. Consequently, curly brackets
9772 &'do not'& terminate header names, and should not be used to enclose them as
9773 if they were variables. Attempting to do so causes a syntax error.
9774
9775 Only header lines that are common to all copies of a message are visible to
9776 this mechanism. These are the original header lines that are received with the
9777 message, and any that are added by an ACL statement or by a system
9778 filter. Header lines that are added to a particular copy of a message by a
9779 router or transport are not accessible.
9780
9781 For incoming SMTP messages, no header lines are visible in
9782 ACLs that are obeyed before the data phase completes,
9783 because the header structure is not set up until the message is received.
9784 They are visible in DKIM, PRDR and DATA ACLs.
9785 Header lines that are added in a RCPT ACL (for example)
9786 are saved until the message's incoming header lines are available, at which
9787 point they are added.
9788 When any of the above ACLs ar
9789 running, however, header lines added by earlier ACLs are visible.
9790
9791 Upper case and lower case letters are synonymous in header names. If the
9792 following character is white space, the terminating colon may be omitted, but
9793 this is not recommended, because you may then forget it when it is needed. When
9794 white space terminates the header name, this white space is included in the
9795 expanded string.  If the message does not contain the given header, the
9796 expansion item is replaced by an empty string. (See the &%def%& condition in
9797 section &<<SECTexpcond>>& for a means of testing for the existence of a
9798 header.)
9799
9800 If there is more than one header with the same name, they are all concatenated
9801 to form the substitution string, up to a maximum length of 64K. Unless
9802 &%rheader%& is being used, leading and trailing white space is removed from
9803 each header before concatenation, and a completely empty header is ignored. A
9804 newline character is then inserted between non-empty headers, but there is no
9805 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9806 those headers that contain lists of addresses, a comma is also inserted at the
9807 junctions between headers. This does not happen for the &%rheader%& expansion.
9808
9809
9810 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9811 .cindex "expansion" "hmac hashing"
9812 .cindex &%hmac%&
9813 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9814 shared secret and some text into a message authentication code, as specified in
9815 RFC 2104. This differs from &`${md5:secret_text...}`& or
9816 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9817 cryptographic hash, allowing for authentication that is not possible with MD5
9818 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9819 present. For example:
9820 .code
9821 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9822 .endd
9823 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9824 produces:
9825 .code
9826 dd97e3ba5d1a61b5006108f8c8252953
9827 .endd
9828 As an example of how this might be used, you might put in the main part of
9829 an Exim configuration:
9830 .code
9831 SPAMSCAN_SECRET=cohgheeLei2thahw
9832 .endd
9833 In a router or a transport you could then have:
9834 .code
9835 headers_add = \
9836   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9837   ${hmac{md5}{SPAMSCAN_SECRET}\
9838   {${primary_hostname},${message_exim_id},$h_message-id:}}
9839 .endd
9840 Then given a message, you can check where it was scanned by looking at the
9841 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9842 this header line is authentic by recomputing the authentication code from the
9843 host name, message ID and the &'Message-id:'& header line. This can be done
9844 using Exim's &%-be%& option, or by other means, for example, by using the
9845 &'hmac_md5_hex()'& function in Perl.
9846
9847
9848 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9849 .cindex "expansion" "conditional"
9850 .cindex "&%if%&, expansion item"
9851 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9852 item; otherwise <&'string2'&> is used. The available conditions are described
9853 in section &<<SECTexpcond>>& below. For example:
9854 .code
9855 ${if eq {$local_part}{postmaster} {yes}{no} }
9856 .endd
9857 The second string need not be present; if it is not and the condition is not
9858 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9859 be present instead of the second string (without any curly brackets). In this
9860 case, the expansion is forced to fail if the condition is not true (see section
9861 &<<SECTforexpfai>>&).
9862
9863 If both strings are omitted, the result is the string &`true`& if the condition
9864 is true, and the empty string if the condition is false. This makes it less
9865 cumbersome to write custom ACL and router conditions. For example, instead of
9866 .code
9867 condition = ${if >{$acl_m4}{3}{true}{false}}
9868 .endd
9869 you can use
9870 .code
9871 condition = ${if >{$acl_m4}{3}}
9872 .endd
9873
9874
9875
9876 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9877 .cindex expansion "imap folder"
9878 .cindex "&%imapfolder%& expansion item"
9879 This item converts a (possibly multilevel, or with non-ASCII characters)
9880 folder specification to a Maildir name for filesystem use.
9881 For information on internationalisation support see &<<SECTi18nMDA>>&.
9882
9883
9884
9885 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9886 .cindex "expansion" "string truncation"
9887 .cindex "&%length%& expansion item"
9888 The &%length%& item is used to extract the initial portion of a string. Both
9889 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9890 you are using a fixed value for the number, that is, if <&'string1'&> does not
9891 change when expanded, you can use the simpler operator notation that avoids
9892 some of the braces:
9893 .code
9894 ${length_<n>:<string>}
9895 .endd
9896 The result of this item is either the first <&'n'&> bytes or the whole
9897 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9898 &%strlen%&, which gives the length of a string.
9899 All measurement is done in bytes and is not UTF-8 aware.
9900
9901
9902 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9903         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9904 .cindex "expansion" "extracting list elements by number"
9905 .cindex "&%listextract%&" "extract list elements by number"
9906 .cindex "list" "extracting elements by number"
9907 The <&'number'&> argument must consist entirely of decimal digits,
9908 apart from an optional leading minus,
9909 and leading and trailing white space (which is ignored).
9910
9911 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9912 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9913
9914 The first field of the list is numbered one.
9915 If the number is negative, the fields are
9916 counted from the end of the list, with the rightmost one numbered -1.
9917 The numbered element of the list is extracted and placed in &$value$&,
9918 then <&'string2'&> is expanded as the result.
9919
9920 If the modulus of the
9921 number is zero or greater than the number of fields in the string,
9922 the result is the expansion of <&'string3'&>.
9923
9924 For example:
9925 .code
9926 ${listextract{2}{x:42:99}}
9927 .endd
9928 yields &"42"&, and
9929 .code
9930 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9931 .endd
9932 yields &"result: 42"&.
9933
9934 If {<&'string3'&>} is omitted, an empty string is used for string3.
9935 If {<&'string2'&>} is also omitted, the value that was
9936 extracted is used.
9937 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9938
9939
9940 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9941         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9942 This is the first of one of two different types of lookup item, which are both
9943 described in the next item.
9944
9945 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9946         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9947 .cindex "expansion" "lookup in"
9948 .cindex "file" "lookups"
9949 .cindex "lookup" "in expanded string"
9950 The two forms of lookup item specify data lookups in files and databases, as
9951 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9952 lookups, and the second is used for query-style lookups. The <&'key'&>,
9953 <&'file'&>, and <&'query'&> strings are expanded before use.
9954
9955 If there is any white space in a lookup item which is part of a filter command,
9956 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9957 other place where white space is significant, the lookup item must be enclosed
9958 in double quotes. The use of data lookups in users' filter files may be locked
9959 out by the system administrator.
9960
9961 .vindex "&$value$&"
9962 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9963 During its expansion, the variable &$value$& contains the data returned by the
9964 lookup. Afterwards it reverts to the value it had previously (at the outer
9965 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9966 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9967 string on failure. If <&'string2'&> is provided, it can itself be a nested
9968 lookup, thus providing a mechanism for looking up a default value when the
9969 original lookup fails.
9970
9971 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9972 data for the outer lookup while the parameters of the second lookup are
9973 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9974 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9975 appear, and in this case, if the lookup fails, the entire expansion is forced
9976 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9977 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9978 successful lookup, and nothing in the case of failure.
9979
9980 For single-key lookups, the string &"partial"& is permitted to precede the
9981 search type in order to do partial matching, and * or *@ may follow a search
9982 type to request default lookups if the key does not match (see sections
9983 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9984
9985 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9986 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9987 and non-wild parts of the key during the expansion of the replacement text.
9988 They return to their previous values at the end of the lookup item.
9989
9990 This example looks up the postmaster alias in the conventional alias file:
9991 .code
9992 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9993 .endd
9994 This example uses NIS+ to look up the full name of the user corresponding to
9995 the local part of an address, forcing the expansion to fail if it is not found:
9996 .code
9997 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9998   {$value}fail}
9999 .endd
10000
10001
10002 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10003 .cindex "expansion" "list creation"
10004 .vindex "&$item$&"
10005 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10006 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10007 For each item
10008 in this list, its value is place in &$item$&, and then <&'string2'&> is
10009 expanded and added to the output as an item in a new list. The separator used
10010 for the output list is the same as the one used for the input, but a separator
10011 setting is not included in the output. For example:
10012 .code
10013 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10014 .endd
10015 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10016 value of &$item$& is restored to what it was before. See also the &%filter%&
10017 and &%reduce%& expansion items.
10018
10019 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10020 .cindex "expansion" "numeric hash"
10021 .cindex "hash function" "numeric"
10022 The three strings are expanded; the first two must yield numbers. Call them
10023 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10024 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10025 can use the simpler operator notation that avoids some of the braces:
10026 .code
10027 ${nhash_<n>_<m>:<string>}
10028 .endd
10029 The second number is optional (in both notations). If there is only one number,
10030 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10031 processed by a div/mod hash function that returns two numbers, separated by a
10032 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10033 example,
10034 .code
10035 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10036 .endd
10037 returns the string &"6/33"&.
10038
10039
10040
10041 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10042 .cindex "Perl" "use in expanded string"
10043 .cindex "expansion" "calling Perl from"
10044 This item is available only if Exim has been built to include an embedded Perl
10045 interpreter. The subroutine name and the arguments are first separately
10046 expanded, and then the Perl subroutine is called with those arguments. No
10047 additional arguments need be given; the maximum number permitted, including the
10048 name of the subroutine, is nine.
10049
10050 The return value of the subroutine is inserted into the expanded string, unless
10051 the return value is &%undef%&. In that case, the expansion fails in the same
10052 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10053 Whatever you return is evaluated in a scalar context. For example, if you
10054 return the name of a Perl vector, the return value is the size of the vector,
10055 not its contents.
10056
10057 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10058 with the error message that was passed to &%die%&. More details of the embedded
10059 Perl facility are given in chapter &<<CHAPperl>>&.
10060
10061 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10062 out the use of this expansion item in filter files.
10063
10064
10065 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10066 .cindex "&%prvs%& expansion item"
10067 The first argument is a complete email address and the second is secret
10068 keystring. The third argument, specifying a key number, is optional. If absent,
10069 it defaults to 0. The result of the expansion is a prvs-signed email address,
10070 to be typically used with the &%return_path%& option on an &(smtp)& transport
10071 as part of a bounce address tag validation (BATV) scheme. For more discussion
10072 and an example, see section &<<SECTverifyPRVS>>&.
10073
10074 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10075         {*&<&'string'&>&*}}*&"
10076 .cindex "&%prvscheck%& expansion item"
10077 This expansion item is the complement of the &%prvs%& item. It is used for
10078 checking prvs-signed addresses. If the expansion of the first argument does not
10079 yield a syntactically valid prvs-signed address, the whole item expands to the
10080 empty string. When the first argument does expand to a syntactically valid
10081 prvs-signed address, the second argument is expanded, with the prvs-decoded
10082 version of the address and the key number extracted from the address in the
10083 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10084
10085 These two variables can be used in the expansion of the second argument to
10086 retrieve the secret. The validity of the prvs-signed address is then checked
10087 against the secret. The result is stored in the variable &$prvscheck_result$&,
10088 which is empty for failure or &"1"& for success.
10089
10090 The third argument is optional; if it is missing, it defaults to an empty
10091 string. This argument is now expanded. If the result is an empty string, the
10092 result of the expansion is the decoded version of the address. This is the case
10093 whether or not the signature was valid. Otherwise, the result of the expansion
10094 is the expansion of the third argument.
10095
10096 All three variables can be used in the expansion of the third argument.
10097 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10098 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10099
10100 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10101 .cindex "expansion" "inserting an entire file"
10102 .cindex "file" "inserting into expansion"
10103 .cindex "&%readfile%& expansion item"
10104 The filename and end-of-line string are first expanded separately. The file is
10105 then read, and its contents replace the entire item. All newline characters in
10106 the file are replaced by the end-of-line string if it is present. Otherwise,
10107 newlines are left in the string.
10108 String expansion is not applied to the contents of the file. If you want this,
10109 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10110 the string expansion fails.
10111
10112 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10113 locks out the use of this expansion item in filter files.
10114
10115
10116
10117 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10118         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10119 .cindex "expansion" "inserting from a socket"
10120 .cindex "socket, use of in expansion"
10121 .cindex "&%readsocket%& expansion item"
10122 This item inserts data from a Unix domain or TCP socket into the expanded
10123 string. The minimal way of using it uses just two arguments, as in these
10124 examples:
10125 .code
10126 ${readsocket{/socket/name}{request string}}
10127 ${readsocket{inet:some.host:1234}{request string}}
10128 .endd
10129 For a Unix domain socket, the first substring must be the path to the socket.
10130 For an Internet socket, the first substring must contain &`inet:`& followed by
10131 a host name or IP address, followed by a colon and a port, which can be a
10132 number or the name of a TCP port in &_/etc/services_&. An IP address may
10133 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10134 example:
10135 .code
10136 ${readsocket{inet:[::1]:1234}{request string}}
10137 .endd
10138 Only a single host name may be given, but if looking it up yields more than
10139 one IP address, they are each tried in turn until a connection is made. For
10140 both kinds of socket, Exim makes a connection, writes the request string
10141 unless it is an empty string; and no terminating NUL is ever sent)
10142 and reads from the socket until an end-of-file
10143 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10144 extend what can be done. Firstly, you can vary the timeout. For example:
10145 .code
10146 ${readsocket{/socket/name}{request string}{3s}}
10147 .endd
10148
10149 The third argument is a list of options, of which the first element is the timeout
10150 and must be present if the argument is given.
10151 Further elements are options of form &'name=value'&.
10152 Two option types is currently recognised: shutdown and tls.
10153 The first defines whether (the default)
10154 or not a shutdown is done on the connection after sending the request.
10155 Example, to not do so (preferred, eg. by some webservers):
10156 .code
10157 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10158 .endd
10159 The second, tls, controls the use of TLS on the connection.  Example:
10160 .code
10161 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10162 .endd
10163 The default is to not use TLS.
10164 If it is enabled, a shutdown as descripbed above is never done.
10165
10166 A fourth argument allows you to change any newlines that are in the data
10167 that is read, in the same way as for &%readfile%& (see above). This example
10168 turns them into spaces:
10169 .code
10170 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10171 .endd
10172 As with all expansions, the substrings are expanded before the processing
10173 happens. Errors in these sub-expansions cause the expansion to fail. In
10174 addition, the following errors can occur:
10175
10176 .ilist
10177 Failure to create a socket file descriptor;
10178 .next
10179 Failure to connect the socket;
10180 .next
10181 Failure to write the request string;
10182 .next
10183 Timeout on reading from the socket.
10184 .endlist
10185
10186 By default, any of these errors causes the expansion to fail. However, if
10187 you supply a fifth substring, it is expanded and used when any of the above
10188 errors occurs. For example:
10189 .code
10190 ${readsocket{/socket/name}{request string}{3s}{\n}\
10191   {socket failure}}
10192 .endd
10193 You can test for the existence of a Unix domain socket by wrapping this
10194 expansion in &`${if exists`&, but there is a race condition between that test
10195 and the actual opening of the socket, so it is safer to use the fifth argument
10196 if you want to be absolutely sure of avoiding an expansion error for a
10197 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10198
10199 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10200 locks out the use of this expansion item in filter files.
10201
10202
10203 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10204 .cindex "expansion" "reducing a list to a scalar"
10205 .cindex "list" "reducing to a scalar"
10206 .vindex "&$value$&"
10207 .vindex "&$item$&"
10208 This operation reduces a list to a single, scalar string. After expansion,
10209 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10210 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10211 Then <&'string2'&> is expanded and
10212 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10213 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10214 them. The result of that expansion is assigned to &$value$& before the next
10215 iteration. When the end of the list is reached, the final value of &$value$& is
10216 added to the expansion output. The &%reduce%& expansion item can be used in a
10217 number of ways. For example, to add up a list of numbers:
10218 .code
10219 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10220 .endd
10221 The result of that expansion would be &`6`&. The maximum of a list of numbers
10222 can be found:
10223 .code
10224 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10225 .endd
10226 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10227 restored to what they were before. See also the &%filter%& and &%map%&
10228 expansion items.
10229
10230 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10231 This item inserts &"raw"& header lines. It is described with the &%header%&
10232 expansion item in section &<<SECTexpansionitems>>& above.
10233
10234 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10235         {*&<&'string2'&>&*}}*&"
10236 .cindex "expansion" "running a command"
10237 .cindex "&%run%& expansion item"
10238 The command and its arguments are first expanded as one string. The string is
10239 split apart into individual arguments by spaces, and then the command is run
10240 in a separate process, but under the same uid and gid.  As in other command
10241 executions from Exim, a shell is not used by default. If the command requires
10242 a shell, you must explicitly code it.
10243
10244 Since the arguments are split by spaces, when there is a variable expansion
10245 which has an empty result, it will cause the situation that the argument will
10246 simply be omitted when the program is actually executed by Exim. If the
10247 script/program requires a specific number of arguments and the expanded
10248 variable could possibly result in this empty expansion, the variable must be
10249 quoted. This is more difficult if the expanded variable itself could result
10250 in a string containing quotes, because it would interfere with the quotes
10251 around the command arguments. A possible guard against this is to wrap the
10252 variable in the &%sg%& operator to change any quote marks to some other
10253 character.
10254
10255 The standard input for the command exists, but is empty. The standard output
10256 and standard error are set to the same file descriptor.
10257 .cindex "return code" "from &%run%& expansion"
10258 .vindex "&$value$&"
10259 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10260 and replaces the entire item; during this expansion, the standard output/error
10261 from the command is in the variable &$value$&. If the command fails,
10262 <&'string2'&>, if present, is expanded and used. Once again, during the
10263 expansion, the standard output/error from the command is in the variable
10264 &$value$&.
10265
10266 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10267 can be the word &"fail"& (not in braces) to force expansion failure if the
10268 command does not succeed. If both strings are omitted, the result is contents
10269 of the standard output/error on success, and nothing on failure.
10270
10271 .vindex "&$run_in_acl$&"
10272 The standard output/error of the command is put in the variable &$value$&.
10273 In this ACL example, the output of a command is logged for the admin to
10274 troubleshoot:
10275 .code
10276 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10277       log_message  = Output of id: $value
10278 .endd
10279 If the command requires shell idioms, such as the > redirect operator, the
10280 shell must be invoked directly, such as with:
10281 .code
10282 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10283 .endd
10284
10285 .vindex "&$runrc$&"
10286 The return code from the command is put in the variable &$runrc$&, and this
10287 remains set afterwards, so in a filter file you can do things like this:
10288 .code
10289 if "${run{x y z}{}}$runrc" is 1 then ...
10290   elif $runrc is 2 then ...
10291   ...
10292 endif
10293 .endd
10294 If execution of the command fails (for example, the command does not exist),
10295 the return code is 127 &-- the same code that shells use for non-existent
10296 commands.
10297
10298 &*Warning*&: In a router or transport, you cannot assume the order in which
10299 option values are expanded, except for those preconditions whose order of
10300 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10301 by the expansion of one option, and use it in another.
10302
10303 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10304 out the use of this expansion item in filter files.
10305
10306
10307 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10308 .cindex "expansion" "string substitution"
10309 .cindex "&%sg%& expansion item"
10310 This item works like Perl's substitution operator (s) with the global (/g)
10311 option; hence its name. However, unlike the Perl equivalent, Exim does not
10312 modify the subject string; instead it returns the modified string for insertion
10313 into the overall expansion. The item takes three arguments: the subject string,
10314 a regular expression, and a substitution string. For example:
10315 .code
10316 ${sg{abcdefabcdef}{abc}{xyz}}
10317 .endd
10318 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10319 if any $, } or \ characters are required in the regular expression or in the
10320 substitution string, they have to be escaped. For example:
10321 .code
10322 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10323 .endd
10324 yields &"defabc"&, and
10325 .code
10326 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10327 .endd
10328 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10329 the regular expression from string expansion.
10330
10331 The regular expression is compiled in 8-bit mode, working against bytes
10332 rather than any Unicode-aware character handling.
10333
10334
10335 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10336 .cindex sorting "a list"
10337 .cindex list sorting
10338 .cindex expansion "list sorting"
10339 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10340 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10341 The <&'comparator'&> argument is interpreted as the operator
10342 of a two-argument expansion condition.
10343 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10344 The comparison should return true when applied to two values
10345 if the first value should sort before the second value.
10346 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10347 the element being placed in &$item$&,
10348 to give values for comparison.
10349
10350 The item result is a sorted list,
10351 with the original list separator,
10352 of the list elements (in full) of the original.
10353
10354 Examples:
10355 .code
10356 ${sort{3:2:1:4}{<}{$item}}
10357 .endd
10358 sorts a list of numbers, and
10359 .code
10360 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10361 .endd
10362 will sort an MX lookup into priority order.
10363
10364
10365 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10366 .cindex "&%substr%& expansion item"
10367 .cindex "substring extraction"
10368 .cindex "expansion" "substring extraction"
10369 The three strings are expanded; the first two must yield numbers. Call them
10370 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10371 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10372 can use the simpler operator notation that avoids some of the braces:
10373 .code
10374 ${substr_<n>_<m>:<string>}
10375 .endd
10376 The second number is optional (in both notations).
10377 If it is absent in the simpler format, the preceding underscore must also be
10378 omitted.
10379
10380 The &%substr%& item can be used to extract more general substrings than
10381 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10382 length required. For example
10383 .code
10384 ${substr{3}{2}{$local_part}}
10385 .endd
10386 If the starting offset is greater than the string length the result is the
10387 null string; if the length plus starting offset is greater than the string
10388 length, the result is the right-hand part of the string, starting from the
10389 given offset. The first byte (character) in the string has offset zero.
10390
10391 The &%substr%& expansion item can take negative offset values to count
10392 from the right-hand end of its operand. The last byte (character) is offset -1,
10393 the second-last is offset -2, and so on. Thus, for example,
10394 .code
10395 ${substr{-5}{2}{1234567}}
10396 .endd
10397 yields &"34"&. If the absolute value of a negative offset is greater than the
10398 length of the string, the substring starts at the beginning of the string, and
10399 the length is reduced by the amount of overshoot. Thus, for example,
10400 .code
10401 ${substr{-5}{2}{12}}
10402 .endd
10403 yields an empty string, but
10404 .code
10405 ${substr{-3}{2}{12}}
10406 .endd
10407 yields &"1"&.
10408
10409 When the second number is omitted from &%substr%&, the remainder of the string
10410 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10411 string preceding the offset point are taken. For example, an offset of -1 and
10412 no length, as in these semantically identical examples:
10413 .code
10414 ${substr_-1:abcde}
10415 ${substr{-1}{abcde}}
10416 .endd
10417 yields all but the last character of the string, that is, &"abcd"&.
10418
10419 All measurement is done in bytes and is not UTF-8 aware.
10420
10421
10422
10423 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10424         {*&<&'replacements'&>&*}}*&"
10425 .cindex "expansion" "character translation"
10426 .cindex "&%tr%& expansion item"
10427 This item does single-character (in bytes) translation on its subject string. The second
10428 argument is a list of characters to be translated in the subject string. Each
10429 matching character is replaced by the corresponding character from the
10430 replacement list. For example
10431 .code
10432 ${tr{abcdea}{ac}{13}}
10433 .endd
10434 yields &`1b3de1`&. If there are duplicates in the second character string, the
10435 last occurrence is used. If the third string is shorter than the second, its
10436 last character is replicated. However, if it is empty, no translation takes
10437 place.
10438
10439 All character handling is done in bytes and is not UTF-8 aware.
10440
10441 .endlist
10442
10443
10444
10445 .section "Expansion operators" "SECTexpop"
10446 .cindex "expansion" "operators"
10447 For expansion items that perform transformations on a single argument string,
10448 the &"operator"& notation is used because it is simpler and uses fewer braces.
10449 The substring is first expanded before the operation is applied to it. The
10450 following operations can be performed:
10451
10452 .vlist
10453 .vitem &*${address:*&<&'string'&>&*}*&
10454 .cindex "expansion" "RFC 2822 address handling"
10455 .cindex "&%address%& expansion item"
10456 The string is interpreted as an RFC 2822 address, as it might appear in a
10457 header line, and the effective address is extracted from it. If the string does
10458 not parse successfully, the result is empty.
10459
10460 The parsing correctly handles SMTPUTF8 Unicode in the string.
10461
10462
10463 .vitem &*${addresses:*&<&'string'&>&*}*&
10464 .cindex "expansion" "RFC 2822 address handling"
10465 .cindex "&%addresses%& expansion item"
10466 The string (after expansion) is interpreted as a list of addresses in RFC
10467 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10468 operative address (&'local-part@domain'&) is extracted from each item, and the
10469 result of the expansion is a colon-separated list, with appropriate
10470 doubling of colons should any happen to be present in the email addresses.
10471 Syntactically invalid RFC2822 address items are omitted from the output.
10472
10473 It is possible to specify a character other than colon for the output
10474 separator by starting the string with > followed by the new separator
10475 character. For example:
10476 .code
10477 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10478 .endd
10479 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10480 first, so if the expanded string starts with >, it may change the output
10481 separator unintentionally. This can be avoided by setting the output
10482 separator explicitly:
10483 .code
10484 ${addresses:>:$h_from:}
10485 .endd
10486
10487 Compare the &%address%& (singular)
10488 expansion item, which extracts the working address from a single RFC2822
10489 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10490 processing lists.
10491
10492 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10493 a strict interpretation of header line formatting.  Exim parses the bare,
10494 unquoted portion of an email address and if it finds a comma, treats it as an
10495 email address separator. For the example header line:
10496 .code
10497 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10498 .endd
10499 The first example below demonstrates that Q-encoded email addresses are parsed
10500 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10501 It does not see the comma because it's still encoded as "=2C".  The second
10502 example below is passed the contents of &`$header_from:`&, meaning it gets
10503 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10504 The third example shows that the presence of a comma is skipped when it is
10505 quoted.  The fourth example shows SMTPUTF8 handling.
10506 .code
10507 # exim -be '${addresses:From: \
10508 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10509 user@example.com
10510 # exim -be '${addresses:From: Last, First <user@example.com>}'
10511 Last:user@example.com
10512 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10513 user@example.com
10514 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10515 フィリップ@example.jp
10516 .endd
10517
10518 .vitem &*${base32:*&<&'digits'&>&*}*&
10519 .cindex "&%base32%& expansion item"
10520 .cindex "expansion" "conversion to base 32"
10521 The string must consist entirely of decimal digits. The number is converted to
10522 base 32 and output as a (empty, for zero) string of characters.
10523 Only lowercase letters are used.
10524
10525 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10526 .cindex "&%base32d%& expansion item"
10527 .cindex "expansion" "conversion to base 32"
10528 The string must consist entirely of base-32 digits.
10529 The number is converted to decimal and output as a string.
10530
10531 .vitem &*${base62:*&<&'digits'&>&*}*&
10532 .cindex "&%base62%& expansion item"
10533 .cindex "expansion" "conversion to base 62"
10534 The string must consist entirely of decimal digits. The number is converted to
10535 base 62 and output as a string of six characters, including leading zeros. In
10536 the few operating environments where Exim uses base 36 instead of base 62 for
10537 its message identifiers (because those systems do not have case-sensitive
10538 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10539 to be absolutely clear: this is &'not'& base64 encoding.
10540
10541 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10542 .cindex "&%base62d%& expansion item"
10543 .cindex "expansion" "conversion to base 62"
10544 The string must consist entirely of base-62 digits, or, in operating
10545 environments where Exim uses base 36 instead of base 62 for its message
10546 identifiers, base-36 digits. The number is converted to decimal and output as a
10547 string.
10548
10549 .vitem &*${base64:*&<&'string'&>&*}*&
10550 .cindex "expansion" "base64 encoding"
10551 .cindex "base64 encoding" "in string expansion"
10552 .cindex "&%base64%& expansion item"
10553 .cindex certificate "base64 of DER"
10554 This operator converts a string into one that is base64 encoded.
10555
10556 If the string is a single variable of type certificate,
10557 returns the base64 encoding of the DER form of the certificate.
10558
10559
10560 .vitem &*${base64d:*&<&'string'&>&*}*&
10561 .cindex "expansion" "base64 decoding"
10562 .cindex "base64 decoding" "in string expansion"
10563 .cindex "&%base64d%& expansion item"
10564 This operator converts a base64-encoded string into the un-coded form.
10565
10566
10567 .vitem &*${domain:*&<&'string'&>&*}*&
10568 .cindex "domain" "extraction"
10569 .cindex "expansion" "domain extraction"
10570 The string is interpreted as an RFC 2822 address and the domain is extracted
10571 from it. If the string does not parse successfully, the result is empty.
10572
10573
10574 .vitem &*${escape:*&<&'string'&>&*}*&
10575 .cindex "expansion" "escaping non-printing characters"
10576 .cindex "&%escape%& expansion item"
10577 If the string contains any non-printing characters, they are converted to
10578 escape sequences starting with a backslash. Whether characters with the most
10579 significant bit set (so-called &"8-bit characters"&) count as printing or not
10580 is controlled by the &%print_topbitchars%& option.
10581
10582 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10583 .cindex "expansion" "escaping 8-bit characters"
10584 .cindex "&%escape8bit%& expansion item"
10585 If the string contains and characters with the most significant bit set,
10586 they are converted to escape sequences starting with a backslash.
10587 Backslashes and DEL characters are also converted.
10588
10589
10590 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10591 .cindex "expansion" "expression evaluation"
10592 .cindex "expansion" "arithmetic expression"
10593 .cindex "&%eval%& expansion item"
10594 These items supports simple arithmetic and bitwise logical operations in
10595 expansion strings. The string (after expansion) must be a conventional
10596 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10597 logical operators, and parentheses. All operations are carried out using
10598 integer arithmetic. The operator priorities are as follows (the same as in the
10599 C programming language):
10600 .table2 70pt 300pt
10601 .irow &'highest:'& "not (~), negate (-)"
10602 .irow ""   "multiply (*), divide (/), remainder (%)"
10603 .irow ""   "plus (+), minus (-)"
10604 .irow ""   "shift-left (<<), shift-right (>>)"
10605 .irow ""   "and (&&)"
10606 .irow ""   "xor (^)"
10607 .irow &'lowest:'&  "or (|)"
10608 .endtable
10609 Binary operators with the same priority are evaluated from left to right. White
10610 space is permitted before or after operators.
10611
10612 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10613 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10614 decimal, even if they start with a leading zero; hexadecimal numbers are not
10615 permitted. This can be useful when processing numbers extracted from dates or
10616 times, which often do have leading zeros.
10617
10618 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10619 or 1024*1024*1024,
10620 respectively. Negative numbers are supported. The result of the computation is
10621 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10622
10623 .display
10624 &`${eval:1+1}            `&  yields 2
10625 &`${eval:1+2*3}          `&  yields 7
10626 &`${eval:(1+2)*3}        `&  yields 9
10627 &`${eval:2+42%5}         `&  yields 4
10628 &`${eval:0xc&amp;5}          `&  yields 4
10629 &`${eval:0xc|5}          `&  yields 13
10630 &`${eval:0xc^5}          `&  yields 9
10631 &`${eval:0xc>>1}         `&  yields 6
10632 &`${eval:0xc<<1}         `&  yields 24
10633 &`${eval:~255&amp;0x1234}    `&  yields 4608
10634 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10635 .endd
10636
10637 As a more realistic example, in an ACL you might have
10638 .code
10639 deny   message = Too many bad recipients
10640        condition =                    \
10641          ${if and {                   \
10642            {>{$rcpt_count}{10}}       \
10643            {                          \
10644            <                          \
10645              {$recipients_count}      \
10646              {${eval:$rcpt_count/2}}  \
10647            }                          \
10648          }{yes}{no}}
10649 .endd
10650 The condition is true if there have been more than 10 RCPT commands and
10651 fewer than half of them have resulted in a valid recipient.
10652
10653
10654 .vitem &*${expand:*&<&'string'&>&*}*&
10655 .cindex "expansion" "re-expansion of substring"
10656 The &%expand%& operator causes a string to be expanded for a second time. For
10657 example,
10658 .code
10659 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10660 .endd
10661 first looks up a string in a file while expanding the operand for &%expand%&,
10662 and then re-expands what it has found.
10663
10664
10665 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10666 .cindex "Unicode"
10667 .cindex "UTF-8" "conversion from"
10668 .cindex "expansion" "UTF-8 conversion"
10669 .cindex "&%from_utf8%& expansion item"
10670 The world is slowly moving towards Unicode, although there are no standards for
10671 email yet. However, other applications (including some databases) are starting
10672 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10673 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10674 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10675 the result is an undefined sequence of bytes.
10676
10677 Unicode code points with values less than 256 are compatible with ASCII and
10678 ISO-8859-1 (also known as Latin-1).
10679 For example, character 169 is the copyright symbol in both cases, though the
10680 way it is encoded is different. In UTF-8, more than one byte is needed for
10681 characters with code values greater than 127, whereas ISO-8859-1 is a
10682 single-byte encoding (but thereby limited to 256 characters). This makes
10683 translation from UTF-8 to ISO-8859-1 straightforward.
10684
10685
10686 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10687 .cindex "hash function" "textual"
10688 .cindex "expansion" "textual hash"
10689 The &%hash%& operator is a simpler interface to the hashing function that can
10690 be used when the two parameters are fixed numbers (as opposed to strings that
10691 change when expanded). The effect is the same as
10692 .code
10693 ${hash{<n>}{<m>}{<string>}}
10694 .endd
10695 See the description of the general &%hash%& item above for details. The
10696 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10697
10698
10699
10700 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10701 .cindex "base64 encoding" "conversion from hex"
10702 .cindex "expansion" "hex to base64"
10703 .cindex "&%hex2b64%& expansion item"
10704 This operator converts a hex string into one that is base64 encoded. This can
10705 be useful for processing the output of the various hashing functions.
10706
10707
10708
10709 .vitem &*${hexquote:*&<&'string'&>&*}*&
10710 .cindex "quoting" "hex-encoded unprintable characters"
10711 .cindex "&%hexquote%& expansion item"
10712 This operator converts non-printable characters in a string into a hex
10713 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10714 as is, and other byte values are converted to &`\xNN`&, for example, a
10715 byte value 127 is converted to &`\x7f`&.
10716
10717
10718 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10719 .cindex "&%ipv6denorm%& expansion item"
10720 .cindex "IP address" normalisation
10721 This expands an IPv6 address to a full eight-element colon-separated set
10722 of hex digits including leading zeroes.
10723 A trailing ipv4-style dotted-decimal set is converted to hex.
10724 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10725
10726 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10727 .cindex "&%ipv6norm%& expansion item"
10728 .cindex "IP address" normalisation
10729 .cindex "IP address" "canonical form"
10730 This converts an IPv6 address to canonical form.
10731 Leading zeroes of groups are omitted, and the longest
10732 set of zero-valued groups is replaced with a double colon.
10733 A trailing ipv4-style dotted-decimal set is converted to hex.
10734 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10735
10736
10737 .vitem &*${lc:*&<&'string'&>&*}*&
10738 .cindex "case forcing in strings"
10739 .cindex "string" "case forcing"
10740 .cindex "lower casing"
10741 .cindex "expansion" "case forcing"
10742 .cindex "&%lc%& expansion item"
10743 This forces the letters in the string into lower-case, for example:
10744 .code
10745 ${lc:$local_part}
10746 .endd
10747 Case is defined per the system C locale.
10748
10749 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10750 .cindex "expansion" "string truncation"
10751 .cindex "&%length%& expansion item"
10752 The &%length%& operator is a simpler interface to the &%length%& function that
10753 can be used when the parameter is a fixed number (as opposed to a string that
10754 changes when expanded). The effect is the same as
10755 .code
10756 ${length{<number>}{<string>}}
10757 .endd
10758 See the description of the general &%length%& item above for details. Note that
10759 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10760 when &%length%& is used as an operator.
10761 All measurement is done in bytes and is not UTF-8 aware.
10762
10763
10764 .vitem &*${listcount:*&<&'string'&>&*}*&
10765 .cindex "expansion" "list item count"
10766 .cindex "list" "item count"
10767 .cindex "list" "count of items"
10768 .cindex "&%listcount%& expansion item"
10769 The string is interpreted as a list and the number of items is returned.
10770
10771
10772 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10773 .cindex "expansion" "named list"
10774 .cindex "&%listnamed%& expansion item"
10775 The name is interpreted as a named list and the content of the list is returned,
10776 expanding any referenced lists, re-quoting as needed for colon-separation.
10777 If the optional type is given it must be one of "a", "d", "h" or "l"
10778 and selects address-, domain-, host- or localpart- lists to search among respectively.
10779 Otherwise all types are searched in an undefined order and the first
10780 matching list is returned.
10781
10782
10783 .vitem &*${local_part:*&<&'string'&>&*}*&
10784 .cindex "expansion" "local part extraction"
10785 .cindex "&%local_part%& expansion item"
10786 The string is interpreted as an RFC 2822 address and the local part is
10787 extracted from it. If the string does not parse successfully, the result is
10788 empty.
10789 The parsing correctly handles SMTPUTF8 Unicode in the string.
10790
10791
10792 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10793 .cindex "masked IP address"
10794 .cindex "IP address" "masking"
10795 .cindex "CIDR notation"
10796 .cindex "expansion" "IP address masking"
10797 .cindex "&%mask%& expansion item"
10798 If the form of the string to be operated on is not an IP address followed by a
10799 slash and an integer (that is, a network address in CIDR notation), the
10800 expansion fails. Otherwise, this operator converts the IP address to binary,
10801 masks off the least significant bits according to the bit count, and converts
10802 the result back to text, with mask appended. For example,
10803 .code
10804 ${mask:10.111.131.206/28}
10805 .endd
10806 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10807 be mostly used for looking up masked addresses in files, the result for an IPv6
10808 address uses dots to separate components instead of colons, because colon
10809 terminates a key string in lsearch files. So, for example,
10810 .code
10811 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10812 .endd
10813 returns the string
10814 .code
10815 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10816 .endd
10817 Letters in IPv6 addresses are always output in lower case.
10818
10819
10820 .vitem &*${md5:*&<&'string'&>&*}*&
10821 .cindex "MD5 hash"
10822 .cindex "expansion" "MD5 hash"
10823 .cindex certificate fingerprint
10824 .cindex "&%md5%& expansion item"
10825 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10826 as a 32-digit hexadecimal number, in which any letters are in lower case.
10827
10828 If the string is a single variable of type certificate,
10829 returns the MD5 hash fingerprint of the certificate.
10830
10831
10832 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10833 .cindex "expansion" "numeric hash"
10834 .cindex "hash function" "numeric"
10835 The &%nhash%& operator is a simpler interface to the numeric hashing function
10836 that can be used when the two parameters are fixed numbers (as opposed to
10837 strings that change when expanded). The effect is the same as
10838 .code
10839 ${nhash{<n>}{<m>}{<string>}}
10840 .endd
10841 See the description of the general &%nhash%& item above for details.
10842
10843
10844 .vitem &*${quote:*&<&'string'&>&*}*&
10845 .cindex "quoting" "in string expansions"
10846 .cindex "expansion" "quoting"
10847 .cindex "&%quote%& expansion item"
10848 The &%quote%& operator puts its argument into double quotes if it
10849 is an empty string or
10850 contains anything other than letters, digits, underscores, dots, and hyphens.
10851 Any occurrences of double quotes and backslashes are escaped with a backslash.
10852 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10853 respectively For example,
10854 .code
10855 ${quote:ab"*"cd}
10856 .endd
10857 becomes
10858 .code
10859 "ab\"*\"cd"
10860 .endd
10861 The place where this is useful is when the argument is a substitution from a
10862 variable or a message header.
10863
10864 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10865 .cindex "&%quote_local_part%& expansion item"
10866 This operator is like &%quote%&, except that it quotes the string only if
10867 required to do so by the rules of RFC 2822 for quoting local parts. For
10868 example, a plus sign would not cause quoting (but it would for &%quote%&).
10869 If you are creating a new email address from the contents of &$local_part$&
10870 (or any other unknown data), you should always use this operator.
10871
10872 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10873 will likely use the quoting form.
10874 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10875
10876
10877 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10878 .cindex "quoting" "lookup-specific"
10879 This operator applies lookup-specific quoting rules to the string. Each
10880 query-style lookup type has its own quoting rules which are described with
10881 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10882 .code
10883 ${quote_ldap:two * two}
10884 .endd
10885 returns
10886 .code
10887 two%20%5C2A%20two
10888 .endd
10889 For single-key lookup types, no quoting is ever necessary and this operator
10890 yields an unchanged string.
10891
10892
10893 .vitem &*${randint:*&<&'n'&>&*}*&
10894 .cindex "random number"
10895 This operator returns a somewhat random number which is less than the
10896 supplied number and is at least 0.  The quality of this randomness depends
10897 on how Exim was built; the values are not suitable for keying material.
10898 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10899 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10900 for versions of GnuTLS with that function.
10901 Otherwise, the implementation may be arc4random(), random() seeded by
10902 srandomdev() or srandom(), or a custom implementation even weaker than
10903 random().
10904
10905
10906 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10907 .cindex "expansion" "IP address"
10908 This operator reverses an IP address; for IPv4 addresses, the result is in
10909 dotted-quad decimal form, while for IPv6 addresses the result is in
10910 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10911 for DNS.  For example,
10912 .code
10913 ${reverse_ip:192.0.2.4}
10914 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10915 .endd
10916 returns
10917 .code
10918 4.2.0.192
10919 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
10920 .endd
10921
10922
10923 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10924 .cindex "expansion" "RFC 2047"
10925 .cindex "RFC 2047" "expansion operator"
10926 .cindex "&%rfc2047%& expansion item"
10927 This operator encodes text according to the rules of RFC 2047. This is an
10928 encoding that is used in header lines to encode non-ASCII characters. It is
10929 assumed that the input string is in the encoding specified by the
10930 &%headers_charset%& option, which gets its default at build time. If the string
10931 contains only characters in the range 33&--126, and no instances of the
10932 characters
10933 .code
10934 ? = ( ) < > @ , ; : \ " . [ ] _
10935 .endd
10936 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10937 string, using as many &"encoded words"& as necessary to encode all the
10938 characters.
10939
10940
10941 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10942 .cindex "expansion" "RFC 2047"
10943 .cindex "RFC 2047" "decoding"
10944 .cindex "&%rfc2047d%& expansion item"
10945 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10946 bytes are replaced by question marks. Characters are converted into the
10947 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10948 not recognized unless &%check_rfc2047_length%& is set false.
10949
10950 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10951 access a header line, RFC 2047 decoding is done automatically. You do not need
10952 to use this operator as well.
10953
10954
10955
10956 .vitem &*${rxquote:*&<&'string'&>&*}*&
10957 .cindex "quoting" "in regular expressions"
10958 .cindex "regular expressions" "quoting"
10959 .cindex "&%rxquote%& expansion item"
10960 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10961 characters in its argument. This is useful when substituting the values of
10962 variables or headers inside regular expressions.
10963
10964
10965 .vitem &*${sha1:*&<&'string'&>&*}*&
10966 .cindex "SHA-1 hash"
10967 .cindex "expansion" "SHA-1 hashing"
10968 .cindex certificate fingerprint
10969 .cindex "&%sha1%& expansion item"
10970 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10971 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10972
10973 If the string is a single variable of type certificate,
10974 returns the SHA-1 hash fingerprint of the certificate.
10975
10976
10977 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
10978        &*${sha2:*&<&'string'&>&*}*& &&&
10979        &*${sha2_<n>:*&<&'string'&>&*}*&
10980 .cindex "SHA-256 hash"
10981 .cindex "SHA-2 hash"
10982 .cindex certificate fingerprint
10983 .cindex "expansion" "SHA-256 hashing"
10984 .cindex "&%sha256%& expansion item"
10985 .cindex "&%sha2%& expansion item"
10986 The &%sha256%& operator computes the SHA-256 hash value of the string
10987 and returns
10988 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10989
10990 If the string is a single variable of type certificate,
10991 returns the SHA-256 hash fingerprint of the certificate.
10992
10993 .new
10994 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
10995 (except for certificates, which are not supported).
10996 Finally, if an underbar
10997 and a number is appended it specifies the output length, selecting a
10998 member of the SHA-2 family of hash functions.
10999 Values of 256, 384 and 512 are accepted, with 256 being the default.
11000 .wen
11001
11002
11003 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11004        &*${sha3_<n>:*&<&'string'&>&*}*&
11005 .cindex "SHA3 hash"
11006 .cindex "expansion" "SHA3 hashing"
11007 .cindex "&%sha3%& expansion item"
11008 The &%sha3%& operator computes the SHA3-256 hash value of the string
11009 and returns
11010 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11011
11012 If a number is appended, separated by an underbar, it specifies
11013 the output length.  Values of 224, 256, 384 and 512 are accepted;
11014 with 256 being the default.
11015
11016 The &%sha3%& expansion item is only supported if Exim has been
11017 compiled with GnuTLS 3.5.0 or later,
11018 or OpenSSL 1.1.1 or later.
11019 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11020
11021
11022 .vitem &*${stat:*&<&'string'&>&*}*&
11023 .cindex "expansion" "statting a file"
11024 .cindex "file" "extracting characteristics"
11025 .cindex "&%stat%& expansion item"
11026 The string, after expansion, must be a file path. A call to the &[stat()]&
11027 function is made for this path. If &[stat()]& fails, an error occurs and the
11028 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11029 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11030 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11031 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11032 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11033 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11034 can extract individual fields using the &%extract%& expansion item.
11035
11036 The use of the &%stat%& expansion in users' filter files can be locked out by
11037 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11038 systems for files larger than 2GB.
11039
11040 .vitem &*${str2b64:*&<&'string'&>&*}*&
11041 .cindex "&%str2b64%& expansion item"
11042 Now deprecated, a synonym for the &%base64%& expansion operator.
11043
11044
11045
11046 .vitem &*${strlen:*&<&'string'&>&*}*&
11047 .cindex "expansion" "string length"
11048 .cindex "string" "length in expansion"
11049 .cindex "&%strlen%& expansion item"
11050 The item is replace by the length of the expanded string, expressed as a
11051 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11052 All measurement is done in bytes and is not UTF-8 aware.
11053
11054
11055 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11056 .cindex "&%substr%& expansion item"
11057 .cindex "substring extraction"
11058 .cindex "expansion" "substring expansion"
11059 The &%substr%& operator is a simpler interface to the &%substr%& function that
11060 can be used when the two parameters are fixed numbers (as opposed to strings
11061 that change when expanded). The effect is the same as
11062 .code
11063 ${substr{<start>}{<length>}{<string>}}
11064 .endd
11065 See the description of the general &%substr%& item above for details. The
11066 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11067 All measurement is done in bytes and is not UTF-8 aware.
11068
11069 .vitem &*${time_eval:*&<&'string'&>&*}*&
11070 .cindex "&%time_eval%& expansion item"
11071 .cindex "time interval" "decoding"
11072 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11073 seconds.
11074
11075 .vitem &*${time_interval:*&<&'string'&>&*}*&
11076 .cindex "&%time_interval%& expansion item"
11077 .cindex "time interval" "formatting"
11078 The argument (after sub-expansion) must be a sequence of decimal digits that
11079 represents an interval of time as a number of seconds. It is converted into a
11080 number of larger units and output in Exim's normal time format, for example,
11081 &`1w3d4h2m6s`&.
11082
11083 .vitem &*${uc:*&<&'string'&>&*}*&
11084 .cindex "case forcing in strings"
11085 .cindex "string" "case forcing"
11086 .cindex "upper casing"
11087 .cindex "expansion" "case forcing"
11088 .cindex "&%uc%& expansion item"
11089 This forces the letters in the string into upper-case.
11090 Case is defined per the system C locale.
11091
11092 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11093 .cindex "correction of invalid utf-8 sequences in strings"
11094 .cindex "utf-8" "utf-8 sequences"
11095 .cindex "incorrect utf-8"
11096 .cindex "expansion" "utf-8 forcing"
11097 .cindex "&%utf8clean%& expansion item"
11098 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11099 In versions of Exim before 4.92, this did not correctly do so for a truncated
11100 final codepoint's encoding, and the character would be silently dropped.
11101 If you must handle detection of this scenario across both sets of Exim behavior,
11102 the complexity will depend upon the task.
11103 For instance, to detect if the first character is multibyte and a 1-byte
11104 extraction can be successfully used as a path component (as is common for
11105 dividing up delivery folders), you might use:
11106 .code
11107 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11108 .endd
11109 (which will false-positive if the first character of the local part is a
11110 literal question mark).
11111
11112 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11113        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11114        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11115        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11116 .cindex expansion UTF-8
11117 .cindex UTF-8 expansion
11118 .cindex EAI
11119 .cindex internationalisation
11120 .cindex "&%utf8_domain_to_alabel%& expansion item"
11121 .cindex "&%utf8_domain_from_alabel%& expansion item"
11122 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11123 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11124 These convert EAI mail name components between UTF-8 and a-label forms.
11125 For information on internationalisation support see &<<SECTi18nMTA>>&.
11126 .endlist
11127
11128
11129
11130
11131
11132
11133 .section "Expansion conditions" "SECTexpcond"
11134 .scindex IIDexpcond "expansion" "conditions"
11135 The following conditions are available for testing by the &%${if%& construct
11136 while expanding strings:
11137
11138 .vlist
11139 .vitem &*!*&<&'condition'&>
11140 .cindex "expansion" "negating a condition"
11141 .cindex "negation" "in expansion condition"
11142 Preceding any condition with an exclamation mark negates the result of the
11143 condition.
11144
11145 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11146 .cindex "numeric comparison"
11147 .cindex "expansion" "numeric comparison"
11148 There are a number of symbolic operators for doing numeric comparisons. They
11149 are:
11150 .display
11151 &`=   `&   equal
11152 &`==  `&   equal
11153 &`>   `&   greater
11154 &`>=  `&   greater or equal
11155 &`<   `&   less
11156 &`<=  `&   less or equal
11157 .endd
11158 For example:
11159 .code
11160 ${if >{$message_size}{10M} ...
11161 .endd
11162 Note that the general negation operator provides for inequality testing. The
11163 two strings must take the form of optionally signed decimal integers,
11164 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11165 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11166 As a special case, the numerical value of an empty string is taken as
11167 zero.
11168
11169 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11170 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11171 10M, not if 10M is larger than &$message_size$&.
11172
11173
11174 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11175         {*&<&'arg2'&>&*}...}*&
11176 .cindex "expansion" "calling an acl"
11177 .cindex "&%acl%&" "expansion condition"
11178 The name and zero to nine argument strings are first expanded separately.  The expanded
11179 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11180 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11181 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11182 and may use the variables; if another acl expansion is used the values
11183 are restored after it returns.  If the ACL sets
11184 a value using a "message =" modifier the variable $value becomes
11185 the result of the expansion, otherwise it is empty.
11186 If the ACL returns accept the condition is true; if deny, false.
11187 If the ACL returns defer the result is a forced-fail.
11188
11189 .vitem &*bool&~{*&<&'string'&>&*}*&
11190 .cindex "expansion" "boolean parsing"
11191 .cindex "&%bool%& expansion condition"
11192 This condition turns a string holding a true or false representation into
11193 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11194 (case-insensitively); also integer numbers map to true if non-zero,
11195 false if zero.
11196 An empty string is treated as false.
11197 Leading and trailing whitespace is ignored;
11198 thus a string consisting only of whitespace is false.
11199 All other string values will result in expansion failure.
11200
11201 When combined with ACL variables, this expansion condition will let you
11202 make decisions in one place and act on those decisions in another place.
11203 For example:
11204 .code
11205 ${if bool{$acl_m_privileged_sender} ...
11206 .endd
11207
11208
11209 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11210 .cindex "expansion" "boolean parsing"
11211 .cindex "&%bool_lax%& expansion condition"
11212 Like &%bool%&, this condition turns a string into a boolean state.  But
11213 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11214 loose definition that the Router &%condition%& option uses.  The empty string
11215 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11216 true.  Leading and trailing whitespace is ignored.
11217
11218 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11219
11220 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11221 .cindex "expansion" "encrypted comparison"
11222 .cindex "encrypted strings, comparing"
11223 .cindex "&%crypteq%& expansion condition"
11224 This condition is included in the Exim binary if it is built to support any
11225 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11226 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11227 included in the binary.
11228
11229 The &%crypteq%& condition has two arguments. The first is encrypted and
11230 compared against the second, which is already encrypted. The second string may
11231 be in the LDAP form for storing encrypted strings, which starts with the
11232 encryption type in curly brackets, followed by the data. If the second string
11233 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11234 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11235 Typically this will be a field from a password file. An example of an encrypted
11236 string in LDAP form is:
11237 .code
11238 {md5}CY9rzUYh03PK3k6DJie09g==
11239 .endd
11240 If such a string appears directly in an expansion, the curly brackets have to
11241 be quoted, because they are part of the expansion syntax. For example:
11242 .code
11243 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11244 .endd
11245 The following encryption types (whose names are matched case-independently) are
11246 supported:
11247
11248 .ilist
11249 .cindex "MD5 hash"
11250 .cindex "base64 encoding" "in encrypted password"
11251 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11252 printable characters to compare with the remainder of the second string. If the
11253 length of the comparison string is 24, Exim assumes that it is base64 encoded
11254 (as in the above example). If the length is 32, Exim assumes that it is a
11255 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11256 comparison fails.
11257
11258 .next
11259 .cindex "SHA-1 hash"
11260 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11261 printable characters to compare with the remainder of the second string. If the
11262 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11263 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11264 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11265
11266 .next
11267 .cindex "&[crypt()]&"
11268 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11269 only the first eight characters of the password. However, in modern operating
11270 systems this is no longer true, and in many cases the entire password is used,
11271 whatever its length.
11272
11273 .next
11274 .cindex "&[crypt16()]&"
11275 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11276 use up to 16 characters of the password in some operating systems. Again, in
11277 modern operating systems, more characters may be used.
11278 .endlist
11279 Exim has its own version of &[crypt16()]&, which is just a double call to
11280 &[crypt()]&. For operating systems that have their own version, setting
11281 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11282 operating system version instead of its own. This option is set by default in
11283 the OS-dependent &_Makefile_& for those operating systems that are known to
11284 support &[crypt16()]&.
11285
11286 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11287 it was not using the same algorithm as some operating systems' versions. It
11288 turns out that as well as &[crypt16()]& there is a function called
11289 &[bigcrypt()]& in some operating systems. This may or may not use the same
11290 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11291
11292 However, since there is now a move away from the traditional &[crypt()]&
11293 functions towards using SHA1 and other algorithms, tidying up this area of
11294 Exim is seen as very low priority.
11295
11296 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11297 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11298 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11299 default is &`{crypt}`&. Whatever the default, you can always use either
11300 function by specifying it explicitly in curly brackets.
11301
11302 .vitem &*def:*&<&'variable&~name'&>
11303 .cindex "expansion" "checking for empty variable"
11304 .cindex "&%def%& expansion condition"
11305 The &%def%& condition must be followed by the name of one of the expansion
11306 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11307 variable does not contain the empty string. For example:
11308 .code
11309 ${if def:sender_ident {from $sender_ident}}
11310 .endd
11311 Note that the variable name is given without a leading &%$%& character. If the
11312 variable does not exist, the expansion fails.
11313
11314 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11315         &~&*def:h_*&<&'header&~name'&>&*:*&"
11316 .cindex "expansion" "checking header line existence"
11317 This condition is true if a message is being processed and the named header
11318 exists in the message. For example,
11319 .code
11320 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11321 .endd
11322 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11323 the header name must be terminated by a colon if white space does not follow.
11324
11325 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11326        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11327 .cindex "string" "comparison"
11328 .cindex "expansion" "string comparison"
11329 .cindex "&%eq%& expansion condition"
11330 .cindex "&%eqi%& expansion condition"
11331 The two substrings are first expanded. The condition is true if the two
11332 resulting strings are identical. For &%eq%& the comparison includes the case of
11333 letters, whereas for &%eqi%& the comparison is case-independent, where
11334 case is defined per the system C locale.
11335
11336 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11337 .cindex "expansion" "file existence test"
11338 .cindex "file" "existence test"
11339 .cindex "&%exists%&, expansion condition"
11340 The substring is first expanded and then interpreted as an absolute path. The
11341 condition is true if the named file (or directory) exists. The existence test
11342 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11343 users' filter files may be locked out by the system administrator.
11344
11345 .vitem &*first_delivery*&
11346 .cindex "delivery" "first"
11347 .cindex "first delivery"
11348 .cindex "expansion" "first delivery test"
11349 .cindex "&%first_delivery%& expansion condition"
11350 This condition, which has no data, is true during a message's first delivery
11351 attempt. It is false during any subsequent delivery attempts.
11352
11353
11354 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11355        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11356 .cindex "list" "iterative conditions"
11357 .cindex "expansion" "&*forall*& condition"
11358 .cindex "expansion" "&*forany*& condition"
11359 .vindex "&$item$&"
11360 These conditions iterate over a list. The first argument is expanded to form
11361 the list. By default, the list separator is a colon, but it can be changed by
11362 the normal method (&<<SECTlistsepchange>>&).
11363 The second argument is interpreted as a condition that is to
11364 be applied to each item in the list in turn. During the interpretation of the
11365 condition, the current list item is placed in a variable called &$item$&.
11366 .ilist
11367 For &*forany*&, interpretation stops if the condition is true for any item, and
11368 the result of the whole condition is true. If the condition is false for all
11369 items in the list, the overall condition is false.
11370 .next
11371 For &*forall*&, interpretation stops if the condition is false for any item,
11372 and the result of the whole condition is false. If the condition is true for
11373 all items in the list, the overall condition is true.
11374 .endlist
11375 Note that negation of &*forany*& means that the condition must be false for all
11376 items for the overall condition to succeed, and negation of &*forall*& means
11377 that the condition must be false for at least one item. In this example, the
11378 list separator is changed to a comma:
11379 .code
11380 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11381 .endd
11382 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11383 being processed, to enable these expansion items to be nested.
11384
11385 To scan a named list, expand it with the &*listnamed*& operator.
11386
11387 .new
11388 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11389        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11390        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11391        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11392 .cindex JSON "iterative conditions"
11393 .cindex JSON expansions
11394 .cindex expansion "&*forall_json*& condition"
11395 .cindex expansion "&*forany_json*& condition"
11396 .cindex expansion "&*forall_jsons*& condition"
11397 .cindex expansion "&*forany_jsons*& condition"
11398 As for the above, except that the first argument must, after expansion,
11399 be a JSON array.
11400 The array separator is not changeable.
11401 For the &"jsons"& variants the elements are expected to be JSON strings
11402 and have their quotes removed before the evaluation of the condition.
11403 .wen
11404
11405
11406
11407 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11408        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11409 .cindex "string" "comparison"
11410 .cindex "expansion" "string comparison"
11411 .cindex "&%ge%& expansion condition"
11412 .cindex "&%gei%& expansion condition"
11413 The two substrings are first expanded. The condition is true if the first
11414 string is lexically greater than or equal to the second string. For &%ge%& the
11415 comparison includes the case of letters, whereas for &%gei%& the comparison is
11416 case-independent.
11417 Case and collation order are defined per the system C locale.
11418
11419 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11420        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11421 .cindex "string" "comparison"
11422 .cindex "expansion" "string comparison"
11423 .cindex "&%gt%& expansion condition"
11424 .cindex "&%gti%& expansion condition"
11425 The two substrings are first expanded. The condition is true if the first
11426 string is lexically greater than the second string. For &%gt%& the comparison
11427 includes the case of letters, whereas for &%gti%& the comparison is
11428 case-independent.
11429 Case and collation order are defined per the system C locale.
11430
11431 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11432        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11433 .cindex "string" "comparison"
11434 .cindex "list" "iterative conditions"
11435 Both strings are expanded; the second string is treated as a list of simple
11436 strings; if the first string is a member of the second, then the condition
11437 is true.
11438 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11439
11440 These are simpler to use versions of the more powerful &*forany*& condition.
11441 Examples, and the &*forany*& equivalents:
11442 .code
11443 ${if inlist{needle}{foo:needle:bar}}
11444   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11445 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11446   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11447 .endd
11448
11449 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11450        &*isip4&~{*&<&'string'&>&*}*& &&&
11451        &*isip6&~{*&<&'string'&>&*}*&
11452 .cindex "IP address" "testing string format"
11453 .cindex "string" "testing for IP address"
11454 .cindex "&%isip%& expansion condition"
11455 .cindex "&%isip4%& expansion condition"
11456 .cindex "&%isip6%& expansion condition"
11457 The substring is first expanded, and then tested to see if it has the form of
11458 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11459 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11460
11461 For an IPv4 address, the test is for four dot-separated components, each of
11462 which consists of from one to three digits. For an IPv6 address, up to eight
11463 colon-separated components are permitted, each containing from one to four
11464 hexadecimal digits. There may be fewer than eight components if an empty
11465 component (adjacent colons) is present. Only one empty component is permitted.
11466
11467 &*Note*&: The checks used to be just on the form of the address; actual numerical
11468 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11469 check.
11470 This is no longer the case.
11471
11472 The main use of these tests is to distinguish between IP addresses and
11473 host names, or between IPv4 and IPv6 addresses. For example, you could use
11474 .code
11475 ${if isip4{$sender_host_address}...
11476 .endd
11477 to test which IP version an incoming SMTP connection is using.
11478
11479 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11480 .cindex "LDAP" "use for authentication"
11481 .cindex "expansion" "LDAP authentication test"
11482 .cindex "&%ldapauth%& expansion condition"
11483 This condition supports user authentication using LDAP. See section
11484 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11485 queries. For this use, the query must contain a user name and password. The
11486 query itself is not used, and can be empty. The condition is true if the
11487 password is not empty, and the user name and password are accepted by the LDAP
11488 server. An empty password is rejected without calling LDAP because LDAP binds
11489 with an empty password are considered anonymous regardless of the username, and
11490 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11491 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11492 this can be used.
11493
11494
11495 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11496        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11497 .cindex "string" "comparison"
11498 .cindex "expansion" "string comparison"
11499 .cindex "&%le%& expansion condition"
11500 .cindex "&%lei%& expansion condition"
11501 The two substrings are first expanded. The condition is true if the first
11502 string is lexically less than or equal to the second string. For &%le%& the
11503 comparison includes the case of letters, whereas for &%lei%& the comparison is
11504 case-independent.
11505 Case and collation order are defined per the system C locale.
11506
11507 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11508        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11509 .cindex "string" "comparison"
11510 .cindex "expansion" "string comparison"
11511 .cindex "&%lt%& expansion condition"
11512 .cindex "&%lti%& expansion condition"
11513 The two substrings are first expanded. The condition is true if the first
11514 string is lexically less than the second string. For &%lt%& the comparison
11515 includes the case of letters, whereas for &%lti%& the comparison is
11516 case-independent.
11517 Case and collation order are defined per the system C locale.
11518
11519
11520 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11521 .cindex "expansion" "regular expression comparison"
11522 .cindex "regular expressions" "match in expanded string"
11523 .cindex "&%match%& expansion condition"
11524 The two substrings are first expanded. The second is then treated as a regular
11525 expression and applied to the first. Because of the pre-expansion, if the
11526 regular expression contains dollar, or backslash characters, they must be
11527 escaped. Care must also be taken if the regular expression contains braces
11528 (curly brackets). A closing brace must be escaped so that it is not taken as a
11529 premature termination of <&'string2'&>. The easiest approach is to use the
11530 &`\N`& feature to disable expansion of the regular expression.
11531 For example,
11532 .code
11533 ${if match {$local_part}{\N^\d{3}\N} ...
11534 .endd
11535 If the whole expansion string is in double quotes, further escaping of
11536 backslashes is also required.
11537
11538 The condition is true if the regular expression match succeeds.
11539 The regular expression is not required to begin with a circumflex
11540 metacharacter, but if there is no circumflex, the expression is not anchored,
11541 and it may match anywhere in the subject, not just at the start. If you want
11542 the pattern to match at the end of the subject, you must include the &`$`&
11543 metacharacter at an appropriate point.
11544 All character handling is done in bytes and is not UTF-8 aware,
11545 but we might change this in a future Exim release.
11546
11547 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11548 At the start of an &%if%& expansion the values of the numeric variable
11549 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11550 succeeds causes them to be reset to the substrings of that condition and they
11551 will have these values during the expansion of the success string. At the end
11552 of the &%if%& expansion, the previous values are restored. After testing a
11553 combination of conditions using &%or%&, the subsequent values of the numeric
11554 variables are those of the condition that succeeded.
11555
11556 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11557 .cindex "&%match_address%& expansion condition"
11558 See &*match_local_part*&.
11559
11560 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11561 .cindex "&%match_domain%& expansion condition"
11562 See &*match_local_part*&.
11563
11564 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11565 .cindex "&%match_ip%& expansion condition"
11566 This condition matches an IP address to a list of IP address patterns. It must
11567 be followed by two argument strings. The first (after expansion) must be an IP
11568 address or an empty string. The second (not expanded) is a restricted host
11569 list that can match only an IP address, not a host name. For example:
11570 .code
11571 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11572 .endd
11573 The specific types of host list item that are permitted in the list are:
11574
11575 .ilist
11576 An IP address, optionally with a CIDR mask.
11577 .next
11578 A single asterisk, which matches any IP address.
11579 .next
11580 An empty item, which matches only if the IP address is empty. This could be
11581 useful for testing for a locally submitted message or one from specific hosts
11582 in a single test such as
11583 . ==== As this is a nested list, any displays it contains must be indented
11584 . ==== as otherwise they are too far to the left. This comment applies to
11585 . ==== the use of xmlto plus fop. There's no problem when formatting with
11586 . ==== sdop, with or without the extra indent.
11587 .code
11588   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11589 .endd
11590 where the first item in the list is the empty string.
11591 .next
11592 The item @[] matches any of the local host's interface addresses.
11593 .next
11594 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11595 even if &`net-`& is not specified. There is never any attempt to turn the IP
11596 address into a host name. The most common type of linear search for
11597 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11598 masks. For example:
11599 .code
11600   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11601 .endd
11602 It is of course possible to use other kinds of lookup, and in such a case, you
11603 do need to specify the &`net-`& prefix if you want to specify a specific
11604 address mask, for example:
11605 .code
11606   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11607 .endd
11608 However, unless you are combining a &%match_ip%& condition with others, it is
11609 just as easy to use the fact that a lookup is itself a condition, and write:
11610 .code
11611   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11612 .endd
11613 .endlist ilist
11614
11615 Note that <&'string2'&> is not itself subject to string expansion, unless
11616 Exim was built with the EXPAND_LISTMATCH_RHS option.
11617
11618 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11619
11620 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11621 .cindex "domain list" "in expansion condition"
11622 .cindex "address list" "in expansion condition"
11623 .cindex "local part" "list, in expansion condition"
11624 .cindex "&%match_local_part%& expansion condition"
11625 This condition, together with &%match_address%& and &%match_domain%&, make it
11626 possible to test domain, address, and local part lists within expansions. Each
11627 condition requires two arguments: an item and a list to match. A trivial
11628 example is:
11629 .code
11630 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11631 .endd
11632 In each case, the second argument may contain any of the allowable items for a
11633 list of the appropriate type. Also, because the second argument
11634 is a standard form of list, it is possible to refer to a named list.
11635 Thus, you can use conditions like this:
11636 .code
11637 ${if match_domain{$domain}{+local_domains}{...
11638 .endd
11639 .cindex "&`+caseful`&"
11640 For address lists, the matching starts off caselessly, but the &`+caseful`&
11641 item can be used, as in all address lists, to cause subsequent items to
11642 have their local parts matched casefully. Domains are always matched
11643 caselessly.
11644
11645 Note that <&'string2'&> is not itself subject to string expansion, unless
11646 Exim was built with the EXPAND_LISTMATCH_RHS option.
11647
11648 &*Note*&: Host lists are &'not'& supported in this way. This is because
11649 hosts have two identities: a name and an IP address, and it is not clear
11650 how to specify cleanly how such a test would work. However, IP addresses can be
11651 matched using &%match_ip%&.
11652
11653 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11654 .cindex "PAM authentication"
11655 .cindex "AUTH" "with PAM"
11656 .cindex "Solaris" "PAM support"
11657 .cindex "expansion" "PAM authentication test"
11658 .cindex "&%pam%& expansion condition"
11659 &'Pluggable Authentication Modules'&
11660 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11661 available in the latest releases of Solaris and in some GNU/Linux
11662 distributions. The Exim support, which is intended for use in conjunction with
11663 the SMTP AUTH command, is available only if Exim is compiled with
11664 .code
11665 SUPPORT_PAM=yes
11666 .endd
11667 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11668 in some releases of GNU/Linux &%-ldl%& is also needed.
11669
11670 The argument string is first expanded, and the result must be a
11671 colon-separated list of strings. Leading and trailing white space is ignored.
11672 The PAM module is initialized with the service name &"exim"& and the user name
11673 taken from the first item in the colon-separated data string (<&'string1'&>).
11674 The remaining items in the data string are passed over in response to requests
11675 from the authentication function. In the simple case there will only be one
11676 request, for a password, so the data consists of just two strings.
11677
11678 There can be problems if any of the strings are permitted to contain colon
11679 characters. In the usual way, these have to be doubled to avoid being taken as
11680 separators. If the data is being inserted from a variable, the &%sg%& expansion
11681 item can be used to double any existing colons. For example, the configuration
11682 of a LOGIN authenticator might contain this setting:
11683 .code
11684 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11685 .endd
11686 For a PLAIN authenticator you could use:
11687 .code
11688 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11689 .endd
11690 In some operating systems, PAM authentication can be done only from a process
11691 running as root. Since Exim is running as the Exim user when receiving
11692 messages, this means that PAM cannot be used directly in those systems.
11693 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11694
11695
11696 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11697 .cindex "&'pwcheck'& daemon"
11698 .cindex "Cyrus"
11699 .cindex "expansion" "&'pwcheck'& authentication test"
11700 .cindex "&%pwcheck%& expansion condition"
11701 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11702 This is one way of making it possible for passwords to be checked by a process
11703 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11704 deprecated. Its replacement is &'saslauthd'& (see below).
11705
11706 The pwcheck support is not included in Exim by default. You need to specify
11707 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11708 building Exim. For example:
11709 .code
11710 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11711 .endd
11712 You do not need to install the full Cyrus software suite in order to use
11713 the pwcheck daemon. You can compile and install just the daemon alone
11714 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11715 access to the &_/var/pwcheck_& directory.
11716
11717 The &%pwcheck%& condition takes one argument, which must be the user name and
11718 password, separated by a colon. For example, in a LOGIN authenticator
11719 configuration, you might have this:
11720 .code
11721 server_condition = ${if pwcheck{$auth1:$auth2}}
11722 .endd
11723 Again, for a PLAIN authenticator configuration, this would be:
11724 .code
11725 server_condition = ${if pwcheck{$auth2:$auth3}}
11726 .endd
11727 .vitem &*queue_running*&
11728 .cindex "queue runner" "detecting when delivering from"
11729 .cindex "expansion" "queue runner test"
11730 .cindex "&%queue_running%& expansion condition"
11731 This condition, which has no data, is true during delivery attempts that are
11732 initiated by queue runner processes, and false otherwise.
11733
11734
11735 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11736 .cindex "Radius"
11737 .cindex "expansion" "Radius authentication"
11738 .cindex "&%radius%& expansion condition"
11739 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11740 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11741 the Radius client configuration file in order to build Exim with Radius
11742 support.
11743
11744 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11745 library, using the original API. If you are using release 0.4.0 or later of
11746 this library, you need to set
11747 .code
11748 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11749 .endd
11750 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11751 &%libradius%& library that comes with FreeBSD. To do this, set
11752 .code
11753 RADIUS_LIB_TYPE=RADLIB
11754 .endd
11755 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11756 You may also have to supply a suitable setting in EXTRALIBS so that the
11757 Radius library can be found when Exim is linked.
11758
11759 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11760 Radius client library, which calls the Radius server. The condition is true if
11761 the authentication is successful. For example:
11762 .code
11763 server_condition = ${if radius{<arguments>}}
11764 .endd
11765
11766
11767 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11768         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11769 .cindex "&'saslauthd'& daemon"
11770 .cindex "Cyrus"
11771 .cindex "expansion" "&'saslauthd'& authentication test"
11772 .cindex "&%saslauthd%& expansion condition"
11773 This condition supports user authentication using the Cyrus &'saslauthd'&
11774 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11775 Using this daemon is one way of making it possible for passwords to be checked
11776 by a process that is not running as root.
11777
11778 The saslauthd support is not included in Exim by default. You need to specify
11779 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11780 building Exim. For example:
11781 .code
11782 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11783 .endd
11784 You do not need to install the full Cyrus software suite in order to use
11785 the saslauthd daemon. You can compile and install just the daemon alone
11786 from the Cyrus SASL library.
11787
11788 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11789 two are mandatory. For example:
11790 .code
11791 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11792 .endd
11793 The service and the realm are optional (which is why the arguments are enclosed
11794 in their own set of braces). For details of the meaning of the service and
11795 realm, and how to run the daemon, consult the Cyrus documentation.
11796 .endlist vlist
11797
11798
11799
11800 .section "Combining expansion conditions" "SECID84"
11801 .cindex "expansion" "combining conditions"
11802 Several conditions can be tested at once by combining them using the &%and%&
11803 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11804 conditions on their own, and precede their lists of sub-conditions. Each
11805 sub-condition must be enclosed in braces within the overall braces that contain
11806 the list. No repetition of &%if%& is used.
11807
11808
11809 .vlist
11810 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11811 .cindex "&""or""& expansion condition"
11812 .cindex "expansion" "&""or""& of conditions"
11813 The sub-conditions are evaluated from left to right. The condition is true if
11814 any one of the sub-conditions is true.
11815 For example,
11816 .code
11817 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11818 .endd
11819 When a true sub-condition is found, the following ones are parsed but not
11820 evaluated. If there are several &"match"& sub-conditions the values of the
11821 numeric variables afterwards are taken from the first one that succeeds.
11822
11823 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11824 .cindex "&""and""& expansion condition"
11825 .cindex "expansion" "&""and""& of conditions"
11826 The sub-conditions are evaluated from left to right. The condition is true if
11827 all of the sub-conditions are true. If there are several &"match"&
11828 sub-conditions, the values of the numeric variables afterwards are taken from
11829 the last one. When a false sub-condition is found, the following ones are
11830 parsed but not evaluated.
11831 .endlist
11832 .ecindex IIDexpcond
11833
11834
11835
11836
11837 .section "Expansion variables" "SECTexpvar"
11838 .cindex "expansion" "variables, list of"
11839 This section contains an alphabetical list of all the expansion variables. Some
11840 of them are available only when Exim is compiled with specific options such as
11841 support for TLS or the content scanning extension.
11842
11843 .vlist
11844 .vitem "&$0$&, &$1$&, etc"
11845 .cindex "numerical variables (&$1$& &$2$& etc)"
11846 When a &%match%& expansion condition succeeds, these variables contain the
11847 captured substrings identified by the regular expression during subsequent
11848 processing of the success string of the containing &%if%& expansion item.
11849 In the expansion condition case
11850 they do not retain their values afterwards; in fact, their previous
11851 values are restored at the end of processing an &%if%& item. The numerical
11852 variables may also be set externally by some other matching process which
11853 precedes the expansion of the string. For example, the commands available in
11854 Exim filter files include an &%if%& command with its own regular expression
11855 matching condition.
11856
11857 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11858 Within an acl condition, expansion condition or expansion item
11859 any arguments are copied to these variables,
11860 any unused variables being made empty.
11861
11862 .vitem "&$acl_c...$&"
11863 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11864 can be given any name that starts with &$acl_c$& and is at least six characters
11865 long, but the sixth character must be either a digit or an underscore. For
11866 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11867 variables persist throughout the lifetime of an SMTP connection. They can be
11868 used to pass information between ACLs and between different invocations of the
11869 same ACL. When a message is received, the values of these variables are saved
11870 with the message, and can be accessed by filters, routers, and transports
11871 during subsequent delivery.
11872
11873 .vitem "&$acl_m...$&"
11874 These variables are like the &$acl_c...$& variables, except that their values
11875 are reset after a message has been received. Thus, if several messages are
11876 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11877 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11878 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11879 message is received, the values of these variables are saved with the message,
11880 and can be accessed by filters, routers, and transports during subsequent
11881 delivery.
11882
11883 .vitem &$acl_narg$&
11884 Within an acl condition, expansion condition or expansion item
11885 this variable has the number of arguments.
11886
11887 .vitem &$acl_verify_message$&
11888 .vindex "&$acl_verify_message$&"
11889 After an address verification has failed, this variable contains the failure
11890 message. It retains its value for use in subsequent modifiers. The message can
11891 be preserved by coding like this:
11892 .code
11893 warn !verify = sender
11894      set acl_m0 = $acl_verify_message
11895 .endd
11896 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11897 &%log_message%& modifiers, to include information about the verification
11898 failure.
11899
11900 .vitem &$address_data$&
11901 .vindex "&$address_data$&"
11902 This variable is set by means of the &%address_data%& option in routers. The
11903 value then remains with the address while it is processed by subsequent routers
11904 and eventually a transport. If the transport is handling multiple addresses,
11905 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11906 for more details. &*Note*&: The contents of &$address_data$& are visible in
11907 user filter files.
11908
11909 If &$address_data$& is set when the routers are called from an ACL to verify
11910 a recipient address, the final value is still in the variable for subsequent
11911 conditions and modifiers of the ACL statement. If routing the address caused it
11912 to be redirected to just one address, the child address is also routed as part
11913 of the verification, and in this case the final value of &$address_data$& is
11914 from the child's routing.
11915
11916 If &$address_data$& is set when the routers are called from an ACL to verify a
11917 sender address, the final value is also preserved, but this time in
11918 &$sender_address_data$&, to distinguish it from data from a recipient
11919 address.
11920
11921 In both cases (recipient and sender verification), the value does not persist
11922 after the end of the current ACL statement. If you want to preserve
11923 these values for longer, you can save them in ACL variables.
11924
11925 .vitem &$address_file$&
11926 .vindex "&$address_file$&"
11927 When, as a result of aliasing, forwarding, or filtering, a message is directed
11928 to a specific file, this variable holds the name of the file when the transport
11929 is running. At other times, the variable is empty. For example, using the
11930 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11931 .code
11932 /home/r2d2/savemail
11933 .endd
11934 then when the &(address_file)& transport is running, &$address_file$&
11935 contains the text string &`/home/r2d2/savemail`&.
11936 .cindex "Sieve filter" "value of &$address_file$&"
11937 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11938 then up to the transport configuration to generate an appropriate absolute path
11939 to the relevant file.
11940
11941 .vitem &$address_pipe$&
11942 .vindex "&$address_pipe$&"
11943 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11944 this variable holds the pipe command when the transport is running.
11945
11946 .vitem "&$auth1$& &-- &$auth3$&"
11947 .vindex "&$auth1$&, &$auth2$&, etc"
11948 These variables are used in SMTP authenticators (see chapters
11949 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11950
11951 .vitem &$authenticated_id$&
11952 .cindex "authentication" "id"
11953 .vindex "&$authenticated_id$&"
11954 When a server successfully authenticates a client it may be configured to
11955 preserve some of the authentication information in the variable
11956 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11957 user/password authenticator configuration might preserve the user name for use
11958 in the routers. Note that this is not the same information that is saved in
11959 &$sender_host_authenticated$&.
11960
11961 When a message is submitted locally (that is, not over a TCP connection)
11962 the value of &$authenticated_id$& is normally the login name of the calling
11963 process. However, a trusted user can override this by means of the &%-oMai%&
11964 command line option.
11965 This second case also sets up information used by the
11966 &$authresults$& expansion item.
11967
11968 .vitem &$authenticated_fail_id$&
11969 .cindex "authentication" "fail" "id"
11970 .vindex "&$authenticated_fail_id$&"
11971 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11972 will contain the failed authentication id. If more than one authentication
11973 id is attempted, it will contain only the last one. The variable is
11974 available for processing in the ACL's, generally the quit or notquit ACL.
11975 A message to a local recipient could still be accepted without requiring
11976 authentication, which means this variable could also be visible in all of
11977 the ACL's as well.
11978
11979
11980 .vitem &$authenticated_sender$&
11981 .cindex "sender" "authenticated"
11982 .cindex "authentication" "sender"
11983 .cindex "AUTH" "on MAIL command"
11984 .vindex "&$authenticated_sender$&"
11985 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11986 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11987 described in section &<<SECTauthparamail>>&. Unless the data is the string
11988 &"<>"&, it is set as the authenticated sender of the message, and the value is
11989 available during delivery in the &$authenticated_sender$& variable. If the
11990 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11991
11992 .vindex "&$qualify_domain$&"
11993 When a message is submitted locally (that is, not over a TCP connection), the
11994 value of &$authenticated_sender$& is an address constructed from the login
11995 name of the calling process and &$qualify_domain$&, except that a trusted user
11996 can override this by means of the &%-oMas%& command line option.
11997
11998
11999 .vitem &$authentication_failed$&
12000 .cindex "authentication" "failure"
12001 .vindex "&$authentication_failed$&"
12002 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12003 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12004 possible to distinguish between &"did not try to authenticate"&
12005 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12006 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12007 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12008 negative response to an AUTH command, including (for example) an attempt to use
12009 an undefined mechanism.
12010
12011 .vitem &$av_failed$&
12012 .cindex "content scanning" "AV scanner failure"
12013 This variable is available when Exim is compiled with the content-scanning
12014 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12015 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12016 the ACL malware condition.
12017
12018 .vitem &$body_linecount$&
12019 .cindex "message body" "line count"
12020 .cindex "body of message" "line count"
12021 .vindex "&$body_linecount$&"
12022 When a message is being received or delivered, this variable contains the
12023 number of lines in the message's body. See also &$message_linecount$&.
12024
12025 .vitem &$body_zerocount$&
12026 .cindex "message body" "binary zero count"
12027 .cindex "body of message" "binary zero count"
12028 .cindex "binary zero" "in message body"
12029 .vindex "&$body_zerocount$&"
12030 When a message is being received or delivered, this variable contains the
12031 number of binary zero bytes (ASCII NULs) in the message's body.
12032
12033 .vitem &$bounce_recipient$&
12034 .vindex "&$bounce_recipient$&"
12035 This is set to the recipient address of a bounce message while Exim is creating
12036 it. It is useful if a customized bounce message text file is in use (see
12037 chapter &<<CHAPemsgcust>>&).
12038
12039 .vitem &$bounce_return_size_limit$&
12040 .vindex "&$bounce_return_size_limit$&"
12041 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12042 up to a multiple of 1000. It is useful when a customized error message text
12043 file is in use (see chapter &<<CHAPemsgcust>>&).
12044
12045 .vitem &$caller_gid$&
12046 .cindex "gid (group id)" "caller"
12047 .vindex "&$caller_gid$&"
12048 The real group id under which the process that called Exim was running. This is
12049 not the same as the group id of the originator of a message (see
12050 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12051 incarnation normally contains the Exim gid.
12052
12053 .vitem &$caller_uid$&
12054 .cindex "uid (user id)" "caller"
12055 .vindex "&$caller_uid$&"
12056 The real user id under which the process that called Exim was running. This is
12057 not the same as the user id of the originator of a message (see
12058 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12059 incarnation normally contains the Exim uid.
12060
12061 .vitem &$callout_address$&
12062 .vindex "&$callout_address$&"
12063 After a callout for verification, spamd or malware daemon service, the
12064 address that was connected to.
12065
12066 .vitem &$compile_number$&
12067 .vindex "&$compile_number$&"
12068 The building process for Exim keeps a count of the number
12069 of times it has been compiled. This serves to distinguish different
12070 compilations of the same version of Exim.
12071
12072 .vitem &$config_dir$&
12073 .vindex "&$config_dir$&"
12074 The directory name of the main configuration file. That is, the content of
12075 &$config_file$& with the last component stripped. The value does not
12076 contain the trailing slash. If &$config_file$& does not contain a slash,
12077 &$config_dir$& is ".".
12078
12079 .vitem &$config_file$&
12080 .vindex "&$config_file$&"
12081 The name of the main configuration file Exim is using.
12082
12083 .new
12084 .vitem &$dmarc_domain_policy$& &&&
12085        &$dmarc_status$& &&&
12086        &$dmarc_status_text$& &&&
12087        &$dmarc_used_domains$&
12088 Results of DMARC verification.
12089 For details see section &<<SECDMARC>>&.
12090 .wen
12091
12092 .vitem &$dkim_verify_status$&
12093 Results of DKIM verification.
12094 For details see section &<<SECDKIMVFY>>&.
12095
12096 .vitem &$dkim_cur_signer$& &&&
12097        &$dkim_verify_reason$& &&&
12098        &$dkim_domain$& &&&
12099        &$dkim_identity$& &&&
12100        &$dkim_selector$& &&&
12101        &$dkim_algo$& &&&
12102        &$dkim_canon_body$& &&&
12103        &$dkim_canon_headers$& &&&
12104        &$dkim_copiedheaders$& &&&
12105        &$dkim_bodylength$& &&&
12106        &$dkim_created$& &&&
12107        &$dkim_expires$& &&&
12108        &$dkim_headernames$& &&&
12109        &$dkim_key_testing$& &&&
12110        &$dkim_key_nosubdomains$& &&&
12111        &$dkim_key_srvtype$& &&&
12112        &$dkim_key_granularity$& &&&
12113        &$dkim_key_notes$& &&&
12114        &$dkim_key_length$&
12115 These variables are only available within the DKIM ACL.
12116 For details see section &<<SECDKIMVFY>>&.
12117
12118 .vitem &$dkim_signers$&
12119 .vindex &$dkim_signers$&
12120 When a message has been received this variable contains
12121 a colon-separated list of signer domains and identities for the message.
12122 For details see section &<<SECDKIMVFY>>&.
12123
12124 .vitem &$dnslist_domain$& &&&
12125        &$dnslist_matched$& &&&
12126        &$dnslist_text$& &&&
12127        &$dnslist_value$&
12128 .vindex "&$dnslist_domain$&"
12129 .vindex "&$dnslist_matched$&"
12130 .vindex "&$dnslist_text$&"
12131 .vindex "&$dnslist_value$&"
12132 .cindex "black list (DNS)"
12133 When a DNS (black) list lookup succeeds, these variables are set to contain
12134 the following data from the lookup: the list's domain name, the key that was
12135 looked up, the contents of any associated TXT record, and the value from the
12136 main A record. See section &<<SECID204>>& for more details.
12137
12138 .vitem &$domain$&
12139 .vindex "&$domain$&"
12140 When an address is being routed, or delivered on its own, this variable
12141 contains the domain. Uppercase letters in the domain are converted into lower
12142 case for &$domain$&.
12143
12144 Global address rewriting happens when a message is received, so the value of
12145 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12146 is set during user filtering, but not during system filtering, because a
12147 message may have many recipients and the system filter is called just once.
12148
12149 When more than one address is being delivered at once (for example, several
12150 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12151 have the same domain. Transports can be restricted to handling only one domain
12152 at a time if the value of &$domain$& is required at transport time &-- this is
12153 the default for local transports. For further details of the environment in
12154 which local transports are run, see chapter &<<CHAPenvironment>>&.
12155
12156 .oindex "&%delay_warning_condition%&"
12157 At the end of a delivery, if all deferred addresses have the same domain, it is
12158 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12159
12160 The &$domain$& variable is also used in some other circumstances:
12161
12162 .ilist
12163 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12164 the recipient address. The domain of the &'sender'& address is in
12165 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12166 normally set during the running of the MAIL ACL. However, if the sender address
12167 is verified with a callout during the MAIL ACL, the sender domain is placed in
12168 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12169 the &(smtp)& transport.
12170
12171 .next
12172 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12173 &$domain$& contains the domain portion of the address that is being rewritten;
12174 it can be used in the expansion of the replacement address, for example, to
12175 rewrite domains by file lookup.
12176
12177 .next
12178 With one important exception, whenever a domain list is being scanned,
12179 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12180 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12181 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12182 that, in a RCPT ACL, the sender domain list can be dependent on the
12183 recipient domain (which is what is in &$domain$& at this time).
12184
12185 .next
12186 .cindex "ETRN" "value of &$domain$&"
12187 .oindex "&%smtp_etrn_command%&"
12188 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12189 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12190 .endlist
12191
12192
12193 .vitem &$domain_data$&
12194 .vindex "&$domain_data$&"
12195 When the &%domains%& option on a router matches a domain by
12196 means of a lookup, the data read by the lookup is available during the running
12197 of the router as &$domain_data$&. In addition, if the driver routes the
12198 address to a transport, the value is available in that transport. If the
12199 transport is handling multiple addresses, the value from the first address is
12200 used.
12201
12202 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12203 domain by means of a lookup. The data read by the lookup is available during
12204 the rest of the ACL statement. In all other situations, this variable expands
12205 to nothing.
12206
12207 .vitem &$exim_gid$&
12208 .vindex "&$exim_gid$&"
12209 This variable contains the numerical value of the Exim group id.
12210
12211 .vitem &$exim_path$&
12212 .vindex "&$exim_path$&"
12213 This variable contains the path to the Exim binary.
12214
12215 .vitem &$exim_uid$&
12216 .vindex "&$exim_uid$&"
12217 This variable contains the numerical value of the Exim user id.
12218
12219 .vitem &$exim_version$&
12220 .vindex "&$exim_version$&"
12221 This variable contains the version string of the Exim build.
12222 The first character is a major version number, currently 4.
12223 Then after a dot, the next group of digits is a minor version number.
12224 There may be other characters following the minor version.
12225 This value may be overridden by the &%exim_version%& main config option.
12226
12227 .vitem &$header_$&<&'name'&>
12228 This is not strictly an expansion variable. It is expansion syntax for
12229 inserting the message header line with the given name. Note that the name must
12230 be terminated by colon or white space, because it may contain a wide variety of
12231 characters. Note also that braces must &'not'& be used.
12232 See the full description in section &<<SECTexpansionitems>>& above.
12233
12234 .vitem &$headers_added$&
12235 .vindex "&$headers_added$&"
12236 Within an ACL this variable contains the headers added so far by
12237 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12238 The headers are a newline-separated list.
12239
12240 .vitem &$home$&
12241 .vindex "&$home$&"
12242 When the &%check_local_user%& option is set for a router, the user's home
12243 directory is placed in &$home$& when the check succeeds. In particular, this
12244 means it is set during the running of users' filter files. A router may also
12245 explicitly set a home directory for use by a transport; this can be overridden
12246 by a setting on the transport itself.
12247
12248 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12249 of the environment variable HOME, which is subject to the
12250 &%keep_environment%& and &%add_environment%& main config options.
12251
12252 .vitem &$host$&
12253 .vindex "&$host$&"
12254 If a router assigns an address to a transport (any transport), and passes a
12255 list of hosts with the address, the value of &$host$& when the transport starts
12256 to run is the name of the first host on the list. Note that this applies both
12257 to local and remote transports.
12258
12259 .cindex "transport" "filter"
12260 .cindex "filter" "transport filter"
12261 For the &(smtp)& transport, if there is more than one host, the value of
12262 &$host$& changes as the transport works its way through the list. In
12263 particular, when the &(smtp)& transport is expanding its options for encryption
12264 using TLS, or for specifying a transport filter (see chapter
12265 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12266 is connected.
12267
12268 When used in the client part of an authenticator configuration (see chapter
12269 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12270 client is connected.
12271
12272
12273 .vitem &$host_address$&
12274 .vindex "&$host_address$&"
12275 This variable is set to the remote host's IP address whenever &$host$& is set
12276 for a remote connection. It is also set to the IP address that is being checked
12277 when the &%ignore_target_hosts%& option is being processed.
12278
12279 .vitem &$host_data$&
12280 .vindex "&$host_data$&"
12281 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12282 result of the lookup is made available in the &$host_data$& variable. This
12283 allows you, for example, to do things like this:
12284 .code
12285 deny  hosts = net-lsearch;/some/file
12286 message = $host_data
12287 .endd
12288 .vitem &$host_lookup_deferred$&
12289 .cindex "host name" "lookup, failure of"
12290 .vindex "&$host_lookup_deferred$&"
12291 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12292 message comes from a remote host and there is an attempt to look up the host's
12293 name from its IP address, and the attempt is not successful, one of these
12294 variables is set to &"1"&.
12295
12296 .ilist
12297 If the lookup receives a definite negative response (for example, a DNS lookup
12298 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12299
12300 .next
12301 If there is any kind of problem during the lookup, such that Exim cannot
12302 tell whether or not the host name is defined (for example, a timeout for a DNS
12303 lookup), &$host_lookup_deferred$& is set to &"1"&.
12304 .endlist ilist
12305
12306 Looking up a host's name from its IP address consists of more than just a
12307 single reverse lookup. Exim checks that a forward lookup of at least one of the
12308 names it receives from a reverse lookup yields the original IP address. If this
12309 is not the case, Exim does not accept the looked up name(s), and
12310 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12311 IP address (for example, the existence of a PTR record in the DNS) is not
12312 sufficient on its own for the success of a host name lookup. If the reverse
12313 lookup succeeds, but there is a lookup problem such as a timeout when checking
12314 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12315 &"1"&. See also &$sender_host_name$&.
12316
12317 .cindex authentication "expansion item"
12318 Performing these checks sets up information used by the
12319 &%authresults%& expansion item.
12320
12321
12322 .vitem &$host_lookup_failed$&
12323 .vindex "&$host_lookup_failed$&"
12324 See &$host_lookup_deferred$&.
12325
12326 .vitem &$host_port$&
12327 .vindex "&$host_port$&"
12328 This variable is set to the remote host's TCP port whenever &$host$& is set
12329 for an outbound connection.
12330
12331 .vitem &$initial_cwd$&
12332 .vindex "&$initial_cwd$&
12333 This variable contains the full path name of the initial working
12334 directory of the current Exim process. This may differ from the current
12335 working directory, as Exim changes this to "/" during early startup, and
12336 to &$spool_directory$& later.
12337
12338 .vitem &$inode$&
12339 .vindex "&$inode$&"
12340 The only time this variable is set is while expanding the &%directory_file%&
12341 option in the &(appendfile)& transport. The variable contains the inode number
12342 of the temporary file which is about to be renamed. It can be used to construct
12343 a unique name for the file.
12344
12345 .vitem &$interface_address$&
12346 .vindex "&$interface_address$&"
12347 This is an obsolete name for &$received_ip_address$&.
12348
12349 .vitem &$interface_port$&
12350 .vindex "&$interface_port$&"
12351 This is an obsolete name for &$received_port$&.
12352
12353 .vitem &$item$&
12354 .vindex "&$item$&"
12355 This variable is used during the expansion of &*forall*& and &*forany*&
12356 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12357 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12358 empty.
12359
12360 .vitem &$ldap_dn$&
12361 .vindex "&$ldap_dn$&"
12362 This variable, which is available only when Exim is compiled with LDAP support,
12363 contains the DN from the last entry in the most recently successful LDAP
12364 lookup.
12365
12366 .vitem &$load_average$&
12367 .vindex "&$load_average$&"
12368 This variable contains the system load average, multiplied by 1000 so that it
12369 is an integer. For example, if the load average is 0.21, the value of the
12370 variable is 210. The value is recomputed every time the variable is referenced.
12371
12372 .vitem &$local_part$&
12373 .vindex "&$local_part$&"
12374 When an address is being routed, or delivered on its own, this
12375 variable contains the local part. When a number of addresses are being
12376 delivered together (for example, multiple RCPT commands in an SMTP
12377 session), &$local_part$& is not set.
12378
12379 Global address rewriting happens when a message is received, so the value of
12380 &$local_part$& during routing and delivery is the value after rewriting.
12381 &$local_part$& is set during user filtering, but not during system filtering,
12382 because a message may have many recipients and the system filter is called just
12383 once.
12384
12385 .vindex "&$local_part_prefix$&"
12386 .vindex "&$local_part_suffix$&"
12387 .cindex affix variables
12388 If a local part prefix or suffix has been recognized, it is not included in the
12389 value of &$local_part$& during routing and subsequent delivery. The values of
12390 any prefix or suffix are in &$local_part_prefix$& and
12391 &$local_part_suffix$&, respectively.
12392
12393 When a message is being delivered to a file, pipe, or autoreply transport as a
12394 result of aliasing or forwarding, &$local_part$& is set to the local part of
12395 the parent address, not to the filename or command (see &$address_file$& and
12396 &$address_pipe$&).
12397
12398 When an ACL is running for a RCPT command, &$local_part$& contains the
12399 local part of the recipient address.
12400
12401 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12402 &$local_part$& contains the local part of the address that is being rewritten;
12403 it can be used in the expansion of the replacement address, for example.
12404
12405 In all cases, all quoting is removed from the local part. For example, for both
12406 the addresses
12407 .code
12408 "abc:xyz"@test.example
12409 abc\:xyz@test.example
12410 .endd
12411 the value of &$local_part$& is
12412 .code
12413 abc:xyz
12414 .endd
12415 If you use &$local_part$& to create another address, you should always wrap it
12416 inside a quoting operator. For example, in a &(redirect)& router you could
12417 have:
12418 .code
12419 data = ${quote_local_part:$local_part}@new.domain.example
12420 .endd
12421 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12422 to process local parts in a case-dependent manner in a router, you can set the
12423 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12424
12425 .vitem &$local_part_data$&
12426 .vindex "&$local_part_data$&"
12427 When the &%local_parts%& option on a router matches a local part by means of a
12428 lookup, the data read by the lookup is available during the running of the
12429 router as &$local_part_data$&. In addition, if the driver routes the address
12430 to a transport, the value is available in that transport. If the transport is
12431 handling multiple addresses, the value from the first address is used.
12432
12433 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12434 matches a local part by means of a lookup. The data read by the lookup is
12435 available during the rest of the ACL statement. In all other situations, this
12436 variable expands to nothing.
12437
12438 .vitem &$local_part_prefix$&
12439 .vindex "&$local_part_prefix$&"
12440 .cindex affix variables
12441 When an address is being routed or delivered, and a
12442 specific prefix for the local part was recognized, it is available in this
12443 variable, having been removed from &$local_part$&.
12444
12445 .vitem &$local_part_suffix$&
12446 .vindex "&$local_part_suffix$&"
12447 When an address is being routed or delivered, and a
12448 specific suffix for the local part was recognized, it is available in this
12449 variable, having been removed from &$local_part$&.
12450
12451 .vitem &$local_scan_data$&
12452 .vindex "&$local_scan_data$&"
12453 This variable contains the text returned by the &[local_scan()]& function when
12454 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12455
12456 .vitem &$local_user_gid$&
12457 .vindex "&$local_user_gid$&"
12458 See &$local_user_uid$&.
12459
12460 .vitem &$local_user_uid$&
12461 .vindex "&$local_user_uid$&"
12462 This variable and &$local_user_gid$& are set to the uid and gid after the
12463 &%check_local_user%& router precondition succeeds. This means that their values
12464 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12465 and &%condition%&), for the &%address_data%& expansion, and for any
12466 router-specific expansions. At all other times, the values in these variables
12467 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12468
12469 .vitem &$localhost_number$&
12470 .vindex "&$localhost_number$&"
12471 This contains the expanded value of the
12472 &%localhost_number%& option. The expansion happens after the main options have
12473 been read.
12474
12475 .vitem &$log_inodes$&
12476 .vindex "&$log_inodes$&"
12477 The number of free inodes in the disk partition where Exim's
12478 log files are being written. The value is recalculated whenever the variable is
12479 referenced. If the relevant file system does not have the concept of inodes,
12480 the value of is -1. See also the &%check_log_inodes%& option.
12481
12482 .vitem &$log_space$&
12483 .vindex "&$log_space$&"
12484 The amount of free space (as a number of kilobytes) in the disk
12485 partition where Exim's log files are being written. The value is recalculated
12486 whenever the variable is referenced. If the operating system does not have the
12487 ability to find the amount of free space (only true for experimental systems),
12488 the space value is -1. See also the &%check_log_space%& option.
12489
12490
12491 .vitem &$lookup_dnssec_authenticated$&
12492 .vindex "&$lookup_dnssec_authenticated$&"
12493 This variable is set after a DNS lookup done by
12494 a dnsdb lookup expansion, dnslookup router or smtp transport.
12495 .cindex "DNS" "DNSSEC"
12496 It will be empty if &(DNSSEC)& was not requested,
12497 &"no"& if the result was not labelled as authenticated data
12498 and &"yes"& if it was.
12499 Results that are labelled as authoritative answer that match
12500 the &%dns_trust_aa%& configuration variable count also
12501 as authenticated data.
12502
12503 .vitem &$mailstore_basename$&
12504 .vindex "&$mailstore_basename$&"
12505 This variable is set only when doing deliveries in &"mailstore"& format in the
12506 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12507 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12508 contains the basename of the files that are being written, that is, the name
12509 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12510 variable is empty.
12511
12512 .vitem &$malware_name$&
12513 .vindex "&$malware_name$&"
12514 This variable is available when Exim is compiled with the
12515 content-scanning extension. It is set to the name of the virus that was found
12516 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12517
12518 .vitem &$max_received_linelength$&
12519 .vindex "&$max_received_linelength$&"
12520 .cindex "maximum" "line length"
12521 .cindex "line length" "maximum"
12522 This variable contains the number of bytes in the longest line that was
12523 received as part of the message, not counting the line termination
12524 character(s).
12525 It is not valid if the &%spool_files_wireformat%& option is used.
12526
12527 .vitem &$message_age$&
12528 .cindex "message" "age of"
12529 .vindex "&$message_age$&"
12530 This variable is set at the start of a delivery attempt to contain the number
12531 of seconds since the message was received. It does not change during a single
12532 delivery attempt.
12533
12534 .vitem &$message_body$&
12535 .cindex "body of message" "expansion variable"
12536 .cindex "message body" "in expansion"
12537 .cindex "binary zero" "in message body"
12538 .vindex "&$message_body$&"
12539 .oindex "&%message_body_visible%&"
12540 This variable contains the initial portion of a message's body while it is
12541 being delivered, and is intended mainly for use in filter files. The maximum
12542 number of characters of the body that are put into the variable is set by the
12543 &%message_body_visible%& configuration option; the default is 500.
12544
12545 .oindex "&%message_body_newlines%&"
12546 By default, newlines are converted into spaces in &$message_body$&, to make it
12547 easier to search for phrases that might be split over a line break. However,
12548 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12549 zeros are always converted into spaces.
12550
12551 .vitem &$message_body_end$&
12552 .cindex "body of message" "expansion variable"
12553 .cindex "message body" "in expansion"
12554 .vindex "&$message_body_end$&"
12555 This variable contains the final portion of a message's
12556 body while it is being delivered. The format and maximum size are as for
12557 &$message_body$&.
12558
12559 .vitem &$message_body_size$&
12560 .cindex "body of message" "size"
12561 .cindex "message body" "size"
12562 .vindex "&$message_body_size$&"
12563 When a message is being delivered, this variable contains the size of the body
12564 in bytes. The count starts from the character after the blank line that
12565 separates the body from the header. Newlines are included in the count. See
12566 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12567
12568 If the spool file is wireformat
12569 (see the &%spool_files_wireformat%& main option)
12570 the CRLF line-terminators are included in the count.
12571
12572 .vitem &$message_exim_id$&
12573 .vindex "&$message_exim_id$&"
12574 When a message is being received or delivered, this variable contains the
12575 unique message id that is generated and used by Exim to identify the message.
12576 An id is not created for a message until after its header has been successfully
12577 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12578 line; it is the local id that Exim assigns to the message, for example:
12579 &`1BXTIK-0001yO-VA`&.
12580
12581 .vitem &$message_headers$&
12582 .vindex &$message_headers$&
12583 This variable contains a concatenation of all the header lines when a message
12584 is being processed, except for lines added by routers or transports. The header
12585 lines are separated by newline characters. Their contents are decoded in the
12586 same way as a header line that is inserted by &%bheader%&.
12587
12588 .vitem &$message_headers_raw$&
12589 .vindex &$message_headers_raw$&
12590 This variable is like &$message_headers$& except that no processing of the
12591 contents of header lines is done.
12592
12593 .vitem &$message_id$&
12594 This is an old name for &$message_exim_id$&. It is now deprecated.
12595
12596 .vitem &$message_linecount$&
12597 .vindex "&$message_linecount$&"
12598 This variable contains the total number of lines in the header and body of the
12599 message. Compare &$body_linecount$&, which is the count for the body only.
12600 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12601 number of lines received. Before delivery happens (that is, before filters,
12602 routers, and transports run) the count is increased to include the
12603 &'Received:'& header line that Exim standardly adds, and also any other header
12604 lines that are added by ACLs. The blank line that separates the message header
12605 from the body is not counted.
12606
12607 As with the special case of &$message_size$&, during the expansion of the
12608 appendfile transport's maildir_tag option in maildir format, the value of
12609 &$message_linecount$& is the precise size of the number of newlines in the
12610 file that has been written (minus one for the blank line between the
12611 header and the body).
12612
12613 Here is an example of the use of this variable in a DATA ACL:
12614 .code
12615 deny message   = Too many lines in message header
12616      condition = \
12617       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12618 .endd
12619 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12620 message has not yet been received.
12621
12622 This variable is not valid if the &%spool_files_wireformat%& option is used.
12623
12624 .vitem &$message_size$&
12625 .cindex "size" "of message"
12626 .cindex "message" "size"
12627 .vindex "&$message_size$&"
12628 When a message is being processed, this variable contains its size in bytes. In
12629 most cases, the size includes those headers that were received with the
12630 message, but not those (such as &'Envelope-to:'&) that are added to individual
12631 deliveries as they are written. However, there is one special case: during the
12632 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12633 doing a delivery in maildir format, the value of &$message_size$& is the
12634 precise size of the file that has been written. See also
12635 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12636
12637 .cindex "RCPT" "value of &$message_size$&"
12638 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12639 contains the size supplied on the MAIL command, or -1 if no size was given. The
12640 value may not, of course, be truthful.
12641
12642 .vitem &$mime_$&&'xxx'&
12643 A number of variables whose names start with &$mime$& are
12644 available when Exim is compiled with the content-scanning extension. For
12645 details, see section &<<SECTscanmimepart>>&.
12646
12647 .vitem "&$n0$& &-- &$n9$&"
12648 These variables are counters that can be incremented by means
12649 of the &%add%& command in filter files.
12650
12651 .vitem &$original_domain$&
12652 .vindex "&$domain$&"
12653 .vindex "&$original_domain$&"
12654 When a top-level address is being processed for delivery, this contains the
12655 same value as &$domain$&. However, if a &"child"& address (for example,
12656 generated by an alias, forward, or filter file) is being processed, this
12657 variable contains the domain of the original address (lower cased). This
12658 differs from &$parent_domain$& only when there is more than one level of
12659 aliasing or forwarding. When more than one address is being delivered in a
12660 single transport run, &$original_domain$& is not set.
12661
12662 If a new address is created by means of a &%deliver%& command in a system
12663 filter, it is set up with an artificial &"parent"& address. This has the local
12664 part &'system-filter'& and the default qualify domain.
12665
12666 .vitem &$original_local_part$&
12667 .vindex "&$local_part$&"
12668 .vindex "&$original_local_part$&"
12669 When a top-level address is being processed for delivery, this contains the
12670 same value as &$local_part$&, unless a prefix or suffix was removed from the
12671 local part, because &$original_local_part$& always contains the full local
12672 part. When a &"child"& address (for example, generated by an alias, forward, or
12673 filter file) is being processed, this variable contains the full local part of
12674 the original address.
12675
12676 If the router that did the redirection processed the local part
12677 case-insensitively, the value in &$original_local_part$& is in lower case.
12678 This variable differs from &$parent_local_part$& only when there is more than
12679 one level of aliasing or forwarding. When more than one address is being
12680 delivered in a single transport run, &$original_local_part$& is not set.
12681
12682 If a new address is created by means of a &%deliver%& command in a system
12683 filter, it is set up with an artificial &"parent"& address. This has the local
12684 part &'system-filter'& and the default qualify domain.
12685
12686 .vitem &$originator_gid$&
12687 .cindex "gid (group id)" "of originating user"
12688 .cindex "sender" "gid"
12689 .vindex "&$caller_gid$&"
12690 .vindex "&$originator_gid$&"
12691 This variable contains the value of &$caller_gid$& that was set when the
12692 message was received. For messages received via the command line, this is the
12693 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12694 normally the gid of the Exim user.
12695
12696 .vitem &$originator_uid$&
12697 .cindex "uid (user id)" "of originating user"
12698 .cindex "sender" "uid"
12699 .vindex "&$caller_uid$&"
12700 .vindex "&$originator_uid$&"
12701 The value of &$caller_uid$& that was set when the message was received. For
12702 messages received via the command line, this is the uid of the sending user.
12703 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12704 user.
12705
12706 .vitem &$parent_domain$&
12707 .vindex "&$parent_domain$&"
12708 This variable is similar to &$original_domain$& (see
12709 above), except that it refers to the immediately preceding parent address.
12710
12711 .vitem &$parent_local_part$&
12712 .vindex "&$parent_local_part$&"
12713 This variable is similar to &$original_local_part$&
12714 (see above), except that it refers to the immediately preceding parent address.
12715
12716 .vitem &$pid$&
12717 .cindex "pid (process id)" "of current process"
12718 .vindex "&$pid$&"
12719 This variable contains the current process id.
12720
12721 .vitem &$pipe_addresses$&
12722 .cindex "filter" "transport filter"
12723 .cindex "transport" "filter"
12724 .vindex "&$pipe_addresses$&"
12725 This is not an expansion variable, but is mentioned here because the string
12726 &`$pipe_addresses`& is handled specially in the command specification for the
12727 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12728 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12729 It cannot be used in general expansion strings, and provokes an &"unknown
12730 variable"& error if encountered.
12731
12732 .vitem &$primary_hostname$&
12733 .vindex "&$primary_hostname$&"
12734 This variable contains the value set by &%primary_hostname%& in the
12735 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12736 a single-component name, Exim calls &[gethostbyname()]& (or
12737 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12738 qualified host name. See also &$smtp_active_hostname$&.
12739
12740
12741 .vitem &$proxy_external_address$& &&&
12742        &$proxy_external_port$& &&&
12743        &$proxy_local_address$& &&&
12744        &$proxy_local_port$& &&&
12745        &$proxy_session$&
12746 These variables are only available when built with Proxy Protocol
12747 or SOCKS5 support.
12748 For details see chapter &<<SECTproxyInbound>>&.
12749
12750 .vitem &$prdr_requested$&
12751 .cindex "PRDR" "variable for"
12752 This variable is set to &"yes"& if PRDR was requested by the client for the
12753 current message, otherwise &"no"&.
12754
12755 .vitem &$prvscheck_address$&
12756 This variable is used in conjunction with the &%prvscheck%& expansion item,
12757 which is described in sections &<<SECTexpansionitems>>& and
12758 &<<SECTverifyPRVS>>&.
12759
12760 .vitem &$prvscheck_keynum$&
12761 This variable is used in conjunction with the &%prvscheck%& expansion item,
12762 which is described in sections &<<SECTexpansionitems>>& and
12763 &<<SECTverifyPRVS>>&.
12764
12765 .vitem &$prvscheck_result$&
12766 This variable is used in conjunction with the &%prvscheck%& expansion item,
12767 which is described in sections &<<SECTexpansionitems>>& and
12768 &<<SECTverifyPRVS>>&.
12769
12770 .vitem &$qualify_domain$&
12771 .vindex "&$qualify_domain$&"
12772 The value set for the &%qualify_domain%& option in the configuration file.
12773
12774 .vitem &$qualify_recipient$&
12775 .vindex "&$qualify_recipient$&"
12776 The value set for the &%qualify_recipient%& option in the configuration file,
12777 or if not set, the value of &$qualify_domain$&.
12778
12779 .vitem &$queue_name$&
12780 .vindex &$queue_name$&
12781 .cindex "named queues"
12782 .cindex queues named
12783 The name of the spool queue in use; empty for the default queue.
12784
12785 .new
12786 .vitem &$r_...$&
12787 .vindex &$r_...$&
12788 .cindex router variables
12789 Values can be placed in these variables by the &%set%& option of a router.
12790 They can be given any name that starts with &$r_$&.
12791 The values persist for the address being handled through subsequent routers
12792 and the eventual transport.
12793 .wen
12794
12795 .vitem &$rcpt_count$&
12796 .vindex "&$rcpt_count$&"
12797 When a message is being received by SMTP, this variable contains the number of
12798 RCPT commands received for the current message. If this variable is used in a
12799 RCPT ACL, its value includes the current command.
12800
12801 .vitem &$rcpt_defer_count$&
12802 .vindex "&$rcpt_defer_count$&"
12803 .cindex "4&'xx'& responses" "count of"
12804 When a message is being received by SMTP, this variable contains the number of
12805 RCPT commands in the current message that have previously been rejected with a
12806 temporary (4&'xx'&) response.
12807
12808 .vitem &$rcpt_fail_count$&
12809 .vindex "&$rcpt_fail_count$&"
12810 When a message is being received by SMTP, this variable contains the number of
12811 RCPT commands in the current message that have previously been rejected with a
12812 permanent (5&'xx'&) response.
12813
12814 .vitem &$received_count$&
12815 .vindex "&$received_count$&"
12816 This variable contains the number of &'Received:'& header lines in the message,
12817 including the one added by Exim (so its value is always greater than zero). It
12818 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12819 delivering.
12820
12821 .vitem &$received_for$&
12822 .vindex "&$received_for$&"
12823 If there is only a single recipient address in an incoming message, this
12824 variable contains that address when the &'Received:'& header line is being
12825 built. The value is copied after recipient rewriting has happened, but before
12826 the &[local_scan()]& function is run.
12827
12828 .vitem &$received_ip_address$&
12829 .vindex "&$received_ip_address$&"
12830 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12831 variable is set to the address of the local IP interface, and &$received_port$&
12832 is set to the local port number. (The remote IP address and port are in
12833 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12834 the port value is -1 unless it has been set using the &%-oMi%& command line
12835 option.
12836
12837 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12838 could be used, for example, to make the filename for a TLS certificate depend
12839 on which interface and/or port is being used for the incoming connection. The
12840 values of &$received_ip_address$& and &$received_port$& are saved with any
12841 messages that are received, thus making these variables available at delivery
12842 time.
12843 For outbound connections see &$sending_ip_address$&.
12844
12845 .vitem &$received_port$&
12846 .vindex "&$received_port$&"
12847 See &$received_ip_address$&.
12848
12849 .vitem &$received_protocol$&
12850 .vindex "&$received_protocol$&"
12851 When a message is being processed, this variable contains the name of the
12852 protocol by which it was received. Most of the names used by Exim are defined
12853 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12854 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12855 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12856 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12857 connection and the client was successfully authenticated.
12858
12859 Exim uses the protocol name &"smtps"& for the case when encryption is
12860 automatically set up on connection without the use of STARTTLS (see
12861 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12862 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12863 where the client initially uses EHLO, sets up an encrypted connection using
12864 STARTTLS, and then uses HELO afterwards.
12865
12866 The &%-oMr%& option provides a way of specifying a custom protocol name for
12867 messages that are injected locally by trusted callers. This is commonly used to
12868 identify messages that are being re-injected after some kind of scanning.
12869
12870 .vitem &$received_time$&
12871 .vindex "&$received_time$&"
12872 This variable contains the date and time when the current message was received,
12873 as a number of seconds since the start of the Unix epoch.
12874
12875 .vitem &$recipient_data$&
12876 .vindex "&$recipient_data$&"
12877 This variable is set after an indexing lookup success in an ACL &%recipients%&
12878 condition. It contains the data from the lookup, and the value remains set
12879 until the next &%recipients%& test. Thus, you can do things like this:
12880 .display
12881 &`require recipients  = cdb*@;/some/file`&
12882 &`deny    `&&'some further test involving'& &`$recipient_data`&
12883 .endd
12884 &*Warning*&: This variable is set only when a lookup is used as an indexing
12885 method in the address list, using the semicolon syntax as in the example above.
12886 The variable is not set for a lookup that is used as part of the string
12887 expansion that all such lists undergo before being interpreted.
12888
12889 .vitem &$recipient_verify_failure$&
12890 .vindex "&$recipient_verify_failure$&"
12891 In an ACL, when a recipient verification fails, this variable contains
12892 information about the failure. It is set to one of the following words:
12893
12894 .ilist
12895 &"qualify"&: The address was unqualified (no domain), and the message
12896 was neither local nor came from an exempted host.
12897
12898 .next
12899 &"route"&: Routing failed.
12900
12901 .next
12902 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12903 or before the MAIL command (that is, on initial connection, HELO, or
12904 MAIL).
12905
12906 .next
12907 &"recipient"&: The RCPT command in a callout was rejected.
12908 .next
12909
12910 &"postmaster"&: The postmaster check in a callout was rejected.
12911 .endlist
12912
12913 The main use of this variable is expected to be to distinguish between
12914 rejections of MAIL and rejections of RCPT.
12915
12916 .vitem &$recipients$&
12917 .vindex "&$recipients$&"
12918 This variable contains a list of envelope recipients for a message. A comma and
12919 a space separate the addresses in the replacement text. However, the variable
12920 is not generally available, to prevent exposure of Bcc recipients in
12921 unprivileged users' filter files. You can use &$recipients$& only in these
12922 cases:
12923
12924 .olist
12925 In a system filter file.
12926 .next
12927 In the ACLs associated with the DATA command and with non-SMTP messages, that
12928 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12929 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12930 &%acl_not_smtp_mime%&.
12931 .next
12932 From within a &[local_scan()]& function.
12933 .endlist
12934
12935
12936 .vitem &$recipients_count$&
12937 .vindex "&$recipients_count$&"
12938 When a message is being processed, this variable contains the number of
12939 envelope recipients that came with the message. Duplicates are not excluded
12940 from the count. While a message is being received over SMTP, the number
12941 increases for each accepted recipient. It can be referenced in an ACL.
12942
12943
12944 .vitem &$regex_match_string$&
12945 .vindex "&$regex_match_string$&"
12946 This variable is set to contain the matching regular expression after a
12947 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12948
12949 .vitem "&$regex1$&, &$regex2$&, etc"
12950 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12951 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12952 these variables contain the
12953 captured substrings identified by the regular expression.
12954
12955
12956 .vitem &$reply_address$&
12957 .vindex "&$reply_address$&"
12958 When a message is being processed, this variable contains the contents of the
12959 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12960 contents of the &'From:'& header line. Apart from the removal of leading
12961 white space, the value is not processed in any way. In particular, no RFC 2047
12962 decoding or character code translation takes place.
12963
12964 .vitem &$return_path$&
12965 .vindex "&$return_path$&"
12966 When a message is being delivered, this variable contains the return path &--
12967 the sender field that will be sent as part of the envelope. It is not enclosed
12968 in <> characters. At the start of routing an address, &$return_path$& has the
12969 same value as &$sender_address$&, but if, for example, an incoming message to a
12970 mailing list has been expanded by a router which specifies a different address
12971 for bounce messages, &$return_path$& subsequently contains the new bounce
12972 address, whereas &$sender_address$& always contains the original sender address
12973 that was received with the message. In other words, &$sender_address$& contains
12974 the incoming envelope sender, and &$return_path$& contains the outgoing
12975 envelope sender.
12976
12977 .vitem &$return_size_limit$&
12978 .vindex "&$return_size_limit$&"
12979 This is an obsolete name for &$bounce_return_size_limit$&.
12980
12981 .vitem &$router_name$&
12982 .cindex "router" "name"
12983 .cindex "name" "of router"
12984 .vindex "&$router_name$&"
12985 During the running of a router this variable contains its name.
12986
12987 .vitem &$runrc$&
12988 .cindex "return code" "from &%run%& expansion"
12989 .vindex "&$runrc$&"
12990 This variable contains the return code from a command that is run by the
12991 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12992 assume the order in which option values are expanded, except for those
12993 preconditions whose order of testing is documented. Therefore, you cannot
12994 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12995 another.
12996
12997 .vitem &$self_hostname$&
12998 .oindex "&%self%&" "value of host name"
12999 .vindex "&$self_hostname$&"
13000 When an address is routed to a supposedly remote host that turns out to be the
13001 local host, what happens is controlled by the &%self%& generic router option.
13002 One of its values causes the address to be passed to another router. When this
13003 happens, &$self_hostname$& is set to the name of the local host that the
13004 original router encountered. In other circumstances its contents are null.
13005
13006 .vitem &$sender_address$&
13007 .vindex "&$sender_address$&"
13008 When a message is being processed, this variable contains the sender's address
13009 that was received in the message's envelope. The case of letters in the address
13010 is retained, in both the local part and the domain. For bounce messages, the
13011 value of this variable is the empty string. See also &$return_path$&.
13012
13013 .vitem &$sender_address_data$&
13014 .vindex "&$address_data$&"
13015 .vindex "&$sender_address_data$&"
13016 If &$address_data$& is set when the routers are called from an ACL to verify a
13017 sender address, the final value is preserved in &$sender_address_data$&, to
13018 distinguish it from data from a recipient address. The value does not persist
13019 after the end of the current ACL statement. If you want to preserve it for
13020 longer, you can save it in an ACL variable.
13021
13022 .vitem &$sender_address_domain$&
13023 .vindex "&$sender_address_domain$&"
13024 The domain portion of &$sender_address$&.
13025
13026 .vitem &$sender_address_local_part$&
13027 .vindex "&$sender_address_local_part$&"
13028 The local part portion of &$sender_address$&.
13029
13030 .vitem &$sender_data$&
13031 .vindex "&$sender_data$&"
13032 This variable is set after a lookup success in an ACL &%senders%& condition or
13033 in a router &%senders%& option. It contains the data from the lookup, and the
13034 value remains set until the next &%senders%& test. Thus, you can do things like
13035 this:
13036 .display
13037 &`require senders      = cdb*@;/some/file`&
13038 &`deny    `&&'some further test involving'& &`$sender_data`&
13039 .endd
13040 &*Warning*&: This variable is set only when a lookup is used as an indexing
13041 method in the address list, using the semicolon syntax as in the example above.
13042 The variable is not set for a lookup that is used as part of the string
13043 expansion that all such lists undergo before being interpreted.
13044
13045 .vitem &$sender_fullhost$&
13046 .vindex "&$sender_fullhost$&"
13047 When a message is received from a remote host, this variable contains the host
13048 name and IP address in a single string. It ends with the IP address in square
13049 brackets, followed by a colon and a port number if the logging of ports is
13050 enabled. The format of the rest of the string depends on whether the host
13051 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13052 looking up its IP address. (Looking up the IP address can be forced by the
13053 &%host_lookup%& option, independent of verification.) A plain host name at the
13054 start of the string is a verified host name; if this is not present,
13055 verification either failed or was not requested. A host name in parentheses is
13056 the argument of a HELO or EHLO command. This is omitted if it is identical to
13057 the verified host name or to the host's IP address in square brackets.
13058
13059 .vitem &$sender_helo_dnssec$&
13060 .vindex "&$sender_helo_dnssec$&"
13061 This boolean variable is true if a successful HELO verification was
13062 .cindex "DNS" "DNSSEC"
13063 done using DNS information the resolver library stated was authenticated data.
13064
13065 .vitem &$sender_helo_name$&
13066 .vindex "&$sender_helo_name$&"
13067 When a message is received from a remote host that has issued a HELO or EHLO
13068 command, the argument of that command is placed in this variable. It is also
13069 set if HELO or EHLO is used when a message is received using SMTP locally via
13070 the &%-bs%& or &%-bS%& options.
13071
13072 .vitem &$sender_host_address$&
13073 .vindex "&$sender_host_address$&"
13074 When a message is received from a remote host using SMTP,
13075 this variable contains that
13076 host's IP address. For locally non-SMTP submitted messages, it is empty.
13077
13078 .vitem &$sender_host_authenticated$&
13079 .vindex "&$sender_host_authenticated$&"
13080 This variable contains the name (not the public name) of the authenticator
13081 driver that successfully authenticated the client from which the message was
13082 received. It is empty if there was no successful authentication. See also
13083 &$authenticated_id$&.
13084
13085 .vitem &$sender_host_dnssec$&
13086 .vindex "&$sender_host_dnssec$&"
13087 If an attempt to populate &$sender_host_name$& has been made
13088 (by reference, &%hosts_lookup%& or
13089 otherwise) then this boolean will have been set true if, and only if, the
13090 resolver library states that both
13091 the reverse and forward DNS were authenticated data.  At all
13092 other times, this variable is false.
13093
13094 .cindex "DNS" "DNSSEC"
13095 It is likely that you will need to coerce DNSSEC support on in the resolver
13096 library, by setting:
13097 .code
13098 dns_dnssec_ok = 1
13099 .endd
13100
13101 Exim does not perform DNSSEC validation itself, instead leaving that to a
13102 validating resolver (e.g. unbound, or bind with suitable configuration).
13103
13104 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13105 mechanism in the list, then this variable will be false.
13106
13107 This requires that your system resolver library support EDNS0 (and that
13108 DNSSEC flags exist in the system headers).  If the resolver silently drops
13109 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13110 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13111
13112
13113 .vitem &$sender_host_name$&
13114 .vindex "&$sender_host_name$&"
13115 When a message is received from a remote host, this variable contains the
13116 host's name as obtained by looking up its IP address. For messages received by
13117 other means, this variable is empty.
13118
13119 .vindex "&$host_lookup_failed$&"
13120 If the host name has not previously been looked up, a reference to
13121 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13122 A looked up name is accepted only if it leads back to the original IP address
13123 via a forward lookup. If either the reverse or the forward lookup fails to find
13124 any data, or if the forward lookup does not yield the original IP address,
13125 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13126
13127 .vindex "&$host_lookup_deferred$&"
13128 However, if either of the lookups cannot be completed (for example, there is a
13129 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13130 &$host_lookup_failed$& remains set to &"0"&.
13131
13132 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13133 host name again if there is a subsequent reference to &$sender_host_name$&
13134 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13135 is set to &"1"&.
13136
13137 Exim does not automatically look up every calling host's name. If you want
13138 maximum efficiency, you should arrange your configuration so that it avoids
13139 these lookups altogether. The lookup happens only if one or more of the
13140 following are true:
13141
13142 .ilist
13143 A string containing &$sender_host_name$& is expanded.
13144 .next
13145 The calling host matches the list in &%host_lookup%&. In the default
13146 configuration, this option is set to *, so it must be changed if lookups are
13147 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13148 .next
13149 Exim needs the host name in order to test an item in a host list. The items
13150 that require this are described in sections &<<SECThoslispatnam>>& and
13151 &<<SECThoslispatnamsk>>&.
13152 .next
13153 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13154 In this case, the host name is required to compare with the name quoted in any
13155 EHLO or HELO commands that the client issues.
13156 .next
13157 The remote host issues a EHLO or HELO command that quotes one of the
13158 domains in &%helo_lookup_domains%&. The default value of this option is
13159 . ==== As this is a nested list, any displays it contains must be indented
13160 . ==== as otherwise they are too far to the left.
13161 .code
13162   helo_lookup_domains = @ : @[]
13163 .endd
13164 which causes a lookup if a remote host (incorrectly) gives the server's name or
13165 IP address in an EHLO or HELO command.
13166 .endlist
13167
13168
13169 .vitem &$sender_host_port$&
13170 .vindex "&$sender_host_port$&"
13171 When a message is received from a remote host, this variable contains the port
13172 number that was used on the remote host.
13173
13174 .vitem &$sender_ident$&
13175 .vindex "&$sender_ident$&"
13176 When a message is received from a remote host, this variable contains the
13177 identification received in response to an RFC 1413 request. When a message has
13178 been received locally, this variable contains the login name of the user that
13179 called Exim.
13180
13181 .vitem &$sender_rate_$&&'xxx'&
13182 A number of variables whose names begin &$sender_rate_$& are set as part of the
13183 &%ratelimit%& ACL condition. Details are given in section
13184 &<<SECTratelimiting>>&.
13185
13186 .vitem &$sender_rcvhost$&
13187 .cindex "DNS" "reverse lookup"
13188 .cindex "reverse DNS lookup"
13189 .vindex "&$sender_rcvhost$&"
13190 This is provided specifically for use in &'Received:'& headers. It starts with
13191 either the verified host name (as obtained from a reverse DNS lookup) or, if
13192 there is no verified host name, the IP address in square brackets. After that
13193 there may be text in parentheses. When the first item is a verified host name,
13194 the first thing in the parentheses is the IP address in square brackets,
13195 followed by a colon and a port number if port logging is enabled. When the
13196 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13197 the parentheses.
13198
13199 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13200 was used and its argument was not identical to the real host name or IP
13201 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13202 all three items are present in the parentheses, a newline and tab are inserted
13203 into the string, to improve the formatting of the &'Received:'& header.
13204
13205 .vitem &$sender_verify_failure$&
13206 .vindex "&$sender_verify_failure$&"
13207 In an ACL, when a sender verification fails, this variable contains information
13208 about the failure. The details are the same as for
13209 &$recipient_verify_failure$&.
13210
13211 .vitem &$sending_ip_address$&
13212 .vindex "&$sending_ip_address$&"
13213 This variable is set whenever an outgoing SMTP connection to another host has
13214 been set up. It contains the IP address of the local interface that is being
13215 used. This is useful if a host that has more than one IP address wants to take
13216 on different personalities depending on which one is being used. For incoming
13217 connections, see &$received_ip_address$&.
13218
13219 .vitem &$sending_port$&
13220 .vindex "&$sending_port$&"
13221 This variable is set whenever an outgoing SMTP connection to another host has
13222 been set up. It contains the local port that is being used. For incoming
13223 connections, see &$received_port$&.
13224
13225 .vitem &$smtp_active_hostname$&
13226 .vindex "&$smtp_active_hostname$&"
13227 During an incoming SMTP session, this variable contains the value of the active
13228 host name, as specified by the &%smtp_active_hostname%& option. The value of
13229 &$smtp_active_hostname$& is saved with any message that is received, so its
13230 value can be consulted during routing and delivery.
13231
13232 .vitem &$smtp_command$&
13233 .vindex "&$smtp_command$&"
13234 During the processing of an incoming SMTP command, this variable contains the
13235 entire command. This makes it possible to distinguish between HELO and EHLO in
13236 the HELO ACL, and also to distinguish between commands such as these:
13237 .code
13238 MAIL FROM:<>
13239 MAIL FROM: <>
13240 .endd
13241 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13242 command, the address in &$smtp_command$& is the original address before any
13243 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13244 the address after SMTP-time rewriting.
13245
13246 .vitem &$smtp_command_argument$&
13247 .cindex "SMTP" "command, argument for"
13248 .vindex "&$smtp_command_argument$&"
13249 While an ACL is running to check an SMTP command, this variable contains the
13250 argument, that is, the text that follows the command name, with leading white
13251 space removed. Following the introduction of &$smtp_command$&, this variable is
13252 somewhat redundant, but is retained for backwards compatibility.
13253
13254 .vitem &$smtp_command_history$&
13255 .cindex SMTP "command history"
13256 .vindex "&$smtp_command_history$&"
13257 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13258 received, in time-order left to right.  Only a limited number of commands
13259 are remembered.
13260
13261 .vitem &$smtp_count_at_connection_start$&
13262 .vindex "&$smtp_count_at_connection_start$&"
13263 This variable is set greater than zero only in processes spawned by the Exim
13264 daemon for handling incoming SMTP connections. The name is deliberately long,
13265 in order to emphasize what the contents are. When the daemon accepts a new
13266 connection, it increments this variable. A copy of the variable is passed to
13267 the child process that handles the connection, but its value is fixed, and
13268 never changes. It is only an approximation of how many incoming connections
13269 there actually are, because many other connections may come and go while a
13270 single connection is being processed. When a child process terminates, the
13271 daemon decrements its copy of the variable.
13272
13273 .vitem "&$sn0$& &-- &$sn9$&"
13274 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13275 that were current at the end of the system filter file. This allows a system
13276 filter file to set values that can be tested in users' filter files. For
13277 example, a system filter could set a value indicating how likely it is that a
13278 message is junk mail.
13279
13280 .vitem &$spam_$&&'xxx'&
13281 A number of variables whose names start with &$spam$& are available when Exim
13282 is compiled with the content-scanning extension. For details, see section
13283 &<<SECTscanspamass>>&.
13284
13285 .vitem &$spf_header_comment$& &&&
13286        &$spf_received$& &&&
13287        &$spf_result$& &&&
13288        &$spf_result_guessed$& &&&
13289        &$spf_smtp_comment$&
13290 These variables are only available if Exim is built with SPF support.
13291 For details see section &<<SECSPF>>&.
13292
13293 .vitem &$spool_directory$&
13294 .vindex "&$spool_directory$&"
13295 The name of Exim's spool directory.
13296
13297 .vitem &$spool_inodes$&
13298 .vindex "&$spool_inodes$&"
13299 The number of free inodes in the disk partition where Exim's spool files are
13300 being written. The value is recalculated whenever the variable is referenced.
13301 If the relevant file system does not have the concept of inodes, the value of
13302 is -1. See also the &%check_spool_inodes%& option.
13303
13304 .vitem &$spool_space$&
13305 .vindex "&$spool_space$&"
13306 The amount of free space (as a number of kilobytes) in the disk partition where
13307 Exim's spool files are being written. The value is recalculated whenever the
13308 variable is referenced. If the operating system does not have the ability to
13309 find the amount of free space (only true for experimental systems), the space
13310 value is -1. For example, to check in an ACL that there is at least 50
13311 megabytes free on the spool, you could write:
13312 .code
13313 condition = ${if > {$spool_space}{50000}}
13314 .endd
13315 See also the &%check_spool_space%& option.
13316
13317
13318 .vitem &$thisaddress$&
13319 .vindex "&$thisaddress$&"
13320 This variable is set only during the processing of the &%foranyaddress%&
13321 command in a filter file. Its use is explained in the description of that
13322 command, which can be found in the separate document entitled &'Exim's
13323 interfaces to mail filtering'&.
13324
13325 .vitem &$tls_in_bits$&
13326 .vindex "&$tls_in_bits$&"
13327 Contains an approximation of the TLS cipher's bit-strength
13328 on the inbound connection; the meaning of
13329 this depends upon the TLS implementation used.
13330 If TLS has not been negotiated, the value will be 0.
13331 The value of this is automatically fed into the Cyrus SASL authenticator
13332 when acting as a server, to specify the "external SSF" (a SASL term).
13333
13334 The deprecated &$tls_bits$& variable refers to the inbound side
13335 except when used in the context of an outbound SMTP delivery, when it refers to
13336 the outbound.
13337
13338 .vitem &$tls_out_bits$&
13339 .vindex "&$tls_out_bits$&"
13340 Contains an approximation of the TLS cipher's bit-strength
13341 on an outbound SMTP connection; the meaning of
13342 this depends upon the TLS implementation used.
13343 If TLS has not been negotiated, the value will be 0.
13344
13345 .vitem &$tls_in_ourcert$&
13346 .vindex "&$tls_in_ourcert$&"
13347 .cindex certificate variables
13348 This variable refers to the certificate presented to the peer of an
13349 inbound connection when the message was received.
13350 It is only useful as the argument of a
13351 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13352 or a &%def%& condition.
13353
13354 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13355 when a list of more than one
13356 file is used for &%tls_certificate%&, this variable is not reliable.
13357 .new
13358 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13359 .wen
13360
13361 .vitem &$tls_in_peercert$&
13362 .vindex "&$tls_in_peercert$&"
13363 This variable refers to the certificate presented by the peer of an
13364 inbound connection when the message was received.
13365 It is only useful as the argument of a
13366 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13367 or a &%def%& condition.
13368 If certificate verification fails it may refer to a failing chain element
13369 which is not the leaf.
13370
13371 .vitem &$tls_out_ourcert$&
13372 .vindex "&$tls_out_ourcert$&"
13373 This variable refers to the certificate presented to the peer of an
13374 outbound connection.  It is only useful as the argument of a
13375 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13376 or a &%def%& condition.
13377
13378 .vitem &$tls_out_peercert$&
13379 .vindex "&$tls_out_peercert$&"
13380 This variable refers to the certificate presented by the peer of an
13381 outbound connection.  It is only useful as the argument of a
13382 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13383 or a &%def%& condition.
13384 If certificate verification fails it may refer to a failing chain element
13385 which is not the leaf.
13386
13387 .vitem &$tls_in_certificate_verified$&
13388 .vindex "&$tls_in_certificate_verified$&"
13389 This variable is set to &"1"& if a TLS certificate was verified when the
13390 message was received, and &"0"& otherwise.
13391
13392 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13393 except when used in the context of an outbound SMTP delivery, when it refers to
13394 the outbound.
13395
13396 .vitem &$tls_out_certificate_verified$&
13397 .vindex "&$tls_out_certificate_verified$&"
13398 This variable is set to &"1"& if a TLS certificate was verified when an
13399 outbound SMTP connection was made,
13400 and &"0"& otherwise.
13401
13402 .vitem &$tls_in_cipher$&
13403 .vindex "&$tls_in_cipher$&"
13404 .vindex "&$tls_cipher$&"
13405 When a message is received from a remote host over an encrypted SMTP
13406 connection, this variable is set to the cipher suite that was negotiated, for
13407 example DES-CBC3-SHA. In other circumstances, in particular, for message
13408 received over unencrypted connections, the variable is empty. Testing
13409 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13410 non-encrypted connections during ACL processing.
13411
13412 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13413 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13414 becomes the same as &$tls_out_cipher$&.
13415
13416 .new
13417 .vitem &$tls_in_cipher_std$&
13418 .vindex "&$tls_in_cipher_std$&"
13419 As above, but returning the RFC standard name for the cipher suite.
13420 .wen
13421
13422 .vitem &$tls_out_cipher$&
13423 .vindex "&$tls_out_cipher$&"
13424 This variable is
13425 cleared before any outgoing SMTP connection is made,
13426 and then set to the outgoing cipher suite if one is negotiated. See chapter
13427 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13428 details of the &(smtp)& transport.
13429
13430 ,new
13431 .vitem &$tls_out_cipher_std$&
13432 .vindex "&$tls_out_cipher_std$&"
13433 As above, but returning the RFC standard name for the cipher suite.
13434 .wen
13435
13436 .vitem &$tls_out_dane$&
13437 .vindex &$tls_out_dane$&
13438 DANE active status.  See section &<<SECDANE>>&.
13439
13440 .vitem &$tls_in_ocsp$&
13441 .vindex "&$tls_in_ocsp$&"
13442 When a message is received from a remote client connection
13443 the result of any OCSP request from the client is encoded in this variable:
13444 .code
13445 0 OCSP proof was not requested (default value)
13446 1 No response to request
13447 2 Response not verified
13448 3 Verification failed
13449 4 Verification succeeded
13450 .endd
13451
13452 .vitem &$tls_out_ocsp$&
13453 .vindex "&$tls_out_ocsp$&"
13454 When a message is sent to a remote host connection
13455 the result of any OCSP request made is encoded in this variable.
13456 See &$tls_in_ocsp$& for values.
13457
13458 .vitem &$tls_in_peerdn$&
13459 .vindex "&$tls_in_peerdn$&"
13460 .vindex "&$tls_peerdn$&"
13461 .cindex certificate "extracting fields"
13462 When a message is received from a remote host over an encrypted SMTP
13463 connection, and Exim is configured to request a certificate from the client,
13464 the value of the Distinguished Name of the certificate is made available in the
13465 &$tls_in_peerdn$& during subsequent processing.
13466 If certificate verification fails it may refer to a failing chain element
13467 which is not the leaf.
13468
13469 The deprecated &$tls_peerdn$& variable refers to the inbound side
13470 except when used in the context of an outbound SMTP delivery, when it refers to
13471 the outbound.
13472
13473 .vitem &$tls_out_peerdn$&
13474 .vindex "&$tls_out_peerdn$&"
13475 When a message is being delivered to a remote host over an encrypted SMTP
13476 connection, and Exim is configured to request a certificate from the server,
13477 the value of the Distinguished Name of the certificate is made available in the
13478 &$tls_out_peerdn$& during subsequent processing.
13479 If certificate verification fails it may refer to a failing chain element
13480 which is not the leaf.
13481
13482 .vitem &$tls_in_sni$&
13483 .vindex "&$tls_in_sni$&"
13484 .vindex "&$tls_sni$&"
13485 .cindex "TLS" "Server Name Indication"
13486 When a TLS session is being established, if the client sends the Server
13487 Name Indication extension, the value will be placed in this variable.
13488 If the variable appears in &%tls_certificate%& then this option and
13489 some others, described in &<<SECTtlssni>>&,
13490 will be re-expanded early in the TLS session, to permit
13491 a different certificate to be presented (and optionally a different key to be
13492 used) to the client, based upon the value of the SNI extension.
13493
13494 The deprecated &$tls_sni$& variable refers to the inbound side
13495 except when used in the context of an outbound SMTP delivery, when it refers to
13496 the outbound.
13497
13498 .vitem &$tls_out_sni$&
13499 .vindex "&$tls_out_sni$&"
13500 .cindex "TLS" "Server Name Indication"
13501 During outbound
13502 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13503 the transport.
13504
13505 .vitem &$tls_out_tlsa_usage$&
13506 .vindex &$tls_out_tlsa_usage$&
13507 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13508
13509 .vitem &$tod_bsdinbox$&
13510 .vindex "&$tod_bsdinbox$&"
13511 The time of day and the date, in the format required for BSD-style mailbox
13512 files, for example: Thu Oct 17 17:14:09 1995.
13513
13514 .vitem &$tod_epoch$&
13515 .vindex "&$tod_epoch$&"
13516 The time and date as a number of seconds since the start of the Unix epoch.
13517
13518 .vitem &$tod_epoch_l$&
13519 .vindex "&$tod_epoch_l$&"
13520 The time and date as a number of microseconds since the start of the Unix epoch.
13521
13522 .vitem &$tod_full$&
13523 .vindex "&$tod_full$&"
13524 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13525 +0100. The timezone is always given as a numerical offset from UTC, with
13526 positive values used for timezones that are ahead (east) of UTC, and negative
13527 values for those that are behind (west).
13528
13529 .vitem &$tod_log$&
13530 .vindex "&$tod_log$&"
13531 The time and date in the format used for writing Exim's log files, for example:
13532 1995-10-12 15:32:29, but without a timezone.
13533
13534 .vitem &$tod_logfile$&
13535 .vindex "&$tod_logfile$&"
13536 This variable contains the date in the format yyyymmdd. This is the format that
13537 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13538 flag.
13539
13540 .vitem &$tod_zone$&
13541 .vindex "&$tod_zone$&"
13542 This variable contains the numerical value of the local timezone, for example:
13543 -0500.
13544
13545 .vitem &$tod_zulu$&
13546 .vindex "&$tod_zulu$&"
13547 This variable contains the UTC date and time in &"Zulu"& format, as specified
13548 by ISO 8601, for example: 20030221154023Z.
13549
13550 .vitem &$transport_name$&
13551 .cindex "transport" "name"
13552 .cindex "name" "of transport"
13553 .vindex "&$transport_name$&"
13554 During the running of a transport, this variable contains its name.
13555
13556 .vitem &$value$&
13557 .vindex "&$value$&"
13558 This variable contains the result of an expansion lookup, extraction operation,
13559 or external command, as described above. It is also used during a
13560 &*reduce*& expansion.
13561
13562 .vitem &$verify_mode$&
13563 .vindex "&$verify_mode$&"
13564 While a router or transport is being run in verify mode or for cutthrough delivery,
13565 contains "S" for sender-verification or "R" for recipient-verification.
13566 Otherwise, empty.
13567
13568 .vitem &$version_number$&
13569 .vindex "&$version_number$&"
13570 The version number of Exim. Same as &$exim_version$&, may be overridden
13571 by the &%exim_version%& main config option.
13572
13573 .vitem &$warn_message_delay$&
13574 .vindex "&$warn_message_delay$&"
13575 This variable is set only during the creation of a message warning about a
13576 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13577
13578 .vitem &$warn_message_recipients$&
13579 .vindex "&$warn_message_recipients$&"
13580 This variable is set only during the creation of a message warning about a
13581 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13582 .endlist
13583 .ecindex IIDstrexp
13584
13585
13586
13587 . ////////////////////////////////////////////////////////////////////////////
13588 . ////////////////////////////////////////////////////////////////////////////
13589
13590 .chapter "Embedded Perl" "CHAPperl"
13591 .scindex IIDperl "Perl" "calling from Exim"
13592 Exim can be built to include an embedded Perl interpreter. When this is done,
13593 Perl subroutines can be called as part of the string expansion process. To make
13594 use of the Perl support, you need version 5.004 or later of Perl installed on
13595 your system. To include the embedded interpreter in the Exim binary, include
13596 the line
13597 .code
13598 EXIM_PERL = perl.o
13599 .endd
13600 in your &_Local/Makefile_& and then build Exim in the normal way.
13601
13602
13603 .section "Setting up so Perl can be used" "SECID85"
13604 .oindex "&%perl_startup%&"
13605 Access to Perl subroutines is via a global configuration option called
13606 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13607 no &%perl_startup%& option in the Exim configuration file then no Perl
13608 interpreter is started and there is almost no overhead for Exim (since none of
13609 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13610 option then the associated value is taken to be Perl code which is executed in
13611 a newly created Perl interpreter.
13612
13613 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13614 need backslashes before any characters to escape special meanings. The option
13615 should usually be something like
13616 .code
13617 perl_startup = do '/etc/exim.pl'
13618 .endd
13619 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13620 use from Exim. Exim can be configured either to start up a Perl interpreter as
13621 soon as it is entered, or to wait until the first time it is needed. Starting
13622 the interpreter at the beginning ensures that it is done while Exim still has
13623 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13624 fact used in a particular run. Also, note that this does not mean that Exim is
13625 necessarily running as root when Perl is called at a later time. By default,
13626 the interpreter is started only when it is needed, but this can be changed in
13627 two ways:
13628
13629 .ilist
13630 .oindex "&%perl_at_start%&"
13631 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13632 a startup when Exim is entered.
13633 .next
13634 The command line option &%-ps%& also requests a startup when Exim is entered,
13635 overriding the setting of &%perl_at_start%&.
13636 .endlist
13637
13638 There is also a command line option &%-pd%& (for delay) which suppresses the
13639 initial startup, even if &%perl_at_start%& is set.
13640
13641 .ilist
13642 .oindex "&%perl_taintmode%&"
13643 .cindex "Perl" "taintmode"
13644 To provide more security executing Perl code via the embedded Perl
13645 interpreter, the &%perl_taintmode%& option can be set. This enables the
13646 taint mode of the Perl interpreter. You are encouraged to set this
13647 option to a true value. To avoid breaking existing installations, it
13648 defaults to false.
13649
13650
13651 .section "Calling Perl subroutines" "SECID86"
13652 When the configuration file includes a &%perl_startup%& option you can make use
13653 of the string expansion item to call the Perl subroutines that are defined
13654 by the &%perl_startup%& code. The operator is used in any of the following
13655 forms:
13656 .code
13657 ${perl{foo}}
13658 ${perl{foo}{argument}}
13659 ${perl{foo}{argument1}{argument2} ... }
13660 .endd
13661 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13662 arguments may be passed. Passing more than this results in an expansion failure
13663 with an error message of the form
13664 .code
13665 Too many arguments passed to Perl subroutine "foo" (max is 8)
13666 .endd
13667 The return value of the Perl subroutine is evaluated in a scalar context before
13668 it is passed back to Exim to be inserted into the expanded string. If the
13669 return value is &'undef'&, the expansion is forced to fail in the same way as
13670 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13671 by obeying Perl's &%die%& function, the expansion fails with the error message
13672 that was passed to &%die%&.
13673
13674
13675 .section "Calling Exim functions from Perl" "SECID87"
13676 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13677 is available to call back into Exim's string expansion function. For example,
13678 the Perl code
13679 .code
13680 my $lp = Exim::expand_string('$local_part');
13681 .endd
13682 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13683 Note those are single quotes and not double quotes to protect against
13684 &$local_part$& being interpolated as a Perl variable.
13685
13686 If the string expansion is forced to fail by a &"fail"& item, the result of
13687 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13688 expansion string, the Perl call from the original expansion string fails with
13689 an appropriate error message, in the same way as if &%die%& were used.
13690
13691 .cindex "debugging" "from embedded Perl"
13692 .cindex "log" "writing from embedded Perl"
13693 Two other Exim functions are available for use from within Perl code.
13694 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13695 debugging is enabled. If you want a newline at the end, you must supply it.
13696 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13697 timestamp. In this case, you should not supply a terminating newline.
13698
13699
13700 .section "Use of standard output and error by Perl" "SECID88"
13701 .cindex "Perl" "standard output and error"
13702 You should not write to the standard error or output streams from within your
13703 Perl code, as it is not defined how these are set up. In versions of Exim
13704 before 4.50, it is possible for the standard output or error to refer to the
13705 SMTP connection during message reception via the daemon. Writing to this stream
13706 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13707 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13708 avoided, but the output is lost.
13709
13710 .cindex "Perl" "use of &%warn%&"
13711 The Perl &%warn%& statement writes to the standard error stream by default.
13712 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13713 you have no control. When Exim starts up the Perl interpreter, it arranges for
13714 output from the &%warn%& statement to be written to the Exim main log. You can
13715 change this by including appropriate Perl magic somewhere in your Perl code.
13716 For example, to discard &%warn%& output completely, you need this:
13717 .code
13718 $SIG{__WARN__} = sub { };
13719 .endd
13720 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13721 example, the code for the subroutine is empty, so it does nothing, but you can
13722 include any Perl code that you like. The text of the &%warn%& message is passed
13723 as the first subroutine argument.
13724 .ecindex IIDperl
13725
13726
13727 . ////////////////////////////////////////////////////////////////////////////
13728 . ////////////////////////////////////////////////////////////////////////////
13729
13730 .chapter "Starting the daemon and the use of network interfaces" &&&
13731          "CHAPinterfaces" &&&
13732          "Starting the daemon"
13733 .cindex "daemon" "starting"
13734 .cindex "interface" "listening"
13735 .cindex "network interface"
13736 .cindex "interface" "network"
13737 .cindex "IP address" "for listening"
13738 .cindex "daemon" "listening IP addresses"
13739 .cindex "TCP/IP" "setting listening interfaces"
13740 .cindex "TCP/IP" "setting listening ports"
13741 A host that is connected to a TCP/IP network may have one or more physical
13742 hardware network interfaces. Each of these interfaces may be configured as one
13743 or more &"logical"& interfaces, which are the entities that a program actually
13744 works with. Each of these logical interfaces is associated with an IP address.
13745 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13746 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13747 knowledge about the host's interfaces for use in three different circumstances:
13748
13749 .olist
13750 When a listening daemon is started, Exim needs to know which interfaces
13751 and ports to listen on.
13752 .next
13753 When Exim is routing an address, it needs to know which IP addresses
13754 are associated with local interfaces. This is required for the correct
13755 processing of MX lists by removing the local host and others with the
13756 same or higher priority values. Also, Exim needs to detect cases
13757 when an address is routed to an IP address that in fact belongs to the
13758 local host. Unless the &%self%& router option or the &%allow_localhost%&
13759 option of the smtp transport is set (as appropriate), this is treated
13760 as an error situation.
13761 .next
13762 When Exim connects to a remote host, it may need to know which interface to use
13763 for the outgoing connection.
13764 .endlist
13765
13766
13767 Exim's default behaviour is likely to be appropriate in the vast majority
13768 of cases. If your host has only one interface, and you want all its IP
13769 addresses to be treated in the same way, and you are using only the
13770 standard SMTP port, you should not need to take any special action. The
13771 rest of this chapter does not apply to you.
13772
13773 In a more complicated situation you may want to listen only on certain
13774 interfaces, or on different ports, and for this reason there are a number of
13775 options that can be used to influence Exim's behaviour. The rest of this
13776 chapter describes how they operate.
13777
13778 When a message is received over TCP/IP, the interface and port that were
13779 actually used are set in &$received_ip_address$& and &$received_port$&.
13780
13781
13782
13783 .section "Starting a listening daemon" "SECID89"
13784 When a listening daemon is started (by means of the &%-bd%& command line
13785 option), the interfaces and ports on which it listens are controlled by the
13786 following options:
13787
13788 .ilist
13789 &%daemon_smtp_ports%& contains a list of default ports
13790 or service names.
13791 (For backward compatibility, this option can also be specified in the singular.)
13792 .next
13793 &%local_interfaces%& contains list of interface IP addresses on which to
13794 listen. Each item may optionally also specify a port.
13795 .endlist
13796
13797 The default list separator in both cases is a colon, but this can be changed as
13798 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13799 it is usually best to change the separator to avoid having to double all the
13800 colons. For example:
13801 .code
13802 local_interfaces = <; 127.0.0.1 ; \
13803                       192.168.23.65 ; \
13804                       ::1 ; \
13805                       3ffe:ffff:836f::fe86:a061
13806 .endd
13807 There are two different formats for specifying a port along with an IP address
13808 in &%local_interfaces%&:
13809
13810 .olist
13811 The port is added onto the address with a dot separator. For example, to listen
13812 on port 1234 on two different IP addresses:
13813 .code
13814 local_interfaces = <; 192.168.23.65.1234 ; \
13815                       3ffe:ffff:836f::fe86:a061.1234
13816 .endd
13817 .next
13818 The IP address is enclosed in square brackets, and the port is added
13819 with a colon separator, for example:
13820 .code
13821 local_interfaces = <; [192.168.23.65]:1234 ; \
13822                       [3ffe:ffff:836f::fe86:a061]:1234
13823 .endd
13824 .endlist
13825
13826 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13827 default setting contains just one port:
13828 .code
13829 daemon_smtp_ports = smtp
13830 .endd
13831 If more than one port is listed, each interface that does not have its own port
13832 specified listens on all of them. Ports that are listed in
13833 &%daemon_smtp_ports%& can be identified either by name (defined in
13834 &_/etc/services_&) or by number. However, when ports are given with individual
13835 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13836
13837
13838
13839 .section "Special IP listening addresses" "SECID90"
13840 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13841 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13842 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13843 instead of setting up separate listening sockets for each interface. The
13844 default value of &%local_interfaces%& is
13845 .code
13846 local_interfaces = 0.0.0.0
13847 .endd
13848 when Exim is built without IPv6 support; otherwise it is:
13849 .code
13850 local_interfaces = <; ::0 ; 0.0.0.0
13851 .endd
13852 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13853
13854
13855
13856 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13857 The &%-oX%& command line option can be used to override the values of
13858 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13859 instance. Another way of doing this would be to use macros and the &%-D%&
13860 option. However, &%-oX%& can be used by any admin user, whereas modification of
13861 the runtime configuration by &%-D%& is allowed only when the caller is root or
13862 exim.
13863
13864 The value of &%-oX%& is a list of items. The default colon separator can be
13865 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13866 If there are any items that do not
13867 contain dots or colons (that is, are not IP addresses), the value of
13868 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13869 items that do contain dots or colons, the value of &%local_interfaces%& is
13870 replaced by those items. Thus, for example,
13871 .code
13872 -oX 1225
13873 .endd
13874 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13875 whereas
13876 .code
13877 -oX 192.168.34.5.1125
13878 .endd
13879 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13880 (However, since &%local_interfaces%& now contains no items without ports, the
13881 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13882
13883
13884
13885 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13886 .cindex "submissions protocol"
13887 .cindex "ssmtp protocol"
13888 .cindex "smtps protocol"
13889 .cindex "SMTP" "ssmtp protocol"
13890 .cindex "SMTP" "smtps protocol"
13891 Exim supports the use of TLS-on-connect, used by mail clients in the
13892 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13893 For some years, IETF Standards Track documents only blessed the
13894 STARTTLS-based Submission service (port 587) while common practice was to support
13895 the same feature set on port 465, but using TLS-on-connect.
13896 If your installation needs to provide service to mail clients
13897 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13898 the 465 TCP ports.
13899
13900 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13901 service names, connections to those ports must first establish TLS, before
13902 proceeding to the application layer use of the SMTP protocol.
13903
13904 The common use of this option is expected to be
13905 .code
13906 tls_on_connect_ports = 465
13907 .endd
13908 per RFC 8314.
13909 There is also a command line option &%-tls-on-connect%&, which forces all ports
13910 to behave in this way when a daemon is started.
13911
13912 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13913 daemon to listen on those ports. You must still specify them in
13914 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13915 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13916 connections via the daemon.)
13917
13918
13919
13920
13921 .section "IPv6 address scopes" "SECID92"
13922 .cindex "IPv6" "address scopes"
13923 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13924 can, in principle, have the same link-local IPv6 address on different
13925 interfaces. Thus, additional information is needed, over and above the IP
13926 address, to distinguish individual interfaces. A convention of using a
13927 percent sign followed by something (often the interface name) has been
13928 adopted in some cases, leading to addresses like this:
13929 .code
13930 fe80::202:b3ff:fe03:45c1%eth0
13931 .endd
13932 To accommodate this usage, a percent sign followed by an arbitrary string is
13933 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13934 to convert a textual IPv6 address for actual use. This function recognizes the
13935 percent convention in operating systems that support it, and it processes the
13936 address appropriately. Unfortunately, some older libraries have problems with
13937 &[getaddrinfo()]&. If
13938 .code
13939 IPV6_USE_INET_PTON=yes
13940 .endd
13941 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13942 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13943 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13944 function.) Of course, this means that the additional functionality of
13945 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13946
13947 .section "Disabling IPv6" "SECID93"
13948 .cindex "IPv6" "disabling"
13949 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13950 run on a host whose kernel does not support IPv6. The binary will fall back to
13951 using IPv4, but it may waste resources looking up AAAA records, and trying to
13952 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13953 .oindex "&%disable_ipv6%&"
13954 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13955 activities take place. AAAA records are never looked up, and any IPv6 addresses
13956 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13957 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13958 to handle IPv6 literal addresses.
13959
13960 On the other hand, when IPv6 is in use, there may be times when you want to
13961 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13962 option to globally suppress the lookup of AAAA records for specified domains,
13963 and you can use the &%ignore_target_hosts%& generic router option to ignore
13964 IPv6 addresses in an individual router.
13965
13966
13967
13968 .section "Examples of starting a listening daemon" "SECID94"
13969 The default case in an IPv6 environment is
13970 .code
13971 daemon_smtp_ports = smtp
13972 local_interfaces = <; ::0 ; 0.0.0.0
13973 .endd
13974 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13975 Either one or two sockets may be used, depending on the characteristics of
13976 the TCP/IP stack. (This is complicated and messy; for more information,
13977 read the comments in the &_daemon.c_& source file.)
13978
13979 To specify listening on ports 25 and 26 on all interfaces:
13980 .code
13981 daemon_smtp_ports = 25 : 26
13982 .endd
13983 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13984 .code
13985 local_interfaces = <; ::0.25     ; ::0.26 \
13986                       0.0.0.0.25 ; 0.0.0.0.26
13987 .endd
13988 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13989 IPv4 loopback address only:
13990 .code
13991 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13992 .endd
13993 To specify listening on the default port on specific interfaces only:
13994 .code
13995 local_interfaces = 10.0.0.67 : 192.168.34.67
13996 .endd
13997 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13998
13999
14000
14001 .section "Recognizing the local host" "SECTreclocipadd"
14002 The &%local_interfaces%& option is also used when Exim needs to determine
14003 whether or not an IP address refers to the local host. That is, the IP
14004 addresses of all the interfaces on which a daemon is listening are always
14005 treated as local.
14006
14007 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14008 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14009 available interfaces from the operating system, and extracts the relevant
14010 (that is, IPv4 or IPv6) addresses to use for checking.
14011
14012 Some systems set up large numbers of virtual interfaces in order to provide
14013 many virtual web servers. In this situation, you may want to listen for
14014 email on only a few of the available interfaces, but nevertheless treat all
14015 interfaces as local when routing. You can do this by setting
14016 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14017 &"all"& wildcard values. These addresses are recognized as local, but are not
14018 used for listening. Consider this example:
14019 .code
14020 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14021                       192.168.53.235 ; \
14022                       3ffe:2101:12:1:a00:20ff:fe86:a061
14023
14024 extra_local_interfaces = <; ::0 ; 0.0.0.0
14025 .endd
14026 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14027 address, but all available interface addresses are treated as local when
14028 Exim is routing.
14029
14030 In some environments the local host name may be in an MX list, but with an IP
14031 address that is not assigned to any local interface. In other cases it may be
14032 desirable to treat other host names as if they referred to the local host. Both
14033 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14034 This contains host names rather than IP addresses. When a host is referenced
14035 during routing, either via an MX record or directly, it is treated as the local
14036 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14037 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14038
14039
14040
14041 .section "Delivering to a remote host" "SECID95"
14042 Delivery to a remote host is handled by the smtp transport. By default, it
14043 allows the system's TCP/IP functions to choose which interface to use (if
14044 there is more than one) when connecting to a remote host. However, the
14045 &%interface%& option can be set to specify which interface is used. See the
14046 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14047 details.
14048
14049
14050
14051
14052 . ////////////////////////////////////////////////////////////////////////////
14053 . ////////////////////////////////////////////////////////////////////////////
14054
14055 .chapter "Main configuration" "CHAPmainconfig"
14056 .scindex IIDconfima "configuration file" "main section"
14057 .scindex IIDmaiconf "main configuration"
14058 The first part of the runtime configuration file contains three types of item:
14059
14060 .ilist
14061 Macro definitions: These lines start with an upper case letter. See section
14062 &<<SECTmacrodefs>>& for details of macro processing.
14063 .next
14064 Named list definitions: These lines start with one of the words &"domainlist"&,
14065 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14066 section &<<SECTnamedlists>>&.
14067 .next
14068 Main configuration settings: Each setting occupies one line of the file
14069 (with possible continuations). If any setting is preceded by the word
14070 &"hide"&, the &%-bP%& command line option displays its value to admin users
14071 only. See section &<<SECTcos>>& for a description of the syntax of these option
14072 settings.
14073 .endlist
14074
14075 This chapter specifies all the main configuration options, along with their
14076 types and default values. For ease of finding a particular option, they appear
14077 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14078 are now so many options, they are first listed briefly in functional groups, as
14079 an aid to finding the name of the option you are looking for. Some options are
14080 listed in more than one group.
14081
14082 .section "Miscellaneous" "SECID96"
14083 .table2
14084 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14085 .row &%debug_store%&                 "do extra internal checks"
14086 .row &%disable_ipv6%&                "do no IPv6 processing"
14087 .row &%keep_malformed%&              "for broken files &-- should not happen"
14088 .row &%localhost_number%&            "for unique message ids in clusters"
14089 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14090 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14091 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14092 .row &%print_topbitchars%&           "top-bit characters are printing"
14093 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14094 .row &%timezone%&                    "force time zone"
14095 .endtable
14096
14097
14098 .section "Exim parameters" "SECID97"
14099 .table2
14100 .row &%exim_group%&                  "override compiled-in value"
14101 .row &%exim_path%&                   "override compiled-in value"
14102 .row &%exim_user%&                   "override compiled-in value"
14103 .row &%primary_hostname%&            "default from &[uname()]&"
14104 .row &%split_spool_directory%&       "use multiple directories"
14105 .row &%spool_directory%&             "override compiled-in value"
14106 .endtable
14107
14108
14109
14110 .section "Privilege controls" "SECID98"
14111 .table2
14112 .row &%admin_groups%&                "groups that are Exim admin users"
14113 .row &%commandline_checks_require_admin%& "require admin for various checks"
14114 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14115 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14116 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14117 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14118 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14119 .row &%never_users%&                 "do not run deliveries as these"
14120 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14121 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14122 .row &%trusted_groups%&              "groups that are trusted"
14123 .row &%trusted_users%&               "users that are trusted"
14124 .endtable
14125
14126
14127
14128 .section "Logging" "SECID99"
14129 .table2
14130 .row &%event_action%&                "custom logging"
14131 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14132 .row &%log_file_path%&               "override compiled-in value"
14133 .row &%log_selector%&                "set/unset optional logging"
14134 .row &%log_timezone%&                "add timezone to log lines"
14135 .row &%message_logs%&                "create per-message logs"
14136 .row &%preserve_message_logs%&       "after message completion"
14137 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14138 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14139 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14140 .row &%syslog_facility%&             "set syslog &""facility""& field"
14141 .row &%syslog_pid%&                  "pid in syslog lines"
14142 .row &%syslog_processname%&          "set syslog &""ident""& field"
14143 .row &%syslog_timestamp%&            "timestamp syslog lines"
14144 .row &%write_rejectlog%&             "control use of message log"
14145 .endtable
14146
14147
14148
14149 .section "Frozen messages" "SECID100"
14150 .table2
14151 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14152 .row &%freeze_tell%&                 "send message when freezing"
14153 .row &%move_frozen_messages%&        "to another directory"
14154 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14155 .endtable
14156
14157
14158
14159 .section "Data lookups" "SECID101"
14160 .table2
14161 .row &%ibase_servers%&               "InterBase servers"
14162 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14163 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14164 .row &%ldap_cert_file%&              "client cert file for LDAP"
14165 .row &%ldap_cert_key%&               "client key file for LDAP"
14166 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14167 .row &%ldap_default_servers%&        "used if no server in query"
14168 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14169 .row &%ldap_start_tls%&              "require TLS within LDAP"
14170 .row &%ldap_version%&                "set protocol version"
14171 .row &%lookup_open_max%&             "lookup files held open"
14172 .row &%mysql_servers%&               "default MySQL servers"
14173 .row &%oracle_servers%&              "Oracle servers"
14174 .row &%pgsql_servers%&               "default PostgreSQL servers"
14175 .row &%sqlite_lock_timeout%&         "as it says"
14176 .endtable
14177
14178
14179
14180 .section "Message ids" "SECID102"
14181 .table2
14182 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14183 .row &%message_id_header_text%&      "ditto"
14184 .endtable
14185
14186
14187
14188 .section "Embedded Perl Startup" "SECID103"
14189 .table2
14190 .row &%perl_at_start%&               "always start the interpreter"
14191 .row &%perl_startup%&                "code to obey when starting Perl"
14192 .row &%perl_taintmode%&              "enable taint mode in Perl"
14193 .endtable
14194
14195
14196
14197 .section "Daemon" "SECID104"
14198 .table2
14199 .row &%daemon_smtp_ports%&           "default ports"
14200 .row &%daemon_startup_retries%&      "number of times to retry"
14201 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14202 .row &%extra_local_interfaces%&      "not necessarily listened on"
14203 .row &%local_interfaces%&            "on which to listen, with optional ports"
14204 .row &%pid_file_path%&               "override compiled-in value"
14205 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14206 .endtable
14207
14208
14209
14210 .section "Resource control" "SECID105"
14211 .table2
14212 .row &%check_log_inodes%&            "before accepting a message"
14213 .row &%check_log_space%&             "before accepting a message"
14214 .row &%check_spool_inodes%&          "before accepting a message"
14215 .row &%check_spool_space%&           "before accepting a message"
14216 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14217 .row &%queue_only_load%&             "queue incoming if load high"
14218 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14219 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14220 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14221 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14222 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14223 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14224 .row &%smtp_accept_max_per_connection%& "messages per connection"
14225 .row &%smtp_accept_max_per_host%&    "connections from one host"
14226 .row &%smtp_accept_queue%&           "queue mail if more connections"
14227 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14228                                            connection"
14229 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14230 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14231 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14232 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14233 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14234 .endtable
14235
14236
14237
14238 .section "Policy controls" "SECID106"
14239 .table2
14240 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14241 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14242 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14243 .row &%acl_smtp_auth%&               "ACL for AUTH"
14244 .row &%acl_smtp_connect%&            "ACL for connection"
14245 .row &%acl_smtp_data%&               "ACL for DATA"
14246 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14247 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14248 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14249 .row &%acl_smtp_expn%&               "ACL for EXPN"
14250 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14251 .row &%acl_smtp_mail%&               "ACL for MAIL"
14252 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14253 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14254 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14255 .row &%acl_smtp_predata%&            "ACL for start of data"
14256 .row &%acl_smtp_quit%&               "ACL for QUIT"
14257 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14258 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14259 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14260 .row &%av_scanner%&                  "specify virus scanner"
14261 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14262                                       words""&"
14263 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14264 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14265 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14266 .row &%header_maxsize%&              "total size of message header"
14267 .row &%header_line_maxsize%&         "individual header line limit"
14268 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14269 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14270 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14271 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14272 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14273 .row &%host_lookup%&                 "host name looked up for these hosts"
14274 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14275 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14276 .row &%host_reject_connection%&      "reject connection from these hosts"
14277 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14278 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14279 .row &%message_size_limit%&          "for all messages"
14280 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14281 .row &%spamd_address%&               "set interface to SpamAssassin"
14282 .row &%strict_acl_vars%&             "object to unset ACL variables"
14283 .endtable
14284
14285
14286
14287 .section "Callout cache" "SECID107"
14288 .table2
14289 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14290                                          item"
14291 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14292                                          item"
14293 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14294 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14295 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14296 .endtable
14297
14298
14299
14300 .section "TLS" "SECID108"
14301 .table2
14302 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14303 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14304 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14305 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14306 .row &%tls_certificate%&             "location of server certificate"
14307 .row &%tls_crl%&                     "certificate revocation list"
14308 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14309 .row &%tls_dhparam%&                 "DH parameters for server"
14310 .row &%tls_eccurve%&                 "EC curve selection for server"
14311 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14312 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14313 .row &%tls_privatekey%&              "location of server private key"
14314 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14315 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14316 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14317 .row &%tls_verify_certificates%&     "expected client certificates"
14318 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14319 .endtable
14320
14321
14322
14323 .section "Local user handling" "SECID109"
14324 .table2
14325 .row &%finduser_retries%&            "useful in NIS environments"
14326 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14327 .row &%gecos_pattern%&               "ditto"
14328 .row &%max_username_length%&         "for systems that truncate"
14329 .row &%unknown_login%&               "used when no login name found"
14330 .row &%unknown_username%&            "ditto"
14331 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14332 .row &%uucp_from_sender%&            "ditto"
14333 .endtable
14334
14335
14336
14337 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14338 .table2
14339 .row &%header_maxsize%&              "total size of message header"
14340 .row &%header_line_maxsize%&         "individual header line limit"
14341 .row &%message_size_limit%&          "applies to all messages"
14342 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14343 .row &%received_header_text%&        "expanded to make &'Received:'&"
14344 .row &%received_headers_max%&        "for mail loop detection"
14345 .row &%recipients_max%&              "limit per message"
14346 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14347 .endtable
14348
14349
14350
14351
14352 .section "Non-SMTP incoming messages" "SECID111"
14353 .table2
14354 .row &%receive_timeout%&             "for non-SMTP messages"
14355 .endtable
14356
14357
14358
14359
14360
14361 .section "Incoming SMTP messages" "SECID112"
14362 See also the &'Policy controls'& section above.
14363
14364 .table2
14365 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14366 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14367 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14368 .row &%host_lookup%&                 "host name looked up for these hosts"
14369 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14370 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14371 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14372 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14373 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14374 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14375 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14376 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14377 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14378 .row &%smtp_accept_max_per_connection%& "messages per connection"
14379 .row &%smtp_accept_max_per_host%&    "connections from one host"
14380 .row &%smtp_accept_queue%&           "queue mail if more connections"
14381 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14382                                            connection"
14383 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14384 .row &%smtp_active_hostname%&        "host name to use in messages"
14385 .row &%smtp_banner%&                 "text for welcome banner"
14386 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14387 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14388 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14389 .row &%smtp_etrn_command%&           "what to run for ETRN"
14390 .row &%smtp_etrn_serialize%&         "only one at once"
14391 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14392 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14393 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14394 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14395 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14396 .row &%smtp_receive_timeout%&        "per command or data line"
14397 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14398 .row &%smtp_return_error_details%&   "give detail on rejections"
14399 .endtable
14400
14401
14402
14403 .section "SMTP extensions" "SECID113"
14404 .table2
14405 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14406 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14407 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14408 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14409 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14410 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14411 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14412 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14413 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14414 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14415 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14416 .endtable
14417
14418
14419
14420 .section "Processing messages" "SECID114"
14421 .table2
14422 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14423 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14424 .row &%allow_utf8_domains%&          "in addresses"
14425 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14426                                       words""&"
14427 .row &%delivery_date_remove%&        "from incoming messages"
14428 .row &%envelope_to_remove%&          "from incoming messages"
14429 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14430 .row &%headers_charset%&             "default for translations"
14431 .row &%qualify_domain%&              "default for senders"
14432 .row &%qualify_recipient%&           "default for recipients"
14433 .row &%return_path_remove%&          "from incoming messages"
14434 .row &%strip_excess_angle_brackets%& "in addresses"
14435 .row &%strip_trailing_dot%&          "at end of addresses"
14436 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14437 .endtable
14438
14439
14440
14441 .section "System filter" "SECID115"
14442 .table2
14443 .row &%system_filter%&               "locate system filter"
14444 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14445                                             directory"
14446 .row &%system_filter_file_transport%& "transport for delivery to a file"
14447 .row &%system_filter_group%&         "group for filter running"
14448 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14449 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14450 .row &%system_filter_user%&          "user for filter running"
14451 .endtable
14452
14453
14454
14455 .section "Routing and delivery" "SECID116"
14456 .table2
14457 .row &%disable_ipv6%&                "do no IPv6 processing"
14458 .row &%dns_again_means_nonexist%&    "for broken domains"
14459 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14460 .row &%dns_dnssec_ok%&               "parameter for resolver"
14461 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14462 .row &%dns_retrans%&                 "parameter for resolver"
14463 .row &%dns_retry%&                   "parameter for resolver"
14464 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14465 .row &%dns_use_edns0%&               "parameter for resolver"
14466 .row &%hold_domains%&                "hold delivery for these domains"
14467 .row &%local_interfaces%&            "for routing checks"
14468 .row &%queue_domains%&               "no immediate delivery for these"
14469 .row &%queue_only%&                  "no immediate delivery at all"
14470 .row &%queue_only_file%&             "no immediate delivery if file exists"
14471 .row &%queue_only_load%&             "no immediate delivery if load is high"
14472 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14473 .row &%queue_only_override%&         "allow command line to override"
14474 .row &%queue_run_in_order%&          "order of arrival"
14475 .row &%queue_run_max%&               "of simultaneous queue runners"
14476 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14477 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14478 .row &%remote_sort_domains%&         "order of remote deliveries"
14479 .row &%retry_data_expire%&           "timeout for retry data"
14480 .row &%retry_interval_max%&          "safety net for retry rules"
14481 .endtable
14482
14483
14484
14485 .section "Bounce and warning messages" "SECID117"
14486 .table2
14487 .row &%bounce_message_file%&         "content of bounce"
14488 .row &%bounce_message_text%&         "content of bounce"
14489 .row &%bounce_return_body%&          "include body if returning message"
14490 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14491 .row &%bounce_return_message%&       "include original message in bounce"
14492 .row &%bounce_return_size_limit%&    "limit on returned message"
14493 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14494 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14495 .row &%errors_copy%&                 "copy bounce messages"
14496 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14497 .row &%delay_warning%&               "time schedule"
14498 .row &%delay_warning_condition%&     "condition for warning messages"
14499 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14500 .row &%smtp_return_error_details%&   "give detail on rejections"
14501 .row &%warn_message_file%&           "content of warning message"
14502 .endtable
14503
14504
14505
14506 .section "Alphabetical list of main options" "SECTalomo"
14507 Those options that undergo string expansion before use are marked with
14508 &dagger;.
14509
14510 .option accept_8bitmime main boolean true
14511 .cindex "8BITMIME"
14512 .cindex "8-bit characters"
14513 .cindex "log" "selectors"
14514 .cindex "log" "8BITMIME"
14515 This option causes Exim to send 8BITMIME in its response to an SMTP
14516 EHLO command, and to accept the BODY= parameter on MAIL commands.
14517 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14518 takes no steps to do anything special with messages received by this route.
14519
14520 Historically Exim kept this option off by default, but the maintainers
14521 feel that in today's Internet, this causes more problems than it solves.
14522 It now defaults to true.
14523 A more detailed analysis of the issues is provided by Dan Bernstein:
14524 .display
14525 &url(https://cr.yp.to/smtp/8bitmime.html)
14526 .endd
14527
14528 To log received 8BITMIME status use
14529 .code
14530 log_selector = +8bitmime
14531 .endd
14532
14533 .option acl_not_smtp main string&!! unset
14534 .cindex "&ACL;" "for non-SMTP messages"
14535 .cindex "non-SMTP messages" "ACLs for"
14536 This option defines the ACL that is run when a non-SMTP message has been
14537 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14538 further details.
14539
14540 .option acl_not_smtp_mime main string&!! unset
14541 This option defines the ACL that is run for individual MIME parts of non-SMTP
14542 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14543 SMTP messages.
14544
14545 .option acl_not_smtp_start main string&!! unset
14546 .cindex "&ACL;" "at start of non-SMTP message"
14547 .cindex "non-SMTP messages" "ACLs for"
14548 This option defines the ACL that is run before Exim starts reading a
14549 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14550
14551 .option acl_smtp_auth main string&!! unset
14552 .cindex "&ACL;" "setting up for SMTP commands"
14553 .cindex "AUTH" "ACL for"
14554 This option defines the ACL that is run when an SMTP AUTH command is
14555 received. See chapter &<<CHAPACL>>& for further details.
14556
14557 .option acl_smtp_connect main string&!! unset
14558 .cindex "&ACL;" "on SMTP connection"
14559 This option defines the ACL that is run when an SMTP connection is received.
14560 See chapter &<<CHAPACL>>& for further details.
14561
14562 .option acl_smtp_data main string&!! unset
14563 .cindex "DATA" "ACL for"
14564 This option defines the ACL that is run after an SMTP DATA command has been
14565 processed and the message itself has been received, but before the final
14566 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14567
14568 .option acl_smtp_data_prdr main string&!! accept
14569 .cindex "PRDR" "ACL for"
14570 .cindex "DATA" "PRDR ACL for"
14571 .cindex "&ACL;" "PRDR-related"
14572 .cindex "&ACL;" "per-user data processing"
14573 This option defines the ACL that,
14574 if the PRDR feature has been negotiated,
14575 is run for each recipient after an SMTP DATA command has been
14576 processed and the message itself has been received, but before the
14577 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14578
14579 .option acl_smtp_dkim main string&!! unset
14580 .cindex DKIM "ACL for"
14581 This option defines the ACL that is run for each DKIM signature
14582 (by default, or as specified in the dkim_verify_signers option)
14583 of a received message.
14584 See section &<<SECDKIMVFY>>& for further details.
14585
14586 .option acl_smtp_etrn main string&!! unset
14587 .cindex "ETRN" "ACL for"
14588 This option defines the ACL that is run when an SMTP ETRN command is
14589 received. See chapter &<<CHAPACL>>& for further details.
14590
14591 .option acl_smtp_expn main string&!! unset
14592 .cindex "EXPN" "ACL for"
14593 This option defines the ACL that is run when an SMTP EXPN command is
14594 received. See chapter &<<CHAPACL>>& for further details.
14595
14596 .option acl_smtp_helo main string&!! unset
14597 .cindex "EHLO" "ACL for"
14598 .cindex "HELO" "ACL for"
14599 This option defines the ACL that is run when an SMTP EHLO or HELO
14600 command is received. See chapter &<<CHAPACL>>& for further details.
14601
14602
14603 .option acl_smtp_mail main string&!! unset
14604 .cindex "MAIL" "ACL for"
14605 This option defines the ACL that is run when an SMTP MAIL command is
14606 received. See chapter &<<CHAPACL>>& for further details.
14607
14608 .option acl_smtp_mailauth main string&!! unset
14609 .cindex "AUTH" "on MAIL command"
14610 This option defines the ACL that is run when there is an AUTH parameter on
14611 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14612 &<<CHAPSMTPAUTH>>& for details of authentication.
14613
14614 .option acl_smtp_mime main string&!! unset
14615 .cindex "MIME content scanning" "ACL for"
14616 This option is available when Exim is built with the content-scanning
14617 extension. It defines the ACL that is run for each MIME part in a message. See
14618 section &<<SECTscanmimepart>>& for details.
14619
14620 .option acl_smtp_notquit main string&!! unset
14621 .cindex "not-QUIT, ACL for"
14622 This option defines the ACL that is run when an SMTP session
14623 ends without a QUIT command being received.
14624 See chapter &<<CHAPACL>>& for further details.
14625
14626 .option acl_smtp_predata main string&!! unset
14627 This option defines the ACL that is run when an SMTP DATA command is
14628 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14629 further details.
14630
14631 .option acl_smtp_quit main string&!! unset
14632 .cindex "QUIT, ACL for"
14633 This option defines the ACL that is run when an SMTP QUIT command is
14634 received. See chapter &<<CHAPACL>>& for further details.
14635
14636 .option acl_smtp_rcpt main string&!! unset
14637 .cindex "RCPT" "ACL for"
14638 This option defines the ACL that is run when an SMTP RCPT command is
14639 received. See chapter &<<CHAPACL>>& for further details.
14640
14641 .option acl_smtp_starttls main string&!! unset
14642 .cindex "STARTTLS, ACL for"
14643 This option defines the ACL that is run when an SMTP STARTTLS command is
14644 received. See chapter &<<CHAPACL>>& for further details.
14645
14646 .option acl_smtp_vrfy main string&!! unset
14647 .cindex "VRFY" "ACL for"
14648 This option defines the ACL that is run when an SMTP VRFY command is
14649 received. See chapter &<<CHAPACL>>& for further details.
14650
14651 .option add_environment main "string list" empty
14652 .cindex "environment" "set values"
14653 This option allows to set individual environment variables that the
14654 currently linked libraries and programs in child processes use.
14655 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14656
14657 .option admin_groups main "string list&!!" unset
14658 .cindex "admin user"
14659 This option is expanded just once, at the start of Exim's processing. If the
14660 current group or any of the supplementary groups of an Exim caller is in this
14661 colon-separated list, the caller has admin privileges. If all your system
14662 programmers are in a specific group, for example, you can give them all Exim
14663 admin privileges by putting that group in &%admin_groups%&. However, this does
14664 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14665 To permit this, you have to add individuals to the Exim group.
14666
14667 .option allow_domain_literals main boolean false
14668 .cindex "domain literal"
14669 If this option is set, the RFC 2822 domain literal format is permitted in
14670 email addresses. The option is not set by default, because the domain literal
14671 format is not normally required these days, and few people know about it. It
14672 has, however, been exploited by mail abusers.
14673
14674 Unfortunately, it seems that some DNS black list maintainers are using this
14675 format to report black listing to postmasters. If you want to accept messages
14676 addressed to your hosts by IP address, you need to set
14677 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14678 domains (defined in the named domain list &%local_domains%& in the default
14679 configuration). This &"magic string"& matches the domain literal form of all
14680 the local host's IP addresses.
14681
14682
14683 .option allow_mx_to_ip main boolean false
14684 .cindex "MX record" "pointing to IP address"
14685 It appears that more and more DNS zone administrators are breaking the rules
14686 and putting domain names that look like IP addresses on the right hand side of
14687 MX records. Exim follows the rules and rejects this, giving an error message
14688 that explains the misconfiguration. However, some other MTAs support this
14689 practice, so to avoid &"Why can't Exim do this?"& complaints,
14690 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14691 recommended, except when you have no other choice.
14692
14693 .option allow_utf8_domains main boolean false
14694 .cindex "domain" "UTF-8 characters in"
14695 .cindex "UTF-8" "in domain name"
14696 Lots of discussion is going on about internationalized domain names. One
14697 camp is strongly in favour of just using UTF-8 characters, and it seems
14698 that at least two other MTAs permit this.
14699 This option allows Exim users to experiment if they wish.
14700
14701 If it is set true, Exim's domain parsing function allows valid
14702 UTF-8 multicharacters to appear in domain name components, in addition to
14703 letters, digits, and hyphens.
14704
14705 .new
14706 If Exim is built with internationalization support
14707 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14708 this option can be left as default.
14709 .wen
14710 Without that,
14711 if you want to look up such domain names in the DNS, you must also
14712 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14713 suitable setting is:
14714 .code
14715 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14716   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14717 .endd
14718 Alternatively, you can just disable this feature by setting
14719 .code
14720 dns_check_names_pattern =
14721 .endd
14722 That is, set the option to an empty string so that no check is done.
14723
14724
14725 .option auth_advertise_hosts main "host list&!!" *
14726 .cindex "authentication" "advertising"
14727 .cindex "AUTH" "advertising"
14728 If any server authentication mechanisms are configured, Exim advertises them in
14729 response to an EHLO command only if the calling host matches this list.
14730 Otherwise, Exim does not advertise AUTH.
14731 Exim does not accept AUTH commands from clients to which it has not
14732 advertised the availability of AUTH. The advertising of individual
14733 authentication mechanisms can be controlled by the use of the
14734 &%server_advertise_condition%& generic authenticator option on the individual
14735 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14736
14737 Certain mail clients (for example, Netscape) require the user to provide a name
14738 and password for authentication if AUTH is advertised, even though it may
14739 not be needed (the host may accept messages from hosts on its local LAN without
14740 authentication, for example). The &%auth_advertise_hosts%& option can be used
14741 to make these clients more friendly by excluding them from the set of hosts to
14742 which Exim advertises AUTH.
14743
14744 .cindex "AUTH" "advertising when encrypted"
14745 If you want to advertise the availability of AUTH only when the connection
14746 is encrypted using TLS, you can make use of the fact that the value of this
14747 option is expanded, with a setting like this:
14748 .code
14749 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14750 .endd
14751 .vindex "&$tls_in_cipher$&"
14752 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14753 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14754 expansion is *, which matches all hosts.
14755
14756
14757 .option auto_thaw main time 0s
14758 .cindex "thawing messages"
14759 .cindex "unfreezing messages"
14760 If this option is set to a time greater than zero, a queue runner will try a
14761 new delivery attempt on any frozen message, other than a bounce message, if
14762 this much time has passed since it was frozen. This may result in the message
14763 being re-frozen if nothing has changed since the last attempt. It is a way of
14764 saying &"keep on trying, even though there are big problems"&.
14765
14766 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14767 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14768 thought to be very useful any more, and its use should probably be avoided.
14769
14770
14771 .option av_scanner main string "see below"
14772 This option is available if Exim is built with the content-scanning extension.
14773 It specifies which anti-virus scanner to use. The default value is:
14774 .code
14775 sophie:/var/run/sophie
14776 .endd
14777 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14778 before use. See section &<<SECTscanvirus>>& for further details.
14779
14780
14781 .option bi_command main string unset
14782 .oindex "&%-bi%&"
14783 This option supplies the name of a command that is run when Exim is called with
14784 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14785 just the command name, it is not a complete command line. If an argument is
14786 required, it must come from the &%-oA%& command line option.
14787
14788
14789 .option bounce_message_file main string unset
14790 .cindex "bounce message" "customizing"
14791 .cindex "customizing" "bounce message"
14792 This option defines a template file containing paragraphs of text to be used
14793 for constructing bounce messages.  Details of the file's contents are given in
14794 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14795
14796
14797 .option bounce_message_text main string unset
14798 When this option is set, its contents are included in the default bounce
14799 message immediately after &"This message was created automatically by mail
14800 delivery software."& It is not used if &%bounce_message_file%& is set.
14801
14802 .option bounce_return_body main boolean true
14803 .cindex "bounce message" "including body"
14804 This option controls whether the body of an incoming message is included in a
14805 bounce message when &%bounce_return_message%& is true. The default setting
14806 causes the entire message, both header and body, to be returned (subject to the
14807 value of &%bounce_return_size_limit%&). If this option is false, only the
14808 message header is included. In the case of a non-SMTP message containing an
14809 error that is detected during reception, only those header lines preceding the
14810 point at which the error was detected are returned.
14811 .cindex "bounce message" "including original"
14812
14813 .option bounce_return_linesize_limit main integer 998
14814 .cindex "size" "of bounce lines, limit"
14815 .cindex "bounce message" "line length limit"
14816 .cindex "limit" "bounce message line length"
14817 This option sets a limit in bytes on the line length of messages
14818 that are returned to senders due to delivery problems,
14819 when &%bounce_return_message%& is true.
14820 The default value corresponds to RFC limits.
14821 If the message being returned has lines longer than this value it is
14822 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14823
14824 The option also applies to bounces returned when an error is detected
14825 during reception of a message.
14826 In this case lines from the original are truncated.
14827
14828 The option does not apply to messages generated by an &(autoreply)& transport.
14829
14830
14831 .option bounce_return_message main boolean true
14832 If this option is set false, none of the original message is included in
14833 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14834 &%bounce_return_body%&.
14835
14836
14837 .option bounce_return_size_limit main integer 100K
14838 .cindex "size" "of bounce, limit"
14839 .cindex "bounce message" "size limit"
14840 .cindex "limit" "bounce message size"
14841 This option sets a limit in bytes on the size of messages that are returned to
14842 senders as part of bounce messages when &%bounce_return_message%& is true. The
14843 limit should be less than the value of the global &%message_size_limit%& and of
14844 any &%message_size_limit%& settings on transports, to allow for the bounce text
14845 that Exim generates. If this option is set to zero there is no limit.
14846
14847 When the body of any message that is to be included in a bounce message is
14848 greater than the limit, it is truncated, and a comment pointing this out is
14849 added at the top. The actual cutoff may be greater than the value given, owing
14850 to the use of buffering for transferring the message in chunks (typically 8K in
14851 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14852 messages.
14853
14854 .option bounce_sender_authentication main string unset
14855 .cindex "bounce message" "sender authentication"
14856 .cindex "authentication" "bounce message"
14857 .cindex "AUTH" "on bounce message"
14858 This option provides an authenticated sender address that is sent with any
14859 bounce messages generated by Exim that are sent over an authenticated SMTP
14860 connection. A typical setting might be:
14861 .code
14862 bounce_sender_authentication = mailer-daemon@my.domain.example
14863 .endd
14864 which would cause bounce messages to be sent using the SMTP command:
14865 .code
14866 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14867 .endd
14868 The value of &%bounce_sender_authentication%& must always be a complete email
14869 address.
14870
14871 .option callout_domain_negative_expire main time 3h
14872 .cindex "caching" "callout timeouts"
14873 .cindex "callout" "caching timeouts"
14874 This option specifies the expiry time for negative callout cache data for a
14875 domain. See section &<<SECTcallver>>& for details of callout verification, and
14876 section &<<SECTcallvercache>>& for details of the caching.
14877
14878
14879 .option callout_domain_positive_expire main time 7d
14880 This option specifies the expiry time for positive callout cache data for a
14881 domain. See section &<<SECTcallver>>& for details of callout verification, and
14882 section &<<SECTcallvercache>>& for details of the caching.
14883
14884
14885 .option callout_negative_expire main time 2h
14886 This option specifies the expiry time for negative callout cache data for an
14887 address. See section &<<SECTcallver>>& for details of callout verification, and
14888 section &<<SECTcallvercache>>& for details of the caching.
14889
14890
14891 .option callout_positive_expire main time 24h
14892 This option specifies the expiry time for positive callout cache data for an
14893 address. See section &<<SECTcallver>>& for details of callout verification, and
14894 section &<<SECTcallvercache>>& for details of the caching.
14895
14896
14897 .option callout_random_local_part main string&!! "see below"
14898 This option defines the &"random"& local part that can be used as part of
14899 callout verification. The default value is
14900 .code
14901 $primary_hostname-$tod_epoch-testing
14902 .endd
14903 See section &<<CALLaddparcall>>& for details of how this value is used.
14904
14905
14906 .option check_log_inodes main integer 100
14907 See &%check_spool_space%& below.
14908
14909
14910 .option check_log_space main integer 10M
14911 See &%check_spool_space%& below.
14912
14913 .oindex "&%check_rfc2047_length%&"
14914 .cindex "RFC 2047" "disabling length check"
14915 .option check_rfc2047_length main boolean true
14916 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14917 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14918 word; strings to be encoded that exceed this length are supposed to use
14919 multiple encoded words. By default, Exim does not recognize encoded words that
14920 exceed the maximum length. However, it seems that some software, in violation
14921 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14922 set false, Exim recognizes encoded words of any length.
14923
14924
14925 .option check_spool_inodes main integer 100
14926 See &%check_spool_space%& below.
14927
14928
14929 .option check_spool_space main integer 10M
14930 .cindex "checking disk space"
14931 .cindex "disk space, checking"
14932 .cindex "spool directory" "checking space"
14933 The four &%check_...%& options allow for checking of disk resources before a
14934 message is accepted.
14935
14936 .vindex "&$log_inodes$&"
14937 .vindex "&$log_space$&"
14938 .vindex "&$spool_inodes$&"
14939 .vindex "&$spool_space$&"
14940 When any of these options are nonzero, they apply to all incoming messages. If you
14941 want to apply different checks to different kinds of message, you can do so by
14942 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14943 &$spool_space$& in an ACL with appropriate additional conditions.
14944
14945
14946 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14947 either value is greater than zero, for example:
14948 .code
14949 check_spool_space = 100M
14950 check_spool_inodes = 100
14951 .endd
14952 The spool partition is the one that contains the directory defined by
14953 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14954 transit.
14955
14956 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14957 files are written if either is greater than zero. These should be set only if
14958 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14959
14960 If there is less space or fewer inodes than requested, Exim refuses to accept
14961 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14962 error response to the MAIL command. If ESMTP is in use and there was a
14963 SIZE parameter on the MAIL command, its value is added to the
14964 &%check_spool_space%& value, and the check is performed even if
14965 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14966
14967 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14968 number of kilobytes (though specified in bytes).
14969 If a non-multiple of 1024 is specified, it is rounded up.
14970
14971 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14972 failure a message is written to stderr and Exim exits with a non-zero code, as
14973 it obviously cannot send an error message of any kind.
14974
14975 There is a slight performance penalty for these checks.
14976 Versions of Exim preceding 4.88 had these disabled by default;
14977 high-rate installations confident they will never run out of resources
14978 may wish to deliberately disable them.
14979
14980 .option chunking_advertise_hosts main "host list&!!" *
14981 .cindex CHUNKING advertisement
14982 .cindex "RFC 3030" "CHUNKING"
14983 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14984 these hosts.
14985 Hosts may use the BDAT command as an alternate to DATA.
14986
14987 .option commandline_checks_require_admin main boolean &`false`&
14988 .cindex "restricting access to features"
14989 This option restricts various basic checking features to require an
14990 administrative user.
14991 This affects most of the &%-b*%& options, such as &%-be%&.
14992
14993 .option debug_store main boolean &`false`&
14994 .cindex debugging "memory corruption"
14995 .cindex memory debugging
14996 This option, when true, enables extra checking in Exim's internal memory
14997 management.  For use when a memory corruption issue is being investigated,
14998 it should normally be left as default.
14999
15000 .option daemon_smtp_ports main string &`smtp`&
15001 .cindex "port" "for daemon"
15002 .cindex "TCP/IP" "setting listening ports"
15003 This option specifies one or more default SMTP ports on which the Exim daemon
15004 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15005 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15006
15007 .option daemon_startup_retries main integer 9
15008 .cindex "daemon startup, retrying"
15009 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15010 the daemon at startup when it cannot immediately bind a listening socket
15011 (typically because the socket is already in use): &%daemon_startup_retries%&
15012 defines the number of retries after the first failure, and
15013 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15014
15015 .option daemon_startup_sleep main time 30s
15016 See &%daemon_startup_retries%&.
15017
15018 .option delay_warning main "time list" 24h
15019 .cindex "warning of delay"
15020 .cindex "delay warning, specifying"
15021 .cindex "queue" "delay warning"
15022 When a message is delayed, Exim sends a warning message to the sender at
15023 intervals specified by this option. The data is a colon-separated list of times
15024 after which to send warning messages. If the value of the option is an empty
15025 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15026 message has been in the queue for longer than the last time, the last interval
15027 between the times is used to compute subsequent warning times. For example,
15028 with
15029 .code
15030 delay_warning = 4h:8h:24h
15031 .endd
15032 the first message is sent after 4 hours, the second after 8 hours, and
15033 the third one after 24 hours. After that, messages are sent every 16 hours,
15034 because that is the interval between the last two times on the list. If you set
15035 just one time, it specifies the repeat interval. For example, with:
15036 .code
15037 delay_warning = 6h
15038 .endd
15039 messages are repeated every six hours. To stop warnings after a given time, set
15040 a very large time at the end of the list. For example:
15041 .code
15042 delay_warning = 2h:12h:99d
15043 .endd
15044 Note that the option is only evaluated at the time a delivery attempt fails,
15045 which depends on retry and queue-runner configuration.
15046 Typically retries will be configured more frequently than warning messages.
15047
15048 .option delay_warning_condition main string&!! "see below"
15049 .vindex "&$domain$&"
15050 The string is expanded at the time a warning message might be sent. If all the
15051 deferred addresses have the same domain, it is set in &$domain$& during the
15052 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15053 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15054 &"false"& (the comparison being done caselessly) then the warning message is
15055 not sent. The default is:
15056 .code
15057 delay_warning_condition = ${if or {\
15058   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15059   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15060   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15061   } {no}{yes}}
15062 .endd
15063 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15064 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15065 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15066 &"auto-replied"& in an &'Auto-Submitted:'& header.
15067
15068 .option deliver_drop_privilege main boolean false
15069 .cindex "unprivileged delivery"
15070 .cindex "delivery" "unprivileged"
15071 If this option is set true, Exim drops its root privilege at the start of a
15072 delivery process, and runs as the Exim user throughout. This severely restricts
15073 the kinds of local delivery that are possible, but is viable in certain types
15074 of configuration. There is a discussion about the use of root privilege in
15075 chapter &<<CHAPsecurity>>&.
15076
15077 .option deliver_queue_load_max main fixed-point unset
15078 .cindex "load average"
15079 .cindex "queue runner" "abandoning"
15080 When this option is set, a queue run is abandoned if the system load average
15081 becomes greater than the value of the option. The option has no effect on
15082 ancient operating systems on which Exim cannot determine the load average.
15083 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15084
15085
15086 .option delivery_date_remove main boolean true
15087 .cindex "&'Delivery-date:'& header line"
15088 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15089 message when it is delivered, in exactly the same way as &'Return-path:'& is
15090 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15091 should not be present in incoming messages, and this option causes them to be
15092 removed at the time the message is received, to avoid any problems that might
15093 occur when a delivered message is subsequently sent on to some other recipient.
15094
15095 .option disable_fsync main boolean false
15096 .cindex "&[fsync()]&, disabling"
15097 This option is available only if Exim was built with the compile-time option
15098 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15099 a runtime configuration generates an &"unknown option"& error. You should not
15100 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15101 really, really, really understand what you are doing. &'No pre-compiled
15102 distributions of Exim should ever make this option available.'&
15103
15104 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15105 updated files' data to be written to disc before continuing. Unexpected events
15106 such as crashes and power outages may cause data to be lost or scrambled.
15107 Here be Dragons. &*Beware.*&
15108
15109
15110 .option disable_ipv6 main boolean false
15111 .cindex "IPv6" "disabling"
15112 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15113 activities take place. AAAA records are never looked up, and any IPv6 addresses
15114 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15115 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15116 to handle IPv6 literal addresses.
15117
15118
15119 .new
15120 .option dkim_verify_hashes main "string list" "sha256 : sha512 : sha1"
15121 .cindex DKIM "selecting signature algorithms"
15122 This option gives a list of hash types which are acceptable in signatures,
15123 and an order of processing.
15124 Signatures with algorithms not in the list will be ignored.
15125
15126 Note that the presence of sha1 violates RFC 8301.
15127 Signatures using the rsa-sha1 are however (as of writing) still common.
15128 The default inclusion of sha1 may be dropped in a future release.
15129
15130 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15131 This option gives a list of key types which are acceptable in signatures,
15132 and an order of processing.
15133 Signatures with algorithms not in the list will be ignored.
15134
15135 .option dkim_verify_minimal main boolean false
15136 If set to true, verification of signatures will terminate after the
15137 first success.
15138 .wen
15139
15140 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15141 .cindex DKIM "controlling calls to the ACL"
15142 This option gives a list of DKIM domains for which the DKIM ACL is run.
15143 It is expanded after the message is received; by default it runs
15144 the ACL once for each signature in the message.
15145 See section &<<SECDKIMVFY>>&.
15146
15147
15148 .option dns_again_means_nonexist main "domain list&!!" unset
15149 .cindex "DNS" "&""try again""& response; overriding"
15150 DNS lookups give a &"try again"& response for the DNS errors
15151 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15152 keep trying to deliver a message, or to give repeated temporary errors to
15153 incoming mail. Sometimes the effect is caused by a badly set up name server and
15154 may persist for a long time. If a domain which exhibits this problem matches
15155 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15156 This option should be used with care. You can make it apply to reverse lookups
15157 by a setting such as this:
15158 .code
15159 dns_again_means_nonexist = *.in-addr.arpa
15160 .endd
15161 This option applies to all DNS lookups that Exim does. It also applies when the
15162 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15163 since these are most likely to be caused by DNS lookup problems. The
15164 &(dnslookup)& router has some options of its own for controlling what happens
15165 when lookups for MX or SRV records give temporary errors. These more specific
15166 options are applied after this global option.
15167
15168 .option dns_check_names_pattern main string "see below"
15169 .cindex "DNS" "pre-check of name syntax"
15170 When this option is set to a non-empty string, it causes Exim to check domain
15171 names for characters that are not allowed in host names before handing them to
15172 the DNS resolver, because some resolvers give temporary errors for names that
15173 contain unusual characters. If a domain name contains any unwanted characters,
15174 a &"not found"& result is forced, and the resolver is not called. The check is
15175 done by matching the domain name against a regular expression, which is the
15176 value of this option. The default pattern is
15177 .code
15178 dns_check_names_pattern = \
15179   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15180 .endd
15181 which permits only letters, digits, slashes, and hyphens in components, but
15182 they must start and end with a letter or digit. Slashes are not, in fact,
15183 permitted in host names, but they are found in certain NS records (which can be
15184 accessed in Exim by using a &%dnsdb%& lookup). If you set
15185 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15186 empty string.
15187
15188 .option dns_csa_search_limit main integer 5
15189 This option controls the depth of parental searching for CSA SRV records in the
15190 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15191
15192 .option dns_csa_use_reverse main boolean true
15193 This option controls whether or not an IP address, given as a CSA domain, is
15194 reversed and looked up in the reverse DNS, as described in more detail in
15195 section &<<SECTverifyCSA>>&.
15196
15197 .option dns_cname_loops main integer 1
15198 .cindex DNS "CNAME following"
15199 This option controls the following of CNAME chains, needed if the resolver does
15200 not do it internally.
15201 As of 2018 most should, and the default can be left.
15202 If you have an ancient one, a value of 10 is likely needed.
15203
15204 The default value of one CNAME-follow is needed
15205 thanks to the observed return for an MX request,
15206 given no MX presence but a CNAME to an A, of the CNAME.
15207
15208
15209 .option dns_dnssec_ok main integer -1
15210 .cindex "DNS" "resolver options"
15211 .cindex "DNS" "DNSSEC"
15212 If this option is set to a non-negative number then Exim will initialise the
15213 DNS resolver library to either use or not use DNSSEC, overriding the system
15214 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15215
15216 If the resolver library does not support DNSSEC then this option has no effect.
15217
15218
15219 .option dns_ipv4_lookup main "domain list&!!" unset
15220 .cindex "IPv6" "DNS lookup for AAAA records"
15221 .cindex "DNS" "IPv6 lookup for AAAA records"
15222 .cindex DNS "IPv6 disabling"
15223 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15224 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15225 (A records) when trying to find IP addresses for hosts, unless the host's
15226 domain matches this list.
15227
15228 This is a fudge to help with name servers that give big delays or otherwise do
15229 not work for the AAAA record type. In due course, when the world's name
15230 servers have all been upgraded, there should be no need for this option.
15231 .new
15232 Note that all lookups, including those done for verification, are affected;
15233 this will result in verify failure for IPv6 connections or ones using names
15234 only valid for IPv6 addresses.
15235 .wen
15236
15237
15238 .option dns_retrans main time 0s
15239 .cindex "DNS" "resolver options"
15240 .cindex timeout "dns lookup"
15241 .cindex "DNS" timeout
15242 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15243 retransmission and retry parameters for DNS lookups. Values of zero (the
15244 defaults) leave the system default settings unchanged. The first value is the
15245 time between retries, and the second is the number of retries. It isn't
15246 totally clear exactly how these settings affect the total time a DNS lookup may
15247 take. I haven't found any documentation about timeouts on DNS lookups; these
15248 parameter values are available in the external resolver interface structure,
15249 but nowhere does it seem to describe how they are used or what you might want
15250 to set in them.
15251 See also the &%slow_lookup_log%& option.
15252
15253
15254 .option dns_retry main integer 0
15255 See &%dns_retrans%& above.
15256
15257
15258 .option dns_trust_aa main "domain list&!!" unset
15259 .cindex "DNS" "resolver options"
15260 .cindex "DNS" "DNSSEC"
15261 If this option is set then lookup results marked with the AA bit
15262 (Authoritative Answer) are trusted the same way as if they were
15263 DNSSEC-verified. The authority section's name of the answer must
15264 match with this expanded domain list.
15265
15266 Use this option only if you talk directly to a resolver that is
15267 authoritative for some zones and does not set the AD (Authentic Data)
15268 bit in the answer. Some DNS servers may have an configuration option to
15269 mark the answers from their own zones as verified (they set the AD bit).
15270 Others do not have this option. It is considered as poor practice using
15271 a resolver that is an authoritative server for some zones.
15272
15273 Use this option only if you really have to (e.g. if you want
15274 to use DANE for remote delivery to a server that is listed in the DNS
15275 zones that your resolver is authoritative for).
15276
15277 If the DNS answer packet has the AA bit set and contains resource record
15278 in the answer section, the name of the first NS record appearing in the
15279 authority section is compared against the list. If the answer packet is
15280 authoritative but the answer section is empty, the name of the first SOA
15281 record in the authoritative section is used instead.
15282
15283 .cindex "DNS" "resolver options"
15284 .option dns_use_edns0 main integer -1
15285 .cindex "DNS" "resolver options"
15286 .cindex "DNS" "EDNS0"
15287 .cindex "DNS" "OpenBSD
15288 If this option is set to a non-negative number then Exim will initialise the
15289 DNS resolver library to either use or not use EDNS0 extensions, overriding
15290 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15291 on.
15292
15293 If the resolver library does not support EDNS0 then this option has no effect.
15294
15295 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15296 means that DNSSEC will not work with Exim on that platform either, unless Exim
15297 is linked against an alternative DNS client library.
15298
15299
15300 .option drop_cr main boolean false
15301 This is an obsolete option that is now a no-op. It used to affect the way Exim
15302 handled CR and LF characters in incoming messages. What happens now is
15303 described in section &<<SECTlineendings>>&.
15304
15305 .option dsn_advertise_hosts main "host list&!!" unset
15306 .cindex "bounce messages" "success"
15307 .cindex "DSN" "success"
15308 .cindex "Delivery Status Notification" "success"
15309 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15310 and accepted from, these hosts.
15311 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15312 and RET and ORCPT options on MAIL FROM commands.
15313 A NOTIFY=SUCCESS option requests success-DSN messages.
15314 A NOTIFY= option with no argument requests that no delay or failure DSNs
15315 are sent.
15316
15317 .option dsn_from main "string&!!" "see below"
15318 .cindex "&'From:'& header line" "in bounces"
15319 .cindex "bounce messages" "&'From:'& line, specifying"
15320 This option can be used to vary the contents of &'From:'& header lines in
15321 bounces and other automatically generated messages (&"Delivery Status
15322 Notifications"& &-- hence the name of the option). The default setting is:
15323 .code
15324 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15325 .endd
15326 The value is expanded every time it is needed. If the expansion fails, a
15327 panic is logged, and the default value is used.
15328
15329 .option envelope_to_remove main boolean true
15330 .cindex "&'Envelope-to:'& header line"
15331 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15332 message when it is delivered, in exactly the same way as &'Return-path:'& is
15333 handled. &'Envelope-to:'& records the original recipient address from the
15334 message's envelope that caused the delivery to happen. Such headers should not
15335 be present in incoming messages, and this option causes them to be removed at
15336 the time the message is received, to avoid any problems that might occur when a
15337 delivered message is subsequently sent on to some other recipient.
15338
15339
15340 .option errors_copy main "string list&!!" unset
15341 .cindex "bounce message" "copy to other address"
15342 .cindex "copy of bounce message"
15343 Setting this option causes Exim to send bcc copies of bounce messages that it
15344 generates to other addresses. &*Note*&: This does not apply to bounce messages
15345 coming from elsewhere. The value of the option is a colon-separated list of
15346 items. Each item consists of a pattern, terminated by white space, followed by
15347 a comma-separated list of email addresses. If a pattern contains spaces, it
15348 must be enclosed in double quotes.
15349
15350 Each pattern is processed in the same way as a single item in an address list
15351 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15352 the bounce message, the message is copied to the addresses on the list. The
15353 items are scanned in order, and once a matching one is found, no further items
15354 are examined. For example:
15355 .code
15356 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15357               rqps@mydomain   hostmaster@mydomain.example,\
15358                               postmaster@mydomain.example
15359 .endd
15360 .vindex "&$domain$&"
15361 .vindex "&$local_part$&"
15362 The address list is expanded before use. The expansion variables &$local_part$&
15363 and &$domain$& are set from the original recipient of the error message, and if
15364 there was any wildcard matching in the pattern, the expansion
15365 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15366 variables &$0$&, &$1$&, etc. are set in the normal way.
15367
15368
15369 .option errors_reply_to main string unset
15370 .cindex "bounce message" "&'Reply-to:'& in"
15371 By default, Exim's bounce and delivery warning messages contain the header line
15372 .display
15373 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15374 .endd
15375 .oindex &%quota_warn_message%&
15376 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15377 A warning message that is generated by the &%quota_warn_message%& option in an
15378 &(appendfile)& transport may contain its own &'From:'& header line that
15379 overrides the default.
15380
15381 Experience shows that people reply to bounce messages. If the
15382 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15383 and warning messages. For example:
15384 .code
15385 errors_reply_to = postmaster@my.domain.example
15386 .endd
15387 The value of the option is not expanded. It must specify a valid RFC 2822
15388 address. However, if a warning message that is generated by the
15389 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15390 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15391 not used.
15392
15393
15394 .option event_action main string&!! unset
15395 .cindex events
15396 This option declares a string to be expanded for Exim's events mechanism.
15397 For details see chapter &<<CHAPevents>>&.
15398
15399
15400 .option exim_group main string "compile-time configured"
15401 .cindex "gid (group id)" "Exim's own"
15402 .cindex "Exim group"
15403 This option changes the gid under which Exim runs when it gives up root
15404 privilege. The default value is compiled into the binary. The value of this
15405 option is used only when &%exim_user%& is also set. Unless it consists entirely
15406 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15407 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15408 security issues.
15409
15410
15411 .option exim_path main string "see below"
15412 .cindex "Exim binary, path name"
15413 This option specifies the path name of the Exim binary, which is used when Exim
15414 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15415 the directory configured at compile time by the BIN_DIRECTORY setting. It
15416 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15417 other place.
15418 &*Warning*&: Do not use a macro to define the value of this option, because
15419 you will break those Exim utilities that scan the configuration file to find
15420 where the binary is. (They then use the &%-bP%& option to extract option
15421 settings such as the value of &%spool_directory%&.)
15422
15423
15424 .option exim_user main string "compile-time configured"
15425 .cindex "uid (user id)" "Exim's own"
15426 .cindex "Exim user"
15427 This option changes the uid under which Exim runs when it gives up root
15428 privilege. The default value is compiled into the binary. Ownership of the run
15429 time configuration file and the use of the &%-C%& and &%-D%& command line
15430 options is checked against the values in the binary, not what is set here.
15431
15432 Unless it consists entirely of digits, the string is looked up using
15433 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15434 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15435 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15436
15437
15438 .option exim_version main string "current version"
15439 .cindex "Exim version"
15440 .cindex customizing "version number"
15441 .cindex "version number of Exim" override
15442 This option allows to override the &$version_number$&/&$exim_version$& Exim reports in
15443 various places.  Use with care, this may fool stupid security scanners.
15444
15445
15446 .option extra_local_interfaces main "string list" unset
15447 This option defines network interfaces that are to be considered local when
15448 routing, but which are not used for listening by the daemon. See section
15449 &<<SECTreclocipadd>>& for details.
15450
15451
15452 . Allow this long option name to split; give it unsplit as a fifth argument
15453 . for the automatic .oindex that is generated by .option.
15454
15455 .option "extract_addresses_remove_arguments" main boolean true &&&
15456          extract_addresses_remove_arguments
15457 .oindex "&%-t%&"
15458 .cindex "command line" "addresses with &%-t%&"
15459 .cindex "Sendmail compatibility" "&%-t%& option"
15460 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15461 are present on the command line when the &%-t%& option is used to build an
15462 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15463 line addresses are removed from the recipients list. This is also how Smail
15464 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15465 command line addresses are added to those obtained from the header lines. When
15466 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15467 argument headers. If it is set false, Exim adds rather than removes argument
15468 addresses.
15469
15470
15471 .option finduser_retries main integer 0
15472 .cindex "NIS, retrying user lookups"
15473 On systems running NIS or other schemes in which user and group information is
15474 distributed from a remote system, there can be times when &[getpwnam()]& and
15475 related functions fail, even when given valid data, because things time out.
15476 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15477 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15478 many extra times to find a user or a group, waiting for one second between
15479 retries.
15480
15481 .cindex "&_/etc/passwd_&" "multiple reading of"
15482 You should not set this option greater than zero if your user information is in
15483 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15484 search the file multiple times for non-existent users, and also cause delay.
15485
15486
15487
15488 .option freeze_tell main "string list, comma separated" unset
15489 .cindex "freezing messages" "sending a message when freezing"
15490 On encountering certain errors, or when configured to do so in a system filter,
15491 ACL, or special router, Exim freezes a message. This means that no further
15492 delivery attempts take place until an administrator thaws the message, or the
15493 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15494 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15495 warning message whenever it freezes something, unless the message it is
15496 freezing is a locally-generated bounce message. (Without this exception there
15497 is the possibility of looping.) The warning message is sent to the addresses
15498 supplied as the comma-separated value of this option. If several of the
15499 message's addresses cause freezing, only a single message is sent. If the
15500 freezing was automatic, the reason(s) for freezing can be found in the message
15501 log. If you configure freezing in a filter or ACL, you must arrange for any
15502 logging that you require.
15503
15504
15505 .option gecos_name main string&!! unset
15506 .cindex "HP-UX"
15507 .cindex "&""gecos""& field, parsing"
15508 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15509 password file to hold other information in addition to users' real names. Exim
15510 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15511 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15512 of the field are used unchanged, except that, if an ampersand is encountered,
15513 it is replaced by the user's login name with the first character forced to
15514 upper case, since this is a convention that is observed on many systems.
15515
15516 When these options are set, &%gecos_pattern%& is treated as a regular
15517 expression that is to be applied to the field (again with && replaced by the
15518 login name), and if it matches, &%gecos_name%& is expanded and used as the
15519 user's name.
15520
15521 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15522 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15523 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15524 name terminates at the first comma, the following can be used:
15525 .code
15526 gecos_pattern = ([^,]*)
15527 gecos_name = $1
15528 .endd
15529
15530 .option gecos_pattern main string unset
15531 See &%gecos_name%& above.
15532
15533
15534 .option gnutls_compat_mode main boolean unset
15535 This option controls whether GnuTLS is used in compatibility mode in an Exim
15536 server. This reduces security slightly, but improves interworking with older
15537 implementations of TLS.
15538
15539
15540 .option gnutls_allow_auto_pkcs11 main boolean unset
15541 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15542 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15543
15544 See
15545 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15546 for documentation.
15547
15548
15549
15550 .option headers_charset main string "see below"
15551 This option sets a default character set for translating from encoded MIME
15552 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15553 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15554 ultimate default is ISO-8859-1. For more details see the description of header
15555 insertions in section &<<SECTexpansionitems>>&.
15556
15557
15558
15559 .option header_maxsize main integer "see below"
15560 .cindex "header section" "maximum size of"
15561 .cindex "limit" "size of message header section"
15562 This option controls the overall maximum size of a message's header
15563 section. The default is the value of HEADER_MAXSIZE in
15564 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15565 sections are rejected.
15566
15567
15568 .option header_line_maxsize main integer 0
15569 .cindex "header lines" "maximum size of"
15570 .cindex "limit" "size of one header line"
15571 This option limits the length of any individual header line in a message, after
15572 all the continuations have been joined together. Messages with individual
15573 header lines that are longer than the limit are rejected. The default value of
15574 zero means &"no limit"&.
15575
15576
15577
15578
15579 .option helo_accept_junk_hosts main "host list&!!" unset
15580 .cindex "HELO" "accepting junk data"
15581 .cindex "EHLO" "accepting junk data"
15582 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15583 mail, and gives an error response for invalid data. Unfortunately, there are
15584 some SMTP clients that send syntactic junk. They can be accommodated by setting
15585 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15586 if you want to do semantic checking.
15587 See also &%helo_allow_chars%& for a way of extending the permitted character
15588 set.
15589
15590
15591 .option helo_allow_chars main string unset
15592 .cindex "HELO" "underscores in"
15593 .cindex "EHLO" "underscores in"
15594 .cindex "underscore in EHLO/HELO"
15595 This option can be set to a string of rogue characters that are permitted in
15596 all EHLO and HELO names in addition to the standard letters, digits,
15597 hyphens, and dots. If you really must allow underscores, you can set
15598 .code
15599 helo_allow_chars = _
15600 .endd
15601 Note that the value is one string, not a list.
15602
15603
15604 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15605 .cindex "HELO" "forcing reverse lookup"
15606 .cindex "EHLO" "forcing reverse lookup"
15607 If the domain given by a client in a HELO or EHLO command matches this
15608 list, a reverse lookup is done in order to establish the host's true name. The
15609 default forces a lookup if the client host gives the server's name or any of
15610 its IP addresses (in brackets), something that broken clients have been seen to
15611 do.
15612
15613
15614 .option helo_try_verify_hosts main "host list&!!" unset
15615 .cindex "HELO verifying" "optional"
15616 .cindex "EHLO" "verifying, optional"
15617 By default, Exim just checks the syntax of HELO and EHLO commands (see
15618 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15619 to do more extensive checking of the data supplied by these commands. The ACL
15620 condition &`verify = helo`& is provided to make this possible.
15621 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15622 to force the check to occur. From release 4.53 onwards, this is no longer
15623 necessary. If the check has not been done before &`verify = helo`& is
15624 encountered, it is done at that time. Consequently, this option is obsolete.
15625 Its specification is retained here for backwards compatibility.
15626
15627 When an EHLO or HELO command is received, if the calling host matches
15628 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15629 EHLO command either:
15630
15631 .ilist
15632 is an IP literal matching the calling address of the host, or
15633 .next
15634 .cindex "DNS" "reverse lookup"
15635 .cindex "reverse DNS lookup"
15636 matches the host name that Exim obtains by doing a reverse lookup of the
15637 calling host address, or
15638 .next
15639 when looked up in DNS yields the calling host address.
15640 .endlist
15641
15642 However, the EHLO or HELO command is not rejected if any of the checks
15643 fail. Processing continues, but the result of the check is remembered, and can
15644 be detected later in an ACL by the &`verify = helo`& condition.
15645
15646 If DNS was used for successful verification, the variable
15647 .cindex "DNS" "DNSSEC"
15648 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15649
15650 .option helo_verify_hosts main "host list&!!" unset
15651 .cindex "HELO verifying" "mandatory"
15652 .cindex "EHLO" "verifying, mandatory"
15653 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15654 backwards compatibility. For hosts that match this option, Exim checks the host
15655 name given in the HELO or EHLO in the same way as for
15656 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15657 rejected with a 550 error, and entries are written to the main and reject logs.
15658 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15659 error.
15660
15661 .option hold_domains main "domain list&!!" unset
15662 .cindex "domain" "delaying delivery"
15663 .cindex "delivery" "delaying certain domains"
15664 This option allows mail for particular domains to be held in the queue
15665 manually. The option is overridden if a message delivery is forced with the
15666 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15667 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15668 item in &%hold_domains%&, no routing or delivery for that address is done, and
15669 it is deferred every time the message is looked at.
15670
15671 This option is intended as a temporary operational measure for delaying the
15672 delivery of mail while some problem is being sorted out, or some new
15673 configuration tested. If you just want to delay the processing of some
15674 domains until a queue run occurs, you should use &%queue_domains%& or
15675 &%queue_smtp_domains%&, not &%hold_domains%&.
15676
15677 A setting of &%hold_domains%& does not override Exim's code for removing
15678 messages from the queue if they have been there longer than the longest retry
15679 time in any retry rule. If you want to hold messages for longer than the normal
15680 retry times, insert a dummy retry rule with a long retry time.
15681
15682
15683 .option host_lookup main "host list&!!" unset
15684 .cindex "host name" "lookup, forcing"
15685 Exim does not look up the name of a calling host from its IP address unless it
15686 is required to compare against some host list, or the host matches
15687 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15688 option (which normally contains IP addresses rather than host names). The
15689 default configuration file contains
15690 .code
15691 host_lookup = *
15692 .endd
15693 which causes a lookup to happen for all hosts. If the expense of these lookups
15694 is felt to be too great, the setting can be changed or removed.
15695
15696 After a successful reverse lookup, Exim does a forward lookup on the name it
15697 has obtained, to verify that it yields the IP address that it started with. If
15698 this check fails, Exim behaves as if the name lookup failed.
15699
15700 .vindex "&$host_lookup_failed$&"
15701 .vindex "&$sender_host_name$&"
15702 After any kind of failure, the host name (in &$sender_host_name$&) remains
15703 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15704 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15705 &`verify = reverse_host_lookup`& in ACLs.
15706
15707
15708 .option host_lookup_order main "string list" &`bydns:byaddr`&
15709 This option specifies the order of different lookup methods when Exim is trying
15710 to find a host name from an IP address. The default is to do a DNS lookup
15711 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15712 if that fails. You can change the order of these lookups, or omit one entirely,
15713 if you want.
15714
15715 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15716 multiple PTR records in the DNS and the IP address is not listed in
15717 &_/etc/hosts_&. Different operating systems give different results in this
15718 case. That is why the default tries a DNS lookup first.
15719
15720
15721
15722 .option host_reject_connection main "host list&!!" unset
15723 .cindex "host" "rejecting connections from"
15724 If this option is set, incoming SMTP calls from the hosts listed are rejected
15725 as soon as the connection is made.
15726 This option is obsolete, and retained only for backward compatibility, because
15727 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15728 connections immediately.
15729
15730 The ability to give an immediate rejection (either by this option or using an
15731 ACL) is provided for use in unusual cases. Many hosts will just try again,
15732 sometimes without much delay. Normally, it is better to use an ACL to reject
15733 incoming messages at a later stage, such as after RCPT commands. See
15734 chapter &<<CHAPACL>>&.
15735
15736
15737 .option hosts_connection_nolog main "host list&!!" unset
15738 .cindex "host" "not logging connections from"
15739 This option defines a list of hosts for which connection logging does not
15740 happen, even though the &%smtp_connection%& log selector is set. For example,
15741 you might want not to log SMTP connections from local processes, or from
15742 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15743 the daemon; you should therefore strive to restrict its value to a short inline
15744 list of IP addresses and networks. To disable logging SMTP connections from
15745 local processes, you must create a host list with an empty item. For example:
15746 .code
15747 hosts_connection_nolog = :
15748 .endd
15749 If the &%smtp_connection%& log selector is not set, this option has no effect.
15750
15751
15752
15753 .option hosts_proxy main "host list&!!" unset
15754 .cindex proxy "proxy protocol"
15755 This option enables use of Proxy Protocol proxies for incoming
15756 connections.  For details see section &<<SECTproxyInbound>>&.
15757
15758
15759 .option hosts_treat_as_local main "domain list&!!" unset
15760 .cindex "local host" "domains treated as"
15761 .cindex "host" "treated as local"
15762 If this option is set, any host names that match the domain list are treated as
15763 if they were the local host when Exim is scanning host lists obtained from MX
15764 records
15765 or other sources. Note that the value of this option is a domain list, not a
15766 host list, because it is always used to check host names, not IP addresses.
15767
15768 This option also applies when Exim is matching the special items
15769 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15770 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15771 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15772 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15773 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15774 interfaces and recognizing the local host.
15775
15776
15777 .option ibase_servers main "string list" unset
15778 .cindex "InterBase" "server list"
15779 This option provides a list of InterBase servers and associated connection data,
15780 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15781 The option is available only if Exim has been built with InterBase support.
15782
15783
15784
15785 .option ignore_bounce_errors_after main time 10w
15786 .cindex "bounce message" "discarding"
15787 .cindex "discarding bounce message"
15788 This option affects the processing of bounce messages that cannot be delivered,
15789 that is, those that suffer a permanent delivery failure. (Bounce messages that
15790 suffer temporary delivery failures are of course retried in the usual way.)
15791
15792 After a permanent delivery failure, bounce messages are frozen,
15793 because there is no sender to whom they can be returned. When a frozen bounce
15794 message has been in the queue for more than the given time, it is unfrozen at
15795 the next queue run, and a further delivery is attempted. If delivery fails
15796 again, the bounce message is discarded. This makes it possible to keep failed
15797 bounce messages around for a shorter time than the normal maximum retry time
15798 for frozen messages. For example,
15799 .code
15800 ignore_bounce_errors_after = 12h
15801 .endd
15802 retries failed bounce message deliveries after 12 hours, discarding any further
15803 failures. If the value of this option is set to a zero time period, bounce
15804 failures are discarded immediately. Setting a very long time (as in the default
15805 value) has the effect of disabling this option. For ways of automatically
15806 dealing with other kinds of frozen message, see &%auto_thaw%& and
15807 &%timeout_frozen_after%&.
15808
15809
15810 .option ignore_fromline_hosts main "host list&!!" unset
15811 .cindex "&""From""& line"
15812 .cindex "UUCP" "&""From""& line"
15813 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15814 the headers of a message. By default this is treated as the start of the
15815 message's body, which means that any following headers are not recognized as
15816 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15817 match those hosts that insist on sending it. If the sender is actually a local
15818 process rather than a remote host, and is using &%-bs%& to inject the messages,
15819 &%ignore_fromline_local%& must be set to achieve this effect.
15820
15821
15822 .option ignore_fromline_local main boolean false
15823 See &%ignore_fromline_hosts%& above.
15824
15825 .option keep_environment main "string list" unset
15826 .cindex "environment" "values from"
15827 This option contains a string list of environment variables to keep.
15828 You have to trust these variables or you have to be sure that
15829 these variables do not impose any security risk. Keep in mind that
15830 during the startup phase Exim is running with an effective UID 0 in most
15831 installations. As the default value is an empty list, the default
15832 environment for using libraries, running embedded Perl code, or running
15833 external binaries is empty, and does not not even contain PATH or HOME.
15834
15835 Actually the list is interpreted as a list of patterns
15836 (&<<SECTlistexpand>>&), except that it is not expanded first.
15837
15838 WARNING: Macro substitution is still done first, so having a macro
15839 FOO and having FOO_HOME in your &%keep_environment%& option may have
15840 unexpected results. You may work around this using a regular expression
15841 that does not match the macro name: ^[F]OO_HOME$.
15842
15843 Current versions of Exim issue a warning during startup if you do not mention
15844 &%keep_environment%& in your runtime configuration file and if your
15845 current environment is not empty. Future versions may not issue that warning
15846 anymore.
15847
15848 See the &%add_environment%& main config option for a way to set
15849 environment variables to a fixed value.  The environment for &(pipe)&
15850 transports is handled separately, see section &<<SECTpipeenv>>& for
15851 details.
15852
15853
15854 .option keep_malformed main time 4d
15855 This option specifies the length of time to keep messages whose spool files
15856 have been corrupted in some way. This should, of course, never happen. At the
15857 next attempt to deliver such a message, it gets removed. The incident is
15858 logged.
15859
15860
15861 .option ldap_ca_cert_dir main string unset
15862 .cindex "LDAP", "TLS CA certificate directory"
15863 .cindex certificate "directory for LDAP"
15864 This option indicates which directory contains CA certificates for verifying
15865 a TLS certificate presented by an LDAP server.
15866 While Exim does not provide a default value, your SSL library may.
15867 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15868 and constrained to be a directory.
15869
15870
15871 .option ldap_ca_cert_file main string unset
15872 .cindex "LDAP", "TLS CA certificate file"
15873 .cindex certificate "file for LDAP"
15874 This option indicates which file contains CA certificates for verifying
15875 a TLS certificate presented by an LDAP server.
15876 While Exim does not provide a default value, your SSL library may.
15877 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15878 and constrained to be a file.
15879
15880
15881 .option ldap_cert_file main string unset
15882 .cindex "LDAP" "TLS client certificate file"
15883 .cindex certificate "file for LDAP"
15884 This option indicates which file contains an TLS client certificate which
15885 Exim should present to the LDAP server during TLS negotiation.
15886 Should be used together with &%ldap_cert_key%&.
15887
15888
15889 .option ldap_cert_key main string unset
15890 .cindex "LDAP" "TLS client key file"
15891 .cindex certificate "key for LDAP"
15892 This option indicates which file contains the secret/private key to use
15893 to prove identity to the LDAP server during TLS negotiation.
15894 Should be used together with &%ldap_cert_file%&, which contains the
15895 identity to be proven.
15896
15897
15898 .option ldap_cipher_suite main string unset
15899 .cindex "LDAP" "TLS cipher suite"
15900 This controls the TLS cipher-suite negotiation during TLS negotiation with
15901 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15902 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15903
15904
15905 .option ldap_default_servers main "string list" unset
15906 .cindex "LDAP" "default servers"
15907 This option provides a list of LDAP servers which are tried in turn when an
15908 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15909 details of LDAP queries. This option is available only when Exim has been built
15910 with LDAP support.
15911
15912
15913 .option ldap_require_cert main string unset.
15914 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15915 This should be one of the values "hard", "demand", "allow", "try" or "never".
15916 A value other than one of these is interpreted as "never".
15917 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15918 Although Exim does not set a default, the LDAP library probably defaults
15919 to hard/demand.
15920
15921
15922 .option ldap_start_tls main boolean false
15923 .cindex "LDAP" "whether or not to negotiate TLS"
15924 If set, Exim will attempt to negotiate TLS with the LDAP server when
15925 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15926 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15927 of SSL-on-connect.
15928 In the event of failure to negotiate TLS, the action taken is controlled
15929 by &%ldap_require_cert%&.
15930 This option is ignored for &`ldapi`& connections.
15931
15932
15933 .option ldap_version main integer unset
15934 .cindex "LDAP" "protocol version, forcing"
15935 This option can be used to force Exim to set a specific protocol version for
15936 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15937 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15938 the LDAP headers; otherwise it is 2. This option is available only when Exim
15939 has been built with LDAP support.
15940
15941
15942
15943 .option local_from_check main boolean true
15944 .cindex "&'Sender:'& header line" "disabling addition of"
15945 .cindex "&'From:'& header line" "disabling checking of"
15946 When a message is submitted locally (that is, not over a TCP/IP connection) by
15947 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15948 checks that the &'From:'& header line matches the login of the calling user and
15949 the domain specified by &%qualify_domain%&.
15950
15951 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15952 locally submitted message is automatically qualified by Exim, unless the
15953 &%-bnq%& command line option is used.
15954
15955 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15956 on the local part. If the &'From:'& header line does not match, Exim adds a
15957 &'Sender:'& header with an address constructed from the calling user's login
15958 and the default qualify domain.
15959
15960 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15961 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15962 &'Sender:'& header lines supplied by untrusted users, you must also set
15963 &%local_sender_retain%& to be true.
15964
15965 .cindex "envelope from"
15966 .cindex "envelope sender"
15967 These options affect only the header lines in the message. The envelope sender
15968 is still forced to be the login id at the qualify domain unless
15969 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15970
15971 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15972 request similar header line checking. See section &<<SECTthesenhea>>&, which
15973 has more details about &'Sender:'& processing.
15974
15975
15976
15977
15978 .option local_from_prefix main string unset
15979 When Exim checks the &'From:'& header line of locally submitted messages for
15980 matching the login id (see &%local_from_check%& above), it can be configured to
15981 ignore certain prefixes and suffixes in the local part of the address. This is
15982 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15983 appropriate lists, in the same form as the &%local_part_prefix%& and
15984 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15985 example, if
15986 .code
15987 local_from_prefix = *-
15988 .endd
15989 is set, a &'From:'& line containing
15990 .code
15991 From: anything-user@your.domain.example
15992 .endd
15993 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15994 matches the actual sender address that is constructed from the login name and
15995 qualify domain.
15996
15997
15998 .option local_from_suffix main string unset
15999 See &%local_from_prefix%& above.
16000
16001
16002 .option local_interfaces main "string list" "see below"
16003 This option controls which network interfaces are used by the daemon for
16004 listening; they are also used to identify the local host when routing. Chapter
16005 &<<CHAPinterfaces>>& contains a full description of this option and the related
16006 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16007 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16008 &%local_interfaces%& is
16009 .code
16010 local_interfaces = 0.0.0.0
16011 .endd
16012 when Exim is built without IPv6 support; otherwise it is
16013 .code
16014 local_interfaces = <; ::0 ; 0.0.0.0
16015 .endd
16016
16017 .option local_scan_timeout main time 5m
16018 .cindex "timeout" "for &[local_scan()]& function"
16019 .cindex "&[local_scan()]& function" "timeout"
16020 This timeout applies to the &[local_scan()]& function (see chapter
16021 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16022 the incoming message is rejected with a temporary error if it is an SMTP
16023 message. For a non-SMTP message, the message is dropped and Exim ends with a
16024 non-zero code. The incident is logged on the main and reject logs.
16025
16026
16027
16028 .option local_sender_retain main boolean false
16029 .cindex "&'Sender:'& header line" "retaining from local submission"
16030 When a message is submitted locally (that is, not over a TCP/IP connection) by
16031 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16032 do not want this to happen, you must set &%local_sender_retain%&, and you must
16033 also set &%local_from_check%& to be false (Exim will complain if you do not).
16034 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16035 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16036
16037
16038
16039
16040 .option localhost_number main string&!! unset
16041 .cindex "host" "locally unique number for"
16042 .cindex "message ids" "with multiple hosts"
16043 .vindex "&$localhost_number$&"
16044 Exim's message ids are normally unique only within the local host. If
16045 uniqueness among a set of hosts is required, each host must set a different
16046 value for the &%localhost_number%& option. The string is expanded immediately
16047 after reading the configuration file (so that a number can be computed from the
16048 host name, for example) and the result of the expansion must be a number in the
16049 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16050 systems). This is available in subsequent string expansions via the variable
16051 &$localhost_number$&. When &%localhost_number is set%&, the final two
16052 characters of the message id, instead of just being a fractional part of the
16053 time, are computed from the time and the local host number as described in
16054 section &<<SECTmessiden>>&.
16055
16056
16057
16058 .option log_file_path main "string list&!!" "set at compile time"
16059 .cindex "log" "file path for"
16060 This option sets the path which is used to determine the names of Exim's log
16061 files, or indicates that logging is to be to syslog, or both. It is expanded
16062 when Exim is entered, so it can, for example, contain a reference to the host
16063 name. If no specific path is set for the log files at compile or runtime,
16064 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16065 they are written in a sub-directory called &_log_& in Exim's spool directory.
16066 .new
16067 A path must start with a slash.
16068 To send to syslog, use the word &"syslog"&.
16069 .wen
16070 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16071 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16072 used. If this string is fixed at your installation (contains no expansion
16073 variables) it is recommended that you do not set this option in the
16074 configuration file, but instead supply the path using LOG_FILE_PATH in
16075 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16076 early on &-- in particular, failure to read the configuration file.
16077
16078
16079 .option log_selector main string unset
16080 .cindex "log" "selectors"
16081 This option can be used to reduce or increase the number of things that Exim
16082 writes to its log files. Its argument is made up of names preceded by plus or
16083 minus characters. For example:
16084 .code
16085 log_selector = +arguments -retry_defer
16086 .endd
16087 A list of possible names and what they control is given in the chapter on
16088 logging, in section &<<SECTlogselector>>&.
16089
16090
16091 .option log_timezone main boolean false
16092 .cindex "log" "timezone for entries"
16093 .vindex "&$tod_log$&"
16094 .vindex "&$tod_zone$&"
16095 By default, the timestamps on log lines are in local time without the
16096 timezone. This means that if your timezone changes twice a year, the timestamps
16097 in log lines are ambiguous for an hour when the clocks go back. One way of
16098 avoiding this problem is to set the timezone to UTC. An alternative is to set
16099 &%log_timezone%& true. This turns on the addition of the timezone offset to
16100 timestamps in log lines. Turning on this option can add quite a lot to the size
16101 of log files because each line is extended by 6 characters. Note that the
16102 &$tod_log$& variable contains the log timestamp without the zone, but there is
16103 another variable called &$tod_zone$& that contains just the timezone offset.
16104
16105
16106 .option lookup_open_max main integer 25
16107 .cindex "too many open files"
16108 .cindex "open files, too many"
16109 .cindex "file" "too many open"
16110 .cindex "lookup" "maximum open files"
16111 .cindex "limit" "open files for lookups"
16112 This option limits the number of simultaneously open files for single-key
16113 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16114 Exim normally keeps these files open during routing, because often the same
16115 file is required several times. If the limit is reached, Exim closes the least
16116 recently used file. Note that if you are using the &'ndbm'& library, it
16117 actually opens two files for each logical DBM database, though it still counts
16118 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16119 open files"& errors with NDBM, you need to reduce the value of
16120 &%lookup_open_max%&.
16121
16122
16123 .option max_username_length main integer 0
16124 .cindex "length of login name"
16125 .cindex "user name" "maximum length"
16126 .cindex "limit" "user name length"
16127 Some operating systems are broken in that they truncate long arguments to
16128 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16129 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16130 an argument that is longer behaves as if &[getpwnam()]& failed.
16131
16132
16133 .option message_body_newlines main bool false
16134 .cindex "message body" "newlines in variables"
16135 .cindex "newline" "in message body variables"
16136 .vindex "&$message_body$&"
16137 .vindex "&$message_body_end$&"
16138 By default, newlines in the message body are replaced by spaces when setting
16139 the &$message_body$& and &$message_body_end$& expansion variables. If this
16140 option is set true, this no longer happens.
16141
16142
16143 .option message_body_visible main integer 500
16144 .cindex "body of message" "visible size"
16145 .cindex "message body" "visible size"
16146 .vindex "&$message_body$&"
16147 .vindex "&$message_body_end$&"
16148 This option specifies how much of a message's body is to be included in the
16149 &$message_body$& and &$message_body_end$& expansion variables.
16150
16151
16152 .option message_id_header_domain main string&!! unset
16153 .cindex "&'Message-ID:'& header line"
16154 If this option is set, the string is expanded and used as the right hand side
16155 (domain) of the &'Message-ID:'& header that Exim creates if a
16156 locally-originated incoming message does not have one. &"Locally-originated"&
16157 means &"not received over TCP/IP."&
16158 Otherwise, the primary host name is used.
16159 Only letters, digits, dot and hyphen are accepted; any other characters are
16160 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16161 empty string, the option is ignored.
16162
16163
16164 .option message_id_header_text main string&!! unset
16165 If this variable is set, the string is expanded and used to augment the text of
16166 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16167 message does not have one. The text of this header is required by RFC 2822 to
16168 take the form of an address. By default, Exim uses its internal message id as
16169 the local part, and the primary host name as the domain. If this option is set,
16170 it is expanded, and provided the expansion is not forced to fail, and does not
16171 yield an empty string, the result is inserted into the header immediately
16172 before the @, separated from the internal message id by a dot. Any characters
16173 that are illegal in an address are automatically converted into hyphens. This
16174 means that variables such as &$tod_log$& can be used, because the spaces and
16175 colons will become hyphens.
16176
16177
16178 .option message_logs main boolean true
16179 .cindex "message logs" "disabling"
16180 .cindex "log" "message log; disabling"
16181 If this option is turned off, per-message log files are not created in the
16182 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16183 Exim, by reducing the number of files involved in handling a message from a
16184 minimum of four (header spool file, body spool file, delivery journal, and
16185 per-message log) to three. The other major I/O activity is Exim's main log,
16186 which is not affected by this option.
16187
16188
16189 .option message_size_limit main string&!! 50M
16190 .cindex "message" "size limit"
16191 .cindex "limit" "message size"
16192 .cindex "size" "of message, limit"
16193 This option limits the maximum size of message that Exim will process. The
16194 value is expanded for each incoming connection so, for example, it can be made
16195 to depend on the IP address of the remote host for messages arriving via
16196 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16197 optionally followed by K or M.
16198
16199 &*Note*&: This limit cannot be made to depend on a message's sender or any
16200 other properties of an individual message, because it has to be advertised in
16201 the server's response to EHLO. String expansion failure causes a temporary
16202 error. A value of zero means no limit, but its use is not recommended. See also
16203 &%bounce_return_size_limit%&.
16204
16205 Incoming SMTP messages are failed with a 552 error if the limit is
16206 exceeded; locally-generated messages either get a stderr message or a delivery
16207 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16208 an oversized message is logged in both the main and the reject logs. See also
16209 the generic transport option &%message_size_limit%&, which limits the size of
16210 message that an individual transport can process.
16211
16212 If you use a virus-scanner and set this option to to a value larger than the
16213 maximum size that your virus-scanner is configured to support, you may get
16214 failures triggered by large mails.  The right size to configure for the
16215 virus-scanner depends upon what data is passed and the options in use but it's
16216 probably safest to just set it to a little larger than this value.  E.g., with a
16217 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16218 some problems may result.
16219
16220 A value of 0 will disable size limit checking; Exim will still advertise the
16221 SIZE extension in an EHLO response, but without a limit, so as to permit
16222 SMTP clients to still indicate the message size along with the MAIL verb.
16223
16224
16225 .option move_frozen_messages main boolean false
16226 .cindex "frozen messages" "moving"
16227 This option, which is available only if Exim has been built with the setting
16228 .code
16229 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16230 .endd
16231 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16232 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16233 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16234 standard utilities for handling such moved messages, and they do not show up in
16235 lists generated by &%-bp%& or by the Exim monitor.
16236
16237
16238 .option mua_wrapper main boolean false
16239 Setting this option true causes Exim to run in a very restrictive mode in which
16240 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16241 contains a full description of this facility.
16242
16243
16244
16245 .option mysql_servers main "string list" unset
16246 .cindex "MySQL" "server list"
16247 This option provides a list of MySQL servers and associated connection data, to
16248 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16249 option is available only if Exim has been built with MySQL support.
16250
16251
16252 .option never_users main "string list&!!" unset
16253 This option is expanded just once, at the start of Exim's processing. Local
16254 message deliveries are normally run in processes that are setuid to the
16255 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16256 It is usually desirable to prevent any deliveries from running as root, as a
16257 safety precaution.
16258
16259 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16260 list of users that must not be used for local deliveries. This list is fixed in
16261 the binary and cannot be overridden by the configuration file. By default, it
16262 contains just the single user name &"root"&. The &%never_users%& runtime option
16263 can be used to add more users to the fixed list.
16264
16265 If a message is to be delivered as one of the users on the fixed list or the
16266 &%never_users%& list, an error occurs, and delivery is deferred. A common
16267 example is
16268 .code
16269 never_users = root:daemon:bin
16270 .endd
16271 Including root is redundant if it is also on the fixed list, but it does no
16272 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16273 transport driver.
16274
16275
16276 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket"
16277 .cindex "OpenSSL "compatibility options"
16278 This option allows an administrator to adjust the SSL options applied
16279 by OpenSSL to connections.  It is given as a space-separated list of items,
16280 each one to be +added or -subtracted from the current value.
16281
16282 This option is only available if Exim is built against OpenSSL.  The values
16283 available for this option vary according to the age of your OpenSSL install.
16284 The &"all"& value controls a subset of flags which are available, typically
16285 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16286 list the values known on your system and Exim should support all the
16287 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16288 names lose the leading &"SSL_OP_"& and are lower-cased.
16289
16290 Note that adjusting the options can have severe impact upon the security of
16291 SSL as used by Exim.  It is possible to disable safety checks and shoot
16292 yourself in the foot in various unpleasant ways.  This option should not be
16293 adjusted lightly.  An unrecognised item will be detected at startup, by
16294 invoking Exim with the &%-bV%& flag.
16295
16296 The option affects Exim operating both as a server and as a client.
16297
16298 Historical note: prior to release 4.80, Exim defaulted this value to
16299 "+dont_insert_empty_fragments", which may still be needed for compatibility
16300 with some clients, but which lowers security by increasing exposure to
16301 some now infamous attacks.
16302
16303 Examples:
16304 .code
16305 # Make both old MS and old Eudora happy:
16306 openssl_options = -all +microsoft_big_sslv3_buffer \
16307                        +dont_insert_empty_fragments
16308
16309 # Disable older protocol versions:
16310 openssl_options = +no_sslv2 +no_sslv3
16311 .endd
16312
16313 Possible options may include:
16314 .ilist
16315 &`all`&
16316 .next
16317 &`allow_unsafe_legacy_renegotiation`&
16318 .next
16319 &`cipher_server_preference`&
16320 .next
16321 &`dont_insert_empty_fragments`&
16322 .next
16323 &`ephemeral_rsa`&
16324 .next
16325 &`legacy_server_connect`&
16326 .next
16327 &`microsoft_big_sslv3_buffer`&
16328 .next
16329 &`microsoft_sess_id_bug`&
16330 .next
16331 &`msie_sslv2_rsa_padding`&
16332 .next
16333 &`netscape_challenge_bug`&
16334 .next
16335 &`netscape_reuse_cipher_change_bug`&
16336 .next
16337 &`no_compression`&
16338 .next
16339 &`no_session_resumption_on_renegotiation`&
16340 .next
16341 &`no_sslv2`&
16342 .next
16343 &`no_sslv3`&
16344 .next
16345 &`no_ticket`&
16346 .next
16347 &`no_tlsv1`&
16348 .next
16349 &`no_tlsv1_1`&
16350 .next
16351 &`no_tlsv1_2`&
16352 .next
16353 &`safari_ecdhe_ecdsa_bug`&
16354 .next
16355 &`single_dh_use`&
16356 .next
16357 &`single_ecdh_use`&
16358 .next
16359 &`ssleay_080_client_dh_bug`&
16360 .next
16361 &`sslref2_reuse_cert_type_bug`&
16362 .next
16363 &`tls_block_padding_bug`&
16364 .next
16365 &`tls_d5_bug`&
16366 .next
16367 &`tls_rollback_bug`&
16368 .endlist
16369
16370 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16371 all clients connecting using the MacOS SecureTransport TLS facility prior
16372 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16373 to negotiate TLS then this option value might help, provided that your OpenSSL
16374 release is new enough to contain this work-around.  This may be a situation
16375 where you have to upgrade OpenSSL to get buggy clients working.
16376
16377
16378 .option oracle_servers main "string list" unset
16379 .cindex "Oracle" "server list"
16380 This option provides a list of Oracle servers and associated connection data,
16381 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16382 The option is available only if Exim has been built with Oracle support.
16383
16384
16385 .option percent_hack_domains main "domain list&!!" unset
16386 .cindex "&""percent hack""&"
16387 .cindex "source routing" "in email address"
16388 .cindex "address" "source-routed"
16389 The &"percent hack"& is the convention whereby a local part containing a
16390 percent sign is re-interpreted as a new email address, with the percent
16391 replaced by @. This is sometimes called &"source routing"&, though that term is
16392 also applied to RFC 2822 addresses that begin with an @ character. If this
16393 option is set, Exim implements the percent facility for those domains listed,
16394 but no others. This happens before an incoming SMTP address is tested against
16395 an ACL.
16396
16397 &*Warning*&: The &"percent hack"& has often been abused by people who are
16398 trying to get round relaying restrictions. For this reason, it is best avoided
16399 if at all possible. Unfortunately, a number of less security-conscious MTAs
16400 implement it unconditionally. If you are running Exim on a gateway host, and
16401 routing mail through to internal MTAs without processing the local parts, it is
16402 a good idea to reject recipient addresses with percent characters in their
16403 local parts. Exim's default configuration does this.
16404
16405
16406 .option perl_at_start main boolean false
16407 .cindex "Perl"
16408 This option is available only when Exim is built with an embedded Perl
16409 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16410
16411
16412 .option perl_startup main string unset
16413 .cindex "Perl"
16414 This option is available only when Exim is built with an embedded Perl
16415 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16416
16417 .option perl_startup main boolean false
16418 .cindex "Perl"
16419 This Option enables the taint mode of the embedded Perl interpreter.
16420
16421
16422 .option pgsql_servers main "string list" unset
16423 .cindex "PostgreSQL lookup type" "server list"
16424 This option provides a list of PostgreSQL servers and associated connection
16425 data, to be used in conjunction with &(pgsql)& lookups (see section
16426 &<<SECID72>>&). The option is available only if Exim has been built with
16427 PostgreSQL support.
16428
16429
16430 .option pid_file_path main string&!! "set at compile time"
16431 .cindex "daemon" "pid file path"
16432 .cindex "pid file, path for"
16433 This option sets the name of the file to which the Exim daemon writes its
16434 process id. The string is expanded, so it can contain, for example, references
16435 to the host name:
16436 .code
16437 pid_file_path = /var/log/$primary_hostname/exim.pid
16438 .endd
16439 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16440 spool directory.
16441 The value set by the option can be overridden by the &%-oP%& command line
16442 option. A pid file is not written if a &"non-standard"& daemon is run by means
16443 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16444
16445
16446 .option pipelining_advertise_hosts main "host list&!!" *
16447 .cindex "PIPELINING" "suppressing advertising"
16448 This option can be used to suppress the advertisement of the SMTP
16449 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16450 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16451 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16452 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16453 that clients will use it; &"out of order"& commands that are &"expected"& do
16454 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16455
16456 .new
16457 .option pipelining_connect_advertise_hosts main "host list&!!" *
16458 .cindex "pipelining" "early connection"
16459 .cindex "pipelining" PIPE_CONNECT
16460 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16461 this option controls which hosts the facility is advertised to
16462 and from which pipeline early-connection (before MAIL) SMTP
16463 commands are acceptable.
16464 When used, the pipelining saves on roundtrip times.
16465
16466 See also the &%hosts_pipe_connect%& smtp transport option.
16467
16468 Currently the option name &"X_PIPE_CONNECT"& is used.
16469 .wen
16470
16471
16472 .option prdr_enable main boolean false
16473 .cindex "PRDR" "enabling on server"
16474 This option can be used to enable the Per-Recipient Data Response extension
16475 to SMTP, defined by Eric Hall.
16476 If the option is set, PRDR is advertised by Exim when operating as a server.
16477 If the client requests PRDR, and more than one recipient, for a message
16478 an additional ACL is called for each recipient after the message content
16479 is received.  See section &<<SECTPRDRACL>>&.
16480
16481 .option preserve_message_logs main boolean false
16482 .cindex "message logs" "preserving"
16483 If this option is set, message log files are not deleted when messages are
16484 completed. Instead, they are moved to a sub-directory of the spool directory
16485 called &_msglog.OLD_&, where they remain available for statistical or debugging
16486 purposes. This is a dangerous option to set on systems with any appreciable
16487 volume of mail. Use with care!
16488
16489
16490 .option primary_hostname main string "see below"
16491 .cindex "name" "of local host"
16492 .cindex "host" "name of local"
16493 .cindex "local host" "name of"
16494 .vindex "&$primary_hostname$&"
16495 This specifies the name of the current host. It is used in the default EHLO or
16496 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16497 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16498 The value is also used by default in some SMTP response messages from an Exim
16499 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16500
16501 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16502 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16503 contains only one component, Exim passes it to &[gethostbyname()]& (or
16504 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16505 version. The variable &$primary_hostname$& contains the host name, whether set
16506 explicitly by this option, or defaulted.
16507
16508
16509 .option print_topbitchars main boolean false
16510 .cindex "printing characters"
16511 .cindex "8-bit characters"
16512 By default, Exim considers only those characters whose codes lie in the range
16513 32&--126 to be printing characters. In a number of circumstances (for example,
16514 when writing log entries) non-printing characters are converted into escape
16515 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16516 is set, code values of 128 and above are also considered to be printing
16517 characters.
16518
16519 This option also affects the header syntax checks performed by the
16520 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16521 the user's full name when constructing From: and Sender: addresses (as
16522 described in section &<<SECTconstr>>&). Setting this option can cause
16523 Exim to generate eight bit message headers that do not conform to the
16524 standards.
16525
16526
16527 .option process_log_path main string unset
16528 .cindex "process log path"
16529 .cindex "log" "process log"
16530 .cindex "&'exiwhat'&"
16531 This option sets the name of the file to which an Exim process writes its
16532 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16533 utility script. If this option is unset, the file called &_exim-process.info_&
16534 in Exim's spool directory is used. The ability to specify the name explicitly
16535 can be useful in environments where two different Exims are running, using
16536 different spool directories.
16537
16538
16539 .option prod_requires_admin main boolean true
16540 .cindex "restricting access to features"
16541 .oindex "&%-M%&"
16542 .oindex "&%-R%&"
16543 .oindex "&%-q%&"
16544 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16545 admin user unless &%prod_requires_admin%& is set false. See also
16546 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16547
16548
16549 .option qualify_domain main string "see below"
16550 .cindex "domain" "for qualifying addresses"
16551 .cindex "address" "qualification"
16552 This option specifies the domain name that is added to any envelope sender
16553 addresses that do not have a domain qualification. It also applies to
16554 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16555 are accepted by default only for locally-generated messages. Qualification is
16556 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16557 locally-generated messages, unless the &%-bnq%& command line option is used.
16558
16559 Messages from external sources must always contain fully qualified addresses,
16560 unless the sending host matches &%sender_unqualified_hosts%& or
16561 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16562 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16563 necessary. Internally, Exim always works with fully qualified envelope
16564 addresses. If &%qualify_domain%& is not set, it defaults to the
16565 &%primary_hostname%& value.
16566
16567
16568 .option qualify_recipient main string "see below"
16569 This option allows you to specify a different domain for qualifying recipient
16570 addresses to the one that is used for senders. See &%qualify_domain%& above.
16571
16572
16573
16574 .option queue_domains main "domain list&!!" unset
16575 .cindex "domain" "specifying non-immediate delivery"
16576 .cindex "queueing incoming messages"
16577 .cindex "message" "queueing certain domains"
16578 This option lists domains for which immediate delivery is not required.
16579 A delivery process is started whenever a message is received, but only those
16580 domains that do not match are processed. All other deliveries wait until the
16581 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16582
16583
16584 .option queue_list_requires_admin main boolean true
16585 .cindex "restricting access to features"
16586 .oindex "&%-bp%&"
16587 The &%-bp%& command-line option, which lists the messages that are on the
16588 queue, requires the caller to be an admin user unless
16589 &%queue_list_requires_admin%& is set false.
16590 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16591
16592
16593 .option queue_only main boolean false
16594 .cindex "queueing incoming messages"
16595 .cindex "message" "queueing unconditionally"
16596 If &%queue_only%& is set, a delivery process is not automatically started
16597 whenever a message is received. Instead, the message waits in the queue for the
16598 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16599 delivered immediately when certain conditions (such as heavy load) occur.
16600
16601 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16602 and &%-odi%& command line options override &%queue_only%& unless
16603 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16604 &%queue_only_load%&, and &%smtp_accept_queue%&.
16605
16606
16607 .option queue_only_file main string unset
16608 .cindex "queueing incoming messages"
16609 .cindex "message" "queueing by file existence"
16610 This option can be set to a colon-separated list of absolute path names, each
16611 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16612 it tests for the existence of each listed path using a call to &[stat()]&. For
16613 each path that exists, the corresponding queueing option is set.
16614 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16615 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16616 .code
16617 queue_only_file = smtp/some/file
16618 .endd
16619 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16620 &_/some/file_& exists.
16621
16622
16623 .option queue_only_load main fixed-point unset
16624 .cindex "load average"
16625 .cindex "queueing incoming messages"
16626 .cindex "message" "queueing by load"
16627 If the system load average is higher than this value, incoming messages from
16628 all sources are queued, and no automatic deliveries are started. If this
16629 happens during local or remote SMTP input, all subsequent messages received on
16630 the same SMTP connection are queued by default, whatever happens to the load in
16631 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16632 false.
16633
16634 Deliveries will subsequently be performed by queue runner processes. This
16635 option has no effect on ancient operating systems on which Exim cannot
16636 determine the load average. See also &%deliver_queue_load_max%& and
16637 &%smtp_load_reserve%&.
16638
16639
16640 .option queue_only_load_latch main boolean true
16641 .cindex "load average" "re-evaluating per message"
16642 When this option is true (the default), once one message has been queued
16643 because the load average is higher than the value set by &%queue_only_load%&,
16644 all subsequent messages received on the same SMTP connection are also queued.
16645 This is a deliberate choice; even though the load average may fall below the
16646 threshold, it doesn't seem right to deliver later messages on the same
16647 connection when not delivering earlier ones. However, there are special
16648 circumstances such as very long-lived connections from scanning appliances
16649 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16650 should be set false. This causes the value of the load average to be
16651 re-evaluated for each message.
16652
16653
16654 .option queue_only_override main boolean true
16655 .cindex "queueing incoming messages"
16656 When this option is true, the &%-od%&&'x'& command line options override the
16657 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16658 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16659 to override; they are accepted, but ignored.
16660
16661
16662 .option queue_run_in_order main boolean false
16663 .cindex "queue runner" "processing messages in order"
16664 If this option is set, queue runs happen in order of message arrival instead of
16665 in an arbitrary order. For this to happen, a complete list of the entire queue
16666 must be set up before the deliveries start. When the queue is all held in a
16667 single directory (the default), a single list is created for both the ordered
16668 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16669 single list is not created when &%queue_run_in_order%& is false. In this case,
16670 the sub-directories are processed one at a time (in a random order), and this
16671 avoids setting up one huge list for the whole queue. Thus, setting
16672 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16673 when the queue is large, because of the extra work in setting up the single,
16674 large list. In most situations, &%queue_run_in_order%& should not be set.
16675
16676
16677
16678 .option queue_run_max main integer&!! 5
16679 .cindex "queue runner" "maximum number of"
16680 This controls the maximum number of queue runner processes that an Exim daemon
16681 can run simultaneously. This does not mean that it starts them all at once,
16682 but rather that if the maximum number are still running when the time comes to
16683 start another one, it refrains from starting another one. This can happen with
16684 very large queues and/or very sluggish deliveries. This option does not,
16685 however, interlock with other processes, so additional queue runners can be
16686 started by other means, or by killing and restarting the daemon.
16687
16688 Setting this option to zero does not suppress queue runs; rather, it disables
16689 the limit, allowing any number of simultaneous queue runner processes to be
16690 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16691 the daemon's command line.
16692
16693 .cindex queues named
16694 .cindex "named queues"
16695 To set limits for different named queues use
16696 an expansion depending on the &$queue_name$& variable.
16697
16698 .option queue_smtp_domains main "domain list&!!" unset
16699 .cindex "queueing incoming messages"
16700 .cindex "message" "queueing remote deliveries"
16701 When this option is set, a delivery process is started whenever a message is
16702 received, routing is performed, and local deliveries take place.
16703 However, if any SMTP deliveries are required for domains that match
16704 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16705 message waits in the queue for the next queue run. Since routing of the message
16706 has taken place, Exim knows to which remote hosts it must be delivered, and so
16707 when the queue run happens, multiple messages for the same host are delivered
16708 over a single SMTP connection. The &%-odqs%& command line option causes all
16709 SMTP deliveries to be queued in this way, and is equivalent to setting
16710 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16711 &%queue_domains%&.
16712
16713
16714 .option receive_timeout main time 0s
16715 .cindex "timeout" "for non-SMTP input"
16716 This option sets the timeout for accepting a non-SMTP message, that is, the
16717 maximum time that Exim waits when reading a message on the standard input. If
16718 the value is zero, it will wait forever. This setting is overridden by the
16719 &%-or%& command line option. The timeout for incoming SMTP messages is
16720 controlled by &%smtp_receive_timeout%&.
16721
16722 .option received_header_text main string&!! "see below"
16723 .cindex "customizing" "&'Received:'& header"
16724 .cindex "&'Received:'& header line" "customizing"
16725 This string defines the contents of the &'Received:'& message header that is
16726 added to each message, except for the timestamp, which is automatically added
16727 on at the end (preceded by a semicolon). The string is expanded each time it is
16728 used. If the expansion yields an empty string, no &'Received:'& header line is
16729 added to the message. Otherwise, the string should start with the text
16730 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16731 header lines.
16732 .new
16733 The default setting is:
16734
16735 .code
16736 received_header_text = Received: \
16737   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16738     {${if def:sender_ident \
16739       {from ${quote_local_part:$sender_ident} }}\
16740         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16741   by $primary_hostname \
16742   ${if def:received_protocol {with $received_protocol }}\
16743   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16744   (Exim $version_number)\n\t\
16745   ${if def:sender_address \
16746   {(envelope-from <$sender_address>)\n\t}}\
16747   id $message_exim_id\
16748   ${if def:received_for {\n\tfor $received_for}}
16749 .endd
16750 .wen
16751
16752 The reference to the TLS cipher is omitted when Exim is built without TLS
16753 support. The use of conditional expansions ensures that this works for both
16754 locally generated messages and messages received from remote hosts, giving
16755 header lines such as the following:
16756 .code
16757 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16758 by marley.carol.example with esmtp (Exim 4.00)
16759 (envelope-from <bob@carol.example>)
16760 id 16IOWa-00019l-00
16761 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16762 Received: by scrooge.carol.example with local (Exim 4.00)
16763 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16764 .endd
16765 Until the body of the message has been received, the timestamp is the time when
16766 the message started to be received. Once the body has arrived, and all policy
16767 checks have taken place, the timestamp is updated to the time at which the
16768 message was accepted.
16769
16770
16771 .option received_headers_max main integer 30
16772 .cindex "loop" "prevention"
16773 .cindex "mail loop prevention"
16774 .cindex "&'Received:'& header line" "counting"
16775 When a message is to be delivered, the number of &'Received:'& headers is
16776 counted, and if it is greater than this parameter, a mail loop is assumed to
16777 have occurred, the delivery is abandoned, and an error message is generated.
16778 This applies to both local and remote deliveries.
16779
16780
16781 .option recipient_unqualified_hosts main "host list&!!" unset
16782 .cindex "unqualified addresses"
16783 .cindex "host" "unqualified addresses from"
16784 This option lists those hosts from which Exim is prepared to accept unqualified
16785 recipient addresses in message envelopes. The addresses are made fully
16786 qualified by the addition of the &%qualify_recipient%& value. This option also
16787 affects message header lines. Exim does not reject unqualified recipient
16788 addresses in headers, but it qualifies them only if the message came from a
16789 host that matches &%recipient_unqualified_hosts%&,
16790 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16791 option was not set.
16792
16793
16794 .option recipients_max main integer 0
16795 .cindex "limit" "number of recipients"
16796 .cindex "recipient" "maximum number"
16797 If this option is set greater than zero, it specifies the maximum number of
16798 original recipients for any message. Additional recipients that are generated
16799 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16800 all recipients over the limit; earlier recipients are delivered as normal.
16801 Non-SMTP messages with too many recipients are failed, and no deliveries are
16802 done.
16803
16804 .cindex "RCPT" "maximum number of incoming"
16805 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16806 RCPT commands in a single message.
16807
16808
16809 .option recipients_max_reject main boolean false
16810 If this option is set true, Exim rejects SMTP messages containing too many
16811 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16812 error to the eventual DATA command. Otherwise (the default) it gives a 452
16813 error to the surplus RCPT commands and accepts the message on behalf of the
16814 initial set of recipients. The remote server should then re-send the message
16815 for the remaining recipients at a later time.
16816
16817
16818 .option remote_max_parallel main integer 2
16819 .cindex "delivery" "parallelism for remote"
16820 This option controls parallel delivery of one message to a number of remote
16821 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16822 does all the remote deliveries for a message one by one. Otherwise, if a single
16823 message has to be delivered to more than one remote host, or if several copies
16824 have to be sent to the same remote host, up to &%remote_max_parallel%&
16825 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16826 deliveries are required, the maximum number of processes are started, and as
16827 each one finishes, another is begun. The order of starting processes is the
16828 same as if sequential delivery were being done, and can be controlled by the
16829 &%remote_sort_domains%& option. If parallel delivery takes place while running
16830 with debugging turned on, the debugging output from each delivery process is
16831 tagged with its process id.
16832
16833 This option controls only the maximum number of parallel deliveries for one
16834 message in one Exim delivery process. Because Exim has no central queue
16835 manager, there is no way of controlling the total number of simultaneous
16836 deliveries if the configuration allows a delivery attempt as soon as a message
16837 is received.
16838
16839 .cindex "number of deliveries"
16840 .cindex "delivery" "maximum number of"
16841 If you want to control the total number of deliveries on the system, you
16842 need to set the &%queue_only%& option. This ensures that all incoming messages
16843 are added to the queue without starting a delivery process. Then set up an Exim
16844 daemon to start queue runner processes at appropriate intervals (probably
16845 fairly often, for example, every minute), and limit the total number of queue
16846 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16847 delivers only one message at a time, the maximum number of deliveries that can
16848 then take place at once is &%queue_run_max%& multiplied by
16849 &%remote_max_parallel%&.
16850
16851 If it is purely remote deliveries you want to control, use
16852 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16853 doing the SMTP routing before queueing, so that several messages for the same
16854 host will eventually get delivered down the same connection.
16855
16856
16857 .option remote_sort_domains main "domain list&!!" unset
16858 .cindex "sorting remote deliveries"
16859 .cindex "delivery" "sorting remote"
16860 When there are a number of remote deliveries for a message, they are sorted by
16861 domain into the order given by this list. For example,
16862 .code
16863 remote_sort_domains = *.cam.ac.uk:*.uk
16864 .endd
16865 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16866 then to those in the &%uk%& domain, then to any others.
16867
16868
16869 .option retry_data_expire main time 7d
16870 .cindex "hints database" "data expiry"
16871 This option sets a &"use before"& time on retry information in Exim's hints
16872 database. Any older retry data is ignored. This means that, for example, once a
16873 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16874 past failures.
16875
16876
16877 .option retry_interval_max main time 24h
16878 .cindex "retry" "limit on interval"
16879 .cindex "limit" "on retry interval"
16880 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16881 intervals between delivery attempts for messages that cannot be delivered
16882 straight away. This option sets an overall limit to the length of time between
16883 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16884 the default value.
16885
16886
16887 .option return_path_remove main boolean true
16888 .cindex "&'Return-path:'& header line" "removing"
16889 RFC 2821, section 4.4, states that an SMTP server must insert a
16890 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16891 The &'Return-path:'& header preserves the sender address as received in the
16892 MAIL command. This description implies that this header should not be present
16893 in an incoming message. If &%return_path_remove%& is true, any existing
16894 &'Return-path:'& headers are removed from messages at the time they are
16895 received. Exim's transports have options for adding &'Return-path:'& headers at
16896 the time of delivery. They are normally used only for final local deliveries.
16897
16898
16899 .option return_size_limit main integer 100K
16900 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16901
16902
16903 .option rfc1413_hosts main "host list&!!" @[]
16904 .cindex "RFC 1413"
16905 .cindex "host" "for RFC 1413 calls"
16906 RFC 1413 identification calls are made to any client host which matches
16907 an item in the list.
16908 The default value specifies just this host, being any local interface
16909 for the system.
16910
16911 .option rfc1413_query_timeout main time 0s
16912 .cindex "RFC 1413" "query timeout"
16913 .cindex "timeout" "for RFC 1413 call"
16914 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16915 no RFC 1413 calls are ever made.
16916
16917
16918 .option sender_unqualified_hosts main "host list&!!" unset
16919 .cindex "unqualified addresses"
16920 .cindex "host" "unqualified addresses from"
16921 This option lists those hosts from which Exim is prepared to accept unqualified
16922 sender addresses. The addresses are made fully qualified by the addition of
16923 &%qualify_domain%&. This option also affects message header lines. Exim does
16924 not reject unqualified addresses in headers that contain sender addresses, but
16925 it qualifies them only if the message came from a host that matches
16926 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16927 using TCP/IP), and the &%-bnq%& option was not set.
16928
16929 .option add_environment main "string list" empty
16930 .cindex "environment"
16931 This option allows to add individual environment variables that the
16932 currently linked libraries and programs in child processes use. The
16933 default list is empty.
16934
16935
16936 .option slow_lookup_log main integer 0
16937 .cindex "logging" "slow lookups"
16938 .cindex "dns" "logging slow lookups"
16939 This option controls logging of slow lookups.
16940 If the value is nonzero it is taken as a number of milliseconds
16941 and lookups taking longer than this are logged.
16942 Currently this applies only to DNS lookups.
16943
16944
16945
16946 .option smtp_accept_keepalive main boolean true
16947 .cindex "keepalive" "on incoming connection"
16948 This option controls the setting of the SO_KEEPALIVE option on incoming
16949 TCP/IP socket connections. When set, it causes the kernel to probe idle
16950 connections periodically, by sending packets with &"old"& sequence numbers. The
16951 other end of the connection should send an acknowledgment if the connection is
16952 still okay or a reset if the connection has been aborted. The reason for doing
16953 this is that it has the beneficial effect of freeing up certain types of
16954 connection that can get stuck when the remote host is disconnected without
16955 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16956 hours to detect unreachable hosts.
16957
16958
16959
16960 .option smtp_accept_max main integer 20
16961 .cindex "limit" "incoming SMTP connections"
16962 .cindex "SMTP" "incoming connection count"
16963 .cindex "inetd"
16964 This option specifies the maximum number of simultaneous incoming SMTP calls
16965 that Exim will accept. It applies only to the listening daemon; there is no
16966 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16967 value is set to zero, no limit is applied. However, it is required to be
16968 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16969 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16970
16971 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16972 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16973 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16974 and &%smtp_load_reserve%& are then checked before accepting the connection.
16975
16976
16977 .option smtp_accept_max_nonmail main integer 10
16978 .cindex "limit" "non-mail SMTP commands"
16979 .cindex "SMTP" "limiting non-mail commands"
16980 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16981 the connection if there are too many. This option defines &"too many"&. The
16982 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16983 client looping sending EHLO, for example. The check is applied only if the
16984 client host matches &%smtp_accept_max_nonmail_hosts%&.
16985
16986 When a new message is expected, one occurrence of RSET is not counted. This
16987 allows a client to send one RSET between messages (this is not necessary,
16988 but some clients do it). Exim also allows one uncounted occurrence of HELO
16989 or EHLO, and one occurrence of STARTTLS between messages. After
16990 starting up a TLS session, another EHLO is expected, and so it too is not
16991 counted. The first occurrence of AUTH in a connection, or immediately
16992 following STARTTLS is not counted. Otherwise, all commands other than
16993 MAIL, RCPT, DATA, and QUIT are counted.
16994
16995
16996 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16997 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16998 check by setting this option. The default value makes it apply to all hosts. By
16999 changing the value, you can exclude any badly-behaved hosts that you have to
17000 live with.
17001
17002
17003 . Allow this long option name to split; give it unsplit as a fifth argument
17004 . for the automatic .oindex that is generated by .option.
17005 . We insert " &~&~" which is both pretty nasty visually and results in
17006 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17007 . zero-width-space, which would be nicer visually and results in (at least)
17008 . html that Firefox will split on when it's forced to reflow (rather than
17009 . inserting a horizontal scrollbar).  However, the text is still not
17010 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17011 . the option name to split.
17012
17013 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17014          smtp_accept_max_per_connection
17015 .cindex "SMTP" "limiting incoming message count"
17016 .cindex "limit" "messages per SMTP connection"
17017 The value of this option limits the number of MAIL commands that Exim is
17018 prepared to accept over a single SMTP connection, whether or not each command
17019 results in the transfer of a message. After the limit is reached, a 421
17020 response is given to subsequent MAIL commands. This limit is a safety
17021 precaution against a client that goes mad (incidents of this type have been
17022 seen).
17023
17024
17025 .option smtp_accept_max_per_host main string&!! unset
17026 .cindex "limit" "SMTP connections from one host"
17027 .cindex "host" "limiting SMTP connections from"
17028 This option restricts the number of simultaneous IP connections from a single
17029 host (strictly, from a single IP address) to the Exim daemon. The option is
17030 expanded, to enable different limits to be applied to different hosts by
17031 reference to &$sender_host_address$&. Once the limit is reached, additional
17032 connection attempts from the same host are rejected with error code 421. This
17033 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17034 of zero imposes no limit. If this option is set greater than zero, it is
17035 required that &%smtp_accept_max%& be non-zero.
17036
17037 &*Warning*&: When setting this option you should not use any expansion
17038 constructions that take an appreciable amount of time. The expansion and test
17039 happen in the main daemon loop, in order to reject additional connections
17040 without forking additional processes (otherwise a denial-of-service attack
17041 could cause a vast number or processes to be created). While the daemon is
17042 doing this processing, it cannot accept any other incoming connections.
17043
17044
17045
17046 .option smtp_accept_queue main integer 0
17047 .cindex "SMTP" "incoming connection count"
17048 .cindex "queueing incoming messages"
17049 .cindex "message" "queueing by SMTP connection count"
17050 If the number of simultaneous incoming SMTP connections being handled via the
17051 listening daemon exceeds this value, messages received by SMTP are just placed
17052 in the queue; no delivery processes are started automatically. The count is
17053 fixed at the start of an SMTP connection. It cannot be updated in the
17054 subprocess that receives messages, and so the queueing or not queueing applies
17055 to all messages received in the same connection.
17056
17057 A value of zero implies no limit, and clearly any non-zero value is useful only
17058 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17059 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17060 various &%-od%&&'x'& command line options.
17061
17062
17063 . See the comment on smtp_accept_max_per_connection
17064
17065 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17066          smtp_accept_queue_per_connection
17067 .cindex "queueing incoming messages"
17068 .cindex "message" "queueing by message count"
17069 This option limits the number of delivery processes that Exim starts
17070 automatically when receiving messages via SMTP, whether via the daemon or by
17071 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17072 and the number of messages received in a single SMTP session exceeds this
17073 number, subsequent messages are placed in the queue, but no delivery processes
17074 are started. This helps to limit the number of Exim processes when a server
17075 restarts after downtime and there is a lot of mail waiting for it on other
17076 systems. On large systems, the default should probably be increased, and on
17077 dial-in client systems it should probably be set to zero (that is, disabled).
17078
17079
17080 .option smtp_accept_reserve main integer 0
17081 .cindex "SMTP" "incoming call count"
17082 .cindex "host" "reserved"
17083 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17084 number of SMTP connections that are reserved for connections from the hosts
17085 that are specified in &%smtp_reserve_hosts%&. The value set in
17086 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17087 restricted to this number of connections; the option specifies a minimum number
17088 of connection slots for them, not a maximum. It is a guarantee that this group
17089 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17090 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17091 individual host.
17092
17093 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17094 set to 5, once there are 45 active connections (from any hosts), new
17095 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17096 provided the other criteria for acceptance are met.
17097
17098
17099 .option smtp_active_hostname main string&!! unset
17100 .cindex "host" "name in SMTP responses"
17101 .cindex "SMTP" "host name in responses"
17102 .vindex "&$primary_hostname$&"
17103 This option is provided for multi-homed servers that want to masquerade as
17104 several different hosts. At the start of an incoming SMTP connection, its value
17105 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17106 responses. For example, it is used as domain name in the response to an
17107 incoming HELO or EHLO command.
17108
17109 .vindex "&$smtp_active_hostname$&"
17110 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17111 is saved with any messages that are received. It is therefore available for use
17112 in routers and transports when the message is later delivered.
17113
17114 If this option is unset, or if its expansion is forced to fail, or if the
17115 expansion results in an empty string, the value of &$primary_hostname$& is
17116 used. Other expansion failures cause a message to be written to the main and
17117 panic logs, and the SMTP command receives a temporary error. Typically, the
17118 value of &%smtp_active_hostname%& depends on the incoming interface address.
17119 For example:
17120 .code
17121 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17122   {cox.mydomain}{box.mydomain}}
17123 .endd
17124
17125 Although &$smtp_active_hostname$& is primarily concerned with incoming
17126 messages, it is also used as the default for HELO commands in callout
17127 verification if there is no remote transport from which to obtain a
17128 &%helo_data%& value.
17129
17130 .option smtp_banner main string&!! "see below"
17131 .cindex "SMTP" "welcome banner"
17132 .cindex "banner for SMTP"
17133 .cindex "welcome banner for SMTP"
17134 .cindex "customizing" "SMTP banner"
17135 This string, which is expanded every time it is used, is output as the initial
17136 positive response to an SMTP connection. The default setting is:
17137 .code
17138 smtp_banner = $smtp_active_hostname ESMTP Exim \
17139   $version_number $tod_full
17140 .endd
17141 Failure to expand the string causes a panic error. If you want to create a
17142 multiline response to the initial SMTP connection, use &"\n"& in the string at
17143 appropriate points, but not at the end. Note that the 220 code is not included
17144 in this string. Exim adds it automatically (several times in the case of a
17145 multiline response).
17146
17147
17148 .option smtp_check_spool_space main boolean true
17149 .cindex "checking disk space"
17150 .cindex "disk space, checking"
17151 .cindex "spool directory" "checking space"
17152 When this option is set, if an incoming SMTP session encounters the SIZE
17153 option on a MAIL command, it checks that there is enough space in the
17154 spool directory's partition to accept a message of that size, while still
17155 leaving free the amount specified by &%check_spool_space%& (even if that value
17156 is zero). If there isn't enough space, a temporary error code is returned.
17157
17158
17159 .option smtp_connect_backlog main integer 20
17160 .cindex "connection backlog"
17161 .cindex "SMTP" "connection backlog"
17162 .cindex "backlog of connections"
17163 This option specifies a maximum number of waiting SMTP connections. Exim passes
17164 this value to the TCP/IP system when it sets up its listener. Once this number
17165 of connections are waiting for the daemon's attention, subsequent connection
17166 attempts are refused at the TCP/IP level. At least, that is what the manuals
17167 say; in some circumstances such connection attempts have been observed to time
17168 out instead. For large systems it is probably a good idea to increase the
17169 value (to 50, say). It also gives some protection against denial-of-service
17170 attacks by SYN flooding.
17171
17172
17173 .option smtp_enforce_sync main boolean true
17174 .cindex "SMTP" "synchronization checking"
17175 .cindex "synchronization checking in SMTP"
17176 The SMTP protocol specification requires the client to wait for a response from
17177 the server at certain points in the dialogue. Without PIPELINING these
17178 synchronization points are after every command; with PIPELINING they are
17179 fewer, but they still exist.
17180
17181 Some spamming sites send out a complete set of SMTP commands without waiting
17182 for any response. Exim protects against this by rejecting a message if the
17183 client has sent further input when it should not have. The error response &"554
17184 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17185 for this error cannot be perfect because of transmission delays (unexpected
17186 input may be on its way but not yet received when Exim checks). However, it
17187 does detect many instances.
17188
17189 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17190 If you want to disable the check selectively (for example, only for certain
17191 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17192 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17193
17194
17195
17196 .option smtp_etrn_command main string&!! unset
17197 .cindex "ETRN" "command to be run"
17198 .vindex "&$domain$&"
17199 If this option is set, the given command is run whenever an SMTP ETRN
17200 command is received from a host that is permitted to issue such commands (see
17201 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17202 are independently expanded. The expansion variable &$domain$& is set to the
17203 argument of the ETRN command, and no syntax checking is done on it. For
17204 example:
17205 .code
17206 smtp_etrn_command = /etc/etrn_command $domain \
17207                     $sender_host_address
17208 .endd
17209 A new process is created to run the command, but Exim does not wait for it to
17210 complete. Consequently, its status cannot be checked. If the command cannot be
17211 run, a line is written to the panic log, but the ETRN caller still receives
17212 a 250 success response. Exim is normally running under its own uid when
17213 receiving SMTP, so it is not possible for it to change the uid before running
17214 the command.
17215
17216
17217 .option smtp_etrn_serialize main boolean true
17218 .cindex "ETRN" "serializing"
17219 When this option is set, it prevents the simultaneous execution of more than
17220 one identical command as a result of ETRN in an SMTP connection. See
17221 section &<<SECTETRN>>& for details.
17222
17223
17224 .option smtp_load_reserve main fixed-point unset
17225 .cindex "load average"
17226 If the system load average ever gets higher than this, incoming SMTP calls are
17227 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17228 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17229 the load is over the limit. The option has no effect on ancient operating
17230 systems on which Exim cannot determine the load average. See also
17231 &%deliver_queue_load_max%& and &%queue_only_load%&.
17232
17233
17234
17235 .option smtp_max_synprot_errors main integer 3
17236 .cindex "SMTP" "limiting syntax and protocol errors"
17237 .cindex "limit" "SMTP syntax and protocol errors"
17238 Exim rejects SMTP commands that contain syntax or protocol errors. In
17239 particular, a syntactically invalid email address, as in this command:
17240 .code
17241 RCPT TO:<abc xyz@a.b.c>
17242 .endd
17243 causes immediate rejection of the command, before any other tests are done.
17244 (The ACL cannot be run if there is no valid address to set up for it.) An
17245 example of a protocol error is receiving RCPT before MAIL. If there are
17246 too many syntax or protocol errors in one SMTP session, the connection is
17247 dropped. The limit is set by this option.
17248
17249 .cindex "PIPELINING" "expected errors"
17250 When the PIPELINING extension to SMTP is in use, some protocol errors are
17251 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17252 Exim assumes that PIPELINING will be used if it advertises it (see
17253 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17254 not count towards the limit.
17255
17256
17257
17258 .option smtp_max_unknown_commands main integer 3
17259 .cindex "SMTP" "limiting unknown commands"
17260 .cindex "limit" "unknown SMTP commands"
17261 If there are too many unrecognized commands in an incoming SMTP session, an
17262 Exim server drops the connection. This is a defence against some kinds of abuse
17263 that subvert web
17264 clients
17265 into making connections to SMTP ports; in these circumstances, a number of
17266 non-SMTP command lines are sent first.
17267
17268
17269
17270 .option smtp_ratelimit_hosts main "host list&!!" unset
17271 .cindex "SMTP" "rate limiting"
17272 .cindex "limit" "rate of message arrival"
17273 .cindex "RCPT" "rate limiting"
17274 Some sites find it helpful to be able to limit the rate at which certain hosts
17275 can send them messages, and the rate at which an individual message can specify
17276 recipients.
17277
17278 Exim has two rate-limiting facilities. This section describes the older
17279 facility, which can limit rates within a single connection. The newer
17280 &%ratelimit%& ACL condition can limit rates across all connections. See section
17281 &<<SECTratelimiting>>& for details of the newer facility.
17282
17283 When a host matches &%smtp_ratelimit_hosts%&, the values of
17284 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17285 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17286 respectively. Each option, if set, must contain a set of four comma-separated
17287 values:
17288
17289 .ilist
17290 A threshold, before which there is no rate limiting.
17291 .next
17292 An initial time delay. Unlike other times in Exim, numbers with decimal
17293 fractional parts are allowed here.
17294 .next
17295 A factor by which to increase the delay each time.
17296 .next
17297 A maximum value for the delay. This should normally be less than 5 minutes,
17298 because after that time, the client is liable to timeout the SMTP command.
17299 .endlist
17300
17301 For example, these settings have been used successfully at the site which
17302 first suggested this feature, for controlling mail from their customers:
17303 .code
17304 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17305 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17306 .endd
17307 The first setting specifies delays that are applied to MAIL commands after
17308 two have been received over a single connection. The initial delay is 0.5
17309 seconds, increasing by a factor of 1.05 each time. The second setting applies
17310 delays to RCPT commands when more than four occur in a single message.
17311
17312
17313 .option smtp_ratelimit_mail main string unset
17314 See &%smtp_ratelimit_hosts%& above.
17315
17316
17317 .option smtp_ratelimit_rcpt main string unset
17318 See &%smtp_ratelimit_hosts%& above.
17319
17320
17321 .option smtp_receive_timeout main time&!! 5m
17322 .cindex "timeout" "for SMTP input"
17323 .cindex "SMTP" "input timeout"
17324 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17325 input, including batch SMTP. If a line of input (either an SMTP command or a
17326 data line) is not received within this time, the SMTP connection is dropped and
17327 the message is abandoned.
17328 A line is written to the log containing one of the following messages:
17329 .code
17330 SMTP command timeout on connection from...
17331 SMTP data timeout on connection from...
17332 .endd
17333 The former means that Exim was expecting to read an SMTP command; the latter
17334 means that it was in the DATA phase, reading the contents of a message.
17335
17336 If the first character of the option is a &"$"& the option is
17337 expanded before use and may depend on
17338 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17339
17340
17341 .oindex "&%-os%&"
17342 The value set by this option can be overridden by the
17343 &%-os%& command-line option. A setting of zero time disables the timeout, but
17344 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17345 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17346 timeout is controlled by &%receive_timeout%& and &%-or%&.
17347
17348
17349 .option smtp_reserve_hosts main "host list&!!" unset
17350 This option defines hosts for which SMTP connections are reserved; see
17351 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17352
17353
17354 .option smtp_return_error_details main boolean false
17355 .cindex "SMTP" "details policy failures"
17356 .cindex "policy control" "rejection, returning details"
17357 In the default state, Exim uses bland messages such as
17358 &"Administrative prohibition"& when it rejects SMTP commands for policy
17359 reasons. Many sysadmins like this because it gives away little information
17360 to spammers. However, some other sysadmins who are applying strict checking
17361 policies want to give out much fuller information about failures. Setting
17362 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17363 example, instead of &"Administrative prohibition"&, it might give:
17364 .code
17365 550-Rejected after DATA: '>' missing at end of address:
17366 550 failing address in "From" header is: <user@dom.ain
17367 .endd
17368
17369
17370 .option smtputf8_advertise_hosts main "host list&!!" *
17371 .cindex "SMTPUTF8" "advertising"
17372 When Exim is built with support for internationalised mail names,
17373 the availability thereof is advertised in
17374 response to EHLO only to those client hosts that match this option. See
17375 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17376
17377
17378 .option spamd_address main string "127.0.0.1 783"
17379 This option is available when Exim is compiled with the content-scanning
17380 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17381 See section &<<SECTscanspamass>>& for more details.
17382
17383
17384
17385 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17386 This option is available when Exim is compiled with SPF support.
17387 See section &<<SECSPF>>& for more details.
17388
17389
17390
17391 .option split_spool_directory main boolean false
17392 .cindex "multiple spool directories"
17393 .cindex "spool directory" "split"
17394 .cindex "directories, multiple"
17395 If this option is set, it causes Exim to split its input directory into 62
17396 subdirectories, each with a single alphanumeric character as its name. The
17397 sixth character of the message id is used to allocate messages to
17398 subdirectories; this is the least significant base-62 digit of the time of
17399 arrival of the message.
17400
17401 Splitting up the spool in this way may provide better performance on systems
17402 where there are long mail queues, by reducing the number of files in any one
17403 directory. The msglog directory is also split up in a similar way to the input
17404 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17405 are still placed in the single directory &_msglog.OLD_&.
17406
17407 It is not necessary to take any special action for existing messages when
17408 changing &%split_spool_directory%&. Exim notices messages that are in the
17409 &"wrong"& place, and continues to process them. If the option is turned off
17410 after a period of being on, the subdirectories will eventually empty and be
17411 automatically deleted.
17412
17413 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17414 changes. Instead of creating a list of all messages in the queue, and then
17415 trying to deliver each one, in turn, it constructs a list of those in one
17416 sub-directory and tries to deliver them, before moving on to the next
17417 sub-directory. The sub-directories are processed in a random order. This
17418 spreads out the scanning of the input directories, and uses less memory. It is
17419 particularly beneficial when there are lots of messages in the queue. However,
17420 if &%queue_run_in_order%& is set, none of this new processing happens. The
17421 entire queue has to be scanned and sorted before any deliveries can start.
17422
17423
17424 .option spool_directory main string&!! "set at compile time"
17425 .cindex "spool directory" "path to"
17426 This defines the directory in which Exim keeps its spool, that is, the messages
17427 it is waiting to deliver. The default value is taken from the compile-time
17428 configuration setting, if there is one. If not, this option must be set. The
17429 string is expanded, so it can contain, for example, a reference to
17430 &$primary_hostname$&.
17431
17432 If the spool directory name is fixed on your installation, it is recommended
17433 that you set it at build time rather than from this option, particularly if the
17434 log files are being written to the spool directory (see &%log_file_path%&).
17435 Otherwise log files cannot be used for errors that are detected early on, such
17436 as failures in the configuration file.
17437
17438 By using this option to override the compiled-in path, it is possible to run
17439 tests of Exim without using the standard spool.
17440
17441 .option spool_wireformat main boolean false
17442 .cindex "spool directory" "file formats"
17443 If this option is set, Exim may for some messages use an alternative format
17444 for data-files in the spool which matches the wire format.
17445 Doing this permits more efficient message reception and transmission.
17446 Currently it is only done for messages received using the ESMTP CHUNKING
17447 option.
17448
17449 The following variables will not have useful values:
17450 .code
17451 $max_received_linelength
17452 $body_linecount
17453 $body_zerocount
17454 .endd
17455
17456 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17457 and any external programs which are passed a reference to a message data file
17458 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17459 will need to be aware of the different formats potentially available.
17460
17461 Using any of the ACL conditions noted will negate the reception benefit
17462 (as a Unix-mbox-format file is constructed for them).
17463 The transmission benefit is maintained.
17464
17465 .option sqlite_lock_timeout main time 5s
17466 .cindex "sqlite lookup type" "lock timeout"
17467 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17468 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17469
17470 .option strict_acl_vars main boolean false
17471 .cindex "&ACL;" "variables, handling unset"
17472 This option controls what happens if a syntactically valid but undefined ACL
17473 variable is referenced. If it is false (the default), an empty string
17474 is substituted; if it is true, an error is generated. See section
17475 &<<SECTaclvariables>>& for details of ACL variables.
17476
17477 .option strip_excess_angle_brackets main boolean false
17478 .cindex "angle brackets, excess"
17479 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17480 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17481 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17482 passed on to another MTA, the excess angle brackets are not passed on. If this
17483 option is not set, multiple pairs of angle brackets cause a syntax error.
17484
17485
17486 .option strip_trailing_dot main boolean false
17487 .cindex "trailing dot on domain"
17488 .cindex "dot" "trailing on domain"
17489 If this option is set, a trailing dot at the end of a domain in an address is
17490 ignored. If this is in the envelope and the message is passed on to another
17491 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17492 domain causes a syntax error.
17493 However, addresses in header lines are checked only when an ACL requests header
17494 syntax checking.
17495
17496
17497 .option syslog_duplication main boolean true
17498 .cindex "syslog" "duplicate log lines; suppressing"
17499 When Exim is logging to syslog, it writes the log lines for its three
17500 separate logs at different syslog priorities so that they can in principle
17501 be separated on the logging hosts. Some installations do not require this
17502 separation, and in those cases, the duplication of certain log lines is a
17503 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17504 particular log line is written to syslog. For lines that normally go to
17505 both the main log and the reject log, the reject log version (possibly
17506 containing message header lines) is written, at LOG_NOTICE priority.
17507 Lines that normally go to both the main and the panic log are written at
17508 the LOG_ALERT priority.
17509
17510
17511 .option syslog_facility main string unset
17512 .cindex "syslog" "facility; setting"
17513 This option sets the syslog &"facility"& name, used when Exim is logging to
17514 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17515 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17516 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17517 details of Exim's logging.
17518
17519
17520 .option syslog_pid main boolean true
17521 .cindex "syslog" "pid"
17522 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17523 omitted when these lines are sent to syslog. (Syslog normally prefixes
17524 the log lines with the PID of the logging process automatically.) You need
17525 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17526 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17527
17528
17529
17530 .option syslog_processname main string &`exim`&
17531 .cindex "syslog" "process name; setting"
17532 This option sets the syslog &"ident"& name, used when Exim is logging to
17533 syslog. The value must be no longer than 32 characters. See chapter
17534 &<<CHAPlog>>& for details of Exim's logging.
17535
17536
17537
17538 .option syslog_timestamp main boolean true
17539 .cindex "syslog" "timestamps"
17540 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17541 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17542 details of Exim's logging.
17543
17544
17545 .option system_filter main string&!! unset
17546 .cindex "filter" "system filter"
17547 .cindex "system filter" "specifying"
17548 .cindex "Sieve filter" "not available for system filter"
17549 This option specifies an Exim filter file that is applied to all messages at
17550 the start of each delivery attempt, before any routing is done. System filters
17551 must be Exim filters; they cannot be Sieve filters. If the system filter
17552 generates any deliveries to files or pipes, or any new mail messages, the
17553 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17554 which transports are to be used. Details of this facility are given in chapter
17555 &<<CHAPsystemfilter>>&.
17556 A forced expansion failure results in no filter operation.
17557
17558
17559 .option system_filter_directory_transport main string&!! unset
17560 .vindex "&$address_file$&"
17561 This sets the name of the transport driver that is to be used when the
17562 &%save%& command in a system message filter specifies a path ending in &"/"&,
17563 implying delivery of each message into a separate file in some directory.
17564 During the delivery, the variable &$address_file$& contains the path name.
17565
17566
17567 .option system_filter_file_transport main string&!! unset
17568 .cindex "file" "transport for system filter"
17569 This sets the name of the transport driver that is to be used when the &%save%&
17570 command in a system message filter specifies a path not ending in &"/"&. During
17571 the delivery, the variable &$address_file$& contains the path name.
17572
17573 .option system_filter_group main string unset
17574 .cindex "gid (group id)" "system filter"
17575 This option is used only when &%system_filter_user%& is also set. It sets the
17576 gid under which the system filter is run, overriding any gid that is associated
17577 with the user. The value may be numerical or symbolic.
17578
17579 .option system_filter_pipe_transport main string&!! unset
17580 .cindex "&(pipe)& transport" "for system filter"
17581 .vindex "&$address_pipe$&"
17582 This specifies the transport driver that is to be used when a &%pipe%& command
17583 is used in a system filter. During the delivery, the variable &$address_pipe$&
17584 contains the pipe command.
17585
17586
17587 .option system_filter_reply_transport main string&!! unset
17588 .cindex "&(autoreply)& transport" "for system filter"
17589 This specifies the transport driver that is to be used when a &%mail%& command
17590 is used in a system filter.
17591
17592
17593 .option system_filter_user main string unset
17594 .cindex "uid (user id)" "system filter"
17595 If this option is set to root, the system filter is run in the main Exim
17596 delivery process, as root.  Otherwise, the system filter runs in a separate
17597 process, as the given user, defaulting to the Exim run-time user.
17598 Unless the string consists entirely of digits, it
17599 is looked up in the password data. Failure to find the named user causes a
17600 configuration error. The gid is either taken from the password data, or
17601 specified by &%system_filter_group%&. When the uid is specified numerically,
17602 &%system_filter_group%& is required to be set.
17603
17604 If the system filter generates any pipe, file, or reply deliveries, the uid
17605 under which the filter is run is used when transporting them, unless a
17606 transport option overrides.
17607
17608
17609 .option tcp_nodelay main boolean true
17610 .cindex "daemon" "TCP_NODELAY on sockets"
17611 .cindex "Nagle algorithm"
17612 .cindex "TCP_NODELAY on listening sockets"
17613 If this option is set false, it stops the Exim daemon setting the
17614 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17615 turns off the &"Nagle algorithm"&, which is a way of improving network
17616 performance in interactive (character-by-character) situations. Turning it off
17617 should improve Exim's performance a bit, so that is what happens by default.
17618 However, it appears that some broken clients cannot cope, and time out. Hence
17619 this option. It affects only those sockets that are set up for listening by the
17620 daemon. Sockets created by the smtp transport for delivering mail always set
17621 TCP_NODELAY.
17622
17623
17624 .option timeout_frozen_after main time 0s
17625 .cindex "frozen messages" "timing out"
17626 .cindex "timeout" "frozen messages"
17627 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17628 message of any kind that has been in the queue for longer than the given time
17629 is automatically cancelled at the next queue run. If the frozen message is a
17630 bounce message, it is just discarded; otherwise, a bounce is sent to the
17631 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17632 If you want to timeout frozen bounce messages earlier than other kinds of
17633 frozen message, see &%ignore_bounce_errors_after%&.
17634
17635 &*Note:*& the default value of zero means no timeouts; with this setting,
17636 frozen messages remain in the queue forever (except for any frozen bounce
17637 messages that are released by &%ignore_bounce_errors_after%&).
17638
17639
17640 .option timezone main string unset
17641 .cindex "timezone, setting"
17642 .cindex "environment" "values from"
17643 The value of &%timezone%& is used to set the environment variable TZ while
17644 running Exim (if it is different on entry). This ensures that all timestamps
17645 created by Exim are in the required timezone. If you want all your timestamps
17646 to be in UTC (aka GMT) you should set
17647 .code
17648 timezone = UTC
17649 .endd
17650 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17651 or, if that is not set, from the value of the TZ environment variable when Exim
17652 is built. If &%timezone%& is set to the empty string, either at build or run
17653 time, any existing TZ variable is removed from the environment when Exim
17654 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17655 unfortunately not all, operating systems.
17656
17657
17658 .option tls_advertise_hosts main "host list&!!" *
17659 .cindex "TLS" "advertising"
17660 .cindex "encryption" "on SMTP connection"
17661 .cindex "SMTP" "encrypted connection"
17662 When Exim is built with support for TLS encrypted connections, the availability
17663 of the STARTTLS command to set up an encrypted session is advertised in
17664 response to EHLO only to those client hosts that match this option. See
17665 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17666 Note that the default value requires that a certificate be supplied
17667 using the &%tls_certificate%& option.  If TLS support for incoming connections
17668 is not required the &%tls_advertise_hosts%& option should be set empty.
17669
17670
17671 .option tls_certificate main string list&!! unset
17672 .cindex "TLS" "server certificate; location of"
17673 .cindex "certificate" "server, location of"
17674 The value of this option is expanded, and must then be a list of absolute paths to
17675 files which contain the server's certificates (in PEM format).
17676 Commonly only one file is needed.
17677 The server's private key is also
17678 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17679 &<<CHAPTLS>>& for further details.
17680
17681 &*Note*&: The certificates defined by this option are used only when Exim is
17682 receiving incoming messages as a server. If you want to supply certificates for
17683 use when sending messages as a client, you must set the &%tls_certificate%&
17684 option in the relevant &(smtp)& transport.
17685
17686 &*Note*&: If you use filenames based on IP addresses, change the list
17687 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17688
17689 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17690 when a list of more than one
17691 file is used, the &$tls_in_ourcert$& variable is unreliable.
17692 .new
17693 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17694 .wen
17695
17696 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17697 if the OpenSSL build supports TLS extensions and the TLS client sends the
17698 Server Name Indication extension, then this option and others documented in
17699 &<<SECTtlssni>>& will be re-expanded.
17700
17701 If this option is unset or empty a fresh self-signed certificate will be
17702 generated for every connection.
17703
17704 .option tls_crl main string&!! unset
17705 .cindex "TLS" "server certificate revocation list"
17706 .cindex "certificate" "revocation list for server"
17707 This option specifies a certificate revocation list. The expanded value must
17708 be the name of a file that contains CRLs in PEM format.
17709
17710 Under OpenSSL the option can specify a directory with CRL files.
17711
17712 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17713 for each signing element of the certificate chain (i.e. all but the leaf).
17714 For the file variant this can be multiple PEM blocks in the one file.
17715
17716 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17717
17718
17719 .option tls_dh_max_bits main integer 2236
17720 .cindex "TLS" "D-H bit count"
17721 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17722 the chosen TLS library.  That value might prove to be too high for
17723 interoperability.  This option provides a maximum clamp on the value
17724 suggested, trading off security for interoperability.
17725
17726 The value must be at least 1024.
17727
17728 The value 2236 was chosen because, at time of adding the option, it was the
17729 hard-coded maximum value supported by the NSS cryptographic library, as used
17730 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17731
17732 If you prefer more security and are willing to break some clients, raise this
17733 number.
17734
17735 Note that the value passed to GnuTLS for *generating* a new prime may be a
17736 little less than this figure, because GnuTLS is inexact and may produce a
17737 larger prime than requested.
17738
17739
17740 .option tls_dhparam main string&!! unset
17741 .cindex "TLS" "D-H parameters for server"
17742 The value of this option is expanded and indicates the source of DH parameters
17743 to be used by Exim.
17744
17745 .new
17746 This option is ignored for GnuTLS version 3.6.0 and later.
17747 The library manages parameter negotiation internally.
17748 .wen
17749
17750 &*Note: The Exim Maintainers strongly recommend,
17751 for other TLS library versions,
17752 using a filename with site-generated
17753 local DH parameters*&, which has been supported across all versions of Exim.  The
17754 other specific constants available are a fallback so that even when
17755 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17756
17757 If &%tls_dhparam%& is a filename starting with a &`/`&,
17758 then it names a file from which DH
17759 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17760 PKCS#3 representation of the DH prime.  If the file does not exist, for
17761 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17762 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17763 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17764 and treated as though the &%tls_dhparam%& were set to "none".
17765
17766 If this option expands to the string "none", then no DH parameters will be
17767 loaded by Exim.
17768
17769 If this option expands to the string "historic" and Exim is using GnuTLS, then
17770 Exim will attempt to load a file from inside the spool directory.  If the file
17771 does not exist, Exim will attempt to create it.
17772 See section &<<SECTgnutlsparam>>& for further details.
17773
17774 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17775 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17776
17777 In older versions of Exim the default was the 2048 bit prime described in section
17778 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17779 in IKE is assigned number 23.
17780
17781 Otherwise, the option must expand to the name used by Exim for any of a number
17782 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17783 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17784 the number used by IKE, or "default" which corresponds to
17785 &`exim.dev.20160529.3`&.
17786
17787 The available standard primes are:
17788 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17789 &`ike1`&, &`ike2`&, &`ike5`&,
17790 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17791 &`ike22`&, &`ike23`& and &`ike24`&.
17792
17793 The available additional primes are:
17794 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17795
17796 Some of these will be too small to be accepted by clients.
17797 Some may be too large to be accepted by clients.
17798 The open cryptographic community has suspicions about the integrity of some
17799 of the later IKE values, which led into RFC7919 providing new fixed constants
17800 (the "ffdhe" identifiers).
17801
17802 At this point, all of the "ike" values should be considered obsolete;
17803 they're still in Exim to avoid breaking unusual configurations, but are
17804 candidates for removal the next time we have backwards-incompatible changes.
17805
17806 The TLS protocol does not negotiate an acceptable size for this; clients tend
17807 to hard-drop connections if what is offered by the server is unacceptable,
17808 whether too large or too small, and there's no provision for the client to
17809 tell the server what these constraints are.  Thus, as a server operator, you
17810 need to make an educated guess as to what is most likely to work for your
17811 userbase.
17812
17813 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17814 is most likely to maximise interoperability.  The upper bound comes from
17815 applications using the Mozilla Network Security Services (NSS) library, which
17816 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17817 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17818 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17819 acceptable bound from 1024 to 2048.
17820
17821
17822 .option tls_eccurve main string&!! &`auto`&
17823 .cindex TLS "EC cryptography"
17824 This option selects a EC curve for use by Exim when used with OpenSSL.
17825 It has no effect when Exim is used with GnuTLS.
17826
17827 After expansion it must contain a valid EC curve parameter, such as
17828 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17829 for valid selections.
17830
17831 For OpenSSL versions before (and not including) 1.0.2, the string
17832 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17833 &`auto`& tells the library to choose.
17834
17835 If the option expands to an empty string, no EC curves will be enabled.
17836
17837
17838 .option tls_ocsp_file main string&!! unset
17839 .cindex TLS "certificate status"
17840 .cindex TLS "OCSP proof file"
17841 This option
17842 must if set expand to the absolute path to a file which contains a current
17843 status proof for the server's certificate, as obtained from the
17844 Certificate Authority.
17845
17846 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17847 .new
17848 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
17849 .wen
17850
17851 .new
17852 For OpenSSL 1.1.0 or later, and
17853 .wen
17854 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17855 of files, to match a list given for the &%tls_certificate%& option.
17856 The ordering of the two lists must match.
17857 .new
17858 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
17859 .wen
17860
17861 .new
17862 The file(s) should be in DER format,
17863 except for GnuTLS 3.6.3 or later
17864 or for OpenSSL,
17865 when an optional filetype prefix can be used.
17866 The prefix must be one of "DER" or "PEM", followed by
17867 a single space.  If one is used it sets the format for subsequent
17868 files in the list; the initial format is DER.
17869 If multiple proofs are wanted, for multiple chain elements
17870 (this only works under TLS1.3)
17871 they must be coded as a combined OCSP response.
17872
17873 Although GnuTLS will accept PEM files with multiple separate
17874 PEM blobs (ie. separate OCSP responses), it sends them in the
17875 TLS Certificate record interleaved with the certificates of the chain;
17876 although a GnuTLS client is happy with that, an OpenSSL client is not.
17877 .wen
17878
17879 .option tls_on_connect_ports main "string list" unset
17880 .cindex SSMTP
17881 .cindex SMTPS
17882 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17883 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17884 set up without waiting for the client to issue a STARTTLS command. For
17885 further details, see section &<<SECTsupobssmt>>&.
17886
17887
17888
17889 .option tls_privatekey main string list&!! unset
17890 .cindex "TLS" "server private key; location of"
17891 The value of this option is expanded, and must then be a list of absolute paths to
17892 files which contains the server's private keys.
17893 If this option is unset, or if
17894 the expansion is forced to fail, or the result is an empty string, the private
17895 key is assumed to be in the same file as the server's certificates. See chapter
17896 &<<CHAPTLS>>& for further details.
17897
17898 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17899
17900
17901 .option tls_remember_esmtp main boolean false
17902 .cindex "TLS" "esmtp state; remembering"
17903 .cindex "TLS" "broken clients"
17904 If this option is set true, Exim violates the RFCs by remembering that it is in
17905 &"esmtp"& state after successfully negotiating a TLS session. This provides
17906 support for broken clients that fail to send a new EHLO after starting a
17907 TLS session.
17908
17909
17910 .option tls_require_ciphers main string&!! unset
17911 .cindex "TLS" "requiring specific ciphers"
17912 .cindex "cipher" "requiring specific"
17913 This option controls which ciphers can be used for incoming TLS connections.
17914 The &(smtp)& transport has an option of the same name for controlling outgoing
17915 connections. This option is expanded for each connection, so can be varied for
17916 different clients if required. The value of this option must be a list of
17917 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17918 in somewhat different ways. If GnuTLS is being used, the client controls the
17919 preference order of the available ciphers. Details are given in sections
17920 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17921
17922
17923 .option tls_try_verify_hosts main "host list&!!" unset
17924 .cindex "TLS" "client certificate verification"
17925 .cindex "certificate" "verification of client"
17926 See &%tls_verify_hosts%& below.
17927
17928
17929 .option tls_verify_certificates main string&!! system
17930 .cindex "TLS" "client certificate verification"
17931 .cindex "certificate" "verification of client"
17932 The value of this option is expanded, and must then be either the
17933 word "system"
17934 or the absolute path to
17935 a file or directory containing permitted certificates for clients that
17936 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17937
17938 The "system" value for the option will use a
17939 system default location compiled into the SSL library.
17940 This is not available for GnuTLS versions preceding 3.0.20,
17941 and will be taken as empty; an explicit location
17942 must be specified.
17943
17944 The use of a directory for the option value is not available for GnuTLS versions
17945 preceding 3.3.6 and a single file must be used.
17946
17947 With OpenSSL the certificates specified
17948 explicitly
17949 either by file or directory
17950 are added to those given by the system default location.
17951
17952 These certificates should be for the certificate authorities trusted, rather
17953 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17954 the value is a file then the certificates are sent by Exim as a server to
17955 connecting clients, defining the list of accepted certificate authorities.
17956 Thus the values defined should be considered public data.  To avoid this,
17957 use the explicit directory version.
17958
17959 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17960
17961 A forced expansion failure or setting to an empty string is equivalent to
17962 being unset.
17963
17964
17965 .option tls_verify_hosts main "host list&!!" unset
17966 .cindex "TLS" "client certificate verification"
17967 .cindex "certificate" "verification of client"
17968 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17969 certificates from clients. The expected certificates are defined by
17970 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17971 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17972 &%tls_verify_certificates%& is not set.
17973
17974 Any client that matches &%tls_verify_hosts%& is constrained by
17975 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17976 present one of the listed certificates. If it does not, the connection is
17977 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17978 the host to use TLS. It can still send SMTP commands through unencrypted
17979 connections. Forcing a client to use TLS has to be done separately using an
17980 ACL to reject inappropriate commands when the connection is not encrypted.
17981
17982 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17983 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17984 certificate and checks it against &%tls_verify_certificates%&, but does not
17985 abort the connection if there is no certificate or if it does not match. This
17986 state can be detected in an ACL, which makes it possible to implement policies
17987 such as &"accept for relay only if a verified certificate has been received,
17988 but accept for local delivery if encrypted, even without a verified
17989 certificate"&.
17990
17991 Client hosts that match neither of these lists are not asked to present
17992 certificates.
17993
17994
17995 .option trusted_groups main "string list&!!" unset
17996 .cindex "trusted groups"
17997 .cindex "groups" "trusted"
17998 This option is expanded just once, at the start of Exim's processing. If this
17999 option is set, any process that is running in one of the listed groups, or
18000 which has one of them as a supplementary group, is trusted. The groups can be
18001 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18002 details of what trusted callers are permitted to do. If neither
18003 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18004 are trusted.
18005
18006 .option trusted_users main "string list&!!" unset
18007 .cindex "trusted users"
18008 .cindex "user" "trusted"
18009 This option is expanded just once, at the start of Exim's processing. If this
18010 option is set, any process that is running as one of the listed users is
18011 trusted. The users can be specified numerically or by name. See section
18012 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18013 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18014 Exim user are trusted.
18015
18016 .option unknown_login main string&!! unset
18017 .cindex "uid (user id)" "unknown caller"
18018 .vindex "&$caller_uid$&"
18019 This is a specialized feature for use in unusual configurations. By default, if
18020 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18021 gives up. The &%unknown_login%& option can be used to set a login name to be
18022 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18023 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18024 is used for the user's real name (gecos field), unless this has been set by the
18025 &%-F%& option.
18026
18027 .option unknown_username main string unset
18028 See &%unknown_login%&.
18029
18030 .option untrusted_set_sender main "address list&!!" unset
18031 .cindex "trusted users"
18032 .cindex "sender" "setting by untrusted user"
18033 .cindex "untrusted user setting sender"
18034 .cindex "user" "untrusted setting sender"
18035 .cindex "envelope from"
18036 .cindex "envelope sender"
18037 When an untrusted user submits a message to Exim using the standard input, Exim
18038 normally creates an envelope sender address from the user's login and the
18039 default qualification domain. Data from the &%-f%& option (for setting envelope
18040 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18041 is used) is ignored.
18042
18043 However, untrusted users are permitted to set an empty envelope sender address,
18044 to declare that a message should never generate any bounces. For example:
18045 .code
18046 exim -f '<>' user@domain.example
18047 .endd
18048 .vindex "&$sender_ident$&"
18049 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18050 other envelope sender addresses in a controlled way. When it is set, untrusted
18051 users are allowed to set envelope sender addresses that match any of the
18052 patterns in the list. Like all address lists, the string is expanded. The
18053 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18054 users to setting senders that start with their login ids
18055 followed by a hyphen
18056 by a setting like this:
18057 .code
18058 untrusted_set_sender = ^$sender_ident-
18059 .endd
18060 If you want to allow untrusted users to set envelope sender addresses without
18061 restriction, you can use
18062 .code
18063 untrusted_set_sender = *
18064 .endd
18065 The &%untrusted_set_sender%& option applies to all forms of local input, but
18066 only to the setting of the envelope sender. It does not permit untrusted users
18067 to use the other options which trusted user can use to override message
18068 parameters. Furthermore, it does not stop Exim from removing an existing
18069 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18070 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18071 overriding these actions. The handling of the &'Sender:'& header is also
18072 described in section &<<SECTthesenhea>>&.
18073
18074 The log line for a message's arrival shows the envelope sender following
18075 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18076 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18077 envelope sender address, the user's login is shown in parentheses after the
18078 sender address.
18079
18080
18081 .option uucp_from_pattern main string "see below"
18082 .cindex "&""From""& line"
18083 .cindex "UUCP" "&""From""& line"
18084 Some applications that pass messages to an MTA via a command line interface use
18085 an initial line starting with &"From&~"& to pass the envelope sender. In
18086 particular, this is used by UUCP software. Exim recognizes such a line by means
18087 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18088 matches, the sender address is constructed by expanding the contents of
18089 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18090 default pattern recognizes lines in the following two forms:
18091 .code
18092 From ph10 Fri Jan  5 12:35 GMT 1996
18093 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18094 .endd
18095 The pattern can be seen by running
18096 .code
18097 exim -bP uucp_from_pattern
18098 .endd
18099 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18100 year in the second case. The first word after &"From&~"& is matched in the
18101 regular expression by a parenthesized subpattern. The default value for
18102 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18103 (&"ph10"& in the example above) as the message's sender. See also
18104 &%ignore_fromline_hosts%&.
18105
18106
18107 .option uucp_from_sender main string&!! &`$1`&
18108 See &%uucp_from_pattern%& above.
18109
18110
18111 .option warn_message_file main string unset
18112 .cindex "warning of delay" "customizing the message"
18113 .cindex "customizing" "warning message"
18114 This option defines a template file containing paragraphs of text to be used
18115 for constructing the warning message which is sent by Exim when a message has
18116 been in the queue for a specified amount of time, as specified by
18117 &%delay_warning%&. Details of the file's contents are given in chapter
18118 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18119
18120
18121 .option write_rejectlog main boolean true
18122 .cindex "reject log" "disabling"
18123 If this option is set false, Exim no longer writes anything to the reject log.
18124 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18125 .ecindex IIDconfima
18126 .ecindex IIDmaiconf
18127
18128
18129
18130
18131 . ////////////////////////////////////////////////////////////////////////////
18132 . ////////////////////////////////////////////////////////////////////////////
18133
18134 .chapter "Generic options for routers" "CHAProutergeneric"
18135 .scindex IIDgenoprou1 "options" "generic; for routers"
18136 .scindex IIDgenoprou2 "generic options" "router"
18137 This chapter describes the generic options that apply to all routers.
18138 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18139
18140 For a general description of how a router operates, see sections
18141 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18142 which the preconditions are tested. The order of expansion of the options that
18143 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18144 &%headers_remove%&, &%transport%&.
18145
18146
18147
18148 .option address_data routers string&!! unset
18149 .cindex "router" "data attached to address"
18150 The string is expanded just before the router is run, that is, after all the
18151 precondition tests have succeeded. If the expansion is forced to fail, the
18152 router declines, the value of &%address_data%& remains unchanged, and the
18153 &%more%& option controls what happens next. Other expansion failures cause
18154 delivery of the address to be deferred.
18155
18156 .vindex "&$address_data$&"
18157 When the expansion succeeds, the value is retained with the address, and can be
18158 accessed using the variable &$address_data$& in the current router, subsequent
18159 routers, and the eventual transport.
18160
18161 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18162 that runs a user's filter file, the contents of &$address_data$& are accessible
18163 in the filter. This is not normally a problem, because such data is usually
18164 either not confidential or it &"belongs"& to the current user, but if you do
18165 put confidential data into &$address_data$& you need to remember this point.
18166
18167 Even if the router declines or passes, the value of &$address_data$& remains
18168 with the address, though it can be changed by another &%address_data%& setting
18169 on a subsequent router. If a router generates child addresses, the value of
18170 &$address_data$& propagates to them. This also applies to the special kind of
18171 &"child"& that is generated by a router with the &%unseen%& option.
18172
18173 The idea of &%address_data%& is that you can use it to look up a lot of data
18174 for the address once, and then pick out parts of the data later. For example,
18175 you could use a single LDAP lookup to return a string of the form
18176 .code
18177 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18178 .endd
18179 In the transport you could pick out the mailbox by a setting such as
18180 .code
18181 file = ${extract{mailbox}{$address_data}}
18182 .endd
18183 This makes the configuration file less messy, and also reduces the number of
18184 lookups (though Exim does cache lookups).
18185
18186 .new
18187 See also the &%set%& option below.
18188 .wen
18189
18190 .vindex "&$sender_address_data$&"
18191 .vindex "&$address_data$&"
18192 The &%address_data%& facility is also useful as a means of passing information
18193 from one router to another, and from a router to a transport. In addition, if
18194 &$address_data$& is set by a router when verifying a recipient address from an
18195 ACL, it remains available for use in the rest of the ACL statement. After
18196 verifying a sender, the value is transferred to &$sender_address_data$&.
18197
18198
18199
18200 .option address_test routers&!? boolean true
18201 .oindex "&%-bt%&"
18202 .cindex "router" "skipping when address testing"
18203 If this option is set false, the router is skipped when routing is being tested
18204 by means of the &%-bt%& command line option. This can be a convenience when
18205 your first router sends messages to an external scanner, because it saves you
18206 having to set the &"already scanned"& indicator when testing real address
18207 routing.
18208
18209
18210
18211 .option cannot_route_message routers string&!! unset
18212 .cindex "router" "customizing &""cannot route""& message"
18213 .cindex "customizing" "&""cannot route""& message"
18214 This option specifies a text message that is used when an address cannot be
18215 routed because Exim has run out of routers. The default message is
18216 &"Unrouteable address"&. This option is useful only on routers that have
18217 &%more%& set false, or on the very last router in a configuration, because the
18218 value that is used is taken from the last router that is considered. This
18219 includes a router that is skipped because its preconditions are not met, as
18220 well as a router that declines. For example, using the default configuration,
18221 you could put:
18222 .code
18223 cannot_route_message = Remote domain not found in DNS
18224 .endd
18225 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18226 and
18227 .code
18228 cannot_route_message = Unknown local user
18229 .endd
18230 on the final router that checks for local users. If string expansion fails for
18231 this option, the default message is used. Unless the expansion failure was
18232 explicitly forced, a message about the failure is written to the main and panic
18233 logs, in addition to the normal message about the routing failure.
18234
18235
18236 .option caseful_local_part routers boolean false
18237 .cindex "case of local parts"
18238 .cindex "router" "case of local parts"
18239 By default, routers handle the local parts of addresses in a case-insensitive
18240 manner, though the actual case is preserved for transmission with the message.
18241 If you want the case of letters to be significant in a router, you must set
18242 this option true. For individual router options that contain address or local
18243 part lists (for example, &%local_parts%&), case-sensitive matching can be
18244 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18245 more details.
18246
18247 .vindex "&$local_part$&"
18248 .vindex "&$original_local_part$&"
18249 .vindex "&$parent_local_part$&"
18250 The value of the &$local_part$& variable is forced to lower case while a
18251 router is running unless &%caseful_local_part%& is set. When a router assigns
18252 an address to a transport, the value of &$local_part$& when the transport runs
18253 is the same as it was in the router. Similarly, when a router generates child
18254 addresses by aliasing or forwarding, the values of &$original_local_part$&
18255 and &$parent_local_part$& are those that were used by the redirecting router.
18256
18257 This option applies to the processing of an address by a router. When a
18258 recipient address is being processed in an ACL, there is a separate &%control%&
18259 modifier that can be used to specify case-sensitive processing within the ACL
18260 (see section &<<SECTcontrols>>&).
18261
18262
18263
18264 .option check_local_user routers&!? boolean false
18265 .cindex "local user, checking in router"
18266 .cindex "router" "checking for local user"
18267 .cindex "&_/etc/passwd_&"
18268 .vindex "&$home$&"
18269 When this option is true, Exim checks that the local part of the recipient
18270 address (with affixes removed if relevant) is the name of an account on the
18271 local system. The check is done by calling the &[getpwnam()]& function rather
18272 than trying to read &_/etc/passwd_& directly. This means that other methods of
18273 holding password data (such as NIS) are supported. If the local part is a local
18274 user, &$home$& is set from the password data, and can be tested in other
18275 preconditions that are evaluated after this one (the order of evaluation is
18276 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18277 overridden by &%router_home_directory%&. If the local part is not a local user,
18278 the router is skipped.
18279
18280 If you want to check that the local part is either the name of a local user
18281 or matches something else, you cannot combine &%check_local_user%& with a
18282 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18283 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18284 setting to achieve this. For example:
18285 .code
18286 local_parts = passwd;$local_part : lsearch;/etc/other/users
18287 .endd
18288 Note, however, that the side effects of &%check_local_user%& (such as setting
18289 up a home directory) do not occur when a &(passwd)& lookup is used in a
18290 &%local_parts%& (or any other) precondition.
18291
18292
18293
18294 .option condition routers&!? string&!! unset
18295 .cindex "router" "customized precondition"
18296 This option specifies a general precondition test that has to succeed for the
18297 router to be called. The &%condition%& option is the last precondition to be
18298 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18299 result is a forced failure, or an empty string, or one of the strings &"0"& or
18300 &"no"& or &"false"& (checked without regard to the case of the letters), the
18301 router is skipped, and the address is offered to the next one.
18302
18303 If the result is any other value, the router is run (as this is the last
18304 precondition to be evaluated, all the other preconditions must be true).
18305
18306 This option is unusual in that multiple &%condition%& options may be present.
18307 All &%condition%& options must succeed.
18308
18309 The &%condition%& option provides a means of applying custom conditions to the
18310 running of routers. Note that in the case of a simple conditional expansion,
18311 the default expansion values are exactly what is wanted. For example:
18312 .code
18313 condition = ${if >{$message_age}{600}}
18314 .endd
18315 Because of the default behaviour of the string expansion, this is equivalent to
18316 .code
18317 condition = ${if >{$message_age}{600}{true}{}}
18318 .endd
18319
18320 A multiple condition example, which succeeds:
18321 .code
18322 condition = ${if >{$message_age}{600}}
18323 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18324 condition = foobar
18325 .endd
18326
18327 If the expansion fails (other than forced failure) delivery is deferred. Some
18328 of the other precondition options are common special cases that could in fact
18329 be specified using &%condition%&.
18330
18331 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18332 are far older, and use one set of semantics.  ACLs are newer and when
18333 they were created, the ACL &%condition%& process was given far stricter
18334 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18335 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18336 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18337 Router rules processing behavior.
18338
18339 This is best illustrated in an example:
18340 .code
18341 # If used in an ACL condition will fail with a syntax error, but
18342 # in a router condition any extra characters are treated as a string
18343
18344 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18345 true {yes} {no}}
18346
18347 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18348  {yes} {no}}
18349 .endd
18350 In each example above, the &%if%& statement actually ends after
18351 &"{google.com}}"&.  Since no true or false braces were defined, the
18352 default &%if%& behavior is to return a boolean true or a null answer
18353 (which evaluates to false). The rest of the line is then treated as a
18354 string. So the first example resulted in the boolean answer &"true"&
18355 with the string &" {yes} {no}}"& appended to it. The second example
18356 resulted in the null output (indicating false) with the string
18357 &" {yes} {no}}"& appended to it.
18358
18359 In fact you can put excess forward braces in too.  In the router
18360 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18361 mean something, like after a &"$"& or when required as part of a
18362 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18363 string characters.
18364
18365 Thus, in a Router, the above expansion strings will both always evaluate
18366 true, as the result of expansion is a non-empty string which doesn't
18367 match an explicit false value.  This can be tricky to debug.  By
18368 contrast, in an ACL either of those strings will always result in an
18369 expansion error because the result doesn't look sufficiently boolean.
18370
18371
18372 .option debug_print routers string&!! unset
18373 .cindex "testing" "variables in drivers"
18374 If this option is set and debugging is enabled (see the &%-d%& command line
18375 option) or in address-testing mode (see the &%-bt%& command line option),
18376 the string is expanded and included in the debugging output.
18377 If expansion of the string fails, the error message is written to the debugging
18378 output, and Exim carries on processing.
18379 This option is provided to help with checking out the values of variables and
18380 so on when debugging router configurations. For example, if a &%condition%&
18381 option appears not to be working, &%debug_print%& can be used to output the
18382 variables it references. The output happens after checks for &%domains%&,
18383 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18384 are tested. A newline is added to the text if it does not end with one.
18385 The variable &$router_name$& contains the name of the router.
18386
18387
18388
18389 .option disable_logging routers boolean false
18390 If this option is set true, nothing is logged for any routing errors
18391 or for any deliveries caused by this router. You should not set this option
18392 unless you really, really know what you are doing. See also the generic
18393 transport option of the same name.
18394
18395 .option dnssec_request_domains routers "domain list&!!" *
18396 .cindex "MX record" "security"
18397 .cindex "DNSSEC" "MX lookup"
18398 .cindex "security" "MX lookup"
18399 .cindex "DNS" "DNSSEC"
18400 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18401 the dnssec request bit set.
18402 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18403
18404 .option dnssec_require_domains routers "domain list&!!" unset
18405 .cindex "MX record" "security"
18406 .cindex "DNSSEC" "MX lookup"
18407 .cindex "security" "MX lookup"
18408 .cindex "DNS" "DNSSEC"
18409 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18410 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18411 (AD bit) set will be ignored and logged as a host-lookup failure.
18412 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18413
18414
18415 .option domains routers&!? "domain list&!!" unset
18416 .cindex "router" "restricting to specific domains"
18417 .vindex "&$domain_data$&"
18418 If this option is set, the router is skipped unless the current domain matches
18419 the list. If the match is achieved by means of a file lookup, the data that the
18420 lookup returned for the domain is placed in &$domain_data$& for use in string
18421 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18422 a list of the order in which preconditions are evaluated.
18423
18424
18425
18426 .option driver routers string unset
18427 This option must always be set. It specifies which of the available routers is
18428 to be used.
18429
18430
18431 .option dsn_lasthop routers boolean false
18432 .cindex "DSN" "success"
18433 .cindex "Delivery Status Notification" "success"
18434 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18435 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18436 instead send a success DSN as if the next hop does not support DSN.
18437 Not effective on redirect routers.
18438
18439
18440
18441 .option errors_to routers string&!! unset
18442 .cindex "envelope from"
18443 .cindex "envelope sender"
18444 .cindex "router" "changing address for errors"
18445 If a router successfully handles an address, it may assign the address to a
18446 transport for delivery or it may generate child addresses. In both cases, if
18447 there is a delivery problem during later processing, the resulting bounce
18448 message is sent to the address that results from expanding this string,
18449 provided that the address verifies successfully. The &%errors_to%& option is
18450 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18451
18452 The &%errors_to%& setting associated with an address can be overridden if it
18453 subsequently passes through other routers that have their own &%errors_to%&
18454 settings, or if the message is delivered by a transport with a &%return_path%&
18455 setting.
18456
18457 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18458 the expansion fails to verify, the errors address associated with the incoming
18459 address is used. At top level, this is the envelope sender. A non-forced
18460 expansion failure causes delivery to be deferred.
18461
18462 If an address for which &%errors_to%& has been set ends up being delivered over
18463 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18464 any bounces that are generated by other MTAs on the delivery route are also
18465 sent there. You can set &%errors_to%& to the empty string by either of these
18466 settings:
18467 .code
18468 errors_to =
18469 errors_to = ""
18470 .endd
18471 An expansion item that yields an empty string has the same effect. If you do
18472 this, a locally detected delivery error for addresses processed by this router
18473 no longer gives rise to a bounce message; the error is discarded. If the
18474 address is delivered to a remote host, the return path is set to &`<>`&, unless
18475 overridden by the &%return_path%& option on the transport.
18476
18477 .vindex "&$address_data$&"
18478 If for some reason you want to discard local errors, but use a non-empty
18479 MAIL command for remote delivery, you can preserve the original return
18480 path in &$address_data$& in the router, and reinstate it in the transport by
18481 setting &%return_path%&.
18482
18483 The most common use of &%errors_to%& is to direct mailing list bounces to the
18484 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18485 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18486
18487
18488
18489 .option expn routers&!? boolean true
18490 .cindex "address" "testing"
18491 .cindex "testing" "addresses"
18492 .cindex "EXPN" "router skipping"
18493 .cindex "router" "skipping for EXPN"
18494 If this option is turned off, the router is skipped when testing an address
18495 as a result of processing an SMTP EXPN command. You might, for example,
18496 want to turn it off on a router for users' &_.forward_& files, while leaving it
18497 on for the system alias file.
18498 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18499 are evaluated.
18500
18501 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18502 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18503 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18504
18505
18506
18507 .option fail_verify routers boolean false
18508 .cindex "router" "forcing verification failure"
18509 Setting this option has the effect of setting both &%fail_verify_sender%& and
18510 &%fail_verify_recipient%& to the same value.
18511
18512
18513
18514 .option fail_verify_recipient routers boolean false
18515 If this option is true and an address is accepted by this router when
18516 verifying a recipient, verification fails.
18517
18518
18519
18520 .option fail_verify_sender routers boolean false
18521 If this option is true and an address is accepted by this router when
18522 verifying a sender, verification fails.
18523
18524
18525
18526 .option fallback_hosts routers "string list" unset
18527 .cindex "router" "fallback hosts"
18528 .cindex "fallback" "hosts specified on router"
18529 String expansion is not applied to this option. The argument must be a
18530 colon-separated list of host names or IP addresses. The list separator can be
18531 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18532 each name or address. In fact, the format of each item is exactly the same as
18533 defined for the list of hosts in a &(manualroute)& router (see section
18534 &<<SECTformatonehostitem>>&).
18535
18536 If a router queues an address for a remote transport, this host list is
18537 associated with the address, and used instead of the transport's fallback host
18538 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18539 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18540 transport for further details.
18541
18542
18543 .option group routers string&!! "see below"
18544 .cindex "gid (group id)" "local delivery"
18545 .cindex "local transports" "uid and gid"
18546 .cindex "transport" "local"
18547 .cindex "router" "setting group"
18548 When a router queues an address for a transport, and the transport does not
18549 specify a group, the group given here is used when running the delivery
18550 process.
18551 The group may be specified numerically or by name. If expansion fails, the
18552 error is logged and delivery is deferred.
18553 The default is unset, unless &%check_local_user%& is set, when the default
18554 is taken from the password information. See also &%initgroups%& and &%user%&
18555 and the discussion in chapter &<<CHAPenvironment>>&.
18556
18557
18558
18559 .option headers_add routers list&!! unset
18560 .cindex "header lines" "adding"
18561 .cindex "router" "adding header lines"
18562 This option specifies a list of text headers,
18563 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18564 that is associated with any addresses that are accepted by the router.
18565 Each item is separately expanded, at routing time.  However, this
18566 option has no effect when an address is just being verified. The way in which
18567 the text is used to add header lines at transport time is described in section
18568 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18569 message is in the process of being transported. This means that references to
18570 header lines in string expansions in the transport's configuration do not
18571 &"see"& the added header lines.
18572
18573 The &%headers_add%& option is expanded after &%errors_to%&, but before
18574 &%headers_remove%& and &%transport%&. If an item is empty, or if
18575 an item expansion is forced to fail, the item has no effect. Other expansion
18576 failures are treated as configuration errors.
18577
18578 Unlike most options, &%headers_add%& can be specified multiple times
18579 for a router; all listed headers are added.
18580
18581 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18582 router that has the &%one_time%& option set.
18583
18584 .cindex "duplicate addresses"
18585 .oindex "&%unseen%&"
18586 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18587 additions are deleted when the address is passed on to subsequent routers.
18588 For a &%redirect%& router, if a generated address is the same as the incoming
18589 address, this can lead to duplicate addresses with different header
18590 modifications. Exim does not do duplicate deliveries (except, in certain
18591 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18592 which of the duplicates is discarded, so this ambiguous situation should be
18593 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18594
18595
18596
18597 .option headers_remove routers list&!! unset
18598 .cindex "header lines" "removing"
18599 .cindex "router" "removing header lines"
18600 This option specifies a list of text headers,
18601 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18602 that is associated with any addresses that are accepted by the router.
18603 Each item is separately expanded, at routing time.  However, this
18604 option has no effect when an address is just being verified. The way in which
18605 the text is used to remove header lines at transport time is described in
18606 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18607 the message is in the process of being transported. This means that references
18608 to header lines in string expansions in the transport's configuration still
18609 &"see"& the original header lines.
18610
18611 The &%headers_remove%& option is expanded after &%errors_to%& and
18612 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18613 the item has no effect. Other expansion failures are treated as configuration
18614 errors.
18615
18616 Unlike most options, &%headers_remove%& can be specified multiple times
18617 for a router; all listed headers are removed.
18618
18619 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18620 router that has the &%one_time%& option set.
18621
18622 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18623 removal requests are deleted when the address is passed on to subsequent
18624 routers, and this can lead to problems with duplicates -- see the similar
18625 warning for &%headers_add%& above.
18626
18627 &*Warning 3*&: Because of the separate expansion of the list items,
18628 items that contain a list separator must have it doubled.
18629 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18630
18631
18632
18633 .option ignore_target_hosts routers "host list&!!" unset
18634 .cindex "IP address" "discarding"
18635 .cindex "router" "discarding IP addresses"
18636 Although this option is a host list, it should normally contain IP address
18637 entries rather than names. If any host that is looked up by the router has an
18638 IP address that matches an item in this list, Exim behaves as if that IP
18639 address did not exist. This option allows you to cope with rogue DNS entries
18640 like
18641 .code
18642 remote.domain.example.  A  127.0.0.1
18643 .endd
18644 by setting
18645 .code
18646 ignore_target_hosts = 127.0.0.1
18647 .endd
18648 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18649 discarded in this way, the router declines. In a conventional configuration, an
18650 attempt to mail to such a domain would normally provoke the &"unrouteable
18651 domain"& error, and an attempt to verify an address in the domain would fail.
18652 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18653 router declines if presented with one of the listed addresses.
18654
18655 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18656 means of the first or the second of the following settings, respectively:
18657 .code
18658 ignore_target_hosts = 0.0.0.0/0
18659 ignore_target_hosts = <; 0::0/0
18660 .endd
18661 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18662 in the second line matches all IPv6 addresses.
18663
18664 This option may also be useful for ignoring link-local and site-local IPv6
18665 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18666 is expanded before use as a list, it is possible to make it dependent on the
18667 domain that is being routed.
18668
18669 .vindex "&$host_address$&"
18670 During its expansion, &$host_address$& is set to the IP address that is being
18671 checked.
18672
18673 .option initgroups routers boolean false
18674 .cindex "additional groups"
18675 .cindex "groups" "additional"
18676 .cindex "local transports" "uid and gid"
18677 .cindex "transport" "local"
18678 If the router queues an address for a transport, and this option is true, and
18679 the uid supplied by the router is not overridden by the transport, the
18680 &[initgroups()]& function is called when running the transport to ensure that
18681 any additional groups associated with the uid are set up. See also &%group%&
18682 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18683
18684
18685
18686 .option local_part_prefix routers&!? "string list" unset
18687 .cindex affix "router precondition"
18688 .cindex "router" "prefix for local part"
18689 .cindex "prefix" "for local part, used in router"
18690 If this option is set, the router is skipped unless the local part starts with
18691 one of the given strings, or &%local_part_prefix_optional%& is true. See
18692 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18693 evaluated.
18694
18695 The list is scanned from left to right, and the first prefix that matches is
18696 used. A limited form of wildcard is available; if the prefix begins with an
18697 asterisk, it matches the longest possible sequence of arbitrary characters at
18698 the start of the local part. An asterisk should therefore always be followed by
18699 some character that does not occur in normal local parts.
18700 .cindex "multiple mailboxes"
18701 .cindex "mailbox" "multiple"
18702 Wildcarding can be used to set up multiple user mailboxes, as described in
18703 section &<<SECTmulbox>>&.
18704
18705 .vindex "&$local_part$&"
18706 .vindex "&$local_part_prefix$&"
18707 During the testing of the &%local_parts%& option, and while the router is
18708 running, the prefix is removed from the local part, and is available in the
18709 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18710 the router accepts the address, this remains true during subsequent delivery by
18711 a transport. In particular, the local part that is transmitted in the RCPT
18712 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18713 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18714 the relevant transport.
18715
18716 When an address is being verified, &%local_part_prefix%& affects only the
18717 behaviour of the router. If the callout feature of verification is in use, this
18718 means that the full address, including the prefix, will be used during the
18719 callout.
18720
18721 The prefix facility is commonly used to handle local parts of the form
18722 &%owner-something%&. Another common use is to support local parts of the form
18723 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18724 to tell a user their forwarding is broken &-- by placing a router like this one
18725 immediately before the router that handles &_.forward_& files:
18726 .code
18727 real_localuser:
18728   driver = accept
18729   local_part_prefix = real-
18730   check_local_user
18731   transport = local_delivery
18732 .endd
18733 For security, it would probably be a good idea to restrict the use of this
18734 router to locally-generated messages, using a condition such as this:
18735 .code
18736   condition = ${if match {$sender_host_address}\
18737                          {\N^(|127\.0\.0\.1)$\N}}
18738 .endd
18739
18740 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18741 both conditions must be met if not optional. Care must be taken if wildcards
18742 are used in both a prefix and a suffix on the same router. Different
18743 separator characters must be used to avoid ambiguity.
18744
18745
18746 .option local_part_prefix_optional routers boolean false
18747 See &%local_part_prefix%& above.
18748
18749
18750
18751 .option local_part_suffix routers&!? "string list" unset
18752 .cindex "router" "suffix for local part"
18753 .cindex "suffix for local part" "used in router"
18754 This option operates in the same way as &%local_part_prefix%&, except that the
18755 local part must end (rather than start) with the given string, the
18756 &%local_part_suffix_optional%& option determines whether the suffix is
18757 mandatory, and the wildcard * character, if present, must be the last
18758 character of the suffix. This option facility is commonly used to handle local
18759 parts of the form &%something-request%& and multiple user mailboxes of the form
18760 &%username-foo%&.
18761
18762
18763 .option local_part_suffix_optional routers boolean false
18764 See &%local_part_suffix%& above.
18765
18766
18767
18768 .option local_parts routers&!? "local part list&!!" unset
18769 .cindex "router" "restricting to specific local parts"
18770 .cindex "local part" "checking in router"
18771 The router is run only if the local part of the address matches the list.
18772 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18773 are evaluated, and
18774 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18775 string is expanded, it is possible to make it depend on the domain, for
18776 example:
18777 .code
18778 local_parts = dbm;/usr/local/specials/$domain
18779 .endd
18780 .vindex "&$local_part_data$&"
18781 If the match is achieved by a lookup, the data that the lookup returned
18782 for the local part is placed in the variable &$local_part_data$& for use in
18783 expansions of the router's private options. You might use this option, for
18784 example, if you have a large number of local virtual domains, and you want to
18785 send all postmaster mail to the same place without having to set up an alias in
18786 each virtual domain:
18787 .code
18788 postmaster:
18789   driver = redirect
18790   local_parts = postmaster
18791   data = postmaster@real.domain.example
18792 .endd
18793
18794
18795 .option log_as_local routers boolean "see below"
18796 .cindex "log" "delivery line"
18797 .cindex "delivery" "log line format"
18798 Exim has two logging styles for delivery, the idea being to make local
18799 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18800 recipient address is given just as the local part, without a domain. The use of
18801 this style is controlled by this option. It defaults to true for the &(accept)&
18802 router, and false for all the others. This option applies only when a
18803 router assigns an address to a transport. It has no effect on routers that
18804 redirect addresses.
18805
18806
18807
18808 .option more routers boolean&!! true
18809 The result of string expansion for this option must be a valid boolean value,
18810 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18811 result causes an error, and delivery is deferred. If the expansion is forced to
18812 fail, the default value for the option (true) is used. Other failures cause
18813 delivery to be deferred.
18814
18815 If this option is set false, and the router declines to handle the address, no
18816 further routers are tried, routing fails, and the address is bounced.
18817 .oindex "&%self%&"
18818 However, if the router explicitly passes an address to the following router by
18819 means of the setting
18820 .code
18821 self = pass
18822 .endd
18823 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18824 does not affect the behaviour if one of the precondition tests fails. In that
18825 case, the address is always passed to the next router.
18826
18827 Note that &%address_data%& is not considered to be a precondition. If its
18828 expansion is forced to fail, the router declines, and the value of &%more%&
18829 controls what happens next.
18830
18831
18832 .option pass_on_timeout routers boolean false
18833 .cindex "timeout" "of router"
18834 .cindex "router" "timeout"
18835 If a router times out during a host lookup, it normally causes deferral of the
18836 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18837 router, overriding &%no_more%&. This may be helpful for systems that are
18838 intermittently connected to the Internet, or those that want to pass to a smart
18839 host any messages that cannot immediately be delivered.
18840
18841 There are occasional other temporary errors that can occur while doing DNS
18842 lookups. They are treated in the same way as a timeout, and this option
18843 applies to all of them.
18844
18845
18846
18847 .option pass_router routers string unset
18848 .cindex "router" "go to after &""pass""&"
18849 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18850 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18851 routing to continue, and overriding a false setting of &%more%&. When one of
18852 these routers returns &"pass"&, the address is normally handed on to the next
18853 router in sequence. This can be changed by setting &%pass_router%& to the name
18854 of another router. However (unlike &%redirect_router%&) the named router must
18855 be below the current router, to avoid loops. Note that this option applies only
18856 to the special case of &"pass"&. It does not apply when a router returns
18857 &"decline"& because it cannot handle an address.
18858
18859
18860
18861 .option redirect_router routers string unset
18862 .cindex "router" "start at after redirection"
18863 Sometimes an administrator knows that it is pointless to reprocess addresses
18864 generated from alias or forward files with the same router again. For
18865 example, if an alias file translates real names into login ids there is no
18866 point searching the alias file a second time, especially if it is a large file.
18867
18868 The &%redirect_router%& option can be set to the name of any router instance.
18869 It causes the routing of any generated addresses to start at the named router
18870 instead of at the first router. This option has no effect if the router in
18871 which it is set does not generate new addresses.
18872
18873
18874
18875 .option require_files routers&!? "string list&!!" unset
18876 .cindex "file" "requiring for router"
18877 .cindex "router" "requiring file existence"
18878 This option provides a general mechanism for predicating the running of a
18879 router on the existence or non-existence of certain files or directories.
18880 Before running a router, as one of its precondition tests, Exim works its way
18881 through the &%require_files%& list, expanding each item separately.
18882
18883 Because the list is split before expansion, any colons in expansion items must
18884 be doubled, or the facility for using a different list separator must be used
18885 (&<<SECTlistsepchange>>&).
18886 If any expansion is forced to fail, the item is ignored. Other expansion
18887 failures cause routing of the address to be deferred.
18888
18889 If any expanded string is empty, it is ignored. Otherwise, except as described
18890 below, each string must be a fully qualified file path, optionally preceded by
18891 &"!"&. The paths are passed to the &[stat()]& function to test for the
18892 existence of the files or directories. The router is skipped if any paths not
18893 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18894
18895 .cindex "NFS"
18896 If &[stat()]& cannot determine whether a file exists or not, delivery of
18897 the message is deferred. This can happen when NFS-mounted filesystems are
18898 unavailable.
18899
18900 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18901 options, so you cannot use it to check for the existence of a file in which to
18902 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18903 full list of the order in which preconditions are evaluated.) However, as
18904 these options are all expanded, you can use the &%exists%& expansion condition
18905 to make such tests. The &%require_files%& option is intended for checking files
18906 that the router may be going to use internally, or which are needed by a
18907 transport (e.g., &_.procmailrc_&).
18908
18909 During delivery, the &[stat()]& function is run as root, but there is a
18910 facility for some checking of the accessibility of a file by another user.
18911 This is not a proper permissions check, but just a &"rough"& check that
18912 operates as follows:
18913
18914 If an item in a &%require_files%& list does not contain any forward slash
18915 characters, it is taken to be the user (and optional group, separated by a
18916 comma) to be checked for subsequent files in the list. If no group is specified
18917 but the user is specified symbolically, the gid associated with the uid is
18918 used. For example:
18919 .code
18920 require_files = mail:/some/file
18921 require_files = $local_part:$home/.procmailrc
18922 .endd
18923 If a user or group name in a &%require_files%& list does not exist, the
18924 &%require_files%& condition fails.
18925
18926 Exim performs the check by scanning along the components of the file path, and
18927 checking the access for the given uid and gid. It checks for &"x"& access on
18928 directories, and &"r"& access on the final file. Note that this means that file
18929 access control lists, if the operating system has them, are ignored.
18930
18931 &*Warning 1*&: When the router is being run to verify addresses for an
18932 incoming SMTP message, Exim is not running as root, but under its own uid. This
18933 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18934 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18935 user is not permitted to read one of the directories on the file's path.
18936
18937 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18938 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18939 without root access. In this case, if a check for access by a particular user
18940 is requested, Exim creates a subprocess that runs as that user, and tries the
18941 check again in that process.
18942
18943 The default action for handling an unresolved EACCES is to consider it to
18944 be caused by a configuration error, and routing is deferred because the
18945 existence or non-existence of the file cannot be determined. However, in some
18946 circumstances it may be desirable to treat this condition as if the file did
18947 not exist. If the filename (or the exclamation mark that precedes the filename
18948 for non-existence) is preceded by a plus sign, the EACCES error is treated
18949 as if the file did not exist. For example:
18950 .code
18951 require_files = +/some/file
18952 .endd
18953 If the router is not an essential part of verification (for example, it
18954 handles users' &_.forward_& files), another solution is to set the &%verify%&
18955 option false so that the router is skipped when verifying.
18956
18957
18958
18959 .option retry_use_local_part routers boolean "see below"
18960 .cindex "hints database" "retry keys"
18961 .cindex "local part" "in retry keys"
18962 When a delivery suffers a temporary routing failure, a retry record is created
18963 in Exim's hints database. For addresses whose routing depends only on the
18964 domain, the key for the retry record should not involve the local part, but for
18965 other addresses, both the domain and the local part should be included.
18966 Usually, remote routing is of the former kind, and local routing is of the
18967 latter kind.
18968
18969 This option controls whether the local part is used to form the key for retry
18970 hints for addresses that suffer temporary errors while being handled by this
18971 .new
18972 router. The default value is true for any router that has any of
18973 &%check_local_user%&,
18974 &%local_parts%&,
18975 &%condition%&,
18976 &%local_part_prefix%&,
18977 &%local_part_suffix%&,
18978 &%senders%& or
18979 &%require_files%&
18980 .wen
18981 set, and false otherwise. Note that this option does not apply to hints keys
18982 for transport delays; they are controlled by a generic transport option of the
18983 same name.
18984
18985 Failing to set this option when it is needed
18986 (because a remote router handles only some of the local-parts for a domain)
18987 can result in incorrect error messages being generated.
18988
18989 The setting of &%retry_use_local_part%& applies only to the router on which it
18990 appears. If the router generates child addresses, they are routed
18991 independently; this setting does not become attached to them.
18992
18993
18994
18995 .option router_home_directory routers string&!! unset
18996 .cindex "router" "home directory for"
18997 .cindex "home directory" "for router"
18998 .vindex "&$home$&"
18999 This option sets a home directory for use while the router is running. (Compare
19000 &%transport_home_directory%&, which sets a home directory for later
19001 transporting.) In particular, if used on a &(redirect)& router, this option
19002 sets a value for &$home$& while a filter is running. The value is expanded;
19003 forced expansion failure causes the option to be ignored &-- other failures
19004 cause the router to defer.
19005
19006 Expansion of &%router_home_directory%& happens immediately after the
19007 &%check_local_user%& test (if configured), before any further expansions take
19008 place.
19009 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19010 are evaluated.)
19011 While the router is running, &%router_home_directory%& overrides the value of
19012 &$home$& that came from &%check_local_user%&.
19013
19014 When a router accepts an address and assigns it to a local transport (including
19015 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19016 delivery), the home directory setting for the transport is taken from the first
19017 of these values that is set:
19018
19019 .ilist
19020 The &%home_directory%& option on the transport;
19021 .next
19022 The &%transport_home_directory%& option on the router;
19023 .next
19024 The password data if &%check_local_user%& is set on the router;
19025 .next
19026 The &%router_home_directory%& option on the router.
19027 .endlist
19028
19029 In other words, &%router_home_directory%& overrides the password data for the
19030 router, but not for the transport.
19031
19032
19033
19034 .option self routers string freeze
19035 .cindex "MX record" "pointing to local host"
19036 .cindex "local host" "MX pointing to"
19037 This option applies to those routers that use a recipient address to find a
19038 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19039 and &(manualroute)& routers.
19040 Certain configurations of the &(queryprogram)& router can also specify a list
19041 of remote hosts.
19042 Usually such routers are configured to send the message to a remote host via an
19043 &(smtp)& transport. The &%self%& option specifies what happens when the first
19044 host on the list turns out to be the local host.
19045 The way in which Exim checks for the local host is described in section
19046 &<<SECTreclocipadd>>&.
19047
19048 Normally this situation indicates either an error in Exim's configuration (for
19049 example, the router should be configured not to process this domain), or an
19050 error in the DNS (for example, the MX should not point to this host). For this
19051 reason, the default action is to log the incident, defer the address, and
19052 freeze the message. The following alternatives are provided for use in special
19053 cases:
19054
19055 .vlist
19056 .vitem &%defer%&
19057 Delivery of the message is tried again later, but the message is not frozen.
19058
19059 .vitem "&%reroute%&: <&'domain'&>"
19060 The domain is changed to the given domain, and the address is passed back to
19061 be reprocessed by the routers. No rewriting of headers takes place. This
19062 behaviour is essentially a redirection.
19063
19064 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19065 The domain is changed to the given domain, and the address is passed back to be
19066 reprocessed by the routers. Any headers that contain the original domain are
19067 rewritten.
19068
19069 .vitem &%pass%&
19070 .oindex "&%more%&"
19071 .vindex "&$self_hostname$&"
19072 The router passes the address to the next router, or to the router named in the
19073 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19074 subsequent routing and delivery, the variable &$self_hostname$& contains the
19075 name of the local host that the router encountered. This can be used to
19076 distinguish between different cases for hosts with multiple names. The
19077 combination
19078 .code
19079 self = pass
19080 no_more
19081 .endd
19082 ensures that only those addresses that routed to the local host are passed on.
19083 Without &%no_more%&, addresses that were declined for other reasons would also
19084 be passed to the next router.
19085
19086 .vitem &%fail%&
19087 Delivery fails and an error report is generated.
19088
19089 .vitem &%send%&
19090 .cindex "local host" "sending to"
19091 The anomaly is ignored and the address is queued for the transport. This
19092 setting should be used with extreme caution. For an &(smtp)& transport, it
19093 makes sense only in cases where the program that is listening on the SMTP port
19094 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19095 different configuration file that handles the domain in another way.
19096 .endlist
19097
19098
19099
19100 .option senders routers&!? "address list&!!" unset
19101 .cindex "router" "checking senders"
19102 If this option is set, the router is skipped unless the message's sender
19103 address matches something on the list.
19104 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19105 are evaluated.
19106
19107 There are issues concerning verification when the running of routers is
19108 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19109 setting, it sets the sender to the null string. When using the &%-bt%& option
19110 to check a configuration file, it is necessary also to use the &%-f%& option to
19111 set an appropriate sender. For incoming mail, the sender is unset when
19112 verifying the sender, but is available when verifying any recipients. If the
19113 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19114 matters.
19115
19116
19117 .new
19118 .option set routers "string list" unset
19119 .cindex router variables
19120 This option may be used multiple times on a router;
19121 because of this the list aspect is mostly irrelevant.
19122 The list separator is a semicolon but can be changed in the
19123 usual way.
19124
19125 Each list-element given must be of the form $"name = value"$
19126 and the names used must start with the string &"r_"&.
19127 Values containing a list-separator should have them doubled.
19128 When a router runs, the strings are evaluated in order,
19129 to create variables which are added to the set associated with
19130 the address.
19131 The variable is set with the expansion of the value.
19132 The variables can be used by the router options
19133 (not including any preconditions)
19134 and by the transport.
19135 Later definitions of a given named variable will override former ones.
19136 Varible use is via the usual &$r_...$& syntax.
19137
19138 This is similar to the &%address_data%& option, except that
19139 many independent variables can be used, with choice of naming.
19140 .wen
19141
19142
19143 .option translate_ip_address routers string&!! unset
19144 .cindex "IP address" "translating"
19145 .cindex "packet radio"
19146 .cindex "router" "IP address translation"
19147 There exist some rare networking situations (for example, packet radio) where
19148 it is helpful to be able to translate IP addresses generated by normal routing
19149 mechanisms into other IP addresses, thus performing a kind of manual IP
19150 routing. This should be done only if the normal IP routing of the TCP/IP stack
19151 is inadequate or broken. Because this is an extremely uncommon requirement, the
19152 code to support this option is not included in the Exim binary unless
19153 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19154
19155 .vindex "&$host_address$&"
19156 The &%translate_ip_address%& string is expanded for every IP address generated
19157 by the router, with the generated address set in &$host_address$&. If the
19158 expansion is forced to fail, no action is taken.
19159 For any other expansion error, delivery of the message is deferred.
19160 If the result of the expansion is an IP address, that replaces the original
19161 address; otherwise the result is assumed to be a host name &-- this is looked
19162 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19163 produce one or more replacement IP addresses. For example, to subvert all IP
19164 addresses in some specific networks, this could be added to a router:
19165 .code
19166 translate_ip_address = \
19167   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19168     {$value}fail}}
19169 .endd
19170 The file would contain lines like
19171 .code
19172 10.2.3.128/26    some.host
19173 10.8.4.34/26     10.44.8.15
19174 .endd
19175 You should not make use of this facility unless you really understand what you
19176 are doing.
19177
19178
19179
19180 .option transport routers string&!! unset
19181 This option specifies the transport to be used when a router accepts an address
19182 and sets it up for delivery. A transport is never needed if a router is used
19183 only for verification. The value of the option is expanded at routing time,
19184 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19185 and result must be the name of one of the configured transports. If it is not,
19186 delivery is deferred.
19187
19188 The &%transport%& option is not used by the &(redirect)& router, but it does
19189 have some private options that set up transports for pipe and file deliveries
19190 (see chapter &<<CHAPredirect>>&).
19191
19192
19193
19194 .option transport_current_directory routers string&!! unset
19195 .cindex "current directory for local transport"
19196 This option associates a current directory with any address that is routed
19197 to a local transport. This can happen either because a transport is
19198 explicitly configured for the router, or because it generates a delivery to a
19199 file or a pipe. During the delivery process (that is, at transport time), this
19200 option string is expanded and is set as the current directory, unless
19201 overridden by a setting on the transport.
19202 If the expansion fails for any reason, including forced failure, an error is
19203 logged, and delivery is deferred.
19204 See chapter &<<CHAPenvironment>>& for details of the local delivery
19205 environment.
19206
19207
19208
19209
19210 .option transport_home_directory routers string&!! "see below"
19211 .cindex "home directory" "for local transport"
19212 This option associates a home directory with any address that is routed to a
19213 local transport. This can happen either because a transport is explicitly
19214 configured for the router, or because it generates a delivery to a file or a
19215 pipe. During the delivery process (that is, at transport time), the option
19216 string is expanded and is set as the home directory, unless overridden by a
19217 setting of &%home_directory%& on the transport.
19218 If the expansion fails for any reason, including forced failure, an error is
19219 logged, and delivery is deferred.
19220
19221 If the transport does not specify a home directory, and
19222 &%transport_home_directory%& is not set for the router, the home directory for
19223 the transport is taken from the password data if &%check_local_user%& is set for
19224 the router. Otherwise it is taken from &%router_home_directory%& if that option
19225 is set; if not, no home directory is set for the transport.
19226
19227 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19228 environment.
19229
19230
19231
19232
19233 .option unseen routers boolean&!! false
19234 .cindex "router" "carrying on after success"
19235 The result of string expansion for this option must be a valid boolean value,
19236 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19237 result causes an error, and delivery is deferred. If the expansion is forced to
19238 fail, the default value for the option (false) is used. Other failures cause
19239 delivery to be deferred.
19240
19241 When this option is set true, routing does not cease if the router accepts the
19242 address. Instead, a copy of the incoming address is passed to the next router,
19243 overriding a false setting of &%more%&. There is little point in setting
19244 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19245 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19246 sometimes true and sometimes false).
19247
19248 .cindex "copy of message (&%unseen%& option)"
19249 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19250 qualifier in filter files. It can be used to cause copies of messages to be
19251 delivered to some other destination, while also carrying out a normal delivery.
19252 In effect, the current address is made into a &"parent"& that has two children
19253 &-- one that is delivered as specified by this router, and a clone that goes on
19254 to be routed further. For this reason, &%unseen%& may not be combined with the
19255 &%one_time%& option in a &(redirect)& router.
19256
19257 &*Warning*&: Header lines added to the address (or specified for removal) by
19258 this router or by previous routers affect the &"unseen"& copy of the message
19259 only. The clone that continues to be processed by further routers starts with
19260 no added headers and none specified for removal. For a &%redirect%& router, if
19261 a generated address is the same as the incoming address, this can lead to
19262 duplicate addresses with different header modifications. Exim does not do
19263 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19264 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19265 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19266 &%redirect%& router may be of help.
19267
19268 Unlike the handling of header modifications, any data that was set by the
19269 &%address_data%& option in the current or previous routers &'is'& passed on to
19270 subsequent routers.
19271
19272
19273 .option user routers string&!! "see below"
19274 .cindex "uid (user id)" "local delivery"
19275 .cindex "local transports" "uid and gid"
19276 .cindex "transport" "local"
19277 .cindex "router" "user for filter processing"
19278 .cindex "filter" "user for processing"
19279 When a router queues an address for a transport, and the transport does not
19280 specify a user, the user given here is used when running the delivery process.
19281 The user may be specified numerically or by name. If expansion fails, the
19282 error is logged and delivery is deferred.
19283 This user is also used by the &(redirect)& router when running a filter file.
19284 The default is unset, except when &%check_local_user%& is set. In this case,
19285 the default is taken from the password information. If the user is specified as
19286 a name, and &%group%& is not set, the group associated with the user is used.
19287 See also &%initgroups%& and &%group%& and the discussion in chapter
19288 &<<CHAPenvironment>>&.
19289
19290
19291
19292 .option verify routers&!? boolean true
19293 Setting this option has the effect of setting &%verify_sender%& and
19294 &%verify_recipient%& to the same value.
19295
19296
19297 .option verify_only routers&!? boolean false
19298 .cindex "EXPN" "with &%verify_only%&"
19299 .oindex "&%-bv%&"
19300 .cindex "router" "used only when verifying"
19301 If this option is set, the router is used only when verifying an address,
19302 delivering in cutthrough mode or
19303 testing with the &%-bv%& option, not when actually doing a delivery, testing
19304 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19305 restricted to verifying only senders or recipients by means of
19306 &%verify_sender%& and &%verify_recipient%&.
19307
19308 &*Warning*&: When the router is being run to verify addresses for an incoming
19309 SMTP message, Exim is not running as root, but under its own uid. If the router
19310 accesses any files, you need to make sure that they are accessible to the Exim
19311 user or group.
19312
19313
19314 .option verify_recipient routers&!? boolean true
19315 If this option is false, the router is skipped when verifying recipient
19316 addresses,
19317 delivering in cutthrough mode
19318 or testing recipient verification using &%-bv%&.
19319 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19320 are evaluated.
19321 See also the &$verify_mode$& variable.
19322
19323
19324 .option verify_sender routers&!? boolean true
19325 If this option is false, the router is skipped when verifying sender addresses
19326 or testing sender verification using &%-bvs%&.
19327 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19328 are evaluated.
19329 See also the &$verify_mode$& variable.
19330 .ecindex IIDgenoprou1
19331 .ecindex IIDgenoprou2
19332
19333
19334
19335
19336
19337
19338 . ////////////////////////////////////////////////////////////////////////////
19339 . ////////////////////////////////////////////////////////////////////////////
19340
19341 .chapter "The accept router" "CHID4"
19342 .cindex "&(accept)& router"
19343 .cindex "routers" "&(accept)&"
19344 The &(accept)& router has no private options of its own. Unless it is being
19345 used purely for verification (see &%verify_only%&) a transport is required to
19346 be defined by the generic &%transport%& option. If the preconditions that are
19347 specified by generic options are met, the router accepts the address and queues
19348 it for the given transport. The most common use of this router is for setting
19349 up deliveries to local mailboxes. For example:
19350 .code
19351 localusers:
19352   driver = accept
19353   domains = mydomain.example
19354   check_local_user
19355   transport = local_delivery
19356 .endd
19357 The &%domains%& condition in this example checks the domain of the address, and
19358 &%check_local_user%& checks that the local part is the login of a local user.
19359 When both preconditions are met, the &(accept)& router runs, and queues the
19360 address for the &(local_delivery)& transport.
19361
19362
19363
19364
19365
19366
19367 . ////////////////////////////////////////////////////////////////////////////
19368 . ////////////////////////////////////////////////////////////////////////////
19369
19370 .chapter "The dnslookup router" "CHAPdnslookup"
19371 .scindex IIDdnsrou1 "&(dnslookup)& router"
19372 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19373 The &(dnslookup)& router looks up the hosts that handle mail for the
19374 recipient's domain in the DNS. A transport must always be set for this router,
19375 unless &%verify_only%& is set.
19376
19377 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19378 SRV records. If none are found, or if SRV support is not configured,
19379 MX records are looked up. If no MX records exist, address records are sought.
19380 However, &%mx_domains%& can be set to disable the direct use of address
19381 records.
19382
19383 MX records of equal priority are sorted by Exim into a random order. Exim then
19384 looks for address records for the host names obtained from MX or SRV records.
19385 When a host has more than one IP address, they are sorted into a random order,
19386 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19387 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19388 generic option, the router declines.
19389
19390 Unless they have the highest priority (lowest MX value), MX records that point
19391 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19392 are discarded, together with any other MX records of equal or lower priority.
19393
19394 .cindex "MX record" "pointing to local host"
19395 .cindex "local host" "MX pointing to"
19396 .oindex "&%self%&" "in &(dnslookup)& router"
19397 If the host pointed to by the highest priority MX record, or looked up as an
19398 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19399 happens is controlled by the generic &%self%& option.
19400
19401
19402 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19403 There have been problems with DNS servers when SRV records are looked up.
19404 Some misbehaving servers return a DNS error or timeout when a non-existent
19405 SRV record is sought. Similar problems have in the past been reported for
19406 MX records. The global &%dns_again_means_nonexist%& option can help with this
19407 problem, but it is heavy-handed because it is a global option.
19408
19409 For this reason, there are two options, &%srv_fail_domains%& and
19410 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19411 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19412 an attempt to look up an SRV or MX record causes one of these results, and the
19413 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19414 such record"&. In the case of an SRV lookup, this means that the router
19415 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19416 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19417 case routing fails.
19418
19419
19420 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19421 .cindex "&(dnslookup)& router" "declines"
19422 There are a few cases where a &(dnslookup)& router will decline to accept
19423 an address; if such a router is expected to handle "all remaining non-local
19424 domains", then it is important to set &%no_more%&.
19425
19426 The router will defer rather than decline if the domain
19427 is found in the &%fail_defer_domains%& router option.
19428
19429 Reasons for a &(dnslookup)& router to decline currently include:
19430 .ilist
19431 The domain does not exist in DNS
19432 .next
19433 The domain exists but the MX record's host part is just "."; this is a common
19434 convention (borrowed from SRV) used to indicate that there is no such service
19435 for this domain and to not fall back to trying A/AAAA records.
19436 .next
19437 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19438 .next
19439 MX record points to a non-existent host.
19440 .next
19441 MX record points to an IP address and the main section option
19442 &%allow_mx_to_ip%& is not set.
19443 .next
19444 MX records exist and point to valid hosts, but all hosts resolve only to
19445 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19446 .next
19447 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19448 &%dns_check_names_pattern%& for handling one variant of this)
19449 .next
19450 &%check_secondary_mx%& is set on this router but the local host can
19451 not be found in the MX records (see below)
19452 .endlist
19453
19454
19455
19456
19457 .section "Private options for dnslookup" "SECID118"
19458 .cindex "options" "&(dnslookup)& router"
19459 The private options for the &(dnslookup)& router are as follows:
19460
19461 .option check_secondary_mx dnslookup boolean false
19462 .cindex "MX record" "checking for secondary"
19463 If this option is set, the router declines unless the local host is found in
19464 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19465 process domains for which the local host is a secondary mail exchanger
19466 differently to other domains. The way in which Exim decides whether a host is
19467 the local host is described in section &<<SECTreclocipadd>>&.
19468
19469
19470 .option check_srv dnslookup string&!! unset
19471 .cindex "SRV record" "enabling use of"
19472 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19473 addition to MX and address records. The support is disabled by default. To
19474 enable SRV support, set the &%check_srv%& option to the name of the service
19475 required. For example,
19476 .code
19477 check_srv = smtp
19478 .endd
19479 looks for SRV records that refer to the normal smtp service. The option is
19480 expanded, so the service name can vary from message to message or address
19481 to address. This might be helpful if SRV records are being used for a
19482 submission service. If the expansion is forced to fail, the &%check_srv%&
19483 option is ignored, and the router proceeds to look for MX records in the
19484 normal way.
19485
19486 When the expansion succeeds, the router searches first for SRV records for
19487 the given service (it assumes TCP protocol). A single SRV record with a
19488 host name that consists of just a single dot indicates &"no such service for
19489 this domain"&; if this is encountered, the router declines. If other kinds of
19490 SRV record are found, they are used to construct a host list for delivery
19491 according to the rules of RFC 2782. MX records are not sought in this case.
19492
19493 When no SRV records are found, MX records (and address records) are sought in
19494 the traditional way. In other words, SRV records take precedence over MX
19495 records, just as MX records take precedence over address records. Note that
19496 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19497 defined it. It is apparently believed that MX records are sufficient for email
19498 and that SRV records should not be used for this purpose. However, SRV records
19499 have an additional &"weight"& feature which some people might find useful when
19500 trying to split an SMTP load between hosts of different power.
19501
19502 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19503 when there is a DNS lookup error.
19504
19505
19506
19507
19508 .option fail_defer_domains dnslookup "domain list&!!" unset
19509 .cindex "MX record" "not found"
19510 DNS lookups for domains matching &%fail_defer_domains%&
19511 which find no matching record will cause the router to defer
19512 rather than the default behaviour of decline.
19513 This maybe be useful for queueing messages for a newly created
19514 domain while the DNS configuration is not ready.
19515 However, it will result in any message with mistyped domains
19516 also being queued.
19517
19518
19519 .option ipv4_only "string&!!" unset
19520 .cindex IPv6 disabling
19521 .cindex DNS "IPv6 disabling"
19522 The string is expanded, and if the result is anything but a forced failure,
19523 or an empty string, or one of the strings “0” or “no” or “false”
19524 (checked without regard to the case of the letters),
19525 only A records are used.
19526
19527 .option ipv4_prefer "string&!!" unset
19528 .cindex IPv4 preference
19529 .cindex DNS "IPv4 preference"
19530 The string is expanded, and if the result is anything but a forced failure,
19531 or an empty string, or one of the strings “0” or “no” or “false”
19532 (checked without regard to the case of the letters),
19533 A records are sorted before AAAA records (inverting the default).
19534
19535 .option mx_domains dnslookup "domain list&!!" unset
19536 .cindex "MX record" "required to exist"
19537 .cindex "SRV record" "required to exist"
19538 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19539 record in order to be recognized. (The name of this option could be improved.)
19540 For example, if all the mail hosts in &'fict.example'& are known to have MX
19541 records, except for those in &'discworld.fict.example'&, you could use this
19542 setting:
19543 .code
19544 mx_domains = ! *.discworld.fict.example : *.fict.example
19545 .endd
19546 This specifies that messages addressed to a domain that matches the list but
19547 has no MX record should be bounced immediately instead of being routed using
19548 the address record.
19549
19550
19551 .option mx_fail_domains dnslookup "domain list&!!" unset
19552 If the DNS lookup for MX records for one of the domains in this list causes a
19553 DNS lookup error, Exim behaves as if no MX records were found. See section
19554 &<<SECTprowitdnsloo>>& for more discussion.
19555
19556
19557
19558
19559 .option qualify_single dnslookup boolean true
19560 .cindex "DNS" "resolver options"
19561 .cindex "DNS" "qualifying single-component names"
19562 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19563 lookups. Typically, but not standardly, this causes the resolver to qualify
19564 single-component names with the default domain. For example, on a machine
19565 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19566 &'thesaurus.ref.example'& inside the resolver. For details of what your
19567 resolver actually does, consult your man pages for &'resolver'& and
19568 &'resolv.conf'&.
19569
19570
19571
19572 .option rewrite_headers dnslookup boolean true
19573 .cindex "rewriting" "header lines"
19574 .cindex "header lines" "rewriting"
19575 If the domain name in the address that is being processed is not fully
19576 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19577 an address is specified as &'dormouse@teaparty'&, the domain might be
19578 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19579 occur as a result of setting the &%widen_domains%& option. If
19580 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19581 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19582 header lines of the message are rewritten with the full domain name.
19583
19584 This option should be turned off only when it is known that no message is
19585 ever going to be sent outside an environment where the abbreviation makes
19586 sense.
19587
19588 When an MX record is looked up in the DNS and matches a wildcard record, name
19589 servers normally return a record containing the name that has been looked up,
19590 making it impossible to detect whether a wildcard was present or not. However,
19591 some name servers have recently been seen to return the wildcard entry. If the
19592 name returned by a DNS lookup begins with an asterisk, it is not used for
19593 header rewriting.
19594
19595
19596 .option same_domain_copy_routing dnslookup boolean false
19597 .cindex "address" "copying routing"
19598 Addresses with the same domain are normally routed by the &(dnslookup)& router
19599 to the same list of hosts. However, this cannot be presumed, because the router
19600 options and preconditions may refer to the local part of the address. By
19601 default, therefore, Exim routes each address in a message independently. DNS
19602 servers run caches, so repeated DNS lookups are not normally expensive, and in
19603 any case, personal messages rarely have more than a few recipients.
19604
19605 If you are running mailing lists with large numbers of subscribers at the same
19606 domain, and you are using a &(dnslookup)& router which is independent of the
19607 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19608 lookups for identical domains in one message. In this case, when &(dnslookup)&
19609 routes an address to a remote transport, any other unrouted addresses in the
19610 message that have the same domain are automatically given the same routing
19611 without processing them independently,
19612 provided the following conditions are met:
19613
19614 .ilist
19615 No router that processed the address specified &%headers_add%& or
19616 &%headers_remove%&.
19617 .next
19618 The router did not change the address in any way, for example, by &"widening"&
19619 the domain.
19620 .endlist
19621
19622
19623
19624
19625 .option search_parents dnslookup boolean false
19626 .cindex "DNS" "resolver options"
19627 When this option is true, the resolver option RES_DNSRCH is set for DNS
19628 lookups. This is different from the &%qualify_single%& option in that it
19629 applies to domains containing dots. Typically, but not standardly, it causes
19630 the resolver to search for the name in the current domain and in parent
19631 domains. For example, on a machine in the &'fict.example'& domain, if looking
19632 up &'teaparty.wonderland'& failed, the resolver would try
19633 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19634 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19635
19636 Setting this option true can cause problems in domains that have a wildcard MX
19637 record, because any domain that does not have its own MX record matches the
19638 local wildcard.
19639
19640
19641
19642 .option srv_fail_domains dnslookup "domain list&!!" unset
19643 If the DNS lookup for SRV records for one of the domains in this list causes a
19644 DNS lookup error, Exim behaves as if no SRV records were found. See section
19645 &<<SECTprowitdnsloo>>& for more discussion.
19646
19647
19648
19649
19650 .option widen_domains dnslookup "string list" unset
19651 .cindex "domain" "partial; widening"
19652 If a DNS lookup fails and this option is set, each of its strings in turn is
19653 added onto the end of the domain, and the lookup is tried again. For example,
19654 if
19655 .code
19656 widen_domains = fict.example:ref.example
19657 .endd
19658 is set and a lookup of &'klingon.dictionary'& fails,
19659 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19660 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19661 and &%search_parents%& options can cause some widening to be undertaken inside
19662 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19663 when verifying, unless &%rewrite_headers%& is false (not the default).
19664
19665
19666 .section "Effect of qualify_single and search_parents" "SECID119"
19667 When a domain from an envelope recipient is changed by the resolver as a result
19668 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19669 corresponding address in the message's header lines unless &%rewrite_headers%&
19670 is set false. Exim then re-routes the address, using the full domain.
19671
19672 These two options affect only the DNS lookup that takes place inside the router
19673 for the domain of the address that is being routed. They do not affect lookups
19674 such as that implied by
19675 .code
19676 domains = @mx_any
19677 .endd
19678 that may happen while processing a router precondition before the router is
19679 entered. No widening ever takes place for these lookups.
19680 .ecindex IIDdnsrou1
19681 .ecindex IIDdnsrou2
19682
19683
19684
19685
19686
19687
19688
19689
19690
19691 . ////////////////////////////////////////////////////////////////////////////
19692 . ////////////////////////////////////////////////////////////////////////////
19693
19694 .chapter "The ipliteral router" "CHID5"
19695 .cindex "&(ipliteral)& router"
19696 .cindex "domain literal" "routing"
19697 .cindex "routers" "&(ipliteral)&"
19698 This router has no private options. Unless it is being used purely for
19699 verification (see &%verify_only%&) a transport is required to be defined by the
19700 generic &%transport%& option. The router accepts the address if its domain part
19701 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19702 router handles the address
19703 .code
19704 root@[192.168.1.1]
19705 .endd
19706 by setting up delivery to the host with that IP address. IPv4 domain literals
19707 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19708 are similar, but the address is preceded by &`ipv6:`&. For example:
19709 .code
19710 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19711 .endd
19712 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19713 grounds that sooner or later somebody will try it.
19714
19715 .oindex "&%self%&" "in &(ipliteral)& router"
19716 If the IP address matches something in &%ignore_target_hosts%&, the router
19717 declines. If an IP literal turns out to refer to the local host, the generic
19718 &%self%& option determines what happens.
19719
19720 The RFCs require support for domain literals; however, their use is
19721 controversial in today's Internet. If you want to use this router, you must
19722 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19723 Exim will not recognize the domain literal syntax in addresses.
19724
19725
19726
19727 . ////////////////////////////////////////////////////////////////////////////
19728 . ////////////////////////////////////////////////////////////////////////////
19729
19730 .chapter "The iplookup router" "CHID6"
19731 .cindex "&(iplookup)& router"
19732 .cindex "routers" "&(iplookup)&"
19733 The &(iplookup)& router was written to fulfil a specific requirement in
19734 Cambridge University (which in fact no longer exists). For this reason, it is
19735 not included in the binary of Exim by default. If you want to include it, you
19736 must set
19737 .code
19738 ROUTER_IPLOOKUP=yes
19739 .endd
19740 in your &_Local/Makefile_& configuration file.
19741
19742 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19743 connection to one or more specific hosts. The host can then return the same or
19744 a different address &-- in effect rewriting the recipient address in the
19745 message's envelope. The new address is then passed on to subsequent routers. If
19746 this process fails, the address can be passed on to other routers, or delivery
19747 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19748 must not be specified for it.
19749
19750 .cindex "options" "&(iplookup)& router"
19751 .option hosts iplookup string unset
19752 This option must be supplied. Its value is a colon-separated list of host
19753 names. The hosts are looked up using &[gethostbyname()]&
19754 (or &[getipnodebyname()]& when available)
19755 and are tried in order until one responds to the query. If none respond, what
19756 happens is controlled by &%optional%&.
19757
19758
19759 .option optional iplookup boolean false
19760 If &%optional%& is true, if no response is obtained from any host, the address
19761 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19762 delivery to the address is deferred.
19763
19764
19765 .option port iplookup integer 0
19766 .cindex "port" "&(iplookup)& router"
19767 This option must be supplied. It specifies the port number for the TCP or UDP
19768 call.
19769
19770
19771 .option protocol iplookup string udp
19772 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19773 protocols is to be used.
19774
19775
19776 .option query iplookup string&!! "see below"
19777 This defines the content of the query that is sent to the remote hosts. The
19778 default value is:
19779 .code
19780 $local_part@$domain $local_part@$domain
19781 .endd
19782 The repetition serves as a way of checking that a response is to the correct
19783 query in the default case (see &%response_pattern%& below).
19784
19785
19786 .option reroute iplookup string&!! unset
19787 If this option is not set, the rerouted address is precisely the byte string
19788 returned by the remote host, up to the first white space, if any. If set, the
19789 string is expanded to form the rerouted address. It can include parts matched
19790 in the response by &%response_pattern%& by means of numeric variables such as
19791 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19792 whether or not a pattern is in use. In all cases, the rerouted address must end
19793 up in the form &'local_part@domain'&.
19794
19795
19796 .option response_pattern iplookup string unset
19797 This option can be set to a regular expression that is applied to the string
19798 returned from the remote host. If the pattern does not match the response, the
19799 router declines. If &%response_pattern%& is not set, no checking of the
19800 response is done, unless the query was defaulted, in which case there is a
19801 check that the text returned after the first white space is the original
19802 address. This checks that the answer that has been received is in response to
19803 the correct question. For example, if the response is just a new domain, the
19804 following could be used:
19805 .code
19806 response_pattern = ^([^@]+)$
19807 reroute = $local_part@$1
19808 .endd
19809
19810 .option timeout iplookup time 5s
19811 This specifies the amount of time to wait for a response from the remote
19812 machine. The same timeout is used for the &[connect()]& function for a TCP
19813 call. It does not apply to UDP.
19814
19815
19816
19817
19818 . ////////////////////////////////////////////////////////////////////////////
19819 . ////////////////////////////////////////////////////////////////////////////
19820
19821 .chapter "The manualroute router" "CHID7"
19822 .scindex IIDmanrou1 "&(manualroute)& router"
19823 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19824 .cindex "domain" "manually routing"
19825 The &(manualroute)& router is so-called because it provides a way of manually
19826 routing an address according to its domain. It is mainly used when you want to
19827 route addresses to remote hosts according to your own rules, bypassing the
19828 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19829 route to local transports, a facility that may be useful if you want to save
19830 messages for dial-in hosts in local files.
19831
19832 The &(manualroute)& router compares a list of domain patterns with the domain
19833 it is trying to route. If there is no match, the router declines. Each pattern
19834 has associated with it a list of hosts and some other optional data, which may
19835 include a transport. The combination of a pattern and its data is called a
19836 &"routing rule"&. For patterns that do not have an associated transport, the
19837 generic &%transport%& option must specify a transport, unless the router is
19838 being used purely for verification (see &%verify_only%&).
19839
19840 .vindex "&$host$&"
19841 In the case of verification, matching the domain pattern is sufficient for the
19842 router to accept the address. When actually routing an address for delivery,
19843 an address that matches a domain pattern is queued for the associated
19844 transport. If the transport is not a local one, a host list must be associated
19845 with the pattern; IP addresses are looked up for the hosts, and these are
19846 passed to the transport along with the mail address. For local transports, a
19847 host list is optional. If it is present, it is passed in &$host$& as a single
19848 text string.
19849
19850 The list of routing rules can be provided as an inline string in
19851 &%route_list%&, or the data can be obtained by looking up the domain in a file
19852 or database by setting &%route_data%&. Only one of these settings may appear in
19853 any one instance of &(manualroute)&. The format of routing rules is described
19854 below, following the list of private options.
19855
19856
19857 .section "Private options for manualroute" "SECTprioptman"
19858
19859 .cindex "options" "&(manualroute)& router"
19860 The private options for the &(manualroute)& router are as follows:
19861
19862 .option host_all_ignored manualroute string defer
19863 See &%host_find_failed%&.
19864
19865 .option host_find_failed manualroute string freeze
19866 This option controls what happens when &(manualroute)& tries to find an IP
19867 address for a host, and the host does not exist. The option can be set to one
19868 of the following values:
19869 .code
19870 decline
19871 defer
19872 fail
19873 freeze
19874 ignore
19875 pass
19876 .endd
19877 The default (&"freeze"&) assumes that this state is a serious configuration
19878 error. The difference between &"pass"& and &"decline"& is that the former
19879 forces the address to be passed to the next router (or the router defined by
19880 &%pass_router%&),
19881 .oindex "&%more%&"
19882 overriding &%no_more%&, whereas the latter passes the address to the next
19883 router only if &%more%& is true.
19884
19885 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19886 cannot be found. If all the hosts in the list are ignored, the behaviour is
19887 controlled by the &%host_all_ignored%& option. This takes the same values
19888 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19889
19890 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19891 state; if a host lookup gets a temporary error, delivery is deferred unless the
19892 generic &%pass_on_timeout%& option is set.
19893
19894
19895 .option hosts_randomize manualroute boolean false
19896 .cindex "randomized host list"
19897 .cindex "host" "list of; randomized"
19898 If this option is set, the order of the items in a host list in a routing rule
19899 is randomized each time the list is used, unless an option in the routing rule
19900 overrides (see below). Randomizing the order of a host list can be used to do
19901 crude load sharing. However, if more than one mail address is routed by the
19902 same router to the same host list, the host lists are considered to be the same
19903 (even though they may be randomized into different orders) for the purpose of
19904 deciding whether to batch the deliveries into a single SMTP transaction.
19905
19906 When &%hosts_randomize%& is true, a host list may be split
19907 into groups whose order is separately randomized. This makes it possible to
19908 set up MX-like behaviour. The boundaries between groups are indicated by an
19909 item that is just &`+`& in the host list. For example:
19910 .code
19911 route_list = * host1:host2:host3:+:host4:host5
19912 .endd
19913 The order of the first three hosts and the order of the last two hosts is
19914 randomized for each use, but the first three always end up before the last two.
19915 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19916 randomized host list is passed to an &(smtp)& transport that also has
19917 &%hosts_randomize set%&, the list is not re-randomized.
19918
19919
19920 .option route_data manualroute string&!! unset
19921 If this option is set, it must expand to yield the data part of a routing rule.
19922 Typically, the expansion string includes a lookup based on the domain. For
19923 example:
19924 .code
19925 route_data = ${lookup{$domain}dbm{/etc/routes}}
19926 .endd
19927 If the expansion is forced to fail, or the result is an empty string, the
19928 router declines. Other kinds of expansion failure cause delivery to be
19929 deferred.
19930
19931
19932 .option route_list manualroute "string list" unset
19933 This string is a list of routing rules, in the form defined below. Note that,
19934 unlike most string lists, the items are separated by semicolons. This is so
19935 that they may contain colon-separated host lists.
19936
19937
19938 .option same_domain_copy_routing manualroute boolean false
19939 .cindex "address" "copying routing"
19940 Addresses with the same domain are normally routed by the &(manualroute)&
19941 router to the same list of hosts. However, this cannot be presumed, because the
19942 router options and preconditions may refer to the local part of the address. By
19943 default, therefore, Exim routes each address in a message independently. DNS
19944 servers run caches, so repeated DNS lookups are not normally expensive, and in
19945 any case, personal messages rarely have more than a few recipients.
19946
19947 If you are running mailing lists with large numbers of subscribers at the same
19948 domain, and you are using a &(manualroute)& router which is independent of the
19949 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19950 lookups for identical domains in one message. In this case, when
19951 &(manualroute)& routes an address to a remote transport, any other unrouted
19952 addresses in the message that have the same domain are automatically given the
19953 same routing without processing them independently. However, this is only done
19954 if &%headers_add%& and &%headers_remove%& are unset.
19955
19956
19957
19958
19959 .section "Routing rules in route_list" "SECID120"
19960 The value of &%route_list%& is a string consisting of a sequence of routing
19961 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19962 entered as two semicolons. Alternatively, the list separator can be changed as
19963 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19964 Empty rules are ignored. The format of each rule is
19965 .display
19966 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19967 .endd
19968 The following example contains two rules, each with a simple domain pattern and
19969 no options:
19970 .code
19971 route_list = \
19972   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19973   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19974 .endd
19975 The three parts of a rule are separated by white space. The pattern and the
19976 list of hosts can be enclosed in quotes if necessary, and if they are, the
19977 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19978 single domain pattern, which is the only mandatory item in the rule. The
19979 pattern is in the same format as one item in a domain list (see section
19980 &<<SECTdomainlist>>&),
19981 except that it may not be the name of an interpolated file.
19982 That is, it may be wildcarded, or a regular expression, or a file or database
19983 lookup (with semicolons doubled, because of the use of semicolon as a separator
19984 in a &%route_list%&).
19985
19986 The rules in &%route_list%& are searched in order until one of the patterns
19987 matches the domain that is being routed. The list of hosts and then options are
19988 then used as described below. If there is no match, the router declines. When
19989 &%route_list%& is set, &%route_data%& must not be set.
19990
19991
19992
19993 .section "Routing rules in route_data" "SECID121"
19994 The use of &%route_list%& is convenient when there are only a small number of
19995 routing rules. For larger numbers, it is easier to use a file or database to
19996 hold the routing information, and use the &%route_data%& option instead.
19997 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19998 Most commonly, &%route_data%& is set as a string that contains an
19999 expansion lookup. For example, suppose we place two routing rules in a file
20000 like this:
20001 .code
20002 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20003 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20004 .endd
20005 This data can be accessed by setting
20006 .code
20007 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20008 .endd
20009 Failure of the lookup results in an empty string, causing the router to
20010 decline. However, you do not have to use a lookup in &%route_data%&. The only
20011 requirement is that the result of expanding the string is a list of hosts,
20012 possibly followed by options, separated by white space. The list of hosts must
20013 be enclosed in quotes if it contains white space.
20014
20015
20016
20017
20018 .section "Format of the list of hosts" "SECID122"
20019 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20020 always separately expanded before use. If the expansion fails, the router
20021 declines. The result of the expansion must be a colon-separated list of names
20022 and/or IP addresses, optionally also including ports.
20023 If the list is written with spaces, it must be protected with quotes.
20024 The format of each item
20025 in the list is described in the next section. The list separator can be changed
20026 as described in section &<<SECTlistsepchange>>&.
20027
20028 If the list of hosts was obtained from a &%route_list%& item, the following
20029 variables are set during its expansion:
20030
20031 .ilist
20032 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20033 If the domain was matched against a regular expression, the numeric variables
20034 &$1$&, &$2$&, etc. may be set. For example:
20035 .code
20036 route_list = ^domain(\d+)   host-$1.text.example
20037 .endd
20038 .next
20039 &$0$& is always set to the entire domain.
20040 .next
20041 &$1$& is also set when partial matching is done in a file lookup.
20042
20043 .next
20044 .vindex "&$value$&"
20045 If the pattern that matched the domain was a lookup item, the data that was
20046 looked up is available in the expansion variable &$value$&. For example:
20047 .code
20048 route_list = lsearch;;/some/file.routes  $value
20049 .endd
20050 .endlist
20051
20052 Note the doubling of the semicolon in the pattern that is necessary because
20053 semicolon is the default route list separator.
20054
20055
20056
20057 .section "Format of one host item" "SECTformatonehostitem"
20058 Each item in the list of hosts is either a host name or an IP address,
20059 optionally with an attached port number. When no port is given, an IP address
20060 is not enclosed in brackets. When a port is specified, it overrides the port
20061 specification on the transport. The port is separated from the name or address
20062 by a colon. This leads to some complications:
20063
20064 .ilist
20065 Because colon is the default separator for the list of hosts, either
20066 the colon that specifies a port must be doubled, or the list separator must
20067 be changed. The following two examples have the same effect:
20068 .code
20069 route_list = * "host1.tld::1225 : host2.tld::1226"
20070 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20071 .endd
20072 .next
20073 When IPv6 addresses are involved, it gets worse, because they contain
20074 colons of their own. To make this case easier, it is permitted to
20075 enclose an IP address (either v4 or v6) in square brackets if a port
20076 number follows. For example:
20077 .code
20078 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20079 .endd
20080 .endlist
20081
20082 .section "How the list of hosts is used" "SECThostshowused"
20083 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20084 the hosts is tried, in the order specified, when carrying out the SMTP
20085 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20086 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20087 transport.
20088
20089 Hosts may be listed by name or by IP address. An unadorned name in the list of
20090 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20091 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20092 records in the DNS. For example:
20093 .code
20094 route_list = *  x.y.z:p.q.r/MX:e.f.g
20095 .endd
20096 If this feature is used with a port specifier, the port must come last. For
20097 example:
20098 .code
20099 route_list = *  dom1.tld/mx::1225
20100 .endd
20101 If the &%hosts_randomize%& option is set, the order of the items in the list is
20102 randomized before any lookups are done. Exim then scans the list; for any name
20103 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20104 be an interface on the local host and the item is not the first in the list,
20105 Exim discards it and any subsequent items. If it is the first item, what
20106 happens is controlled by the
20107 .oindex "&%self%&" "in &(manualroute)& router"
20108 &%self%& option of the router.
20109
20110 A name on the list that is followed by &`/MX`& is replaced with the list of
20111 hosts obtained by looking up MX records for the name. This is always a DNS
20112 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20113 below) are not relevant here. The order of these hosts is determined by the
20114 preference values in the MX records, according to the usual rules. Because
20115 randomizing happens before the MX lookup, it does not affect the order that is
20116 defined by MX preferences.
20117
20118 If the local host is present in the sublist obtained from MX records, but is
20119 not the most preferred host in that list, it and any equally or less
20120 preferred hosts are removed before the sublist is inserted into the main list.
20121
20122 If the local host is the most preferred host in the MX list, what happens
20123 depends on where in the original list of hosts the &`/MX`& item appears. If it
20124 is not the first item (that is, there are previous hosts in the main list),
20125 Exim discards this name and any subsequent items in the main list.
20126
20127 If the MX item is first in the list of hosts, and the local host is the
20128 most preferred host, what happens is controlled by the &%self%& option of the
20129 router.
20130
20131 DNS failures when lookup up the MX records are treated in the same way as DNS
20132 failures when looking up IP addresses: &%pass_on_timeout%& and
20133 &%host_find_failed%& are used when relevant.
20134
20135 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20136 whether obtained from an MX lookup or not.
20137
20138
20139
20140 .section "How the options are used" "SECThowoptused"
20141 The options are a sequence of words, space-separated.
20142 One of the words can be the name of a transport; this overrides the
20143 &%transport%& option on the router for this particular routing rule only. The
20144 other words (if present) control randomization of the list of hosts on a
20145 per-rule basis, and how the IP addresses of the hosts are to be found when
20146 routing to a remote transport. These options are as follows:
20147
20148 .ilist
20149 &%randomize%&: randomize the order of the hosts in this list, overriding the
20150 setting of &%hosts_randomize%& for this routing rule only.
20151 .next
20152 &%no_randomize%&: do not randomize the order of the hosts in this list,
20153 overriding the setting of &%hosts_randomize%& for this routing rule only.
20154 .next
20155 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20156 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20157 also look in &_/etc/hosts_& or other sources of information.
20158 .next
20159 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20160 no address records are found. If there is a temporary DNS error (such as a
20161 timeout), delivery is deferred.
20162 .next
20163 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20164 .next
20165 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20166 .endlist
20167
20168 For example:
20169 .code
20170 route_list = domain1  host1:host2:host3  randomize bydns;\
20171              domain2  host4:host5
20172 .endd
20173 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20174 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20175 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20176 or &[gethostbyname()]&, and the result of the lookup is the result of that
20177 call.
20178
20179 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20180 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20181 instead of TRY_AGAIN. That is why the default action is to try a DNS
20182 lookup first. Only if that gives a definite &"no such host"& is the local
20183 function called.
20184
20185 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20186 inadvertent constraint that a transport name as an option had to be the last
20187 option specified.
20188
20189
20190
20191 If no IP address for a host can be found, what happens is controlled by the
20192 &%host_find_failed%& option.
20193
20194 .vindex "&$host$&"
20195 When an address is routed to a local transport, IP addresses are not looked up.
20196 The host list is passed to the transport in the &$host$& variable.
20197
20198
20199
20200 .section "Manualroute examples" "SECID123"
20201 In some of the examples that follow, the presence of the &%remote_smtp%&
20202 transport, as defined in the default configuration file, is assumed:
20203
20204 .ilist
20205 .cindex "smart host" "example router"
20206 The &(manualroute)& router can be used to forward all external mail to a
20207 &'smart host'&. If you have set up, in the main part of the configuration, a
20208 named domain list that contains your local domains, for example:
20209 .code
20210 domainlist local_domains = my.domain.example
20211 .endd
20212 You can arrange for all other domains to be routed to a smart host by making
20213 your first router something like this:
20214 .code
20215 smart_route:
20216   driver = manualroute
20217   domains = !+local_domains
20218   transport = remote_smtp
20219   route_list = * smarthost.ref.example
20220 .endd
20221 This causes all non-local addresses to be sent to the single host
20222 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20223 they are tried in order
20224 (but you can use &%hosts_randomize%& to vary the order each time).
20225 Another way of configuring the same thing is this:
20226 .code
20227 smart_route:
20228   driver = manualroute
20229   transport = remote_smtp
20230   route_list = !+local_domains  smarthost.ref.example
20231 .endd
20232 There is no difference in behaviour between these two routers as they stand.
20233 However, they behave differently if &%no_more%& is added to them. In the first
20234 example, the router is skipped if the domain does not match the &%domains%&
20235 precondition; the following router is always tried. If the router runs, it
20236 always matches the domain and so can never decline. Therefore, &%no_more%&
20237 would have no effect. In the second case, the router is never skipped; it
20238 always runs. However, if it doesn't match the domain, it declines. In this case
20239 &%no_more%& would prevent subsequent routers from running.
20240
20241 .next
20242 .cindex "mail hub example"
20243 A &'mail hub'& is a host which receives mail for a number of domains via MX
20244 records in the DNS and delivers it via its own private routing mechanism. Often
20245 the final destinations are behind a firewall, with the mail hub being the one
20246 machine that can connect to machines both inside and outside the firewall. The
20247 &(manualroute)& router is usually used on a mail hub to route incoming messages
20248 to the correct hosts. For a small number of domains, the routing can be inline,
20249 using the &%route_list%& option, but for a larger number a file or database
20250 lookup is easier to manage.
20251
20252 If the domain names are in fact the names of the machines to which the mail is
20253 to be sent by the mail hub, the configuration can be quite simple. For
20254 example:
20255 .code
20256 hub_route:
20257   driver = manualroute
20258   transport = remote_smtp
20259   route_list = *.rhodes.tvs.example  $domain
20260 .endd
20261 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20262 whose names are the same as the mail domains. A similar approach can be taken
20263 if the host name can be obtained from the domain name by a string manipulation
20264 that the expansion facilities can handle. Otherwise, a lookup based on the
20265 domain can be used to find the host:
20266 .code
20267 through_firewall:
20268   driver = manualroute
20269   transport = remote_smtp
20270   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20271 .endd
20272 The result of the lookup must be the name or IP address of the host (or
20273 hosts) to which the address is to be routed. If the lookup fails, the route
20274 data is empty, causing the router to decline. The address then passes to the
20275 next router.
20276
20277 .next
20278 .cindex "batched SMTP output example"
20279 .cindex "SMTP" "batched outgoing; example"
20280 You can use &(manualroute)& to deliver messages to pipes or files in batched
20281 SMTP format for onward transportation by some other means. This is one way of
20282 storing mail for a dial-up host when it is not connected. The route list entry
20283 can be as simple as a single domain name in a configuration like this:
20284 .code
20285 save_in_file:
20286   driver = manualroute
20287   transport = batchsmtp_appendfile
20288   route_list = saved.domain.example
20289 .endd
20290 though often a pattern is used to pick up more than one domain. If there are
20291 several domains or groups of domains with different transport requirements,
20292 different transports can be listed in the routing information:
20293 .code
20294 save_in_file:
20295   driver = manualroute
20296   route_list = \
20297     *.saved.domain1.example  $domain  batch_appendfile; \
20298     *.saved.domain2.example  \
20299       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20300       batch_pipe
20301 .endd
20302 .vindex "&$domain$&"
20303 .vindex "&$host$&"
20304 The first of these just passes the domain in the &$host$& variable, which
20305 doesn't achieve much (since it is also in &$domain$&), but the second does a
20306 file lookup to find a value to pass, causing the router to decline to handle
20307 the address if the lookup fails.
20308
20309 .next
20310 .cindex "UUCP" "example of router for"
20311 Routing mail directly to UUCP software is a specific case of the use of
20312 &(manualroute)& in a gateway to another mail environment. This is an example of
20313 one way it can be done:
20314 .code
20315 # Transport
20316 uucp:
20317   driver = pipe
20318   user = nobody
20319   command = /usr/local/bin/uux -r - \
20320     ${substr_-5:$host}!rmail ${local_part}
20321   return_fail_output = true
20322
20323 # Router
20324 uucphost:
20325   transport = uucp
20326   driver = manualroute
20327   route_data = \
20328     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20329 .endd
20330 The file &_/usr/local/exim/uucphosts_& contains entries like
20331 .code
20332 darksite.ethereal.example:           darksite.UUCP
20333 .endd
20334 It can be set up more simply without adding and removing &".UUCP"& but this way
20335 makes clear the distinction between the domain name
20336 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20337 .endlist
20338 .ecindex IIDmanrou1
20339 .ecindex IIDmanrou2
20340
20341
20342
20343
20344
20345
20346
20347
20348 . ////////////////////////////////////////////////////////////////////////////
20349 . ////////////////////////////////////////////////////////////////////////////
20350
20351 .chapter "The queryprogram router" "CHAPdriverlast"
20352 .scindex IIDquerou1 "&(queryprogram)& router"
20353 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20354 .cindex "routing" "by external program"
20355 The &(queryprogram)& router routes an address by running an external command
20356 and acting on its output. This is an expensive way to route, and is intended
20357 mainly for use in lightly-loaded systems, or for performing experiments.
20358 However, if it is possible to use the precondition options (&%domains%&,
20359 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20360 be used in special cases, even on a busy host. There are the following private
20361 options:
20362 .cindex "options" "&(queryprogram)& router"
20363
20364 .option command queryprogram string&!! unset
20365 This option must be set. It specifies the command that is to be run. The
20366 command is split up into a command name and arguments, and then each is
20367 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20368 &<<CHAPpipetransport>>&).
20369
20370
20371 .option command_group queryprogram string unset
20372 .cindex "gid (group id)" "in &(queryprogram)& router"
20373 This option specifies a gid to be set when running the command while routing an
20374 address for deliver. It must be set if &%command_user%& specifies a numerical
20375 uid. If it begins with a digit, it is interpreted as the numerical value of the
20376 gid. Otherwise it is looked up using &[getgrnam()]&.
20377
20378
20379 .option command_user queryprogram string unset
20380 .cindex "uid (user id)" "for &(queryprogram)&"
20381 This option must be set. It specifies the uid which is set when running the
20382 command while routing an address for delivery. If the value begins with a digit,
20383 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20384 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20385 not set, a value for the gid also.
20386
20387 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20388 root, which it does during a normal delivery in a conventional configuration.
20389 However, when an address is being verified during message reception, Exim is
20390 usually running as the Exim user, not as root. If the &(queryprogram)& router
20391 is called from a non-root process, Exim cannot change uid or gid before running
20392 the command. In this circumstance the command runs under the current uid and
20393 gid.
20394
20395
20396 .option current_directory queryprogram string /
20397 This option specifies an absolute path which is made the current directory
20398 before running the command.
20399
20400
20401 .option timeout queryprogram time 1h
20402 If the command does not complete within the timeout period, its process group
20403 is killed and the message is frozen. A value of zero time specifies no
20404 timeout.
20405
20406
20407 The standard output of the command is connected to a pipe, which is read when
20408 the command terminates. It should consist of a single line of output,
20409 containing up to five fields, separated by white space. The maximum length of
20410 the line is 1023 characters. Longer lines are silently truncated. The first
20411 field is one of the following words (case-insensitive):
20412
20413 .ilist
20414 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20415 below).
20416 .next
20417 &'Decline'&: the router declines; pass the address to the next router, unless
20418 &%no_more%& is set.
20419 .next
20420 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20421 subsequent text on the line is an error message. If the router is run as part
20422 of address verification during an incoming SMTP message, the message is
20423 included in the SMTP response.
20424 .next
20425 &'Defer'&: routing could not be completed at this time; try again later. Any
20426 subsequent text on the line is an error message which is logged. It is not
20427 included in any SMTP response.
20428 .next
20429 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20430 .next
20431 &'Pass'&: pass the address to the next router (or the router specified by
20432 &%pass_router%&), overriding &%no_more%&.
20433 .next
20434 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20435 new addresses, which are routed independently, starting with the first router,
20436 or the router specified by &%redirect_router%&, if set.
20437 .endlist
20438
20439 When the first word is &'accept'&, the remainder of the line consists of a
20440 number of keyed data values, as follows (split into two lines here, to fit on
20441 the page):
20442 .code
20443 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20444 LOOKUP=byname|bydns DATA=<text>
20445 .endd
20446 The data items can be given in any order, and all are optional. If no transport
20447 is included, the transport specified by the generic &%transport%& option is
20448 used. The list of hosts and the lookup type are needed only if the transport is
20449 an &(smtp)& transport that does not itself supply a list of hosts.
20450
20451 The format of the list of hosts is the same as for the &(manualroute)& router.
20452 As well as host names and IP addresses with optional port numbers, as described
20453 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20454 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20455 (see section &<<SECThostshowused>>&).
20456
20457 If the lookup type is not specified, Exim behaves as follows when trying to
20458 find an IP address for each host: First, a DNS lookup is done. If this yields
20459 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20460 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20461 result of the lookup is the result of that call.
20462
20463 .vindex "&$address_data$&"
20464 If the DATA field is set, its value is placed in the &$address_data$&
20465 variable. For example, this return line
20466 .code
20467 accept hosts=x1.y.example:x2.y.example data="rule1"
20468 .endd
20469 routes the address to the default transport, passing a list of two hosts. When
20470 the transport runs, the string &"rule1"& is in &$address_data$&.
20471 .ecindex IIDquerou1
20472 .ecindex IIDquerou2
20473
20474
20475
20476
20477 . ////////////////////////////////////////////////////////////////////////////
20478 . ////////////////////////////////////////////////////////////////////////////
20479
20480 .chapter "The redirect router" "CHAPredirect"
20481 .scindex IIDredrou1 "&(redirect)& router"
20482 .scindex IIDredrou2 "routers" "&(redirect)&"
20483 .cindex "alias file" "in a &(redirect)& router"
20484 .cindex "address redirection" "&(redirect)& router"
20485 The &(redirect)& router handles several kinds of address redirection. Its most
20486 common uses are for resolving local part aliases from a central alias file
20487 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20488 files, but it has many other potential uses. The incoming address can be
20489 redirected in several different ways:
20490
20491 .ilist
20492 It can be replaced by one or more new addresses which are themselves routed
20493 independently.
20494 .next
20495 It can be routed to be delivered to a given file or directory.
20496 .next
20497 It can be routed to be delivered to a specified pipe command.
20498 .next
20499 It can cause an automatic reply to be generated.
20500 .next
20501 It can be forced to fail, optionally with a custom error message.
20502 .next
20503 It can be temporarily deferred, optionally with a custom message.
20504 .next
20505 It can be discarded.
20506 .endlist
20507
20508 The generic &%transport%& option must not be set for &(redirect)& routers.
20509 However, there are some private options which define transports for delivery to
20510 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20511 &%pipe_transport%& and &%reply_transport%& descriptions below.
20512
20513 If success DSNs have been requested
20514 .cindex "DSN" "success"
20515 .cindex "Delivery Status Notification" "success"
20516 redirection triggers one and the DSN options are not passed any further.
20517
20518
20519
20520 .section "Redirection data" "SECID124"
20521 The router operates by interpreting a text string which it obtains either by
20522 expanding the contents of the &%data%& option, or by reading the entire
20523 contents of a file whose name is given in the &%file%& option. These two
20524 options are mutually exclusive. The first is commonly used for handling system
20525 aliases, in a configuration like this:
20526 .code
20527 system_aliases:
20528   driver = redirect
20529   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20530 .endd
20531 If the lookup fails, the expanded string in this example is empty. When the
20532 expansion of &%data%& results in an empty string, the router declines. A forced
20533 expansion failure also causes the router to decline; other expansion failures
20534 cause delivery to be deferred.
20535
20536 A configuration using &%file%& is commonly used for handling users'
20537 &_.forward_& files, like this:
20538 .code
20539 userforward:
20540   driver = redirect
20541   check_local_user
20542   file = $home/.forward
20543   no_verify
20544 .endd
20545 If the file does not exist, or causes no action to be taken (for example, it is
20546 empty or consists only of comments), the router declines. &*Warning*&: This
20547 is not the case when the file contains syntactically valid items that happen to
20548 yield empty addresses, for example, items containing only RFC 2822 address
20549 comments.
20550
20551
20552
20553 .section "Forward files and address verification" "SECID125"
20554 .cindex "address redirection" "while verifying"
20555 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20556 &_.forward_& files, as in the example above. There are two reasons for this:
20557
20558 .ilist
20559 When Exim is receiving an incoming SMTP message from a remote host, it is
20560 running under the Exim uid, not as root. Exim is unable to change uid to read
20561 the file as the user, and it may not be able to read it as the Exim user. So in
20562 practice the router may not be able to operate.
20563 .next
20564 However, even when the router can operate, the existence of a &_.forward_& file
20565 is unimportant when verifying an address. What should be checked is whether the
20566 local part is a valid user name or not. Cutting out the redirection processing
20567 saves some resources.
20568 .endlist
20569
20570
20571
20572
20573
20574
20575 .section "Interpreting redirection data" "SECID126"
20576 .cindex "Sieve filter" "specifying in redirection data"
20577 .cindex "filter" "specifying in redirection data"
20578 The contents of the data string, whether obtained from &%data%& or &%file%&,
20579 can be interpreted in two different ways:
20580
20581 .ilist
20582 If the &%allow_filter%& option is set true, and the data begins with the text
20583 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20584 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20585 respectively. Details of the syntax and semantics of filter files are described
20586 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20587 document is intended for use by end users.
20588 .next
20589 Otherwise, the data must be a comma-separated list of redirection items, as
20590 described in the next section.
20591 .endlist
20592
20593 When a message is redirected to a file (a &"mail folder"&), the filename given
20594 in a non-filter redirection list must always be an absolute path. A filter may
20595 generate a relative path &-- how this is handled depends on the transport's
20596 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20597 for the &(appendfile)& transport.
20598
20599
20600
20601 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20602 .cindex "address redirection" "non-filter list items"
20603 When the redirection data is not an Exim or Sieve filter, for example, if it
20604 comes from a conventional alias or forward file, it consists of a list of
20605 addresses, filenames, pipe commands, or certain special items (see section
20606 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20607 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20608 depending on their default values. The items in the list are separated by
20609 commas or newlines.
20610 If a comma is required in an item, the entire item must be enclosed in double
20611 quotes.
20612
20613 Lines starting with a # character are comments, and are ignored, and # may
20614 also appear following a comma, in which case everything between the # and the
20615 next newline character is ignored.
20616
20617 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20618 double quotes are retained because some forms of mail address require their use
20619 (but never to enclose the entire address). In the following description,
20620 &"item"& refers to what remains after any surrounding double quotes have been
20621 removed.
20622
20623 .vindex "&$local_part$&"
20624 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20625 and the expansion contains a reference to &$local_part$&, you should make use
20626 of the &%quote_local_part%& expansion operator, in case the local part contains
20627 special characters. For example, to redirect all mail for the domain
20628 &'obsolete.example'&, retaining the existing local part, you could use this
20629 setting:
20630 .code
20631 data = ${quote_local_part:$local_part}@newdomain.example
20632 .endd
20633
20634
20635 .section "Redirecting to a local mailbox" "SECTredlocmai"
20636 .cindex "routing" "loops in"
20637 .cindex "loop" "while routing, avoidance of"
20638 .cindex "address redirection" "to local mailbox"
20639 A redirection item may safely be the same as the address currently under
20640 consideration. This does not cause a routing loop, because a router is
20641 automatically skipped if any ancestor of the address that is being processed
20642 is the same as the current address and was processed by the current router.
20643 Such an address is therefore passed to the following routers, so it is handled
20644 as if there were no redirection. When making this loop-avoidance test, the
20645 complete local part, including any prefix or suffix, is used.
20646
20647 .cindex "address redirection" "local part without domain"
20648 Specifying the same local part without a domain is a common usage in personal
20649 filter files when the user wants to have messages delivered to the local
20650 mailbox and also forwarded elsewhere. For example, the user whose login is
20651 &'cleo'& might have a &_.forward_& file containing this:
20652 .code
20653 cleo, cleopatra@egypt.example
20654 .endd
20655 .cindex "backslash in alias file"
20656 .cindex "alias file" "backslash in"
20657 For compatibility with other MTAs, such unqualified local parts may be
20658 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20659 it does make a difference if more than one domain is being handled
20660 synonymously.
20661
20662 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20663 2822 address that does not include a domain, the item is qualified using the
20664 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20665 addresses are qualified using the value in &%qualify_recipient%&, but you can
20666 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20667
20668 Care must be taken if there are alias names for local users.
20669 Consider an MTA handling a single local domain where the system alias file
20670 contains:
20671 .code
20672 Sam.Reman: spqr
20673 .endd
20674 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20675 messages in the local mailbox, and also forward copies elsewhere. He creates
20676 this forward file:
20677 .code
20678 Sam.Reman, spqr@reme.elsewhere.example
20679 .endd
20680 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20681 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20682 second time round, because it has previously routed it,
20683 and the following routers presumably cannot handle the alias. The forward file
20684 should really contain
20685 .code
20686 spqr, spqr@reme.elsewhere.example
20687 .endd
20688 but because this is such a common error, the &%check_ancestor%& option (see
20689 below) exists to provide a way to get round it. This is normally set on a
20690 &(redirect)& router that is handling users' &_.forward_& files.
20691
20692
20693
20694 .section "Special items in redirection lists" "SECTspecitredli"
20695 In addition to addresses, the following types of item may appear in redirection
20696 lists (that is, in non-filter redirection data):
20697
20698 .ilist
20699 .cindex "pipe" "in redirection list"
20700 .cindex "address redirection" "to pipe"
20701 An item is treated as a pipe command if it begins with &"|"& and does not parse
20702 as a valid RFC 2822 address that includes a domain. A transport for running the
20703 command must be specified by the &%pipe_transport%& option.
20704 Normally, either the router or the transport specifies a user and a group under
20705 which to run the delivery. The default is to use the Exim user and group.
20706
20707 Single or double quotes can be used for enclosing the individual arguments of
20708 the pipe command; no interpretation of escapes is done for single quotes. If
20709 the command contains a comma character, it is necessary to put the whole item
20710 in double quotes, for example:
20711 .code
20712 "|/some/command ready,steady,go"
20713 .endd
20714 since items in redirection lists are terminated by commas. Do not, however,
20715 quote just the command. An item such as
20716 .code
20717 |"/some/command ready,steady,go"
20718 .endd
20719 is interpreted as a pipe with a rather strange command name, and no arguments.
20720
20721 Note that the above example assumes that the text comes from a lookup source
20722 of some sort, so that the quotes are part of the data.  If composing a
20723 redirect router with a &%data%& option directly specifying this command, the
20724 quotes will be used by the configuration parser to define the extent of one
20725 string, but will not be passed down into the redirect router itself.  There
20726 are two main approaches to get around this: escape quotes to be part of the
20727 data itself, or avoid using this mechanism and instead create a custom
20728 transport with the &%command%& option set and reference that transport from
20729 an &%accept%& router.
20730
20731 .next
20732 .cindex "file" "in redirection list"
20733 .cindex "address redirection" "to file"
20734 An item is interpreted as a path name if it begins with &"/"& and does not
20735 parse as a valid RFC 2822 address that includes a domain. For example,
20736 .code
20737 /home/world/minbari
20738 .endd
20739 is treated as a filename, but
20740 .code
20741 /s=molari/o=babylon/@x400gate.way
20742 .endd
20743 is treated as an address. For a filename, a transport must be specified using
20744 the &%file_transport%& option. However, if the generated path name ends with a
20745 forward slash character, it is interpreted as a directory name rather than a
20746 filename, and &%directory_transport%& is used instead.
20747
20748 Normally, either the router or the transport specifies a user and a group under
20749 which to run the delivery. The default is to use the Exim user and group.
20750
20751 .cindex "&_/dev/null_&"
20752 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20753 bypassed at a high level, and the log entry shows &"**bypassed**"&
20754 instead of a transport name. In this case the user and group are not used.
20755
20756 .next
20757 .cindex "included address list"
20758 .cindex "address redirection" "included external list"
20759 If an item is of the form
20760 .code
20761 :include:<path name>
20762 .endd
20763 a list of further items is taken from the given file and included at that
20764 point. &*Note*&: Such a file can not be a filter file; it is just an
20765 out-of-line addition to the list. The items in the included list are separated
20766 by commas or newlines and are not subject to expansion. If this is the first
20767 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20768 the alias name. This example is incorrect:
20769 .code
20770 list1    :include:/opt/lists/list1
20771 .endd
20772 It must be given as
20773 .code
20774 list1:   :include:/opt/lists/list1
20775 .endd
20776 .next
20777 .cindex "address redirection" "to black hole"
20778 .cindex "delivery" "discard"
20779 .cindex "delivery" "blackhole"
20780 .cindex "black hole"
20781 .cindex "abandoning mail"
20782 Sometimes you want to throw away mail to a particular local part.  Making the
20783 &%data%& option expand to an empty string does not work, because that causes
20784 the router to decline. Instead, the alias item
20785 .code
20786 :blackhole:
20787 .endd
20788 can be used. It does what its name implies. No delivery is
20789 done, and no error message is generated. This has the same effect as specifying
20790 &_/dev/null_& as a destination, but it can be independently disabled.
20791
20792 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20793 delivery is done for the original local part, even if other redirection items
20794 are present. If you are generating a multi-item list (for example, by reading a
20795 database) and need the ability to provide a no-op item, you must use
20796 &_/dev/null_&.
20797
20798 .next
20799 .cindex "delivery" "forcing failure"
20800 .cindex "delivery" "forcing deferral"
20801 .cindex "failing delivery" "forcing"
20802 .cindex "deferred delivery, forcing"
20803 .cindex "customizing" "failure message"
20804 An attempt to deliver a particular address can be deferred or forced to fail by
20805 redirection items of the form
20806 .code
20807 :defer:
20808 :fail:
20809 .endd
20810 respectively. When a redirection list contains such an item, it applies
20811 to the entire redirection; any other items in the list are ignored. Any
20812 text following &':fail:'& or &':defer:'& is placed in the error text
20813 associated with the failure. For example, an alias file might contain:
20814 .code
20815 X.Employee:  :fail: Gone away, no forwarding address
20816 .endd
20817 In the case of an address that is being verified from an ACL or as the subject
20818 of a
20819 .cindex "VRFY" "error text, display of"
20820 VRFY command, the text is included in the SMTP error response by
20821 default.
20822 .cindex "EXPN" "error text, display of"
20823 The text is not included in the response to an EXPN command. In non-SMTP cases
20824 the text is included in the error message that Exim generates.
20825
20826 .cindex "SMTP" "error codes"
20827 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20828 &':fail:'&. However, if the message starts with three digits followed by a
20829 space, optionally followed by an extended code of the form &'n.n.n'&, also
20830 followed by a space, and the very first digit is the same as the default error
20831 code, the code from the message is used instead. If the very first digit is
20832 incorrect, a panic error is logged, and the default code is used. You can
20833 suppress the use of the supplied code in a redirect router by setting the
20834 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20835 ignored.
20836
20837 .vindex "&$acl_verify_message$&"
20838 In an ACL, an explicitly provided message overrides the default, but the
20839 default message is available in the variable &$acl_verify_message$& and can
20840 therefore be included in a custom message if this is desired.
20841
20842 Normally the error text is the rest of the redirection list &-- a comma does
20843 not terminate it &-- but a newline does act as a terminator. Newlines are not
20844 normally present in alias expansions. In &(lsearch)& lookups they are removed
20845 as part of the continuation process, but they may exist in other kinds of
20846 lookup and in &':include:'& files.
20847
20848 During routing for message delivery (as opposed to verification), a redirection
20849 containing &':fail:'& causes an immediate failure of the incoming address,
20850 whereas &':defer:'& causes the message to remain in the queue so that a
20851 subsequent delivery attempt can happen at a later time. If an address is
20852 deferred for too long, it will ultimately fail, because the normal retry
20853 rules still apply.
20854
20855 .next
20856 .cindex "alias file" "exception to default"
20857 Sometimes it is useful to use a single-key search type with a default (see
20858 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20859 for exceptions to the default. These can be handled by aliasing them to
20860 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20861 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20862 results in an empty redirection list has the same effect.
20863 .endlist
20864
20865
20866 .section "Duplicate addresses" "SECTdupaddr"
20867 .cindex "duplicate addresses"
20868 .cindex "address duplicate, discarding"
20869 .cindex "pipe" "duplicated"
20870 Exim removes duplicate addresses from the list to which it is delivering, so as
20871 to deliver just one copy to each address. This does not apply to deliveries
20872 routed to pipes by different immediate parent addresses, but an indirect
20873 aliasing scheme of the type
20874 .code
20875 pipe:       |/some/command $local_part
20876 localpart1: pipe
20877 localpart2: pipe
20878 .endd
20879 does not work with a message that is addressed to both local parts, because
20880 when the second is aliased to the intermediate local part &"pipe"& it gets
20881 discarded as being the same as a previously handled address. However, a scheme
20882 such as
20883 .code
20884 localpart1: |/some/command $local_part
20885 localpart2: |/some/command $local_part
20886 .endd
20887 does result in two different pipe deliveries, because the immediate parents of
20888 the pipes are distinct.
20889
20890
20891
20892 .section "Repeated redirection expansion" "SECID128"
20893 .cindex "repeated redirection expansion"
20894 .cindex "address redirection" "repeated for each delivery attempt"
20895 When a message cannot be delivered to all of its recipients immediately,
20896 leading to two or more delivery attempts, redirection expansion is carried out
20897 afresh each time for those addresses whose children were not all previously
20898 delivered. If redirection is being used as a mailing list, this can lead to new
20899 members of the list receiving copies of old messages. The &%one_time%& option
20900 can be used to avoid this.
20901
20902
20903 .section "Errors in redirection lists" "SECID129"
20904 .cindex "address redirection" "errors"
20905 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20906 error is skipped, and an entry is written to the main log. This may be useful
20907 for mailing lists that are automatically managed. Otherwise, if an error is
20908 detected while generating the list of new addresses, the original address is
20909 deferred. See also &%syntax_errors_to%&.
20910
20911
20912
20913 .section "Private options for the redirect router" "SECID130"
20914
20915 .cindex "options" "&(redirect)& router"
20916 The private options for the &(redirect)& router are as follows:
20917
20918
20919 .option allow_defer redirect boolean false
20920 Setting this option allows the use of &':defer:'& in non-filter redirection
20921 data, or the &%defer%& command in an Exim filter file.
20922
20923
20924 .option allow_fail redirect boolean false
20925 .cindex "failing delivery" "from filter"
20926 If this option is true, the &':fail:'& item can be used in a redirection list,
20927 and the &%fail%& command may be used in an Exim filter file.
20928
20929
20930 .option allow_filter redirect boolean false
20931 .cindex "filter" "enabling use of"
20932 .cindex "Sieve filter" "enabling use of"
20933 Setting this option allows Exim to interpret redirection data that starts with
20934 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20935 are some features of Exim filter files that some administrators may wish to
20936 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20937
20938 It is also possible to lock out Exim filters or Sieve filters while allowing
20939 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20940
20941
20942 The filter is run using the uid and gid set by the generic &%user%& and
20943 &%group%& options. These take their defaults from the password data if
20944 &%check_local_user%& is set, so in the normal case of users' personal filter
20945 files, the filter is run as the relevant user. When &%allow_filter%& is set
20946 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20947
20948
20949
20950 .option allow_freeze redirect boolean false
20951 .cindex "freezing messages" "allowing in filter"
20952 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20953 This command is more normally encountered in system filters, and is disabled by
20954 default for redirection filters because it isn't something you usually want to
20955 let ordinary users do.
20956
20957
20958
20959 .option check_ancestor redirect boolean false
20960 This option is concerned with handling generated addresses that are the same
20961 as some address in the list of redirection ancestors of the current address.
20962 Although it is turned off by default in the code, it is set in the default
20963 configuration file for handling users' &_.forward_& files. It is recommended
20964 for this use of the &(redirect)& router.
20965
20966 When &%check_ancestor%& is set, if a generated address (including the domain)
20967 is the same as any ancestor of the current address, it is replaced by a copy of
20968 the current address. This helps in the case where local part A is aliased to B,
20969 and B has a &_.forward_& file pointing back to A. For example, within a single
20970 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20971 &_&~jb/.forward_& contains:
20972 .code
20973 \Joe.Bloggs, <other item(s)>
20974 .endd
20975 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20976 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20977 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20978 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20979 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20980 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20981 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20982 original address. See also the &%repeat_use%& option below.
20983
20984
20985 .option check_group redirect boolean "see below"
20986 When the &%file%& option is used, the group owner of the file is checked only
20987 when this option is set. The permitted groups are those listed in the
20988 &%owngroups%& option, together with the user's default group if
20989 &%check_local_user%& is set. If the file has the wrong group, routing is
20990 deferred. The default setting for this option is true if &%check_local_user%&
20991 is set and the &%modemask%& option permits the group write bit, or if the
20992 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20993
20994
20995
20996 .option check_owner redirect boolean "see below"
20997 When the &%file%& option is used, the owner of the file is checked only when
20998 this option is set. If &%check_local_user%& is set, the local user is
20999 permitted; otherwise the owner must be one of those listed in the &%owners%&
21000 option. The default value for this option is true if &%check_local_user%& or
21001 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21002
21003
21004 .option data redirect string&!! unset
21005 This option is mutually exclusive with &%file%&. One or other of them must be
21006 set, but not both. The contents of &%data%& are expanded, and then used as the
21007 list of forwarding items, or as a set of filtering instructions. If the
21008 expansion is forced to fail, or the result is an empty string or a string that
21009 has no effect (consists entirely of comments), the router declines.
21010
21011 When filtering instructions are used, the string must begin with &"#Exim
21012 filter"&, and all comments in the string, including this initial one, must be
21013 terminated with newline characters. For example:
21014 .code
21015 data = #Exim filter\n\
21016        if $h_to: contains Exim then save $home/mail/exim endif
21017 .endd
21018 If you are reading the data from a database where newlines cannot be included,
21019 you can use the &${sg}$& expansion item to turn the escape string of your
21020 choice into a newline.
21021
21022
21023 .option directory_transport redirect string&!! unset
21024 A &(redirect)& router sets up a direct delivery to a directory when a path name
21025 ending with a slash is specified as a new &"address"&. The transport used is
21026 specified by this option, which, after expansion, must be the name of a
21027 configured transport. This should normally be an &(appendfile)& transport.
21028
21029
21030 .option file redirect string&!! unset
21031 This option specifies the name of a file that contains the redirection data. It
21032 is mutually exclusive with the &%data%& option. The string is expanded before
21033 use; if the expansion is forced to fail, the router declines. Other expansion
21034 failures cause delivery to be deferred. The result of a successful expansion
21035 must be an absolute path. The entire file is read and used as the redirection
21036 data. If the data is an empty string or a string that has no effect (consists
21037 entirely of comments), the router declines.
21038
21039 .cindex "NFS" "checking for file existence"
21040 If the attempt to open the file fails with a &"does not exist"& error, Exim
21041 runs a check on the containing directory,
21042 unless &%ignore_enotdir%& is true (see below).
21043 If the directory does not appear to exist, delivery is deferred. This can
21044 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21045 is a mount problem. If the containing directory does exist, but the file does
21046 not, the router declines.
21047
21048
21049 .option file_transport redirect string&!! unset
21050 .vindex "&$address_file$&"
21051 A &(redirect)& router sets up a direct delivery to a file when a path name not
21052 ending in a slash is specified as a new &"address"&. The transport used is
21053 specified by this option, which, after expansion, must be the name of a
21054 configured transport. This should normally be an &(appendfile)& transport. When
21055 it is running, the filename is in &$address_file$&.
21056
21057
21058 .option filter_prepend_home redirect boolean true
21059 When this option is true, if a &(save)& command in an Exim filter specifies a
21060 relative path, and &$home$& is defined, it is automatically prepended to the
21061 relative path. If this option is set false, this action does not happen. The
21062 relative path is then passed to the transport unmodified.
21063
21064
21065 .option forbid_blackhole redirect boolean false
21066 .cindex "restricting access to features"
21067 .cindex "filter" "locking out certain features"
21068 If this option is true, the &':blackhole:'& item may not appear in a
21069 redirection list.
21070
21071
21072 .option forbid_exim_filter redirect boolean false
21073 .cindex "restricting access to features"
21074 .cindex "filter" "locking out certain features"
21075 If this option is set true, only Sieve filters are permitted when
21076 &%allow_filter%& is true.
21077
21078
21079
21080
21081 .option forbid_file redirect boolean false
21082 .cindex "restricting access to features"
21083 .cindex "delivery" "to file; forbidding"
21084 .cindex "filter" "locking out certain features"
21085 .cindex "Sieve filter" "forbidding delivery to a file"
21086 .cindex "Sieve filter" "&""keep""& facility; disabling"
21087 If this option is true, this router may not generate a new address that
21088 specifies delivery to a local file or directory, either from a filter or from a
21089 conventional forward file. This option is forced to be true if &%one_time%& is
21090 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21091 locks out the Sieve's &"keep"& facility.
21092
21093
21094 .option forbid_filter_dlfunc redirect boolean false
21095 .cindex "restricting access to features"
21096 .cindex "filter" "locking out certain features"
21097 If this option is true, string expansions in Exim filters are not allowed to
21098 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21099 functions.
21100
21101 .option forbid_filter_existstest redirect boolean false
21102 .cindex "restricting access to features"
21103 .cindex "filter" "locking out certain features"
21104 .cindex "expansion" "statting a file"
21105 If this option is true, string expansions in Exim filters are not allowed to
21106 make use of the &%exists%& condition or the &%stat%& expansion item.
21107
21108 .option forbid_filter_logwrite redirect boolean false
21109 .cindex "restricting access to features"
21110 .cindex "filter" "locking out certain features"
21111 If this option is true, use of the logging facility in Exim filters is not
21112 permitted. Logging is in any case available only if the filter is being run
21113 under some unprivileged uid (which is normally the case for ordinary users'
21114 &_.forward_& files).
21115
21116
21117 .option forbid_filter_lookup redirect boolean false
21118 .cindex "restricting access to features"
21119 .cindex "filter" "locking out certain features"
21120 If this option is true, string expansions in Exim filter files are not allowed
21121 to make use of &%lookup%& items.
21122
21123
21124 .option forbid_filter_perl redirect boolean false
21125 .cindex "restricting access to features"
21126 .cindex "filter" "locking out certain features"
21127 This option has an effect only if Exim is built with embedded Perl support. If
21128 it is true, string expansions in Exim filter files are not allowed to make use
21129 of the embedded Perl support.
21130
21131
21132 .option forbid_filter_readfile redirect boolean false
21133 .cindex "restricting access to features"
21134 .cindex "filter" "locking out certain features"
21135 If this option is true, string expansions in Exim filter files are not allowed
21136 to make use of &%readfile%& items.
21137
21138
21139 .option forbid_filter_readsocket redirect boolean false
21140 .cindex "restricting access to features"
21141 .cindex "filter" "locking out certain features"
21142 If this option is true, string expansions in Exim filter files are not allowed
21143 to make use of &%readsocket%& items.
21144
21145
21146 .option forbid_filter_reply redirect boolean false
21147 .cindex "restricting access to features"
21148 .cindex "filter" "locking out certain features"
21149 If this option is true, this router may not generate an automatic reply
21150 message. Automatic replies can be generated only from Exim or Sieve filter
21151 files, not from traditional forward files. This option is forced to be true if
21152 &%one_time%& is set.
21153
21154
21155 .option forbid_filter_run redirect boolean false
21156 .cindex "restricting access to features"
21157 .cindex "filter" "locking out certain features"
21158 If this option is true, string expansions in Exim filter files are not allowed
21159 to make use of &%run%& items.
21160
21161
21162 .option forbid_include redirect boolean false
21163 .cindex "restricting access to features"
21164 .cindex "filter" "locking out certain features"
21165 If this option is true, items of the form
21166 .code
21167 :include:<path name>
21168 .endd
21169 are not permitted in non-filter redirection lists.
21170
21171
21172 .option forbid_pipe redirect boolean false
21173 .cindex "restricting access to features"
21174 .cindex "filter" "locking out certain features"
21175 .cindex "delivery" "to pipe; forbidding"
21176 If this option is true, this router may not generate a new address which
21177 specifies delivery to a pipe, either from an Exim filter or from a conventional
21178 forward file. This option is forced to be true if &%one_time%& is set.
21179
21180
21181 .option forbid_sieve_filter redirect boolean false
21182 .cindex "restricting access to features"
21183 .cindex "filter" "locking out certain features"
21184 If this option is set true, only Exim filters are permitted when
21185 &%allow_filter%& is true.
21186
21187
21188 .cindex "SMTP" "error codes"
21189 .option forbid_smtp_code redirect boolean false
21190 If this option is set true, any SMTP error codes that are present at the start
21191 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21192 the default codes (451 and 550, respectively) are always used.
21193
21194
21195
21196
21197 .option hide_child_in_errmsg redirect boolean false
21198 .cindex "bounce message" "redirection details; suppressing"
21199 If this option is true, it prevents Exim from quoting a child address if it
21200 generates a bounce or delay message for it. Instead it says &"an address
21201 generated from <&'the top level address'&>"&. Of course, this applies only to
21202 bounces generated locally. If a message is forwarded to another host, &'its'&
21203 bounce may well quote the generated address.
21204
21205
21206 .option ignore_eacces redirect boolean false
21207 .cindex "EACCES"
21208 If this option is set and an attempt to open a redirection file yields the
21209 EACCES error (permission denied), the &(redirect)& router behaves as if the
21210 file did not exist.
21211
21212
21213 .option ignore_enotdir redirect boolean false
21214 .cindex "ENOTDIR"
21215 If this option is set and an attempt to open a redirection file yields the
21216 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21217 router behaves as if the file did not exist.
21218
21219 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21220 router that has the &%file%& option set discovers that the file does not exist
21221 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21222 against unmounted NFS directories. If the parent can not be statted, delivery
21223 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21224 is set, because that option tells Exim to ignore &"something on the path is not
21225 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21226 that some operating systems give ENOENT where others give ENOTDIR.
21227
21228
21229
21230 .option include_directory redirect string unset
21231 If this option is set, the path names of any &':include:'& items in a
21232 redirection list must start with this directory.
21233
21234
21235 .option modemask redirect "octal integer" 022
21236 This specifies mode bits which must not be set for a file specified by the
21237 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21238
21239
21240 .option one_time redirect boolean false
21241 .cindex "one-time aliasing/forwarding expansion"
21242 .cindex "alias file" "one-time expansion"
21243 .cindex "forward file" "one-time expansion"
21244 .cindex "mailing lists" "one-time expansion"
21245 .cindex "address redirection" "one-time expansion"
21246 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21247 files each time it tries to deliver a message causes a problem when one or more
21248 of the generated addresses fails be delivered at the first attempt. The problem
21249 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21250 but of what happens when the redirection list changes during the time that the
21251 message is on Exim's queue. This is particularly true in the case of mailing
21252 lists, where new subscribers might receive copies of messages that were posted
21253 before they subscribed.
21254
21255 If &%one_time%& is set and any addresses generated by the router fail to
21256 deliver at the first attempt, the failing addresses are added to the message as
21257 &"top level"& addresses, and the parent address that generated them is marked
21258 &"delivered"&. Thus, redirection does not happen again at the next delivery
21259 attempt.
21260
21261 &*Warning 1*&: Any header line addition or removal that is specified by this
21262 router would be lost if delivery did not succeed at the first attempt. For this
21263 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21264 permitted when &%one_time%& is set.
21265
21266 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21267 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21268 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21269
21270 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21271 &%one_time%&.
21272
21273 The original top-level address is remembered with each of the generated
21274 addresses, and is output in any log messages. However, any intermediate parent
21275 addresses are not recorded. This makes a difference to the log only if
21276 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21277 typically be used for mailing lists, where there is normally just one level of
21278 expansion.
21279
21280
21281 .option owners redirect "string list" unset
21282 .cindex "ownership" "alias file"
21283 .cindex "ownership" "forward file"
21284 .cindex "alias file" "ownership"
21285 .cindex "forward file" "ownership"
21286 This specifies a list of permitted owners for the file specified by &%file%&.
21287 This list is in addition to the local user when &%check_local_user%& is set.
21288 See &%check_owner%& above.
21289
21290
21291 .option owngroups redirect "string list" unset
21292 This specifies a list of permitted groups for the file specified by &%file%&.
21293 The list is in addition to the local user's primary group when
21294 &%check_local_user%& is set. See &%check_group%& above.
21295
21296
21297 .option pipe_transport redirect string&!! unset
21298 .vindex "&$address_pipe$&"
21299 A &(redirect)& router sets up a direct delivery to a pipe when a string
21300 starting with a vertical bar character is specified as a new &"address"&. The
21301 transport used is specified by this option, which, after expansion, must be the
21302 name of a configured transport. This should normally be a &(pipe)& transport.
21303 When the transport is run, the pipe command is in &$address_pipe$&.
21304
21305
21306 .option qualify_domain redirect string&!! unset
21307 .vindex "&$qualify_recipient$&"
21308 If this option is set, and an unqualified address (one without a domain) is
21309 generated, and that address would normally be qualified by the global setting
21310 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21311 expanding this string. If the expansion fails, the router declines. If you want
21312 to revert to the default, you can have the expansion generate
21313 &$qualify_recipient$&.
21314
21315 This option applies to all unqualified addresses generated by Exim filters,
21316 but for traditional &_.forward_& files, it applies only to addresses that are
21317 not preceded by a backslash. Sieve filters cannot generate unqualified
21318 addresses.
21319
21320 .option qualify_preserve_domain redirect boolean false
21321 .cindex "domain" "in redirection; preserving"
21322 .cindex "preserving domain in redirection"
21323 .cindex "address redirection" "domain; preserving"
21324 If this option is set, the router's local &%qualify_domain%& option must not be
21325 set (a configuration error occurs if it is). If an unqualified address (one
21326 without a domain) is generated, it is qualified with the domain of the parent
21327 address (the immediately preceding ancestor) instead of the global
21328 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21329 this applies whether or not the address is preceded by a backslash.
21330
21331
21332 .option repeat_use redirect boolean true
21333 If this option is set false, the router is skipped for a child address that has
21334 any ancestor that was routed by this router. This test happens before any of
21335 the other preconditions are tested. Exim's default anti-looping rules skip
21336 only when the ancestor is the same as the current address. See also
21337 &%check_ancestor%& above and the generic &%redirect_router%& option.
21338
21339
21340 .option reply_transport redirect string&!! unset
21341 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21342 &%vacation%& command is used in a filter file. The transport used is specified
21343 by this option, which, after expansion, must be the name of a configured
21344 transport. This should normally be an &(autoreply)& transport. Other transports
21345 are unlikely to do anything sensible or useful.
21346
21347
21348 .option rewrite redirect boolean true
21349 .cindex "address redirection" "disabling rewriting"
21350 If this option is set false, addresses generated by the router are not
21351 subject to address rewriting. Otherwise, they are treated like new addresses
21352 and are rewritten according to the global rewriting rules.
21353
21354
21355 .option sieve_subaddress redirect string&!! unset
21356 The value of this option is passed to a Sieve filter to specify the
21357 :subaddress part of an address.
21358
21359 .option sieve_useraddress redirect string&!! unset
21360 The value of this option is passed to a Sieve filter to specify the :user part
21361 of an address. However, if it is unset, the entire original local part
21362 (including any prefix or suffix) is used for :user.
21363
21364
21365 .option sieve_vacation_directory redirect string&!! unset
21366 .cindex "Sieve filter" "vacation directory"
21367 To enable the &"vacation"& extension for Sieve filters, you must set
21368 &%sieve_vacation_directory%& to the directory where vacation databases are held
21369 (do not put anything else in that directory), and ensure that the
21370 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21371 needs their own directory; Exim will create it if necessary.
21372
21373
21374
21375 .option skip_syntax_errors redirect boolean false
21376 .cindex "forward file" "broken"
21377 .cindex "address redirection" "broken files"
21378 .cindex "alias file" "broken"
21379 .cindex "broken alias or forward files"
21380 .cindex "ignoring faulty addresses"
21381 .cindex "skipping faulty addresses"
21382 .cindex "error" "skipping bad syntax"
21383 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21384 non-filter redirection data are skipped, and each failing address is logged. If
21385 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21386 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21387 are expanded and placed at the head of the error message generated by
21388 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21389 be the same address as the generic &%errors_to%& option. The
21390 &%skip_syntax_errors%& option is often used when handling mailing lists.
21391
21392 If all the addresses in a redirection list are skipped because of syntax
21393 errors, the router declines to handle the original address, and it is passed to
21394 the following routers.
21395
21396 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21397 error in the filter causes filtering to be abandoned without any action being
21398 taken. The incident is logged, and the router declines to handle the address,
21399 so it is passed to the following routers.
21400
21401 .cindex "Sieve filter" "syntax errors in"
21402 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21403 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21404 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21405
21406 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21407 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21408 option, used with an address that does not get redirected, can be used to
21409 notify users of these errors, by means of a router like this:
21410 .code
21411 userforward:
21412   driver = redirect
21413   allow_filter
21414   check_local_user
21415   file = $home/.forward
21416   file_transport = address_file
21417   pipe_transport = address_pipe
21418   reply_transport = address_reply
21419   no_verify
21420   skip_syntax_errors
21421   syntax_errors_to = real-$local_part@$domain
21422   syntax_errors_text = \
21423    This is an automatically generated message. An error has\n\
21424    been found in your .forward file. Details of the error are\n\
21425    reported below. While this error persists, you will receive\n\
21426    a copy of this message for every message that is addressed\n\
21427    to you. If your .forward file is a filter file, or if it is\n\
21428    a non-filter file containing no valid forwarding addresses,\n\
21429    a copy of each incoming message will be put in your normal\n\
21430    mailbox. If a non-filter file contains at least one valid\n\
21431    forwarding address, forwarding to the valid addresses will\n\
21432    happen, and those will be the only deliveries that occur.
21433 .endd
21434 You also need a router to ensure that local addresses that are prefixed by
21435 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21436 put this immediately before the &(userforward)& router:
21437 .code
21438 real_localuser:
21439   driver = accept
21440   check_local_user
21441   local_part_prefix = real-
21442   transport = local_delivery
21443 .endd
21444 For security, it would probably be a good idea to restrict the use of this
21445 router to locally-generated messages, using a condition such as this:
21446 .code
21447   condition = ${if match {$sender_host_address}\
21448                          {\N^(|127\.0\.0\.1)$\N}}
21449 .endd
21450
21451
21452 .option syntax_errors_text redirect string&!! unset
21453 See &%skip_syntax_errors%& above.
21454
21455
21456 .option syntax_errors_to redirect string unset
21457 See &%skip_syntax_errors%& above.
21458 .ecindex IIDredrou1
21459 .ecindex IIDredrou2
21460
21461
21462
21463
21464
21465
21466 . ////////////////////////////////////////////////////////////////////////////
21467 . ////////////////////////////////////////////////////////////////////////////
21468
21469 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21470          "Environment for local transports"
21471 .scindex IIDenvlotra1 "local transports" "environment for"
21472 .scindex IIDenvlotra2 "environment" "local transports"
21473 .scindex IIDenvlotra3 "transport" "local; environment for"
21474 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21475 transport can be thought of as similar to a pipe.) Exim always runs transports
21476 in subprocesses, under specified uids and gids. Typical deliveries to local
21477 mailboxes run under the uid and gid of the local user.
21478
21479 Exim also sets a specific current directory while running the transport; for
21480 some transports a home directory setting is also relevant. The &(pipe)&
21481 transport is the only one that sets up environment variables; see section
21482 &<<SECTpipeenv>>& for details.
21483
21484 The values used for the uid, gid, and the directories may come from several
21485 different places. In many cases, the router that handles the address associates
21486 settings with that address as a result of its &%check_local_user%&, &%group%&,
21487 or &%user%& options. However, values may also be given in the transport's own
21488 configuration, and these override anything that comes from the router.
21489
21490
21491
21492 .section "Concurrent deliveries" "SECID131"
21493 .cindex "concurrent deliveries"
21494 .cindex "simultaneous deliveries"
21495 If two different messages for the same local recipient arrive more or less
21496 simultaneously, the two delivery processes are likely to run concurrently. When
21497 the &(appendfile)& transport is used to write to a file, Exim applies locking
21498 rules to stop concurrent processes from writing to the same file at the same
21499 time.
21500
21501 However, when you use a &(pipe)& transport, it is up to you to arrange any
21502 locking that is needed. Here is a silly example:
21503 .code
21504 my_transport:
21505   driver = pipe
21506   command = /bin/sh -c 'cat >>/some/file'
21507 .endd
21508 This is supposed to write the message at the end of the file. However, if two
21509 messages arrive at the same time, the file will be scrambled. You can use the
21510 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21511 file using the same algorithm that Exim itself uses.
21512
21513
21514
21515
21516 .section "Uids and gids" "SECTenvuidgid"
21517 .cindex "local transports" "uid and gid"
21518 .cindex "transport" "local; uid and gid"
21519 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21520 overrides any group that the router set in the address, even if &%user%& is not
21521 set for the transport. This makes it possible, for example, to run local mail
21522 delivery under the uid of the recipient (set by the router), but in a special
21523 group (set by the transport). For example:
21524 .code
21525 # Routers ...
21526 # User/group are set by check_local_user in this router
21527 local_users:
21528   driver = accept
21529   check_local_user
21530   transport = group_delivery
21531
21532 # Transports ...
21533 # This transport overrides the group
21534 group_delivery:
21535   driver = appendfile
21536   file = /var/spool/mail/$local_part
21537   group = mail
21538 .endd
21539 If &%user%& is set for a transport, its value overrides what is set in the
21540 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21541 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21542 set.
21543
21544 .oindex "&%initgroups%&"
21545 When the uid is taken from the transport's configuration, the &[initgroups()]&
21546 function is called for the groups associated with that uid if the
21547 &%initgroups%& option is set for the transport. When the uid is not specified
21548 by the transport, but is associated with the address by a router, the option
21549 for calling &[initgroups()]& is taken from the router configuration.
21550
21551 .cindex "&(pipe)& transport" "uid for"
21552 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21553 is set and &%user%& is not set, the uid of the process that called Exim to
21554 receive the message is used, and if &%group%& is not set, the corresponding
21555 original gid is also used.
21556
21557 This is the detailed preference order for obtaining a gid; the first of the
21558 following that is set is used:
21559
21560 .ilist
21561 A &%group%& setting of the transport;
21562 .next
21563 A &%group%& setting of the router;
21564 .next
21565 A gid associated with a user setting of the router, either as a result of
21566 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21567 .next
21568 The group associated with a non-numeric &%user%& setting of the transport;
21569 .next
21570 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21571 the uid is the creator's uid;
21572 .next
21573 The Exim gid if the Exim uid is being used as a default.
21574 .endlist
21575
21576 If, for example, the user is specified numerically on the router and there are
21577 no group settings, no gid is available. In this situation, an error occurs.
21578 This is different for the uid, for which there always is an ultimate default.
21579 The first of the following that is set is used:
21580
21581 .ilist
21582 A &%user%& setting of the transport;
21583 .next
21584 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21585 .next
21586 A &%user%& setting of the router;
21587 .next
21588 A &%check_local_user%& setting of the router;
21589 .next
21590 The Exim uid.
21591 .endlist
21592
21593 Of course, an error will still occur if the uid that is chosen is on the
21594 &%never_users%& list.
21595
21596
21597
21598
21599
21600 .section "Current and home directories" "SECID132"
21601 .cindex "current directory for local transport"
21602 .cindex "home directory" "for local transport"
21603 .cindex "transport" "local; home directory for"
21604 .cindex "transport" "local; current directory for"
21605 Routers may set current and home directories for local transports by means of
21606 the &%transport_current_directory%& and &%transport_home_directory%& options.
21607 However, if the transport's &%current_directory%& or &%home_directory%& options
21608 are set, they override the router's values. In detail, the home directory
21609 for a local transport is taken from the first of these values that is set:
21610
21611 .ilist
21612 The &%home_directory%& option on the transport;
21613 .next
21614 The &%transport_home_directory%& option on the router;
21615 .next
21616 The password data if &%check_local_user%& is set on the router;
21617 .next
21618 The &%router_home_directory%& option on the router.
21619 .endlist
21620
21621 The current directory is taken from the first of these values that is set:
21622
21623 .ilist
21624 The &%current_directory%& option on the transport;
21625 .next
21626 The &%transport_current_directory%& option on the router.
21627 .endlist
21628
21629
21630 If neither the router nor the transport sets a current directory, Exim uses the
21631 value of the home directory, if it is set. Otherwise it sets the current
21632 directory to &_/_& before running a local transport.
21633
21634
21635
21636 .section "Expansion variables derived from the address" "SECID133"
21637 .vindex "&$domain$&"
21638 .vindex "&$local_part$&"
21639 .vindex "&$original_domain$&"
21640 Normally a local delivery is handling a single address, and in that case the
21641 variables such as &$domain$& and &$local_part$& are set during local
21642 deliveries. However, in some circumstances more than one address may be handled
21643 at once (for example, while writing batch SMTP for onward transmission by some
21644 other means). In this case, the variables associated with the local part are
21645 never set, &$domain$& is set only if all the addresses have the same domain,
21646 and &$original_domain$& is never set.
21647 .ecindex IIDenvlotra1
21648 .ecindex IIDenvlotra2
21649 .ecindex IIDenvlotra3
21650
21651
21652
21653
21654
21655
21656
21657 . ////////////////////////////////////////////////////////////////////////////
21658 . ////////////////////////////////////////////////////////////////////////////
21659
21660 .chapter "Generic options for transports" "CHAPtransportgeneric"
21661 .scindex IIDgenoptra1 "generic options" "transport"
21662 .scindex IIDgenoptra2 "options" "generic; for transports"
21663 .scindex IIDgenoptra3 "transport" "generic options for"
21664 The following generic options apply to all transports:
21665
21666
21667 .option body_only transports boolean false
21668 .cindex "transport" "body only"
21669 .cindex "message" "transporting body only"
21670 .cindex "body of message" "transporting"
21671 If this option is set, the message's headers are not transported. It is
21672 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21673 or &(pipe)& transports, the settings of &%message_prefix%& and
21674 &%message_suffix%& should be checked, because this option does not
21675 automatically suppress them.
21676
21677
21678 .option current_directory transports string&!! unset
21679 .cindex "transport" "current directory for"
21680 This specifies the current directory that is to be set while running the
21681 transport, overriding any value that may have been set by the router.
21682 If the expansion fails for any reason, including forced failure, an error is
21683 logged, and delivery is deferred.
21684
21685
21686 .option disable_logging transports boolean false
21687 If this option is set true, nothing is logged for any
21688 deliveries by the transport or for any
21689 transport errors. You should not set this option unless you really, really know
21690 what you are doing.
21691
21692
21693 .option debug_print transports string&!! unset
21694 .cindex "testing" "variables in drivers"
21695 If this option is set and debugging is enabled (see the &%-d%& command line
21696 option), the string is expanded and included in the debugging output when the
21697 transport is run.
21698 If expansion of the string fails, the error message is written to the debugging
21699 output, and Exim carries on processing.
21700 This facility is provided to help with checking out the values of variables and
21701 so on when debugging driver configurations. For example, if a &%headers_add%&
21702 option is not working properly, &%debug_print%& could be used to output the
21703 variables it references. A newline is added to the text if it does not end with
21704 one.
21705 The variables &$transport_name$& and &$router_name$& contain the name of the
21706 transport and the router that called it.
21707
21708 .option delivery_date_add transports boolean false
21709 .cindex "&'Delivery-date:'& header line"
21710 If this option is true, a &'Delivery-date:'& header is added to the message.
21711 This gives the actual time the delivery was made. As this is not a standard
21712 header, Exim has a configuration option (&%delivery_date_remove%&) which
21713 requests its removal from incoming messages, so that delivered messages can
21714 safely be resent to other recipients.
21715
21716
21717 .option driver transports string unset
21718 This specifies which of the available transport drivers is to be used.
21719 There is no default, and this option must be set for every transport.
21720
21721
21722 .option envelope_to_add transports boolean false
21723 .cindex "&'Envelope-to:'& header line"
21724 If this option is true, an &'Envelope-to:'& header is added to the message.
21725 This gives the original address(es) in the incoming envelope that caused this
21726 delivery to happen. More than one address may be present if the transport is
21727 configured to handle several addresses at once, or if more than one original
21728 address was redirected to the same final address. As this is not a standard
21729 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21730 its removal from incoming messages, so that delivered messages can safely be
21731 resent to other recipients.
21732
21733
21734 .option event_action transports string&!! unset
21735 .cindex events
21736 This option declares a string to be expanded for Exim's events mechanism.
21737 For details see chapter &<<CHAPevents>>&.
21738
21739
21740 .option group transports string&!! "Exim group"
21741 .cindex "transport" "group; specifying"
21742 This option specifies a gid for running the transport process, overriding any
21743 value that the router supplies, and also overriding any value associated with
21744 &%user%& (see below).
21745
21746
21747 .option headers_add transports list&!! unset
21748 .cindex "header lines" "adding in transport"
21749 .cindex "transport" "header lines; adding"
21750 This option specifies a list of text headers,
21751 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21752 which are (separately) expanded and added to the header
21753 portion of a message as it is transported, as described in section
21754 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21755 routers. If the result of the expansion is an empty string, or if the expansion
21756 is forced to fail, no action is taken. Other expansion failures are treated as
21757 errors and cause the delivery to be deferred.
21758
21759 Unlike most options, &%headers_add%& can be specified multiple times
21760 for a transport; all listed headers are added.
21761
21762
21763 .option headers_only transports boolean false
21764 .cindex "transport" "header lines only"
21765 .cindex "message" "transporting headers only"
21766 .cindex "header lines" "transporting"
21767 If this option is set, the message's body is not transported. It is mutually
21768 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21769 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21770 checked, since this option does not automatically suppress them.
21771
21772
21773 .option headers_remove transports list&!! unset
21774 .cindex "header lines" "removing"
21775 .cindex "transport" "header lines; removing"
21776 This option specifies a list of header names,
21777 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21778 these headers are omitted from the message as it is transported, as described
21779 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21780 routers.
21781 Each list item is separately expanded.
21782 If the result of the expansion is an empty string, or if the expansion
21783 is forced to fail, no action is taken. Other expansion failures are treated as
21784 errors and cause the delivery to be deferred.
21785
21786 Unlike most options, &%headers_remove%& can be specified multiple times
21787 for a transport; all listed headers are removed.
21788
21789 &*Warning*&: Because of the separate expansion of the list items,
21790 items that contain a list separator must have it doubled.
21791 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21792
21793
21794
21795 .option headers_rewrite transports string unset
21796 .cindex "transport" "header lines; rewriting"
21797 .cindex "rewriting" "at transport time"
21798 This option allows addresses in header lines to be rewritten at transport time,
21799 that is, as the message is being copied to its destination. The contents of the
21800 option are a colon-separated list of rewriting rules. Each rule is in exactly
21801 the same form as one of the general rewriting rules that are applied when a
21802 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21803 example,
21804 .code
21805 headers_rewrite = a@b c@d f : \
21806                   x@y w@z
21807 .endd
21808 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21809 &'w@z'& in all address-bearing header lines. The rules are applied to the
21810 header lines just before they are written out at transport time, so they affect
21811 only those copies of the message that pass through the transport. However, only
21812 the message's original header lines, and any that were added by a system
21813 filter, are rewritten. If a router or transport adds header lines, they are not
21814 affected by this option. These rewriting rules are &'not'& applied to the
21815 envelope. You can change the return path using &%return_path%&, but you cannot
21816 change envelope recipients at this time.
21817
21818
21819 .option home_directory transports string&!! unset
21820 .cindex "transport" "home directory for"
21821 .vindex "&$home$&"
21822 This option specifies a home directory setting for a local transport,
21823 overriding any value that may be set by the router. The home directory is
21824 placed in &$home$& while expanding the transport's private options. It is also
21825 used as the current directory if no current directory is set by the
21826 &%current_directory%& option on the transport or the
21827 &%transport_current_directory%& option on the router. If the expansion fails
21828 for any reason, including forced failure, an error is logged, and delivery is
21829 deferred.
21830
21831
21832 .option initgroups transports boolean false
21833 .cindex "additional groups"
21834 .cindex "groups" "additional"
21835 .cindex "transport" "group; additional"
21836 If this option is true and the uid for the delivery process is provided by the
21837 transport, the &[initgroups()]& function is called when running the transport
21838 to ensure that any additional groups associated with the uid are set up.
21839
21840
21841 .option max_parallel transports integer&!! unset
21842 .cindex limit "transport parallelism"
21843 .cindex transport "parallel processes"
21844 .cindex transport "concurrency limit"
21845 .cindex "delivery" "parallelism for transport"
21846 If this option is set and expands to an integer greater than zero
21847 it limits the number of concurrent runs of the transport.
21848 The control does not apply to shadow transports.
21849
21850 .cindex "hints database" "transport concurrency control"
21851 Exim implements this control by means of a hints database in which a record is
21852 incremented whenever a transport process is being created. The record
21853 is decremented and possibly removed when the process terminates.
21854 Obviously there is scope for
21855 records to get left lying around if there is a system or program crash. To
21856 guard against this, Exim ignores any records that are more than six hours old.
21857
21858 If you use this option, you should also arrange to delete the
21859 relevant hints database whenever your system reboots. The names of the files
21860 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21861 may be one or two files, depending on the type of DBM in use. The same files
21862 are used for ETRN and smtp transport serialization.
21863
21864
21865 .option message_size_limit transports string&!! 0
21866 .cindex "limit" "message size per transport"
21867 .cindex "size" "of message, limit"
21868 .cindex "transport" "message size; limiting"
21869 This option controls the size of messages passed through the transport. It is
21870 expanded before use; the result of the expansion must be a sequence of decimal
21871 digits, optionally followed by K or M. If the expansion fails for any reason,
21872 including forced failure, or if the result is not of the required form,
21873 delivery is deferred. If the value is greater than zero and the size of a
21874 message exceeds this limit, the address is failed. If there is any chance that
21875 the resulting bounce message could be routed to the same transport, you should
21876 ensure that &%return_size_limit%& is less than the transport's
21877 &%message_size_limit%&, as otherwise the bounce message will fail to get
21878 delivered.
21879
21880
21881
21882 .option rcpt_include_affixes transports boolean false
21883 .cindex "prefix" "for local part, including in envelope"
21884 .cindex "suffix for local part" "including in envelope"
21885 .cindex "local part" "prefix"
21886 .cindex "local part" "suffix"
21887 When this option is false (the default), and an address that has had any
21888 affixes (prefixes or suffixes) removed from the local part is delivered by any
21889 form of SMTP or LMTP, the affixes are not included. For example, if a router
21890 that contains
21891 .code
21892 local_part_prefix = *-
21893 .endd
21894 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21895 is delivered with
21896 .code
21897 RCPT TO:<xyz@some.domain>
21898 .endd
21899 This is also the case when an ACL-time callout is being used to verify a
21900 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21901 whole local part is included in the RCPT command. This option applies to BSMTP
21902 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21903 &(lmtp)& and &(smtp)& transports.
21904
21905
21906 .option retry_use_local_part transports boolean "see below"
21907 .cindex "hints database" "retry keys"
21908 When a delivery suffers a temporary failure, a retry record is created
21909 in Exim's hints database. For remote deliveries, the key for the retry record
21910 is based on the name and/or IP address of the failing remote host. For local
21911 deliveries, the key is normally the entire address, including both the local
21912 part and the domain. This is suitable for most common cases of local delivery
21913 temporary failure &-- for example, exceeding a mailbox quota should delay only
21914 deliveries to that mailbox, not to the whole domain.
21915
21916 However, in some special cases you may want to treat a temporary local delivery
21917 as a failure associated with the domain, and not with a particular local part.
21918 (For example, if you are storing all mail for some domain in files.) You can do
21919 this by setting &%retry_use_local_part%& false.
21920
21921 For all the local transports, its default value is true. For remote transports,
21922 the default value is false for tidiness, but changing the value has no effect
21923 on a remote transport in the current implementation.
21924
21925
21926 .option return_path transports string&!! unset
21927 .cindex "envelope sender"
21928 .cindex "envelope from"
21929 .cindex "transport" "return path; changing"
21930 .cindex "return path" "changing in transport"
21931 If this option is set, the string is expanded at transport time and replaces
21932 the existing return path (envelope sender) value in the copy of the message
21933 that is being delivered. An empty return path is permitted. This feature is
21934 designed for remote deliveries, where the value of this option is used in the
21935 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21936 only effect is to change the address that is placed in the &'Return-path:'&
21937 header line, if one is added to the message (see the next option).
21938
21939 &*Note:*& A changed return path is not logged unless you add
21940 &%return_path_on_delivery%& to the log selector.
21941
21942 .vindex "&$return_path$&"
21943 The expansion can refer to the existing value via &$return_path$&. This is
21944 either the message's envelope sender, or an address set by the
21945 &%errors_to%& option on a router. If the expansion is forced to fail, no
21946 replacement occurs; if it fails for another reason, delivery is deferred. This
21947 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21948 section &<<SECTverp>>&.
21949
21950 &*Note*&: If a delivery error is detected locally, including the case when a
21951 remote server rejects a message at SMTP time, the bounce message is not sent to
21952 the value of this option. It is sent to the previously set errors address.
21953 This defaults to the incoming sender address, but can be changed by setting
21954 &%errors_to%& in a router.
21955
21956
21957
21958 .option return_path_add transports boolean false
21959 .cindex "&'Return-path:'& header line"
21960 If this option is true, a &'Return-path:'& header is added to the message.
21961 Although the return path is normally available in the prefix line of BSD
21962 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21963 have easy access to it.
21964
21965 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21966 the delivery SMTP server makes the final delivery"&. This implies that this
21967 header should not be present in incoming messages. Exim has a configuration
21968 option, &%return_path_remove%&, which requests removal of this header from
21969 incoming messages, so that delivered messages can safely be resent to other
21970 recipients.
21971
21972
21973 .option shadow_condition transports string&!! unset
21974 See &%shadow_transport%& below.
21975
21976
21977 .option shadow_transport transports string unset
21978 .cindex "shadow transport"
21979 .cindex "transport" "shadow"
21980 A local transport may set the &%shadow_transport%& option to the name of
21981 another local transport. Shadow remote transports are not supported.
21982
21983 Whenever a delivery to the main transport succeeds, and either
21984 &%shadow_condition%& is unset, or its expansion does not result in the empty
21985 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21986 passed to the shadow transport, with the same delivery address or addresses. If
21987 expansion fails, no action is taken except that non-forced expansion failures
21988 cause a log line to be written.
21989
21990 The result of the shadow transport is discarded and does not affect the
21991 subsequent processing of the message. Only a single level of shadowing is
21992 provided; the &%shadow_transport%& option is ignored on any transport when it
21993 is running as a shadow. Options concerned with output from pipes are also
21994 ignored. The log line for the successful delivery has an item added on the end,
21995 of the form
21996 .code
21997 ST=<shadow transport name>
21998 .endd
21999 If the shadow transport did not succeed, the error message is put in
22000 parentheses afterwards. Shadow transports can be used for a number of different
22001 purposes, including keeping more detailed log information than Exim normally
22002 provides, and implementing automatic acknowledgment policies based on message
22003 headers that some sites insist on.
22004
22005
22006 .option transport_filter transports string&!! unset
22007 .cindex "transport" "filter"
22008 .cindex "filter" "transport filter"
22009 This option sets up a filtering (in the Unix shell sense) process for messages
22010 at transport time. It should not be confused with mail filtering as set up by
22011 individual users or via a system filter.
22012 If unset, or expanding to an empty string, no filtering is done.
22013
22014 When the message is about to be written out, the command specified by
22015 &%transport_filter%& is started up in a separate, parallel process, and
22016 the entire message, including the header lines, is passed to it on its standard
22017 input (this in fact is done from a third process, to avoid deadlock). The
22018 command must be specified as an absolute path.
22019
22020 The lines of the message that are written to the transport filter are
22021 terminated by newline (&"\n"&). The message is passed to the filter before any
22022 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22023 lines beginning with a dot, and also before any processing implied by the
22024 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22025 &(pipe)& transports.
22026
22027 The standard error for the filter process is set to the same destination as its
22028 standard output; this is read and written to the message's ultimate
22029 destination. The process that writes the message to the filter, the
22030 filter itself, and the original process that reads the result and delivers it
22031 are all run in parallel, like a shell pipeline.
22032
22033 The filter can perform any transformations it likes, but of course should take
22034 care not to break RFC 2822 syntax. Exim does not check the result, except to
22035 test for a final newline when SMTP is in use. All messages transmitted over
22036 SMTP must end with a newline, so Exim supplies one if it is missing.
22037
22038 .cindex "content scanning" "per user"
22039 A transport filter can be used to provide content-scanning on a per-user basis
22040 at delivery time if the only required effect of the scan is to modify the
22041 message. For example, a content scan could insert a new header line containing
22042 a spam score. This could be interpreted by a filter in the user's MUA. It is
22043 not possible to discard a message at this stage.
22044
22045 .cindex "SMTP" "SIZE"
22046 A problem might arise if the filter increases the size of a message that is
22047 being sent down an SMTP connection. If the receiving SMTP server has indicated
22048 support for the SIZE parameter, Exim will have sent the size of the message
22049 at the start of the SMTP session. If what is actually sent is substantially
22050 more, the server might reject the message. This can be worked round by setting
22051 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22052 additions to the message, or to disable the use of SIZE altogether.
22053
22054 .vindex "&$pipe_addresses$&"
22055 The value of the &%transport_filter%& option is the command string for starting
22056 the filter, which is run directly from Exim, not under a shell. The string is
22057 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22058 Exim breaks it up into arguments and then expands each argument separately (see
22059 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22060 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22061 of arguments, one for each address that applies to this delivery. (This isn't
22062 an ideal name for this feature here, but as it was already implemented for the
22063 &(pipe)& transport, it seemed sensible not to change it.)
22064
22065 .vindex "&$host$&"
22066 .vindex "&$host_address$&"
22067 The expansion variables &$host$& and &$host_address$& are available when the
22068 transport is a remote one. They contain the name and IP address of the host to
22069 which the message is being sent. For example:
22070 .code
22071 transport_filter = /some/directory/transport-filter.pl \
22072   $host $host_address $sender_address $pipe_addresses
22073 .endd
22074
22075 Two problems arise if you want to use more complicated expansion items to
22076 generate transport filter commands, both of which due to the fact that the
22077 command is split up &'before'& expansion.
22078 .ilist
22079 If an expansion item contains white space, you must quote it, so that it is all
22080 part of the same command item. If the entire option setting is one such
22081 expansion item, you have to take care what kind of quoting you use. For
22082 example:
22083 .code
22084 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22085 .endd
22086 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22087 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22088 stripped by Exim when it read the option's value. When the value is used, if
22089 the single quotes were missing, the line would be split into two items,
22090 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22091 Exim tried to expand the first one.
22092 .next
22093 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22094 expansion cannot generate multiple arguments, or a command name followed by
22095 arguments. Consider this example:
22096 .code
22097 transport_filter = ${lookup{$host}lsearch{/a/file}\
22098                     {$value}{/bin/cat}}
22099 .endd
22100 The result of the lookup is interpreted as the name of the command, even
22101 if it contains white space. The simplest way round this is to use a shell:
22102 .code
22103 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22104                                {$value}{/bin/cat}}
22105 .endd
22106 .endlist
22107
22108 The filter process is run under the same uid and gid as the normal delivery.
22109 For remote deliveries this is the Exim uid/gid by default. The command should
22110 normally yield a zero return code. Transport filters are not supposed to fail.
22111 A non-zero code is taken to mean that the transport filter encountered some
22112 serious problem. Delivery of the message is deferred; the message remains on
22113 the queue and is tried again later. It is not possible to cause a message to be
22114 bounced from a transport filter.
22115
22116 If a transport filter is set on an autoreply transport, the original message is
22117 passed through the filter as it is being copied into the newly generated
22118 message, which happens if the &%return_message%& option is set.
22119
22120
22121 .option transport_filter_timeout transports time 5m
22122 .cindex "transport" "filter, timeout"
22123 When Exim is reading the output of a transport filter, it applies a timeout
22124 that can be set by this option. Exceeding the timeout is normally treated as a
22125 temporary delivery failure. However, if a transport filter is used with a
22126 &(pipe)& transport, a timeout in the transport filter is treated in the same
22127 way as a timeout in the pipe command itself. By default, a timeout is a hard
22128 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22129 becomes a temporary error.
22130
22131
22132 .option user transports string&!! "Exim user"
22133 .cindex "uid (user id)" "local delivery"
22134 .cindex "transport" "user, specifying"
22135 This option specifies the user under whose uid the delivery process is to be
22136 run, overriding any uid that may have been set by the router. If the user is
22137 given as a name, the uid is looked up from the password data, and the
22138 associated group is taken as the value of the gid to be used if the &%group%&
22139 option is not set.
22140
22141 For deliveries that use local transports, a user and group are normally
22142 specified explicitly or implicitly (for example, as a result of
22143 &%check_local_user%&) by the router or transport.
22144
22145 .cindex "hints database" "access by remote transport"
22146 For remote transports, you should leave this option unset unless you really are
22147 sure you know what you are doing. When a remote transport is running, it needs
22148 to be able to access Exim's hints databases, because each host may have its own
22149 retry data.
22150 .ecindex IIDgenoptra1
22151 .ecindex IIDgenoptra2
22152 .ecindex IIDgenoptra3
22153
22154
22155
22156
22157
22158
22159 . ////////////////////////////////////////////////////////////////////////////
22160 . ////////////////////////////////////////////////////////////////////////////
22161
22162 .chapter "Address batching in local transports" "CHAPbatching" &&&
22163          "Address batching"
22164 .cindex "transport" "local; address batching in"
22165 The only remote transport (&(smtp)&) is normally configured to handle more than
22166 one address at a time, so that when several addresses are routed to the same
22167 remote host, just one copy of the message is sent. Local transports, however,
22168 normally handle one address at a time. That is, a separate instance of the
22169 transport is run for each address that is routed to the transport. A separate
22170 copy of the message is delivered each time.
22171
22172 .cindex "batched local delivery"
22173 .oindex "&%batch_max%&"
22174 .oindex "&%batch_id%&"
22175 In special cases, it may be desirable to handle several addresses at once in a
22176 local transport, for example:
22177
22178 .ilist
22179 In an &(appendfile)& transport, when storing messages in files for later
22180 delivery by some other means, a single copy of the message with multiple
22181 recipients saves space.
22182 .next
22183 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22184 a single copy saves time, and is the normal way LMTP is expected to work.
22185 .next
22186 In a &(pipe)& transport, when passing the message
22187 to a scanner program or
22188 to some other delivery mechanism such as UUCP, multiple recipients may be
22189 acceptable.
22190 .endlist
22191
22192 These three local transports all have the same options for controlling multiple
22193 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22194 repeating the information for each transport, these options are described here.
22195
22196 The &%batch_max%& option specifies the maximum number of addresses that can be
22197 delivered together in a single run of the transport. Its default value is one
22198 (no batching). When more than one address is routed to a transport that has a
22199 &%batch_max%& value greater than one, the addresses are delivered in a batch
22200 (that is, in a single run of the transport with multiple recipients), subject
22201 to certain conditions:
22202
22203 .ilist
22204 .vindex "&$local_part$&"
22205 If any of the transport's options contain a reference to &$local_part$&, no
22206 batching is possible.
22207 .next
22208 .vindex "&$domain$&"
22209 If any of the transport's options contain a reference to &$domain$&, only
22210 addresses with the same domain are batched.
22211 .next
22212 .cindex "customizing" "batching condition"
22213 If &%batch_id%& is set, it is expanded for each address, and only those
22214 addresses with the same expanded value are batched. This allows you to specify
22215 customized batching conditions. Failure of the expansion for any reason,
22216 including forced failure, disables batching, but it does not stop the delivery
22217 from taking place.
22218 .next
22219 Batched addresses must also have the same errors address (where to send
22220 delivery errors), the same header additions and removals, the same user and
22221 group for the transport, and if a host list is present, the first host must
22222 be the same.
22223 .endlist
22224
22225 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22226 both when the file or pipe command is specified in the transport, and when it
22227 is specified by a &(redirect)& router, but all the batched addresses must of
22228 course be routed to the same file or pipe command. These two transports have an
22229 option called &%use_bsmtp%&, which causes them to deliver the message in
22230 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22231 &%check_string%& and &%escape_string%& options are forced to the values
22232 .code
22233 check_string = "."
22234 escape_string = ".."
22235 .endd
22236 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22237 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22238 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22239
22240 .cindex "&'Envelope-to:'& header line"
22241 If the generic &%envelope_to_add%& option is set for a batching transport, the
22242 &'Envelope-to:'& header that is added to the message contains all the addresses
22243 that are being processed together. If you are using a batching &(appendfile)&
22244 transport without &%use_bsmtp%&, the only way to preserve the recipient
22245 addresses is to set the &%envelope_to_add%& option.
22246
22247 .cindex "&(pipe)& transport" "with multiple addresses"
22248 .vindex "&$pipe_addresses$&"
22249 If you are using a &(pipe)& transport without BSMTP, and setting the
22250 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22251 the command. This is not a true variable; it is a bit of magic that causes each
22252 of the recipient addresses to be inserted into the command as a separate
22253 argument. This provides a way of accessing all the addresses that are being
22254 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22255 are specified by a &(redirect)& router.
22256
22257
22258
22259
22260 . ////////////////////////////////////////////////////////////////////////////
22261 . ////////////////////////////////////////////////////////////////////////////
22262
22263 .chapter "The appendfile transport" "CHAPappendfile"
22264 .scindex IIDapptra1 "&(appendfile)& transport"
22265 .scindex IIDapptra2 "transports" "&(appendfile)&"
22266 .cindex "directory creation"
22267 .cindex "creating directories"
22268 The &(appendfile)& transport delivers a message by appending it to an existing
22269 file, or by creating an entirely new file in a specified directory. Single
22270 files to which messages are appended can be in the traditional Unix mailbox
22271 format, or optionally in the MBX format supported by the Pine MUA and
22272 University of Washington IMAP daemon, &'inter alia'&. When each message is
22273 being delivered as a separate file, &"maildir"& format can optionally be used
22274 to give added protection against failures that happen part-way through the
22275 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22276 supported. For all file formats, Exim attempts to create as many levels of
22277 directory as necessary, provided that &%create_directory%& is set.
22278
22279 The code for the optional formats is not included in the Exim binary by
22280 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22281 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22282 included.
22283
22284 .cindex "quota" "system"
22285 Exim recognizes system quota errors, and generates an appropriate message. Exim
22286 also supports its own quota control within the transport, for use when the
22287 system facility is unavailable or cannot be used for some reason.
22288
22289 If there is an error while appending to a file (for example, quota exceeded or
22290 partition filled), Exim attempts to reset the file's length and last
22291 modification time back to what they were before. If there is an error while
22292 creating an entirely new file, the new file is removed.
22293
22294 Before appending to a file, a number of security checks are made, and the
22295 file is locked. A detailed description is given below, after the list of
22296 private options.
22297
22298 The &(appendfile)& transport is most commonly used for local deliveries to
22299 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22300 putting messages into files for remote delivery by some means other than Exim.
22301 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22302 option).
22303
22304
22305
22306 .section "The file and directory options" "SECTfildiropt"
22307 The &%file%& option specifies a single file, to which the message is appended;
22308 the &%directory%& option specifies a directory, in which a new file containing
22309 the message is created. Only one of these two options can be set, and for
22310 normal deliveries to mailboxes, one of them &'must'& be set.
22311
22312 .vindex "&$address_file$&"
22313 .vindex "&$local_part$&"
22314 However, &(appendfile)& is also used for delivering messages to files or
22315 directories whose names (or parts of names) are obtained from alias,
22316 forwarding, or filtering operations (for example, a &%save%& command in a
22317 user's Exim filter). When such a transport is running, &$local_part$& contains
22318 the local part that was aliased or forwarded, and &$address_file$& contains the
22319 name (or partial name) of the file or directory generated by the redirection
22320 operation. There are two cases:
22321
22322 .ilist
22323 If neither &%file%& nor &%directory%& is set, the redirection operation
22324 must specify an absolute path (one that begins with &`/`&). This is the most
22325 common case when users with local accounts use filtering to sort mail into
22326 different folders. See for example, the &(address_file)& transport in the
22327 default configuration. If the path ends with a slash, it is assumed to be the
22328 name of a directory. A delivery to a directory can also be forced by setting
22329 &%maildir_format%& or &%mailstore_format%&.
22330 .next
22331 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22332 used to determine the file or directory name for the delivery. Normally, the
22333 contents of &$address_file$& are used in some way in the string expansion.
22334 .endlist
22335
22336
22337 .cindex "Sieve filter" "configuring &(appendfile)&"
22338 .cindex "Sieve filter" "relative mailbox path handling"
22339 As an example of the second case, consider an environment where users do not
22340 have home directories. They may be permitted to use Exim filter commands of the
22341 form:
22342 .code
22343 save folder23
22344 .endd
22345 or Sieve filter commands of the form:
22346 .code
22347 require "fileinto";
22348 fileinto "folder23";
22349 .endd
22350 In this situation, the expansion of &%file%& or &%directory%& in the transport
22351 must transform the relative path into an appropriate absolute filename. In the
22352 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22353 is used as a result of a &"keep"& action in the filter. This example shows one
22354 way of handling this requirement:
22355 .code
22356 file = ${if eq{$address_file}{inbox} \
22357             {/var/mail/$local_part} \
22358             {${if eq{${substr_0_1:$address_file}}{/} \
22359                   {$address_file} \
22360                   {$home/mail/$address_file} \
22361             }} \
22362        }
22363 .endd
22364 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22365 location, absolute paths are used without change, and other folders are in the
22366 &_mail_& directory within the home directory.
22367
22368 &*Note 1*&: While processing an Exim filter, a relative path such as
22369 &_folder23_& is turned into an absolute path if a home directory is known to
22370 the router. In particular, this is the case if &%check_local_user%& is set. If
22371 you want to prevent this happening at routing time, you can set
22372 &%router_home_directory%& empty. This forces the router to pass the relative
22373 path to the transport.
22374
22375 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22376 the &%file%& or &%directory%& option is still used if it is set.
22377
22378
22379
22380
22381 .section "Private options for appendfile" "SECID134"
22382 .cindex "options" "&(appendfile)& transport"
22383
22384
22385
22386 .option allow_fifo appendfile boolean false
22387 .cindex "fifo (named pipe)"
22388 .cindex "named pipe (fifo)"
22389 .cindex "pipe" "named (fifo)"
22390 Setting this option permits delivery to named pipes (FIFOs) as well as to
22391 regular files. If no process is reading the named pipe at delivery time, the
22392 delivery is deferred.
22393
22394
22395 .option allow_symlink appendfile boolean false
22396 .cindex "symbolic link" "to mailbox"
22397 .cindex "mailbox" "symbolic link"
22398 By default, &(appendfile)& will not deliver if the path name for the file is
22399 that of a symbolic link. Setting this option relaxes that constraint, but there
22400 are security issues involved in the use of symbolic links. Be sure you know
22401 what you are doing if you set this. Details of exactly what this option affects
22402 are included in the discussion which follows this list of options.
22403
22404
22405 .option batch_id appendfile string&!! unset
22406 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22407 However, batching is automatically disabled for &(appendfile)& deliveries that
22408 happen as a result of forwarding or aliasing or other redirection directly to a
22409 file.
22410
22411
22412 .option batch_max appendfile integer 1
22413 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22414
22415
22416 .option check_group appendfile boolean false
22417 When this option is set, the group owner of the file defined by the &%file%&
22418 option is checked to see that it is the same as the group under which the
22419 delivery process is running. The default setting is false because the default
22420 file mode is 0600, which means that the group is irrelevant.
22421
22422
22423 .option check_owner appendfile boolean true
22424 When this option is set, the owner of the file defined by the &%file%& option
22425 is checked to ensure that it is the same as the user under which the delivery
22426 process is running.
22427
22428
22429 .option check_string appendfile string "see below"
22430 .cindex "&""From""& line"
22431 As &(appendfile)& writes the message, the start of each line is tested for
22432 matching &%check_string%&, and if it does, the initial matching characters are
22433 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22434 a literal string, not a regular expression, and the case of any letters it
22435 contains is significant.
22436
22437 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22438 are forced to &"."& and &".."& respectively, and any settings in the
22439 configuration are ignored. Otherwise, they default to &"From&~"& and
22440 &">From&~"& when the &%file%& option is set, and unset when any of the
22441 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22442
22443 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22444 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22445 &"From&~"& indicates the start of a new message. All four options need changing
22446 if another format is used. For example, to deliver to mailboxes in MMDF format:
22447 .cindex "MMDF format mailbox"
22448 .cindex "mailbox" "MMDF format"
22449 .code
22450 check_string = "\1\1\1\1\n"
22451 escape_string = "\1\1\1\1 \n"
22452 message_prefix = "\1\1\1\1\n"
22453 message_suffix = "\1\1\1\1\n"
22454 .endd
22455 .option create_directory appendfile boolean true
22456 .cindex "directory creation"
22457 When this option is true, Exim attempts to create any missing superior
22458 directories for the file that it is about to write. A created directory's mode
22459 is given by the &%directory_mode%& option.
22460
22461 The group ownership of a newly created directory is highly dependent on the
22462 operating system (and possibly the file system) that is being used. For
22463 example, in Solaris, if the parent directory has the setgid bit set, its group
22464 is propagated to the child; if not, the currently set group is used. However,
22465 in FreeBSD, the parent's group is always used.
22466
22467
22468
22469 .option create_file appendfile string anywhere
22470 This option constrains the location of files and directories that are created
22471 by this transport. It applies to files defined by the &%file%& option and
22472 directories defined by the &%directory%& option. In the case of maildir
22473 delivery, it applies to the top level directory, not the maildir directories
22474 beneath.
22475
22476 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22477 &"belowhome"&. In the second and third cases, a home directory must have been
22478 set for the transport. This option is not useful when an explicit filename is
22479 given for normal mailbox deliveries. It is intended for the case when filenames
22480 are generated from users' &_.forward_& files. These are usually handled
22481 by an &(appendfile)& transport called &%address_file%&. See also
22482 &%file_must_exist%&.
22483
22484
22485 .option directory appendfile string&!! unset
22486 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22487 or &%directory%& must be set, unless the delivery is the direct result of a
22488 redirection (see section &<<SECTfildiropt>>&).
22489
22490 When &%directory%& is set, the string is expanded, and the message is delivered
22491 into a new file or files in or below the given directory, instead of being
22492 appended to a single mailbox file. A number of different formats are provided
22493 (see &%maildir_format%& and &%mailstore_format%&), and see section
22494 &<<SECTopdir>>& for further details of this form of delivery.
22495
22496
22497 .option directory_file appendfile string&!! "see below"
22498 .cindex "base62"
22499 .vindex "&$inode$&"
22500 When &%directory%& is set, but neither &%maildir_format%& nor
22501 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22502 whose name is obtained by expanding this string. The default value is:
22503 .code
22504 q${base62:$tod_epoch}-$inode
22505 .endd
22506 This generates a unique name from the current time, in base 62 form, and the
22507 inode of the file. The variable &$inode$& is available only when expanding this
22508 option.
22509
22510
22511 .option directory_mode appendfile "octal integer" 0700
22512 If &(appendfile)& creates any directories as a result of the
22513 &%create_directory%& option, their mode is specified by this option.
22514
22515
22516 .option escape_string appendfile string "see description"
22517 See &%check_string%& above.
22518
22519
22520 .option file appendfile string&!! unset
22521 This option is mutually exclusive with the &%directory%& option, but one of
22522 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22523 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22524 specifies a single file, to which the message is appended. One or more of
22525 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22526 &%file%&.
22527
22528 .cindex "NFS" "lock file"
22529 .cindex "locking files"
22530 .cindex "lock files"
22531 If you are using more than one host to deliver over NFS into the same
22532 mailboxes, you should always use lock files.
22533
22534 The string value is expanded for each delivery, and must yield an absolute
22535 path. The most common settings of this option are variations on one of these
22536 examples:
22537 .code
22538 file = /var/spool/mail/$local_part
22539 file = /home/$local_part/inbox
22540 file = $home/inbox
22541 .endd
22542 .cindex "&""sticky""& bit"
22543 In the first example, all deliveries are done into the same directory. If Exim
22544 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22545 create a file in the directory, so the &"sticky"& bit must be turned on for
22546 deliveries to be possible, or alternatively the &%group%& option can be used to
22547 run the delivery under a group id which has write access to the directory.
22548
22549
22550
22551 .option file_format appendfile string unset
22552 .cindex "file" "mailbox; checking existing format"
22553 This option requests the transport to check the format of an existing file
22554 before adding to it. The check consists of matching a specific string at the
22555 start of the file. The value of the option consists of an even number of
22556 colon-separated strings. The first of each pair is the test string, and the
22557 second is the name of a transport. If the transport associated with a matched
22558 string is not the current transport, control is passed over to the other
22559 transport. For example, suppose the standard &(local_delivery)& transport has
22560 this added to it:
22561 .code
22562 file_format = "From       : local_delivery :\
22563                \1\1\1\1\n : local_mmdf_delivery"
22564 .endd
22565 Mailboxes that begin with &"From"& are still handled by this transport, but if
22566 a mailbox begins with four binary ones followed by a newline, control is passed
22567 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22568 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22569 is assumed to match the current transport. If the start of a mailbox doesn't
22570 match any string, or if the transport named for a given string is not defined,
22571 delivery is deferred.
22572
22573
22574 .option file_must_exist appendfile boolean false
22575 If this option is true, the file specified by the &%file%& option must exist.
22576 A temporary error occurs if it does not, causing delivery to be deferred.
22577 If this option is false, the file is created if it does not exist.
22578
22579
22580 .option lock_fcntl_timeout appendfile time 0s
22581 .cindex "timeout" "mailbox locking"
22582 .cindex "mailbox" "locking, blocking and non-blocking"
22583 .cindex "locking files"
22584 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22585 when locking an open mailbox file. If the call fails, the delivery process
22586 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22587 Non-blocking calls are used so that the file is not kept open during the wait
22588 for the lock; the reason for this is to make it as safe as possible for
22589 deliveries over NFS in the case when processes might be accessing an NFS
22590 mailbox without using a lock file. This should not be done, but
22591 misunderstandings and hence misconfigurations are not unknown.
22592
22593 On a busy system, however, the performance of a non-blocking lock approach is
22594 not as good as using a blocking lock with a timeout. In this case, the waiting
22595 is done inside the system call, and Exim's delivery process acquires the lock
22596 and can proceed as soon as the previous lock holder releases it.
22597
22598 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22599 timeout, are used. There may still be some retrying: the maximum number of
22600 retries is
22601 .code
22602 (lock_retries * lock_interval) / lock_fcntl_timeout
22603 .endd
22604 rounded up to the next whole number. In other words, the total time during
22605 which &(appendfile)& is trying to get a lock is roughly the same, unless
22606 &%lock_fcntl_timeout%& is set very large.
22607
22608 You should consider setting this option if you are getting a lot of delayed
22609 local deliveries because of errors of the form
22610 .code
22611 failed to lock mailbox /some/file (fcntl)
22612 .endd
22613
22614 .option lock_flock_timeout appendfile time 0s
22615 This timeout applies to file locking when using &[flock()]& (see
22616 &%use_flock%&); the timeout operates in a similar manner to
22617 &%lock_fcntl_timeout%&.
22618
22619
22620 .option lock_interval appendfile time 3s
22621 This specifies the time to wait between attempts to lock the file. See below
22622 for details of locking.
22623
22624
22625 .option lock_retries appendfile integer 10
22626 This specifies the maximum number of attempts to lock the file. A value of zero
22627 is treated as 1. See below for details of locking.
22628
22629
22630 .option lockfile_mode appendfile "octal integer" 0600
22631 This specifies the mode of the created lock file, when a lock file is being
22632 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22633
22634
22635 .option lockfile_timeout appendfile time 30m
22636 .cindex "timeout" "mailbox locking"
22637 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22638 exists and is older than this value, it is assumed to have been left behind by
22639 accident, and Exim attempts to remove it.
22640
22641
22642 .option mailbox_filecount appendfile string&!! unset
22643 .cindex "mailbox" "specifying size of"
22644 .cindex "size" "of mailbox"
22645 If this option is set, it is expanded, and the result is taken as the current
22646 number of files in the mailbox. It must be a decimal number, optionally
22647 followed by K or M. This provides a way of obtaining this information from an
22648 external source that maintains the data.
22649
22650
22651 .option mailbox_size appendfile string&!! unset
22652 .cindex "mailbox" "specifying size of"
22653 .cindex "size" "of mailbox"
22654 If this option is set, it is expanded, and the result is taken as the current
22655 size the mailbox. It must be a decimal number, optionally followed by K or M.
22656 This provides a way of obtaining this information from an external source that
22657 maintains the data. This is likely to be helpful for maildir deliveries where
22658 it is computationally expensive to compute the size of a mailbox.
22659
22660
22661
22662 .option maildir_format appendfile boolean false
22663 .cindex "maildir format" "specifying"
22664 If this option is set with the &%directory%& option, the delivery is into a new
22665 file, in the &"maildir"& format that is used by other mail software. When the
22666 transport is activated directly from a &(redirect)& router (for example, the
22667 &(address_file)& transport in the default configuration), setting
22668 &%maildir_format%& causes the path received from the router to be treated as a
22669 directory, whether or not it ends with &`/`&. This option is available only if
22670 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22671 &<<SECTmaildirdelivery>>& below for further details.
22672
22673
22674 .option maildir_quota_directory_regex appendfile string "See below"
22675 .cindex "maildir format" "quota; directories included in"
22676 .cindex "quota" "maildir; directories included in"
22677 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22678 a regular expression for specifying directories, relative to the quota
22679 directory (see &%quota_directory%&), that should be included in the quota
22680 calculation. The default value is:
22681 .code
22682 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22683 .endd
22684 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22685 (directories whose names begin with a dot). If you want to exclude the
22686 &_Trash_&
22687 folder from the count (as some sites do), you need to change this setting to
22688 .code
22689 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22690 .endd
22691 This uses a negative lookahead in the regular expression to exclude the
22692 directory whose name is &_.Trash_&. When a directory is excluded from quota
22693 calculations, quota processing is bypassed for any messages that are delivered
22694 directly into that directory.
22695
22696
22697 .option maildir_retries appendfile integer 10
22698 This option specifies the number of times to retry when writing a file in
22699 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22700
22701
22702 .option maildir_tag appendfile string&!! unset
22703 This option applies only to deliveries in maildir format, and is described in
22704 section &<<SECTmaildirdelivery>>& below.
22705
22706
22707 .option maildir_use_size_file appendfile&!! boolean false
22708 .cindex "maildir format" "&_maildirsize_& file"
22709 The result of string expansion for this option must be a valid boolean value.
22710 If it is true, it enables support for &_maildirsize_& files. Exim
22711 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22712 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22713 value is zero. See &%maildir_quota_directory_regex%& above and section
22714 &<<SECTmaildirdelivery>>& below for further details.
22715
22716 .option maildirfolder_create_regex appendfile string unset
22717 .cindex "maildir format" "&_maildirfolder_& file"
22718 .cindex "&_maildirfolder_&, creating"
22719 The value of this option is a regular expression. If it is unset, it has no
22720 effect. Otherwise, before a maildir delivery takes place, the pattern is
22721 matched against the name of the maildir directory, that is, the directory
22722 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22723 delivery. If there is a match, Exim checks for the existence of a file called
22724 &_maildirfolder_& in the directory, and creates it if it does not exist.
22725 See section &<<SECTmaildirdelivery>>& for more details.
22726
22727
22728 .option mailstore_format appendfile boolean false
22729 .cindex "mailstore format" "specifying"
22730 If this option is set with the &%directory%& option, the delivery is into two
22731 new files in  &"mailstore"& format. The option is available only if
22732 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22733 below for further details.
22734
22735
22736 .option mailstore_prefix appendfile string&!! unset
22737 This option applies only to deliveries in mailstore format, and is described in
22738 section &<<SECTopdir>>& below.
22739
22740
22741 .option mailstore_suffix appendfile string&!! unset
22742 This option applies only to deliveries in mailstore format, and is described in
22743 section &<<SECTopdir>>& below.
22744
22745
22746 .option mbx_format appendfile boolean false
22747 .cindex "locking files"
22748 .cindex "file" "locking"
22749 .cindex "file" "MBX format"
22750 .cindex "MBX format, specifying"
22751 This option is available only if Exim has been compiled with SUPPORT_MBX
22752 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22753 the message is appended to the mailbox file in MBX format instead of
22754 traditional Unix format. This format is supported by Pine4 and its associated
22755 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22756
22757 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22758 automatically changed by the use of &%mbx_format%&. They should normally be set
22759 empty when using MBX format, so this option almost always appears in this
22760 combination:
22761 .code
22762 mbx_format = true
22763 message_prefix =
22764 message_suffix =
22765 .endd
22766 If none of the locking options are mentioned in the configuration,
22767 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22768 is possible to specify the other kinds of locking with &%mbx_format%&, but
22769 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22770 interworks with &'c-client'&, providing for shared access to the mailbox. It
22771 should not be used if any program that does not use this form of locking is
22772 going to access the mailbox, nor should it be used if the mailbox file is NFS
22773 mounted, because it works only when the mailbox is accessed from a single host.
22774
22775 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22776 the standard version of &'c-client'&, because as long as it has a mailbox open
22777 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22778 append messages to it.
22779
22780
22781 .option message_prefix appendfile string&!! "see below"
22782 .cindex "&""From""& line"
22783 The string specified here is expanded and output at the start of every message.
22784 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22785 in which case it is:
22786 .code
22787 message_prefix = "From ${if def:return_path{$return_path}\
22788   {MAILER-DAEMON}} $tod_bsdinbox\n"
22789 .endd
22790 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22791 &`\n`& to &`\r\n`& in &%message_prefix%&.
22792
22793 .option message_suffix appendfile string&!! "see below"
22794 The string specified here is expanded and output at the end of every message.
22795 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22796 in which case it is a single newline character. The suffix can be suppressed by
22797 setting
22798 .code
22799 message_suffix =
22800 .endd
22801 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22802 &`\n`& to &`\r\n`& in &%message_suffix%&.
22803
22804 .option mode appendfile "octal integer" 0600
22805 If the output file is created, it is given this mode. If it already exists and
22806 has wider permissions, they are reduced to this mode. If it has narrower
22807 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22808 if the delivery is the result of a &%save%& command in a filter file specifying
22809 a particular mode, the mode of the output file is always forced to take that
22810 value, and this option is ignored.
22811
22812
22813 .option mode_fail_narrower appendfile boolean true
22814 This option applies in the case when an existing mailbox file has a narrower
22815 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22816 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22817 continues with the delivery attempt, using the existing mode of the file.
22818
22819
22820 .option notify_comsat appendfile boolean false
22821 If this option is true, the &'comsat'& daemon is notified after every
22822 successful delivery to a user mailbox. This is the daemon that notifies logged
22823 on users about incoming mail.
22824
22825
22826 .option quota appendfile string&!! unset
22827 .cindex "quota" "imposed by Exim"
22828 This option imposes a limit on the size of the file to which Exim is appending,
22829 or to the total space used in the directory tree when the &%directory%& option
22830 is set. In the latter case, computation of the space used is expensive, because
22831 all the files in the directory (and any sub-directories) have to be
22832 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22833 &%maildir_use_size_file%& for ways to avoid this in environments where users
22834 have no shell access to their mailboxes).
22835
22836 As there is no interlock against two simultaneous deliveries into a
22837 multi-file mailbox, it is possible for the quota to be overrun in this case.
22838 For single-file mailboxes, of course, an interlock is a necessity.
22839
22840 A file's size is taken as its &'used'& value. Because of blocking effects, this
22841 may be a lot less than the actual amount of disk space allocated to the file.
22842 If the sizes of a number of files are being added up, the rounding effect can
22843 become quite noticeable, especially on systems that have large block sizes.
22844 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22845 the obvious value which users understand most easily.
22846
22847 The value of the option is expanded, and must then be a numerical value
22848 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22849 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22850 and further option modifiers. If Exim is running on a system with
22851 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22852 be handled.
22853
22854 The option modifier &%no_check%& can be used to force delivery even if the over
22855 quota condition is met. The quota gets updated as usual.
22856
22857 &*Note*&: A value of zero is interpreted as &"no quota"&.
22858
22859 The expansion happens while Exim is running as root, before it changes uid for
22860 the delivery. This means that files that are inaccessible to the end user can
22861 be used to hold quota values that are looked up in the expansion. When delivery
22862 fails because this quota is exceeded, the handling of the error is as for
22863 system quota failures.
22864
22865 By default, Exim's quota checking mimics system quotas, and restricts the
22866 mailbox to the specified maximum size, though the value is not accurate to the
22867 last byte, owing to separator lines and additional headers that may get added
22868 during message delivery. When a mailbox is nearly full, large messages may get
22869 refused even though small ones are accepted, because the size of the current
22870 message is added to the quota when the check is made. This behaviour can be
22871 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22872 for exceeding the quota does not include the current message. Thus, deliveries
22873 continue until the quota has been exceeded; thereafter, no further messages are
22874 delivered. See also &%quota_warn_threshold%&.
22875
22876
22877 .option quota_directory appendfile string&!! unset
22878 This option defines the directory to check for quota purposes when delivering
22879 into individual files. The default is the delivery directory, or, if a file
22880 called &_maildirfolder_& exists in a maildir directory, the parent of the
22881 delivery directory.
22882
22883
22884 .option quota_filecount appendfile string&!! 0
22885 This option applies when the &%directory%& option is set. It limits the total
22886 number of files in the directory (compare the inode limit in system quotas). It
22887 can only be used if &%quota%& is also set. The value is expanded; an expansion
22888 failure causes delivery to be deferred. A value of zero is interpreted as
22889 &"no quota"&.
22890
22891 The option modifier &%no_check%& can be used to force delivery even if the over
22892 quota condition is met. The quota gets updated as usual.
22893
22894 .option quota_is_inclusive appendfile boolean true
22895 See &%quota%& above.
22896
22897
22898 .option quota_size_regex appendfile string unset
22899 This option applies when one of the delivery modes that writes a separate file
22900 for each message is being used. When Exim wants to find the size of one of
22901 these files in order to test the quota, it first checks &%quota_size_regex%&.
22902 If this is set to a regular expression that matches the filename, and it
22903 captures one string, that string is interpreted as a representation of the
22904 file's size. The value of &%quota_size_regex%& is not expanded.
22905
22906 This feature is useful only when users have no shell access to their mailboxes
22907 &-- otherwise they could defeat the quota simply by renaming the files. This
22908 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22909 the file length to the filename. For example:
22910 .code
22911 maildir_tag = ,S=$message_size
22912 quota_size_regex = ,S=(\d+)
22913 .endd
22914 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22915 number of lines in the message.
22916
22917 The regular expression should not assume that the length is at the end of the
22918 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22919 sometimes add other information onto the ends of message filenames.
22920
22921 Section &<<SECID136>>& contains further information.
22922
22923 .new
22924 This option should not be used when other message-handling software
22925 may duplicate messages by making hardlinks to the files.  When that is done Exim
22926 will count the message size once for each filename, in contrast with the actual
22927 disk usage.  When the option is not set, calculating total usage requires
22928 a system-call per file to get the size; the number of links is then available also
22929 as is used to adjust the effective size.
22930 .wen
22931
22932
22933 .option quota_warn_message appendfile string&!! "see below"
22934 See below for the use of this option. If it is not set when
22935 &%quota_warn_threshold%& is set, it defaults to
22936 .code
22937 quota_warn_message = "\
22938   To: $local_part@$domain\n\
22939   Subject: Your mailbox\n\n\
22940   This message is automatically created \
22941   by mail delivery software.\n\n\
22942   The size of your mailbox has exceeded \
22943   a warning threshold that is\n\
22944   set by the system administrator.\n"
22945 .endd
22946
22947
22948 .option quota_warn_threshold appendfile string&!! 0
22949 .cindex "quota" "warning threshold"
22950 .cindex "mailbox" "size warning"
22951 .cindex "size" "of mailbox"
22952 This option is expanded in the same way as &%quota%& (see above). If the
22953 resulting value is greater than zero, and delivery of the message causes the
22954 size of the file or total space in the directory tree to cross the given
22955 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22956 may be specified as a percentage of it by following the value with a percent
22957 sign. For example:
22958 .code
22959 quota = 10M
22960 quota_warn_threshold = 75%
22961 .endd
22962 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22963 percent sign is ignored.
22964
22965 The warning message itself is specified by the &%quota_warn_message%& option,
22966 and it must start with a &'To:'& header line containing the recipient(s) of the
22967 warning message. These do not necessarily have to include the recipient(s) of
22968 the original message. A &'Subject:'& line should also normally be supplied. You
22969 can include any other header lines that you want. If you do not include a
22970 &'From:'& line, the default is:
22971 .code
22972 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22973 .endd
22974 .oindex &%errors_reply_to%&
22975 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22976 option.
22977
22978 The &%quota%& option does not have to be set in order to use this option; they
22979 are independent of one another except when the threshold is specified as a
22980 percentage.
22981
22982
22983 .option use_bsmtp appendfile boolean false
22984 .cindex "envelope from"
22985 .cindex "envelope sender"
22986 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22987 format, with the envelope sender and recipient(s) included as SMTP commands. If
22988 you want to include a leading HELO command with such messages, you can do
22989 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22990 for details of batch SMTP.
22991
22992
22993 .option use_crlf appendfile boolean false
22994 .cindex "carriage return"
22995 .cindex "linefeed"
22996 This option causes lines to be terminated with the two-character CRLF sequence
22997 (carriage return, linefeed) instead of just a linefeed character. In the case
22998 of batched SMTP, the byte sequence written to the file is then an exact image
22999 of what would be sent down a real SMTP connection.
23000
23001 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23002 (which are used to supply the traditional &"From&~"& and blank line separators
23003 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23004 carriage return characters if these are needed. In cases where these options
23005 have non-empty defaults, the values end with a single linefeed, so they must be
23006 changed to end with &`\r\n`& if &%use_crlf%& is set.
23007
23008
23009 .option use_fcntl_lock appendfile boolean "see below"
23010 This option controls the use of the &[fcntl()]& function to lock a file for
23011 exclusive use when a message is being appended. It is set by default unless
23012 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23013 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23014 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23015
23016
23017 .option use_flock_lock appendfile boolean false
23018 This option is provided to support the use of &[flock()]& for file locking, for
23019 the few situations where it is needed. Most modern operating systems support
23020 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23021 each other. Exim uses &[fcntl()]& locking by default.
23022
23023 This option is required only if you are using an operating system where
23024 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23025 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23026 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23027
23028 .cindex "Solaris" "&[flock()]& support"
23029 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23030 have it (and some, I think, provide a not quite right version built on top of
23031 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23032 the ability to use it, and any attempt to do so will cause a configuration
23033 error.
23034
23035 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23036 is just being mapped onto &[fcntl()]& by the OS).
23037
23038
23039 .option use_lockfile appendfile boolean "see below"
23040 If this option is turned off, Exim does not attempt to create a lock file when
23041 appending to a mailbox file. In this situation, the only locking is by
23042 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23043 sure that every MUA that is ever going to look at your users' mailboxes uses
23044 &[fcntl()]& rather than a lock file, and even then only when you are not
23045 delivering over NFS from more than one host.
23046
23047 .cindex "NFS" "lock file"
23048 In order to append to an NFS file safely from more than one host, it is
23049 necessary to take out a lock &'before'& opening the file, and the lock file
23050 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23051 file corruption.
23052
23053 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23054 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23055 except when &%mbx_format%& is set.
23056
23057
23058 .option use_mbx_lock appendfile boolean "see below"
23059 This option is available only if Exim has been compiled with SUPPORT_MBX
23060 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23061 locking rules be used. It is set by default if &%mbx_format%& is set and none
23062 of the locking options are mentioned in the configuration. The locking rules
23063 are the same as are used by the &'c-client'& library that underlies Pine and
23064 the IMAP4 and POP daemons that come with it (see the discussion below). The
23065 rules allow for shared access to the mailbox. However, this kind of locking
23066 does not work when the mailbox is NFS mounted.
23067
23068 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23069 &%use_flock_lock%& to control what kind of locking is used in implementing the
23070 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23071 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23072
23073
23074
23075
23076 .section "Operational details for appending" "SECTopappend"
23077 .cindex "appending to a file"
23078 .cindex "file" "appending"
23079 Before appending to a file, the following preparations are made:
23080
23081 .ilist
23082 If the name of the file is &_/dev/null_&, no action is taken, and a success
23083 return is given.
23084
23085 .next
23086 .cindex "directory creation"
23087 If any directories on the file's path are missing, Exim creates them if the
23088 &%create_directory%& option is set. A created directory's mode is given by the
23089 &%directory_mode%& option.
23090
23091 .next
23092 If &%file_format%& is set, the format of an existing file is checked. If this
23093 indicates that a different transport should be used, control is passed to that
23094 transport.
23095
23096 .next
23097 .cindex "file" "locking"
23098 .cindex "locking files"
23099 .cindex "NFS" "lock file"
23100 If &%use_lockfile%& is set, a lock file is built in a way that will work
23101 reliably over NFS, as follows:
23102
23103 .olist
23104 Create a &"hitching post"& file whose name is that of the lock file with the
23105 current time, primary host name, and process id added, by opening for writing
23106 as a new file. If this fails with an access error, delivery is deferred.
23107 .next
23108 Close the hitching post file, and hard link it to the lock filename.
23109 .next
23110 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23111 Unlink the hitching post name.
23112 .next
23113 Otherwise, use &[stat()]& to get information about the hitching post file, and
23114 then unlink hitching post name. If the number of links is exactly two, creation
23115 of the lock file succeeded but something (for example, an NFS server crash and
23116 restart) caused this fact not to be communicated to the &[link()]& call.
23117 .next
23118 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23119 up to &%lock_retries%& times. However, since any program that writes to a
23120 mailbox should complete its task very quickly, it is reasonable to time out old
23121 lock files that are normally the result of user agent and system crashes. If an
23122 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23123 it before trying again.
23124 .endlist olist
23125
23126 .next
23127 A call is made to &[lstat()]& to discover whether the main file exists, and if
23128 so, what its characteristics are. If &[lstat()]& fails for any reason other
23129 than non-existence, delivery is deferred.
23130
23131 .next
23132 .cindex "symbolic link" "to mailbox"
23133 .cindex "mailbox" "symbolic link"
23134 If the file does exist and is a symbolic link, delivery is deferred, unless the
23135 &%allow_symlink%& option is set, in which case the ownership of the link is
23136 checked, and then &[stat()]& is called to find out about the real file, which
23137 is then subjected to the checks below. The check on the top-level link
23138 ownership prevents one user creating a link for another's mailbox in a sticky
23139 directory, though allowing symbolic links in this case is definitely not a good
23140 idea. If there is a chain of symbolic links, the intermediate ones are not
23141 checked.
23142
23143 .next
23144 If the file already exists but is not a regular file, or if the file's owner
23145 and group (if the group is being checked &-- see &%check_group%& above) are
23146 different from the user and group under which the delivery is running,
23147 delivery is deferred.
23148
23149 .next
23150 If the file's permissions are more generous than specified, they are reduced.
23151 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23152 is set false, in which case the delivery is tried using the existing
23153 permissions.
23154
23155 .next
23156 The file's inode number is saved, and the file is then opened for appending.
23157 If this fails because the file has vanished, &(appendfile)& behaves as if it
23158 hadn't existed (see below). For any other failures, delivery is deferred.
23159
23160 .next
23161 If the file is opened successfully, check that the inode number hasn't
23162 changed, that it is still a regular file, and that the owner and permissions
23163 have not changed. If anything is wrong, defer delivery and freeze the message.
23164
23165 .next
23166 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23167 option is set. Otherwise, check that the file is being created in a permitted
23168 directory if the &%create_file%& option is set (deferring on failure), and then
23169 open for writing as a new file, with the O_EXCL and O_CREAT options,
23170 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23171 set). In this case, which can happen if the link points to a non-existent file,
23172 the file is opened for writing using O_CREAT but not O_EXCL, because
23173 that prevents link following.
23174
23175 .next
23176 .cindex "loop" "while file testing"
23177 If opening fails because the file exists, obey the tests given above for
23178 existing files. However, to avoid looping in a situation where the file is
23179 being continuously created and destroyed, the exists/not-exists loop is broken
23180 after 10 repetitions, and the message is then frozen.
23181
23182 .next
23183 If opening fails with any other error, defer delivery.
23184
23185 .next
23186 .cindex "file" "locking"
23187 .cindex "locking files"
23188 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23189 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23190 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23191 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23192 file, and an exclusive lock on the file whose name is
23193 .code
23194 /tmp/.<device-number>.<inode-number>
23195 .endd
23196 using the device and inode numbers of the open mailbox file, in accordance with
23197 the MBX locking rules. This file is created with a mode that is specified by
23198 the &%lockfile_mode%& option.
23199
23200 If Exim fails to lock the file, there are two possible courses of action,
23201 depending on the value of the locking timeout. This is obtained from
23202 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23203
23204 If the timeout value is zero, the file is closed, Exim waits for
23205 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23206 to lock it again. This happens up to &%lock_retries%& times, after which the
23207 delivery is deferred.
23208
23209 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23210 &[flock()]& are used (with the given timeout), so there has already been some
23211 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23212 immediately. It retries up to
23213 .code
23214 (lock_retries * lock_interval) / <timeout>
23215 .endd
23216 times (rounded up).
23217 .endlist
23218
23219 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23220 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23221
23222
23223 .section "Operational details for delivery to a new file" "SECTopdir"
23224 .cindex "delivery" "to single file"
23225 .cindex "&""From""& line"
23226 When the &%directory%& option is set instead of &%file%&, each message is
23227 delivered into a newly-created file or set of files. When &(appendfile)& is
23228 activated directly from a &(redirect)& router, neither &%file%& nor
23229 &%directory%& is normally set, because the path for delivery is supplied by the
23230 router. (See for example, the &(address_file)& transport in the default
23231 configuration.) In this case, delivery is to a new file if either the path name
23232 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23233
23234 No locking is required while writing the message to a new file, so the various
23235 locking options of the transport are ignored. The &"From"& line that by default
23236 separates messages in a single file is not normally needed, nor is the escaping
23237 of message lines that start with &"From"&, and there is no need to ensure a
23238 newline at the end of each message. Consequently, the default values for
23239 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23240 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23241
23242 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23243 the files in the delivery directory by default. However, you can specify a
23244 different directory by setting &%quota_directory%&. Also, for maildir
23245 deliveries (see below) the &_maildirfolder_& convention is honoured.
23246
23247
23248 .cindex "maildir format"
23249 .cindex "mailstore format"
23250 There are three different ways in which delivery to individual files can be
23251 done, controlled by the settings of the &%maildir_format%& and
23252 &%mailstore_format%& options. Note that code to support maildir or mailstore
23253 formats is not included in the binary unless SUPPORT_MAILDIR or
23254 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23255
23256 .cindex "directory creation"
23257 In all three cases an attempt is made to create the directory and any necessary
23258 sub-directories if they do not exist, provided that the &%create_directory%&
23259 option is set (the default). The location of a created directory can be
23260 constrained by setting &%create_file%&. A created directory's mode is given by
23261 the &%directory_mode%& option. If creation fails, or if the
23262 &%create_directory%& option is not set when creation is required, delivery is
23263 deferred.
23264
23265
23266
23267 .section "Maildir delivery" "SECTmaildirdelivery"
23268 .cindex "maildir format" "description of"
23269 If the &%maildir_format%& option is true, Exim delivers each message by writing
23270 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23271 directory that is defined by the &%directory%& option (the &"delivery
23272 directory"&). If the delivery is successful, the file is renamed into the
23273 &_new_& subdirectory.
23274
23275 In the filename, <&'stime'&> is the current time of day in seconds, and
23276 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23277 Exim checks that the time-of-day clock has moved on by at least one microsecond
23278 before terminating the delivery process. This guarantees uniqueness for the
23279 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23280 opening it. If any response other than ENOENT (does not exist) is given,
23281 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23282
23283 Before Exim carries out a maildir delivery, it ensures that subdirectories
23284 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23285 do not exist, Exim tries to create them and any superior directories in their
23286 path, subject to the &%create_directory%& and &%create_file%& options. If the
23287 &%maildirfolder_create_regex%& option is set, and the regular expression it
23288 contains matches the delivery directory, Exim also ensures that a file called
23289 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23290 &_maildirfolder_& file cannot be created, delivery is deferred.
23291
23292 These features make it possible to use Exim to create all the necessary files
23293 and directories in a maildir mailbox, including subdirectories for maildir++
23294 folders. Consider this example:
23295 .code
23296 maildir_format = true
23297 directory = /var/mail/$local_part\
23298            ${if eq{$local_part_suffix}{}{}\
23299            {/.${substr_1:$local_part_suffix}}}
23300 maildirfolder_create_regex = /\.[^/]+$
23301 .endd
23302 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23303 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23304 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23305 not match this name, so Exim will not look for or create the file
23306 &_/var/mail/pimbo/maildirfolder_&, though it will create
23307 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23308
23309 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23310 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23311 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23312 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23313 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23314
23315 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23316 not inadvertently match the toplevel maildir directory, because a
23317 &_maildirfolder_& file at top level would completely break quota calculations.
23318
23319 .cindex "quota" "in maildir delivery"
23320 .cindex "maildir++"
23321 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23322 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23323 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23324 Exim assumes the directory is a maildir++ folder directory, which is one level
23325 down from the user's top level mailbox directory. This causes it to start at
23326 the parent directory instead of the current directory when calculating the
23327 amount of space used.
23328
23329 One problem with delivering into a multi-file mailbox is that it is
23330 computationally expensive to compute the size of the mailbox for quota
23331 checking. Various approaches have been taken to reduce the amount of work
23332 needed. The next two sections describe two of them. A third alternative is to
23333 use some external process for maintaining the size data, and use the expansion
23334 of the &%mailbox_size%& option as a way of importing it into Exim.
23335
23336
23337
23338
23339 .section "Using tags to record message sizes" "SECID135"
23340 If &%maildir_tag%& is set, the string is expanded for each delivery.
23341 When the maildir file is renamed into the &_new_& sub-directory, the
23342 tag is added to its name. However, if adding the tag takes the length of the
23343 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23344 the tag is dropped and the maildir file is created with no tag.
23345
23346
23347 .vindex "&$message_size$&"
23348 Tags can be used to encode the size of files in their names; see
23349 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23350 happens after the message has been written. The value of the &$message_size$&
23351 variable is set to the number of bytes actually written. If the expansion is
23352 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23353 be deferred. The expanded tag may contain any printing characters except &"/"&.
23354 Non-printing characters in the string are ignored; if the resulting string is
23355 empty, it is ignored. If it starts with an alphanumeric character, a leading
23356 colon is inserted; this default has not proven to be the path that popular
23357 maildir implementations have chosen (but changing it in Exim would break
23358 backwards compatibility).
23359
23360 For one common implementation, you might set:
23361 .code
23362 maildir_tag = ,S=${message_size}
23363 .endd
23364 but you should check the documentation of the other software to be sure.
23365
23366 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23367 as this allows Exim to extract the size from your tag, instead of having to
23368 &[stat()]& each message file.
23369
23370
23371 .section "Using a maildirsize file" "SECID136"
23372 .cindex "quota" "in maildir delivery"
23373 .cindex "maildir format" "&_maildirsize_& file"
23374 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23375 storing quota and message size information in a file called &_maildirsize_&
23376 within the toplevel maildir directory. If this file does not exist, Exim
23377 creates it, setting the quota from the &%quota%& option of the transport. If
23378 the maildir directory itself does not exist, it is created before any attempt
23379 to write a &_maildirsize_& file.
23380
23381 The &_maildirsize_& file is used to hold information about the sizes of
23382 messages in the maildir, thus speeding up quota calculations. The quota value
23383 in the file is just a cache; if the quota is changed in the transport, the new
23384 value overrides the cached value when the next message is delivered. The cache
23385 is maintained for the benefit of other programs that access the maildir and
23386 need to know the quota.
23387
23388 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23389 file is maintained (with a zero quota setting), but no quota is imposed.
23390
23391 A regular expression is available for controlling which directories in the
23392 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23393 See the description of the &%maildir_quota_directory_regex%& option above for
23394 details.
23395
23396
23397 .section "Mailstore delivery" "SECID137"
23398 .cindex "mailstore format" "description of"
23399 If the &%mailstore_format%& option is true, each message is written as two
23400 files in the given directory. A unique base name is constructed from the
23401 message id and the current delivery process, and the files that are written use
23402 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23403 contains the message's envelope, and the &_.msg_& file contains the message
23404 itself. The base name is placed in the variable &$mailstore_basename$&.
23405
23406 During delivery, the envelope is first written to a file with the suffix
23407 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23408 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23409 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23410 file before accessing either of them. An alternative approach is to wait for
23411 the absence of a &_.tmp_& file.
23412
23413 The envelope file starts with any text defined by the &%mailstore_prefix%&
23414 option, expanded and terminated by a newline if there isn't one. Then follows
23415 the sender address on one line, then all the recipient addresses, one per line.
23416 There can be more than one recipient only if the &%batch_max%& option is set
23417 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23418 appended to the file, followed by a newline if it does not end with one.
23419
23420 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23421 failure, it is ignored. Other expansion errors are treated as serious
23422 configuration errors, and delivery is deferred. The variable
23423 &$mailstore_basename$& is available for use during these expansions.
23424
23425
23426 .section "Non-special new file delivery" "SECID138"
23427 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23428 file is created directly in the named directory. For example, when delivering
23429 messages into files in batched SMTP format for later delivery to some host (see
23430 section &<<SECTbatchSMTP>>&), a setting such as
23431 .code
23432 directory = /var/bsmtp/$host
23433 .endd
23434 might be used. A message is written to a file with a temporary name, which is
23435 then renamed when the delivery is complete. The final name is obtained by
23436 expanding the contents of the &%directory_file%& option.
23437 .ecindex IIDapptra1
23438 .ecindex IIDapptra2
23439
23440
23441
23442
23443
23444
23445 . ////////////////////////////////////////////////////////////////////////////
23446 . ////////////////////////////////////////////////////////////////////////////
23447
23448 .chapter "The autoreply transport" "CHID8"
23449 .scindex IIDauttra1 "transports" "&(autoreply)&"
23450 .scindex IIDauttra2 "&(autoreply)& transport"
23451 The &(autoreply)& transport is not a true transport in that it does not cause
23452 the message to be transmitted. Instead, it generates a new mail message as an
23453 automatic reply to the incoming message. &'References:'& and
23454 &'Auto-Submitted:'& header lines are included. These are constructed according
23455 to the rules in RFCs 2822 and 3834, respectively.
23456
23457 If the router that passes the message to this transport does not have the
23458 &%unseen%& option set, the original message (for the current recipient) is not
23459 delivered anywhere. However, when the &%unseen%& option is set on the router
23460 that passes the message to this transport, routing of the address continues, so
23461 another router can set up a normal message delivery.
23462
23463
23464 The &(autoreply)& transport is usually run as the result of mail filtering, a
23465 &"vacation"& message being the standard example. However, it can also be run
23466 directly from a router like any other transport. To reduce the possibility of
23467 message cascades, messages created by the &(autoreply)& transport always have
23468 empty envelope sender addresses, like bounce messages.
23469
23470 The parameters of the message to be sent can be specified in the configuration
23471 by options described below. However, these are used only when the address
23472 passed to the transport does not contain its own reply information. When the
23473 transport is run as a consequence of a
23474 &%mail%&
23475 or &%vacation%& command in a filter file, the parameters of the message are
23476 supplied by the filter, and passed with the address. The transport's options
23477 that define the message are then ignored (so they are not usually set in this
23478 case). The message is specified entirely by the filter or by the transport; it
23479 is never built from a mixture of options. However, the &%file_optional%&,
23480 &%mode%&, and &%return_message%& options apply in all cases.
23481
23482 &(Autoreply)& is implemented as a local transport. When used as a result of a
23483 command in a user's filter file, &(autoreply)& normally runs under the uid and
23484 gid of the user, and with appropriate current and home directories (see chapter
23485 &<<CHAPenvironment>>&).
23486
23487 There is a subtle difference between routing a message to a &(pipe)& transport
23488 that generates some text to be returned to the sender, and routing it to an
23489 &(autoreply)& transport. This difference is noticeable only if more than one
23490 address from the same message is so handled. In the case of a pipe, the
23491 separate outputs from the different addresses are gathered up and returned to
23492 the sender in a single message, whereas if &(autoreply)& is used, a separate
23493 message is generated for each address that is passed to it.
23494
23495 Non-printing characters are not permitted in the header lines generated for the
23496 message that &(autoreply)& creates, with the exception of newlines that are
23497 immediately followed by white space. If any non-printing characters are found,
23498 the transport defers.
23499 Whether characters with the top bit set count as printing characters or not is
23500 controlled by the &%print_topbitchars%& global option.
23501
23502 If any of the generic options for manipulating headers (for example,
23503 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23504 of the original message that is included in the generated message when
23505 &%return_message%& is set. They do not apply to the generated message itself.
23506
23507 .vindex "&$sender_address$&"
23508 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23509 the message, indicating that there were no recipients, it does not treat this
23510 as an error. This means that autoreplies sent to &$sender_address$& when this
23511 is empty (because the incoming message is a bounce message) do not cause
23512 problems. They are just discarded.
23513
23514
23515
23516 .section "Private options for autoreply" "SECID139"
23517 .cindex "options" "&(autoreply)& transport"
23518
23519 .option bcc autoreply string&!! unset
23520 This specifies the addresses that are to receive &"blind carbon copies"& of the
23521 message when the message is specified by the transport.
23522
23523
23524 .option cc autoreply string&!! unset
23525 This specifies recipients of the message and the contents of the &'Cc:'& header
23526 when the message is specified by the transport.
23527
23528
23529 .option file autoreply string&!! unset
23530 The contents of the file are sent as the body of the message when the message
23531 is specified by the transport. If both &%file%& and &%text%& are set, the text
23532 string comes first.
23533
23534
23535 .option file_expand autoreply boolean false
23536 If this is set, the contents of the file named by the &%file%& option are
23537 subjected to string expansion as they are added to the message.
23538
23539
23540 .option file_optional autoreply boolean false
23541 If this option is true, no error is generated if the file named by the &%file%&
23542 option or passed with the address does not exist or cannot be read.
23543
23544
23545 .option from autoreply string&!! unset
23546 This specifies the contents of the &'From:'& header when the message is
23547 specified by the transport.
23548
23549
23550 .option headers autoreply string&!! unset
23551 This specifies additional RFC 2822 headers that are to be added to the message
23552 when the message is specified by the transport. Several can be given by using
23553 &"\n"& to separate them. There is no check on the format.
23554
23555
23556 .option log autoreply string&!! unset
23557 This option names a file in which a record of every message sent is logged when
23558 the message is specified by the transport.
23559
23560
23561 .option mode autoreply "octal integer" 0600
23562 If either the log file or the &"once"& file has to be created, this mode is
23563 used.
23564
23565
23566 .option never_mail autoreply "address list&!!" unset
23567 If any run of the transport creates a message with a recipient that matches any
23568 item in the list, that recipient is quietly discarded. If all recipients are
23569 discarded, no message is created. This applies both when the recipients are
23570 generated by a filter and when they are specified in the transport.
23571
23572
23573
23574 .option once autoreply string&!! unset
23575 This option names a file or DBM database in which a record of each &'To:'&
23576 recipient is kept when the message is specified by the transport. &*Note*&:
23577 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23578
23579 If &%once%& is unset, or is set to an empty string, the message is always sent.
23580 By default, if &%once%& is set to a non-empty filename, the message
23581 is not sent if a potential recipient is already listed in the database.
23582 However, if the &%once_repeat%& option specifies a time greater than zero, the
23583 message is sent if that much time has elapsed since a message was last sent to
23584 this recipient. A setting of zero time for &%once_repeat%& (the default)
23585 prevents a message from being sent a second time &-- in this case, zero means
23586 infinity.
23587
23588 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23589 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23590 greater than zero, it changes the way Exim implements the &%once%& option.
23591 Instead of using a DBM file to record every recipient it sends to, it uses a
23592 regular file, whose size will never get larger than the given value.
23593
23594 In the file, Exim keeps a linear list of recipient addresses and the times at
23595 which they were sent messages. If the file is full when a new address needs to
23596 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23597 means that a given recipient may receive multiple messages, but at
23598 unpredictable intervals that depend on the rate of turnover of addresses in the
23599 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23600
23601
23602 .option once_file_size autoreply integer 0
23603 See &%once%& above.
23604
23605
23606 .option once_repeat autoreply time&!! 0s
23607 See &%once%& above.
23608 After expansion, the value of this option must be a valid time value.
23609
23610
23611 .option reply_to autoreply string&!! unset
23612 This specifies the contents of the &'Reply-To:'& header when the message is
23613 specified by the transport.
23614
23615
23616 .option return_message autoreply boolean false
23617 If this is set, a copy of the original message is returned with the new
23618 message, subject to the maximum size set in the &%return_size_limit%& global
23619 configuration option.
23620
23621
23622 .option subject autoreply string&!! unset
23623 This specifies the contents of the &'Subject:'& header when the message is
23624 specified by the transport. It is tempting to quote the original subject in
23625 automatic responses. For example:
23626 .code
23627 subject = Re: $h_subject:
23628 .endd
23629 There is a danger in doing this, however. It may allow a third party to
23630 subscribe your users to an opt-in mailing list, provided that the list accepts
23631 bounce messages as subscription confirmations. Well-managed lists require a
23632 non-bounce message to confirm a subscription, so the danger is relatively
23633 small.
23634
23635
23636
23637 .option text autoreply string&!! unset
23638 This specifies a single string to be used as the body of the message when the
23639 message is specified by the transport. If both &%text%& and &%file%& are set,
23640 the text comes first.
23641
23642
23643 .option to autoreply string&!! unset
23644 This specifies recipients of the message and the contents of the &'To:'& header
23645 when the message is specified by the transport.
23646 .ecindex IIDauttra1
23647 .ecindex IIDauttra2
23648
23649
23650
23651
23652 . ////////////////////////////////////////////////////////////////////////////
23653 . ////////////////////////////////////////////////////////////////////////////
23654
23655 .chapter "The lmtp transport" "CHAPLMTP"
23656 .cindex "transports" "&(lmtp)&"
23657 .cindex "&(lmtp)& transport"
23658 .cindex "LMTP" "over a pipe"
23659 .cindex "LMTP" "over a socket"
23660 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23661 specified command
23662 or by interacting with a Unix domain socket.
23663 This transport is something of a cross between the &(pipe)& and &(smtp)&
23664 transports. Exim also has support for using LMTP over TCP/IP; this is
23665 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23666 to be of minority interest, the default build-time configure in &_src/EDITME_&
23667 has it commented out. You need to ensure that
23668 .code
23669 TRANSPORT_LMTP=yes
23670 .endd
23671 .cindex "options" "&(lmtp)& transport"
23672 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23673 included in the Exim binary. The private options of the &(lmtp)& transport are
23674 as follows:
23675
23676 .option batch_id lmtp string&!! unset
23677 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23678
23679
23680 .option batch_max lmtp integer 1
23681 This limits the number of addresses that can be handled in a single delivery.
23682 Most LMTP servers can handle several addresses at once, so it is normally a
23683 good idea to increase this value. See the description of local delivery
23684 batching in chapter &<<CHAPbatching>>&.
23685
23686
23687 .option command lmtp string&!! unset
23688 This option must be set if &%socket%& is not set. The string is a command which
23689 is run in a separate process. It is split up into a command name and list of
23690 arguments, each of which is separately expanded (so expansion cannot change the
23691 number of arguments). The command is run directly, not via a shell. The message
23692 is passed to the new process using the standard input and output to operate the
23693 LMTP protocol.
23694
23695 .option ignore_quota lmtp boolean false
23696 .cindex "LMTP" "ignoring quota errors"
23697 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23698 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23699 in its response to the LHLO command.
23700
23701 .option socket lmtp string&!! unset
23702 This option must be set if &%command%& is not set. The result of expansion must
23703 be the name of a Unix domain socket. The transport connects to the socket and
23704 delivers the message to it using the LMTP protocol.
23705
23706
23707 .option timeout lmtp time 5m
23708 The transport is aborted if the created process or Unix domain socket does not
23709 respond to LMTP commands or message input within this timeout. Delivery
23710 is deferred, and will be tried again later. Here is an example of a typical
23711 LMTP transport:
23712 .code
23713 lmtp:
23714   driver = lmtp
23715   command = /some/local/lmtp/delivery/program
23716   batch_max = 20
23717   user = exim
23718 .endd
23719 This delivers up to 20 addresses at a time, in a mixture of domains if
23720 necessary, running as the user &'exim'&.
23721
23722
23723
23724 . ////////////////////////////////////////////////////////////////////////////
23725 . ////////////////////////////////////////////////////////////////////////////
23726
23727 .chapter "The pipe transport" "CHAPpipetransport"
23728 .scindex IIDpiptra1 "transports" "&(pipe)&"
23729 .scindex IIDpiptra2 "&(pipe)& transport"
23730 The &(pipe)& transport is used to deliver messages via a pipe to a command
23731 running in another process. One example is the use of &(pipe)& as a
23732 pseudo-remote transport for passing messages to some other delivery mechanism
23733 (such as UUCP). Another is the use by individual users to automatically process
23734 their incoming messages. The &(pipe)& transport can be used in one of the
23735 following ways:
23736
23737 .ilist
23738 .vindex "&$local_part$&"
23739 A router routes one address to a transport in the normal way, and the
23740 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23741 contains the local part of the address (as usual), and the command that is run
23742 is specified by the &%command%& option on the transport.
23743 .next
23744 .vindex "&$pipe_addresses$&"
23745 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23746 transport can handle more than one address in a single run. In this case, when
23747 more than one address is routed to the transport, &$local_part$& is not set
23748 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23749 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23750 that are routed to the transport.
23751 .next
23752 .vindex "&$address_pipe$&"
23753 A router redirects an address directly to a pipe command (for example, from an
23754 alias or forward file). In this case, &$address_pipe$& contains the text of the
23755 pipe command, and the &%command%& option on the transport is ignored unless
23756 &%force_command%& is set. If only one address is being transported
23757 (&%batch_max%& is not greater than one, or only one address was redirected to
23758 this pipe command), &$local_part$& contains the local part that was redirected.
23759 .endlist
23760
23761
23762 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23763 deliver messages over pipes using the LMTP interactive protocol. This is
23764 implemented by the &(lmtp)& transport.
23765
23766 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23767 &_.forward_& file, the command runs under the uid and gid of that user. In
23768 other cases, the uid and gid have to be specified explicitly, either on the
23769 transport or on the router that handles the address. Current and &"home"&
23770 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23771 details of the local delivery environment and chapter &<<CHAPbatching>>&
23772 for a discussion of local delivery batching.
23773
23774
23775 .section "Concurrent delivery" "SECID140"
23776 If two messages arrive at almost the same time, and both are routed to a pipe
23777 delivery, the two pipe transports may be run concurrently. You must ensure that
23778 any pipe commands you set up are robust against this happening. If the commands
23779 write to a file, the &%exim_lock%& utility might be of use.
23780 Alternatively the &%max_parallel%& option could be used with a value
23781 of "1" to enforce serialization.
23782
23783
23784
23785
23786 .section "Returned status and data" "SECID141"
23787 .cindex "&(pipe)& transport" "returned data"
23788 If the command exits with a non-zero return code, the delivery is deemed to
23789 have failed, unless either the &%ignore_status%& option is set (in which case
23790 the return code is treated as zero), or the return code is one of those listed
23791 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23792 later"&. In this case, delivery is deferred. Details of a permanent failure are
23793 logged, but are not included in the bounce message, which merely contains
23794 &"local delivery failed"&.
23795
23796 If the command exits on a signal and the &%freeze_signal%& option is set then
23797 the message will be frozen in the queue. If that option is not set, a bounce
23798 will be sent as normal.
23799
23800 If the return code is greater than 128 and the command being run is a shell
23801 script, it normally means that the script was terminated by a signal whose
23802 value is the return code minus 128. The &%freeze_signal%& option does not
23803 apply in this case.
23804
23805 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23806 return code is set to 127. This is the value that a shell returns if it is
23807 asked to run a non-existent command. The wording for the log line suggests that
23808 a non-existent command may be the problem.
23809
23810 The &%return_output%& option can affect the result of a pipe delivery. If it is
23811 set and the command produces any output on its standard output or standard
23812 error streams, the command is considered to have failed, even if it gave a zero
23813 return code or if &%ignore_status%& is set. The output from the command is
23814 included as part of the bounce message. The &%return_fail_output%& option is
23815 similar, except that output is returned only when the command exits with a
23816 failure return code, that is, a value other than zero or a code that matches
23817 &%temp_errors%&.
23818
23819
23820
23821 .section "How the command is run" "SECThowcommandrun"
23822 .cindex "&(pipe)& transport" "path for command"
23823 The command line is (by default) broken down into a command name and arguments
23824 by the &(pipe)& transport itself. The &%allow_commands%& and
23825 &%restrict_to_path%& options can be used to restrict the commands that may be
23826 run.
23827
23828 .cindex "quoting" "in pipe command"
23829 Unquoted arguments are delimited by white space. If an argument appears in
23830 double quotes, backslash is interpreted as an escape character in the usual
23831 way. If an argument appears in single quotes, no escaping is done.
23832
23833 String expansion is applied to the command line except when it comes from a
23834 traditional &_.forward_& file (commands from a filter file are expanded). The
23835 expansion is applied to each argument in turn rather than to the whole line.
23836 For this reason, any string expansion item that contains white space must be
23837 quoted so as to be contained within a single argument. A setting such as
23838 .code
23839 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23840 .endd
23841 will not work, because the expansion item gets split between several
23842 arguments. You have to write
23843 .code
23844 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23845 .endd
23846 to ensure that it is all in one argument. The expansion is done in this way,
23847 argument by argument, so that the number of arguments cannot be changed as a
23848 result of expansion, and quotes or backslashes in inserted variables do not
23849 interact with external quoting. However, this leads to problems if you want to
23850 generate multiple arguments (or the command name plus arguments) from a single
23851 expansion. In this situation, the simplest solution is to use a shell. For
23852 example:
23853 .code
23854 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23855 .endd
23856
23857 .cindex "transport" "filter"
23858 .cindex "filter" "transport filter"
23859 .vindex "&$pipe_addresses$&"
23860 Special handling takes place when an argument consists of precisely the text
23861 &`$pipe_addresses`& (no quotes).
23862 This is not a general expansion variable; the only
23863 place this string is recognized is when it appears as an argument for a pipe or
23864 transport filter command. It causes each address that is being handled to be
23865 inserted in the argument list at that point &'as a separate argument'&. This
23866 avoids any problems with spaces or shell metacharacters, and is of use when a
23867 &(pipe)& transport is handling groups of addresses in a batch.
23868
23869 If &%force_command%& is enabled on the transport, special handling takes place
23870 for an argument that consists of precisely the text &`$address_pipe`&.  It
23871 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23872 argument is inserted in the argument list at that point
23873 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23874 the only item in the argument; in fact, if it were then &%force_command%&
23875 should behave as a no-op.  Rather, it should be used to adjust the command
23876 run while preserving the argument vector separation.
23877
23878 After splitting up into arguments and expansion, the resulting command is run
23879 in a subprocess directly from the transport, &'not'& under a shell. The
23880 message that is being delivered is supplied on the standard input, and the
23881 standard output and standard error are both connected to a single pipe that is
23882 read by Exim. The &%max_output%& option controls how much output the command
23883 may produce, and the &%return_output%& and &%return_fail_output%& options
23884 control what is done with it.
23885
23886 Not running the command under a shell (by default) lessens the security risks
23887 in cases when a command from a user's filter file is built out of data that was
23888 taken from an incoming message. If a shell is required, it can of course be
23889 explicitly specified as the command to be run. However, there are circumstances
23890 where existing commands (for example, in &_.forward_& files) expect to be run
23891 under a shell and cannot easily be modified. To allow for these cases, there is
23892 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23893 works. Instead of breaking up the command line as just described, it expands it
23894 as a single string and passes the result to &_/bin/sh_&. The
23895 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23896 with &%use_shell%&, and the whole mechanism is inherently less secure.
23897
23898
23899
23900 .section "Environment variables" "SECTpipeenv"
23901 .cindex "&(pipe)& transport" "environment for command"
23902 .cindex "environment" "&(pipe)& transport"
23903 The environment variables listed below are set up when the command is invoked.
23904 This list is a compromise for maximum compatibility with other MTAs. Note that
23905 the &%environment%& option can be used to add additional variables to this
23906 environment. The environment for the &(pipe)& transport is not subject
23907 to the &%add_environment%& and &%keep_environment%& main config options.
23908 .display
23909 &`DOMAIN            `&   the domain of the address
23910 &`HOME              `&   the home directory, if set
23911 &`HOST              `&   the host name when called from a router (see below)
23912 &`LOCAL_PART        `&   see below
23913 &`LOCAL_PART_PREFIX `&   see below
23914 &`LOCAL_PART_SUFFIX `&   see below
23915 &`LOGNAME           `&   see below
23916 &`MESSAGE_ID        `&   Exim's local ID for the message
23917 &`PATH              `&   as specified by the &%path%& option below
23918 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23919 &`RECIPIENT         `&   the complete recipient address
23920 &`SENDER            `&   the sender of the message (empty if a bounce)
23921 &`SHELL             `&   &`/bin/sh`&
23922 &`TZ                `&   the value of the &%timezone%& option, if set
23923 &`USER              `&   see below
23924 .endd
23925 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23926 router, LOCAL_PART is set to the local part of the address. When it is
23927 called as a result of a forward or alias expansion, LOCAL_PART is set to
23928 the local part of the address that was expanded. In both cases, any affixes are
23929 removed from the local part, and made available in LOCAL_PART_PREFIX and
23930 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23931 same value as LOCAL_PART for compatibility with other MTAs.
23932
23933 .cindex "HOST"
23934 HOST is set only when a &(pipe)& transport is called from a router that
23935 associates hosts with an address, typically when using &(pipe)& as a
23936 pseudo-remote transport. HOST is set to the first host name specified by
23937 the router.
23938
23939 .cindex "HOME"
23940 If the transport's generic &%home_directory%& option is set, its value is used
23941 for the HOME environment variable. Otherwise, a home directory may be set
23942 by the router's &%transport_home_directory%& option, which defaults to the
23943 user's home directory if &%check_local_user%& is set.
23944
23945
23946 .section "Private options for pipe" "SECID142"
23947 .cindex "options" "&(pipe)& transport"
23948
23949
23950
23951 .option allow_commands pipe "string list&!!" unset
23952 .cindex "&(pipe)& transport" "permitted commands"
23953 The string is expanded, and is then interpreted as a colon-separated list of
23954 permitted commands. If &%restrict_to_path%& is not set, the only commands
23955 permitted are those in the &%allow_commands%& list. They need not be absolute
23956 paths; the &%path%& option is still used for relative paths. If
23957 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23958 in the &%allow_commands%& list, or a name without any slashes that is found on
23959 the path. In other words, if neither &%allow_commands%& nor
23960 &%restrict_to_path%& is set, there is no restriction on the command, but
23961 otherwise only commands that are permitted by one or the other are allowed. For
23962 example, if
23963 .code
23964 allow_commands = /usr/bin/vacation
23965 .endd
23966 and &%restrict_to_path%& is not set, the only permitted command is
23967 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23968 &%use_shell%& is set.
23969
23970
23971 .option batch_id pipe string&!! unset
23972 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23973
23974
23975 .option batch_max pipe integer 1
23976 This limits the number of addresses that can be handled in a single delivery.
23977 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23978
23979
23980 .option check_string pipe string unset
23981 As &(pipe)& writes the message, the start of each line is tested for matching
23982 &%check_string%&, and if it does, the initial matching characters are replaced
23983 by the contents of &%escape_string%&, provided both are set. The value of
23984 &%check_string%& is a literal string, not a regular expression, and the case of
23985 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23986 of &%check_string%& and &%escape_string%& are forced to values that implement
23987 the SMTP escaping protocol. Any settings made in the configuration file are
23988 ignored.
23989
23990
23991 .option command pipe string&!! unset
23992 This option need not be set when &(pipe)& is being used to deliver to pipes
23993 obtained directly from address redirections. In other cases, the option must be
23994 set, to provide a command to be run. It need not yield an absolute path (see
23995 the &%path%& option below). The command is split up into separate arguments by
23996 Exim, and each argument is separately expanded, as described in section
23997 &<<SECThowcommandrun>>& above.
23998
23999
24000 .option environment pipe string&!! unset
24001 .cindex "&(pipe)& transport" "environment for command"
24002 .cindex "environment" "&(pipe)& transport"
24003 This option is used to add additional variables to the environment in which the
24004 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24005 a string which is expanded, and then interpreted as a colon-separated list of
24006 environment settings of the form <&'name'&>=<&'value'&>.
24007
24008
24009 .option escape_string pipe string unset
24010 See &%check_string%& above.
24011
24012
24013 .option freeze_exec_fail pipe boolean false
24014 .cindex "exec failure"
24015 .cindex "failure of exec"
24016 .cindex "&(pipe)& transport" "failure of exec"
24017 Failure to exec the command in a pipe transport is by default treated like
24018 any other failure while running the command. However, if &%freeze_exec_fail%&
24019 is set, failure to exec is treated specially, and causes the message to be
24020 frozen, whatever the setting of &%ignore_status%&.
24021
24022
24023 .option freeze_signal pipe boolean false
24024 .cindex "signal exit"
24025 .cindex "&(pipe)& transport", "signal exit"
24026 Normally if the process run by a command in a pipe transport exits on a signal,
24027 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24028 frozen in Exim's queue instead.
24029
24030
24031 .option force_command pipe boolean false
24032 .cindex "force command"
24033 .cindex "&(pipe)& transport", "force command"
24034 Normally when a router redirects an address directly to a pipe command
24035 the &%command%& option on the transport is ignored.  If &%force_command%&
24036 is set, the &%command%& option will used. This is especially
24037 useful for forcing a wrapper or additional argument to be added to the
24038 command. For example:
24039 .code
24040 command = /usr/bin/remote_exec myhost -- $address_pipe
24041 force_command
24042 .endd
24043
24044 Note that &$address_pipe$& is handled specially in &%command%& when
24045 &%force_command%& is set, expanding out to the original argument vector as
24046 separate items, similarly to a Unix shell &`"$@"`& construct.
24047
24048
24049 .option ignore_status pipe boolean false
24050 If this option is true, the status returned by the subprocess that is set up to
24051 run the command is ignored, and Exim behaves as if zero had been returned.
24052 Otherwise, a non-zero status or termination by signal causes an error return
24053 from the transport unless the status value is one of those listed in
24054 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24055
24056 &*Note*&: This option does not apply to timeouts, which do not return a status.
24057 See the &%timeout_defer%& option for how timeouts are handled.
24058
24059
24060 .option log_defer_output pipe boolean false
24061 .cindex "&(pipe)& transport" "logging output"
24062 If this option is set, and the status returned by the command is
24063 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24064 and any output was produced on stdout or stderr, the first line of it is
24065 written to the main log.
24066
24067
24068 .option log_fail_output pipe boolean false
24069 If this option is set, and the command returns any output on stdout or
24070 stderr, and also ends with a return code that is neither zero nor one of
24071 the return codes listed in &%temp_errors%& (that is, the delivery
24072 failed), the first line of output is written to the main log. This
24073 option and &%log_output%& are mutually exclusive.  Only one of them may
24074 be set.
24075
24076
24077 .option log_output pipe boolean false
24078 If this option is set and the command returns any output on stdout or
24079 stderr, the first line of output is written to the main log, whatever
24080 the return code. This option and &%log_fail_output%& are mutually
24081 exclusive. Only one of them may be set.
24082
24083
24084 .option max_output pipe integer 20K
24085 This specifies the maximum amount of output that the command may produce on its
24086 standard output and standard error file combined. If the limit is exceeded, the
24087 process running the command is killed. This is intended as a safety measure to
24088 catch runaway processes. The limit is applied independently of the settings of
24089 the options that control what is done with such output (for example,
24090 &%return_output%&). Because of buffering effects, the amount of output may
24091 exceed the limit by a small amount before Exim notices.
24092
24093
24094 .option message_prefix pipe string&!! "see below"
24095 The string specified here is expanded and output at the start of every message.
24096 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24097 .code
24098 message_prefix = \
24099   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24100   ${tod_bsdinbox}\n
24101 .endd
24102 .cindex "Cyrus"
24103 .cindex "&%tmail%&"
24104 .cindex "&""From""& line"
24105 This is required by the commonly used &_/usr/bin/vacation_& program.
24106 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24107 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24108 setting
24109 .code
24110 message_prefix =
24111 .endd
24112 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24113 &`\n`& to &`\r\n`& in &%message_prefix%&.
24114
24115
24116 .option message_suffix pipe string&!! "see below"
24117 The string specified here is expanded and output at the end of every message.
24118 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24119 The suffix can be suppressed by setting
24120 .code
24121 message_suffix =
24122 .endd
24123 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24124 &`\n`& to &`\r\n`& in &%message_suffix%&.
24125
24126
24127 .option path pipe string&!! "/bin:/usr/bin"
24128 This option is expanded and
24129 specifies the string that is set up in the PATH environment
24130 variable of the subprocess.
24131 If the &%command%& option does not yield an absolute path name, the command is
24132 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24133 apply to a command specified as a transport filter.
24134
24135
24136 .option permit_coredump pipe boolean false
24137 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24138 a core-dump of a pipe command, enable this command.  This enables core-dumps
24139 during delivery and affects both the Exim binary and the pipe command run.
24140 It is recommended that this option remain off unless and until you have a need
24141 for it and that this only be enabled when needed, as the risk of excessive
24142 resource consumption can be quite high.  Note also that Exim is typically
24143 installed as a setuid binary and most operating systems will inhibit coredumps
24144 of these by default, so further OS-specific action may be required.
24145
24146
24147 .option pipe_as_creator pipe boolean false
24148 .cindex "uid (user id)" "local delivery"
24149 If the generic &%user%& option is not set and this option is true, the delivery
24150 process is run under the uid that was in force when Exim was originally called
24151 to accept the message. If the group id is not otherwise set (via the generic
24152 &%group%& option), the gid that was in force when Exim was originally called to
24153 accept the message is used.
24154
24155
24156 .option restrict_to_path pipe boolean false
24157 When this option is set, any command name not listed in &%allow_commands%& must
24158 contain no slashes. The command is searched for only in the directories listed
24159 in the &%path%& option. This option is intended for use in the case when a pipe
24160 command has been generated from a user's &_.forward_& file. This is usually
24161 handled by a &(pipe)& transport called &%address_pipe%&.
24162
24163
24164 .option return_fail_output pipe boolean false
24165 If this option is true, and the command produced any output and ended with a
24166 return code other than zero or one of the codes listed in &%temp_errors%& (that
24167 is, the delivery failed), the output is returned in the bounce message.
24168 However, if the message has a null sender (that is, it is itself a bounce
24169 message), output from the command is discarded. This option and
24170 &%return_output%& are mutually exclusive. Only one of them may be set.
24171
24172
24173
24174 .option return_output pipe boolean false
24175 If this option is true, and the command produced any output, the delivery is
24176 deemed to have failed whatever the return code from the command, and the output
24177 is returned in the bounce message. Otherwise, the output is just discarded.
24178 However, if the message has a null sender (that is, it is a bounce message),
24179 output from the command is always discarded, whatever the setting of this
24180 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24181 of them may be set.
24182
24183
24184
24185 .option temp_errors pipe "string list" "see below"
24186 .cindex "&(pipe)& transport" "temporary failure"
24187 This option contains either a colon-separated list of numbers, or a single
24188 asterisk. If &%ignore_status%& is false
24189 and &%return_output%& is not set,
24190 and the command exits with a non-zero return code, the failure is treated as
24191 temporary and the delivery is deferred if the return code matches one of the
24192 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24193 codes are treated as permanent errors. The default setting contains the codes
24194 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24195 compiled on a system that does not define these macros, it assumes values of 75
24196 and 73, respectively.
24197
24198
24199 .option timeout pipe time 1h
24200 If the command fails to complete within this time, it is killed. This normally
24201 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24202 specifies no timeout. In order to ensure that any subprocesses created by the
24203 command are also killed, Exim makes the initial process a process group leader,
24204 and kills the whole process group on a timeout. However, this can be defeated
24205 if one of the processes starts a new process group.
24206
24207 .option timeout_defer pipe boolean false
24208 A timeout in a &(pipe)& transport, either in the command that the transport
24209 runs, or in a transport filter that is associated with it, is by default
24210 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24211 is set true, both kinds of timeout become temporary errors, causing the
24212 delivery to be deferred.
24213
24214 .option umask pipe "octal integer" 022
24215 This specifies the umask setting for the subprocess that runs the command.
24216
24217
24218 .option use_bsmtp pipe boolean false
24219 .cindex "envelope sender"
24220 If this option is set true, the &(pipe)& transport writes messages in &"batch
24221 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24222 commands. If you want to include a leading HELO command with such messages,
24223 you can do so by setting the &%message_prefix%& option. See section
24224 &<<SECTbatchSMTP>>& for details of batch SMTP.
24225
24226 .option use_classresources pipe boolean false
24227 .cindex "class resources (BSD)"
24228 This option is available only when Exim is running on FreeBSD, NetBSD, or
24229 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24230 resource limits when a &(pipe)& transport is run to perform a delivery. The
24231 limits for the uid under which the pipe is to run are obtained from the login
24232 class database.
24233
24234
24235 .option use_crlf pipe boolean false
24236 .cindex "carriage return"
24237 .cindex "linefeed"
24238 This option causes lines to be terminated with the two-character CRLF sequence
24239 (carriage return, linefeed) instead of just a linefeed character. In the case
24240 of batched SMTP, the byte sequence written to the pipe is then an exact image
24241 of what would be sent down a real SMTP connection.
24242
24243 The contents of the &%message_prefix%& and &%message_suffix%& options are
24244 written verbatim, so must contain their own carriage return characters if these
24245 are needed. When &%use_bsmtp%& is not set, the default values for both
24246 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24247 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24248
24249
24250 .option use_shell pipe boolean false
24251 .vindex "&$pipe_addresses$&"
24252 If this option is set, it causes the command to be passed to &_/bin/sh_&
24253 instead of being run directly from the transport, as described in section
24254 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24255 where the command is expected to be run under a shell and cannot easily be
24256 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24257 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24258 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24259 its &%-c%& option.
24260
24261
24262
24263 .section "Using an external local delivery agent" "SECID143"
24264 .cindex "local delivery" "using an external agent"
24265 .cindex "&'procmail'&"
24266 .cindex "external local delivery"
24267 .cindex "delivery" "&'procmail'&"
24268 .cindex "delivery" "by external agent"
24269 The &(pipe)& transport can be used to pass all messages that require local
24270 delivery to a separate local delivery agent such as &%procmail%&. When doing
24271 this, care must be taken to ensure that the pipe is run under an appropriate
24272 uid and gid. In some configurations one wants this to be a uid that is trusted
24273 by the delivery agent to supply the correct sender of the message. It may be
24274 necessary to recompile or reconfigure the delivery agent so that it trusts an
24275 appropriate user. The following is an example transport and router
24276 configuration for &%procmail%&:
24277 .code
24278 # transport
24279 procmail_pipe:
24280   driver = pipe
24281   command = /usr/local/bin/procmail -d $local_part
24282   return_path_add
24283   delivery_date_add
24284   envelope_to_add
24285   check_string = "From "
24286   escape_string = ">From "
24287   umask = 077
24288   user = $local_part
24289   group = mail
24290
24291 # router
24292 procmail:
24293   driver = accept
24294   check_local_user
24295   transport = procmail_pipe
24296 .endd
24297 In this example, the pipe is run as the local user, but with the group set to
24298 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24299 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24300 user to supply a correct sender address. If you do not specify either a
24301 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24302 home directory is the user's home directory by default.
24303
24304 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24305 .code
24306 IFS=" "
24307 .endd
24308 as shown in some &%procmail%& documentation, because Exim does not by default
24309 use a shell to run pipe commands.
24310
24311 .cindex "Cyrus"
24312 The next example shows a transport and a router for a system where local
24313 deliveries are handled by the Cyrus IMAP server.
24314 .code
24315 # transport
24316 local_delivery_cyrus:
24317   driver = pipe
24318   command = /usr/cyrus/bin/deliver \
24319             -m ${substr_1:$local_part_suffix} -- $local_part
24320   user = cyrus
24321   group = mail
24322   return_output
24323   log_output
24324   message_prefix =
24325   message_suffix =
24326
24327 # router
24328 local_user_cyrus:
24329   driver = accept
24330   check_local_user
24331   local_part_suffix = .*
24332   transport = local_delivery_cyrus
24333 .endd
24334 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24335 &%return_output%& to cause any text written by Cyrus to be returned to the
24336 sender.
24337 .ecindex IIDpiptra1
24338 .ecindex IIDpiptra2
24339
24340
24341 . ////////////////////////////////////////////////////////////////////////////
24342 . ////////////////////////////////////////////////////////////////////////////
24343
24344 .chapter "The smtp transport" "CHAPsmtptrans"
24345 .scindex IIDsmttra1 "transports" "&(smtp)&"
24346 .scindex IIDsmttra2 "&(smtp)& transport"
24347 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24348 or LMTP protocol. The list of hosts to try can either be taken from the address
24349 that is being processed (having been set up by the router), or specified
24350 explicitly for the transport. Timeout and retry processing (see chapter
24351 &<<CHAPretry>>&) is applied to each IP address independently.
24352
24353
24354 .section "Multiple messages on a single connection" "SECID144"
24355 The sending of multiple messages over a single TCP/IP connection can arise in
24356 two ways:
24357
24358 .ilist
24359 If a message contains more than &%max_rcpt%& (see below) addresses that are
24360 routed to the same host, more than one copy of the message has to be sent to
24361 that host. In this situation, multiple copies may be sent in a single run of
24362 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24363 does when it has too many addresses to send in one message also depends on the
24364 value of the global &%remote_max_parallel%& option. Details are given in
24365 section &<<SECToutSMTPTCP>>&.)
24366 .next
24367 .cindex "hints database" "remembering routing"
24368 When a message has been successfully delivered over a TCP/IP connection, Exim
24369 looks in its hints database to see if there are any other messages awaiting a
24370 connection to the same host. If there are, a new delivery process is started
24371 for one of them, and the current TCP/IP connection is passed on to it. The new
24372 process may in turn send multiple copies and possibly create yet another
24373 process.
24374 .endlist
24375
24376
24377 For each copy sent over the same TCP/IP connection, a sequence counter is
24378 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24379 no further messages are sent over that connection.
24380
24381
24382
24383 .section "Use of the $host and $host_address variables" "SECID145"
24384 .vindex "&$host$&"
24385 .vindex "&$host_address$&"
24386 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24387 &$host_address$& are the name and IP address of the first host on the host list
24388 passed by the router. However, when the transport is about to connect to a
24389 specific host, and while it is connected to that host, &$host$& and
24390 &$host_address$& are set to the values for that host. These are the values
24391 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24392 &%serialize_hosts%&, and the various TLS options are expanded.
24393
24394
24395 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24396 .vindex &$tls_bits$&
24397 .vindex &$tls_cipher$&
24398 .vindex &$tls_peerdn$&
24399 .vindex &$tls_sni$&
24400 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24401 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24402 are the values that were set when the message was received.
24403 These are the values that are used for options that are expanded before any
24404 SMTP connections are made. Just before each connection is made, these four
24405 variables are emptied. If TLS is subsequently started, they are set to the
24406 appropriate values for the outgoing connection, and these are the values that
24407 are in force when any authenticators are run and when the
24408 &%authenticated_sender%& option is expanded.
24409
24410 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24411 and will be removed in a future release.
24412
24413
24414 .section "Private options for smtp" "SECID146"
24415 .cindex "options" "&(smtp)& transport"
24416 The private options of the &(smtp)& transport are as follows:
24417
24418
24419 .option address_retry_include_sender smtp boolean true
24420 .cindex "4&'xx'& responses" "retrying after"
24421 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24422 is the combination of sender and recipient that is delayed in subsequent queue
24423 runs until the retry time is reached. You can delay the recipient without
24424 reference to the sender (which is what earlier versions of Exim did), by
24425 setting &%address_retry_include_sender%& false. However, this can lead to
24426 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24427
24428 .option allow_localhost smtp boolean false
24429 .cindex "local host" "sending to"
24430 .cindex "fallback" "hosts specified on transport"
24431 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24432 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24433 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24434 the delivery anyway. This should be used only in special cases when the
24435 configuration ensures that no looping will result (for example, a differently
24436 configured Exim is listening on the port to which the message is sent).
24437
24438
24439 .option authenticated_sender smtp string&!! unset
24440 .cindex "Cyrus"
24441 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24442 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24443 overriding any existing authenticated sender value. If the string expansion is
24444 forced to fail, the option is ignored. Other expansion failures cause delivery
24445 to be deferred. If the result of expansion is an empty string, that is also
24446 ignored.
24447
24448 The expansion happens after the outgoing connection has been made and TLS
24449 started, if required. This means that the &$host$&, &$host_address$&,
24450 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24451 particular connection.
24452
24453 If the SMTP session is not authenticated, the expansion of
24454 &%authenticated_sender%& still happens (and can cause the delivery to be
24455 deferred if it fails), but no AUTH= item is added to MAIL commands
24456 unless &%authenticated_sender_force%& is true.
24457
24458 This option allows you to use the &(smtp)& transport in LMTP mode to
24459 deliver mail to Cyrus IMAP and provide the proper local part as the
24460 &"authenticated sender"&, via a setting such as:
24461 .code
24462 authenticated_sender = $local_part
24463 .endd
24464 This removes the need for IMAP subfolders to be assigned special ACLs to
24465 allow direct delivery to those subfolders.
24466
24467 Because of expected uses such as that just described for Cyrus (when no
24468 domain is involved), there is no checking on the syntax of the provided
24469 value.
24470
24471
24472 .option authenticated_sender_force smtp boolean false
24473 If this option is set true, the &%authenticated_sender%& option's value
24474 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24475 authenticated as a client.
24476
24477
24478 .option command_timeout smtp time 5m
24479 This sets a timeout for receiving a response to an SMTP command that has been
24480 sent out. It is also used when waiting for the initial banner line from the
24481 remote host. Its value must not be zero.
24482
24483
24484 .option connect_timeout smtp time 5m
24485 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24486 to a remote host. A setting of zero allows the system timeout (typically
24487 several minutes) to act. To have any effect, the value of this option must be
24488 less than the system timeout. However, it has been observed that on some
24489 systems there is no system timeout, which is why the default value for this
24490 option is 5 minutes, a value recommended by RFC 1123.
24491
24492
24493 .option connection_max_messages smtp integer 500
24494 .cindex "SMTP" "passed connection"
24495 .cindex "SMTP" "multiple deliveries"
24496 .cindex "multiple SMTP deliveries"
24497 This controls the maximum number of separate message deliveries that are sent
24498 over a single TCP/IP connection. If the value is zero, there is no limit.
24499 For testing purposes, this value can be overridden by the &%-oB%& command line
24500 option.
24501
24502
24503 .option dane_require_tls_ciphers smtp string&!! unset
24504 .cindex "TLS" "requiring specific ciphers for DANE"
24505 .cindex "cipher" "requiring specific"
24506 .cindex DANE "TLS ciphers"
24507 This option may be used to override &%tls_require_ciphers%& for connections
24508 where DANE has been determined to be in effect.
24509 If not set, then &%tls_require_ciphers%& will be used.
24510 Normal SMTP delivery is not able to make strong demands of TLS cipher
24511 configuration, because delivery will fall back to plaintext.  Once DANE has
24512 been determined to be in effect, there is no plaintext fallback and making the
24513 TLS cipherlist configuration stronger will increase security, rather than
24514 counter-intuitively decreasing it.
24515 If the option expands to be empty or is forced to fail, then it will
24516 be treated as unset and &%tls_require_ciphers%& will be used instead.
24517
24518
24519 .option data_timeout smtp time 5m
24520 This sets a timeout for the transmission of each block in the data portion of
24521 the message. As a result, the overall timeout for a message depends on the size
24522 of the message. Its value must not be zero. See also &%final_timeout%&.
24523
24524
24525 .option dkim_canon smtp string&!! unset
24526 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24527 .option dkim_domain smtp string list&!! unset
24528 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24529 .option dkim_hash smtp string&!! sha256
24530 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24531 .option dkim_identity smtp string&!! unset
24532 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24533 .option dkim_private_key smtp string&!! unset
24534 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24535 .option dkim_selector smtp string&!! unset
24536 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24537 .option dkim_strict smtp string&!! unset
24538 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24539 .option dkim_sign_headers smtp string&!! "per RFC"
24540 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24541 .option dkim_timestamps smtp string&!! unset
24542 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24543
24544
24545 .option delay_after_cutoff smtp boolean true
24546 .cindex "final cutoff" "retries, controlling"
24547 .cindex retry "final cutoff"
24548 This option controls what happens when all remote IP addresses for a given
24549 domain have been inaccessible for so long that they have passed their retry
24550 cutoff times.
24551
24552 In the default state, if the next retry time has not been reached for any of
24553 them, the address is bounced without trying any deliveries. In other words,
24554 Exim delays retrying an IP address after the final cutoff time until a new
24555 retry time is reached, and can therefore bounce an address without ever trying
24556 a delivery, when machines have been down for a long time. Some people are
24557 unhappy at this prospect, so...
24558
24559 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24560 addresses are past their final cutoff time, Exim tries to deliver to those
24561 IP addresses that have not been tried since the message arrived. If there are
24562 none, of if they all fail, the address is bounced. In other words, it does not
24563 delay when a new message arrives, but immediately tries those expired IP
24564 addresses that haven't been tried since the message arrived. If there is a
24565 continuous stream of messages for the dead hosts, unsetting
24566 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24567 to them.
24568
24569
24570 .option dns_qualify_single smtp boolean true
24571 If the &%hosts%& or &%fallback_hosts%& option is being used,
24572 and the &%gethostbyname%& option is false,
24573 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24574 in chapter &<<CHAPdnslookup>>& for more details.
24575
24576
24577 .option dns_search_parents smtp boolean false
24578 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24579 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24580 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24581 details.
24582
24583
24584 .option dnssec_request_domains smtp "domain list&!!" *
24585 .cindex "MX record" "security"
24586 .cindex "DNSSEC" "MX lookup"
24587 .cindex "security" "MX lookup"
24588 .cindex "DNS" "DNSSEC"
24589 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24590 the dnssec request bit set. Setting this transport option is only useful if the
24591 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24592 router option.
24593
24594
24595
24596 .option dnssec_require_domains smtp "domain list&!!" unset
24597 .cindex "MX record" "security"
24598 .cindex "DNSSEC" "MX lookup"
24599 .cindex "security" "MX lookup"
24600 .cindex "DNS" "DNSSEC"
24601 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24602 the dnssec request bit set.  Setting this transport option is only
24603 useful if the transport overrides or sets the host names. See the
24604 &%dnssec_require_domains%& router option.
24605
24606
24607
24608 .option dscp smtp string&!! unset
24609 .cindex "DCSP" "outbound"
24610 This option causes the DSCP value associated with a socket to be set to one
24611 of a number of fixed strings or to numeric value.
24612 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24613 Common values include &`throughput`&, &`mincost`&, and on newer systems
24614 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24615
24616 The outbound packets from Exim will be marked with this value in the header
24617 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24618 that these values will have any effect, not be stripped by networking
24619 equipment, or do much of anything without cooperation with your Network
24620 Engineer and those of all network operators between the source and destination.
24621
24622
24623 .option fallback_hosts smtp "string list" unset
24624 .cindex "fallback" "hosts specified on transport"
24625 String expansion is not applied to this option. The argument must be a
24626 colon-separated list of host names or IP addresses, optionally also including
24627 port numbers, though the separator can be changed, as described in section
24628 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24629 item in a &%route_list%& setting for the &(manualroute)& router, as described
24630 in section &<<SECTformatonehostitem>>&.
24631
24632 Fallback hosts can also be specified on routers, which associate them with the
24633 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24634 &%fallback_hosts%& specified on the transport is used only if the address does
24635 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24636 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24637 However, &%hosts_randomize%& does apply to fallback host lists.
24638
24639 If Exim is unable to deliver to any of the hosts for a particular address, and
24640 the errors are not permanent rejections, the address is put on a separate
24641 transport queue with its host list replaced by the fallback hosts, unless the
24642 address was routed via MX records and the current host was in the original MX
24643 list. In that situation, the fallback host list is not used.
24644
24645 Once normal deliveries are complete, the fallback queue is delivered by
24646 re-running the same transports with the new host lists. If several failing
24647 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24648 copy of the message is sent.
24649
24650 The resolution of the host names on the fallback list is controlled by the
24651 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24652 both to cases when the host list comes with the address and when it is taken
24653 from &%hosts%&. This option provides a &"use a smart host only if delivery
24654 fails"& facility.
24655
24656
24657 .option final_timeout smtp time 10m
24658 This is the timeout that applies while waiting for the response to the final
24659 line containing just &"."& that terminates a message. Its value must not be
24660 zero.
24661
24662 .option gethostbyname smtp boolean false
24663 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24664 being used, names are looked up using &[gethostbyname()]&
24665 (or &[getipnodebyname()]& when available)
24666 instead of using the DNS. Of course, that function may in fact use the DNS, but
24667 it may also consult other sources of information such as &_/etc/hosts_&.
24668
24669 .option gnutls_compat_mode smtp boolean unset
24670 This option controls whether GnuTLS is used in compatibility mode in an Exim
24671 server. This reduces security slightly, but improves interworking with older
24672 implementations of TLS.
24673
24674 .option helo_data smtp string&!! "see below"
24675 .cindex "HELO" "argument, setting"
24676 .cindex "EHLO" "argument, setting"
24677 .cindex "LHLO argument setting"
24678 The value of this option is expanded after a connection to a another host has
24679 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24680 command that starts the outgoing SMTP or LMTP session. The default value of the
24681 option is:
24682 .code
24683 $primary_hostname
24684 .endd
24685 During the expansion, the variables &$host$& and &$host_address$& are set to
24686 the identity of the remote host, and the variables &$sending_ip_address$& and
24687 &$sending_port$& are set to the local IP address and port number that are being
24688 used. These variables can be used to generate different values for different
24689 servers or different local IP addresses. For example, if you want the string
24690 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24691 interface address, you could use this:
24692 .code
24693 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24694   {$primary_hostname}}
24695 .endd
24696 The use of &%helo_data%& applies both to sending messages and when doing
24697 callouts.
24698
24699 .option hosts smtp "string list&!!" unset
24700 Hosts are associated with an address by a router such as &(dnslookup)&, which
24701 finds the hosts by looking up the address domain in the DNS, or by
24702 &(manualroute)&, which has lists of hosts in its configuration. However,
24703 email addresses can be passed to the &(smtp)& transport by any router, and not
24704 all of them can provide an associated list of hosts.
24705
24706 The &%hosts%& option specifies a list of hosts to be used if the address being
24707 processed does not have any hosts associated with it. The hosts specified by
24708 &%hosts%& are also used, whether or not the address has its own hosts, if
24709 &%hosts_override%& is set.
24710
24711 The string is first expanded, before being interpreted as a colon-separated
24712 list of host names or IP addresses, possibly including port numbers. The
24713 separator may be changed to something other than colon, as described in section
24714 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24715 item in a &%route_list%& setting for the &(manualroute)& router, as described
24716 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24717 of the &(manualroute)& router is not available here.
24718
24719 If the expansion fails, delivery is deferred. Unless the failure was caused by
24720 the inability to complete a lookup, the error is logged to the panic log as
24721 well as the main log. Host names are looked up either by searching directly for
24722 address records in the DNS or by calling &[gethostbyname()]& (or
24723 &[getipnodebyname()]& when available), depending on the setting of the
24724 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24725 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24726 address are used.
24727
24728 During delivery, the hosts are tried in order, subject to their retry status,
24729 unless &%hosts_randomize%& is set.
24730
24731
24732 .option hosts_avoid_esmtp smtp "host list&!!" unset
24733 .cindex "ESMTP, avoiding use of"
24734 .cindex "HELO" "forcing use of"
24735 .cindex "EHLO" "avoiding use of"
24736 .cindex "PIPELINING" "avoiding the use of"
24737 This option is for use with broken hosts that announce ESMTP facilities (for
24738 example, PIPELINING) and then fail to implement them properly. When a host
24739 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24740 start of the SMTP session. This means that it cannot use any of the ESMTP
24741 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24742
24743
24744 .option hosts_avoid_pipelining smtp "host list&!!" unset
24745 .cindex "PIPELINING" "avoiding the use of"
24746 Exim will not use the SMTP PIPELINING extension when delivering to any host
24747 that matches this list, even if the server host advertises PIPELINING support.
24748
24749 .new
24750 .option hosts_pipe_connect smtp "host list&!!" unset
24751 .cindex "pipelining" "early connection"
24752 .cindex "pipelining" PIPE_CONNECT
24753 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24754 this option controls which to hosts the facility watched for
24755 and recorded, and used for subsequent connections.
24756
24757 The retry hints database is used for the record,
24758 and records are subject to the &%retry_data_expire%& option.
24759 When used, the pipelining saves on roundtrip times.
24760 It also turns SMTP into a client-first protocol
24761 so combines well with TCP Fast Open.
24762
24763 See also the &%pipelining_connect_advertise_hosts%& main option.
24764
24765 Note:
24766 When the facility is used, the transport &%helo_data%& option
24767 will be expanded before the &$sending_ip_address$& variable
24768 is filled in.
24769 A check is made for the use of that variable, without the
24770 presence of a &"def:"& test on it, but suitably complex coding
24771 can avoid the check and produce unexpected results.
24772 You have been warned.
24773 .wen
24774
24775
24776 .option hosts_avoid_tls smtp "host list&!!" unset
24777 .cindex "TLS" "avoiding for certain hosts"
24778 Exim will not try to start a TLS session when delivering to any host that
24779 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24780
24781 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24782 .cindex "TLS" "avoiding for certain hosts"
24783 Exim will not try to start a TLS session for a verify callout,
24784 or when delivering in cutthrough mode,
24785 to any host that matches this list.
24786
24787
24788 .option hosts_max_try smtp integer 5
24789 .cindex "host" "maximum number to try"
24790 .cindex "limit" "number of hosts tried"
24791 .cindex "limit" "number of MX tried"
24792 .cindex "MX record" "maximum tried"
24793 This option limits the number of IP addresses that are tried for any one
24794 delivery in cases where there are temporary delivery errors. Section
24795 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24796
24797
24798 .option hosts_max_try_hardlimit smtp integer 50
24799 This is an additional check on the maximum number of IP addresses that Exim
24800 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24801 why it exists.
24802
24803
24804
24805 .option hosts_nopass_tls smtp "host list&!!" unset
24806 .cindex "TLS" "passing connection"
24807 .cindex "multiple SMTP deliveries"
24808 .cindex "TLS" "multiple message deliveries"
24809 For any host that matches this list, a connection on which a TLS session has
24810 been started will not be passed to a new delivery process for sending another
24811 message on the same connection. See section &<<SECTmulmessam>>& for an
24812 explanation of when this might be needed.
24813
24814 .new
24815 .option hosts_noproxy_tls smtp "host list&!!" unset
24816 .cindex "TLS" "passing connection"
24817 .cindex "multiple SMTP deliveries"
24818 .cindex "TLS" "multiple message deliveries"
24819 For any host that matches this list, a TLS session which has
24820 been started will not be passed to a new delivery process for sending another
24821 message on the same session.
24822 .wen
24823
24824 The traditional implementation closes down TLS and re-starts it in the new
24825 process, on the same open TCP connection, for each successive message
24826 sent.  If permitted by this option a pipe to to the new process is set up
24827 instead, and the original process maintains the TLS connection and proxies
24828 the SMTP connection from and to the new process and any subsequents.
24829 The new process has no access to TLS information, so cannot include it in
24830 logging.
24831
24832
24833
24834 .option hosts_override smtp boolean false
24835 If this option is set and the &%hosts%& option is also set, any hosts that are
24836 attached to the address are ignored, and instead the hosts specified by the
24837 &%hosts%& option are always used. This option does not apply to
24838 &%fallback_hosts%&.
24839
24840
24841 .option hosts_randomize smtp boolean false
24842 .cindex "randomized host list"
24843 .cindex "host" "list of; randomized"
24844 .cindex "fallback" "randomized hosts"
24845 If this option is set, and either the list of hosts is taken from the
24846 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24847 were not obtained from MX records (this includes fallback hosts from the
24848 router), and were not randomized by the router, the order of trying the hosts
24849 is randomized each time the transport runs. Randomizing the order of a host
24850 list can be used to do crude load sharing.
24851
24852 When &%hosts_randomize%& is true, a host list may be split into groups whose
24853 order is separately randomized. This makes it possible to set up MX-like
24854 behaviour. The boundaries between groups are indicated by an item that is just
24855 &`+`& in the host list. For example:
24856 .code
24857 hosts = host1:host2:host3:+:host4:host5
24858 .endd
24859 The order of the first three hosts and the order of the last two hosts is
24860 randomized for each use, but the first three always end up before the last two.
24861 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24862
24863 .option hosts_require_auth smtp "host list&!!" unset
24864 .cindex "authentication" "required by client"
24865 This option provides a list of servers for which authentication must succeed
24866 before Exim will try to transfer a message. If authentication fails for
24867 servers which are not in this list, Exim tries to send unauthenticated. If
24868 authentication fails for one of these servers, delivery is deferred. This
24869 temporary error is detectable in the retry rules, so it can be turned into a
24870 hard failure if required. See also &%hosts_try_auth%&, and chapter
24871 &<<CHAPSMTPAUTH>>& for details of authentication.
24872
24873
24874 .option hosts_request_ocsp smtp "host list&!!" *
24875 .cindex "TLS" "requiring for certain servers"
24876 Exim will request a Certificate Status on a
24877 TLS session for any host that matches this list.
24878 &%tls_verify_certificates%& should also be set for the transport.
24879
24880 .option hosts_require_dane smtp "host list&!!" unset
24881 .cindex DANE "transport options"
24882 .cindex DANE "requiring for certain servers"
24883 If built with DANE support, Exim  will require that a DNSSEC-validated
24884 TLSA record is present for any host matching the list,
24885 and that a DANE-verified TLS connection is made. See
24886 the &%dnssec_request_domains%& router and transport options.
24887 There will be no fallback to in-clear communication.
24888 See section &<<SECDANE>>&.
24889
24890 .option hosts_require_ocsp smtp "host list&!!" unset
24891 .cindex "TLS" "requiring for certain servers"
24892 Exim will request, and check for a valid Certificate Status being given, on a
24893 TLS session for any host that matches this list.
24894 &%tls_verify_certificates%& should also be set for the transport.
24895
24896 .option hosts_require_tls smtp "host list&!!" unset
24897 .cindex "TLS" "requiring for certain servers"
24898 Exim will insist on using a TLS session when delivering to any host that
24899 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24900 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24901 incoming messages, use an appropriate ACL.
24902
24903 .option hosts_try_auth smtp "host list&!!" unset
24904 .cindex "authentication" "optional in client"
24905 This option provides a list of servers to which, provided they announce
24906 authentication support, Exim will attempt to authenticate as a client when it
24907 connects. If authentication fails, Exim will try to transfer the message
24908 unauthenticated. See also &%hosts_require_auth%&, and chapter
24909 &<<CHAPSMTPAUTH>>& for details of authentication.
24910
24911 .option hosts_try_chunking smtp "host list&!!" *
24912 .cindex CHUNKING "enabling, in client"
24913 .cindex BDAT "SMTP command"
24914 .cindex "RFC 3030" "CHUNKING"
24915 This option provides a list of servers to which, provided they announce
24916 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24917 BDAT will not be used in conjunction with a transport filter.
24918
24919 .option hosts_try_dane smtp "host list&!!" *
24920 .cindex DANE "transport options"
24921 .cindex DANE "attempting for certain servers"
24922 If built with DANE support, Exim  will require that a DNSSEC-validated
24923 TLSA record is present for any host matching the list,
24924 and that a DANE-verified TLS connection is made. See
24925 the &%dnssec_request_domains%& router and transport options.
24926 There will be no fallback to in-clear communication.
24927 See section &<<SECDANE>>&.
24928
24929 .option hosts_try_fastopen smtp "host list&!!" *
24930 .cindex "fast open, TCP" "enabling, in client"
24931 .cindex "TCP Fast Open" "enabling, in client"
24932 .cindex "RFC 7413" "TCP Fast Open"
24933 This option provides a list of servers to which, provided
24934 the facility is supported by this system, Exim will attempt to
24935 perform a TCP Fast Open.
24936 No data is sent on the SYN segment but, if the remote server also
24937 supports the facility, it can send its SMTP banner immediately after
24938 the SYN,ACK segment.  This can save up to one round-trip time.
24939
24940 The facility is only active for previously-contacted servers,
24941 as the initiator must present a cookie in the SYN segment.
24942
24943 On (at least some) current Linux distributions the facility must be enabled
24944 in the kernel by the sysadmin before the support is usable.
24945 There is no option for control of the server side; if the system supports
24946 it it is always enabled.  Note that lengthy operations in the connect ACL,
24947 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24948
24949 .option hosts_try_prdr smtp "host list&!!" *
24950 .cindex "PRDR" "enabling, optional in client"
24951 This option provides a list of servers to which, provided they announce
24952 PRDR support, Exim will attempt to negotiate PRDR
24953 for multi-recipient messages.
24954 The option can usually be left as default.
24955
24956 .option interface smtp "string list&!!" unset
24957 .cindex "bind IP address"
24958 .cindex "IP address" "binding"
24959 .vindex "&$host$&"
24960 .vindex "&$host_address$&"
24961 This option specifies which interface to bind to when making an outgoing SMTP
24962 call. The value is an IP address, not an interface name such as
24963 &`eth0`&. Do not confuse this with the interface address that was used when a
24964 message was received, which is in &$received_ip_address$&, formerly known as
24965 &$interface_address$&. The name was changed to minimize confusion with the
24966 outgoing interface address. There is no variable that contains an outgoing
24967 interface address because, unless it is set by this option, its value is
24968 unknown.
24969
24970 During the expansion of the &%interface%& option the variables &$host$& and
24971 &$host_address$& refer to the host to which a connection is about to be made
24972 during the expansion of the string. Forced expansion failure, or an empty
24973 string result causes the option to be ignored. Otherwise, after expansion, the
24974 string must be a list of IP addresses, colon-separated by default, but the
24975 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
24976 For example:
24977 .code
24978 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24979 .endd
24980 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24981 connection. If none of them are the correct type, the option is ignored. If
24982 &%interface%& is not set, or is ignored, the system's IP functions choose which
24983 interface to use if the host has more than one.
24984
24985
24986 .option keepalive smtp boolean true
24987 .cindex "keepalive" "on outgoing connection"
24988 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24989 connections. When set, it causes the kernel to probe idle connections
24990 periodically, by sending packets with &"old"& sequence numbers. The other end
24991 of the connection should send a acknowledgment if the connection is still okay
24992 or a reset if the connection has been aborted. The reason for doing this is
24993 that it has the beneficial effect of freeing up certain types of connection
24994 that can get stuck when the remote host is disconnected without tidying up the
24995 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24996 unreachable hosts.
24997
24998
24999 .option lmtp_ignore_quota smtp boolean false
25000 .cindex "LMTP" "ignoring quota errors"
25001 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25002 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25003 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25004
25005 .option max_rcpt smtp integer 100
25006 .cindex "RCPT" "maximum number of outgoing"
25007 This option limits the number of RCPT commands that are sent in a single
25008 SMTP message transaction. Each set of addresses is treated independently, and
25009 so can cause parallel connections to the same host if &%remote_max_parallel%&
25010 permits this.
25011
25012
25013 .option multi_domain smtp boolean&!! true
25014 .vindex "&$domain$&"
25015 When this option is set, the &(smtp)& transport can handle a number of
25016 addresses containing a mixture of different domains provided they all resolve
25017 to the same list of hosts. Turning the option off restricts the transport to
25018 handling only one domain at a time. This is useful if you want to use
25019 &$domain$& in an expansion for the transport, because it is set only when there
25020 is a single domain involved in a remote delivery.
25021
25022 It is expanded per-address and can depend on any of
25023 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25024 &$host$&, &$host_address$& and &$host_port$&.
25025
25026 .option port smtp string&!! "see below"
25027 .cindex "port" "sending TCP/IP"
25028 .cindex "TCP/IP" "setting outgoing port"
25029 This option specifies the TCP/IP port on the server to which Exim connects.
25030 &*Note:*& Do not confuse this with the port that was used when a message was
25031 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25032 The name was changed to minimize confusion with the outgoing port. There is no
25033 variable that contains an outgoing port.
25034
25035 If the value of this option begins with a digit it is taken as a port number;
25036 otherwise it is looked up using &[getservbyname()]&. The default value is
25037 normally &"smtp"&,
25038 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25039 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25040 If the expansion fails, or if a port number cannot be found, delivery
25041 is deferred.
25042
25043 Note that at least one Linux distribution has been seen failing
25044 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25045
25046
25047
25048 .option protocol smtp string smtp
25049 .cindex "LMTP" "over TCP/IP"
25050 .cindex "ssmtp protocol" "outbound"
25051 .cindex "TLS" "SSL-on-connect outbound"
25052 .vindex "&$port$&"
25053 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25054 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25055 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25056 deliveries into closed message stores. Exim also has support for running LMTP
25057 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25058
25059 If this option is set to &"smtps"&, the default value for the &%port%& option
25060 changes to &"smtps"&, and the transport initiates TLS immediately after
25061 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25062 The Internet standards bodies used to strongly discourage use of this mode,
25063 but as of RFC 8314 it is perferred over STARTTLS for message submission
25064 (as distinct from MTA-MTA communication).
25065
25066
25067 .option retry_include_ip_address smtp boolean&!! true
25068 Exim normally includes both the host name and the IP address in the key it
25069 constructs for indexing retry data after a temporary delivery failure. This
25070 means that when one of several IP addresses for a host is failing, it gets
25071 tried periodically (controlled by the retry rules), but use of the other IP
25072 addresses is not affected.
25073
25074 However, in some dialup environments hosts are assigned a different IP address
25075 each time they connect. In this situation the use of the IP address as part of
25076 the retry key leads to undesirable behaviour. Setting this option false causes
25077 Exim to use only the host name.
25078 Since it is expanded it can be made to depend on the host or domain.
25079
25080
25081 .option serialize_hosts smtp "host list&!!" unset
25082 .cindex "serializing connections"
25083 .cindex "host" "serializing connections"
25084 Because Exim operates in a distributed manner, if several messages for the same
25085 host arrive at around the same time, more than one simultaneous connection to
25086 the remote host can occur. This is not usually a problem except when there is a
25087 slow link between the hosts. In that situation it may be helpful to restrict
25088 Exim to one connection at a time. This can be done by setting
25089 &%serialize_hosts%& to match the relevant hosts.
25090
25091 .cindex "hints database" "serializing deliveries to a host"
25092 Exim implements serialization by means of a hints database in which a record is
25093 written whenever a process connects to one of the restricted hosts. The record
25094 is deleted when the connection is completed. Obviously there is scope for
25095 records to get left lying around if there is a system or program crash. To
25096 guard against this, Exim ignores any records that are more than six hours old.
25097
25098 If you set up this kind of serialization, you should also arrange to delete the
25099 relevant hints database whenever your system reboots. The names of the files
25100 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25101 may be one or two files, depending on the type of DBM in use. The same files
25102 are used for ETRN serialization.
25103
25104 See also the &%max_parallel%& generic transport option.
25105
25106
25107 .option size_addition smtp integer 1024
25108 .cindex "SMTP" "SIZE"
25109 .cindex "message" "size issue for transport filter"
25110 .cindex "size" "of message"
25111 .cindex "transport" "filter"
25112 .cindex "filter" "transport filter"
25113 If a remote SMTP server indicates that it supports the SIZE option of the
25114 MAIL command, Exim uses this to pass over the message size at the start of
25115 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25116 sends, to allow for headers and other text that may be added during delivery by
25117 configuration options or in a transport filter. It may be necessary to increase
25118 this if a lot of text is added to messages.
25119
25120 Alternatively, if the value of &%size_addition%& is set negative, it disables
25121 the use of the SIZE option altogether.
25122
25123
25124 .option socks_proxy smtp string&!! unset
25125 .cindex proxy SOCKS
25126 This option enables use of SOCKS proxies for connections made by the
25127 transport.  For details see section &<<SECTproxySOCKS>>&.
25128
25129
25130 .option tls_certificate smtp string&!! unset
25131 .cindex "TLS" "client certificate, location of"
25132 .cindex "certificate" "client, location of"
25133 .vindex "&$host$&"
25134 .vindex "&$host_address$&"
25135 The value of this option must be the absolute path to a file which contains the
25136 client's certificate, for possible use when sending a message over an encrypted
25137 connection. The values of &$host$& and &$host_address$& are set to the name and
25138 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25139 details of TLS.
25140
25141 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25142 certificate when sending messages as a client. The global option of the same
25143 name specifies the certificate for Exim as a server; it is not automatically
25144 assumed that the same certificate should be used when Exim is operating as a
25145 client.
25146
25147
25148 .option tls_crl smtp string&!! unset
25149 .cindex "TLS" "client certificate revocation list"
25150 .cindex "certificate" "revocation list for client"
25151 This option specifies a certificate revocation list. The expanded value must
25152 be the name of a file that contains a CRL in PEM format.
25153
25154
25155 .option tls_dh_min_bits smtp integer 1024
25156 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25157 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25158 key agreement is negotiated, the server will provide a large prime number
25159 for use.  This option establishes the minimum acceptable size of that number.
25160 If the parameter offered by the server is too small, then the TLS handshake
25161 will fail.
25162
25163 Only supported when using GnuTLS.
25164
25165
25166 .option tls_privatekey smtp string&!! unset
25167 .cindex "TLS" "client private key, location of"
25168 .vindex "&$host$&"
25169 .vindex "&$host_address$&"
25170 The value of this option must be the absolute path to a file which contains the
25171 client's private key. This is used when sending a message over an encrypted
25172 connection using a client certificate. The values of &$host$& and
25173 &$host_address$& are set to the name and address of the server during the
25174 expansion. If this option is unset, or the expansion is forced to fail, or the
25175 result is an empty string, the private key is assumed to be in the same file as
25176 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25177
25178
25179 .option tls_require_ciphers smtp string&!! unset
25180 .cindex "TLS" "requiring specific ciphers"
25181 .cindex "cipher" "requiring specific"
25182 .vindex "&$host$&"
25183 .vindex "&$host_address$&"
25184 The value of this option must be a list of permitted cipher suites, for use
25185 when setting up an outgoing encrypted connection. (There is a global option of
25186 the same name for controlling incoming connections.) The values of &$host$& and
25187 &$host_address$& are set to the name and address of the server during the
25188 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25189 is used in different ways by OpenSSL and GnuTLS (see sections
25190 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25191 ciphers is a preference order.
25192
25193
25194
25195 .option tls_sni smtp string&!! unset
25196 .cindex "TLS" "Server Name Indication"
25197 .vindex "&$tls_sni$&"
25198 If this option is set then it sets the $tls_out_sni variable and causes any
25199 TLS session to pass this value as the Server Name Indication extension to
25200 the remote side, which can be used by the remote side to select an appropriate
25201 certificate and private key for the session.
25202
25203 See &<<SECTtlssni>>& for more information.
25204
25205 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25206 TLS extensions.
25207
25208
25209
25210
25211 .option tls_tempfail_tryclear smtp boolean true
25212 .cindex "4&'xx'& responses" "to STARTTLS"
25213 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25214 setting up a TLS session, this option determines whether or not Exim should try
25215 to deliver the message unencrypted. If it is set false, delivery to the
25216 current host is deferred; if there are other hosts, they are tried. If this
25217 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25218 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25219 TLS negotiation fails, Exim closes the current connection (because it is in an
25220 unknown state), opens a new one to the same host, and then tries the delivery
25221 in clear.
25222
25223
25224 .option tls_try_verify_hosts smtp "host list&!!" *
25225 .cindex "TLS" "server certificate verification"
25226 .cindex "certificate" "verification of server"
25227 This option gives a list of hosts for which, on encrypted connections,
25228 certificate verification will be tried but need not succeed.
25229 The &%tls_verify_certificates%& option must also be set.
25230 Note that unless the host is in this list
25231 TLS connections will be denied to hosts using self-signed certificates
25232 when &%tls_verify_certificates%& is matched.
25233 The &$tls_out_certificate_verified$& variable is set when
25234 certificate verification succeeds.
25235
25236
25237 .option tls_verify_cert_hostnames smtp "host list&!!" *
25238 .cindex "TLS" "server certificate hostname verification"
25239 .cindex "certificate" "verification of server"
25240 This option give a list of hosts for which,
25241 while verifying the server certificate,
25242 checks will be included on the host name
25243 (note that this will generally be the result of a DNS MX lookup)
25244 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25245 limited to being the initial component of a 3-or-more component FQDN.
25246
25247 There is no equivalent checking on client certificates.
25248
25249
25250 .option tls_verify_certificates smtp string&!! system
25251 .cindex "TLS" "server certificate verification"
25252 .cindex "certificate" "verification of server"
25253 .vindex "&$host$&"
25254 .vindex "&$host_address$&"
25255 The value of this option must be either the
25256 word "system"
25257 or the absolute path to
25258 a file or directory containing permitted certificates for servers,
25259 for use when setting up an encrypted connection.
25260
25261 The "system" value for the option will use a location compiled into the SSL library.
25262 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25263 is taken as empty and an explicit location
25264 must be specified.
25265
25266 The use of a directory for the option value is not available for GnuTLS versions
25267 preceding 3.3.6 and a single file must be used.
25268
25269 With OpenSSL the certificates specified
25270 explicitly
25271 either by file or directory
25272 are added to those given by the system default location.
25273
25274 The values of &$host$& and
25275 &$host_address$& are set to the name and address of the server during the
25276 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25277
25278 For back-compatibility,
25279 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25280 (a single-colon empty list counts as being set)
25281 and certificate verification fails the TLS connection is closed.
25282
25283
25284 .option tls_verify_hosts smtp "host list&!!" unset
25285 .cindex "TLS" "server certificate verification"
25286 .cindex "certificate" "verification of server"
25287 This option gives a list of hosts for which, on encrypted connections,
25288 certificate verification must succeed.
25289 The &%tls_verify_certificates%& option must also be set.
25290 If both this option and &%tls_try_verify_hosts%& are unset
25291 operation is as if this option selected all hosts.
25292
25293 .option utf8_downconvert smtp integer!! unset
25294 .cindex utf8 "address downconversion"
25295 .cindex i18n "utf8 address downconversion"
25296 If built with internationalization support,
25297 this option controls conversion of UTF-8 in message addresses
25298 to a-label form.
25299 For details see section &<<SECTi18nMTA>>&.
25300
25301
25302
25303
25304 .section "How the limits for the number of hosts to try are used" &&&
25305          "SECTvalhosmax"
25306 .cindex "host" "maximum number to try"
25307 .cindex "limit" "hosts; maximum number tried"
25308 There are two options that are concerned with the number of hosts that are
25309 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25310 &%hosts_max_try_hardlimit%&.
25311
25312
25313 The &%hosts_max_try%& option limits the number of hosts that are tried
25314 for a single delivery. However, despite the term &"host"& in its name, the
25315 option actually applies to each IP address independently. In other words, a
25316 multihomed host is treated as several independent hosts, just as it is for
25317 retrying.
25318
25319 Many of the larger ISPs have multiple MX records which often point to
25320 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25321 created as a result of routing one of these domains.
25322
25323 Trying every single IP address on such a long list does not seem sensible; if
25324 several at the top of the list fail, it is reasonable to assume there is some
25325 problem that is likely to affect all of them. Roughly speaking, the value of
25326 &%hosts_max_try%& is the maximum number that are tried before deferring the
25327 delivery. However, the logic cannot be quite that simple.
25328
25329 Firstly, IP addresses that are skipped because their retry times have not
25330 arrived do not count, and in addition, addresses that are past their retry
25331 limits are also not counted, even when they are tried. This means that when
25332 some IP addresses are past their retry limits, more than the value of
25333 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25334 that all IP addresses are considered before timing out an email address (but
25335 see below for an exception).
25336
25337 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25338 list to see if there is a subsequent host with a different (higher valued) MX.
25339 If there is, that host is considered next, and the current IP address is used
25340 but not counted. This behaviour helps in the case of a domain with a retry rule
25341 that hardly ever delays any hosts, as is now explained:
25342
25343 Consider the case of a long list of hosts with one MX value, and a few with a
25344 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25345 hosts at the top of the list are tried at first. With the default retry rule,
25346 which specifies increasing retry times, the higher MX hosts are eventually
25347 tried when those at the top of the list are skipped because they have not
25348 reached their retry times.
25349
25350 However, it is common practice to put a fixed short retry time on domains for
25351 large ISPs, on the grounds that their servers are rarely down for very long.
25352 Unfortunately, these are exactly the domains that tend to resolve to long lists
25353 of hosts. The short retry time means that the lowest MX hosts are tried every
25354 time. The attempts may be in a different order because of random sorting, but
25355 without the special MX check, the higher MX hosts would never be tried until
25356 all the lower MX hosts had timed out (which might be several days), because
25357 there are always some lower MX hosts that have reached their retry times. With
25358 the special check, Exim considers at least one IP address from each MX value at
25359 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25360 reached.
25361
25362 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25363 particular, Exim normally eventually tries all the IP addresses before timing
25364 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25365 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25366 been set up with hundreds of IP addresses for some domains. It can
25367 take a very long time indeed for an address to time out in these cases.
25368
25369 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25370 Exim never tries more than this number of IP addresses; if it hits this limit
25371 and they are all timed out, the email address is bounced, even though not all
25372 possible IP addresses have been tried.
25373 .ecindex IIDsmttra1
25374 .ecindex IIDsmttra2
25375
25376
25377
25378
25379
25380 . ////////////////////////////////////////////////////////////////////////////
25381 . ////////////////////////////////////////////////////////////////////////////
25382
25383 .chapter "Address rewriting" "CHAPrewrite"
25384 .scindex IIDaddrew "rewriting" "addresses"
25385 There are some circumstances in which Exim automatically rewrites domains in
25386 addresses. The two most common are when an address is given without a domain
25387 (referred to as an &"unqualified address"&) or when an address contains an
25388 abbreviated domain that is expanded by DNS lookup.
25389
25390 Unqualified envelope addresses are accepted only for locally submitted
25391 messages, or for messages that are received from hosts matching
25392 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25393 appropriate. Unqualified addresses in header lines are qualified if they are in
25394 locally submitted messages, or messages from hosts that are permitted to send
25395 unqualified envelope addresses. Otherwise, unqualified addresses in header
25396 lines are neither qualified nor rewritten.
25397
25398 One situation in which Exim does &'not'& automatically rewrite a domain is
25399 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25400 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25401 do this. The new RFCs do not contain this suggestion.
25402
25403
25404 .section "Explicitly configured address rewriting" "SECID147"
25405 This chapter describes the rewriting rules that can be used in the
25406 main rewrite section of the configuration file, and also in the generic
25407 &%headers_rewrite%& option that can be set on any transport.
25408
25409 Some people believe that configured address rewriting is a Mortal Sin.
25410 Others believe that life is not possible without it. Exim provides the
25411 facility; you do not have to use it.
25412
25413 The main rewriting rules that appear in the &"rewrite"& section of the
25414 configuration file are applied to addresses in incoming messages, both envelope
25415 addresses and addresses in header lines. Each rule specifies the types of
25416 address to which it applies.
25417
25418 Whether or not addresses in header lines are rewritten depends on the origin of
25419 the headers and the type of rewriting. Global rewriting, that is, rewriting
25420 rules from the rewrite section of the configuration file, is applied only to
25421 those headers that were received with the message. Header lines that are added
25422 by ACLs or by a system filter or by individual routers or transports (which
25423 are specific to individual recipient addresses) are not rewritten by the global
25424 rules.
25425
25426 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25427 applies all headers except those added by routers and transports. That is, as
25428 well as the headers that were received with the message, it also applies to
25429 headers that were added by an ACL or a system filter.
25430
25431
25432 In general, rewriting addresses from your own system or domain has some
25433 legitimacy. Rewriting other addresses should be done only with great care and
25434 in special circumstances. The author of Exim believes that rewriting should be
25435 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25436 Although it can sometimes be used as a routing tool, this is very strongly
25437 discouraged.
25438
25439 There are two commonly encountered circumstances where rewriting is used, as
25440 illustrated by these examples:
25441
25442 .ilist
25443 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25444 exchange mail with each other behind a firewall, but there is only a single
25445 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25446 &'hitch.fict.example'& when sending mail off-site.
25447 .next
25448 A host rewrites the local parts of its own users so that, for example,
25449 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25450 .endlist
25451
25452
25453
25454 .section "When does rewriting happen?" "SECID148"
25455 .cindex "rewriting" "timing of"
25456 .cindex "&ACL;" "rewriting addresses in"
25457 Configured address rewriting can take place at several different stages of a
25458 message's processing.
25459
25460 .vindex "&$sender_address$&"
25461 At the start of an ACL for MAIL, the sender address may have been rewritten
25462 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25463 ordinary rewrite rules have yet been applied. If, however, the sender address
25464 is verified in the ACL, it is rewritten before verification, and remains
25465 rewritten thereafter. The subsequent value of &$sender_address$& is the
25466 rewritten address. This also applies if sender verification happens in a
25467 RCPT ACL. Otherwise, when the sender address is not verified, it is
25468 rewritten as soon as a message's header lines have been received.
25469
25470 .vindex "&$domain$&"
25471 .vindex "&$local_part$&"
25472 Similarly, at the start of an ACL for RCPT, the current recipient's address
25473 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25474 rewrite rules have yet been applied to it. However, the behaviour is different
25475 from the sender address when a recipient is verified. The address is rewritten
25476 for the verification, but the rewriting is not remembered at this stage. The
25477 value of &$local_part$& and &$domain$& after verification are always the same
25478 as they were before (that is, they contain the unrewritten &-- except for
25479 SMTP-time rewriting &-- address).
25480
25481 As soon as a message's header lines have been received, all the envelope
25482 recipient addresses are permanently rewritten, and rewriting is also applied to
25483 the addresses in the header lines (if configured). This happens before adding
25484 any header lines that were specified in MAIL or RCPT ACLs, and
25485 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25486 before the DATA ACL and &[local_scan()]& functions are run.
25487
25488 When an address is being routed, either for delivery or for verification,
25489 rewriting is applied immediately to child addresses that are generated by
25490 redirection, unless &%no_rewrite%& is set on the router.
25491
25492 .cindex "envelope from"
25493 .cindex "envelope sender" "rewriting at transport time"
25494 .cindex "rewriting" "at transport time"
25495 .cindex "header lines" "rewriting at transport time"
25496 At transport time, additional rewriting of addresses in header lines can be
25497 specified by setting the generic &%headers_rewrite%& option on a transport.
25498 This option contains rules that are identical in form to those in the rewrite
25499 section of the configuration file. They are applied to the original message
25500 header lines and any that were added by ACLs or a system filter. They are not
25501 applied to header lines that are added by routers or the transport.
25502
25503 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25504 transport option. However, it is not possible to rewrite envelope recipients at
25505 transport time.
25506
25507
25508
25509
25510 .section "Testing the rewriting rules that apply on input" "SECID149"
25511 .cindex "rewriting" "testing"
25512 .cindex "testing" "rewriting"
25513 Exim's input rewriting configuration appears in a part of the runtime
25514 configuration file headed by &"begin rewrite"&. It can be tested by the
25515 &%-brw%& command line option. This takes an address (which can be a full RFC
25516 2822 address) as its argument. The output is a list of how the address would be
25517 transformed by the rewriting rules for each of the different places it might
25518 appear in an incoming message, that is, for each different header and for the
25519 envelope sender and recipient fields. For example,
25520 .code
25521 exim -brw ph10@exim.workshop.example
25522 .endd
25523 might produce the output
25524 .code
25525 sender: Philip.Hazel@exim.workshop.example
25526 from: Philip.Hazel@exim.workshop.example
25527 to: ph10@exim.workshop.example
25528 cc: ph10@exim.workshop.example
25529 bcc: ph10@exim.workshop.example
25530 reply-to: Philip.Hazel@exim.workshop.example
25531 env-from: Philip.Hazel@exim.workshop.example
25532 env-to: ph10@exim.workshop.example
25533 .endd
25534 which shows that rewriting has been set up for that address when used in any of
25535 the source fields, but not when it appears as a recipient address. At the
25536 present time, there is no equivalent way of testing rewriting rules that are
25537 set for a particular transport.
25538
25539
25540 .section "Rewriting rules" "SECID150"
25541 .cindex "rewriting" "rules"
25542 The rewrite section of the configuration file consists of lines of rewriting
25543 rules in the form
25544 .display
25545 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25546 .endd
25547 Rewriting rules that are specified for the &%headers_rewrite%& generic
25548 transport option are given as a colon-separated list. Each item in the list
25549 takes the same form as a line in the main rewriting configuration (except that
25550 any colons must be doubled, of course).
25551
25552 The formats of source patterns and replacement strings are described below.
25553 Each is terminated by white space, unless enclosed in double quotes, in which
25554 case normal quoting conventions apply inside the quotes. The flags are single
25555 characters which may appear in any order. Spaces and tabs between them are
25556 ignored.
25557
25558 For each address that could potentially be rewritten, the rules are scanned in
25559 order, and replacements for the address from earlier rules can themselves be
25560 replaced by later rules (but see the &"q"& and &"R"& flags).
25561
25562 The order in which addresses are rewritten is undefined, may change between
25563 releases, and must not be relied on, with one exception: when a message is
25564 received, the envelope sender is always rewritten first, before any header
25565 lines are rewritten. For example, the replacement string for a rewrite of an
25566 address in &'To:'& must not assume that the message's address in &'From:'& has
25567 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25568 that the envelope sender has already been rewritten.
25569
25570 .vindex "&$domain$&"
25571 .vindex "&$local_part$&"
25572 The variables &$local_part$& and &$domain$& can be used in the replacement
25573 string to refer to the address that is being rewritten. Note that lookup-driven
25574 rewriting can be done by a rule of the form
25575 .code
25576 *@*   ${lookup ...
25577 .endd
25578 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25579 refer to the address that is being rewritten.
25580
25581
25582 .section "Rewriting patterns" "SECID151"
25583 .cindex "rewriting" "patterns"
25584 .cindex "address list" "in a rewriting pattern"
25585 The source pattern in a rewriting rule is any item which may appear in an
25586 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25587 single-item address list, which means that it is expanded before being tested
25588 against the address. As always, if you use a regular expression as a pattern,
25589 you must take care to escape dollar and backslash characters, or use the &`\N`&
25590 facility to suppress string expansion within the regular expression.
25591
25592 Domains in patterns should be given in lower case. Local parts in patterns are
25593 case-sensitive. If you want to do case-insensitive matching of local parts, you
25594 can use a regular expression that starts with &`^(?i)`&.
25595
25596 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25597 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25598 depending on the type of match which occurred. These can be used in the
25599 replacement string to insert portions of the incoming address. &$0$& always
25600 refers to the complete incoming address. When a regular expression is used, the
25601 numerical variables are set from its capturing subexpressions. For other types
25602 of pattern they are set as follows:
25603
25604 .ilist
25605 If a local part or domain starts with an asterisk, the numerical variables
25606 refer to the character strings matched by asterisks, with &$1$& associated with
25607 the first asterisk, and &$2$& with the second, if present. For example, if the
25608 pattern
25609 .code
25610 *queen@*.fict.example
25611 .endd
25612 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25613 .code
25614 $0 = hearts-queen@wonderland.fict.example
25615 $1 = hearts-
25616 $2 = wonderland
25617 .endd
25618 Note that if the local part does not start with an asterisk, but the domain
25619 does, it is &$1$& that contains the wild part of the domain.
25620
25621 .next
25622 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25623 of the domain are placed in the next available numerical variables. Suppose,
25624 for example, that the address &'foo@bar.baz.example'& is processed by a
25625 rewriting rule of the form
25626 .display
25627 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25628 .endd
25629 and the key in the file that matches the domain is &`*.baz.example`&. Then
25630 .code
25631 $1 = foo
25632 $2 = bar
25633 $3 = baz.example
25634 .endd
25635 If the address &'foo@baz.example'& is looked up, this matches the same
25636 wildcard file entry, and in this case &$2$& is set to the empty string, but
25637 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25638 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25639 whole domain. For non-partial domain lookups, no numerical variables are set.
25640 .endlist
25641
25642
25643 .section "Rewriting replacements" "SECID152"
25644 .cindex "rewriting" "replacements"
25645 If the replacement string for a rule is a single asterisk, addresses that
25646 match the pattern and the flags are &'not'& rewritten, and no subsequent
25647 rewriting rules are scanned. For example,
25648 .code
25649 hatta@lookingglass.fict.example  *  f
25650 .endd
25651 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25652 &'From:'& headers.
25653
25654 .vindex "&$domain$&"
25655 .vindex "&$local_part$&"
25656 If the replacement string is not a single asterisk, it is expanded, and must
25657 yield a fully qualified address. Within the expansion, the variables
25658 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25659 Any letters they contain retain their original case &-- they are not lower
25660 cased. The numerical variables are set up according to the type of pattern that
25661 matched the address, as described above. If the expansion is forced to fail by
25662 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25663 current rule is abandoned, but subsequent rules may take effect. Any other
25664 expansion failure causes the entire rewriting operation to be abandoned, and an
25665 entry written to the panic log.
25666
25667
25668
25669 .section "Rewriting flags" "SECID153"
25670 There are three different kinds of flag that may appear on rewriting rules:
25671
25672 .ilist
25673 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25674 c, f, h, r, s, t.
25675 .next
25676 A flag that specifies rewriting at SMTP time: S.
25677 .next
25678 Flags that control the rewriting process: Q, q, R, w.
25679 .endlist
25680
25681 For rules that are part of the &%headers_rewrite%& generic transport option,
25682 E, F, T, and S are not permitted.
25683
25684
25685
25686 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25687          "SECID154"
25688 .cindex "rewriting" "flags"
25689 If none of the following flag letters, nor the &"S"& flag (see section
25690 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25691 and to both the sender and recipient fields of the envelope, whereas a
25692 transport-time rewriting rule just applies to all headers. Otherwise, the
25693 rewriting rule is skipped unless the relevant addresses are being processed.
25694 .display
25695 &`E`&       rewrite all envelope fields
25696 &`F`&       rewrite the envelope From field
25697 &`T`&       rewrite the envelope To field
25698 &`b`&       rewrite the &'Bcc:'& header
25699 &`c`&       rewrite the &'Cc:'& header
25700 &`f`&       rewrite the &'From:'& header
25701 &`h`&       rewrite all headers
25702 &`r`&       rewrite the &'Reply-To:'& header
25703 &`s`&       rewrite the &'Sender:'& header
25704 &`t`&       rewrite the &'To:'& header
25705 .endd
25706 "All headers" means all of the headers listed above that can be selected
25707 individually, plus their &'Resent-'& versions. It does not include
25708 other headers such as &'Subject:'& etc.
25709
25710 You should be particularly careful about rewriting &'Sender:'& headers, and
25711 restrict this to special known cases in your own domains.
25712
25713
25714 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25715 .cindex "SMTP" "rewriting malformed addresses"
25716 .cindex "RCPT" "rewriting argument of"
25717 .cindex "MAIL" "rewriting argument of"
25718 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25719 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25720 before any other processing; even before syntax checking. The pattern is
25721 required to be a regular expression, and it is matched against the whole of the
25722 data for the command, including any surrounding angle brackets.
25723
25724 .vindex "&$domain$&"
25725 .vindex "&$local_part$&"
25726 This form of rewrite rule allows for the handling of addresses that are not
25727 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25728 input). Because the input is not required to be a syntactically valid address,
25729 the variables &$local_part$& and &$domain$& are not available during the
25730 expansion of the replacement string. The result of rewriting replaces the
25731 original address in the MAIL or RCPT command.
25732
25733
25734 .section "Flags controlling the rewriting process" "SECID155"
25735 There are four flags which control the way the rewriting process works. These
25736 take effect only when a rule is invoked, that is, when the address is of the
25737 correct type (matches the flags) and matches the pattern:
25738
25739 .ilist
25740 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25741 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25742 absence of &"Q"& the rewritten address must always include a domain.
25743 .next
25744 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25745 even if no rewriting actually takes place because of a &"fail"& in the
25746 expansion. The &"q"& flag is not effective if the address is of the wrong type
25747 (does not match the flags) or does not match the pattern.
25748 .next
25749 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25750 address, up to ten times. It can be combined with the &"q"& flag, to stop
25751 rewriting once it fails to match (after at least one successful rewrite).
25752 .next
25753 .cindex "rewriting" "whole addresses"
25754 When an address in a header is rewritten, the rewriting normally applies only
25755 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25756 left unchanged. For example, rewriting might change
25757 .code
25758 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25759 .endd
25760 into
25761 .code
25762 From: Ford Prefect <prefectf@hitch.fict.example>
25763 .endd
25764 .cindex "RFC 2047"
25765 Sometimes there is a need to replace the whole address item, and this can be
25766 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25767 causes an address in a header line to be rewritten, the entire address is
25768 replaced, not just the working part. The replacement must be a complete RFC
25769 2822 address, including the angle brackets if necessary. If text outside angle
25770 brackets contains a character whose value is greater than 126 or less than 32
25771 (except for tab), the text is encoded according to RFC 2047. The character set
25772 is taken from &%headers_charset%&, which gets its default at build time.
25773
25774 When the &"w"& flag is set on a rule that causes an envelope address to be
25775 rewritten, all but the working part of the replacement address is discarded.
25776 .endlist
25777
25778
25779 .section "Rewriting examples" "SECID156"
25780 Here is an example of the two common rewriting paradigms:
25781 .code
25782 *@*.hitch.fict.example  $1@hitch.fict.example
25783 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25784                      {$value}fail}@hitch.fict.example bctfrF
25785 .endd
25786 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25787 the string expansion to fail if the lookup does not succeed. In this context it
25788 has the effect of leaving the original address unchanged, but Exim goes on to
25789 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25790 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25791 explicitly, which would cause the rewritten address to be the same as before,
25792 at the cost of a small bit of processing. Not supplying either of these is an
25793 error, since the rewritten address would then contain no local part.
25794
25795 The first example above replaces the domain with a superior, more general
25796 domain. This may not be desirable for certain local parts. If the rule
25797 .code
25798 root@*.hitch.fict.example  *
25799 .endd
25800 were inserted before the first rule, rewriting would be suppressed for the
25801 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25802
25803 Rewriting can be made conditional on a number of tests, by making use of
25804 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25805 messages that originate outside the local host:
25806 .code
25807 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25808                          {$1@hitch.fict.example}fail}"
25809 .endd
25810 The replacement string is quoted in this example because it contains white
25811 space.
25812
25813 .cindex "rewriting" "bang paths"
25814 .cindex "bang paths" "rewriting"
25815 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25816 an address it treats it as an unqualified local part which it qualifies with
25817 the local qualification domain (if the source of the message is local or if the
25818 remote host is permitted to send unqualified addresses). Rewriting can
25819 sometimes be used to handle simple bang paths with a fixed number of
25820 components. For example, the rule
25821 .code
25822 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25823 .endd
25824 rewrites a two-component bang path &'host.name!user'& as the domain address
25825 &'user@host.name'&. However, there is a security implication in using this as
25826 a global rewriting rule for envelope addresses. It can provide a backdoor
25827 method for using your system as a relay, because the incoming addresses appear
25828 to be local. If the bang path addresses are received via SMTP, it is safer to
25829 use the &"S"& flag to rewrite them as they are received, so that relay checking
25830 can be done on the rewritten addresses.
25831 .ecindex IIDaddrew
25832
25833
25834
25835
25836
25837 . ////////////////////////////////////////////////////////////////////////////
25838 . ////////////////////////////////////////////////////////////////////////////
25839
25840 .chapter "Retry configuration" "CHAPretry"
25841 .scindex IIDretconf1 "retry" "configuration, description of"
25842 .scindex IIDregconf2 "configuration file" "retry section"
25843 The &"retry"& section of the runtime configuration file contains a list of
25844 retry rules that control how often Exim tries to deliver messages that cannot
25845 be delivered at the first attempt. If there are no retry rules (the section is
25846 empty or not present), there are no retries. In this situation, temporary
25847 errors are treated as permanent. The default configuration contains a single,
25848 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25849 line option can be used to test which retry rule will be used for a given
25850 address, domain and error.
25851
25852 The most common cause of retries is temporary failure to deliver to a remote
25853 host because the host is down, or inaccessible because of a network problem.
25854 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25855 address) basis, not on a per-message basis. Thus, if one message has recently
25856 been delayed, delivery of a new message to the same host is not immediately
25857 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25858 log selector is set, the message
25859 .cindex "retry" "time not reached"
25860 &"retry time not reached"& is written to the main log whenever a delivery is
25861 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25862 the handling of errors during remote deliveries.
25863
25864 Retry processing applies to routing as well as to delivering, except as covered
25865 in the next paragraph. The retry rules do not distinguish between these
25866 actions. It is not possible, for example, to specify different behaviour for
25867 failures to route the domain &'snark.fict.example'& and failures to deliver to
25868 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25869 added complication, so did not implement it. However, although they share the
25870 same retry rule, the actual retry times for routing and transporting a given
25871 domain are maintained independently.
25872
25873 When a delivery is not part of a queue run (typically an immediate delivery on
25874 receipt of a message), the routers are always run, and local deliveries are
25875 always attempted, even if retry times are set for them. This makes for better
25876 behaviour if one particular message is causing problems (for example, causing
25877 quota overflow, or provoking an error in a filter file). If such a delivery
25878 suffers a temporary failure, the retry data is updated as normal, and
25879 subsequent delivery attempts from queue runs occur only when the retry time for
25880 the local address is reached.
25881
25882 .section "Changing retry rules" "SECID157"
25883 If you change the retry rules in your configuration, you should consider
25884 whether or not to delete the retry data that is stored in Exim's spool area in
25885 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25886 always safe; that is why they are called &"hints"&.
25887
25888 The hints retry data contains suggested retry times based on the previous
25889 rules. In the case of a long-running problem with a remote host, it might
25890 record the fact that the host has timed out. If your new rules increase the
25891 timeout time for such a host, you should definitely remove the old retry data
25892 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25893 messages that it should now be retaining.
25894
25895
25896
25897 .section "Format of retry rules" "SECID158"
25898 .cindex "retry" "rules"
25899 Each retry rule occupies one line and consists of three or four parts,
25900 separated by white space: a pattern, an error name, an optional list of sender
25901 addresses, and a list of retry parameters. The pattern and sender lists must be
25902 enclosed in double quotes if they contain white space. The rules are searched
25903 in order until one is found where the pattern, error name, and sender list (if
25904 present) match the failing host or address, the error that occurred, and the
25905 message's sender, respectively.
25906
25907
25908 The pattern is any single item that may appear in an address list (see section
25909 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25910 which means that it is expanded before being tested against the address that
25911 has been delayed. A negated address list item is permitted. Address
25912 list processing treats a plain domain name as if it were preceded by &"*@"&,
25913 which makes it possible for many retry rules to start with just a domain. For
25914 example,
25915 .code
25916 lookingglass.fict.example        *  F,24h,30m;
25917 .endd
25918 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25919 whereas
25920 .code
25921 alice@lookingglass.fict.example  *  F,24h,30m;
25922 .endd
25923 applies only to temporary failures involving the local part &%alice%&.
25924 In practice, almost all rules start with a domain name pattern without a local
25925 part.
25926
25927 .cindex "regular expressions" "in retry rules"
25928 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25929 must match a complete address, not just a domain, because that is how regular
25930 expressions work in address lists.
25931 .display
25932 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25933 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25934 .endd
25935
25936
25937 .section "Choosing which retry rule to use for address errors" "SECID159"
25938 When Exim is looking for a retry rule after a routing attempt has failed (for
25939 example, after a DNS timeout), each line in the retry configuration is tested
25940 against the complete address only if &%retry_use_local_part%& is set for the
25941 router. Otherwise, only the domain is used, except when matching against a
25942 regular expression, when the local part of the address is replaced with &"*"&.
25943 A domain on its own can match a domain pattern, or a pattern that starts with
25944 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25945 &%check_local_user%& is true, and false for other routers.
25946
25947 Similarly, when Exim is looking for a retry rule after a local delivery has
25948 failed (for example, after a mailbox full error), each line in the retry
25949 configuration is tested against the complete address only if
25950 &%retry_use_local_part%& is set for the transport (it defaults true for all
25951 local transports).
25952
25953 .cindex "4&'xx'& responses" "retry rules for"
25954 However, when Exim is looking for a retry rule after a remote delivery attempt
25955 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25956 whole address is always used as the key when searching the retry rules. The
25957 rule that is found is used to create a retry time for the combination of the
25958 failing address and the message's sender. It is the combination of sender and
25959 recipient that is delayed in subsequent queue runs until its retry time is
25960 reached. You can delay the recipient without regard to the sender by setting
25961 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25962 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25963 commands.
25964
25965
25966
25967 .section "Choosing which retry rule to use for host and message errors" &&&
25968          "SECID160"
25969 For a temporary error that is not related to an individual address (for
25970 example, a connection timeout), each line in the retry configuration is checked
25971 twice. First, the name of the remote host is used as a domain name (preceded by
25972 &"*@"& when matching a regular expression). If this does not match the line,
25973 the domain from the email address is tried in a similar fashion. For example,
25974 suppose the MX records for &'a.b.c.example'& are
25975 .code
25976 a.b.c.example  MX  5  x.y.z.example
25977                MX  6  p.q.r.example
25978                MX  7  m.n.o.example
25979 .endd
25980 and the retry rules are
25981 .code
25982 p.q.r.example    *      F,24h,30m;
25983 a.b.c.example    *      F,4d,45m;
25984 .endd
25985 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25986 first rule matches neither the host nor the domain, so Exim looks at the second
25987 rule. This does not match the host, but it does match the domain, so it is used
25988 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25989 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25990 first retry rule is used, because it matches the host.
25991
25992 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25993 first rule to determine retry times, but for all the other hosts for the domain
25994 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25995 routing to &'a.b.c.example'& suffers a temporary failure.
25996
25997 &*Note*&: The host name is used when matching the patterns, not its IP address.
25998 However, if a message is routed directly to an IP address without the use of a
25999 host name, for example, if a &(manualroute)& router contains a setting such as:
26000 .code
26001 route_list = *.a.example  192.168.34.23
26002 .endd
26003 then the &"host name"& that is used when searching for a retry rule is the
26004 textual form of the IP address.
26005
26006 .section "Retry rules for specific errors" "SECID161"
26007 .cindex "retry" "specific errors; specifying"
26008 The second field in a retry rule is the name of a particular error, or an
26009 asterisk, which matches any error. The errors that can be tested for are:
26010
26011 .vlist
26012 .vitem &%auth_failed%&
26013 Authentication failed when trying to send to a host in the
26014 &%hosts_require_auth%& list in an &(smtp)& transport.
26015
26016 .vitem &%data_4xx%&
26017 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26018 after the command, or after sending the message's data.
26019
26020 .vitem &%mail_4xx%&
26021 A 4&'xx'& error was received for an outgoing MAIL command.
26022
26023 .vitem &%rcpt_4xx%&
26024 A 4&'xx'& error was received for an outgoing RCPT command.
26025 .endlist
26026
26027 For the three 4&'xx'& errors, either the first or both of the x's can be given
26028 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26029 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26030 and have retries every ten minutes with a one-hour timeout, you could set up a
26031 retry rule of this form:
26032 .code
26033 the.domain.name  rcpt_452   F,1h,10m
26034 .endd
26035 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26036 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26037
26038 .vlist
26039 .vitem &%lost_connection%&
26040 A server unexpectedly closed the SMTP connection. There may, of course,
26041 legitimate reasons for this (host died, network died), but if it repeats a lot
26042 for the same host, it indicates something odd.
26043
26044 .vitem &%lookup%&
26045 A DNS lookup for a host failed.
26046 Note that a &%dnslookup%& router will need to have matched
26047 its &%fail_defer_domains%& option for this retry type to be usable.
26048 Also note that a &%manualroute%& router will probably need
26049 its &%host_find_failed%& option set to &%defer%&.
26050
26051 .vitem &%refused_MX%&
26052 A connection to a host obtained from an MX record was refused.
26053
26054 .vitem &%refused_A%&
26055 A connection to a host not obtained from an MX record was refused.
26056
26057 .vitem &%refused%&
26058 A connection was refused.
26059
26060 .vitem &%timeout_connect_MX%&
26061 A connection attempt to a host obtained from an MX record timed out.
26062
26063 .vitem &%timeout_connect_A%&
26064 A connection attempt to a host not obtained from an MX record timed out.
26065
26066 .vitem &%timeout_connect%&
26067 A connection attempt timed out.
26068
26069 .vitem &%timeout_MX%&
26070 There was a timeout while connecting or during an SMTP session with a host
26071 obtained from an MX record.
26072
26073 .vitem &%timeout_A%&
26074 There was a timeout while connecting or during an SMTP session with a host not
26075 obtained from an MX record.
26076
26077 .vitem &%timeout%&
26078 There was a timeout while connecting or during an SMTP session.
26079
26080 .vitem &%tls_required%&
26081 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26082 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26083 to STARTTLS, or there was a problem setting up the TLS connection.
26084
26085 .vitem &%quota%&
26086 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26087 transport.
26088
26089 .vitem &%quota_%&<&'time'&>
26090 .cindex "quota" "error testing in retry rule"
26091 .cindex "retry" "quota error testing"
26092 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26093 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26094 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26095 for four days.
26096 .endlist
26097
26098 .cindex "mailbox" "time of last read"
26099 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26100 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26101 it should be based on the last time that the user accessed the mailbox.
26102 However, it is not always possible to determine this. Exim uses the following
26103 heuristic rules:
26104
26105 .ilist
26106 If the mailbox is a single file, the time of last access (the &"atime"&) is
26107 used. As no new messages are being delivered (because the mailbox is over
26108 quota), Exim does not access the file, so this is the time of last user access.
26109 .next
26110 .cindex "maildir format" "time of last read"
26111 For a maildir delivery, the time of last modification of the &_new_&
26112 subdirectory is used. As the mailbox is over quota, no new files are created in
26113 the &_new_& subdirectory, because no new messages are being delivered. Any
26114 change to the &_new_& subdirectory is therefore assumed to be the result of an
26115 MUA moving a new message to the &_cur_& directory when it is first read. The
26116 time that is used is therefore the last time that the user read a new message.
26117 .next
26118 For other kinds of multi-file mailbox, the time of last access cannot be
26119 obtained, so a retry rule that uses this type of error field is never matched.
26120 .endlist
26121
26122 The quota errors apply both to system-enforced quotas and to Exim's own quota
26123 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26124 when a local delivery is deferred because a partition is full (the ENOSPC
26125 error).
26126
26127
26128
26129 .section "Retry rules for specified senders" "SECID162"
26130 .cindex "retry" "rules; sender-specific"
26131 You can specify retry rules that apply only when the failing message has a
26132 specific sender. In particular, this can be used to define retry rules that
26133 apply only to bounce messages. The third item in a retry rule can be of this
26134 form:
26135 .display
26136 &`senders=`&<&'address list'&>
26137 .endd
26138 The retry timings themselves are then the fourth item. For example:
26139 .code
26140 *   rcpt_4xx   senders=:   F,1h,30m
26141 .endd
26142 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26143 host. If the address list contains white space, it must be enclosed in quotes.
26144 For example:
26145 .code
26146 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26147 .endd
26148 &*Warning*&: This facility can be unhelpful if it is used for host errors
26149 (which do not depend on the recipient). The reason is that the sender is used
26150 only to match the retry rule. Once the rule has been found for a host error,
26151 its contents are used to set a retry time for the host, and this will apply to
26152 all messages, not just those with specific senders.
26153
26154 When testing retry rules using &%-brt%&, you can supply a sender using the
26155 &%-f%& command line option, like this:
26156 .code
26157 exim -f "" -brt user@dom.ain
26158 .endd
26159 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26160 list is never matched.
26161
26162
26163
26164
26165
26166 .section "Retry parameters" "SECID163"
26167 .cindex "retry" "parameters in rules"
26168 The third (or fourth, if a senders list is present) field in a retry rule is a
26169 sequence of retry parameter sets, separated by semicolons. Each set consists of
26170 .display
26171 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26172 .endd
26173 The letter identifies the algorithm for computing a new retry time; the cutoff
26174 time is the time beyond which this algorithm no longer applies, and the
26175 arguments vary the algorithm's action. The cutoff time is measured from the
26176 time that the first failure for the domain (combined with the local part if
26177 relevant) was detected, not from the time the message was received.
26178
26179 .cindex "retry" "algorithms"
26180 .cindex "retry" "fixed intervals"
26181 .cindex "retry" "increasing intervals"
26182 .cindex "retry" "random intervals"
26183 The available algorithms are:
26184
26185 .ilist
26186 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26187 the interval.
26188 .next
26189 &'G'&: retry at geometrically increasing intervals. The first argument
26190 specifies a starting value for the interval, and the second a multiplier, which
26191 is used to increase the size of the interval at each retry.
26192 .next
26193 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26194 retry, the previous interval is multiplied by the factor in order to get a
26195 maximum for the next interval. The minimum interval is the first argument of
26196 the parameter, and an actual interval is chosen randomly between them. Such a
26197 rule has been found to be helpful in cluster configurations when all the
26198 members of the cluster restart at once, and may therefore synchronize their
26199 queue processing times.
26200 .endlist
26201
26202 When computing the next retry time, the algorithm definitions are scanned in
26203 order until one whose cutoff time has not yet passed is reached. This is then
26204 used to compute a new retry time that is later than the current time. In the
26205 case of fixed interval retries, this simply means adding the interval to the
26206 current time. For geometrically increasing intervals, retry intervals are
26207 computed from the rule's parameters until one that is greater than the previous
26208 interval is found. The main configuration variable
26209 .cindex "limit" "retry interval"
26210 .cindex "retry" "interval, maximum"
26211 .oindex "&%retry_interval_max%&"
26212 &%retry_interval_max%& limits the maximum interval between retries. It
26213 cannot be set greater than &`24h`&, which is its default value.
26214
26215 A single remote domain may have a number of hosts associated with it, and each
26216 host may have more than one IP address. Retry algorithms are selected on the
26217 basis of the domain name, but are applied to each IP address independently. If,
26218 for example, a host has two IP addresses and one is unusable, Exim will
26219 generate retry times for it and will not try to use it until its next retry
26220 time comes. Thus the good IP address is likely to be tried first most of the
26221 time.
26222
26223 .cindex "hints database" "use for retrying"
26224 Retry times are hints rather than promises. Exim does not make any attempt to
26225 run deliveries exactly at the computed times. Instead, a queue runner process
26226 starts delivery processes for delayed messages periodically, and these attempt
26227 new deliveries only for those addresses that have passed their next retry time.
26228 If a new message arrives for a deferred address, an immediate delivery attempt
26229 occurs only if the address has passed its retry time. In the absence of new
26230 messages, the minimum time between retries is the interval between queue runner
26231 processes. There is not much point in setting retry times of five minutes if
26232 your queue runners happen only once an hour, unless there are a significant
26233 number of incoming messages (which might be the case on a system that is
26234 sending everything to a smart host, for example).
26235
26236 The data in the retry hints database can be inspected by using the
26237 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26238 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26239 &'exinext'& utility script can be used to find out what the next retry times
26240 are for the hosts associated with a particular mail domain, and also for local
26241 deliveries that have been deferred.
26242
26243
26244 .section "Retry rule examples" "SECID164"
26245 Here are some example retry rules:
26246 .code
26247 alice@wonderland.fict.example quota_5d  F,7d,3h
26248 wonderland.fict.example       quota_5d
26249 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26250 lookingglass.fict.example     *         F,24h,30m;
26251 *                 refused_A   F,2h,20m;
26252 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26253 .endd
26254 The first rule sets up special handling for mail to
26255 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26256 mailbox has not been read for at least 5 days. Retries continue every three
26257 hours for 7 days. The second rule handles over-quota errors for all other local
26258 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26259 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26260 fail are bounced immediately if the mailbox has not been read for at least 5
26261 days.
26262
26263 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26264 happen every 15 minutes for an hour, then with geometrically increasing
26265 intervals until two days have passed since a delivery first failed. After the
26266 first hour there is a delay of one hour, then two hours, then four hours, and
26267 so on (this is a rather extreme example).
26268
26269 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26270 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26271 all other domains, with special action for connection refusal from hosts that
26272 were not obtained from an MX record.
26273
26274 The final rule in a retry configuration should always have asterisks in the
26275 first two fields so as to provide a general catch-all for any addresses that do
26276 not have their own special handling. This example tries every 15 minutes for 2
26277 hours, then with intervals starting at one hour and increasing by a factor of
26278 1.5 up to 16 hours, then every 8 hours up to 5 days.
26279
26280
26281
26282 .section "Timeout of retry data" "SECID165"
26283 .cindex "timeout" "of retry data"
26284 .oindex "&%retry_data_expire%&"
26285 .cindex "hints database" "data expiry"
26286 .cindex "retry" "timeout of data"
26287 Exim timestamps the data that it writes to its retry hints database. When it
26288 consults the data during a delivery it ignores any that is older than the value
26289 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26290 been tried for 7 days, Exim will try to deliver to it immediately a message
26291 arrives, and if that fails, it will calculate a retry time as if it were
26292 failing for the first time.
26293
26294 This improves the behaviour for messages routed to rarely-used hosts such as MX
26295 backups. If such a host was down at one time, and happens to be down again when
26296 Exim tries a month later, using the old retry data would imply that it had been
26297 down all the time, which is not a justified assumption.
26298
26299 If a host really is permanently dead, this behaviour causes a burst of retries
26300 every now and again, but only if messages routed to it are rare. If there is a
26301 message at least once every 7 days the retry data never expires.
26302
26303
26304
26305
26306 .section "Long-term failures" "SECID166"
26307 .cindex "delivery failure, long-term"
26308 .cindex "retry" "after long-term failure"
26309 Special processing happens when an email address has been failing for so long
26310 that the cutoff time for the last algorithm is reached. For example, using the
26311 default retry rule:
26312 .code
26313 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26314 .endd
26315 the cutoff time is four days. Reaching the retry cutoff is independent of how
26316 long any specific message has been failing; it is the length of continuous
26317 failure for the recipient address that counts.
26318
26319 When the cutoff time is reached for a local delivery, or for all the IP
26320 addresses associated with a remote delivery, a subsequent delivery failure
26321 causes Exim to give up on the address, and a bounce message is generated.
26322 In order to cater for new messages that use the failing address, a next retry
26323 time is still computed from the final algorithm, and is used as follows:
26324
26325 For local deliveries, one delivery attempt is always made for any subsequent
26326 messages. If this delivery fails, the address fails immediately. The
26327 post-cutoff retry time is not used.
26328
26329 .cindex "final cutoff" "retries, controlling"
26330 .cindex retry "final cutoff"
26331 If the delivery is remote, there are two possibilities, controlled by the
26332 .oindex "&%delay_after_cutoff%&"
26333 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26334 default. Until the post-cutoff retry time for one of the IP addresses,
26335 as set by the &%retry_data_expire%& option, is
26336 reached, the failing email address is bounced immediately, without a delivery
26337 attempt taking place. After that time, one new delivery attempt is made to
26338 those IP addresses that are past their retry times, and if that still fails,
26339 the address is bounced and new retry times are computed.
26340
26341 In other words, when all the hosts for a given email address have been failing
26342 for a long time, Exim bounces rather then defers until one of the hosts' retry
26343 times is reached. Then it tries once, and bounces if that attempt fails. This
26344 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26345 to a broken destination, but if the host does recover, Exim will eventually
26346 notice.
26347
26348 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26349 addresses are past their final cutoff time, Exim tries to deliver to those IP
26350 addresses that have not been tried since the message arrived. If there are
26351 no suitable IP addresses, or if they all fail, the address is bounced. In other
26352 words, it does not delay when a new message arrives, but tries the expired
26353 addresses immediately, unless they have been tried since the message arrived.
26354 If there is a continuous stream of messages for the failing domains, setting
26355 &%delay_after_cutoff%& false means that there will be many more attempts to
26356 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26357 true.
26358
26359 .section "Deliveries that work intermittently" "SECID167"
26360 .cindex "retry" "intermittently working deliveries"
26361 Some additional logic is needed to cope with cases where a host is
26362 intermittently available, or when a message has some attribute that prevents
26363 its delivery when others to the same address get through. In this situation,
26364 because some messages are successfully delivered, the &"retry clock"& for the
26365 host or address keeps getting reset by the successful deliveries, and so
26366 failing messages remain in the queue for ever because the cutoff time is never
26367 reached.
26368
26369 Two exceptional actions are applied to prevent this happening. The first
26370 applies to errors that are related to a message rather than a remote host.
26371 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26372 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26373 commands, and quota failures. For this type of error, if a message's arrival
26374 time is earlier than the &"first failed"& time for the error, the earlier time
26375 is used when scanning the retry rules to decide when to try next and when to
26376 time out the address.
26377
26378 The exceptional second action applies in all cases. If a message has been on
26379 the queue for longer than the cutoff time of any applicable retry rule for a
26380 given address, a delivery is attempted for that address, even if it is not yet
26381 time, and if this delivery fails, the address is timed out. A new retry time is
26382 not computed in this case, so that other messages for the same address are
26383 considered immediately.
26384 .ecindex IIDretconf1
26385 .ecindex IIDregconf2
26386
26387
26388
26389
26390
26391
26392 . ////////////////////////////////////////////////////////////////////////////
26393 . ////////////////////////////////////////////////////////////////////////////
26394
26395 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26396 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26397 .scindex IIDauthconf2 "authentication"
26398 The &"authenticators"& section of Exim's runtime configuration is concerned
26399 with SMTP authentication. This facility is an extension to the SMTP protocol,
26400 described in RFC 2554, which allows a client SMTP host to authenticate itself
26401 to a server. This is a common way for a server to recognize clients that are
26402 permitted to use it as a relay. SMTP authentication is not of relevance to the
26403 transfer of mail between servers that have no managerial connection with each
26404 other.
26405
26406 .cindex "AUTH" "description of"
26407 Very briefly, the way SMTP authentication works is as follows:
26408
26409 .ilist
26410 The server advertises a number of authentication &'mechanisms'& in response to
26411 the client's EHLO command.
26412 .next
26413 The client issues an AUTH command, naming a specific mechanism. The command
26414 may, optionally, contain some authentication data.
26415 .next
26416 The server may issue one or more &'challenges'&, to which the client must send
26417 appropriate responses. In simple authentication mechanisms, the challenges are
26418 just prompts for user names and passwords. The server does not have to issue
26419 any challenges &-- in some mechanisms the relevant data may all be transmitted
26420 with the AUTH command.
26421 .next
26422 The server either accepts or denies authentication.
26423 .next
26424 If authentication succeeds, the client may optionally make use of the AUTH
26425 option on the MAIL command to pass an authenticated sender in subsequent
26426 mail transactions. Authentication lasts for the remainder of the SMTP
26427 connection.
26428 .next
26429 If authentication fails, the client may give up, or it may try a different
26430 authentication mechanism, or it may try transferring mail over the
26431 unauthenticated connection.
26432 .endlist
26433
26434 If you are setting up a client, and want to know which authentication
26435 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26436 SMTP port) on the server, and issue an EHLO command. The response to this
26437 includes the list of supported mechanisms. For example:
26438 .display
26439 &`$ `&&*&`telnet server.example 25`&*&
26440 &`Trying 192.168.34.25...`&
26441 &`Connected to server.example.`&
26442 &`Escape character is &#x0027;^]&#x0027;.`&
26443 &`220 server.example ESMTP Exim 4.20 ...`&
26444 &*&`ehlo client.example`&*&
26445 &`250-server.example Hello client.example [10.8.4.5]`&
26446 &`250-SIZE 52428800`&
26447 &`250-PIPELINING`&
26448 &`250-AUTH PLAIN`&
26449 &`250 HELP`&
26450 .endd
26451 The second-last line of this example output shows that the server supports
26452 authentication using the PLAIN mechanism. In Exim, the different authentication
26453 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26454 routers and transports, which authenticators are included in the binary is
26455 controlled by build-time definitions. The following are currently available,
26456 included by setting
26457 .code
26458 AUTH_CRAM_MD5=yes
26459 AUTH_CYRUS_SASL=yes
26460 AUTH_DOVECOT=yes
26461 AUTH_EXTERNAL=yes
26462 AUTH_GSASL=yes
26463 AUTH_HEIMDAL_GSSAPI=yes
26464 AUTH_PLAINTEXT=yes
26465 AUTH_SPA=yes
26466 AUTH_TLS=yes
26467 .endd
26468 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26469 authentication mechanism (RFC 2195), and the second provides an interface to
26470 the Cyrus SASL authentication library.
26471 The third is an interface to Dovecot's authentication system, delegating the
26472 work via a socket interface.
26473 .new
26474 The fourth provides for negotiation of authentication done via non-SMTP means,
26475 as defined by RFC 4422 Appendix A.
26476 .wen
26477 The fifth provides an interface to the GNU SASL authentication library, which
26478 provides mechanisms but typically not data sources.
26479 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26480 supporting setting a server keytab.
26481 The seventh can be configured to support
26482 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26483 not formally documented, but used by several MUAs.
26484 The eighth authenticator
26485 supports Microsoft's &'Secure Password Authentication'& mechanism.
26486 The last is an Exim authenticator but not an SMTP one;
26487 instead it can use information from a TLS negotiation.
26488
26489 The authenticators are configured using the same syntax as other drivers (see
26490 section &<<SECTfordricon>>&). If no authenticators are required, no
26491 authentication section need be present in the configuration file. Each
26492 authenticator can in principle have both server and client functions. When Exim
26493 is receiving SMTP mail, it is acting as a server; when it is sending out
26494 messages over SMTP, it is acting as a client. Authenticator configuration
26495 options are provided for use in both these circumstances.
26496
26497 To make it clear which options apply to which situation, the prefixes
26498 &%server_%& and &%client_%& are used on option names that are specific to
26499 either the server or the client function, respectively. Server and client
26500 functions are disabled if none of their options are set. If an authenticator is
26501 to be used for both server and client functions, a single definition, using
26502 both sets of options, is required. For example:
26503 .code
26504 cram:
26505   driver = cram_md5
26506   public_name = CRAM-MD5
26507   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26508   client_name = ph10
26509   client_secret = secret2
26510 .endd
26511 The &%server_%& option is used when Exim is acting as a server, and the
26512 &%client_%& options when it is acting as a client.
26513
26514 Descriptions of the individual authenticators are given in subsequent chapters.
26515 The remainder of this chapter covers the generic options for the
26516 authenticators, followed by general discussion of the way authentication works
26517 in Exim.
26518
26519 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26520 per-mechanism basis.  Please read carefully to determine which variables hold
26521 account labels such as usercodes and which hold passwords or other
26522 authenticating data.
26523
26524 Note that some mechanisms support two different identifiers for accounts: the
26525 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26526 and &'authz'& are commonly encountered.  The American spelling is standard here.
26527 Conceptually, authentication data such as passwords are tied to the identifier
26528 used to authenticate; servers may have rules to permit one user to act as a
26529 second user, so that after login the session is treated as though that second
26530 user had logged in.  That second user is the &'authorization id'&.  A robust
26531 configuration might confirm that the &'authz'& field is empty or matches the
26532 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26533 as verified data, the &'authz'& as an unverified request which the server might
26534 choose to honour.
26535
26536 A &'realm'& is a text string, typically a domain name, presented by a server
26537 to a client to help it select an account and credentials to use.  In some
26538 mechanisms, the client and server provably agree on the realm, but clients
26539 typically can not treat the realm as secure data to be blindly trusted.
26540
26541
26542
26543 .section "Generic options for authenticators" "SECID168"
26544 .cindex "authentication" "generic options"
26545 .cindex "options" "generic; for authenticators"
26546
26547 .option client_condition authenticators string&!! unset
26548 When Exim is authenticating as a client, it skips any authenticator whose
26549 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26550 used, for example, to skip plain text authenticators when the connection is not
26551 encrypted by a setting such as:
26552 .code
26553 client_condition = ${if !eq{$tls_out_cipher}{}}
26554 .endd
26555
26556
26557 .option client_set_id authenticators string&!! unset
26558 When client authentication succeeds, this condition is expanded; the
26559 result is used in the log lines for outbound messages.
26560 Typically it will be the user name used for authentication.
26561
26562
26563 .option driver authenticators string unset
26564 This option must always be set. It specifies which of the available
26565 authenticators is to be used.
26566
26567
26568 .option public_name authenticators string unset
26569 This option specifies the name of the authentication mechanism that the driver
26570 implements, and by which it is known to the outside world. These names should
26571 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26572 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26573 defaults to the driver's instance name.
26574
26575
26576 .option server_advertise_condition authenticators string&!! unset
26577 When a server is about to advertise an authentication mechanism, the condition
26578 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26579 mechanism is not advertised.
26580 If the expansion fails, the mechanism is not advertised. If the failure was not
26581 forced, and was not caused by a lookup defer, the incident is logged.
26582 See section &<<SECTauthexiser>>& below for further discussion.
26583
26584
26585 .option server_condition authenticators string&!! unset
26586 This option must be set for a &%plaintext%& server authenticator, where it
26587 is used directly to control authentication. See section &<<SECTplainserver>>&
26588 for details.
26589
26590 For the &(gsasl)& authenticator, this option is required for various
26591 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26592
26593 For the other authenticators, &%server_condition%& can be used as an additional
26594 authentication or authorization mechanism that is applied after the other
26595 authenticator conditions succeed. If it is set, it is expanded when the
26596 authenticator would otherwise return a success code. If the expansion is forced
26597 to fail, authentication fails. Any other expansion failure causes a temporary
26598 error code to be returned. If the result of a successful expansion is an empty
26599 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26600 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26601 other result, a temporary error code is returned, with the expanded string as
26602 the error text.
26603
26604
26605 .option server_debug_print authenticators string&!! unset
26606 If this option is set and authentication debugging is enabled (see the &%-d%&
26607 command line option), the string is expanded and included in the debugging
26608 output when the authenticator is run as a server. This can help with checking
26609 out the values of variables.
26610 If expansion of the string fails, the error message is written to the debugging
26611 output, and Exim carries on processing.
26612
26613
26614 .option server_set_id authenticators string&!! unset
26615 .vindex "&$authenticated_id$&"
26616 .vindex "&$authenticated_fail_id$&"
26617 When an Exim server successfully authenticates a client, this string is
26618 expanded using data from the authentication, and preserved for any incoming
26619 messages in the variable &$authenticated_id$&. It is also included in the log
26620 lines for incoming messages. For example, a user/password authenticator
26621 configuration might preserve the user name that was used to authenticate, and
26622 refer to it subsequently during delivery of the message.
26623 On a failing authentication the expansion result is instead saved in
26624 the &$authenticated_fail_id$& variable.
26625 If expansion fails, the option is ignored.
26626
26627
26628 .option server_mail_auth_condition authenticators string&!! unset
26629 This option allows a server to discard authenticated sender addresses supplied
26630 as part of MAIL commands in SMTP connections that are authenticated by the
26631 driver on which &%server_mail_auth_condition%& is set. The option is not used
26632 as part of the authentication process; instead its (unexpanded) value is
26633 remembered for later use.
26634 How it is used is described in the following section.
26635
26636
26637
26638
26639
26640 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26641 .cindex "authentication" "sender; authenticated"
26642 .cindex "AUTH" "on MAIL command"
26643 When a client supplied an AUTH= item on a MAIL command, Exim applies
26644 the following checks before accepting it as the authenticated sender of the
26645 message:
26646
26647 .ilist
26648 If the connection is not using extended SMTP (that is, HELO was used rather
26649 than EHLO), the use of AUTH= is a syntax error.
26650 .next
26651 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26652 .next
26653 .vindex "&$authenticated_sender$&"
26654 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26655 running, the value of &$authenticated_sender$& is set to the value obtained
26656 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26657 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26658 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26659 given for the MAIL command.
26660 .next
26661 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26662 is accepted and placed in &$authenticated_sender$& only if the client has
26663 authenticated.
26664 .next
26665 If the AUTH= value was accepted by either of the two previous rules, and
26666 the client has authenticated, and the authenticator has a setting for the
26667 &%server_mail_auth_condition%&, the condition is checked at this point. The
26668 valued that was saved from the authenticator is expanded. If the expansion
26669 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26670 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26671 the value of &$authenticated_sender$& is retained and passed on with the
26672 message.
26673 .endlist
26674
26675
26676 When &$authenticated_sender$& is set for a message, it is passed on to other
26677 hosts to which Exim authenticates as a client. Do not confuse this value with
26678 &$authenticated_id$&, which is a string obtained from the authentication
26679 process, and which is not usually a complete email address.
26680
26681 .vindex "&$sender_address$&"
26682 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26683 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26684 therefore make use of &$authenticated_sender$&. The converse is not true: the
26685 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26686 ACL is run.
26687
26688
26689
26690 .section "Authentication on an Exim server" "SECTauthexiser"
26691 .cindex "authentication" "on an Exim server"
26692 When Exim receives an EHLO command, it advertises the public names of those
26693 authenticators that are configured as servers, subject to the following
26694 conditions:
26695
26696 .ilist
26697 The client host must match &%auth_advertise_hosts%& (default *).
26698 .next
26699 It the &%server_advertise_condition%& option is set, its expansion must not
26700 yield the empty string, &"0"&, &"no"&, or &"false"&.
26701 .endlist
26702
26703 The order in which the authenticators are defined controls the order in which
26704 the mechanisms are advertised.
26705
26706 Some mail clients (for example, some versions of Netscape) require the user to
26707 provide a name and password for authentication whenever AUTH is advertised,
26708 even though authentication may not in fact be needed (for example, Exim may be
26709 set up to allow unconditional relaying from the client by an IP address check).
26710 You can make such clients more friendly by not advertising AUTH to them.
26711 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26712 that runs for RCPT) to relay without authentication, you should set
26713 .code
26714 auth_advertise_hosts = ! 10.9.8.0/24
26715 .endd
26716 so that no authentication mechanisms are advertised to them.
26717
26718 The &%server_advertise_condition%& controls the advertisement of individual
26719 authentication mechanisms. For example, it can be used to restrict the
26720 advertisement of a particular mechanism to encrypted connections, by a setting
26721 such as:
26722 .code
26723 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26724 .endd
26725 .vindex "&$tls_in_cipher$&"
26726 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26727 yields &"yes"&, which allows the advertisement to happen.
26728
26729 When an Exim server receives an AUTH command from a client, it rejects it
26730 immediately if AUTH was not advertised in response to an earlier EHLO
26731 command. This is the case if
26732
26733 .ilist
26734 The client host does not match &%auth_advertise_hosts%&; or
26735 .next
26736 No authenticators are configured with server options; or
26737 .next
26738 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26739 server authenticators.
26740 .endlist
26741
26742
26743 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26744 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26745 AUTH is accepted from any client host.
26746
26747 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26748 server authentication mechanism that was advertised in response to EHLO and
26749 that matches the one named in the AUTH command. If it finds one, it runs
26750 the appropriate authentication protocol, and authentication either succeeds or
26751 fails. If there is no matching advertised mechanism, the AUTH command is
26752 rejected with a 504 error.
26753
26754 .vindex "&$received_protocol$&"
26755 .vindex "&$sender_host_authenticated$&"
26756 When a message is received from an authenticated host, the value of
26757 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26758 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26759 public name) of the authenticator driver that successfully authenticated the
26760 client from which the message was received. This variable is empty if there was
26761 no successful authentication.
26762
26763 .cindex authentication "expansion item"
26764 Successful authentication sets up information used by the
26765 &%authresults%& expansion item.
26766
26767
26768
26769
26770 .section "Testing server authentication" "SECID169"
26771 .cindex "authentication" "testing a server"
26772 .cindex "AUTH" "testing a server"
26773 .cindex "base64 encoding" "creating authentication test data"
26774 Exim's &%-bh%& option can be useful for testing server authentication
26775 configurations. The data for the AUTH command has to be sent using base64
26776 encoding. A quick way to produce such data for testing is the following Perl
26777 script:
26778 .code
26779 use MIME::Base64;
26780 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26781 .endd
26782 .cindex "binary zero" "in authentication data"
26783 This interprets its argument as a Perl string, and then encodes it. The
26784 interpretation as a Perl string allows binary zeros, which are required for
26785 some kinds of authentication, to be included in the data. For example, a
26786 command line to run this script on such data might be
26787 .code
26788 encode '\0user\0password'
26789 .endd
26790 Note the use of single quotes to prevent the shell interpreting the
26791 backslashes, so that they can be interpreted by Perl to specify characters
26792 whose code value is zero.
26793
26794 &*Warning 1*&: If either of the user or password strings starts with an octal
26795 digit, you must use three zeros instead of one after the leading backslash. If
26796 you do not, the octal digit that starts your string will be incorrectly
26797 interpreted as part of the code for the first character.
26798
26799 &*Warning 2*&: If there are characters in the strings that Perl interprets
26800 specially, you must use a Perl escape to prevent them being misinterpreted. For
26801 example, a command such as
26802 .code
26803 encode '\0user@domain.com\0pas$$word'
26804 .endd
26805 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26806
26807 If you have the &%mimencode%& command installed, another way to do produce
26808 base64-encoded strings is to run the command
26809 .code
26810 echo -e -n `\0user\0password' | mimencode
26811 .endd
26812 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26813 in the argument, and the &%-n%& option specifies no newline at the end of its
26814 output. However, not all versions of &%echo%& recognize these options, so you
26815 should check your version before relying on this suggestion.
26816
26817
26818
26819 .section "Authentication by an Exim client" "SECID170"
26820 .cindex "authentication" "on an Exim client"
26821 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26822 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26823 announces support for authentication, and the host matches an entry in either
26824 of these options, Exim (as a client) tries to authenticate as follows:
26825
26826 .ilist
26827 For each authenticator that is configured as a client, in the order in which
26828 they are defined in the configuration, it searches the authentication
26829 mechanisms announced by the server for one whose name matches the public name
26830 of the authenticator.
26831 .next
26832 .vindex "&$host$&"
26833 .vindex "&$host_address$&"
26834 When it finds one that matches, it runs the authenticator's client code. The
26835 variables &$host$& and &$host_address$& are available for any string expansions
26836 that the client might do. They are set to the server's name and IP address. If
26837 any expansion is forced to fail, the authentication attempt is abandoned, and
26838 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26839 delivery to be deferred.
26840 .next
26841 If the result of the authentication attempt is a temporary error or a timeout,
26842 Exim abandons trying to send the message to the host for the moment. It will
26843 try again later. If there are any backup hosts available, they are tried in the
26844 usual way.
26845 .next
26846 If the response to authentication is a permanent error (5&'xx'& code), Exim
26847 carries on searching the list of authenticators and tries another one if
26848 possible. If all authentication attempts give permanent errors, or if there are
26849 no attempts because no mechanisms match (or option expansions force failure),
26850 what happens depends on whether the host matches &%hosts_require_auth%& or
26851 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26852 delivery is deferred. The error can be detected in the retry rules, and thereby
26853 turned into a permanent error if you wish. In the second case, Exim tries to
26854 deliver the message unauthenticated.
26855 .endlist
26856
26857 Note that the hostlist test for whether to do authentication can be
26858 confused if name-IP lookups change between the time the peer is decided
26859 upon and the time that the transport runs.  For example, with a manualroute
26860 router given a host name, and with DNS "round-robin" used by that name: if
26861 the local resolver cache times out between the router and the transport
26862 running, the transport may get an IP for the name for its authentication
26863 check which does not match the connection peer IP.
26864 No authentication will then be done, despite the names being identical.
26865
26866 For such cases use a separate transport which always authenticates.
26867
26868 .cindex "AUTH" "on MAIL command"
26869 When Exim has authenticated itself to a remote server, it adds the AUTH
26870 parameter to the MAIL commands it sends, if it has an authenticated sender for
26871 the message. If the message came from a remote host, the authenticated sender
26872 is the one that was receiving on an incoming MAIL command, provided that the
26873 incoming connection was authenticated and the &%server_mail_auth%& condition
26874 allowed the authenticated sender to be retained. If a local process calls Exim
26875 to send a message, the sender address that is built from the login name and
26876 &%qualify_domain%& is treated as authenticated. However, if the
26877 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26878 the authenticated sender that was received with the message.
26879 .ecindex IIDauthconf1
26880 .ecindex IIDauthconf2
26881
26882
26883
26884
26885
26886
26887 . ////////////////////////////////////////////////////////////////////////////
26888 . ////////////////////////////////////////////////////////////////////////////
26889
26890 .chapter "The plaintext authenticator" "CHAPplaintext"
26891 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26892 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26893 The &(plaintext)& authenticator can be configured to support the PLAIN and
26894 LOGIN authentication mechanisms, both of which transfer authentication data as
26895 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26896 security risk; you are strongly advised to insist on the use of SMTP encryption
26897 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26898 use unencrypted plain text, you should not use the same passwords for SMTP
26899 connections as you do for login accounts.
26900
26901 .section "Plaintext options" "SECID171"
26902 .cindex "options" "&(plaintext)& authenticator (server)"
26903 When configured as a server, &(plaintext)& uses the following options:
26904
26905 .option server_condition authenticators string&!! unset
26906 This is actually a global authentication option, but it must be set in order to
26907 configure the &(plaintext)& driver as a server. Its use is described below.
26908
26909 .option server_prompts plaintext string&!! unset
26910 The contents of this option, after expansion, must be a colon-separated list of
26911 prompt strings. If expansion fails, a temporary authentication rejection is
26912 given.
26913
26914 .section "Using plaintext in a server" "SECTplainserver"
26915 .cindex "AUTH" "in &(plaintext)& authenticator"
26916 .cindex "binary zero" "in &(plaintext)& authenticator"
26917 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26918         "in &(plaintext)& authenticator"
26919 .vindex "&$auth1$&, &$auth2$&, etc"
26920 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26921
26922 When running as a server, &(plaintext)& performs the authentication test by
26923 expanding a string. The data sent by the client with the AUTH command, or in
26924 response to subsequent prompts, is base64 encoded, and so may contain any byte
26925 values when decoded. If any data is supplied with the command, it is treated as
26926 a list of strings, separated by NULs (binary zeros), the first three of which
26927 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26928 (neither LOGIN nor PLAIN uses more than three strings).
26929
26930 For compatibility with previous releases of Exim, the values are also placed in
26931 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26932 variables for this purpose is now deprecated, as it can lead to confusion in
26933 string expansions that also use them for other things.
26934
26935 If there are more strings in &%server_prompts%& than the number of strings
26936 supplied with the AUTH command, the remaining prompts are used to obtain more
26937 data. Each response from the client may be a list of NUL-separated strings.
26938
26939 .vindex "&$authenticated_id$&"
26940 Once a sufficient number of data strings have been received,
26941 &%server_condition%& is expanded. If the expansion is forced to fail,
26942 authentication fails. Any other expansion failure causes a temporary error code
26943 to be returned. If the result of a successful expansion is an empty string,
26944 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26945 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26946 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26947 For any other result, a temporary error code is returned, with the expanded
26948 string as the error text.
26949
26950 &*Warning*&: If you use a lookup in the expansion to find the user's
26951 password, be sure to make the authentication fail if the user is unknown.
26952 There are good and bad examples at the end of the next section.
26953
26954
26955
26956 .section "The PLAIN authentication mechanism" "SECID172"
26957 .cindex "PLAIN authentication mechanism"
26958 .cindex "authentication" "PLAIN mechanism"
26959 .cindex "binary zero" "in &(plaintext)& authenticator"
26960 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26961 sent as one item of data (that is, one combined string containing two NUL
26962 separators). The data is sent either as part of the AUTH command, or
26963 subsequently in response to an empty prompt from the server.
26964
26965 The second and third strings are a user name and a corresponding password.
26966 Using a single fixed user name and password as an example, this could be
26967 configured as follows:
26968 .code
26969 fixed_plain:
26970   driver = plaintext
26971   public_name = PLAIN
26972   server_prompts = :
26973   server_condition = \
26974     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26975   server_set_id = $auth2
26976 .endd
26977 Note that the default result strings from &%if%& (&"true"& or an empty string)
26978 are exactly what we want here, so they need not be specified. Obviously, if the
26979 password contains expansion-significant characters such as dollar, backslash,
26980 or closing brace, they have to be escaped.
26981
26982 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26983 the end of a string list are ignored). If all the data comes as part of the
26984 AUTH command, as is commonly the case, the prompt is not used. This
26985 authenticator is advertised in the response to EHLO as
26986 .code
26987 250-AUTH PLAIN
26988 .endd
26989 and a client host can authenticate itself by sending the command
26990 .code
26991 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26992 .endd
26993 As this contains three strings (more than the number of prompts), no further
26994 data is required from the client. Alternatively, the client may just send
26995 .code
26996 AUTH PLAIN
26997 .endd
26998 to initiate authentication, in which case the server replies with an empty
26999 prompt. The client must respond with the combined data string.
27000
27001 The data string is base64 encoded, as required by the RFC. This example,
27002 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27003 represents a zero byte. This is split up into three strings, the first of which
27004 is empty. The &%server_condition%& option in the authenticator checks that the
27005 second two are &`username`& and &`mysecret`& respectively.
27006
27007 Having just one fixed user name and password, as in this example, is not very
27008 realistic, though for a small organization with only a handful of
27009 authenticating clients it could make sense.
27010
27011 A more sophisticated instance of this authenticator could use the user name in
27012 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27013 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27014 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27015 This is an incorrect example:
27016 .code
27017 server_condition = \
27018   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27019 .endd
27020 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27021 which it then compares to the supplied password (&$auth3$&). Why is this example
27022 incorrect? It works fine for existing users, but consider what happens if a
27023 non-existent user name is given. The lookup fails, but as no success/failure
27024 strings are given for the lookup, it yields an empty string. Thus, to defeat
27025 the authentication, all a client has to do is to supply a non-existent user
27026 name and an empty password. The correct way of writing this test is:
27027 .code
27028 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27029   {${if eq{$value}{$auth3}}} {false}}
27030 .endd
27031 In this case, if the lookup succeeds, the result is checked; if the lookup
27032 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27033 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27034 always fails if its second argument is empty. However, the second way of
27035 writing the test makes the logic clearer.
27036
27037
27038 .section "The LOGIN authentication mechanism" "SECID173"
27039 .cindex "LOGIN authentication mechanism"
27040 .cindex "authentication" "LOGIN mechanism"
27041 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27042 in a number of programs. No data is sent with the AUTH command. Instead, a
27043 user name and password are supplied separately, in response to prompts. The
27044 plaintext authenticator can be configured to support this as in this example:
27045 .code
27046 fixed_login:
27047   driver = plaintext
27048   public_name = LOGIN
27049   server_prompts = User Name : Password
27050   server_condition = \
27051     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27052   server_set_id = $auth1
27053 .endd
27054 Because of the way plaintext operates, this authenticator accepts data supplied
27055 with the AUTH command (in contravention of the specification of LOGIN), but
27056 if the client does not supply it (as is the case for LOGIN clients), the prompt
27057 strings are used to obtain two data items.
27058
27059 Some clients are very particular about the precise text of the prompts. For
27060 example, Outlook Express is reported to recognize only &"Username:"& and
27061 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27062 strings. It uses the &%ldapauth%& expansion condition to check the user
27063 name and password by binding to an LDAP server:
27064 .code
27065 login:
27066   driver = plaintext
27067   public_name = LOGIN
27068   server_prompts = Username:: : Password::
27069   server_condition = ${if and{{ \
27070     !eq{}{$auth1} }{ \
27071     ldapauth{\
27072       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27073       pass=${quote:$auth2} \
27074       ldap://ldap.example.org/} }} }
27075   server_set_id = uid=$auth1,ou=people,o=example.org
27076 .endd
27077 We have to check that the username is not empty before using it, because LDAP
27078 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27079 operator to correctly quote the DN for authentication. However, the basic
27080 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27081 correct one to use for the password, because quoting is needed only to make
27082 the password conform to the Exim syntax. At the LDAP level, the password is an
27083 uninterpreted string.
27084
27085
27086 .section "Support for different kinds of authentication" "SECID174"
27087 A number of string expansion features are provided for the purpose of
27088 interfacing to different ways of user authentication. These include checking
27089 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27090 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27091 &<<SECTexpcond>>&.
27092
27093
27094
27095
27096 .section "Using plaintext in a client" "SECID175"
27097 .cindex "options" "&(plaintext)& authenticator (client)"
27098 The &(plaintext)& authenticator has two client options:
27099
27100 .option client_ignore_invalid_base64 plaintext boolean false
27101 If the client receives a server prompt that is not a valid base64 string,
27102 authentication is abandoned by default. However, if this option is set true,
27103 the error in the challenge is ignored and the client sends the response as
27104 usual.
27105
27106 .option client_send plaintext string&!! unset
27107 The string is a colon-separated list of authentication data strings. Each
27108 string is independently expanded before being sent to the server. The first
27109 string is sent with the AUTH command; any more strings are sent in response
27110 to prompts from the server. Before each string is expanded, the value of the
27111 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27112 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27113 way. Thus, the prompt that is received in response to sending the first string
27114 (with the AUTH command) can be used in the expansion of the second string, and
27115 so on. If an invalid base64 string is received when
27116 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27117 &$auth$&<&'n'&> variable.
27118
27119 &*Note*&: You cannot use expansion to create multiple strings, because
27120 splitting takes priority and happens first.
27121
27122 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27123 the data, further processing is applied to each string before it is sent. If
27124 there are any single circumflex characters in the string, they are converted to
27125 NULs. Should an actual circumflex be required as data, it must be doubled in
27126 the string.
27127
27128 This is an example of a client configuration that implements the PLAIN
27129 authentication mechanism with a fixed user name and password:
27130 .code
27131 fixed_plain:
27132   driver = plaintext
27133   public_name = PLAIN
27134   client_send = ^username^mysecret
27135 .endd
27136 The lack of colons means that the entire text is sent with the AUTH
27137 command, with the circumflex characters converted to NULs. A similar example
27138 that uses the LOGIN mechanism is:
27139 .code
27140 fixed_login:
27141   driver = plaintext
27142   public_name = LOGIN
27143   client_send = : username : mysecret
27144 .endd
27145 The initial colon means that the first string is empty, so no data is sent with
27146 the AUTH command itself. The remaining strings are sent in response to
27147 prompts.
27148 .ecindex IIDplaiauth1
27149 .ecindex IIDplaiauth2
27150
27151
27152
27153
27154 . ////////////////////////////////////////////////////////////////////////////
27155 . ////////////////////////////////////////////////////////////////////////////
27156
27157 .chapter "The cram_md5 authenticator" "CHID9"
27158 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27159 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27160 .cindex "CRAM-MD5 authentication mechanism"
27161 .cindex "authentication" "CRAM-MD5 mechanism"
27162 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27163 sends a challenge string to the client, and the response consists of a user
27164 name and the CRAM-MD5 digest of the challenge string combined with a secret
27165 string (password) which is known to both server and client. Thus, the secret
27166 is not sent over the network as plain text, which makes this authenticator more
27167 secure than &(plaintext)&. However, the downside is that the secret has to be
27168 available in plain text at either end.
27169
27170
27171 .section "Using cram_md5 as a server" "SECID176"
27172 .cindex "options" "&(cram_md5)& authenticator (server)"
27173 This authenticator has one server option, which must be set to configure the
27174 authenticator as a server:
27175
27176 .option server_secret cram_md5 string&!! unset
27177 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27178 When the server receives the client's response, the user name is placed in
27179 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27180 obtain the password for that user. The server then computes the CRAM-MD5 digest
27181 that the client should have sent, and checks that it received the correct
27182 string. If the expansion of &%server_secret%& is forced to fail, authentication
27183 fails. If the expansion fails for some other reason, a temporary error code is
27184 returned to the client.
27185
27186 For compatibility with previous releases of Exim, the user name is also placed
27187 in &$1$&. However, the use of this variables for this purpose is now
27188 deprecated, as it can lead to confusion in string expansions that also use
27189 numeric variables for other things.
27190
27191 For example, the following authenticator checks that the user name given by the
27192 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27193 user name, authentication fails.
27194 .code
27195 fixed_cram:
27196   driver = cram_md5
27197   public_name = CRAM-MD5
27198   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27199   server_set_id = $auth1
27200 .endd
27201 .vindex "&$authenticated_id$&"
27202 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27203 name in &$authenticated_id$&. A more typical configuration might look up the
27204 secret string in a file, using the user name as the key. For example:
27205 .code
27206 lookup_cram:
27207   driver = cram_md5
27208   public_name = CRAM-MD5
27209   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27210                   {$value}fail}
27211   server_set_id = $auth1
27212 .endd
27213 Note that this expansion explicitly forces failure if the lookup fails
27214 because &$auth1$& contains an unknown user name.
27215
27216 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27217 using the relevant libraries, you need to know the realm to specify in the
27218 lookup and then ask for the &"userPassword"& attribute for that user in that
27219 realm, with:
27220 .code
27221 cyrusless_crammd5:
27222   driver = cram_md5
27223   public_name = CRAM-MD5
27224   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27225                   dbmjz{/etc/sasldb2}{$value}fail}
27226   server_set_id = $auth1
27227 .endd
27228
27229 .section "Using cram_md5 as a client" "SECID177"
27230 .cindex "options" "&(cram_md5)& authenticator (client)"
27231 When used as a client, the &(cram_md5)& authenticator has two options:
27232
27233
27234
27235 .option client_name cram_md5 string&!! "the primary host name"
27236 This string is expanded, and the result used as the user name data when
27237 computing the response to the server's challenge.
27238
27239
27240 .option client_secret cram_md5 string&!! unset
27241 This option must be set for the authenticator to work as a client. Its value is
27242 expanded and the result used as the secret string when computing the response.
27243
27244
27245 .vindex "&$host$&"
27246 .vindex "&$host_address$&"
27247 Different user names and secrets can be used for different servers by referring
27248 to &$host$& or &$host_address$& in the options. Forced failure of either
27249 expansion string is treated as an indication that this authenticator is not
27250 prepared to handle this case. Exim moves on to the next configured client
27251 authenticator. Any other expansion failure causes Exim to give up trying to
27252 send the message to the current server.
27253
27254 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27255 strings, is:
27256 .code
27257 fixed_cram:
27258   driver = cram_md5
27259   public_name = CRAM-MD5
27260   client_name = ph10
27261   client_secret = secret
27262 .endd
27263 .ecindex IIDcramauth1
27264 .ecindex IIDcramauth2
27265
27266
27267
27268 . ////////////////////////////////////////////////////////////////////////////
27269 . ////////////////////////////////////////////////////////////////////////////
27270
27271 .chapter "The cyrus_sasl authenticator" "CHID10"
27272 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27273 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27274 .cindex "Cyrus" "SASL library"
27275 .cindex "Kerberos"
27276 The code for this authenticator was provided by Matthew Byng-Maddick while
27277 at A L Digital Ltd.
27278
27279 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27280 library implementation of the RFC 2222 (&"Simple Authentication and Security
27281 Layer"&). This library supports a number of authentication mechanisms,
27282 including PLAIN and LOGIN, but also several others that Exim does not support
27283 directly. In particular, there is support for Kerberos authentication.
27284
27285 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27286 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27287 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27288 name of the driver to determine which mechanism to support.
27289
27290 Where access to some kind of secret file is required, for example, in GSSAPI
27291 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27292 user, and that the Cyrus SASL library has no way of escalating privileges
27293 by default. You may also find you need to set environment variables,
27294 depending on the driver you are using.
27295
27296 The application name provided by Exim is &"exim"&, so various SASL options may
27297 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27298 Kerberos, note that because of limitations in the GSSAPI interface,
27299 changing the server keytab might need to be communicated down to the Kerberos
27300 layer independently. The mechanism for doing so is dependent upon the Kerberos
27301 implementation.
27302
27303 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27304 may be set to point to an alternative keytab file. Exim will pass this
27305 variable through from its own inherited environment when started as root or the
27306 Exim user. The keytab file needs to be readable by the Exim user.
27307 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27308 environment variable.  In practice, for those releases, the Cyrus authenticator
27309 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27310 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27311
27312
27313 .section "Using cyrus_sasl as a server" "SECID178"
27314 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27315 (on a successful authentication) into &$auth1$&. For compatibility with
27316 previous releases of Exim, the username is also placed in &$1$&. However, the
27317 use of this variable for this purpose is now deprecated, as it can lead to
27318 confusion in string expansions that also use numeric variables for other
27319 things.
27320
27321
27322 .option server_hostname cyrus_sasl string&!! "see below"
27323 This option selects the hostname that is used when communicating with the
27324 library. The default value is &`$primary_hostname`&. It is up to the underlying
27325 SASL plug-in what it does with this data.
27326
27327
27328 .option server_mech cyrus_sasl string "see below"
27329 This option selects the authentication mechanism this driver should use. The
27330 default is the value of the generic &%public_name%& option. This option allows
27331 you to use a different underlying mechanism from the advertised name. For
27332 example:
27333 .code
27334 sasl:
27335   driver = cyrus_sasl
27336   public_name = X-ANYTHING
27337   server_mech = CRAM-MD5
27338   server_set_id = $auth1
27339 .endd
27340
27341 .option server_realm cyrus_sasl string&!! unset
27342 This specifies the SASL realm that the server claims to be in.
27343
27344
27345 .option server_service cyrus_sasl string &`smtp`&
27346 This is the SASL service that the server claims to implement.
27347
27348
27349 For straightforward cases, you do not need to set any of the authenticator's
27350 private options. All you need to do is to specify an appropriate mechanism as
27351 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27352 PLAIN, you could have two authenticators as follows:
27353 .code
27354 sasl_cram_md5:
27355   driver = cyrus_sasl
27356   public_name = CRAM-MD5
27357   server_set_id = $auth1
27358
27359 sasl_plain:
27360   driver = cyrus_sasl
27361   public_name = PLAIN
27362   server_set_id = $auth2
27363 .endd
27364 Cyrus SASL does implement the LOGIN authentication method, even though it is
27365 not a standard method. It is disabled by default in the source distribution,
27366 but it is present in many binary distributions.
27367 .ecindex IIDcyrauth1
27368 .ecindex IIDcyrauth2
27369
27370
27371
27372
27373 . ////////////////////////////////////////////////////////////////////////////
27374 . ////////////////////////////////////////////////////////////////////////////
27375 .chapter "The dovecot authenticator" "CHAPdovecot"
27376 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27377 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27378 This authenticator is an interface to the authentication facility of the
27379 Dovecot POP/IMAP server, which can support a number of authentication methods.
27380 Note that Dovecot must be configured to use auth-client not auth-userdb.
27381 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27382 to use the same mechanisms for SMTP authentication. This is a server
27383 authenticator only. There is only one option:
27384
27385 .option server_socket dovecot string unset
27386
27387 This option must specify the UNIX socket that is the interface to Dovecot
27388 authentication. The &%public_name%& option must specify an authentication
27389 mechanism that Dovecot is configured to support. You can have several
27390 authenticators for different mechanisms. For example:
27391 .code
27392 dovecot_plain:
27393   driver = dovecot
27394   public_name = PLAIN
27395   server_socket = /var/run/dovecot/auth-client
27396   server_set_id = $auth1
27397
27398 dovecot_ntlm:
27399   driver = dovecot
27400   public_name = NTLM
27401   server_socket = /var/run/dovecot/auth-client
27402   server_set_id = $auth1
27403 .endd
27404 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27405 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27406 option is passed in the Dovecot authentication command. If, for a TLS
27407 connection, a client certificate has been verified, the &"valid-client-cert"&
27408 option is passed. When authentication succeeds, the identity of the user
27409 who authenticated is placed in &$auth1$&.
27410 .ecindex IIDdcotauth1
27411 .ecindex IIDdcotauth2
27412
27413
27414 . ////////////////////////////////////////////////////////////////////////////
27415 . ////////////////////////////////////////////////////////////////////////////
27416 .chapter "The gsasl authenticator" "CHAPgsasl"
27417 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27418 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27419 .cindex "authentication" "GNU SASL"
27420 .cindex "authentication" "SASL"
27421 .cindex "authentication" "EXTERNAL"
27422 .cindex "authentication" "ANONYMOUS"
27423 .cindex "authentication" "PLAIN"
27424 .cindex "authentication" "LOGIN"
27425 .cindex "authentication" "DIGEST-MD5"
27426 .cindex "authentication" "CRAM-MD5"
27427 .cindex "authentication" "SCRAM-SHA-1"
27428 The &(gsasl)& authenticator provides server integration for the GNU SASL
27429 library and the mechanisms it provides.  This is new as of the 4.80 release
27430 and there are a few areas where the library does not let Exim smoothly
27431 scale to handle future authentication mechanisms, so no guarantee can be
27432 made that any particular new authentication mechanism will be supported
27433 without code changes in Exim.
27434
27435 Exim's &(gsasl)& authenticator does not have client-side support at this
27436 time; only the server-side support is implemented.  Patches welcome.
27437
27438
27439 .option server_channelbinding gsasl boolean false
27440 Do not set this true without consulting a cryptographic engineer.
27441
27442 Some authentication mechanisms are able to use external context at both ends
27443 of the session to bind the authentication to that context, and fail the
27444 authentication process if that context differs.  Specifically, some TLS
27445 ciphersuites can provide identifying information about the cryptographic
27446 context.
27447
27448 This should have meant that certificate identity and verification becomes a
27449 non-issue, as a man-in-the-middle attack will cause the correct client and
27450 server to see different identifiers and authentication will fail.
27451
27452 This is currently only supported when using the GnuTLS library.  This is
27453 only usable by mechanisms which support "channel binding"; at time of
27454 writing, that's the SCRAM family.
27455
27456 This defaults off to ensure smooth upgrade across Exim releases, in case
27457 this option causes some clients to start failing.  Some future release
27458 of Exim might have switched the default to be true.
27459
27460 However, Channel Binding in TLS has proven to be broken in current versions.
27461 Do not plan to rely upon this feature for security, ever, without consulting
27462 with a subject matter expert (a cryptographic engineer).
27463
27464
27465 .option server_hostname gsasl string&!! "see below"
27466 This option selects the hostname that is used when communicating with the
27467 library. The default value is &`$primary_hostname`&.
27468 Some mechanisms will use this data.
27469
27470
27471 .option server_mech gsasl string "see below"
27472 This option selects the authentication mechanism this driver should use. The
27473 default is the value of the generic &%public_name%& option. This option allows
27474 you to use a different underlying mechanism from the advertised name. For
27475 example:
27476 .code
27477 sasl:
27478   driver = gsasl
27479   public_name = X-ANYTHING
27480   server_mech = CRAM-MD5
27481   server_set_id = $auth1
27482 .endd
27483
27484
27485 .option server_password gsasl string&!! unset
27486 Various mechanisms need access to the cleartext password on the server, so
27487 that proof-of-possession can be demonstrated on the wire, without sending
27488 the password itself.
27489
27490 The data available for lookup varies per mechanism.
27491 In all cases, &$auth1$& is set to the &'authentication id'&.
27492 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27493 if available, else the empty string.
27494 The &$auth3$& variable will always be the &'realm'& if available,
27495 else the empty string.
27496
27497 A forced failure will cause authentication to defer.
27498
27499 If using this option, it may make sense to set the &%server_condition%&
27500 option to be simply "true".
27501
27502
27503 .option server_realm gsasl string&!! unset
27504 This specifies the SASL realm that the server claims to be in.
27505 Some mechanisms will use this data.
27506
27507
27508 .option server_scram_iter gsasl string&!! unset
27509 This option provides data for the SCRAM family of mechanisms.
27510 &$auth1$& is not available at evaluation time.
27511 (This may change, as we receive feedback on use)
27512
27513
27514 .option server_scram_salt gsasl string&!! unset
27515 This option provides data for the SCRAM family of mechanisms.
27516 &$auth1$& is not available at evaluation time.
27517 (This may change, as we receive feedback on use)
27518
27519
27520 .option server_service gsasl string &`smtp`&
27521 This is the SASL service that the server claims to implement.
27522 Some mechanisms will use this data.
27523
27524
27525 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27526 .vindex "&$auth1$&, &$auth2$&, etc"
27527 These may be set when evaluating specific options, as detailed above.
27528 They will also be set when evaluating &%server_condition%&.
27529
27530 Unless otherwise stated below, the &(gsasl)& integration will use the following
27531 meanings for these variables:
27532
27533 .ilist
27534 .vindex "&$auth1$&"
27535 &$auth1$&: the &'authentication id'&
27536 .next
27537 .vindex "&$auth2$&"
27538 &$auth2$&: the &'authorization id'&
27539 .next
27540 .vindex "&$auth3$&"
27541 &$auth3$&: the &'realm'&
27542 .endlist
27543
27544 On a per-mechanism basis:
27545
27546 .ilist
27547 .cindex "authentication" "EXTERNAL"
27548 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27549 the &%server_condition%& option must be present.
27550 .next
27551 .cindex "authentication" "ANONYMOUS"
27552 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27553 the &%server_condition%& option must be present.
27554 .next
27555 .cindex "authentication" "GSSAPI"
27556 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27557 &$auth2$& will be set to the &'authorization id'&,
27558 the &%server_condition%& option must be present.
27559 .endlist
27560
27561 An &'anonymous token'& is something passed along as an unauthenticated
27562 identifier; this is analogous to FTP anonymous authentication passing an
27563 email address, or software-identifier@, as the "password".
27564
27565
27566 An example showing the password having the realm specified in the callback
27567 and demonstrating a Cyrus SASL to GSASL migration approach is:
27568 .code
27569 gsasl_cyrusless_crammd5:
27570   driver = gsasl
27571   public_name = CRAM-MD5
27572   server_realm = imap.example.org
27573   server_password = ${lookup{$auth1:$auth3:userPassword}\
27574                     dbmjz{/etc/sasldb2}{$value}fail}
27575   server_set_id = ${quote:$auth1}
27576   server_condition = yes
27577 .endd
27578
27579
27580 . ////////////////////////////////////////////////////////////////////////////
27581 . ////////////////////////////////////////////////////////////////////////////
27582
27583 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27584 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27585 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27586 .cindex "authentication" "GSSAPI"
27587 .cindex "authentication" "Kerberos"
27588 The &(heimdal_gssapi)& authenticator provides server integration for the
27589 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27590 reliably.
27591
27592 .option server_hostname heimdal_gssapi string&!! "see below"
27593 This option selects the hostname that is used, with &%server_service%&,
27594 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27595 identifier.  The default value is &`$primary_hostname`&.
27596
27597 .option server_keytab heimdal_gssapi string&!! unset
27598 If set, then Heimdal will not use the system default keytab (typically
27599 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27600 The value should be a pathname, with no &"file:"& prefix.
27601
27602 .option server_service heimdal_gssapi string&!! "smtp"
27603 This option specifies the service identifier used, in conjunction with
27604 &%server_hostname%&, for building the identifier for finding credentials
27605 from the keytab.
27606
27607
27608 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27609 Beware that these variables will typically include a realm, thus will appear
27610 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27611 not verified, so a malicious client can set it to anything.
27612
27613 The &$auth1$& field should be safely trustable as a value from the Key
27614 Distribution Center.  Note that these are not quite email addresses.
27615 Each identifier is for a role, and so the left-hand-side may include a
27616 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27617
27618 .vindex "&$auth1$&, &$auth2$&, etc"
27619 .ilist
27620 .vindex "&$auth1$&"
27621 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27622 .next
27623 .vindex "&$auth2$&"
27624 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27625 authentication.  If that was empty, this will also be set to the
27626 GSS Display Name.
27627 .endlist
27628
27629
27630 . ////////////////////////////////////////////////////////////////////////////
27631 . ////////////////////////////////////////////////////////////////////////////
27632
27633 .chapter "The spa authenticator" "CHAPspa"
27634 .scindex IIDspaauth1 "&(spa)& authenticator"
27635 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27636 .cindex "authentication" "Microsoft Secure Password"
27637 .cindex "authentication" "NTLM"
27638 .cindex "Microsoft Secure Password Authentication"
27639 .cindex "NTLM authentication"
27640 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27641 Password Authentication'& mechanism,
27642 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27643 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27644 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27645 server side was subsequently contributed by Tom Kistner. The mechanism works as
27646 follows:
27647
27648 .ilist
27649 After the AUTH command has been accepted, the client sends an SPA
27650 authentication request based on the user name and optional domain.
27651 .next
27652 The server sends back a challenge.
27653 .next
27654 The client builds a challenge response which makes use of the user's password
27655 and sends it to the server, which then accepts or rejects it.
27656 .endlist
27657
27658 Encryption is used to protect the password in transit.
27659
27660
27661
27662 .section "Using spa as a server" "SECID179"
27663 .cindex "options" "&(spa)& authenticator (server)"
27664 The &(spa)& authenticator has just one server option:
27665
27666 .option server_password spa string&!! unset
27667 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27668 This option is expanded, and the result must be the cleartext password for the
27669 authenticating user, whose name is at this point in &$auth1$&. For
27670 compatibility with previous releases of Exim, the user name is also placed in
27671 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27672 it can lead to confusion in string expansions that also use numeric variables
27673 for other things. For example:
27674 .code
27675 spa:
27676   driver = spa
27677   public_name = NTLM
27678   server_password = \
27679     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27680 .endd
27681 If the expansion is forced to fail, authentication fails. Any other expansion
27682 failure causes a temporary error code to be returned.
27683
27684
27685
27686
27687
27688 .section "Using spa as a client" "SECID180"
27689 .cindex "options" "&(spa)& authenticator (client)"
27690 The &(spa)& authenticator has the following client options:
27691
27692
27693
27694 .option client_domain spa string&!! unset
27695 This option specifies an optional domain for the authentication.
27696
27697
27698 .option client_password spa string&!! unset
27699 This option specifies the user's password, and must be set.
27700
27701
27702 .option client_username spa string&!! unset
27703 This option specifies the user name, and must be set. Here is an example of a
27704 configuration of this authenticator for use with the mail servers at
27705 &'msn.com'&:
27706 .code
27707 msn:
27708   driver = spa
27709   public_name = MSN
27710   client_username = msn/msn_username
27711   client_password = msn_plaintext_password
27712   client_domain = DOMAIN_OR_UNSET
27713 .endd
27714 .ecindex IIDspaauth1
27715 .ecindex IIDspaauth2
27716
27717
27718
27719
27720
27721 . ////////////////////////////////////////////////////////////////////////////
27722 . ////////////////////////////////////////////////////////////////////////////
27723
27724 .chapter "The external authenticator" "CHAPexternauth"
27725 .scindex IIDexternauth1 "&(external)& authenticator"
27726 .scindex IIDexternauth2 "authenticators" "&(external)&"
27727 .cindex "authentication" "Client Certificate"
27728 .cindex "authentication" "X509"
27729 .cindex "Certificate-based authentication"
27730 The &(external)& authenticator provides support for
27731 authentication based on non-SMTP information.
27732 The specification is in RFC 4422 Appendix A
27733 (&url(https://tools.ietf.org/html/rfc4422)).
27734 It is only a transport and negotiation mechanism;
27735 the process of authentication is entirely controlled
27736 by the server configuration.
27737
27738 The client presents an identity in-clear.
27739 It is probably wise for a server to only advertise,
27740 and for clients to only attempt,
27741 this authentication method on a secure (eg. under TLS) connection.
27742
27743 One possible use, compatible with the
27744 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27745 is for using X509 client certificates.
27746
27747 It thus overlaps in function with the TLS authenticator
27748 (see &<<CHAPtlsauth>>&)
27749 but is a full SMTP SASL authenticator
27750 rather than being implicit for TLS-connection carried
27751 client certificates only.
27752
27753 The examples and discussion in this chapter assume that
27754 client-certificate authentication is being done.
27755
27756 The client must present a certificate,
27757 for which it must have been requested via the
27758 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27759 (see &<<CHAPTLS>>&).
27760 For authentication to be effective the certificate should be
27761 verifiable against a trust-anchor certificate known to the server.
27762
27763 .section "External options" "SECTexternsoptions"
27764 .cindex "options" "&(external)& authenticator (server)"
27765 The &(external)& authenticator has two server options:
27766
27767 .option server_param2 external string&!! unset
27768 .option server_param3 external string&!! unset
27769 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27770 These options are expanded before the &%server_condition%& option
27771 and the result are placed in &$auth2$& and &$auth3$& resectively.
27772 If the expansion is forced to fail, authentication fails. Any other expansion
27773 failure causes a temporary error code to be returned.
27774
27775 They can be used to clarify the coding of a complex &%server_condition%&.
27776
27777 .section "Using external in a server" "SECTexternserver"
27778 .cindex "AUTH" "in &(external)& authenticator"
27779 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27780         "in &(external)& authenticator"
27781 .vindex "&$auth1$&, &$auth2$&, etc"
27782 .cindex "base64 encoding" "in &(external)& authenticator"
27783
27784 When running as a server, &(external)& performs the authentication test by
27785 expanding a string. The data sent by the client with the AUTH command, or in
27786 response to subsequent prompts, is base64 encoded, and so may contain any byte
27787 values when decoded. The decoded value is treated as
27788 an identity for authentication and
27789 placed in the expansion variable &$auth1$&.
27790
27791 For compatibility with previous releases of Exim, the value is also placed in
27792 the expansion variable &$1$&. However, the use of this
27793 variable for this purpose is now deprecated, as it can lead to confusion in
27794 string expansions that also use them for other things.
27795
27796 .vindex "&$authenticated_id$&"
27797 Once an identity has been received,
27798 &%server_condition%& is expanded. If the expansion is forced to fail,
27799 authentication fails. Any other expansion failure causes a temporary error code
27800 to be returned. If the result of a successful expansion is an empty string,
27801 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27802 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27803 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27804 For any other result, a temporary error code is returned, with the expanded
27805 string as the error text.
27806
27807 Example:
27808 .code
27809 ext_ccert_san_mail:
27810   driver =            external
27811   public_name =       EXTERNAL
27812
27813   server_advertise_condition = $tls_in_certificate_verified
27814   server_param2 =     ${certextract {subj_altname,mail,>:} \
27815                                     {$tls_in_peercert}}
27816   server_condition =  ${if forany {$auth2} \
27817                             {eq {$item}{$auth1}}}
27818   server_set_id =     $auth1
27819 .endd
27820 This accepts a client certificate that is verifiable against any
27821 of your configured trust-anchors
27822 (which usually means the full set of public CAs)
27823 and which has a mail-SAN matching the claimed identity sent by the client.
27824
27825 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27826 The account name is therefore guessable by an opponent.
27827 TLS 1.3 protects both server and client certificates, and is not vulnerable
27828 in this way.
27829 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27830
27831
27832 .section "Using external in a client" "SECTexternclient"
27833 .cindex "options" "&(external)& authenticator (client)"
27834 The &(external)& authenticator has one client option:
27835
27836 .option client_send external string&!! unset
27837 This option is expanded and sent with the AUTH command as the
27838 identity being asserted.
27839
27840 Example:
27841 .code
27842 ext_ccert:
27843   driver =      external
27844   public_name = EXTERNAL
27845
27846   client_condition = ${if !eq{$tls_out_cipher}{}}
27847   client_send = myaccount@smarthost.example.net
27848 .endd
27849
27850
27851 .ecindex IIDexternauth1
27852 .ecindex IIDexternauth2
27853
27854
27855
27856
27857
27858 . ////////////////////////////////////////////////////////////////////////////
27859 . ////////////////////////////////////////////////////////////////////////////
27860
27861 .chapter "The tls authenticator" "CHAPtlsauth"
27862 .scindex IIDtlsauth1 "&(tls)& authenticator"
27863 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27864 .cindex "authentication" "Client Certificate"
27865 .cindex "authentication" "X509"
27866 .cindex "Certificate-based authentication"
27867 The &(tls)& authenticator provides server support for
27868 authentication based on client certificates.
27869
27870 It is not an SMTP authentication mechanism and is not
27871 advertised by the server as part of the SMTP EHLO response.
27872 It is an Exim authenticator in the sense that it affects
27873 the protocol element of the log line, can be tested for
27874 by the &%authenticated%& ACL condition, and can set
27875 the &$authenticated_id$& variable.
27876
27877 The client must present a verifiable certificate,
27878 for which it must have been requested via the
27879 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27880 (see &<<CHAPTLS>>&).
27881
27882 If an authenticator of this type is configured it is
27883 run before any SMTP-level communication is done,
27884 and can authenticate the connection.
27885 If it does, SMTP authentication is not offered.
27886
27887 A maximum of one authenticator of this type may be present.
27888
27889
27890 .cindex "options" "&(tls)& authenticator (server)"
27891 The &(tls)& authenticator has three server options:
27892
27893 .option server_param1 tls string&!! unset
27894 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27895 This option is expanded after the TLS negotiation and
27896 the result is placed in &$auth1$&.
27897 If the expansion is forced to fail, authentication fails. Any other expansion
27898 failure causes a temporary error code to be returned.
27899
27900 .option server_param2 tls string&!! unset
27901 .option server_param3 tls string&!! unset
27902 As above, for &$auth2$& and &$auth3$&.
27903
27904 &%server_param1%& may also be spelled &%server_param%&.
27905
27906
27907 Example:
27908 .code
27909 tls:
27910   driver = tls
27911   server_param1 =     ${certextract {subj_altname,mail,>:} \
27912                                     {$tls_in_peercert}}
27913   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
27914                                  {forany {$auth1} \
27915                             {!= {0} \
27916                                 {${lookup ldap{ldap:///\
27917                          mailname=${quote_ldap_dn:${lc:$item}},\
27918                          ou=users,LDAP_DC?mailid} {$value}{0} \
27919                        }    }  } }}}
27920   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27921 .endd
27922 This accepts a client certificate that is verifiable against any
27923 of your configured trust-anchors
27924 (which usually means the full set of public CAs)
27925 and which has a SAN with a good account name.
27926
27927 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27928 The account name is therefore guessable by an opponent.
27929 TLS 1.3 protects both server and client certificates, and is not vulnerable
27930 in this way.
27931 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27932
27933 . An alternative might use
27934 . .code
27935 .   server_param1 = ${sha256:$tls_in_peercert}
27936 . .endd
27937 . to require one of a set of specific certs that define a given account
27938 . (the verification is still required, but mostly irrelevant).
27939 . This would help for per-device use.
27940 .
27941 . However, for the future we really need support for checking a
27942 . user cert in LDAP - which probably wants a base-64 DER.
27943
27944 .ecindex IIDtlsauth1
27945 .ecindex IIDtlsauth2
27946
27947
27948 Note that because authentication is traditionally an SMTP operation,
27949 the &%authenticated%& ACL condition cannot be used in
27950 a connect- or helo-ACL.
27951
27952
27953
27954 . ////////////////////////////////////////////////////////////////////////////
27955 . ////////////////////////////////////////////////////////////////////////////
27956
27957 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27958          "Encrypted SMTP connections"
27959 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27960 .scindex IIDencsmtp2 "SMTP" "encryption"
27961 .cindex "TLS" "on SMTP connection"
27962 .cindex "OpenSSL"
27963 .cindex "GnuTLS"
27964 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27965 Sockets Layer), is implemented by making use of the OpenSSL library or the
27966 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27967 cryptographic code in the Exim distribution itself for implementing TLS. In
27968 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27969 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27970 You also need to understand the basic concepts of encryption at a managerial
27971 level, and in particular, the way that public keys, private keys, and
27972 certificates are used.
27973
27974 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27975 connection is established, the client issues a STARTTLS command. If the
27976 server accepts this, the client and the server negotiate an encryption
27977 mechanism. If the negotiation succeeds, the data that subsequently passes
27978 between them is encrypted.
27979
27980 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27981 and if so, what cipher suite is in use, whether the client supplied a
27982 certificate, and whether or not that certificate was verified. This makes it
27983 possible for an Exim server to deny or accept certain commands based on the
27984 encryption state.
27985
27986 &*Warning*&: Certain types of firewall and certain anti-virus products can
27987 disrupt TLS connections. You need to turn off SMTP scanning for these products
27988 in order to get TLS to work.
27989
27990
27991
27992 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27993          "SECID284"
27994 .cindex "submissions protocol"
27995 .cindex "ssmtp protocol"
27996 .cindex "smtps protocol"
27997 .cindex "SMTP" "submissions protocol"
27998 .cindex "SMTP" "ssmtp protocol"
27999 .cindex "SMTP" "smtps protocol"
28000 The history of port numbers for TLS in SMTP is a little messy and has been
28001 contentious.  As of RFC 8314, the common practice of using the historically
28002 allocated port 465 for "email submission but with TLS immediately upon connect
28003 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28004 by them in preference to STARTTLS.
28005
28006 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28007 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28008 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28009
28010 This approach was, for a while, officially abandoned when encrypted SMTP was
28011 standardized, but many clients kept using it, even as the TCP port number was
28012 reassigned for other use.
28013 Thus you may encounter guidance claiming that you shouldn't enable use of
28014 this port.
28015 In practice, a number of mail-clients have only ever supported submissions,
28016 not submission with STARTTLS upgrade.
28017 Ideally, offer both submission (587) and submissions (465) service.
28018
28019 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28020 global option. Its value must be a list of port numbers;
28021 the most common use is expected to be:
28022 .code
28023 tls_on_connect_ports = 465
28024 .endd
28025 The port numbers specified by this option apply to all SMTP connections, both
28026 via the daemon and via &'inetd'&. You still need to specify all the ports that
28027 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28028 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28029 an extra port &-- rather, it specifies different behaviour on a port that is
28030 defined elsewhere.
28031
28032 There is also a &%-tls-on-connect%& command line option. This overrides
28033 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28034
28035
28036
28037
28038
28039
28040 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28041 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28042 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
28043 followed later, when the first versions of GnuTLS were released. To build Exim
28044 to use GnuTLS, you need to set
28045 .code
28046 USE_GNUTLS=yes
28047 .endd
28048 in Local/Makefile
28049 you must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28050 include files and libraries for GnuTLS can be found.
28051
28052 There are some differences in usage when using GnuTLS instead of OpenSSL:
28053
28054 .ilist
28055 The &%tls_verify_certificates%& option
28056 cannot be the path of a directory
28057 for GnuTLS versions before 3.3.6
28058 (for later versions, or OpenSSL, it can be either).
28059 .next
28060 The default value for &%tls_dhparam%& differs for historical reasons.
28061 .next
28062 .vindex "&$tls_in_peerdn$&"
28063 .vindex "&$tls_out_peerdn$&"
28064 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28065 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28066 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28067 .next
28068 OpenSSL identifies cipher suites using hyphens as separators, for example:
28069 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28070 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28071 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28072 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28073 to handle its own older variants) when processing lists of cipher suites in the
28074 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28075 option).
28076 .next
28077 The &%tls_require_ciphers%& options operate differently, as described in the
28078 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28079 .next
28080 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28081 When using OpenSSL, this option is ignored.
28082 (If an API is found to let OpenSSL be configured in this way,
28083 let the Exim Maintainers know and we'll likely use it).
28084 .next
28085 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28086 main option, it must be ordered to match the &%tls_certificate%& list.
28087 .next
28088 Some other recently added features may only be available in one or the other.
28089 This should be documented with the feature.  If the documentation does not
28090 explicitly state that the feature is infeasible in the other TLS
28091 implementation, then patches are welcome.
28092 .endlist
28093
28094
28095 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28096 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28097 an explicit path; if the latter, then the text about generation still applies,
28098 but not the chosen filename.
28099 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28100 See the documentation of &%tls_dhparam%& for more information.
28101
28102 GnuTLS uses D-H parameters that may take a substantial amount of time
28103 to compute. It is unreasonable to re-compute them for every TLS session.
28104 Therefore, Exim keeps this data in a file in its spool directory, called
28105 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28106 of bits requested.
28107 The file is owned by the Exim user and is readable only by
28108 its owner. Every Exim process that start up GnuTLS reads the D-H
28109 parameters from this file. If the file does not exist, the first Exim process
28110 that needs it computes the data and writes it to a temporary file which is
28111 renamed once it is complete. It does not matter if several Exim processes do
28112 this simultaneously (apart from wasting a few resources). Once a file is in
28113 place, new Exim processes immediately start using it.
28114
28115 For maximum security, the parameters that are stored in this file should be
28116 recalculated periodically, the frequency depending on your paranoia level.
28117 If you are avoiding using the fixed D-H primes published in RFCs, then you
28118 are concerned about some advanced attacks and will wish to do this; if you do
28119 not regenerate then you might as well stick to the standard primes.
28120
28121 Arranging this is easy in principle; just delete the file when you want new
28122 values to be computed. However, there may be a problem. The calculation of new
28123 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28124 If the system is not very active, &_/dev/random_& may delay returning data
28125 until enough randomness (entropy) is available. This may cause Exim to hang for
28126 a substantial amount of time, causing timeouts on incoming connections.
28127
28128 The solution is to generate the parameters externally to Exim. They are stored
28129 in &_gnutls-params-N_& in PEM format, which means that they can be
28130 generated externally using the &(certtool)& command that is part of GnuTLS.
28131
28132 To replace the parameters with new ones, instead of deleting the file
28133 and letting Exim re-create it, you can generate new parameters using
28134 &(certtool)& and, when this has been done, replace Exim's cache file by
28135 renaming. The relevant commands are something like this:
28136 .code
28137 # ls
28138 [ look for file; assume gnutls-params-2236 is the most recent ]
28139 # rm -f new-params
28140 # touch new-params
28141 # chown exim:exim new-params
28142 # chmod 0600 new-params
28143 # certtool --generate-dh-params --bits 2236 >>new-params
28144 # openssl dhparam -noout -text -in new-params | head
28145 [ check the first line, make sure it's not more than 2236;
28146   if it is, then go back to the start ("rm") and repeat
28147   until the size generated is at most the size requested ]
28148 # chmod 0400 new-params
28149 # mv new-params gnutls-params-2236
28150 .endd
28151 If Exim never has to generate the parameters itself, the possibility of
28152 stalling is removed.
28153
28154 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28155 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28156 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28157 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28158 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28159 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28160 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28161 which applies to all D-H usage, client or server.  If the value returned by
28162 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28163 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28164 limit, which is still much higher than Exim historically used.
28165
28166 The filename and bits used will change as the GnuTLS maintainers change the
28167 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28168 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28169 2432 bits, while NSS is limited to 2236 bits.
28170
28171 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28172 increase the chance of the generated prime actually being within acceptable
28173 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28174 procedure above.  There is no sane procedure available to Exim to double-check
28175 the size of the generated prime, so it might still be too large.
28176
28177
28178 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28179 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28180 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28181 There is a function in the OpenSSL library that can be passed a list of cipher
28182 suites before the cipher negotiation takes place. This specifies which ciphers
28183 are acceptable for TLS versions prior to 1.3.
28184 The list is colon separated and may contain names like
28185 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28186 directly to this function call.
28187 Many systems will install the OpenSSL manual-pages, so you may have
28188 &'ciphers(1)'& available to you.
28189 The following quotation from the OpenSSL
28190 documentation specifies what forms of item are allowed in the cipher string:
28191
28192 .ilist
28193 It can consist of a single cipher suite such as RC4-SHA.
28194 .next
28195 It can represent a list of cipher suites containing a certain algorithm,
28196 or cipher suites of a certain type. For example SHA1 represents all
28197 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28198 SSL v3 algorithms.
28199 .next
28200 Lists of cipher suites can be combined in a single cipher string using
28201 the + character. This is used as a logical and operation. For example
28202 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28203 algorithms.
28204 .endlist
28205
28206 Each cipher string can be optionally preceded by one of the characters &`!`&,
28207 &`-`& or &`+`&.
28208 .ilist
28209 If &`!`& is used, the ciphers are permanently deleted from the list. The
28210 ciphers deleted can never reappear in the list even if they are explicitly
28211 stated.
28212 .next
28213 If &`-`& is used, the ciphers are deleted from the list, but some or all
28214 of the ciphers can be added again by later options.
28215 .next
28216 If &`+`& is used, the ciphers are moved to the end of the list. This
28217 option does not add any new ciphers; it just moves matching existing ones.
28218 .endlist
28219
28220 If none of these characters is present, the string is interpreted as
28221 a list of ciphers to be appended to the current preference list. If the list
28222 includes any ciphers already present they will be ignored: that is, they will
28223 not be moved to the end of the list.
28224 .endlist
28225
28226 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28227 string:
28228 .code
28229 # note single-quotes to get ! past any shell history expansion
28230 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28231 .endd
28232
28233 This example will let the library defaults be permitted on the MX port, where
28234 there's probably no identity verification anyway, but ups the ante on the
28235 submission ports where the administrator might have some influence on the
28236 choice of clients used:
28237 .code
28238 # OpenSSL variant; see man ciphers(1)
28239 tls_require_ciphers = ${if =={$received_port}{25}\
28240                            {DEFAULT}\
28241                            {HIGH:!MD5:!SHA1}}
28242 .endd
28243
28244 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28245 .code
28246 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28247 .endd
28248
28249 For TLS version 1.3 the control available is less fine-grained
28250 and Exim does not provide access to it at present.
28251 The value of the &%tls_require_ciphers%& option is ignored when
28252 TLS version 1.3 is negotiated.
28253
28254 As of writing the library default cipher suite list for TLSv1.3 is
28255 .code
28256 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28257 .endd
28258
28259
28260 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28261          "SECTreqciphgnu"
28262 .cindex "GnuTLS" "specifying parameters for"
28263 .cindex "TLS" "specifying ciphers (GnuTLS)"
28264 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28265 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28266 .cindex "TLS" "specifying protocols (GnuTLS)"
28267 .cindex "TLS" "specifying priority string (GnuTLS)"
28268 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28269 The GnuTLS library allows the caller to provide a "priority string", documented
28270 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28271 ciphersuite specification in OpenSSL.
28272
28273 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28274 and controls both protocols and ciphers.
28275
28276 The &%tls_require_ciphers%& option is available both as an global option,
28277 controlling how Exim behaves as a server, and also as an option of the
28278 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28279 the value is string expanded.  The resulting string is not an Exim list and
28280 the string is given to the GnuTLS library, so that Exim does not need to be
28281 aware of future feature enhancements of GnuTLS.
28282
28283 Documentation of the strings accepted may be found in the GnuTLS manual, under
28284 "Priority strings".  This is online as
28285 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28286 but beware that this relates to GnuTLS 3, which may be newer than the version
28287 installed on your system.  If you are using GnuTLS 3,
28288 then the example code
28289 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28290 on that site can be used to test a given string.
28291
28292 For example:
28293 .code
28294 # Disable older versions of protocols
28295 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28296 .endd
28297
28298 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28299 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28300 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28301
28302 This example will let the library defaults be permitted on the MX port, where
28303 there's probably no identity verification anyway, and lowers security further
28304 by increasing compatibility; but this ups the ante on the submission ports
28305 where the administrator might have some influence on the choice of clients
28306 used:
28307 .code
28308 # GnuTLS variant
28309 tls_require_ciphers = ${if =={$received_port}{25}\
28310                            {NORMAL:%COMPAT}\
28311                            {SECURE128}}
28312 .endd
28313
28314
28315 .section "Configuring an Exim server to use TLS" "SECID182"
28316 .cindex "TLS" "configuring an Exim server"
28317 When Exim has been built with TLS support, it advertises the availability of
28318 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28319 but not to any others. The default value of this option is *, which means
28320 that STARTTLS is always advertised.  Set it to blank to never advertise;
28321 this is reasonable for systems that want to use TLS only as a client.
28322
28323 If STARTTLS is to be used you
28324 need to set some other options in order to make TLS available.
28325
28326 If a client issues a STARTTLS command and there is some configuration
28327 problem in the server, the command is rejected with a 454 error. If the client
28328 persists in trying to issue SMTP commands, all except QUIT are rejected
28329 with the error
28330 .code
28331 554 Security failure
28332 .endd
28333 If a STARTTLS command is issued within an existing TLS session, it is
28334 rejected with a 554 error code.
28335
28336 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28337 must be set to match some hosts. The default is * which matches all hosts.
28338
28339 If this is all you do, TLS encryption will be enabled but not authentication -
28340 meaning that the peer has no assurance it is actually you he is talking to.
28341 You gain protection from a passive sniffer listening on the wire but not
28342 from someone able to intercept the communication.
28343
28344 Further protection requires some further configuration at the server end.
28345
28346 To make TLS work you need to set, in the server,
28347 .code
28348 tls_certificate = /some/file/name
28349 tls_privatekey = /some/file/name
28350 .endd
28351 These options are, in fact, expanded strings, so you can make them depend on
28352 the identity of the client that is connected if you wish. The first file
28353 contains the server's X509 certificate, and the second contains the private key
28354 that goes with it. These files need to be
28355 PEM format and readable by the Exim user, and must
28356 always be given as full path names.
28357 The key must not be password-protected.
28358 They can be the same file if both the
28359 certificate and the key are contained within it. If &%tls_privatekey%& is not
28360 set, or if its expansion is forced to fail or results in an empty string, this
28361 is assumed to be the case. The certificate file may also contain intermediate
28362 certificates that need to be sent to the client to enable it to authenticate
28363 the server's certificate.
28364
28365 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28366 colon-separated lists of file paths.  Ciphers using given authentication
28367 algorithms require the presence of a suitable certificate to supply the
28368 public-key.  The server selects among the certificates to present to the
28369 client depending on the selected cipher, hence the priority ordering for
28370 ciphers will affect which certificate is used.
28371
28372 If you do not understand about certificates and keys, please try to find a
28373 source of this background information, which is not Exim-specific. (There are a
28374 few comments below in section &<<SECTcerandall>>&.)
28375
28376 &*Note*&: These options do not apply when Exim is operating as a client &--
28377 they apply only in the case of a server. If you need to use a certificate in an
28378 Exim client, you must set the options of the same names in an &(smtp)&
28379 transport.
28380
28381 With just these options, an Exim server will be able to use TLS. It does not
28382 require the client to have a certificate (but see below for how to insist on
28383 this). There is one other option that may be needed in other situations. If
28384 .code
28385 tls_dhparam = /some/file/name
28386 .endd
28387 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28388 with the parameters contained in the file.
28389 Set this to &`none`& to disable use of DH entirely, by making no prime
28390 available:
28391 .code
28392 tls_dhparam = none
28393 .endd
28394 This may also be set to a string identifying a standard prime to be used for
28395 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28396 used is &`ike23`&.  There are a few standard primes available, see the
28397 documentation for &%tls_dhparam%& for the complete list.
28398
28399 See the command
28400 .code
28401 openssl dhparam
28402 .endd
28403 for a way of generating file data.
28404
28405 The strings supplied for these three options are expanded every time a client
28406 host connects. It is therefore possible to use different certificates and keys
28407 for different hosts, if you so wish, by making use of the client's IP address
28408 in &$sender_host_address$& to control the expansion. If a string expansion is
28409 forced to fail, Exim behaves as if the option is not set.
28410
28411 .cindex "cipher" "logging"
28412 .cindex "log" "TLS cipher"
28413 .vindex "&$tls_in_cipher$&"
28414 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28415 an incoming TLS connection. It is included in the &'Received:'& header of an
28416 incoming message (by default &-- you can, of course, change this), and it is
28417 also included in the log line that records a message's arrival, keyed by
28418 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28419 condition can be used to test for specific cipher suites in ACLs.
28420
28421 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28422 can check the name of the cipher suite and vary their actions accordingly. The
28423 cipher suite names vary, depending on which TLS library is being used. For
28424 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28425 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28426 documentation for more details.
28427
28428 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28429 (again depending on the &%tls_cipher%& log selector).
28430
28431
28432 .section "Requesting and verifying client certificates" "SECID183"
28433 .cindex "certificate" "verification of client"
28434 .cindex "TLS" "client certificate verification"
28435 If you want an Exim server to request a certificate when negotiating a TLS
28436 session with a client, you must set either &%tls_verify_hosts%& or
28437 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28438 apply to all TLS connections. For any host that matches one of these options,
28439 Exim requests a certificate as part of the setup of the TLS session. The
28440 contents of the certificate are verified by comparing it with a list of
28441 expected trust-anchors or certificates.
28442 These may be the system default set (depending on library version),
28443 an explicit file or,
28444 depending on library version, a directory, identified by
28445 &%tls_verify_certificates%&.
28446
28447 A file can contain multiple certificates, concatenated end to end. If a
28448 directory is used
28449 (OpenSSL only),
28450 each certificate must be in a separate file, with a name (or a symbolic link)
28451 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28452 certificate. You can compute the relevant hash by running the command
28453 .code
28454 openssl x509 -hash -noout -in /cert/file
28455 .endd
28456 where &_/cert/file_& contains a single certificate.
28457
28458 There is no checking of names of the client against the certificate
28459 Subject Name or Subject Alternate Names.
28460
28461 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28462 what happens if the client does not supply a certificate, or if the certificate
28463 does not match any of the certificates in the collection named by
28464 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28465 attempt to set up a TLS session is aborted, and the incoming connection is
28466 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28467 session continues. ACLs that run for subsequent SMTP commands can detect the
28468 fact that no certificate was verified, and vary their actions accordingly. For
28469 example, you can insist on a certificate before accepting a message for
28470 relaying, but not when the message is destined for local delivery.
28471
28472 .vindex "&$tls_in_peerdn$&"
28473 When a client supplies a certificate (whether it verifies or not), the value of
28474 the Distinguished Name of the certificate is made available in the variable
28475 &$tls_in_peerdn$& during subsequent processing of the message.
28476
28477 .cindex "log" "distinguished name"
28478 Because it is often a long text string, it is not included in the log line or
28479 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28480 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28481 &%received_header_text%& to change the &'Received:'& header. When no
28482 certificate is supplied, &$tls_in_peerdn$& is empty.
28483
28484
28485 .section "Revoked certificates" "SECID184"
28486 .cindex "TLS" "revoked certificates"
28487 .cindex "revocation list"
28488 .cindex "certificate" "revocation list"
28489 .cindex "OCSP" "stapling"
28490 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28491 certificates are revoked. If you have such a list, you can pass it to an Exim
28492 server using the global option called &%tls_crl%& and to an Exim client using
28493 an identically named option for the &(smtp)& transport. In each case, the value
28494 of the option is expanded and must then be the name of a file that contains a
28495 CRL in PEM format.
28496 The downside is that clients have to periodically re-download a potentially huge
28497 file from every certificate authority they know of.
28498
28499 The way with most moving parts at query time is Online Certificate
28500 Status Protocol (OCSP), where the client verifies the certificate
28501 against an OCSP server run by the CA.  This lets the CA track all
28502 usage of the certs.  It requires running software with access to the
28503 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28504 is based on HTTP and can be proxied accordingly.
28505
28506 The only widespread OCSP server implementation (known to this writer)
28507 comes as part of OpenSSL and aborts on an invalid request, such as
28508 connecting to the port and then disconnecting.  This requires
28509 re-entering the passphrase each time some random client does this.
28510
28511 The third way is OCSP Stapling; in this, the server using a certificate
28512 issued by the CA periodically requests an OCSP proof of validity from
28513 the OCSP server, then serves it up inline as part of the TLS
28514 negotiation.   This approach adds no extra round trips, does not let the
28515 CA track users, scales well with number of certs issued by the CA and is
28516 resilient to temporary OCSP server failures, as long as the server
28517 starts retrying to fetch an OCSP proof some time before its current
28518 proof expires.  The downside is that it requires server support.
28519
28520 Unless Exim is built with the support disabled,
28521 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28522 support for OCSP stapling is included.
28523
28524 There is a global option called &%tls_ocsp_file%&.
28525 The file specified therein is expected to be in DER format, and contain
28526 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28527 option will be re-expanded for SNI, if the &%tls_certificate%& option
28528 contains &`tls_in_sni`&, as per other TLS options.
28529
28530 Exim does not at this time implement any support for fetching a new OCSP
28531 proof.  The burden is on the administrator to handle this, outside of
28532 Exim.  The file specified should be replaced atomically, so that the
28533 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28534 on each connection, so a new file will be handled transparently on the
28535 next connection.
28536
28537 When built with OpenSSL Exim will check for a valid next update timestamp
28538 in the OCSP proof; if not present, or if the proof has expired, it will be
28539 ignored.
28540
28541 For the client to be able to verify the stapled OCSP the server must
28542 also supply, in its stapled information, any intermediate
28543 certificates for the chain leading to the OCSP proof from the signer
28544 of the server certificate.  There may be zero or one such. These
28545 intermediate certificates should be added to the server OCSP stapling
28546 file named by &%tls_ocsp_file%&.
28547
28548 Note that the proof only covers the terminal server certificate,
28549 not any of the chain from CA to it.
28550
28551 There is no current way to staple a proof for a client certificate.
28552
28553 .code
28554   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28555   OCSP server is supplied.  The server URL may be included in the
28556   server certificate, if the CA is helpful.
28557
28558   One failure mode seen was the OCSP Signer cert expiring before the end
28559   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28560   noted this as invalid overall, but the re-fetch script did not.
28561 .endd
28562
28563
28564
28565
28566 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28567 .cindex "cipher" "logging"
28568 .cindex "log" "TLS cipher"
28569 .cindex "log" "distinguished name"
28570 .cindex "TLS" "configuring an Exim client"
28571 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28572 deliveries as well as to incoming, the latter one causing logging of the
28573 server certificate's DN. The remaining client configuration for TLS is all
28574 within the &(smtp)& transport.
28575
28576 It is not necessary to set any options to have TLS work in the &(smtp)&
28577 transport. If Exim is built with TLS support, and TLS is advertised by a
28578 server, the &(smtp)& transport always tries to start a TLS session. However,
28579 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28580 transport) to a list of server hosts for which TLS should not be used.
28581
28582 If you do not want Exim to attempt to send messages unencrypted when an attempt
28583 to set up an encrypted connection fails in any way, you can set
28584 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28585 those hosts, delivery is always deferred if an encrypted connection cannot be
28586 set up. If there are any other hosts for the address, they are tried in the
28587 usual way.
28588
28589 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28590 the message unencrypted. It always does this if the response to STARTTLS is
28591 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28592 session after a success response code, what happens is controlled by the
28593 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28594 delivery to this host is deferred, and other hosts (if available) are tried. If
28595 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28596 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28597 negotiation fails, Exim closes the current connection (because it is in an
28598 unknown state), opens a new one to the same host, and then tries the delivery
28599 unencrypted.
28600
28601 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28602 transport provide the client with a certificate, which is passed to the server
28603 if it requests it. If the server is Exim, it will request a certificate only if
28604 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28605
28606 .new
28607 Do not use a certificate which has the OCSP-must-staple extension,
28608 for client use (they are usable for server use).
28609 As TLS has no means for the client to staple before TLS 1.3 it will result
28610 in failed connections.
28611 .wen
28612
28613 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28614 specifies a collection of expected server certificates.
28615 These may be
28616 the system default set (depending on library version),
28617 a file,
28618 or (depending on library version) a directory.
28619 The client verifies the server's certificate
28620 against this collection, taking into account any revoked certificates that are
28621 in the list defined by &%tls_crl%&.
28622 Failure to verify fails the TLS connection unless either of the
28623 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28624
28625 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28626 certificate verification to the listed servers.  Verification either must
28627 or need not succeed respectively.
28628
28629 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28630 checks are made: that the host name (the one in the DNS A record)
28631 is valid for the certificate.
28632 The option defaults to always checking.
28633
28634 The &(smtp)& transport has two OCSP-related options:
28635 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28636 is requested and required for the connection to proceed.  The default
28637 value is empty.
28638 &%hosts_request_ocsp%&; a host-list for which (additionally)
28639 a Certificate Status is requested (but not necessarily verified).  The default
28640 value is "*" meaning that requests are made unless configured
28641 otherwise.
28642
28643 The host(s) should also be in &%hosts_require_tls%&, and
28644 &%tls_verify_certificates%& configured for the transport,
28645 for OCSP to be relevant.
28646
28647 If
28648 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28649 list of permitted cipher suites. If either of these checks fails, delivery to
28650 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28651 alternative hosts, if any.
28652
28653  &*Note*&:
28654 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28655 is operating as a client. Exim does not assume that a server certificate (set
28656 by the global options of the same name) should also be used when operating as a
28657 client.
28658
28659 .vindex "&$host$&"
28660 .vindex "&$host_address$&"
28661 All the TLS options in the &(smtp)& transport are expanded before use, with
28662 &$host$& and &$host_address$& containing the name and address of the server to
28663 which the client is connected. Forced failure of an expansion causes Exim to
28664 behave as if the relevant option were unset.
28665
28666 .vindex &$tls_out_bits$&
28667 .vindex &$tls_out_cipher$&
28668 .vindex &$tls_out_peerdn$&
28669 .vindex &$tls_out_sni$&
28670 Before an SMTP connection is established, the
28671 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28672 variables are emptied. (Until the first connection, they contain the values
28673 that were set when the message was received.) If STARTTLS is subsequently
28674 successfully obeyed, these variables are set to the relevant values for the
28675 outgoing connection.
28676
28677
28678
28679 .section "Use of TLS Server Name Indication" "SECTtlssni"
28680 .cindex "TLS" "Server Name Indication"
28681 .vindex "&$tls_in_sni$&"
28682 .oindex "&%tls_in_sni%&"
28683 With TLS1.0 or above, there is an extension mechanism by which extra
28684 information can be included at various points in the protocol.  One of these
28685 extensions, documented in RFC 6066 (and before that RFC 4366) is
28686 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28687 client in the initial handshake, so that the server can examine the servername
28688 within and possibly choose to use different certificates and keys (and more)
28689 for this session.
28690
28691 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28692 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28693 address.
28694
28695 With SMTP to MX, there are the same problems here as in choosing the identity
28696 against which to validate a certificate: you can't rely on insecure DNS to
28697 provide the identity which you then cryptographically verify.  So this will
28698 be of limited use in that environment.
28699
28700 With SMTP to Submission, there is a well-defined hostname which clients are
28701 connecting to and can validate certificates against.  Thus clients &*can*&
28702 choose to include this information in the TLS negotiation.  If this becomes
28703 wide-spread, then hosters can choose to present different certificates to
28704 different clients.  Or even negotiate different cipher suites.
28705
28706 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28707 if not empty, will be sent on a TLS session as part of the handshake.  There's
28708 nothing more to it.  Choosing a sensible value not derived insecurely is the
28709 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28710 for the lifetime of the client connection (including during authentication).
28711
28712 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28713 received from a client.
28714 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28715
28716 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28717 option (prior to expansion) then the following options will be re-expanded
28718 during TLS session handshake, to permit alternative values to be chosen:
28719
28720 .ilist
28721 &%tls_certificate%&
28722 .next
28723 &%tls_crl%&
28724 .next
28725 &%tls_privatekey%&
28726 .next
28727 &%tls_verify_certificates%&
28728 .next
28729 &%tls_ocsp_file%&
28730 .endlist
28731
28732 Great care should be taken to deal with matters of case, various injection
28733 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28734 can always be referenced; it is important to remember that &$tls_in_sni$& is
28735 arbitrary unverified data provided prior to authentication.
28736 Further, the initial certificate is loaded before SNI has arrived, so
28737 an expansion for &%tls_certificate%& must have a default which is used
28738 when &$tls_in_sni$& is empty.
28739
28740 The Exim developers are proceeding cautiously and so far no other TLS options
28741 are re-expanded.
28742
28743 When Exim is built against OpenSSL, OpenSSL must have been built with support
28744 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28745 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28746 see &`-servername`& in the output, then OpenSSL has support.
28747
28748 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28749 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28750 built, then you have SNI support).
28751
28752
28753
28754 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28755          "SECTmulmessam"
28756 .cindex "multiple SMTP deliveries with TLS"
28757 .cindex "TLS" "multiple message deliveries"
28758 Exim sends multiple messages down the same TCP/IP connection by starting up
28759 an entirely new delivery process for each message, passing the socket from
28760 one process to the next. This implementation does not fit well with the use
28761 of TLS, because there is quite a lot of state information associated with a TLS
28762 connection, not just a socket identification. Passing all the state information
28763 to a new process is not feasible. Consequently, for sending using TLS Exim
28764 starts an additional proxy process for handling the encryption, piping the
28765 unencrypted data stream from and to the delivery processes.
28766
28767 An older mode of operation can be enabled on a per-host basis by the
28768 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28769 this list the proxy process described above is not used; instead Exim
28770 shuts down an existing TLS session being run by the delivery process
28771 before passing the socket to a new process. The new process may then
28772 try to start a new TLS session, and if successful, may try to re-authenticate
28773 if AUTH is in use, before sending the next message.
28774
28775 The RFC is not clear as to whether or not an SMTP session continues in clear
28776 after TLS has been shut down, or whether TLS may be restarted again later, as
28777 just described. However, if the server is Exim, this shutdown and
28778 reinitialization works. It is not known which (if any) other servers operate
28779 successfully if the client closes a TLS session and continues with unencrypted
28780 SMTP, but there are certainly some that do not work. For such servers, Exim
28781 should not pass the socket to another process, because the failure of the
28782 subsequent attempt to use it would cause Exim to record a temporary host error,
28783 and delay other deliveries to that host.
28784
28785 To test for this case, Exim sends an EHLO command to the server after
28786 closing down the TLS session. If this fails in any way, the connection is
28787 closed instead of being passed to a new delivery process, but no retry
28788 information is recorded.
28789
28790 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28791 &(smtp)& transport to match those hosts for which Exim should not pass
28792 connections to new processes if TLS has been used.
28793
28794
28795
28796
28797 .section "Certificates and all that" "SECTcerandall"
28798 .cindex "certificate" "references to discussion"
28799 In order to understand fully how TLS works, you need to know about
28800 certificates, certificate signing, and certificate authorities.
28801 This is a large topic and an introductory guide is unsuitable for the Exim
28802 reference manual, so instead we provide pointers to existing documentation.
28803
28804 The Apache web-server was for a long time the canonical guide, so their
28805 documentation is a good place to start; their SSL module's Introduction
28806 document is currently at
28807 .display
28808 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28809 .endd
28810 and their FAQ is at
28811 .display
28812 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28813 .endd
28814
28815 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28816 0-201-61598-3) in 2001, contains both introductory and more in-depth
28817 descriptions.
28818 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28819 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28820 Ivan is the author of the popular TLS testing tools at
28821 &url(https://www.ssllabs.com/).
28822
28823
28824 .section "Certificate chains" "SECID186"
28825 The file named by &%tls_certificate%& may contain more than one
28826 certificate. This is useful in the case where the certificate that is being
28827 sent is validated by an intermediate certificate which the other end does
28828 not have. Multiple certificates must be in the correct order in the file.
28829 First the host's certificate itself, then the first intermediate
28830 certificate to validate the issuer of the host certificate, then the next
28831 intermediate certificate to validate the issuer of the first intermediate
28832 certificate, and so on, until finally (optionally) the root certificate.
28833 The root certificate must already be trusted by the recipient for
28834 validation to succeed, of course, but if it's not preinstalled, sending the
28835 root certificate along with the rest makes it available for the user to
28836 install if the receiving end is a client MUA that can interact with a user.
28837
28838 Note that certificates using MD5 are unlikely to work on today's Internet;
28839 even if your libraries allow loading them for use in Exim when acting as a
28840 server, increasingly clients will not accept such certificates.  The error
28841 diagnostics in such a case can be frustratingly vague.
28842
28843
28844
28845 .section "Self-signed certificates" "SECID187"
28846 .cindex "certificate" "self-signed"
28847 You can create a self-signed certificate using the &'req'& command provided
28848 with OpenSSL, like this:
28849 . ==== Do not shorten the duration here without reading and considering
28850 . ==== the text below.  Please leave it at 9999 days.
28851 .code
28852 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28853             -days 9999 -nodes
28854 .endd
28855 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28856 delimited and so can be identified independently. The &%-days%& option
28857 specifies a period for which the certificate is valid. The &%-nodes%& option is
28858 important: if you do not set it, the key is encrypted with a passphrase
28859 that you are prompted for, and any use that is made of the key causes more
28860 prompting for the passphrase. This is not helpful if you are going to use
28861 this certificate and key in an MTA, where prompting is not possible.
28862
28863 . ==== I expect to still be working 26 years from now.  The less technical
28864 . ==== debt I create, in terms of storing up trouble for my later years, the
28865 . ==== happier I will be then.  We really have reached the point where we
28866 . ==== should start, at the very least, provoking thought and making folks
28867 . ==== pause before proceeding, instead of leaving all the fixes until two
28868 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28869 . ==== -pdp, 2012
28870 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28871 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28872 the above command might produce a date in the past.  Think carefully about
28873 the lifetime of the systems you're deploying, and either reduce the duration
28874 of the certificate or reconsider your platform deployment.  (At time of
28875 writing, reducing the duration is the most likely choice, but the inexorable
28876 progression of time takes us steadily towards an era where this will not
28877 be a sensible resolution).
28878
28879 A self-signed certificate made in this way is sufficient for testing, and
28880 may be adequate for all your requirements if you are mainly interested in
28881 encrypting transfers, and not in secure identification.
28882
28883 However, many clients require that the certificate presented by the server be a
28884 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28885 certificate. In this situation, the self-signed certificate described above
28886 must be installed on the client host as a trusted root &'certification
28887 authority'& (CA), and the certificate used by Exim must be a user certificate
28888 signed with that self-signed certificate.
28889
28890 For information on creating self-signed CA certificates and using them to sign
28891 user certificates, see the &'General implementation overview'& chapter of the
28892 Open-source PKI book, available online at
28893 &url(https://sourceforge.net/projects/ospkibook/).
28894 .ecindex IIDencsmtp1
28895 .ecindex IIDencsmtp2
28896
28897
28898
28899 .section DANE "SECDANE"
28900 .cindex DANE
28901 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28902 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28903 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28904 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28905 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28906 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28907
28908 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28909 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28910 by (a) is thought to be smaller than that of the set of root CAs.
28911
28912 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28913 fail to pass on a server's STARTTLS.
28914
28915 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28916 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28917 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28918
28919 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28920 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28921 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28922 DNSSEC.
28923 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28924 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28925
28926 There are no changes to Exim specific to server-side operation of DANE.
28927 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28928 in &_Local/Makefile_&.
28929 If it has been included, the macro "_HAVE_DANE" will be defined.
28930
28931 A TLSA record consist of 4 fields, the "Certificate Usage", the
28932 "Selector", the "Matching type", and the "Certificate Association Data".
28933 For a detailed description of the TLSA record see
28934 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
28935
28936 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
28937 These are the "Trust Anchor" and "End Entity" variants.
28938 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28939 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28940 this is appropriate for a single system, using a self-signed certificate.
28941 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28942 well-known one.
28943 A private CA at simplest is just a self-signed certificate (with certain
28944 attributes) which is used to sign server certificates, but running one securely
28945 does require careful arrangement.
28946 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28947 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28948 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28949 all of which point to a single TLSA record.
28950 DANE-TA and DANE-EE can both be used together.
28951
28952 Our recommendation is to use DANE with a certificate from a public CA,
28953 because this enables a variety of strategies for remote clients to verify
28954 your certificate.
28955 You can then publish information both via DANE and another technology,
28956 "MTA-STS", described below.
28957
28958 When you use DANE-TA to publish trust anchor information, you ask entities
28959 outside your administrative control to trust the Certificate Authority for
28960 connections to you.
28961 If using a private CA then you should expect others to still apply the
28962 technical criteria they'd use for a public CA to your certificates.
28963 In particular, you should probably try to follow current best practices for CA
28964 operation around hash algorithms and key sizes.
28965 Do not expect other organizations to lower their security expectations just
28966 because a particular profile might be reasonable for your own internal use.
28967
28968 When this text was last updated, this in practice means to avoid use of SHA-1
28969 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28970 than 4096, for interoperability); to use keyUsage fields correctly; to use
28971 random serial numbers.
28972 The list of requirements is subject to change as best practices evolve.
28973 If you're not already using a private CA, or it doesn't meet these
28974 requirements, then we encourage you to avoid all these issues and use a public
28975 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28976
28977 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
28978 a "Matching Type" (3rd) field of SHA2-512(2).
28979
28980 For the "Certificate Authority Data" (4th) field, commands like
28981
28982 .code
28983   openssl x509 -pubkey -noout <certificate.pem \
28984   | openssl rsa -outform der -pubin 2>/dev/null \
28985   | openssl sha512 \
28986   | awk '{print $2}'
28987 .endd
28988
28989 are workable to create a hash of the certificate's public key.
28990
28991 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
28992
28993 .code
28994   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
28995 .endd
28996
28997 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28998 is useful for quickly generating TLSA records.
28999
29000
29001 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29002
29003 The Certificate issued by the CA published in the DANE-TA model should be
29004 issued using a strong hash algorithm.
29005 Exim, and importantly various other MTAs sending to you, will not
29006 re-enable hash algorithms which have been disabled by default in TLS
29007 libraries.
29008 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29009 interoperability (and probably the maximum too, in 2018).
29010
29011 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29012 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29013 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29014
29015 .code
29016   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29017                                  {= {4}{$tls_out_tlsa_usage}} } \
29018                          {*}{}}
29019 .endd
29020
29021 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29022 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29023 found. If the definition of &%hosts_request_ocsp%& includes the
29024 string "tls_out_tlsa_usage", they are re-expanded in time to
29025 control the OCSP request.
29026
29027 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29028 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29029
29030
29031 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29032 and &%dane_require_tls_ciphers%&.
29033 The require variant will result in failure if the target host is not
29034 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29035 the &%dnssec_request_domains%& router or transport option.
29036
29037 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29038
29039 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29040 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29041 will be required for the host.  If it does not, the host will not
29042 be used; there is no fallback to non-DANE or non-TLS.
29043
29044 If DANE is requested and usable, then the TLS cipher list configuration
29045 prefers to use the option &%dane_require_tls_ciphers%& and falls
29046 back to &%tls_require_ciphers%& only if that is unset.
29047 This lets you configure "decent crypto" for DANE and "better than nothing
29048 crypto" as the default.  Note though that while GnuTLS lets the string control
29049 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29050 limited to ciphersuite constraints.
29051
29052 If DANE is requested and useable (see above) the following transport options are ignored:
29053 .code
29054   hosts_require_tls
29055   tls_verify_hosts
29056   tls_try_verify_hosts
29057   tls_verify_certificates
29058   tls_crl
29059   tls_verify_cert_hostnames
29060 .endd
29061
29062 If DANE is not usable, whether requested or not, and CA-anchored
29063 verification evaluation is wanted, the above variables should be set appropriately.
29064
29065 The router and transport option &%dnssec_request_domains%& must not be
29066 set to "never" and &%dnssec_require_domains%& is ignored.
29067
29068 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29069
29070 There is a new variable &$tls_out_dane$& which will have "yes" if
29071 verification succeeded using DANE and "no" otherwise (only useful
29072 in combination with events; see &<<CHAPevents>>&),
29073 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29074
29075 .cindex DANE reporting
29076 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29077 to achieve DANE-verified connection, if one was either requested and offered, or
29078 required.  This is intended to support TLS-reporting as defined in
29079 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29080 The &$event_data$& will be one of the Result Types defined in
29081 Section 4.3 of that document.
29082
29083 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29084
29085 DANE is specified in published RFCs and decouples certificate authority trust
29086 selection from a "race to the bottom" of "you must trust everything for mail
29087 to get through".  There is an alternative technology called MTA-STS, which
29088 instead publishes MX trust anchor information on an HTTPS website.  At the
29089 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29090 Exim has no support for MTA-STS as a client, but Exim mail server operators
29091 can choose to publish information describing their TLS configuration using
29092 MTA-STS to let those clients who do use that protocol derive trust
29093 information.
29094
29095 The MTA-STS design requires a certificate from a public Certificate Authority
29096 which is recognized by clients sending to you.
29097 That selection of which CAs are trusted by others is outside your control.
29098
29099 The most interoperable course of action is probably to use
29100 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29101 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29102 records for DANE clients (such as Exim and Postfix) and to publish anchor
29103 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29104 domain itself (with caveats around occasionally broken MTA-STS because of
29105 incompatible specification changes prior to reaching RFC status).
29106
29107
29108
29109 . ////////////////////////////////////////////////////////////////////////////
29110 . ////////////////////////////////////////////////////////////////////////////
29111
29112 .chapter "Access control lists" "CHAPACL"
29113 .scindex IIDacl "&ACL;" "description"
29114 .cindex "control of incoming mail"
29115 .cindex "message" "controlling incoming"
29116 .cindex "policy control" "access control lists"
29117 Access Control Lists (ACLs) are defined in a separate section of the runtime
29118 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29119 name, terminated by a colon. Here is a complete ACL section that contains just
29120 one very small ACL:
29121 .code
29122 begin acl
29123 small_acl:
29124   accept   hosts = one.host.only
29125 .endd
29126 You can have as many lists as you like in the ACL section, and the order in
29127 which they appear does not matter. The lists are self-terminating.
29128
29129 The majority of ACLs are used to control Exim's behaviour when it receives
29130 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29131 when a local process submits a message using SMTP by specifying the &%-bs%&
29132 option. The most common use is for controlling which recipients are accepted
29133 in incoming messages. In addition, you can define an ACL that is used to check
29134 local non-SMTP messages. The default configuration file contains an example of
29135 a realistic ACL for checking RCPT commands. This is discussed in chapter
29136 &<<CHAPdefconfil>>&.
29137
29138
29139 .section "Testing ACLs" "SECID188"
29140 The &%-bh%& command line option provides a way of testing your ACL
29141 configuration locally by running a fake SMTP session with which you interact.
29142
29143
29144 .section "Specifying when ACLs are used" "SECID189"
29145 .cindex "&ACL;" "options for specifying"
29146 In order to cause an ACL to be used, you have to name it in one of the relevant
29147 options in the main part of the configuration. These options are:
29148 .cindex "AUTH" "ACL for"
29149 .cindex "DATA" "ACLs for"
29150 .cindex "ETRN" "ACL for"
29151 .cindex "EXPN" "ACL for"
29152 .cindex "HELO" "ACL for"
29153 .cindex "EHLO" "ACL for"
29154 .cindex "DKIM" "ACL for"
29155 .cindex "MAIL" "ACL for"
29156 .cindex "QUIT, ACL for"
29157 .cindex "RCPT" "ACL for"
29158 .cindex "STARTTLS, ACL for"
29159 .cindex "VRFY" "ACL for"
29160 .cindex "SMTP" "connection, ACL for"
29161 .cindex "non-SMTP messages" "ACLs for"
29162 .cindex "MIME content scanning" "ACL for"
29163 .cindex "PRDR" "ACL for"
29164
29165 .table2 140pt
29166 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29167 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29168 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29169 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29170 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29171 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29172 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29173 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29174 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29175 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29176 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29177 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29178 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29179 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29180 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29181 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29182 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29183 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29184 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29185 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29186 .endtable
29187
29188 For example, if you set
29189 .code
29190 acl_smtp_rcpt = small_acl
29191 .endd
29192 the little ACL defined above is used whenever Exim receives a RCPT command
29193 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29194 done when RCPT commands arrive. A rejection of RCPT should cause the
29195 sending MTA to give up on the recipient address contained in the RCPT
29196 command, whereas rejection at other times may cause the client MTA to keep on
29197 trying to deliver the message. It is therefore recommended that you do as much
29198 testing as possible at RCPT time.
29199
29200
29201 .section "The non-SMTP ACLs" "SECID190"
29202 .cindex "non-SMTP messages" "ACLs for"
29203 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29204 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29205 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29206 the state of the SMTP connection such as encryption and authentication) are not
29207 relevant and are forbidden in these ACLs. However, the sender and recipients
29208 are known, so the &%senders%& and &%sender_domains%& conditions and the
29209 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29210 &$authenticated_sender$& are also available. You can specify added header lines
29211 in any of these ACLs.
29212
29213 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29214 non-SMTP message, before any of the message has been read. (This is the
29215 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29216 batched SMTP input, it runs after the DATA command has been reached. The
29217 result of this ACL is ignored; it cannot be used to reject a message. If you
29218 really need to, you could set a value in an ACL variable here and reject based
29219 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29220 controls, and in particular, it can be used to set
29221 .code
29222 control = suppress_local_fixups
29223 .endd
29224 This cannot be used in the other non-SMTP ACLs because by the time they are
29225 run, it is too late.
29226
29227 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29228 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29229
29230 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29231 kind of rejection is treated as permanent, because there is no way of sending a
29232 temporary error for these kinds of message.
29233
29234
29235 .section "The SMTP connect ACL" "SECID191"
29236 .cindex "SMTP" "connection, ACL for"
29237 .oindex &%smtp_banner%&
29238 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29239 session, after the test specified by &%host_reject_connection%& (which is now
29240 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29241 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29242 the message override the banner message that is otherwise specified by the
29243 &%smtp_banner%& option.
29244
29245
29246 .section "The EHLO/HELO ACL" "SECID192"
29247 .cindex "EHLO" "ACL for"
29248 .cindex "HELO" "ACL for"
29249 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29250 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29251 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29252 Note that a client may issue more than one EHLO or HELO command in an SMTP
29253 session, and indeed is required to issue a new EHLO or HELO after successfully
29254 setting up encryption following a STARTTLS command.
29255
29256 Note also that a deny neither forces the client to go away nor means that
29257 mail will be refused on the connection.  Consider checking for
29258 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29259
29260 If the command is accepted by an &%accept%& verb that has a &%message%&
29261 modifier, the message may not contain more than one line (it will be truncated
29262 at the first newline and a panic logged if it does). Such a message cannot
29263 affect the EHLO options that are listed on the second and subsequent lines of
29264 an EHLO response.
29265
29266
29267 .section "The DATA ACLs" "SECID193"
29268 .cindex "DATA" "ACLs for"
29269 Two ACLs are associated with the DATA command, because it is two-stage
29270 command, with two responses being sent to the client.
29271 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29272 is obeyed. This gives you control after all the RCPT commands, but before
29273 the message itself is received. It offers the opportunity to give a negative
29274 response to the DATA command before the data is transmitted. Header lines
29275 added by MAIL or RCPT ACLs are not visible at this time, but any that
29276 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29277
29278 You cannot test the contents of the message, for example, to verify addresses
29279 in the headers, at RCPT time or when the DATA command is received. Such
29280 tests have to appear in the ACL that is run after the message itself has been
29281 received, before the final response to the DATA command is sent. This is
29282 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29283 associated with the DATA command.
29284
29285 .cindex CHUNKING "BDAT command"
29286 .cindex BDAT "SMTP command"
29287 .cindex "RFC 3030" CHUNKING
29288 If CHUNKING was advertised and a BDAT command sequence is received,
29289 the &%acl_smtp_predata%& ACL is not run.
29290 . XXX why not?  It should be possible, for the first BDAT.
29291 The &%acl_smtp_data%& is run after the last BDAT command and all of
29292 the data specified is received.
29293
29294 For both of these ACLs, it is not possible to reject individual recipients. An
29295 error response rejects the entire message. Unfortunately, it is known that some
29296 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29297 before or after the data) correctly &-- they keep the message on their queues
29298 and try again later, but that is their problem, though it does waste some of
29299 your resources.
29300
29301 The &%acl_smtp_data%& ACL is run after
29302 the &%acl_smtp_data_prdr%&,
29303 the &%acl_smtp_dkim%&
29304 and the &%acl_smtp_mime%& ACLs.
29305
29306 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29307 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29308 enabled (which is the default).
29309
29310 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29311 received, and is executed for each DKIM signature found in a message.  If not
29312 otherwise specified, the default action is to accept.
29313
29314 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29315
29316 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29317
29318
29319 .section "The SMTP MIME ACL" "SECID194"
29320 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29321 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29322
29323 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29324
29325
29326 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29327 .cindex "PRDR" "ACL for"
29328 .oindex "&%prdr_enable%&"
29329 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29330 with PRDR support enabled (which is the default).
29331 It becomes active only when the PRDR feature is negotiated between
29332 client and server for a message, and more than one recipient
29333 has been accepted.
29334
29335 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29336 has been received, and is executed once for each recipient of the message
29337 with &$local_part$& and &$domain$& valid.
29338 The test may accept, defer or deny for individual recipients.
29339 The &%acl_smtp_data%& will still be called after this ACL and
29340 can reject the message overall, even if this ACL has accepted it
29341 for some or all recipients.
29342
29343 PRDR may be used to support per-user content filtering.  Without it
29344 one must defer any recipient after the first that has a different
29345 content-filter configuration.  With PRDR, the RCPT-time check
29346 .cindex "PRDR" "variable for"
29347 for this can be disabled when the variable &$prdr_requested$&
29348 is &"yes"&.
29349 Any required difference in behaviour of the main DATA-time
29350 ACL should however depend on the PRDR-time ACL having run, as Exim
29351 will avoid doing so in some situations (e.g. single-recipient mails).
29352
29353 See also the &%prdr_enable%& global option
29354 and the &%hosts_try_prdr%& smtp transport option.
29355
29356 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29357 If the ACL is not defined, processing completes as if
29358 the feature was not requested by the client.
29359
29360 .section "The QUIT ACL" "SECTQUITACL"
29361 .cindex "QUIT, ACL for"
29362 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29363 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29364 does not in fact control any access.
29365 For this reason, it may only accept
29366 or warn as its final result.
29367
29368 This ACL can be used for tasks such as custom logging at the end of an SMTP
29369 session. For example, you can use ACL variables in other ACLs to count
29370 messages, recipients, etc., and log the totals at QUIT time using one or
29371 more &%logwrite%& modifiers on a &%warn%& verb.
29372
29373 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29374 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29375
29376 You do not need to have a final &%accept%&, but if you do, you can use a
29377 &%message%& modifier to specify custom text that is sent as part of the 221
29378 response to QUIT.
29379
29380 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29381 failure (for example, failure to open a log file, or when Exim is bombing out
29382 because it has detected an unrecoverable error), all SMTP commands from the
29383 client are given temporary error responses until QUIT is received or the
29384 connection is closed. In these special cases, the QUIT ACL does not run.
29385
29386
29387 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29388 .vindex &$acl_smtp_notquit$&
29389 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29390 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29391 trouble, such as being unable to write to its log files, this ACL is not run,
29392 because it might try to do things (such as write to log files) that make the
29393 situation even worse.
29394
29395 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29396 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29397 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29398 and &%warn%&.
29399
29400 .vindex &$smtp_notquit_reason$&
29401 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29402 to a string that indicates the reason for the termination of the SMTP
29403 connection. The possible values are:
29404 .table2
29405 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29406 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29407 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29408 .irow &`connection-lost`&          "The SMTP connection has been lost"
29409 .irow &`data-timeout`&             "Timeout while reading message data"
29410 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29411 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29412 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29413 .irow &`synchronization-error`&    "SMTP synchronization error"
29414 .irow &`tls-failed`&               "TLS failed to start"
29415 .endtable
29416 In most cases when an SMTP connection is closed without having received QUIT,
29417 Exim sends an SMTP response message before actually closing the connection.
29418 With the exception of the &`acl-drop`& case, the default message can be
29419 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29420 &%drop%& verb in another ACL, it is the message from the other ACL that is
29421 used.
29422
29423
29424 .section "Finding an ACL to use" "SECID195"
29425 .cindex "&ACL;" "finding which to use"
29426 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29427 you can use different ACLs in different circumstances. For example,
29428 .code
29429 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29430                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29431 .endd
29432 In the default configuration file there are some example settings for
29433 providing an RFC 4409 message &"submission"& service on port 587 and
29434 an RFC 8314 &"submissions"& service on port 465. You can use a string
29435 expansion like this to choose an ACL for MUAs on these ports which is
29436 more appropriate for this purpose than the default ACL on port 25.
29437
29438 The expanded string does not have to be the name of an ACL in the
29439 configuration file; there are other possibilities. Having expanded the
29440 string, Exim searches for an ACL as follows:
29441
29442 .ilist
29443 If the string begins with a slash, Exim uses it as a filename, and reads its
29444 contents as an ACL. The lines are processed in the same way as lines in the
29445 Exim configuration file. In particular, continuation lines are supported, blank
29446 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29447 If the file does not exist or cannot be read, an error occurs (typically
29448 causing a temporary failure of whatever caused the ACL to be run). For example:
29449 .code
29450 acl_smtp_data = /etc/acls/\
29451   ${lookup{$sender_host_address}lsearch\
29452   {/etc/acllist}{$value}{default}}
29453 .endd
29454 This looks up an ACL file to use on the basis of the host's IP address, falling
29455 back to a default if the lookup fails. If an ACL is successfully read from a
29456 file, it is retained in memory for the duration of the Exim process, so that it
29457 can be re-used without having to re-read the file.
29458 .next
29459 If the string does not start with a slash, and does not contain any spaces,
29460 Exim searches the ACL section of the configuration for an ACL whose name
29461 matches the string.
29462 .next
29463 If no named ACL is found, or if the string contains spaces, Exim parses
29464 the string as an inline ACL. This can save typing in cases where you just
29465 want to have something like
29466 .code
29467 acl_smtp_vrfy = accept
29468 .endd
29469 in order to allow free use of the VRFY command. Such a string may contain
29470 newlines; it is processed in the same way as an ACL that is read from a file.
29471 .endlist
29472
29473
29474
29475
29476 .section "ACL return codes" "SECID196"
29477 .cindex "&ACL;" "return codes"
29478 Except for the QUIT ACL, which does not affect the SMTP return code (see
29479 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29480 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29481 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29482 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29483 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29484 This also causes a 4&'xx'& return code.
29485
29486 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29487 &"deny"&, because there is no mechanism for passing temporary errors to the
29488 submitters of non-SMTP messages.
29489
29490
29491 ACLs that are relevant to message reception may also return &"discard"&. This
29492 has the effect of &"accept"&, but causes either the entire message or an
29493 individual recipient address to be discarded. In other words, it is a
29494 blackholing facility. Use it with care.
29495
29496 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29497 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29498 RCPT ACL is to discard just the one recipient address. If there are no
29499 recipients left when the message's data is received, the DATA ACL is not
29500 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29501 remaining recipients. The &"discard"& return is not permitted for the
29502 &%acl_smtp_predata%& ACL.
29503
29504 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29505 is done on the address and the result determines the SMTP response.
29506
29507
29508 .cindex "&[local_scan()]& function" "when all recipients discarded"
29509 The &[local_scan()]& function is always run, even if there are no remaining
29510 recipients; it may create new recipients.
29511
29512
29513
29514 .section "Unset ACL options" "SECID197"
29515 .cindex "&ACL;" "unset options"
29516 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29517 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29518 not defined at all. For any defined ACL, the default action when control
29519 reaches the end of the ACL statements is &"deny"&.
29520
29521 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29522 these two are ACLs that are used only for their side effects. They cannot be
29523 used to accept or reject anything.
29524
29525 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29526 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29527 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29528 when the ACL is not defined is &"accept"&.
29529
29530 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29531 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29532 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29533 messages over an SMTP connection. For an example, see the ACL in the default
29534 configuration file.
29535
29536
29537
29538
29539 .section "Data for message ACLs" "SECID198"
29540 .cindex "&ACL;" "data for message ACL"
29541 .vindex &$domain$&
29542 .vindex &$local_part$&
29543 .vindex &$sender_address$&
29544 .vindex &$sender_host_address$&
29545 .vindex &$smtp_command$&
29546 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29547 that contain information about the host and the message's sender (for example,
29548 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29549 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29550 &$local_part$& are set from the argument address. The entire SMTP command
29551 is available in &$smtp_command$&.
29552
29553 When an ACL for the AUTH parameter of MAIL is running, the variables that
29554 contain information about the host are set, but &$sender_address$& is not yet
29555 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29556 how it is used.
29557
29558 .vindex "&$message_size$&"
29559 The &$message_size$& variable is set to the value of the SIZE parameter on
29560 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29561 that parameter is not given. The value is updated to the true message size by
29562 the time the final DATA ACL is run (after the message data has been
29563 received).
29564
29565 .vindex "&$rcpt_count$&"
29566 .vindex "&$recipients_count$&"
29567 The &$rcpt_count$& variable increases by one for each RCPT command received.
29568 The &$recipients_count$& variable increases by one each time a RCPT command is
29569 accepted, so while an ACL for RCPT is being processed, it contains the number
29570 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29571 &$rcpt_count$& contains the total number of RCPT commands, and
29572 &$recipients_count$& contains the total number of accepted recipients.
29573
29574
29575
29576
29577
29578 .section "Data for non-message ACLs" "SECTdatfornon"
29579 .cindex "&ACL;" "data for non-message ACL"
29580 .vindex &$smtp_command_argument$&
29581 .vindex &$smtp_command$&
29582 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29583 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29584 and the entire SMTP command is available in &$smtp_command$&.
29585 These variables can be tested using a &%condition%& condition. For example,
29586 here is an ACL for use with AUTH, which insists that either the session is
29587 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29588 does not permit authentication methods that use cleartext passwords on
29589 unencrypted connections.
29590 .code
29591 acl_check_auth:
29592   accept encrypted = *
29593   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29594                      {CRAM-MD5}}
29595   deny   message   = TLS encryption or CRAM-MD5 required
29596 .endd
29597 (Another way of applying this restriction is to arrange for the authenticators
29598 that use cleartext passwords not to be advertised when the connection is not
29599 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29600 option to do this.)
29601
29602
29603
29604 .section "Format of an ACL" "SECID199"
29605 .cindex "&ACL;" "format of"
29606 .cindex "&ACL;" "verbs, definition of"
29607 An individual ACL consists of a number of statements. Each statement starts
29608 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29609 Modifiers can change the way the verb operates, define error and log messages,
29610 set variables, insert delays, and vary the processing of accepted messages.
29611
29612 If all the conditions are met, the verb is obeyed. The same condition may be
29613 used (with different arguments) more than once in the same statement. This
29614 provides a means of specifying an &"and"& conjunction between conditions. For
29615 example:
29616 .code
29617 deny  dnslists = list1.example
29618       dnslists = list2.example
29619 .endd
29620 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29621 the conditions and modifiers when it reaches a condition that fails. What
29622 happens then depends on the verb (and in one case, on a special modifier). Not
29623 all the conditions make sense at every testing point. For example, you cannot
29624 test a sender address in the ACL that is run for a VRFY command.
29625
29626
29627 .section "ACL verbs" "SECID200"
29628 The ACL verbs are as follows:
29629
29630 .ilist
29631 .cindex "&%accept%& ACL verb"
29632 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29633 of the conditions are not met, what happens depends on whether &%endpass%&
29634 appears among the conditions (for syntax see below). If the failing condition
29635 is before &%endpass%&, control is passed to the next ACL statement; if it is
29636 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29637 check a RCPT command:
29638 .code
29639 accept domains = +local_domains
29640        endpass
29641        verify = recipient
29642 .endd
29643 If the recipient domain does not match the &%domains%& condition, control
29644 passes to the next statement. If it does match, the recipient is verified, and
29645 the command is accepted if verification succeeds. However, if verification
29646 fails, the ACL yields &"deny"&, because the failing condition is after
29647 &%endpass%&.
29648
29649 The &%endpass%& feature has turned out to be confusing to many people, so its
29650 use is not recommended nowadays. It is always possible to rewrite an ACL so
29651 that &%endpass%& is not needed, and it is no longer used in the default
29652 configuration.
29653
29654 .cindex "&%message%& ACL modifier" "with &%accept%&"
29655 If a &%message%& modifier appears on an &%accept%& statement, its action
29656 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29657 (when an &%accept%& verb either accepts or passes control to the next
29658 statement), &%message%& can be used to vary the message that is sent when an
29659 SMTP command is accepted. For example, in a RCPT ACL you could have:
29660 .display
29661 &`accept  `&<&'some conditions'&>
29662 &`        message = OK, I will allow you through today`&
29663 .endd
29664 You can specify an SMTP response code, optionally followed by an &"extended
29665 response code"& at the start of the message, but the first digit must be the
29666 same as would be sent by default, which is 2 for an &%accept%& verb.
29667
29668 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29669 an error message that is used when access is denied. This behaviour is retained
29670 for backward compatibility, but current &"best practice"& is to avoid the use
29671 of &%endpass%&.
29672
29673
29674 .next
29675 .cindex "&%defer%& ACL verb"
29676 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29677 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29678 &%defer%& is the same as &%deny%&, because there is no way of sending a
29679 temporary error. For a RCPT command, &%defer%& is much the same as using a
29680 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29681 be used in any ACL, and even for a recipient it might be a simpler approach.
29682
29683
29684 .next
29685 .cindex "&%deny%& ACL verb"
29686 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29687 the conditions are not met, control is passed to the next ACL statement. For
29688 example,
29689 .code
29690 deny dnslists = blackholes.mail-abuse.org
29691 .endd
29692 rejects commands from hosts that are on a DNS black list.
29693
29694
29695 .next
29696 .cindex "&%discard%& ACL verb"
29697 &%discard%&: This verb behaves like &%accept%&, except that it returns
29698 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29699 that are concerned with receiving messages. When all the conditions are true,
29700 the sending entity receives a &"success"& response. However, &%discard%& causes
29701 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29702 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29703 message's recipients are discarded. Recipients that are discarded before DATA
29704 do not appear in the log line when the &%received_recipients%& log selector is set.
29705
29706 If the &%log_message%& modifier is set when &%discard%& operates,
29707 its contents are added to the line that is automatically written to the log.
29708 The &%message%& modifier operates exactly as it does for &%accept%&.
29709
29710
29711 .next
29712 .cindex "&%drop%& ACL verb"
29713 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29714 forcibly closed after the 5&'xx'& error message has been sent. For example:
29715 .code
29716 drop   message   = I don't take more than 20 RCPTs
29717        condition = ${if > {$rcpt_count}{20}}
29718 .endd
29719 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29720 The connection is always dropped after sending a 550 response.
29721
29722 .next
29723 .cindex "&%require%& ACL verb"
29724 &%require%&: If all the conditions are met, control is passed to the next ACL
29725 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29726 example, when checking a RCPT command,
29727 .code
29728 require message = Sender did not verify
29729         verify  = sender
29730 .endd
29731 passes control to subsequent statements only if the message's sender can be
29732 verified. Otherwise, it rejects the command. Note the positioning of the
29733 &%message%& modifier, before the &%verify%& condition. The reason for this is
29734 discussed in section &<<SECTcondmodproc>>&.
29735
29736 .next
29737 .cindex "&%warn%& ACL verb"
29738 &%warn%&: If all the conditions are true, a line specified by the
29739 &%log_message%& modifier is written to Exim's main log. Control always passes
29740 to the next ACL statement. If any condition is false, the log line is not
29741 written. If an identical log line is requested several times in the same
29742 message, only one copy is actually written to the log. If you want to force
29743 duplicates to be written, use the &%logwrite%& modifier instead.
29744
29745 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29746 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29747 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29748 first failing condition. There is more about adding header lines in section
29749 &<<SECTaddheadacl>>&.
29750
29751 If any condition on a &%warn%& statement cannot be completed (that is, there is
29752 some sort of defer), the log line specified by &%log_message%& is not written.
29753 This does not include the case of a forced failure from a lookup, which
29754 is considered to be a successful completion. After a defer, no further
29755 conditions or modifiers in the &%warn%& statement are processed. The incident
29756 is logged, and the ACL continues to be processed, from the next statement
29757 onwards.
29758
29759
29760 .vindex "&$acl_verify_message$&"
29761 When one of the &%warn%& conditions is an address verification that fails, the
29762 text of the verification failure message is in &$acl_verify_message$&. If you
29763 want this logged, you must set it up explicitly. For example:
29764 .code
29765 warn   !verify = sender
29766        log_message = sender verify failed: $acl_verify_message
29767 .endd
29768 .endlist
29769
29770 At the end of each ACL there is an implicit unconditional &%deny%&.
29771
29772 As you can see from the examples above, the conditions and modifiers are
29773 written one to a line, with the first one on the same line as the verb, and
29774 subsequent ones on following lines. If you have a very long condition, you can
29775 continue it onto several physical lines by the usual backslash continuation
29776 mechanism. It is conventional to align the conditions vertically.
29777
29778
29779
29780 .section "ACL variables" "SECTaclvariables"
29781 .cindex "&ACL;" "variables"
29782 There are some special variables that can be set during ACL processing. They
29783 can be used to pass information between different ACLs, different invocations
29784 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29785 transports, and filters that are used to deliver a message. The names of these
29786 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29787 an underscore, but the remainder of the name can be any sequence of
29788 alphanumeric characters and underscores that you choose. There is no limit on
29789 the number of ACL variables. The two sets act as follows:
29790 .ilist
29791 The values of those variables whose names begin with &$acl_c$& persist
29792 throughout an SMTP connection. They are never reset. Thus, a value that is set
29793 while receiving one message is still available when receiving the next message
29794 on the same SMTP connection.
29795 .next
29796 The values of those variables whose names begin with &$acl_m$& persist only
29797 while a message is being received. They are reset afterwards. They are also
29798 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29799 .endlist
29800
29801 When a message is accepted, the current values of all the ACL variables are
29802 preserved with the message and are subsequently made available at delivery
29803 time. The ACL variables are set by a modifier called &%set%&. For example:
29804 .code
29805 accept hosts = whatever
29806        set acl_m4 = some value
29807 accept authenticated = *
29808        set acl_c_auth = yes
29809 .endd
29810 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29811 be set. If you want to set a variable without taking any action, you can use a
29812 &%warn%& verb without any other modifiers or conditions.
29813
29814 .oindex &%strict_acl_vars%&
29815 What happens if a syntactically valid but undefined ACL variable is
29816 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29817 false (the default), an empty string is substituted; if it is true, an
29818 error is generated.
29819
29820 Versions of Exim before 4.64 have a limited set of numbered variables, but
29821 their names are compatible, so there is no problem with upgrading.
29822
29823
29824 .section "Condition and modifier processing" "SECTcondmodproc"
29825 .cindex "&ACL;" "conditions; processing"
29826 .cindex "&ACL;" "modifiers; processing"
29827 An exclamation mark preceding a condition negates its result. For example:
29828 .code
29829 deny   domains = *.dom.example
29830       !verify  = recipient
29831 .endd
29832 causes the ACL to return &"deny"& if the recipient domain ends in
29833 &'dom.example'& and the recipient address cannot be verified. Sometimes
29834 negation can be used on the right-hand side of a condition. For example, these
29835 two statements are equivalent:
29836 .code
29837 deny  hosts = !192.168.3.4
29838 deny !hosts =  192.168.3.4
29839 .endd
29840 However, for many conditions (&%verify%& being a good example), only left-hand
29841 side negation of the whole condition is possible.
29842
29843 The arguments of conditions and modifiers are expanded. A forced failure
29844 of an expansion causes a condition to be ignored, that is, it behaves as if the
29845 condition is true. Consider these two statements:
29846 .code
29847 accept  senders = ${lookup{$host_name}lsearch\
29848                   {/some/file}{$value}fail}
29849 accept  senders = ${lookup{$host_name}lsearch\
29850                   {/some/file}{$value}{}}
29851 .endd
29852 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29853 the returned list is searched, but if the lookup fails the behaviour is
29854 different in the two cases. The &%fail%& in the first statement causes the
29855 condition to be ignored, leaving no further conditions. The &%accept%& verb
29856 therefore succeeds. The second statement, however, generates an empty list when
29857 the lookup fails. No sender can match an empty list, so the condition fails,
29858 and therefore the &%accept%& also fails.
29859
29860 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29861 specify actions that are taken as the conditions for a statement are checked;
29862 others specify text for messages that are used when access is denied or a
29863 warning is generated. The &%control%& modifier affects the way an incoming
29864 message is handled.
29865
29866 The positioning of the modifiers in an ACL statement is important, because the
29867 processing of a verb ceases as soon as its outcome is known. Only those
29868 modifiers that have already been encountered will take effect. For example,
29869 consider this use of the &%message%& modifier:
29870 .code
29871 require message = Can't verify sender
29872         verify  = sender
29873         message = Can't verify recipient
29874         verify  = recipient
29875         message = This message cannot be used
29876 .endd
29877 If sender verification fails, Exim knows that the result of the statement is
29878 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29879 so its text is used as the error message. If sender verification succeeds, but
29880 recipient verification fails, the second message is used. If recipient
29881 verification succeeds, the third message becomes &"current"&, but is never used
29882 because there are no more conditions to cause failure.
29883
29884 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29885 modifier that is used, because all the conditions must be true for rejection to
29886 happen. Specifying more than one &%message%& modifier does not make sense, and
29887 the message can even be specified after all the conditions. For example:
29888 .code
29889 deny   hosts = ...
29890       !senders = *@my.domain.example
29891        message = Invalid sender from client host
29892 .endd
29893 The &"deny"& result does not happen until the end of the statement is reached,
29894 by which time Exim has set up the message.
29895
29896
29897
29898 .section "ACL modifiers" "SECTACLmodi"
29899 .cindex "&ACL;" "modifiers; list of"
29900 The ACL modifiers are as follows:
29901
29902 .vlist
29903 .vitem &*add_header*&&~=&~<&'text'&>
29904 This modifier specifies one or more header lines that are to be added to an
29905 incoming message, assuming, of course, that the message is ultimately
29906 accepted. For details, see section &<<SECTaddheadacl>>&.
29907
29908 .vitem &*continue*&&~=&~<&'text'&>
29909 .cindex "&%continue%& ACL modifier"
29910 .cindex "database" "updating in ACL"
29911 This modifier does nothing of itself, and processing of the ACL always
29912 continues with the next condition or modifier. The value of &%continue%& is in
29913 the side effects of expanding its argument. Typically this could be used to
29914 update a database. It is really just a syntactic tidiness, to avoid having to
29915 write rather ugly lines like this:
29916 .display
29917 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29918 .endd
29919 Instead, all you need is
29920 .display
29921 &`continue = `&<&'some expansion'&>
29922 .endd
29923
29924 .vitem &*control*&&~=&~<&'text'&>
29925 .cindex "&%control%& ACL modifier"
29926 This modifier affects the subsequent processing of the SMTP connection or of an
29927 incoming message that is accepted. The effect of the first type of control
29928 lasts for the duration of the connection, whereas the effect of the second type
29929 lasts only until the current message has been received. The message-specific
29930 controls always apply to the whole message, not to individual recipients,
29931 even if the &%control%& modifier appears in a RCPT ACL.
29932
29933 As there are now quite a few controls that can be applied, they are described
29934 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29935 in several different ways. For example:
29936
29937 . ==== As this is a nested list, any displays it contains must be indented
29938 . ==== as otherwise they are too far to the left. That comment applies only
29939 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29940 . ==== way.
29941
29942 .ilist
29943 It can be at the end of an &%accept%& statement:
29944 .code
29945     accept  ...some conditions
29946             control = queue_only
29947 .endd
29948 In this case, the control is applied when this statement yields &"accept"&, in
29949 other words, when the conditions are all true.
29950
29951 .next
29952 It can be in the middle of an &%accept%& statement:
29953 .code
29954     accept  ...some conditions...
29955             control = queue_only
29956             ...some more conditions...
29957 .endd
29958 If the first set of conditions are true, the control is applied, even if the
29959 statement does not accept because one of the second set of conditions is false.
29960 In this case, some subsequent statement must yield &"accept"& for the control
29961 to be relevant.
29962
29963 .next
29964 It can be used with &%warn%& to apply the control, leaving the
29965 decision about accepting or denying to a subsequent verb. For
29966 example:
29967 .code
29968     warn    ...some conditions...
29969             control = freeze
29970     accept  ...
29971 .endd
29972 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29973 &%logwrite%&, so it does not add anything to the message and does not write a
29974 log entry.
29975
29976 .next
29977 If you want to apply a control unconditionally, you can use it with a
29978 &%require%& verb. For example:
29979 .code
29980     require  control = no_multiline_responses
29981 .endd
29982 .endlist
29983
29984 .vitem &*delay*&&~=&~<&'time'&>
29985 .cindex "&%delay%& ACL modifier"
29986 .oindex "&%-bh%&"
29987 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29988 the time interval before proceeding. However, when testing Exim using the
29989 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29990 output instead). The time is given in the usual Exim notation, and the delay
29991 happens as soon as the modifier is processed. In an SMTP session, pending
29992 output is flushed before the delay is imposed.
29993
29994 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29995 example:
29996 .code
29997 deny    ...some conditions...
29998         delay = 30s
29999 .endd
30000 The delay happens if all the conditions are true, before the statement returns
30001 &"deny"&. Compare this with:
30002 .code
30003 deny    delay = 30s
30004         ...some conditions...
30005 .endd
30006 which waits for 30s before processing the conditions. The &%delay%& modifier
30007 can also be used with &%warn%& and together with &%control%&:
30008 .code
30009 warn    ...some conditions...
30010         delay = 2m
30011         control = freeze
30012 accept  ...
30013 .endd
30014
30015 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30016 responses to several commands are no longer buffered and sent in one packet (as
30017 they would normally be) because all output is flushed before imposing the
30018 delay. This optimization is disabled so that a number of small delays do not
30019 appear to the client as one large aggregated delay that might provoke an
30020 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30021 using a &%control%& modifier to set &%no_delay_flush%&.
30022
30023
30024 .vitem &*endpass*&
30025 .cindex "&%endpass%& ACL modifier"
30026 This modifier, which has no argument, is recognized only in &%accept%& and
30027 &%discard%& statements. It marks the boundary between the conditions whose
30028 failure causes control to pass to the next statement, and the conditions whose
30029 failure causes the ACL to return &"deny"&. This concept has proved to be
30030 confusing to some people, so the use of &%endpass%& is no longer recommended as
30031 &"best practice"&. See the description of &%accept%& above for more details.
30032
30033
30034 .vitem &*log_message*&&~=&~<&'text'&>
30035 .cindex "&%log_message%& ACL modifier"
30036 This modifier sets up a message that is used as part of the log message if the
30037 ACL denies access or a &%warn%& statement's conditions are true. For example:
30038 .code
30039 require log_message = wrong cipher suite $tls_in_cipher
30040         encrypted   = DES-CBC3-SHA
30041 .endd
30042 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30043 example:
30044 .display
30045 &`discard `&<&'some conditions'&>
30046 &`        log_message = Discarded $local_part@$domain because...`&
30047 .endd
30048 When access is denied, &%log_message%& adds to any underlying error message
30049 that may exist because of a condition failure. For example, while verifying a
30050 recipient address, a &':fail:'& redirection might have already set up a
30051 message.
30052
30053 The message may be defined before the conditions to which it applies, because
30054 the string expansion does not happen until Exim decides that access is to be
30055 denied. This means that any variables that are set by the condition are
30056 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30057 variables are set after a DNS black list lookup succeeds. If the expansion of
30058 &%log_message%& fails, or if the result is an empty string, the modifier is
30059 ignored.
30060
30061 .vindex "&$acl_verify_message$&"
30062 If you want to use a &%warn%& statement to log the result of an address
30063 verification, you can use &$acl_verify_message$& to include the verification
30064 error message.
30065
30066 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30067 the start of the logged message. If the same warning log message is requested
30068 more than once while receiving  a single email message, only one copy is
30069 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30070 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30071 is logged for a successful &%warn%& statement.
30072
30073 If &%log_message%& is not present and there is no underlying error message (for
30074 example, from the failure of address verification), but &%message%& is present,
30075 the &%message%& text is used for logging rejections. However, if any text for
30076 logging contains newlines, only the first line is logged. In the absence of
30077 both &%log_message%& and &%message%&, a default built-in message is used for
30078 logging rejections.
30079
30080
30081 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30082 .cindex "&%log_reject_target%& ACL modifier"
30083 .cindex "logging in ACL" "specifying which log"
30084 This modifier makes it possible to specify which logs are used for messages
30085 about ACL rejections. Its argument is a colon-separated list of words that can
30086 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30087 may be empty, in which case a rejection is not logged at all. For example, this
30088 ACL fragment writes no logging information when access is denied:
30089 .display
30090 &`deny `&<&'some conditions'&>
30091 &`     log_reject_target =`&
30092 .endd
30093 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30094 permanent and temporary rejections. Its effect lasts for the rest of the
30095 current ACL.
30096
30097
30098 .vitem &*logwrite*&&~=&~<&'text'&>
30099 .cindex "&%logwrite%& ACL modifier"
30100 .cindex "logging in ACL" "immediate"
30101 This modifier writes a message to a log file as soon as it is encountered when
30102 processing an ACL. (Compare &%log_message%&, which, except in the case of
30103 &%warn%& and &%discard%&, is used only if the ACL statement denies
30104 access.) The &%logwrite%& modifier can be used to log special incidents in
30105 ACLs. For example:
30106 .display
30107 &`accept `&<&'some special conditions'&>
30108 &`       control  = freeze`&
30109 &`       logwrite = froze message because ...`&
30110 .endd
30111 By default, the message is written to the main log. However, it may begin
30112 with a colon, followed by a comma-separated list of log names, and then
30113 another colon, to specify exactly which logs are to be written. For
30114 example:
30115 .code
30116 logwrite = :main,reject: text for main and reject logs
30117 logwrite = :panic: text for panic log only
30118 .endd
30119
30120
30121 .vitem &*message*&&~=&~<&'text'&>
30122 .cindex "&%message%& ACL modifier"
30123 This modifier sets up a text string that is expanded and used as a response
30124 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30125 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30126 there is some complication if &%endpass%& is involved; see the description of
30127 &%accept%& for details.)
30128
30129 The expansion of the message happens at the time Exim decides that the ACL is
30130 to end, not at the time it processes &%message%&. If the expansion fails, or
30131 generates an empty string, the modifier is ignored. Here is an example where
30132 &%message%& must be specified first, because the ACL ends with a rejection if
30133 the &%hosts%& condition fails:
30134 .code
30135 require  message = Host not recognized
30136          hosts = 10.0.0.0/8
30137 .endd
30138 (Once a condition has failed, no further conditions or modifiers are
30139 processed.)
30140
30141 .cindex "SMTP" "error codes"
30142 .oindex "&%smtp_banner%&
30143 For ACLs that are triggered by SMTP commands, the message is returned as part
30144 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30145 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30146 is accepted. In the case of the connect ACL, accepting with a message modifier
30147 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30148 accept message may not contain more than one line (otherwise it will be
30149 truncated at the first newline and a panic logged), and it cannot affect the
30150 EHLO options.
30151
30152 When SMTP is involved, the message may begin with an overriding response code,
30153 consisting of three digits optionally followed by an &"extended response code"&
30154 of the form &'n.n.n'&, each code being followed by a space. For example:
30155 .code
30156 deny  message = 599 1.2.3 Host not welcome
30157       hosts = 192.168.34.0/24
30158 .endd
30159 The first digit of the supplied response code must be the same as would be sent
30160 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30161 access, but for the predata ACL, note that the default success code is 354, not
30162 2&'xx'&.
30163
30164 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30165 the message modifier cannot override the 221 response code.
30166
30167 The text in a &%message%& modifier is literal; any quotes are taken as
30168 literals, but because the string is expanded, backslash escapes are processed
30169 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30170 response.
30171
30172 .vindex "&$acl_verify_message$&"
30173 For ACLs that are called by an &%acl =%& ACL condition, the message is
30174 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30175
30176 If &%message%& is used on a statement that verifies an address, the message
30177 specified overrides any message that is generated by the verification process.
30178 However, the original message is available in the variable
30179 &$acl_verify_message$&, so you can incorporate it into your message if you
30180 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30181 routers to be passed back as part of the SMTP response, you should either not
30182 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30183
30184 For compatibility with previous releases of Exim, a &%message%& modifier that
30185 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30186 modifier, but this usage is now deprecated. However, &%message%& acts only when
30187 all the conditions are true, wherever it appears in an ACL command, whereas
30188 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30189 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30190 effect.
30191
30192
30193 .vitem &*queue*&&~=&~<&'text'&>
30194 .cindex "&%queue%& ACL modifier"
30195 .cindex "named queues" "selecting in ACL"
30196 This modifier specifies the use of a named queue for spool files
30197 for the message.
30198 It can only be used before the message is received (i.e. not in
30199 the DATA ACL).
30200 This could be used, for example, for known high-volume burst sources
30201 of traffic, or for quarantine of messages.
30202 Separate queue-runner processes will be needed for named queues.
30203 If the text after expansion is empty, the default queue is used.
30204
30205
30206 .vitem &*remove_header*&&~=&~<&'text'&>
30207 This modifier specifies one or more header names in a colon-separated list
30208  that are to be removed from an incoming message, assuming, of course, that
30209 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30210
30211
30212 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30213 .cindex "&%set%& ACL modifier"
30214 This modifier puts a value into one of the ACL variables (see section
30215 &<<SECTaclvariables>>&).
30216
30217
30218 .vitem &*udpsend*&&~=&~<&'parameters'&>
30219 .cindex "UDP communications"
30220 This modifier sends a UDP packet, for purposes such as statistics
30221 collection or behaviour monitoring. The parameters are expanded, and
30222 the result of the expansion must be a colon-separated list consisting
30223 of a destination server, port number, and the packet contents. The
30224 server can be specified as a host name or IPv4 or IPv6 address. The
30225 separator can be changed with the usual angle bracket syntax. For
30226 example, you might want to collect information on which hosts connect
30227 when:
30228 .code
30229 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30230              $tod_zulu $sender_host_address
30231 .endd
30232 .endlist
30233
30234
30235
30236
30237 .section "Use of the control modifier" "SECTcontrols"
30238 .cindex "&%control%& ACL modifier"
30239 The &%control%& modifier supports the following settings:
30240
30241 .vlist
30242 .vitem &*control&~=&~allow_auth_unadvertised*&
30243 This modifier allows a client host to use the SMTP AUTH command even when it
30244 has not been advertised in response to EHLO. Furthermore, because there are
30245 apparently some really broken clients that do this, Exim will accept AUTH after
30246 HELO (rather than EHLO) when this control is set. It should be used only if you
30247 really need it, and you should limit its use to those broken clients that do
30248 not work without it. For example:
30249 .code
30250 warn hosts   = 192.168.34.25
30251      control = allow_auth_unadvertised
30252 .endd
30253 Normally, when an Exim server receives an AUTH command, it checks the name of
30254 the authentication mechanism that is given in the command to ensure that it
30255 matches an advertised mechanism. When this control is set, the check that a
30256 mechanism has been advertised is bypassed. Any configured mechanism can be used
30257 by the client. This control is permitted only in the connection and HELO ACLs.
30258
30259
30260 .vitem &*control&~=&~caseful_local_part*& &&&
30261        &*control&~=&~caselower_local_part*&
30262 .cindex "&ACL;" "case of local part in"
30263 .cindex "case of local parts"
30264 .vindex "&$local_part$&"
30265 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30266 (that is, during RCPT processing). By default, the contents of &$local_part$&
30267 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30268 any uppercase letters in the original local part are restored in &$local_part$&
30269 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30270 is encountered.
30271
30272 These controls affect only the current recipient. Moreover, they apply only to
30273 local part handling that takes place directly in the ACL (for example, as a key
30274 in lookups). If a test to verify the recipient is obeyed, the case-related
30275 handling of the local part during the verification is controlled by the router
30276 configuration (see the &%caseful_local_part%& generic router option).
30277
30278 This facility could be used, for example, to add a spam score to local parts
30279 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30280 spam score:
30281 .code
30282 warn  control = caseful_local_part
30283       set acl_m4 = ${eval:\
30284                      $acl_m4 + \
30285                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30286                     }
30287       control = caselower_local_part
30288 .endd
30289 Notice that we put back the lower cased version afterwards, assuming that
30290 is what is wanted for subsequent tests.
30291
30292
30293 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30294 .cindex "&ACL;" "cutthrough routing"
30295 .cindex "cutthrough" "requesting"
30296 This option requests delivery be attempted while the item is being received.
30297
30298 The option is usable in the RCPT ACL.
30299 If enabled for a message received via smtp and routed to an smtp transport,
30300 and only one transport, interface, destination host and port combination
30301 is used for all recipients of the message,
30302 then the delivery connection is made while the receiving connection is open
30303 and data is copied from one to the other.
30304
30305 An attempt to set this option for any recipient but the first
30306 for a mail will be quietly ignored.
30307 If a recipient-verify callout
30308 (with use_sender)
30309 connection is subsequently
30310 requested in the same ACL it is held open and used for
30311 any subsequent recipients and the data,
30312 otherwise one is made after the initial RCPT ACL completes.
30313
30314 Note that routers are used in verify mode,
30315 and cannot depend on content of received headers.
30316 Note also that headers cannot be
30317 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30318 Headers may be modified by routers (subject to the above) and transports.
30319 The &'Received-By:'& header is generated as soon as the body reception starts,
30320 rather than the traditional time after the full message is received;
30321 this will affect the timestamp.
30322
30323 All the usual ACLs are called; if one results in the message being
30324 rejected, all effort spent in delivery (including the costs on
30325 the ultimate destination) will be wasted.
30326 Note that in the case of data-time ACLs this includes the entire
30327 message body.
30328
30329 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30330 of outgoing messages is done, because it sends data to the ultimate destination
30331 before the entire message has been received from the source.
30332 It is not supported for messages received with the SMTP PRDR
30333 or CHUNKING
30334 options in use.
30335
30336 Should the ultimate destination system positively accept or reject the mail,
30337 a corresponding indication is given to the source system and nothing is queued.
30338 If the item is successfully delivered in cutthrough mode
30339 the delivery log lines are tagged with ">>" rather than "=>" and appear
30340 before the acceptance "<=" line.
30341
30342 If there is a temporary error the item is queued for later delivery in the
30343 usual fashion.
30344 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30345 to the control; the default value is &"spool"& and the alternate value
30346 &"pass"& copies an SMTP defer response from the target back to the initiator
30347 and does not queue the message.
30348 Note that this is independent of any recipient verify conditions in the ACL.
30349
30350 Delivery in this mode avoids the generation of a bounce mail to a
30351 (possibly faked)
30352 sender when the destination system is doing content-scan based rejection.
30353
30354
30355 .vitem &*control&~=&~debug/*&<&'options'&>
30356 .cindex "&ACL;" "enabling debug logging"
30357 .cindex "debugging" "enabling from an ACL"
30358 This control turns on debug logging, almost as though Exim had been invoked
30359 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30360 by default called &'debuglog'&.
30361 The filename can be adjusted with the &'tag'& option, which
30362 may access any variables already defined.  The logging may be adjusted with
30363 the &'opts'& option, which takes the same values as the &`-d`& command-line
30364 option.
30365 Logging started this way may be stopped, and the file removed,
30366 with the &'kill'& option.
30367 Some examples (which depend on variables that don't exist in all
30368 contexts):
30369 .code
30370       control = debug
30371       control = debug/tag=.$sender_host_address
30372       control = debug/opts=+expand+acl
30373       control = debug/tag=.$message_exim_id/opts=+expand
30374       control = debug/kill
30375 .endd
30376
30377
30378 .vitem &*control&~=&~dkim_disable_verify*&
30379 .cindex "disable DKIM verify"
30380 .cindex "DKIM" "disable verify"
30381 This control turns off DKIM verification processing entirely.  For details on
30382 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30383
30384
30385 .vitem &*control&~=&~dscp/*&<&'value'&>
30386 .cindex "&ACL;" "setting DSCP value"
30387 .cindex "DSCP" "inbound"
30388 This option causes the DSCP value associated with the socket for the inbound
30389 connection to be adjusted to a given value, given as one of a number of fixed
30390 strings or to numeric value.
30391 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30392 Common values include &`throughput`&, &`mincost`&, and on newer systems
30393 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30394
30395 The outbound packets from Exim will be marked with this value in the header
30396 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30397 that these values will have any effect, not be stripped by networking
30398 equipment, or do much of anything without cooperation with your Network
30399 Engineer and those of all network operators between the source and destination.
30400
30401
30402 .vitem &*control&~=&~enforce_sync*& &&&
30403        &*control&~=&~no_enforce_sync*&
30404 .cindex "SMTP" "synchronization checking"
30405 .cindex "synchronization checking in SMTP"
30406 These controls make it possible to be selective about when SMTP synchronization
30407 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30408 state of the switch (it is true by default). See the description of this option
30409 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30410
30411 The effect of these two controls lasts for the remainder of the SMTP
30412 connection. They can appear in any ACL except the one for the non-SMTP
30413 messages. The most straightforward place to put them is in the ACL defined by
30414 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30415 before the first synchronization check. The expected use is to turn off the
30416 synchronization checks for badly-behaved hosts that you nevertheless need to
30417 work with.
30418
30419
30420 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30421 .cindex "fake defer"
30422 .cindex "defer, fake"
30423 This control works in exactly the same way as &%fakereject%& (described below)
30424 except that it causes an SMTP 450 response after the message data instead of a
30425 550 response. You must take care when using &%fakedefer%& because it causes the
30426 messages to be duplicated when the sender retries. Therefore, you should not
30427 use &%fakedefer%& if the message is to be delivered normally.
30428
30429 .vitem &*control&~=&~fakereject/*&<&'message'&>
30430 .cindex "fake rejection"
30431 .cindex "rejection, fake"
30432 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30433 words, only when an SMTP message is being received. If Exim accepts the
30434 message, instead the final 250 response, a 550 rejection message is sent.
30435 However, Exim proceeds to deliver the message as normal. The control applies
30436 only to the current message, not to any subsequent ones that may be received in
30437 the same SMTP connection.
30438
30439 The text for the 550 response is taken from the &%control%& modifier. If no
30440 message is supplied, the following is used:
30441 .code
30442 550-Your message has been rejected but is being
30443 550-kept for evaluation.
30444 550-If it was a legitimate message, it may still be
30445 550 delivered to the target recipient(s).
30446 .endd
30447 This facility should be used with extreme caution.
30448
30449 .vitem &*control&~=&~freeze*&
30450 .cindex "frozen messages" "forcing in ACL"
30451 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30452 other words, only when a message is being received. If the message is accepted,
30453 it is placed on Exim's queue and frozen. The control applies only to the
30454 current message, not to any subsequent ones that may be received in the same
30455 SMTP connection.
30456
30457 This modifier can optionally be followed by &`/no_tell`&. If the global option
30458 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30459 is told about the freezing), provided all the &*control=freeze*& modifiers that
30460 are obeyed for the current message have the &`/no_tell`& option.
30461
30462 .vitem &*control&~=&~no_delay_flush*&
30463 .cindex "SMTP" "output flushing, disabling for delay"
30464 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30465 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30466 use. This control, as long as it is encountered before the &%delay%& modifier,
30467 disables such output flushing.
30468
30469 .vitem &*control&~=&~no_callout_flush*&
30470 .cindex "SMTP" "output flushing, disabling for callout"
30471 Exim normally flushes SMTP output before performing a callout in an ACL, to
30472 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30473 use. This control, as long as it is encountered before the &%verify%& condition
30474 that causes the callout, disables such output flushing.
30475
30476 .vitem &*control&~=&~no_mbox_unspool*&
30477 This control is available when Exim is compiled with the content scanning
30478 extension. Content scanning may require a copy of the current message, or parts
30479 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30480 or spam scanner. Normally, such copies are deleted when they are no longer
30481 needed. If this control is set, the copies are not deleted. The control applies
30482 only to the current message, not to any subsequent ones that may be received in
30483 the same SMTP connection. It is provided for debugging purposes and is unlikely
30484 to be useful in production.
30485
30486 .vitem &*control&~=&~no_multiline_responses*&
30487 .cindex "multiline responses, suppressing"
30488 This control is permitted for any ACL except the one for non-SMTP messages.
30489 It seems that there are broken clients in use that cannot handle multiline
30490 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30491
30492 If this control is set, multiline SMTP responses from ACL rejections are
30493 suppressed. One way of doing this would have been to put out these responses as
30494 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30495 (&"use multiline responses for more"& it says &-- ha!), and some of the
30496 responses might get close to that. So this facility, which is after all only a
30497 sop to broken clients, is implemented by doing two very easy things:
30498
30499 .ilist
30500 Extra information that is normally output as part of a rejection caused by
30501 sender verification failure is omitted. Only the final line (typically &"sender
30502 verification failed"&) is sent.
30503 .next
30504 If a &%message%& modifier supplies a multiline response, only the first
30505 line is output.
30506 .endlist
30507
30508 The setting of the switch can, of course, be made conditional on the
30509 calling host. Its effect lasts until the end of the SMTP connection.
30510
30511 .vitem &*control&~=&~no_pipelining*&
30512 .cindex "PIPELINING" "suppressing advertising"
30513 This control turns off the advertising of the PIPELINING extension to SMTP in
30514 the current session. To be useful, it must be obeyed before Exim sends its
30515 response to an EHLO command. Therefore, it should normally appear in an ACL
30516 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30517 &%pipelining_advertise_hosts%&.
30518
30519 .vitem &*control&~=&~queue_only*&
30520 .oindex "&%queue_only%&"
30521 .cindex "queueing incoming messages"
30522 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30523 other words, only when a message is being received. If the message is accepted,
30524 it is placed on Exim's queue and left there for delivery by a subsequent queue
30525 runner. No immediate delivery process is started. In other words, it has the
30526 effect as the &%queue_only%& global option. However, the control applies only
30527 to the current message, not to any subsequent ones that may be received in the
30528 same SMTP connection.
30529
30530 .vitem &*control&~=&~submission/*&<&'options'&>
30531 .cindex "message" "submission"
30532 .cindex "submission mode"
30533 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30534 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30535 the current message is a submission from a local MUA. In this case, Exim
30536 operates in &"submission mode"&, and applies certain fixups to the message if
30537 necessary. For example, it adds a &'Date:'& header line if one is not present.
30538 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30539 late (the message has already been created).
30540
30541 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30542 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30543 submission mode; the available options for this control are described there.
30544 The control applies only to the current message, not to any subsequent ones
30545 that may be received in the same SMTP connection.
30546
30547 .vitem &*control&~=&~suppress_local_fixups*&
30548 .cindex "submission fixups, suppressing"
30549 This control applies to locally submitted (non TCP/IP) messages, and is the
30550 complement of &`control = submission`&. It disables the fixups that are
30551 normally applied to locally-submitted messages. Specifically:
30552
30553 .ilist
30554 Any &'Sender:'& header line is left alone (in this respect, it is a
30555 dynamic version of &%local_sender_retain%&).
30556 .next
30557 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30558 .next
30559 There is no check that &'From:'& corresponds to the actual sender.
30560 .endlist ilist
30561
30562 This control may be useful when a remotely-originated message is accepted,
30563 passed to some scanning program, and then re-submitted for delivery. It can be
30564 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30565 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30566 data is read.
30567
30568 &*Note:*& This control applies only to the current message, not to any others
30569 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30570
30571 .vitem &*control&~=&~utf8_downconvert*&
30572 This control enables conversion of UTF-8 in message addresses
30573 to a-label form.
30574 For details see section &<<SECTi18nMTA>>&.
30575 .endlist vlist
30576
30577
30578 .section "Summary of message fixup control" "SECTsummesfix"
30579 All four possibilities for message fixups can be specified:
30580
30581 .ilist
30582 Locally submitted, fixups applied: the default.
30583 .next
30584 Locally submitted, no fixups applied: use
30585 &`control = suppress_local_fixups`&.
30586 .next
30587 Remotely submitted, no fixups applied: the default.
30588 .next
30589 Remotely submitted, fixups applied: use &`control = submission`&.
30590 .endlist
30591
30592
30593
30594 .section "Adding header lines in ACLs" "SECTaddheadacl"
30595 .cindex "header lines" "adding in an ACL"
30596 .cindex "header lines" "position of added lines"
30597 .cindex "&%add_header%& ACL modifier"
30598 The &%add_header%& modifier can be used to add one or more extra header lines
30599 to an incoming message, as in this example:
30600 .code
30601 warn dnslists = sbl.spamhaus.org : \
30602                 dialup.mail-abuse.org
30603      add_header = X-blacklisted-at: $dnslist_domain
30604 .endd
30605 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30606 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30607 receiving a message). The message must ultimately be accepted for
30608 &%add_header%& to have any significant effect. You can use &%add_header%& with
30609 any ACL verb, including &%deny%& (though this is potentially useful only in a
30610 RCPT ACL).
30611
30612 Headers will not be added to the message if the modifier is used in
30613 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30614
30615 Leading and trailing newlines are removed from
30616 the data for the &%add_header%& modifier; if it then
30617 contains one or more newlines that
30618 are not followed by a space or a tab, it is assumed to contain multiple header
30619 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30620 front of any line that is not a valid header line.
30621
30622 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30623 They are added to the message before processing the DATA and MIME ACLs.
30624 However, if an identical header line is requested more than once, only one copy
30625 is actually added to the message. Further header lines may be accumulated
30626 during the DATA and MIME ACLs, after which they are added to the message, again
30627 with duplicates suppressed. Thus, it is possible to add two identical header
30628 lines to an SMTP message, but only if one is added before DATA and one after.
30629 In the case of non-SMTP messages, new headers are accumulated during the
30630 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30631 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30632 are included in the entry that is written to the reject log.
30633
30634 .cindex "header lines" "added; visibility of"
30635 Header lines are not visible in string expansions
30636 of message headers
30637 until they are added to the
30638 message. It follows that header lines defined in the MAIL, RCPT, and predata
30639 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30640 header lines that are added by the DATA or MIME ACLs are not visible in those
30641 ACLs. Because of this restriction, you cannot use header lines as a way of
30642 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30643 this, you can use ACL variables, as described in section
30644 &<<SECTaclvariables>>&.
30645
30646 The list of headers yet to be added is given by the &%$headers_added%& variable.
30647
30648 The &%add_header%& modifier acts immediately as it is encountered during the
30649 processing of an ACL. Notice the difference between these two cases:
30650 .display
30651 &`accept add_header = ADDED: some text`&
30652 &`       `&<&'some condition'&>
30653
30654 &`accept `&<&'some condition'&>
30655 &`       add_header = ADDED: some text`&
30656 .endd
30657 In the first case, the header line is always added, whether or not the
30658 condition is true. In the second case, the header line is added only if the
30659 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30660 ACL statement. All those that are encountered before a condition fails are
30661 honoured.
30662
30663 .cindex "&%warn%& ACL verb"
30664 For compatibility with previous versions of Exim, a &%message%& modifier for a
30665 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30666 effect only if all the conditions are true, even if it appears before some of
30667 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30668 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30669 are present on a &%warn%& verb, both are processed according to their
30670 specifications.
30671
30672 By default, new header lines are added to a message at the end of the existing
30673 header lines. However, you can specify that any particular header line should
30674 be added right at the start (before all the &'Received:'& lines), immediately
30675 after the first block of &'Received:'& lines, or immediately before any line
30676 that is not a &'Received:'& or &'Resent-something:'& header.
30677
30678 This is done by specifying &":at_start:"&, &":after_received:"&, or
30679 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30680 header line, respectively. (Header text cannot start with a colon, as there has
30681 to be a header name first.) For example:
30682 .code
30683 warn add_header = \
30684        :after_received:X-My-Header: something or other...
30685 .endd
30686 If more than one header line is supplied in a single &%add_header%& modifier,
30687 each one is treated independently and can therefore be placed differently. If
30688 you add more than one line at the start, or after the Received: block, they end
30689 up in reverse order.
30690
30691 &*Warning*&: This facility currently applies only to header lines that are
30692 added in an ACL. It does NOT work for header lines that are added in a
30693 system filter or in a router or transport.
30694
30695
30696
30697 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30698 .cindex "header lines" "removing in an ACL"
30699 .cindex "header lines" "position of removed lines"
30700 .cindex "&%remove_header%& ACL modifier"
30701 The &%remove_header%& modifier can be used to remove one or more header lines
30702 from an incoming message, as in this example:
30703 .code
30704 warn   message        = Remove internal headers
30705        remove_header  = x-route-mail1 : x-route-mail2
30706 .endd
30707 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30708 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30709 receiving a message). The message must ultimately be accepted for
30710 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30711 with any ACL verb, including &%deny%&, though this is really not useful for
30712 any verb that doesn't result in a delivered message.
30713
30714 Headers will not be removed from the message if the modifier is used in
30715 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30716
30717 More than one header can be removed at the same time by using a colon separated
30718 list of header names. The header matching is case insensitive. Wildcards are
30719 not permitted, nor is list expansion performed, so you cannot use hostlists to
30720 create a list of headers, however both connection and message variable expansion
30721 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30722 .code
30723 warn   hosts           = +internal_hosts
30724        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30725 warn   message         = Remove internal headers
30726        remove_header   = $acl_c_ihdrs
30727 .endd
30728 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30729 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30730 If multiple header lines match, all are removed.
30731 There is no harm in attempting to remove the same header twice nor in removing
30732 a non-existent header. Further header lines to be removed may be accumulated
30733 during the DATA and MIME ACLs, after which they are removed from the message,
30734 if present. In the case of non-SMTP messages, headers to be removed are
30735 accumulated during the non-SMTP ACLs, and are removed from the message after
30736 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30737 ACL, there really is no effect because there is no logging of what headers
30738 would have been removed.
30739
30740 .cindex "header lines" "removed; visibility of"
30741 Header lines are not visible in string expansions until the DATA phase when it
30742 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30743 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30744 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30745 this restriction, you cannot use header lines as a way of controlling data
30746 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30747 you should instead use ACL variables, as described in section
30748 &<<SECTaclvariables>>&.
30749
30750 The &%remove_header%& modifier acts immediately as it is encountered during the
30751 processing of an ACL. Notice the difference between these two cases:
30752 .display
30753 &`accept remove_header = X-Internal`&
30754 &`       `&<&'some condition'&>
30755
30756 &`accept `&<&'some condition'&>
30757 &`       remove_header = X-Internal`&
30758 .endd
30759 In the first case, the header line is always removed, whether or not the
30760 condition is true. In the second case, the header line is removed only if the
30761 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30762 same ACL statement. All those that are encountered before a condition fails
30763 are honoured.
30764
30765 &*Warning*&: This facility currently applies only to header lines that are
30766 present during ACL processing. It does NOT remove header lines that are added
30767 in a system filter or in a router or transport.
30768
30769
30770
30771
30772 .section "ACL conditions" "SECTaclconditions"
30773 .cindex "&ACL;" "conditions; list of"
30774 Some of the conditions listed in this section are available only when Exim is
30775 compiled with the content-scanning extension. They are included here briefly
30776 for completeness. More detailed descriptions can be found in the discussion on
30777 content scanning in chapter &<<CHAPexiscan>>&.
30778
30779 Not all conditions are relevant in all circumstances. For example, testing
30780 senders and recipients does not make sense in an ACL that is being run as the
30781 result of the arrival of an ETRN command, and checks on message headers can be
30782 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30783 can use the same condition (with different parameters) more than once in the
30784 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30785 The conditions are as follows:
30786
30787
30788 .vlist
30789 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30790 .cindex "&ACL;" "nested"
30791 .cindex "&ACL;" "indirect"
30792 .cindex "&ACL;" "arguments"
30793 .cindex "&%acl%& ACL condition"
30794 The possible values of the argument are the same as for the
30795 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30796 &"accept"& the condition is true; if it returns &"deny"& the condition is
30797 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30798 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30799 condition false. This means that further processing of the &%warn%& verb
30800 ceases, but processing of the ACL continues.
30801
30802 If the argument is a named ACL, up to nine space-separated optional values
30803 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30804 and $acl_narg is set to the count of values.
30805 Previous values of these variables are restored after the call returns.
30806 The name and values are expanded separately.
30807 Note that spaces in complex expansions which are used as arguments
30808 will act as argument separators.
30809
30810 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30811 the connection is dropped. If it returns &"discard"&, the verb must be
30812 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30813 conditions are tested.
30814
30815 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30816 loops. This condition allows you to use different ACLs in different
30817 circumstances. For example, different ACLs can be used to handle RCPT commands
30818 for different local users or different local domains.
30819
30820 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30821 .cindex "&%authenticated%& ACL condition"
30822 .cindex "authentication" "ACL checking"
30823 .cindex "&ACL;" "testing for authentication"
30824 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30825 the name of the authenticator is tested against the list. To test for
30826 authentication by any authenticator, you can set
30827 .code
30828 authenticated = *
30829 .endd
30830
30831 .vitem &*condition&~=&~*&<&'string'&>
30832 .cindex "&%condition%& ACL condition"
30833 .cindex "customizing" "ACL condition"
30834 .cindex "&ACL;" "customized test"
30835 .cindex "&ACL;" "testing, customized"
30836 This feature allows you to make up custom conditions. If the result of
30837 expanding the string is an empty string, the number zero, or one of the strings
30838 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30839 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30840 any other value, some error is assumed to have occurred, and the ACL returns
30841 &"defer"&. However, if the expansion is forced to fail, the condition is
30842 ignored. The effect is to treat it as true, whether it is positive or
30843 negative.
30844
30845 .vitem &*decode&~=&~*&<&'location'&>
30846 .cindex "&%decode%& ACL condition"
30847 This condition is available only when Exim is compiled with the
30848 content-scanning extension, and it is allowed only in the ACL defined by
30849 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30850 If all goes well, the condition is true. It is false only if there are
30851 problems such as a syntax error or a memory shortage. For more details, see
30852 chapter &<<CHAPexiscan>>&.
30853
30854 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30855 .cindex "&%dnslists%& ACL condition"
30856 .cindex "DNS list" "in ACL"
30857 .cindex "black list (DNS)"
30858 .cindex "&ACL;" "testing a DNS list"
30859 This condition checks for entries in DNS black lists. These are also known as
30860 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30861 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30862 different variants of this condition to describe briefly here. See sections
30863 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30864
30865 .vitem &*domains&~=&~*&<&'domain&~list'&>
30866 .cindex "&%domains%& ACL condition"
30867 .cindex "domain" "ACL checking"
30868 .cindex "&ACL;" "testing a recipient domain"
30869 .vindex "&$domain_data$&"
30870 This condition is relevant only after a RCPT command. It checks that the domain
30871 of the recipient address is in the domain list. If percent-hack processing is
30872 enabled, it is done before this test is done. If the check succeeds with a
30873 lookup, the result of the lookup is placed in &$domain_data$& until the next
30874 &%domains%& test.
30875
30876 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30877 use &%domains%& in a DATA ACL.
30878
30879
30880 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30881 .cindex "&%encrypted%& ACL condition"
30882 .cindex "encryption" "checking in an ACL"
30883 .cindex "&ACL;" "testing for encryption"
30884 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30885 name of the cipher suite in use is tested against the list. To test for
30886 encryption without testing for any specific cipher suite(s), set
30887 .code
30888 encrypted = *
30889 .endd
30890
30891
30892 .vitem &*hosts&~=&~*&<&'host&~list'&>
30893 .cindex "&%hosts%& ACL condition"
30894 .cindex "host" "ACL checking"
30895 .cindex "&ACL;" "testing the client host"
30896 This condition tests that the calling host matches the host list. If you have
30897 name lookups or wildcarded host names and IP addresses in the same host list,
30898 you should normally put the IP addresses first. For example, you could have:
30899 .code
30900 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30901 .endd
30902 The lookup in this example uses the host name for its key. This is implied by
30903 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30904 and it wouldn't matter which way round you had these two items.)
30905
30906 The reason for the problem with host names lies in the left-to-right way that
30907 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30908 but when it reaches an item that requires a host name, it fails if it cannot
30909 find a host name to compare with the pattern. If the above list is given in the
30910 opposite order, the &%accept%& statement fails for a host whose name cannot be
30911 found, even if its IP address is 10.9.8.7.
30912
30913 If you really do want to do the name check first, and still recognize the IP
30914 address even if the name lookup fails, you can rewrite the ACL like this:
30915 .code
30916 accept hosts = dbm;/etc/friendly/hosts
30917 accept hosts = 10.9.8.7
30918 .endd
30919 The default action on failing to find the host name is to assume that the host
30920 is not in the list, so the first &%accept%& statement fails. The second
30921 statement can then check the IP address.
30922
30923 .vindex "&$host_data$&"
30924 If a &%hosts%& condition is satisfied by means of a lookup, the result
30925 of the lookup is made available in the &$host_data$& variable. This
30926 allows you, for example, to set up a statement like this:
30927 .code
30928 deny  hosts = net-lsearch;/some/file
30929 message = $host_data
30930 .endd
30931 which gives a custom error message for each denied host.
30932
30933 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30934 .cindex "&%local_parts%& ACL condition"
30935 .cindex "local part" "ACL checking"
30936 .cindex "&ACL;" "testing a local part"
30937 .vindex "&$local_part_data$&"
30938 This condition is relevant only after a RCPT command. It checks that the local
30939 part of the recipient address is in the list. If percent-hack processing is
30940 enabled, it is done before this test. If the check succeeds with a lookup, the
30941 result of the lookup is placed in &$local_part_data$&, which remains set until
30942 the next &%local_parts%& test.
30943
30944 .vitem &*malware&~=&~*&<&'option'&>
30945 .cindex "&%malware%& ACL condition"
30946 .cindex "&ACL;" "virus scanning"
30947 .cindex "&ACL;" "scanning for viruses"
30948 This condition is available only when Exim is compiled with the
30949 content-scanning extension
30950 and only after a DATA command.
30951 It causes the incoming message to be scanned for
30952 viruses. For details, see chapter &<<CHAPexiscan>>&.
30953
30954 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30955 .cindex "&%mime_regex%& ACL condition"
30956 .cindex "&ACL;" "testing by regex matching"
30957 This condition is available only when Exim is compiled with the
30958 content-scanning extension, and it is allowed only in the ACL defined by
30959 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30960 with any of the regular expressions. For details, see chapter
30961 &<<CHAPexiscan>>&.
30962
30963 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30964 .cindex "rate limiting"
30965 This condition can be used to limit the rate at which a user or host submits
30966 messages. Details are given in section &<<SECTratelimiting>>&.
30967
30968 .vitem &*recipients&~=&~*&<&'address&~list'&>
30969 .cindex "&%recipients%& ACL condition"
30970 .cindex "recipient" "ACL checking"
30971 .cindex "&ACL;" "testing a recipient"
30972 This condition is relevant only after a RCPT command. It checks the entire
30973 recipient address against a list of recipients.
30974
30975 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30976 .cindex "&%regex%& ACL condition"
30977 .cindex "&ACL;" "testing by regex matching"
30978 This condition is available only when Exim is compiled with the
30979 content-scanning extension, and is available only in the DATA, MIME, and
30980 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30981 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30982
30983 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30984 .cindex "&%sender_domains%& ACL condition"
30985 .cindex "sender" "ACL checking"
30986 .cindex "&ACL;" "testing a sender domain"
30987 .vindex "&$domain$&"
30988 .vindex "&$sender_address_domain$&"
30989 This condition tests the domain of the sender of the message against the given
30990 domain list. &*Note*&: The domain of the sender address is in
30991 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30992 of this condition. This is an exception to the general rule for testing domain
30993 lists. It is done this way so that, if this condition is used in an ACL for a
30994 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30995 influence the sender checking.
30996
30997 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30998 relaying, because sender addresses are easily, and commonly, forged.
30999
31000 .vitem &*senders&~=&~*&<&'address&~list'&>
31001 .cindex "&%senders%& ACL condition"
31002 .cindex "sender" "ACL checking"
31003 .cindex "&ACL;" "testing a sender"
31004 This condition tests the sender of the message against the given list. To test
31005 for a bounce message, which has an empty sender, set
31006 .code
31007 senders = :
31008 .endd
31009 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31010 relaying, because sender addresses are easily, and commonly, forged.
31011
31012 .vitem &*spam&~=&~*&<&'username'&>
31013 .cindex "&%spam%& ACL condition"
31014 .cindex "&ACL;" "scanning for spam"
31015 This condition is available only when Exim is compiled with the
31016 content-scanning extension. It causes the incoming message to be scanned by
31017 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31018
31019 .vitem &*verify&~=&~certificate*&
31020 .cindex "&%verify%& ACL condition"
31021 .cindex "TLS" "client certificate verification"
31022 .cindex "certificate" "verification of client"
31023 .cindex "&ACL;" "certificate verification"
31024 .cindex "&ACL;" "testing a TLS certificate"
31025 This condition is true in an SMTP session if the session is encrypted, and a
31026 certificate was received from the client, and the certificate was verified. The
31027 server requests a certificate only if the client matches &%tls_verify_hosts%&
31028 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31029
31030 .vitem &*verify&~=&~csa*&
31031 .cindex "CSA verification"
31032 This condition checks whether the sending host (the client) is authorized to
31033 send email. Details of how this works are given in section
31034 &<<SECTverifyCSA>>&.
31035
31036 .vitem &*verify&~=&~header_names_ascii*&
31037 .cindex "&%verify%& ACL condition"
31038 .cindex "&ACL;" "verifying header names only ASCII"
31039 .cindex "header lines" "verifying header names only ASCII"
31040 .cindex "verifying" "header names only ASCII"
31041 This condition is relevant only in an ACL that is run after a message has been
31042 received, that is, in an ACL specified by &%acl_smtp_data%& or
31043 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31044 there are no non-ASCII characters, also excluding control characters.  The
31045 allowable characters are decimal ASCII values 33 through 126.
31046
31047 Exim itself will handle headers with non-ASCII characters, but it can cause
31048 problems for downstream applications, so this option will allow their
31049 detection and rejection in the DATA ACL's.
31050
31051 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31052 .cindex "&%verify%& ACL condition"
31053 .cindex "&ACL;" "verifying sender in the header"
31054 .cindex "header lines" "verifying the sender in"
31055 .cindex "sender" "verifying in header"
31056 .cindex "verifying" "sender in header"
31057 This condition is relevant only in an ACL that is run after a message has been
31058 received, that is, in an ACL specified by &%acl_smtp_data%& or
31059 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31060 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31061 is loosely thought of as a &"sender"& address (hence the name of the test).
31062 However, an address that appears in one of these headers need not be an address
31063 that accepts bounce messages; only sender addresses in envelopes are required
31064 to accept bounces. Therefore, if you use the callout option on this check, you
31065 might want to arrange for a non-empty address in the MAIL command.
31066
31067 Details of address verification and the options are given later, starting at
31068 section &<<SECTaddressverification>>& (callouts are described in section
31069 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31070 condition to restrict it to bounce messages only:
31071 .code
31072 deny    senders = :
31073         message = A valid sender header is required for bounces
31074        !verify  = header_sender
31075 .endd
31076
31077 .vitem &*verify&~=&~header_syntax*&
31078 .cindex "&%verify%& ACL condition"
31079 .cindex "&ACL;" "verifying header syntax"
31080 .cindex "header lines" "verifying syntax"
31081 .cindex "verifying" "header syntax"
31082 This condition is relevant only in an ACL that is run after a message has been
31083 received, that is, in an ACL specified by &%acl_smtp_data%& or
31084 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31085 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31086 and &'Bcc:'&), returning true if there are no problems.
31087 Unqualified addresses (local parts without domains) are
31088 permitted only in locally generated messages and from hosts that match
31089 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31090 appropriate.
31091
31092 Note that this condition is a syntax check only. However, a common spamming
31093 ploy used to be to send syntactically invalid headers such as
31094 .code
31095 To: @
31096 .endd
31097 and this condition can be used to reject such messages, though they are not as
31098 common as they used to be.
31099
31100 .vitem &*verify&~=&~helo*&
31101 .cindex "&%verify%& ACL condition"
31102 .cindex "&ACL;" "verifying HELO/EHLO"
31103 .cindex "HELO" "verifying"
31104 .cindex "EHLO" "verifying"
31105 .cindex "verifying" "EHLO"
31106 .cindex "verifying" "HELO"
31107 This condition is true if a HELO or EHLO command has been received from the
31108 client host, and its contents have been verified. If there has been no previous
31109 attempt to verify the HELO/EHLO contents, it is carried out when this
31110 condition is encountered. See the description of the &%helo_verify_hosts%& and
31111 &%helo_try_verify_hosts%& options for details of how to request verification
31112 independently of this condition, and for detail of the verification.
31113
31114 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31115 option), this condition is always true.
31116
31117
31118 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31119 .cindex "verifying" "not blind"
31120 .cindex "bcc recipients, verifying none"
31121 This condition checks that there are no blind (bcc) recipients in the message.
31122 Every envelope recipient must appear either in a &'To:'& header line or in a
31123 &'Cc:'& header line for this condition to be true. Local parts are checked
31124 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31125 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31126 used only in a DATA or non-SMTP ACL.
31127
31128 .new
31129 There is one possible option, &`case_insensitive`&.  If this is present then
31130 local parts are checked case-insensitively.
31131 .wen
31132
31133 There are, of course, many legitimate messages that make use of blind (bcc)
31134 recipients. This check should not be used on its own for blocking messages.
31135
31136
31137 .vitem &*verify&~=&~recipient/*&<&'options'&>
31138 .cindex "&%verify%& ACL condition"
31139 .cindex "&ACL;" "verifying recipient"
31140 .cindex "recipient" "verifying"
31141 .cindex "verifying" "recipient"
31142 .vindex "&$address_data$&"
31143 This condition is relevant only after a RCPT command. It verifies the current
31144 recipient. Details of address verification are given later, starting at section
31145 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31146 of &$address_data$& is the last value that was set while routing the address.
31147 This applies even if the verification fails. When an address that is being
31148 verified is redirected to a single address, verification continues with the new
31149 address, and in that case, the subsequent value of &$address_data$& is the
31150 value for the child address.
31151
31152 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31153 .cindex "&%verify%& ACL condition"
31154 .cindex "&ACL;" "verifying host reverse lookup"
31155 .cindex "host" "verifying reverse lookup"
31156 This condition ensures that a verified host name has been looked up from the IP
31157 address of the client host. (This may have happened already if the host name
31158 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31159 Verification ensures that the host name obtained from a reverse DNS lookup, or
31160 one of its aliases, does, when it is itself looked up in the DNS, yield the
31161 original IP address.
31162
31163 There is one possible option, &`defer_ok`&.  If this is present and a
31164 DNS operation returns a temporary error, the verify condition succeeds.
31165
31166 If this condition is used for a locally generated message (that is, when there
31167 is no client host involved), it always succeeds.
31168
31169 .vitem &*verify&~=&~sender/*&<&'options'&>
31170 .cindex "&%verify%& ACL condition"
31171 .cindex "&ACL;" "verifying sender"
31172 .cindex "sender" "verifying"
31173 .cindex "verifying" "sender"
31174 This condition is relevant only after a MAIL or RCPT command, or after a
31175 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31176 the message's sender is empty (that is, this is a bounce message), the
31177 condition is true. Otherwise, the sender address is verified.
31178
31179 .vindex "&$address_data$&"
31180 .vindex "&$sender_address_data$&"
31181 If there is data in the &$address_data$& variable at the end of routing, its
31182 value is placed in &$sender_address_data$& at the end of verification. This
31183 value can be used in subsequent conditions and modifiers in the same ACL
31184 statement. It does not persist after the end of the current statement. If you
31185 want to preserve the value for longer, you can save it in an ACL variable.
31186
31187 Details of verification are given later, starting at section
31188 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31189 to avoid doing it more than once per message.
31190
31191 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31192 .cindex "&%verify%& ACL condition"
31193 This is a variation of the previous option, in which a modified address is
31194 verified as a sender.
31195
31196 Note that '/' is legal in local-parts; if the address may have such
31197 (eg. is generated from the received message)
31198 they must be protected from the options parsing by doubling:
31199 .code
31200 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31201 .endd
31202 .endlist
31203
31204
31205
31206 .section "Using DNS lists" "SECTmorednslists"
31207 .cindex "DNS list" "in ACL"
31208 .cindex "black list (DNS)"
31209 .cindex "&ACL;" "testing a DNS list"
31210 In its simplest form, the &%dnslists%& condition tests whether the calling host
31211 is on at least one of a number of DNS lists by looking up the inverted IP
31212 address in one or more DNS domains. (Note that DNS list domains are not mail
31213 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31214 special options instead.) For example, if the calling host's IP
31215 address is 192.168.62.43, and the ACL statement is
31216 .code
31217 deny dnslists = blackholes.mail-abuse.org : \
31218                 dialups.mail-abuse.org
31219 .endd
31220 the following records are looked up:
31221 .code
31222 43.62.168.192.blackholes.mail-abuse.org
31223 43.62.168.192.dialups.mail-abuse.org
31224 .endd
31225 As soon as Exim finds an existing DNS record, processing of the list stops.
31226 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31227 to test that a host is on more than one list (an &"and"& conjunction), you can
31228 use two separate conditions:
31229 .code
31230 deny dnslists = blackholes.mail-abuse.org
31231      dnslists = dialups.mail-abuse.org
31232 .endd
31233 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31234 behaves as if the host does not match the list item, that is, as if the DNS
31235 record does not exist. If there are further items in the DNS list, they are
31236 processed.
31237
31238 This is usually the required action when &%dnslists%& is used with &%deny%&
31239 (which is the most common usage), because it prevents a DNS failure from
31240 blocking mail. However, you can change this behaviour by putting one of the
31241 following special items in the list:
31242 .display
31243 &`+include_unknown `&   behave as if the item is on the list
31244 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31245 &`+defer_unknown   `&   give a temporary error
31246 .endd
31247 .cindex "&`+include_unknown`&"
31248 .cindex "&`+exclude_unknown`&"
31249 .cindex "&`+defer_unknown`&"
31250 Each of these applies to any subsequent items on the list. For example:
31251 .code
31252 deny dnslists = +defer_unknown : foo.bar.example
31253 .endd
31254 Testing the list of domains stops as soon as a match is found. If you want to
31255 warn for one list and block for another, you can use two different statements:
31256 .code
31257 deny  dnslists = blackholes.mail-abuse.org
31258 warn  message  = X-Warn: sending host is on dialups list
31259       dnslists = dialups.mail-abuse.org
31260 .endd
31261 .cindex caching "of dns lookup"
31262 .cindex DNS TTL
31263 DNS list lookups are cached by Exim for the duration of the SMTP session
31264 (but limited by the DNS return TTL value),
31265 so a lookup based on the IP address is done at most once for any incoming
31266 connection (assuming long-enough TTL).
31267 Exim does not share information between multiple incoming
31268 connections (but your local name server cache should be active).
31269
31270 There are a number of DNS lists to choose from, some commercial, some free,
31271 or free for small deployments.  An overview can be found at
31272 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31273
31274
31275
31276 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31277 .cindex "DNS list" "keyed by explicit IP address"
31278 By default, the IP address that is used in a DNS list lookup is the IP address
31279 of the calling host. However, you can specify another IP address by listing it
31280 after the domain name, introduced by a slash. For example:
31281 .code
31282 deny dnslists = black.list.tld/192.168.1.2
31283 .endd
31284 This feature is not very helpful with explicit IP addresses; it is intended for
31285 use with IP addresses that are looked up, for example, the IP addresses of the
31286 MX hosts or nameservers of an email sender address. For an example, see section
31287 &<<SECTmulkeyfor>>& below.
31288
31289
31290
31291
31292 .section "DNS lists keyed on domain names" "SECID202"
31293 .cindex "DNS list" "keyed by domain name"
31294 There are some lists that are keyed on domain names rather than inverted IP
31295 addresses (see, e.g., the &'domain based zones'& link at
31296 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31297 with these lists. You can change the name that is looked up in a DNS list by
31298 listing it after the domain name, introduced by a slash. For example,
31299 .code
31300 deny  message  = Sender's domain is listed at $dnslist_domain
31301       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31302 .endd
31303 This particular example is useful only in ACLs that are obeyed after the
31304 RCPT or DATA commands, when a sender address is available. If (for
31305 example) the message's sender is &'user@tld.example'& the name that is looked
31306 up by this example is
31307 .code
31308 tld.example.dsn.rfc-ignorant.org
31309 .endd
31310 A single &%dnslists%& condition can contain entries for both names and IP
31311 addresses. For example:
31312 .code
31313 deny dnslists = sbl.spamhaus.org : \
31314                 dsn.rfc-ignorant.org/$sender_address_domain
31315 .endd
31316 The first item checks the sending host's IP address; the second checks a domain
31317 name. The whole condition is true if either of the DNS lookups succeeds.
31318
31319
31320
31321
31322 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31323 .cindex "DNS list" "multiple keys for"
31324 The syntax described above for looking up explicitly-defined values (either
31325 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31326 name for the DNS list, what follows the slash can in fact be a list of items.
31327 As with all lists in Exim, the default separator is a colon. However, because
31328 this is a sublist within the list of DNS blacklist domains, it is necessary
31329 either to double the separators like this:
31330 .code
31331 dnslists = black.list.tld/name.1::name.2
31332 .endd
31333 or to change the separator character, like this:
31334 .code
31335 dnslists = black.list.tld/<;name.1;name.2
31336 .endd
31337 If an item in the list is an IP address, it is inverted before the DNS
31338 blacklist domain is appended. If it is not an IP address, no inversion
31339 occurs. Consider this condition:
31340 .code
31341 dnslists = black.list.tld/<;192.168.1.2;a.domain
31342 .endd
31343 The DNS lookups that occur are:
31344 .code
31345 2.1.168.192.black.list.tld
31346 a.domain.black.list.tld
31347 .endd
31348 Once a DNS record has been found (that matches a specific IP return
31349 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31350 are done. If there is a temporary DNS error, the rest of the sublist of domains
31351 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31352 only if no other DNS lookup in this sublist succeeds. In other words, a
31353 successful lookup for any of the items in the sublist overrides a temporary
31354 error for a previous item.
31355
31356 The ability to supply a list of items after the slash is in some sense just a
31357 syntactic convenience. These two examples have the same effect:
31358 .code
31359 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31360 dnslists = black.list.tld/a.domain::b.domain
31361 .endd
31362 However, when the data for the list is obtained from a lookup, the second form
31363 is usually much more convenient. Consider this example:
31364 .code
31365 deny message  = The mail servers for the domain \
31366                 $sender_address_domain \
31367                 are listed at $dnslist_domain ($dnslist_value); \
31368                 see $dnslist_text.
31369      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31370                                    ${lookup dnsdb {>|mxh=\
31371                                    $sender_address_domain} }} }
31372 .endd
31373 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31374 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31375 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31376 of expanding the condition might be something like this:
31377 .code
31378 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31379 .endd
31380 Thus, this example checks whether or not the IP addresses of the sender
31381 domain's mail servers are on the Spamhaus black list.
31382
31383 The key that was used for a successful DNS list lookup is put into the variable
31384 &$dnslist_matched$& (see section &<<SECID204>>&).
31385
31386
31387
31388
31389 .section "Data returned by DNS lists" "SECID203"
31390 .cindex "DNS list" "data returned from"
31391 DNS lists are constructed using address records in the DNS. The original RBL
31392 just used the address 127.0.0.1 on the right hand side of each record, but the
31393 RBL+ list and some other lists use a number of values with different meanings.
31394 The values used on the RBL+ list are:
31395 .display
31396 127.1.0.1  RBL
31397 127.1.0.2  DUL
31398 127.1.0.3  DUL and RBL
31399 127.1.0.4  RSS
31400 127.1.0.5  RSS and RBL
31401 127.1.0.6  RSS and DUL
31402 127.1.0.7  RSS and DUL and RBL
31403 .endd
31404 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31405 different values. Some DNS lists may return more than one address record;
31406 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31407
31408
31409 .section "Variables set from DNS lists" "SECID204"
31410 .cindex "expansion" "variables, set from DNS list"
31411 .cindex "DNS list" "variables set from"
31412 .vindex "&$dnslist_domain$&"
31413 .vindex "&$dnslist_matched$&"
31414 .vindex "&$dnslist_text$&"
31415 .vindex "&$dnslist_value$&"
31416 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31417 the name of the overall domain that matched (for example,
31418 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31419 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31420 the DNS record. When the key is an IP address, it is not reversed in
31421 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31422 cases, for example:
31423 .code
31424 deny dnslists = spamhaus.example
31425 .endd
31426 the key is also available in another variable (in this case,
31427 &$sender_host_address$&). In more complicated cases, however, this is not true.
31428 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31429 might generate a dnslists lookup like this:
31430 .code
31431 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31432 .endd
31433 If this condition succeeds, the value in &$dnslist_matched$& might be
31434 &`192.168.6.7`& (for example).
31435
31436 If more than one address record is returned by the DNS lookup, all the IP
31437 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31438 The variable &$dnslist_text$& contains the contents of any associated TXT
31439 record. For lists such as RBL+ the TXT record for a merged entry is often not
31440 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31441 information.
31442
31443 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31444 &-- although these appear before the condition in the ACL, they are not
31445 expanded until after it has failed. For example:
31446 .code
31447 deny    hosts = !+local_networks
31448         message = $sender_host_address is listed \
31449                   at $dnslist_domain
31450         dnslists = rbl-plus.mail-abuse.example
31451 .endd
31452
31453
31454
31455 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31456 .cindex "DNS list" "matching specific returned data"
31457 You can add an equals sign and an IP address after a &%dnslists%& domain name
31458 in order to restrict its action to DNS records with a matching right hand side.
31459 For example,
31460 .code
31461 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31462 .endd
31463 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31464 any address record is considered to be a match. For the moment, we assume
31465 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31466 describes how multiple records are handled.
31467
31468 More than one IP address may be given for checking, using a comma as a
31469 separator. These are alternatives &-- if any one of them matches, the
31470 &%dnslists%& condition is true. For example:
31471 .code
31472 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31473 .endd
31474 If you want to specify a constraining address list and also specify names or IP
31475 addresses to be looked up, the constraining address list must be specified
31476 first. For example:
31477 .code
31478 deny dnslists = dsn.rfc-ignorant.org\
31479                 =127.0.0.2/$sender_address_domain
31480 .endd
31481
31482 If the character &`&&`& is used instead of &`=`&, the comparison for each
31483 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31484 In other words, the listed addresses are used as bit masks. The comparison is
31485 true if all the bits in the mask are present in the address that is being
31486 tested. For example:
31487 .code
31488 dnslists = a.b.c&0.0.0.3
31489 .endd
31490 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31491 want to test whether one bit or another bit is present (as opposed to both
31492 being present), you must use multiple values. For example:
31493 .code
31494 dnslists = a.b.c&0.0.0.1,0.0.0.2
31495 .endd
31496 matches if the final component of the address is an odd number or two times
31497 an odd number.
31498
31499
31500
31501 .section "Negated DNS matching conditions" "SECID205"
31502 You can supply a negative list of IP addresses as part of a &%dnslists%&
31503 condition. Whereas
31504 .code
31505 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31506 .endd
31507 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31508 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31509 .code
31510 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31511 .endd
31512 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31513 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31514 words, the result of the test is inverted if an exclamation mark appears before
31515 the &`=`& (or the &`&&`&) sign.
31516
31517 &*Note*&: This kind of negation is not the same as negation in a domain,
31518 host, or address list (which is why the syntax is different).
31519
31520 If you are using just one list, the negation syntax does not gain you much. The
31521 previous example is precisely equivalent to
31522 .code
31523 deny  dnslists = a.b.c
31524      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31525 .endd
31526 However, if you are using multiple lists, the negation syntax is clearer.
31527 Consider this example:
31528 .code
31529 deny  dnslists = sbl.spamhaus.org : \
31530                  list.dsbl.org : \
31531                  dnsbl.njabl.org!=127.0.0.3 : \
31532                  relays.ordb.org
31533 .endd
31534 Using only positive lists, this would have to be:
31535 .code
31536 deny  dnslists = sbl.spamhaus.org : \
31537                  list.dsbl.org
31538 deny  dnslists = dnsbl.njabl.org
31539      !dnslists = dnsbl.njabl.org=127.0.0.3
31540 deny  dnslists = relays.ordb.org
31541 .endd
31542 which is less clear, and harder to maintain.
31543
31544
31545
31546
31547 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31548 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31549 thereby providing more than one IP address. When an item in a &%dnslists%& list
31550 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31551 the match to specific results from the DNS lookup, there are two ways in which
31552 the checking can be handled. For example, consider the condition:
31553 .code
31554 dnslists = a.b.c=127.0.0.1
31555 .endd
31556 What happens if the DNS lookup for the incoming IP address yields both
31557 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31558 condition true because at least one given value was found, or is it false
31559 because at least one of the found values was not listed? And how does this
31560 affect negated conditions? Both possibilities are provided for with the help of
31561 additional separators &`==`& and &`=&&`&.
31562
31563 .ilist
31564 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31565 IP addresses matches one of the listed addresses. For the example above, the
31566 condition is true because 127.0.0.1 matches.
31567 .next
31568 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31569 looked up IP addresses matches one of the listed addresses. If the condition is
31570 changed to:
31571 .code
31572 dnslists = a.b.c==127.0.0.1
31573 .endd
31574 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31575 false because 127.0.0.2 is not listed. You would need to have:
31576 .code
31577 dnslists = a.b.c==127.0.0.1,127.0.0.2
31578 .endd
31579 for the condition to be true.
31580 .endlist
31581
31582 When &`!`& is used to negate IP address matching, it inverts the result, giving
31583 the precise opposite of the behaviour above. Thus:
31584 .ilist
31585 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31586 addresses matches one of the listed addresses. Consider:
31587 .code
31588 dnslists = a.b.c!&0.0.0.1
31589 .endd
31590 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31591 false because 127.0.0.1 matches.
31592 .next
31593 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31594 looked up IP address that does not match. Consider:
31595 .code
31596 dnslists = a.b.c!=&0.0.0.1
31597 .endd
31598 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31599 true, because 127.0.0.2 does not match. You would need to have:
31600 .code
31601 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31602 .endd
31603 for the condition to be false.
31604 .endlist
31605 When the DNS lookup yields only a single IP address, there is no difference
31606 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31607
31608
31609
31610
31611 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31612 .cindex "DNS list" "information from merged"
31613 When the facility for restricting the matching IP values in a DNS list is used,
31614 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31615 the true reason for rejection. This happens when lists are merged and the IP
31616 address in the A record is used to distinguish them; unfortunately there is
31617 only one TXT record. One way round this is not to use merged lists, but that
31618 can be inefficient because it requires multiple DNS lookups where one would do
31619 in the vast majority of cases when the host of interest is not on any of the
31620 lists.
31621
31622 A less inefficient way of solving this problem is available. If
31623 two domain names, comma-separated, are given, the second is used first to
31624 do an initial check, making use of any IP value restrictions that are set.
31625 If there is a match, the first domain is used, without any IP value
31626 restrictions, to get the TXT record. As a byproduct of this, there is also
31627 a check that the IP being tested is indeed on the first list. The first
31628 domain is the one that is put in &$dnslist_domain$&. For example:
31629 .code
31630 deny message  = \
31631          rejected because $sender_host_address is blacklisted \
31632          at $dnslist_domain\n$dnslist_text
31633        dnslists = \
31634          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31635          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31636 .endd
31637 For the first blacklist item, this starts by doing a lookup in
31638 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31639 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31640 value, and as long as something is found, it looks for the corresponding TXT
31641 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31642 The second blacklist item is processed similarly.
31643
31644 If you are interested in more than one merged list, the same list must be
31645 given several times, but because the results of the DNS lookups are cached,
31646 the DNS calls themselves are not repeated. For example:
31647 .code
31648 deny dnslists = \
31649          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31650          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31651          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31652          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31653 .endd
31654 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31655 values matches (or if no record is found), this is the only lookup that is
31656 done. Only if there is a match is one of the more specific lists consulted.
31657
31658
31659
31660 .section "DNS lists and IPv6" "SECTmorednslistslast"
31661 .cindex "IPv6" "DNS black lists"
31662 .cindex "DNS list" "IPv6 usage"
31663 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31664 nibble by nibble. For example, if the calling host's IP address is
31665 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31666 .code
31667 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31668   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31669 .endd
31670 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31671 lists contain wildcard records, intended for IPv4, that interact badly with
31672 IPv6. For example, the DNS entry
31673 .code
31674 *.3.some.list.example.    A    127.0.0.1
31675 .endd
31676 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31677 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31678
31679 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31680 &%condition%& condition, as in this example:
31681 .code
31682 deny   condition = ${if isip4{$sender_host_address}}
31683        dnslists  = some.list.example
31684 .endd
31685
31686 If an explicit key is being used for a DNS lookup and it may be an IPv6
31687 address you should specify alternate list separators for both the outer
31688 (DNS list name) list and inner (lookup keys) list:
31689 .code
31690        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31691 .endd
31692
31693 .section "Rate limiting incoming messages" "SECTratelimiting"
31694 .cindex "rate limiting" "client sending"
31695 .cindex "limiting client sending rates"
31696 .oindex "&%smtp_ratelimit_*%&"
31697 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31698 which clients can send email. This is more powerful than the
31699 &%smtp_ratelimit_*%& options, because those options control the rate of
31700 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31701 works across all connections (concurrent and sequential) from the same client
31702 host. The syntax of the &%ratelimit%& condition is:
31703 .display
31704 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31705 .endd
31706 If the average client sending rate is less than &'m'& messages per time
31707 period &'p'& then the condition is false; otherwise it is true.
31708
31709 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31710 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31711 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31712 of &'p'&.
31713
31714 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31715 time interval, for example, &`8h`& for eight hours. A larger time constant
31716 means that it takes Exim longer to forget a client's past behaviour. The
31717 parameter &'m'& is the maximum number of messages that a client is permitted to
31718 send in each time interval. It also specifies the number of messages permitted
31719 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31720 constant, you can allow a client to send more messages in a burst without
31721 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31722 both small, messages must be sent at an even rate.
31723
31724 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31725 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31726 when deploying the &%ratelimit%& ACL condition. The script prints usage
31727 instructions when it is run with no arguments.
31728
31729 The key is used to look up the data for calculating the client's average
31730 sending rate. This data is stored in Exim's spool directory, alongside the
31731 retry and other hints databases. The default key is &$sender_host_address$&,
31732 which means Exim computes the sending rate of each client host IP address.
31733 By changing the key you can change how Exim identifies clients for the purpose
31734 of ratelimiting. For example, to limit the sending rate of each authenticated
31735 user, independent of the computer they are sending from, set the key to
31736 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31737 example, &$authenticated_id$& is only meaningful if the client has
31738 authenticated (which you can check with the &%authenticated%& ACL condition).
31739
31740 The lookup key does not have to identify clients: If you want to limit the
31741 rate at which a recipient receives messages, you can use the key
31742 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31743 ACL.
31744
31745 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31746 specifies what Exim measures the rate of, for example, messages or recipients
31747 or bytes. You can adjust the measurement using the &%unique=%& and/or
31748 &%count=%& options. You can also control when Exim updates the recorded rate
31749 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31750 separated by a slash, like the other parameters. They may appear in any order.
31751
31752 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31753 any options that alter the meaning of the stored data. The limit &'m'& is not
31754 stored, so you can alter the configured maximum rate and Exim will still
31755 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31756 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31757 behaviour. The lookup key is not affected by changes to the update mode and
31758 the &%count=%& option.
31759
31760
31761 .section "Ratelimit options for what is being measured" "ratoptmea"
31762 .cindex "rate limiting" "per_* options"
31763 The &%per_conn%& option limits the client's connection rate. It is not
31764 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31765 &%acl_not_smtp_start%& ACLs.
31766
31767 The &%per_mail%& option limits the client's rate of sending messages. This is
31768 the default if none of the &%per_*%& options is specified. It can be used in
31769 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31770 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31771
31772 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31773 the same ACLs as the &%per_mail%& option, though it is best to use this option
31774 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31775 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31776 in its MAIL command, which may be inaccurate or completely missing. You can
31777 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31778 in kilobytes, megabytes, or gigabytes, respectively.
31779
31780 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31781 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31782 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31783 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31784 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31785 in either case the rate limiting engine will see a message with many
31786 recipients as a large high-speed burst.
31787
31788 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31789 number of different recipients that the client has sent messages to in the
31790 last time period. That is, if the client repeatedly sends messages to the same
31791 recipient, its measured rate is not increased. This option can only be used in
31792 &%acl_smtp_rcpt%&.
31793
31794 The &%per_cmd%& option causes Exim to recompute the rate every time the
31795 condition is processed. This can be used to limit the rate of any SMTP
31796 command. If it is used in multiple ACLs it can limit the aggregate rate of
31797 multiple different commands.
31798
31799 The &%count=%& option can be used to alter how much Exim adds to the client's
31800 measured rate. For example, the &%per_byte%& option is equivalent to
31801 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31802 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31803 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31804
31805 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31806
31807
31808 .section "Ratelimit update modes" "ratoptupd"
31809 .cindex "rate limiting" "reading data without updating"
31810 You can specify one of three options with the &%ratelimit%& condition to
31811 control when its database is updated. This section describes the &%readonly%&
31812 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31813
31814 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31815 previously-computed rate to check against the limit.
31816
31817 For example, you can test the client's sending rate and deny it access (when
31818 it is too fast) in the connect ACL. If the client passes this check then it
31819 can go on to send a message, in which case its recorded rate will be updated
31820 in the MAIL ACL. Subsequent connections from the same client will check this
31821 new rate.
31822 .code
31823 acl_check_connect:
31824  deny ratelimit = 100 / 5m / readonly
31825     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31826                   (max $sender_rate_limit)
31827 # ...
31828 acl_check_mail:
31829  warn ratelimit = 100 / 5m / strict
31830     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31831                   (max $sender_rate_limit)
31832 .endd
31833
31834 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31835 processing a message then it may increase the client's measured rate more than
31836 it should. For example, this will happen if you check the &%per_rcpt%& option
31837 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31838 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31839 multiple update problems by using the &%readonly%& option on later ratelimit
31840 checks.
31841
31842 The &%per_*%& options described above do not make sense in some ACLs. If you
31843 use a &%per_*%& option in an ACL where it is not normally permitted then the
31844 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31845 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31846 next section) so you must specify the &%readonly%& option explicitly.
31847
31848
31849 .section "Ratelimit options for handling fast clients" "ratoptfast"
31850 .cindex "rate limiting" "strict and leaky modes"
31851 If a client's average rate is greater than the maximum, the rate limiting
31852 engine can react in two possible ways, depending on the presence of the
31853 &%strict%& or &%leaky%& update modes. This is independent of the other
31854 counter-measures (such as rejecting the message) that may be specified by the
31855 rest of the ACL.
31856
31857 The &%leaky%& (default) option means that the client's recorded rate is not
31858 updated if it is above the limit. The effect of this is that Exim measures the
31859 client's average rate of successfully sent email,
31860 up to the given limit.
31861 This is appropriate if the countermeasure when the condition is true
31862 consists of refusing the message, and
31863 is generally the better choice if you have clients that retry automatically.
31864 If the action when true is anything more complex then this option is
31865 likely not what is wanted.
31866
31867 The &%strict%& option means that the client's recorded rate is always
31868 updated. The effect of this is that Exim measures the client's average rate
31869 of attempts to send email, which can be much higher than the maximum it is
31870 actually allowed. If the client is over the limit it may be subjected to
31871 counter-measures by the ACL. It must slow down and allow sufficient time to
31872 pass that its computed rate falls below the maximum before it can send email
31873 again. The time (the number of smoothing periods) it must wait and not
31874 attempt to send mail can be calculated with this formula:
31875 .code
31876         ln(peakrate/maxrate)
31877 .endd
31878
31879
31880 .section "Limiting the rate of different events" "ratoptuniq"
31881 .cindex "rate limiting" "counting unique events"
31882 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31883 rate of different events. For example, the &%per_addr%& option uses this
31884 mechanism to count the number of different recipients that the client has
31885 sent messages to in the last time period; it is equivalent to
31886 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31887 measure the rate that a client uses different sender addresses with the
31888 options &`per_mail/unique=$sender_address`&.
31889
31890 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31891 has seen for that key. The whole set is thrown away when it is older than the
31892 rate smoothing period &'p'&, so each different event is counted at most once
31893 per period. In the &%leaky%& update mode, an event that causes the client to
31894 go over the limit is not added to the set, in the same way that the client's
31895 recorded rate is not updated in the same situation.
31896
31897 When you combine the &%unique=%& and &%readonly%& options, the specific
31898 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31899 rate.
31900
31901 The &%unique=%& mechanism needs more space in the ratelimit database than the
31902 other &%ratelimit%& options in order to store the event set. The number of
31903 unique values is potentially as large as the rate limit, so the extra space
31904 required increases with larger limits.
31905
31906 The uniqueification is not perfect: there is a small probability that Exim
31907 will think a new event has happened before. If the sender's rate is less than
31908 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31909 the measured rate can go above the limit, in which case Exim may under-count
31910 events by a significant margin. Fortunately, if the rate is high enough (2.7
31911 times the limit) that the false positive rate goes above 9%, then Exim will
31912 throw away the over-full event set before the measured rate falls below the
31913 limit. Therefore the only harm should be that exceptionally high sending rates
31914 are logged incorrectly; any countermeasures you configure will be as effective
31915 as intended.
31916
31917
31918 .section "Using rate limiting" "useratlim"
31919 Exim's other ACL facilities are used to define what counter-measures are taken
31920 when the rate limit is exceeded. This might be anything from logging a warning
31921 (for example, while measuring existing sending rates in order to define
31922 policy), through time delays to slow down fast senders, up to rejecting the
31923 message. For example:
31924 .code
31925 # Log all senders' rates
31926 warn ratelimit = 0 / 1h / strict
31927      log_message = Sender rate $sender_rate / $sender_rate_period
31928
31929 # Slow down fast senders; note the need to truncate $sender_rate
31930 # at the decimal point.
31931 warn ratelimit = 100 / 1h / per_rcpt / strict
31932      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31933                    $sender_rate_limit }s
31934
31935 # Keep authenticated users under control
31936 deny authenticated = *
31937      ratelimit = 100 / 1d / strict / $authenticated_id
31938
31939 # System-wide rate limit
31940 defer message = Sorry, too busy. Try again later.
31941      ratelimit = 10 / 1s / $primary_hostname
31942
31943 # Restrict incoming rate from each host, with a default
31944 # set using a macro and special cases looked up in a table.
31945 defer message = Sender rate exceeds $sender_rate_limit \
31946                messages per $sender_rate_period
31947      ratelimit = ${lookup {$sender_host_address} \
31948                    cdb {DB/ratelimits.cdb} \
31949                    {$value} {RATELIMIT} }
31950 .endd
31951 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31952 especially with the &%per_rcpt%& option, you may suffer from a performance
31953 bottleneck caused by locking on the ratelimit hints database. Apart from
31954 making your ACLs less complicated, you can reduce the problem by using a
31955 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31956 this means that Exim will lose its hints data after a reboot (including retry
31957 hints, the callout cache, and ratelimit data).
31958
31959
31960
31961 .section "Address verification" "SECTaddressverification"
31962 .cindex "verifying address" "options for"
31963 .cindex "policy control" "address verification"
31964 Several of the &%verify%& conditions described in section
31965 &<<SECTaclconditions>>& cause addresses to be verified. Section
31966 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31967 The verification conditions can be followed by options that modify the
31968 verification process. The options are separated from the keyword and from each
31969 other by slashes, and some of them contain parameters. For example:
31970 .code
31971 verify = sender/callout
31972 verify = recipient/defer_ok/callout=10s,defer_ok
31973 .endd
31974 The first stage of address verification, which always happens, is to run the
31975 address through the routers, in &"verify mode"&. Routers can detect the
31976 difference between verification and routing for delivery, and their actions can
31977 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31978 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31979 The available options are as follows:
31980
31981 .ilist
31982 If the &%callout%& option is specified, successful routing to one or more
31983 remote hosts is followed by a &"callout"& to those hosts as an additional
31984 check. Callouts and their sub-options are discussed in the next section.
31985 .next
31986 If there is a defer error while doing verification routing, the ACL
31987 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31988 options, the condition is forced to be true instead. Note that this is a main
31989 verification option as well as a suboption for callouts.
31990 .next
31991 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31992 discusses the reporting of sender address verification failures.
31993 .next
31994 The &%success_on_redirect%& option causes verification always to succeed
31995 immediately after a successful redirection. By default, if a redirection
31996 generates just one address, that address is also verified. See further
31997 discussion in section &<<SECTredirwhilveri>>&.
31998 .endlist
31999
32000 .cindex "verifying address" "differentiating failures"
32001 .vindex "&$recipient_verify_failure$&"
32002 .vindex "&$sender_verify_failure$&"
32003 .vindex "&$acl_verify_message$&"
32004 After an address verification failure, &$acl_verify_message$& contains the
32005 error message that is associated with the failure. It can be preserved by
32006 coding like this:
32007 .code
32008 warn  !verify = sender
32009        set acl_m0 = $acl_verify_message
32010 .endd
32011 If you are writing your own custom rejection message or log message when
32012 denying access, you can use this variable to include information about the
32013 verification failure.
32014
32015 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32016 appropriate) contains one of the following words:
32017
32018 .ilist
32019 &%qualify%&: The address was unqualified (no domain), and the message
32020 was neither local nor came from an exempted host.
32021 .next
32022 &%route%&: Routing failed.
32023 .next
32024 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32025 occurred at or before the MAIL command (that is, on initial
32026 connection, HELO, or MAIL).
32027 .next
32028 &%recipient%&: The RCPT command in a callout was rejected.
32029 .next
32030 &%postmaster%&: The postmaster check in a callout was rejected.
32031 .endlist
32032
32033 The main use of these variables is expected to be to distinguish between
32034 rejections of MAIL and rejections of RCPT in callouts.
32035
32036 The above variables may also be set after a &*successful*&
32037 address verification to:
32038
32039 .ilist
32040 &%random%&: A random local-part callout succeeded
32041 .endlist
32042
32043
32044
32045
32046 .section "Callout verification" "SECTcallver"
32047 .cindex "verifying address" "by callout"
32048 .cindex "callout" "verification"
32049 .cindex "SMTP" "callout verification"
32050 For non-local addresses, routing verifies the domain, but is unable to do any
32051 checking of the local part. There are situations where some means of verifying
32052 the local part is desirable. One way this can be done is to make an SMTP
32053 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32054 a subsequent host for a recipient address, to see if the host accepts the
32055 address. We use the term &'callout'& to cover both cases. Note that for a
32056 sender address, the callback is not to the client host that is trying to
32057 deliver the message, but to one of the hosts that accepts incoming mail for the
32058 sender's domain.
32059
32060 Exim does not do callouts by default. If you want them to happen, you must
32061 request them by setting appropriate options on the &%verify%& condition, as
32062 described below. This facility should be used with care, because it can add a
32063 lot of resource usage to the cost of verifying an address. However, Exim does
32064 cache the results of callouts, which helps to reduce the cost. Details of
32065 caching are in section &<<SECTcallvercache>>&.
32066
32067 Recipient callouts are usually used only between hosts that are controlled by
32068 the same administration. For example, a corporate gateway host could use
32069 callouts to check for valid recipients on an internal mailserver. A successful
32070 callout does not guarantee that a real delivery to the address would succeed;
32071 on the other hand, a failing callout does guarantee that a delivery would fail.
32072
32073 If the &%callout%& option is present on a condition that verifies an address, a
32074 second stage of verification occurs if the address is successfully routed to
32075 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32076 &(manualroute)& router, where the router specifies the hosts. However, if a
32077 router that does not set up hosts routes to an &(smtp)& transport with a
32078 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32079 &%hosts_override%& set, its hosts are always used, whether or not the router
32080 supplies a host list.
32081 Callouts are only supported on &(smtp)& transports.
32082
32083 The port that is used is taken from the transport, if it is specified and is a
32084 remote transport. (For routers that do verification only, no transport need be
32085 specified.) Otherwise, the default SMTP port is used. If a remote transport
32086 specifies an outgoing interface, this is used; otherwise the interface is not
32087 specified. Likewise, the text that is used for the HELO command is taken from
32088 the transport's &%helo_data%& option; if there is no transport, the value of
32089 &$smtp_active_hostname$& is used.
32090
32091 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32092 test whether a bounce message could be delivered to the sender address. The
32093 following SMTP commands are sent:
32094 .display
32095 &`HELO `&<&'local host name'&>
32096 &`MAIL FROM:<>`&
32097 &`RCPT TO:`&<&'the address to be tested'&>
32098 &`QUIT`&
32099 .endd
32100 LHLO is used instead of HELO if the transport's &%protocol%& option is
32101 set to &"lmtp"&.
32102
32103 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32104 settings.
32105
32106 A recipient callout check is similar. By default, it also uses an empty address
32107 for the sender. This default is chosen because most hosts do not make use of
32108 the sender address when verifying a recipient. Using the same address means
32109 that a single cache entry can be used for each recipient. Some sites, however,
32110 do make use of the sender address when verifying. These are catered for by the
32111 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32112
32113 If the response to the RCPT command is a 2&'xx'& code, the verification
32114 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32115 Exim tries the next host, if any. If there is a problem with all the remote
32116 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32117 &%callout%& option is given, in which case the condition is forced to succeed.
32118
32119 .cindex "SMTP" "output flushing, disabling for callout"
32120 A callout may take a little time. For this reason, Exim normally flushes SMTP
32121 output before performing a callout in an ACL, to avoid unexpected timeouts in
32122 clients when the SMTP PIPELINING extension is in use. The flushing can be
32123 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32124
32125
32126
32127
32128 .section "Additional parameters for callouts" "CALLaddparcall"
32129 .cindex "callout" "additional parameters for"
32130 The &%callout%& option can be followed by an equals sign and a number of
32131 optional parameters, separated by commas. For example:
32132 .code
32133 verify = recipient/callout=10s,defer_ok
32134 .endd
32135 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32136 separate verify options, is retained for backwards compatibility, but is now
32137 deprecated. The additional parameters for &%callout%& are as follows:
32138
32139
32140 .vlist
32141 .vitem <&'a&~time&~interval'&>
32142 .cindex "callout" "timeout, specifying"
32143 This specifies the timeout that applies for the callout attempt to each host.
32144 For example:
32145 .code
32146 verify = sender/callout=5s
32147 .endd
32148 The default is 30 seconds. The timeout is used for each response from the
32149 remote host. It is also used for the initial connection, unless overridden by
32150 the &%connect%& parameter.
32151
32152
32153 .vitem &*connect&~=&~*&<&'time&~interval'&>
32154 .cindex "callout" "connection timeout, specifying"
32155 This parameter makes it possible to set a different (usually smaller) timeout
32156 for making the SMTP connection. For example:
32157 .code
32158 verify = sender/callout=5s,connect=1s
32159 .endd
32160 If not specified, this timeout defaults to the general timeout value.
32161
32162 .vitem &*defer_ok*&
32163 .cindex "callout" "defer, action on"
32164 When this parameter is present, failure to contact any host, or any other kind
32165 of temporary error, is treated as success by the ACL. However, the cache is not
32166 updated in this circumstance.
32167
32168 .vitem &*fullpostmaster*&
32169 .cindex "callout" "full postmaster check"
32170 This operates like the &%postmaster%& option (see below), but if the check for
32171 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32172 accordance with the specification in RFC 2821. The RFC states that the
32173 unqualified address &'postmaster'& should be accepted.
32174
32175
32176 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32177 .cindex "callout" "sender when verifying header"
32178 When verifying addresses in header lines using the &%header_sender%&
32179 verification option, Exim behaves by default as if the addresses are envelope
32180 sender addresses from a message. Callout verification therefore tests to see
32181 whether a bounce message could be delivered, by using an empty address in the
32182 MAIL command. However, it is arguable that these addresses might never be used
32183 as envelope senders, and could therefore justifiably reject bounce messages
32184 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32185 address to use in the MAIL command. For example:
32186 .code
32187 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32188 .endd
32189 This parameter is available only for the &%header_sender%& verification option.
32190
32191
32192 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32193 .cindex "callout" "overall timeout, specifying"
32194 This parameter sets an overall timeout for performing a callout verification.
32195 For example:
32196 .code
32197 verify = sender/callout=5s,maxwait=30s
32198 .endd
32199 This timeout defaults to four times the callout timeout for individual SMTP
32200 commands. The overall timeout applies when there is more than one host that can
32201 be tried. The timeout is checked before trying the next host. This prevents
32202 very long delays if there are a large number of hosts and all are timing out
32203 (for example, when network connections are timing out).
32204
32205
32206 .vitem &*no_cache*&
32207 .cindex "callout" "cache, suppressing"
32208 .cindex "caching callout, suppressing"
32209 When this parameter is given, the callout cache is neither read nor updated.
32210
32211 .vitem &*postmaster*&
32212 .cindex "callout" "postmaster; checking"
32213 When this parameter is set, a successful callout check is followed by a similar
32214 check for the local part &'postmaster'& at the same domain. If this address is
32215 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32216 the postmaster check is recorded in a cache record; if it is a failure, this is
32217 used to fail subsequent callouts for the domain without a connection being
32218 made, until the cache record expires.
32219
32220 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32221 The postmaster check uses an empty sender in the MAIL command by default.
32222 You can use this parameter to do a postmaster check using a different address.
32223 For example:
32224 .code
32225 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32226 .endd
32227 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32228 one overrides. The &%postmaster%& parameter is equivalent to this example:
32229 .code
32230 require  verify = sender/callout=postmaster_mailfrom=
32231 .endd
32232 &*Warning*&: The caching arrangements for postmaster checking do not take
32233 account of the sender address. It is assumed that either the empty address or
32234 a fixed non-empty address will be used. All that Exim remembers is that the
32235 postmaster check for the domain succeeded or failed.
32236
32237
32238 .vitem &*random*&
32239 .cindex "callout" "&""random""& check"
32240 When this parameter is set, before doing the normal callout check, Exim does a
32241 check for a &"random"& local part at the same domain. The local part is not
32242 really random &-- it is defined by the expansion of the option
32243 &%callout_random_local_part%&, which defaults to
32244 .code
32245 $primary_hostname-$tod_epoch-testing
32246 .endd
32247 The idea here is to try to determine whether the remote host accepts all local
32248 parts without checking. If it does, there is no point in doing callouts for
32249 specific local parts. If the &"random"& check succeeds, the result is saved in
32250 a cache record, and used to force the current and subsequent callout checks to
32251 succeed without a connection being made, until the cache record expires.
32252
32253 .vitem &*use_postmaster*&
32254 .cindex "callout" "sender for recipient check"
32255 This parameter applies to recipient callouts only. For example:
32256 .code
32257 deny  !verify = recipient/callout=use_postmaster
32258 .endd
32259 .vindex "&$qualify_domain$&"
32260 It causes a non-empty postmaster address to be used in the MAIL command when
32261 performing the callout for the recipient, and also for a &"random"& check if
32262 that is configured. The local part of the address is &`postmaster`& and the
32263 domain is the contents of &$qualify_domain$&.
32264
32265 .vitem &*use_sender*&
32266 This option applies to recipient callouts only. For example:
32267 .code
32268 require  verify = recipient/callout=use_sender
32269 .endd
32270 It causes the message's actual sender address to be used in the MAIL
32271 command when performing the callout, instead of an empty address. There is no
32272 need to use this option unless you know that the called hosts make use of the
32273 sender when checking recipients. If used indiscriminately, it reduces the
32274 usefulness of callout caching.
32275
32276 .vitem &*hold*&
32277 This option applies to recipient callouts only. For example:
32278 .code
32279 require  verify = recipient/callout=use_sender,hold
32280 .endd
32281 It causes the connection to be held open and used for any further recipients
32282 and for eventual delivery (should that be done quickly).
32283 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32284 when that is used for the connections.
32285 The advantage is only gained if there are no callout cache hits
32286 (which could be enforced by the no_cache option),
32287 if the use_sender option is used,
32288 if neither the random nor the use_postmaster option is used,
32289 and if no other callouts intervene.
32290 .endlist
32291
32292 If you use any of the parameters that set a non-empty sender for the MAIL
32293 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32294 &%use_sender%&), you should think about possible loops. Recipient checking is
32295 usually done between two hosts that are under the same management, and the host
32296 that receives the callouts is not normally configured to do callouts itself.
32297 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32298 these circumstances.
32299
32300 However, if you use a non-empty sender address for a callout to an arbitrary
32301 host, there is the likelihood that the remote host will itself initiate a
32302 callout check back to your host. As it is checking what appears to be a message
32303 sender, it is likely to use an empty address in MAIL, thus avoiding a
32304 callout loop. However, to be on the safe side it would be best to set up your
32305 own ACLs so that they do not do sender verification checks when the recipient
32306 is the address you use for header sender or postmaster callout checking.
32307
32308 Another issue to think about when using non-empty senders for callouts is
32309 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32310 by the sender/recipient combination; thus, for any given recipient, many more
32311 actual callouts are performed than when an empty sender or postmaster is used.
32312
32313
32314
32315
32316 .section "Callout caching" "SECTcallvercache"
32317 .cindex "hints database" "callout cache"
32318 .cindex "callout" "cache, description of"
32319 .cindex "caching" "callout"
32320 Exim caches the results of callouts in order to reduce the amount of resources
32321 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32322 option. A hints database called &"callout"& is used for the cache. Two
32323 different record types are used: one records the result of a callout check for
32324 a specific address, and the other records information that applies to the
32325 entire domain (for example, that it accepts the local part &'postmaster'&).
32326
32327 When an original callout fails, a detailed SMTP error message is given about
32328 the failure. However, for subsequent failures use the cache data, this message
32329 is not available.
32330
32331 The expiry times for negative and positive address cache records are
32332 independent, and can be set by the global options &%callout_negative_expire%&
32333 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32334
32335 If a host gives a negative response to an SMTP connection, or rejects any
32336 commands up to and including
32337 .code
32338 MAIL FROM:<>
32339 .endd
32340 (but not including the MAIL command with a non-empty address),
32341 any callout attempt is bound to fail. Exim remembers such failures in a
32342 domain cache record, which it uses to fail callouts for the domain without
32343 making new connections, until the domain record times out. There are two
32344 separate expiry times for domain cache records:
32345 &%callout_domain_negative_expire%& (default 3h) and
32346 &%callout_domain_positive_expire%& (default 7d).
32347
32348 Domain records expire when the negative expiry time is reached if callouts
32349 cannot be made for the domain, or if the postmaster check failed.
32350 Otherwise, they expire when the positive expiry time is reached. This
32351 ensures that, for example, a host that stops accepting &"random"& local parts
32352 will eventually be noticed.
32353
32354 The callout caching mechanism is based on the domain of the address that is
32355 being tested. If the domain routes to several hosts, it is assumed that their
32356 behaviour will be the same.
32357
32358
32359
32360 .section "Sender address verification reporting" "SECTsenaddver"
32361 .cindex "verifying" "suppressing error details"
32362 See section &<<SECTaddressverification>>& for a general discussion of
32363 verification. When sender verification fails in an ACL, the details of the
32364 failure are given as additional output lines before the 550 response to the
32365 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32366 you might see:
32367 .code
32368 MAIL FROM:<xyz@abc.example>
32369 250 OK
32370 RCPT TO:<pqr@def.example>
32371 550-Verification failed for <xyz@abc.example>
32372 550-Called:   192.168.34.43
32373 550-Sent:     RCPT TO:<xyz@abc.example>
32374 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32375 550 Sender verification failed
32376 .endd
32377 If more than one RCPT command fails in the same way, the details are given
32378 only for the first of them. However, some administrators do not want to send
32379 out this much information. You can suppress the details by adding
32380 &`/no_details`& to the ACL statement that requests sender verification. For
32381 example:
32382 .code
32383 verify = sender/no_details
32384 .endd
32385
32386 .section "Redirection while verifying" "SECTredirwhilveri"
32387 .cindex "verifying" "redirection while"
32388 .cindex "address redirection" "while verifying"
32389 A dilemma arises when a local address is redirected by aliasing or forwarding
32390 during verification: should the generated addresses themselves be verified,
32391 or should the successful expansion of the original address be enough to verify
32392 it? By default, Exim takes the following pragmatic approach:
32393
32394 .ilist
32395 When an incoming address is redirected to just one child address, verification
32396 continues with the child address, and if that fails to verify, the original
32397 verification also fails.
32398 .next
32399 When an incoming address is redirected to more than one child address,
32400 verification does not continue. A success result is returned.
32401 .endlist
32402
32403 This seems the most reasonable behaviour for the common use of aliasing as a
32404 way of redirecting different local parts to the same mailbox. It means, for
32405 example, that a pair of alias entries of the form
32406 .code
32407 A.Wol:   aw123
32408 aw123:   :fail: Gone away, no forwarding address
32409 .endd
32410 work as expected, with both local parts causing verification failure. When a
32411 redirection generates more than one address, the behaviour is more like a
32412 mailing list, where the existence of the alias itself is sufficient for
32413 verification to succeed.
32414
32415 It is possible, however, to change the default behaviour so that all successful
32416 redirections count as successful verifications, however many new addresses are
32417 generated. This is specified by the &%success_on_redirect%& verification
32418 option. For example:
32419 .code
32420 require verify = recipient/success_on_redirect/callout=10s
32421 .endd
32422 In this example, verification succeeds if a router generates a new address, and
32423 the callout does not occur, because no address was routed to a remote host.
32424
32425 When verification is being tested via the &%-bv%& option, the treatment of
32426 redirections is as just described, unless the &%-v%& or any debugging option is
32427 also specified. In that case, full verification is done for every generated
32428 address and a report is output for each of them.
32429
32430
32431
32432 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32433 .cindex "CSA" "verifying"
32434 Client SMTP Authorization is a system that allows a site to advertise
32435 which machines are and are not permitted to send email. This is done by placing
32436 special SRV records in the DNS; these are looked up using the client's HELO
32437 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32438 Authorization checks in Exim are performed by the ACL condition:
32439 .code
32440 verify = csa
32441 .endd
32442 This fails if the client is not authorized. If there is a DNS problem, or if no
32443 valid CSA SRV record is found, or if the client is authorized, the condition
32444 succeeds. These three cases can be distinguished using the expansion variable
32445 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32446 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32447 be likely to cause problems for legitimate email.
32448
32449 The error messages produced by the CSA code include slightly more
32450 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32451 looking up the CSA SRV record, or problems looking up the CSA target
32452 address record. There are four reasons for &$csa_status$& being &"fail"&:
32453
32454 .ilist
32455 The client's host name is explicitly not authorized.
32456 .next
32457 The client's IP address does not match any of the CSA target IP addresses.
32458 .next
32459 The client's host name is authorized but it has no valid target IP addresses
32460 (for example, the target's addresses are IPv6 and the client is using IPv4).
32461 .next
32462 The client's host name has no CSA SRV record but a parent domain has asserted
32463 that all subdomains must be explicitly authorized.
32464 .endlist
32465
32466 The &%csa%& verification condition can take an argument which is the domain to
32467 use for the DNS query. The default is:
32468 .code
32469 verify = csa/$sender_helo_name
32470 .endd
32471 This implementation includes an extension to CSA. If the query domain
32472 is an address literal such as [192.0.2.95], or if it is a bare IP
32473 address, Exim searches for CSA SRV records in the reverse DNS as if
32474 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32475 meaningful to say:
32476 .code
32477 verify = csa/$sender_host_address
32478 .endd
32479 In fact, this is the check that Exim performs if the client does not say HELO.
32480 This extension can be turned off by setting the main configuration option
32481 &%dns_csa_use_reverse%& to be false.
32482
32483 If a CSA SRV record is not found for the domain itself, a search
32484 is performed through its parent domains for a record which might be
32485 making assertions about subdomains. The maximum depth of this search is limited
32486 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32487 default. Exim does not look for CSA SRV records in a top level domain, so the
32488 default settings handle HELO domains as long as seven
32489 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32490 of legitimate HELO domains.
32491
32492 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32493 direct SRV lookups, this is not sufficient because of the extra parent domain
32494 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32495 addresses into lookups in the reverse DNS space. The result of a successful
32496 lookup such as:
32497 .code
32498 ${lookup dnsdb {csa=$sender_helo_name}}
32499 .endd
32500 has two space-separated fields: an authorization code and a target host name.
32501 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32502 authorization required but absent, or &"?"& for unknown.
32503
32504
32505
32506
32507 .section "Bounce address tag validation" "SECTverifyPRVS"
32508 .cindex "BATV, verifying"
32509 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32510 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32511 Genuine incoming bounce messages should therefore always be addressed to
32512 recipients that have a valid tag. This scheme is a way of detecting unwanted
32513 bounce messages caused by sender address forgeries (often called &"collateral
32514 spam"&), because the recipients of such messages do not include valid tags.
32515
32516 There are two expansion items to help with the implementation of the BATV
32517 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32518 the original envelope sender address by using a simple key to add a hash of the
32519 address and some time-based randomizing information. The &%prvs%& expansion
32520 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32521 The syntax of these expansion items is described in section
32522 &<<SECTexpansionitems>>&.
32523 The validity period on signed addresses is seven days.
32524
32525 As an example, suppose the secret per-address keys are stored in an MySQL
32526 database. A query to look up the key for an address could be defined as a macro
32527 like this:
32528 .code
32529 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32530                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32531                 }{$value}}
32532 .endd
32533 Suppose also that the senders who make use of BATV are defined by an address
32534 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32535 use this:
32536 .code
32537 # Bounces: drop unsigned addresses for BATV senders
32538 deny message = This address does not send an unsigned reverse path
32539      senders = :
32540      recipients = +batv_senders
32541
32542 # Bounces: In case of prvs-signed address, check signature.
32543 deny message = Invalid reverse path signature.
32544      senders = :
32545      condition  = ${prvscheck {$local_part@$domain}\
32546                   {PRVSCHECK_SQL}{1}}
32547      !condition = $prvscheck_result
32548 .endd
32549 The first statement rejects recipients for bounce messages that are addressed
32550 to plain BATV sender addresses, because it is known that BATV senders do not
32551 send out messages with plain sender addresses. The second statement rejects
32552 recipients that are prvs-signed, but with invalid signatures (either because
32553 the key is wrong, or the signature has timed out).
32554
32555 A non-prvs-signed address is not rejected by the second statement, because the
32556 &%prvscheck%& expansion yields an empty string if its first argument is not a
32557 prvs-signed address, thus causing the &%condition%& condition to be false. If
32558 the first argument is a syntactically valid prvs-signed address, the yield is
32559 the third string (in this case &"1"&), whether or not the cryptographic and
32560 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32561 of the checks (empty for failure, &"1"& for success).
32562
32563 There is one more issue you must consider when implementing prvs-signing:
32564 you have to ensure that the routers accept prvs-signed addresses and
32565 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32566 router to remove the signature with a configuration along these lines:
32567 .code
32568 batv_redirect:
32569   driver = redirect
32570   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32571 .endd
32572 This works because, if the third argument of &%prvscheck%& is empty, the result
32573 of the expansion of a prvs-signed address is the decoded value of the original
32574 address. This router should probably be the first of your routers that handles
32575 local addresses.
32576
32577 To create BATV-signed addresses in the first place, a transport of this form
32578 can be used:
32579 .code
32580 external_smtp_batv:
32581   driver = smtp
32582   return_path = ${prvs {$return_path} \
32583                        {${lookup mysql{SELECT \
32584                        secret FROM batv_prvs WHERE \
32585                        sender='${quote_mysql:$sender_address}'} \
32586                        {$value}fail}}}
32587 .endd
32588 If no key can be found for the existing return path, no signing takes place.
32589
32590
32591
32592 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32593 .cindex "&ACL;" "relay control"
32594 .cindex "relaying" "control by ACL"
32595 .cindex "policy control" "relay control"
32596 An MTA is said to &'relay'& a message if it receives it from some host and
32597 delivers it directly to another host as a result of a remote address contained
32598 within it. Redirecting a local address via an alias or forward file and then
32599 passing the message on to another host is not relaying,
32600 .cindex "&""percent hack""&"
32601 but a redirection as a result of the &"percent hack"& is.
32602
32603 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32604 A host which is acting as a gateway or an MX backup is concerned with incoming
32605 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32606 a host which is acting as a smart host for a number of clients is concerned
32607 with outgoing relaying from those clients to the Internet at large. Often the
32608 same host is fulfilling both functions,
32609 . ///
32610 . as illustrated in the diagram below,
32611 . ///
32612 but in principle these two kinds of relaying are entirely independent. What is
32613 not wanted is the transmission of mail from arbitrary remote hosts through your
32614 system to arbitrary domains.
32615
32616
32617 You can implement relay control by means of suitable statements in the ACL that
32618 runs for each RCPT command. For convenience, it is often easiest to use
32619 Exim's named list facility to define the domains and hosts involved. For
32620 example, suppose you want to do the following:
32621
32622 .ilist
32623 Deliver a number of domains to mailboxes on the local host (or process them
32624 locally in some other way). Let's say these are &'my.dom1.example'& and
32625 &'my.dom2.example'&.
32626 .next
32627 Relay mail for a number of other domains for which you are the secondary MX.
32628 These might be &'friend1.example'& and &'friend2.example'&.
32629 .next
32630 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32631 Suppose your LAN is 192.168.45.0/24.
32632 .endlist
32633
32634
32635 In the main part of the configuration, you put the following definitions:
32636 .code
32637 domainlist local_domains    = my.dom1.example : my.dom2.example
32638 domainlist relay_to_domains = friend1.example : friend2.example
32639 hostlist   relay_from_hosts = 192.168.45.0/24
32640 .endd
32641 Now you can use these definitions in the ACL that is run for every RCPT
32642 command:
32643 .code
32644 acl_check_rcpt:
32645   accept domains = +local_domains : +relay_to_domains
32646   accept hosts   = +relay_from_hosts
32647 .endd
32648 The first statement accepts any RCPT command that contains an address in
32649 the local or relay domains. For any other domain, control passes to the second
32650 statement, which accepts the command only if it comes from one of the relay
32651 hosts. In practice, you will probably want to make your ACL more sophisticated
32652 than this, for example, by including sender and recipient verification. The
32653 default configuration includes a more comprehensive example, which is described
32654 in chapter &<<CHAPdefconfil>>&.
32655
32656
32657
32658 .section "Checking a relay configuration" "SECTcheralcon"
32659 .cindex "relaying" "checking control of"
32660 You can check the relay characteristics of your configuration in the same way
32661 that you can test any ACL behaviour for an incoming SMTP connection, by using
32662 the &%-bh%& option to run a fake SMTP session with which you interact.
32663 .ecindex IIDacl
32664
32665
32666
32667 . ////////////////////////////////////////////////////////////////////////////
32668 . ////////////////////////////////////////////////////////////////////////////
32669
32670 .chapter "Content scanning at ACL time" "CHAPexiscan"
32671 .scindex IIDcosca "content scanning" "at ACL time"
32672 The extension of Exim to include content scanning at ACL time, formerly known
32673 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32674 was integrated into the main source for Exim release 4.50, and Tom continues to
32675 maintain it. Most of the wording of this chapter is taken from Tom's
32676 specification.
32677
32678 It is also possible to scan the content of messages at other times. The
32679 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32680 scanning after all the ACLs have run. A transport filter can be used to scan
32681 messages at delivery time (see the &%transport_filter%& option, described in
32682 chapter &<<CHAPtransportgeneric>>&).
32683
32684 If you want to include the ACL-time content-scanning features when you compile
32685 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32686 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32687
32688 .ilist
32689 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32690 for all MIME parts for SMTP and non-SMTP messages, respectively.
32691 .next
32692 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32693 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32694 run at the end of message reception (the &%acl_smtp_data%& ACL).
32695 .next
32696 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32697 of messages, or parts of messages, for debugging purposes.
32698 .next
32699 Additional expansion variables that are set in the new ACL and by the new
32700 conditions.
32701 .next
32702 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32703 .endlist
32704
32705 Content-scanning is continually evolving, and new features are still being
32706 added. While such features are still unstable and liable to incompatible
32707 changes, they are made available in Exim by setting options whose names begin
32708 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32709 this manual. You can find out about them by reading the file called
32710 &_doc/experimental.txt_&.
32711
32712 All the content-scanning facilities work on a MBOX copy of the message that is
32713 temporarily created in a file called:
32714 .display
32715 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32716 .endd
32717 The &_.eml_& extension is a friendly hint to virus scanners that they can
32718 expect an MBOX-like structure inside that file. The file is created when the
32719 first content scanning facility is called. Subsequent calls to content
32720 scanning conditions open the same file again. The directory is recursively
32721 removed when the &%acl_smtp_data%& ACL has finished running, unless
32722 .code
32723 control = no_mbox_unspool
32724 .endd
32725 has been encountered. When the MIME ACL decodes files, they are put into the
32726 same directory by default.
32727
32728
32729
32730 .section "Scanning for viruses" "SECTscanvirus"
32731 .cindex "virus scanning"
32732 .cindex "content scanning" "for viruses"
32733 .cindex "content scanning" "the &%malware%& condition"
32734 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32735 It supports a &"generic"& interface to scanners called via the shell, and
32736 specialized interfaces for &"daemon"& type virus scanners, which are resident
32737 in memory and thus are much faster.
32738
32739 .new
32740 Since message data needs to have arrived,
32741 the condition may be only called in ACL defined by
32742 &%acl_smtp_data%&,
32743 &%acl_smtp_data_prdr%&,
32744 &%acl_smtp_mime%& or
32745 &%acl_smtp_dkim%&
32746 .wen
32747
32748 A timeout of 2 minutes is applied to a scanner call (by default);
32749 if it expires then a defer action is taken.
32750
32751 .oindex "&%av_scanner%&"
32752 You can set the &%av_scanner%& option in the main part of the configuration
32753 to specify which scanner to use, together with any additional options that
32754 are needed. The basic syntax is as follows:
32755 .display
32756 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32757 .endd
32758 If you do not set &%av_scanner%&, it defaults to
32759 .code
32760 av_scanner = sophie:/var/run/sophie
32761 .endd
32762 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32763 before use.
32764 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32765 The following scanner types are supported in this release,
32766 though individual ones can be included or not at build time:
32767
32768 .vlist
32769 .vitem &%avast%&
32770 .cindex "virus scanners" "avast"
32771 This is the scanner daemon of Avast. It has been tested with Avast Core
32772 Security (currently at version 2.2.0).
32773 You can get a trial version at &url(https://www.avast.com) or for Linux
32774 at &url(https://www.avast.com/linux-server-antivirus).
32775 This scanner type takes one option,
32776 which can be either a full path to a UNIX socket,
32777 or host and port specifiers separated by white space.
32778 The host may be a name or an IP address; the port is either a
32779 single number or a pair of numbers with a dash between.
32780 A list of options may follow. These options are interpreted on the
32781 Exim's side of the malware scanner, or are given on separate lines to
32782 the daemon as options before the main scan command.
32783
32784 .cindex &`pass_unscanned`& "avast"
32785 If &`pass_unscanned`&
32786 is set, any files the Avast scanner can't scan (e.g.
32787 decompression bombs, or invalid archives) are considered clean. Use with
32788 care.
32789
32790 For example:
32791 .code
32792 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32793 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32794 av_scanner = avast:192.168.2.22 5036
32795 .endd
32796 If you omit the argument, the default path
32797 &_/var/run/avast/scan.sock_&
32798 is used.
32799 If you use a remote host,
32800 you need to make Exim's spool directory available to it,
32801 as the scanner is passed a file path, not file contents.
32802 For information about available commands and their options you may use
32803 .code
32804 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32805     FLAGS
32806     SENSITIVITY
32807     PACK
32808 .endd
32809
32810 If the scanner returns a temporary failure (e.g. license issues, or
32811 permission problems), the message is deferred and a paniclog entry is
32812 written.  The usual &`defer_ok`& option is available.
32813
32814 .vitem &%aveserver%&
32815 .cindex "virus scanners" "Kaspersky"
32816 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32817 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32818 which is the path to the daemon's UNIX socket. The default is shown in this
32819 example:
32820 .code
32821 av_scanner = aveserver:/var/run/aveserver
32822 .endd
32823
32824
32825 .vitem &%clamd%&
32826 .cindex "virus scanners" "clamd"
32827 This daemon-type scanner is GPL and free. You can get it at
32828 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32829 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32830 in the MIME ACL. This is no longer believed to be necessary.
32831
32832 The options are a list of server specifiers, which may be
32833 a UNIX socket specification,
32834 a TCP socket specification,
32835 or a (global) option.
32836
32837 A socket specification consists of a space-separated list.
32838 For a Unix socket the first element is a full path for the socket,
32839 for a TCP socket the first element is the IP address
32840 and the second a port number,
32841 Any further elements are per-server (non-global) options.
32842 These per-server options are supported:
32843 .code
32844 retry=<timespec>        Retry on connect fail
32845 .endd
32846
32847 The &`retry`& option specifies a time after which a single retry for
32848 a failed connect is made.  The default is to not retry.
32849
32850 If a Unix socket file is specified, only one server is supported.
32851
32852 Examples:
32853 .code
32854 av_scanner = clamd:/opt/clamd/socket
32855 av_scanner = clamd:192.0.2.3 1234
32856 av_scanner = clamd:192.0.2.3 1234:local
32857 av_scanner = clamd:192.0.2.3 1234 retry=10s
32858 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32859 .endd
32860 If the value of av_scanner points to a UNIX socket file or contains the
32861 &`local`&
32862 option, then the ClamAV interface will pass a filename containing the data
32863 to be scanned, which should normally result in less I/O happening and be
32864 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32865 Exim does not assume that there is a common filesystem with the remote host.
32866
32867 The final example shows that multiple TCP targets can be specified.  Exim will
32868 randomly use one for each incoming email (i.e. it load balances them).  Note
32869 that only TCP targets may be used if specifying a list of scanners; a UNIX
32870 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32871 unavailable, Exim will try the remaining one(s) until it finds one that works.
32872 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32873 not keep track of scanner state between multiple messages, and the scanner
32874 selection is random, so the message will get logged in the mainlog for each
32875 email that the down scanner gets chosen first (message wrapped to be readable):
32876 .code
32877 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32878    clamd: connection to localhost, port 3310 failed
32879    (Connection refused)
32880 .endd
32881
32882 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32883 contributing the code for this scanner.
32884
32885 .vitem &%cmdline%&
32886 .cindex "virus scanners" "command line interface"
32887 This is the keyword for the generic command line scanner interface. It can be
32888 used to attach virus scanners that are invoked from the shell. This scanner
32889 type takes 3 mandatory options:
32890
32891 .olist
32892 The full path and name of the scanner binary, with all command line options,
32893 and a placeholder (&`%s`&) for the directory to scan.
32894
32895 .next
32896 A regular expression to match against the STDOUT and STDERR output of the
32897 virus scanner. If the expression matches, a virus was found. You must make
32898 absolutely sure that this expression matches on &"virus found"&. This is called
32899 the &"trigger"& expression.
32900
32901 .next
32902 Another regular expression, containing exactly one pair of parentheses, to
32903 match the name of the virus found in the scanners output. This is called the
32904 &"name"& expression.
32905 .endlist olist
32906
32907 For example, Sophos Sweep reports a virus on a line like this:
32908 .code
32909 Virus 'W32/Magistr-B' found in file ./those.bat
32910 .endd
32911 For the trigger expression, we can match the phrase &"found in file"&. For the
32912 name expression, we want to extract the W32/Magistr-B string, so we can match
32913 for the single quotes left and right of it. Altogether, this makes the
32914 configuration setting:
32915 .code
32916 av_scanner = cmdline:\
32917              /path/to/sweep -ss -all -rec -archive %s:\
32918              found in file:'(.+)'
32919 .endd
32920 .vitem &%drweb%&
32921 .cindex "virus scanners" "DrWeb"
32922 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32923 takes one option,
32924 either a full path to a UNIX socket,
32925 or host and port specifiers separated by white space.
32926 The host may be a name or an IP address; the port is either a
32927 single number or a pair of numbers with a dash between.
32928 For example:
32929 .code
32930 av_scanner = drweb:/var/run/drwebd.sock
32931 av_scanner = drweb:192.168.2.20 31337
32932 .endd
32933 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32934 is used. Thanks to Alex Miller for contributing the code for this scanner.
32935
32936 .vitem &%f-protd%&
32937 .cindex "virus scanners" "f-protd"
32938 The f-protd scanner is accessed via HTTP over TCP.
32939 One argument is taken, being a space-separated hostname and port number
32940 (or port-range).
32941 For example:
32942 .code
32943 av_scanner = f-protd:localhost 10200-10204
32944 .endd
32945 If you omit the argument, the default values shown above are used.
32946
32947 .vitem &%f-prot6d%&
32948 .cindex "virus scanners" "f-prot6d"
32949 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32950 One argument is taken, being a space-separated hostname and port number.
32951 For example:
32952 .code
32953 av_scanner = f-prot6d:localhost 10200
32954 .endd
32955 If you omit the argument, the default values show above are used.
32956
32957 .vitem &%fsecure%&
32958 .cindex "virus scanners" "F-Secure"
32959 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32960 argument which is the path to a UNIX socket. For example:
32961 .code
32962 av_scanner = fsecure:/path/to/.fsav
32963 .endd
32964 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32965 Thelmen for contributing the code for this scanner.
32966
32967 .vitem &%kavdaemon%&
32968 .cindex "virus scanners" "Kaspersky"
32969 This is the scanner daemon of Kaspersky Version 4. This version of the
32970 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32971 scanner type takes one option, which is the path to the daemon's UNIX socket.
32972 For example:
32973 .code
32974 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32975 .endd
32976 The default path is &_/var/run/AvpCtl_&.
32977
32978 .vitem &%mksd%&
32979 .cindex "virus scanners" "mksd"
32980 This was a daemon type scanner that is aimed mainly at Polish users,
32981 though some documentation was available in English.
32982 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32983 and this appears to be a candidate for removal from Exim, unless
32984 we are informed of other virus scanners which use the same protocol
32985 to integrate.
32986 The only option for this scanner type is
32987 the maximum number of processes used simultaneously to scan the attachments,
32988 provided that mksd has
32989 been run with at least the same number of child processes. For example:
32990 .code
32991 av_scanner = mksd:2
32992 .endd
32993 You can safely omit this option (the default value is 1).
32994
32995 .vitem &%sock%&
32996 .cindex "virus scanners" "simple socket-connected"
32997 This is a general-purpose way of talking to simple scanner daemons
32998 running on the local machine.
32999 There are four options:
33000 an address (which may be an IP address and port, or the path of a Unix socket),
33001 a commandline to send (may include a single %s which will be replaced with
33002 the path to the mail file to be scanned),
33003 an RE to trigger on from the returned data,
33004 and an RE to extract malware_name from the returned data.
33005 For example:
33006 .code
33007 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33008 .endd
33009 Note that surrounding whitespace is stripped from each option, meaning
33010 there is no way to specify a trailing newline.
33011 The socket specifier and both regular-expressions are required.
33012 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33013 specify an empty element to get this.
33014
33015 .vitem &%sophie%&
33016 .cindex "virus scanners" "Sophos and Sophie"
33017 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33018 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33019 for this scanner type is the path to the UNIX socket that Sophie uses for
33020 client communication. For example:
33021 .code
33022 av_scanner = sophie:/tmp/sophie
33023 .endd
33024 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33025 the option.
33026 .endlist
33027
33028 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33029 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33030 ACL.
33031
33032 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33033 makes it possible to use different scanners. See further below for an example.
33034 The &%malware%& condition caches its results, so when you use it multiple times
33035 for the same message, the actual scanning process is only carried out once.
33036 However, using expandable items in &%av_scanner%& disables this caching, in
33037 which case each use of the &%malware%& condition causes a new scan of the
33038 message.
33039
33040 The &%malware%& condition takes a right-hand argument that is expanded before
33041 use and taken as a list, slash-separated by default.
33042 The first element can then be one of
33043
33044 .ilist
33045 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33046 The condition succeeds if a virus was found, and fail otherwise. This is the
33047 recommended usage.
33048 .next
33049 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33050 the condition fails immediately.
33051 .next
33052 A regular expression, in which case the message is scanned for viruses. The
33053 condition succeeds if a virus is found and its name matches the regular
33054 expression. This allows you to take special actions on certain types of virus.
33055 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33056 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33057 .endlist
33058
33059 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33060 messages even if there is a problem with the virus scanner.
33061 Otherwise, such a problem causes the ACL to defer.
33062
33063 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33064 specify a non-default timeout.  The default is two minutes.
33065 For example:
33066 .code
33067 malware = * / defer_ok / tmo=10s
33068 .endd
33069 A timeout causes the ACL to defer.
33070
33071 .vindex "&$callout_address$&"
33072 When a connection is made to the scanner the expansion variable &$callout_address$&
33073 is set to record the actual address used.
33074
33075 .vindex "&$malware_name$&"
33076 When a virus is found, the condition sets up an expansion variable called
33077 &$malware_name$& that contains the name of the virus. You can use it in a
33078 &%message%& modifier that specifies the error returned to the sender, and/or in
33079 logging data.
33080
33081 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33082 imposed by your anti-virus scanner.
33083
33084 Here is a very simple scanning example:
33085 .code
33086 deny message = This message contains malware ($malware_name)
33087      malware = *
33088 .endd
33089 The next example accepts messages when there is a problem with the scanner:
33090 .code
33091 deny message = This message contains malware ($malware_name)
33092      malware = */defer_ok
33093 .endd
33094 The next example shows how to use an ACL variable to scan with both sophie and
33095 aveserver. It assumes you have set:
33096 .code
33097 av_scanner = $acl_m0
33098 .endd
33099 in the main Exim configuration.
33100 .code
33101 deny message = This message contains malware ($malware_name)
33102      set acl_m0 = sophie
33103      malware = *
33104
33105 deny message = This message contains malware ($malware_name)
33106      set acl_m0 = aveserver
33107      malware = *
33108 .endd
33109
33110
33111 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33112 .cindex "content scanning" "for spam"
33113 .cindex "spam scanning"
33114 .cindex "SpamAssassin"
33115 .cindex "Rspamd"
33116 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33117 score and a report for the message.
33118 Support is also provided for Rspamd.
33119
33120 For more information about installation and configuration of SpamAssassin or
33121 Rspamd refer to their respective websites at
33122 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33123
33124 SpamAssassin can be installed with CPAN by running:
33125 .code
33126 perl -MCPAN -e 'install Mail::SpamAssassin'
33127 .endd
33128 SpamAssassin has its own set of configuration files. Please review its
33129 documentation to see how you can tweak it. The default installation should work
33130 nicely, however.
33131
33132 .oindex "&%spamd_address%&"
33133 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33134 intend to use an instance running on the local host you do not need to set
33135 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33136 you must set the &%spamd_address%& option in the global part of the Exim
33137 configuration as follows (example):
33138 .code
33139 spamd_address = 192.168.99.45 783
33140 .endd
33141 The SpamAssassin protocol relies on a TCP half-close from the client.
33142 If your SpamAssassin client side is running a Linux system with an
33143 iptables firewall, consider setting
33144 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33145 timeout, Exim uses when waiting for a response from the SpamAssassin
33146 server (currently defaulting to 120s).  With a lower value the Linux
33147 connection tracking may consider your half-closed connection as dead too
33148 soon.
33149
33150
33151 To use Rspamd (which by default listens on all local addresses
33152 on TCP port 11333)
33153 you should add &%variant=rspamd%& after the address/port pair, for example:
33154 .code
33155 spamd_address = 127.0.0.1 11333 variant=rspamd
33156 .endd
33157
33158 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33159 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33160 filename instead of an address/port pair:
33161 .code
33162 spamd_address = /var/run/spamd_socket
33163 .endd
33164 You can have multiple &%spamd%& servers to improve scalability. These can
33165 reside on other hardware reachable over the network. To specify multiple
33166 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33167 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33168 .code
33169 spamd_address = 192.168.2.10 783 : \
33170                 192.168.2.11 783 : \
33171                 192.168.2.12 783
33172 .endd
33173 Up to 32 &%spamd%& servers are supported.
33174 When a server fails to respond to the connection attempt, all other
33175 servers are tried until one succeeds. If no server responds, the &%spam%&
33176 condition defers.
33177
33178 Unix and TCP socket specifications may be mixed in any order.
33179 Each element of the list is a list itself, space-separated by default
33180 and changeable in the usual way (&<<SECTlistsepchange>>&);
33181 take care to not double the separator.
33182
33183 For TCP socket specifications a host name or IP (v4 or v6, but
33184 subject to list-separator quoting rules) address can be used,
33185 and the port can be one or a dash-separated pair.
33186 In the latter case, the range is tried in strict order.
33187
33188 Elements after the first for Unix sockets, or second for TCP socket,
33189 are options.
33190 The supported options are:
33191 .code
33192 pri=<priority>      Selection priority
33193 weight=<value>      Selection bias
33194 time=<start>-<end>  Use only between these times of day
33195 retry=<timespec>    Retry on connect fail
33196 tmo=<timespec>      Connection time limit
33197 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33198 .endd
33199
33200 The &`pri`& option specifies a priority for the server within the list,
33201 higher values being tried first.
33202 The default priority is 1.
33203
33204 The &`weight`& option specifies a selection bias.
33205 Within a priority set
33206 servers are queried in a random fashion, weighted by this value.
33207 The default value for selection bias is 1.
33208
33209 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33210 in the local time zone; each element being one or more digits.
33211 Either the seconds or both minutes and seconds, plus the leading &`.`&
33212 characters, may be omitted and will be taken as zero.
33213
33214 Timeout specifications for the &`retry`& and &`tmo`& options
33215 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33216
33217 The &`tmo`& option specifies an overall timeout for communication.
33218 The default value is two minutes.
33219
33220 The &`retry`& option specifies a time after which a single retry for
33221 a failed connect is made.
33222 The default is to not retry.
33223
33224 The &%spamd_address%& variable is expanded before use if it starts with
33225 a dollar sign. In this case, the expansion may return a string that is
33226 used as the list so that multiple spamd servers can be the result of an
33227 expansion.
33228
33229 .vindex "&$callout_address$&"
33230 When a connection is made to the server the expansion variable &$callout_address$&
33231 is set to record the actual address used.
33232
33233 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33234 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33235 .code
33236 deny message = This message was classified as SPAM
33237      spam = joe
33238 .endd
33239 The right-hand side of the &%spam%& condition specifies a name. This is
33240 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33241 to scan using a specific profile, but rather use the SpamAssassin system-wide
33242 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33243 Rspamd does not use this setting. However, you must put something on the
33244 right-hand side.
33245
33246 The name allows you to use per-domain or per-user antispam profiles in
33247 principle, but this is not straightforward in practice, because a message may
33248 have multiple recipients, not necessarily all in the same domain. Because the
33249 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33250 read the contents of the message, the variables &$local_part$& and &$domain$&
33251 are not set.
33252 Careful enforcement of single-recipient messages
33253 (e.g. by responding with defer in the recipient ACL for all recipients
33254 after the first),
33255 or the use of PRDR,
33256 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33257 are needed to use this feature.
33258
33259 The right-hand side of the &%spam%& condition is expanded before being used, so
33260 you can put lookups or conditions there. When the right-hand side evaluates to
33261 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33262
33263
33264 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33265 large ones may cause significant performance degradation. As most spam messages
33266 are quite small, it is recommended that you do not scan the big ones. For
33267 example:
33268 .code
33269 deny message = This message was classified as SPAM
33270      condition = ${if < {$message_size}{10K}}
33271      spam = nobody
33272 .endd
33273
33274 The &%spam%& condition returns true if the threshold specified in the user's
33275 SpamAssassin profile has been matched or exceeded. If you want to use the
33276 &%spam%& condition for its side effects (see the variables below), you can make
33277 it always return &"true"& by appending &`:true`& to the username.
33278
33279 .cindex "spam scanning" "returned variables"
33280 When the &%spam%& condition is run, it sets up a number of expansion
33281 variables.
33282 Except for &$spam_report$&,
33283 these variables are saved with the received message so are
33284 available for use at delivery time.
33285
33286 .vlist
33287 .vitem &$spam_score$&
33288 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33289 for inclusion in log or reject messages.
33290
33291 .vitem &$spam_score_int$&
33292 The spam score of the message, multiplied by ten, as an integer value. For
33293 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33294 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33295 The integer value is useful for numeric comparisons in conditions.
33296
33297 .vitem &$spam_bar$&
33298 A string consisting of a number of &"+"& or &"-"& characters, representing the
33299 integer part of the spam score value. A spam score of 4.4 would have a
33300 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33301 headers, since MUAs can match on such strings. The maximum length of the
33302 spam bar is 50 characters.
33303
33304 .vitem &$spam_report$&
33305 A multiline text table, containing the full SpamAssassin report for the
33306 message. Useful for inclusion in headers or reject messages.
33307 This variable is only usable in a DATA-time ACL.
33308 Beware that SpamAssassin may return non-ASCII characters, especially
33309 when running in country-specific locales, which are not legal
33310 unencoded in headers.
33311
33312 .vitem &$spam_action$&
33313 For SpamAssassin either 'reject' or 'no action' depending on the
33314 spam score versus threshold.
33315 For Rspamd, the recommended action.
33316
33317 .endlist
33318
33319 The &%spam%& condition caches its results unless expansion in
33320 spamd_address was used. If you call it again with the same user name, it
33321 does not scan again, but rather returns the same values as before.
33322
33323 The &%spam%& condition returns DEFER if there is any error while running
33324 the message through SpamAssassin or if the expansion of spamd_address
33325 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33326 statement block), append &`/defer_ok`& to the right-hand side of the
33327 spam condition, like this:
33328 .code
33329 deny message = This message was classified as SPAM
33330      spam    = joe/defer_ok
33331 .endd
33332 This causes messages to be accepted even if there is a problem with &%spamd%&.
33333
33334 Here is a longer, commented example of the use of the &%spam%&
33335 condition:
33336 .code
33337 # put headers in all messages (no matter if spam or not)
33338 warn  spam = nobody:true
33339       add_header = X-Spam-Score: $spam_score ($spam_bar)
33340       add_header = X-Spam-Report: $spam_report
33341
33342 # add second subject line with *SPAM* marker when message
33343 # is over threshold
33344 warn  spam = nobody
33345       add_header = Subject: *SPAM* $h_Subject:
33346
33347 # reject spam at high scores (> 12)
33348 deny  message = This message scored $spam_score spam points.
33349       spam = nobody:true
33350       condition = ${if >{$spam_score_int}{120}{1}{0}}
33351 .endd
33352
33353
33354
33355 .section "Scanning MIME parts" "SECTscanmimepart"
33356 .cindex "content scanning" "MIME parts"
33357 .cindex "MIME content scanning"
33358 .oindex "&%acl_smtp_mime%&"
33359 .oindex "&%acl_not_smtp_mime%&"
33360 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33361 each MIME part of an SMTP message, including multipart types, in the sequence
33362 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33363 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33364 options may both refer to the same ACL if you want the same processing in both
33365 cases.
33366
33367 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33368 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33369 the case of a non-SMTP message. However, a MIME ACL is called only if the
33370 message contains a &'Content-Type:'& header line. When a call to a MIME
33371 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33372 result code is sent to the client. In the case of an SMTP message, the
33373 &%acl_smtp_data%& ACL is not called when this happens.
33374
33375 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33376 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33377 condition to match against the raw MIME part. You can also use the
33378 &%mime_regex%& condition to match against the decoded MIME part (see section
33379 &<<SECTscanregex>>&).
33380
33381 At the start of a MIME ACL, a number of variables are set from the header
33382 information for the relevant MIME part. These are described below. The contents
33383 of the MIME part are not by default decoded into a disk file except for MIME
33384 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33385 part into a disk file, you can use the &%decode%& condition. The general
33386 syntax is:
33387 .display
33388 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33389 .endd
33390 The right hand side is expanded before use. After expansion,
33391 the value can be:
33392
33393 .olist
33394 &"0"& or &"false"&, in which case no decoding is done.
33395 .next
33396 The string &"default"&. In that case, the file is put in the temporary
33397 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33398 a sequential filename consisting of the message id and a sequence number. The
33399 full path and name is available in &$mime_decoded_filename$& after decoding.
33400 .next
33401 A full path name starting with a slash. If the full name is an existing
33402 directory, it is used as a replacement for the default directory. The filename
33403 is then sequentially assigned. If the path does not exist, it is used as
33404 the full path and filename.
33405 .next
33406 If the string does not start with a slash, it is used as the
33407 filename, and the default path is then used.
33408 .endlist
33409 The &%decode%& condition normally succeeds. It is only false for syntax
33410 errors or unusual circumstances such as memory shortages. You can easily decode
33411 a file with its original, proposed filename using
33412 .code
33413 decode = $mime_filename
33414 .endd
33415 However, you should keep in mind that &$mime_filename$& might contain
33416 anything. If you place files outside of the default path, they are not
33417 automatically unlinked.
33418
33419 For RFC822 attachments (these are messages attached to messages, with a
33420 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33421 as for the primary message, only that the &$mime_is_rfc822$& expansion
33422 variable is set (see below). Attached messages are always decoded to disk
33423 before being checked, and the files are unlinked once the check is done.
33424
33425 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33426 used to match regular expressions against raw and decoded MIME parts,
33427 respectively. They are described in section &<<SECTscanregex>>&.
33428
33429 .cindex "MIME content scanning" "returned variables"
33430 The following list describes all expansion variables that are
33431 available in the MIME ACL:
33432
33433 .vlist
33434 .vitem &$mime_boundary$&
33435 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33436 have a boundary string, which is stored in this variable. If the current part
33437 has no boundary parameter in the &'Content-Type:'& header, this variable
33438 contains the empty string.
33439
33440 .vitem &$mime_charset$&
33441 This variable contains the character set identifier, if one was found in the
33442 &'Content-Type:'& header. Examples for charset identifiers are:
33443 .code
33444 us-ascii
33445 gb2312 (Chinese)
33446 iso-8859-1
33447 .endd
33448 Please note that this value is not normalized, so you should do matches
33449 case-insensitively.
33450
33451 .vitem &$mime_content_description$&
33452 This variable contains the normalized content of the &'Content-Description:'&
33453 header. It can contain a human-readable description of the parts content. Some
33454 implementations repeat the filename for attachments here, but they are usually
33455 only used for display purposes.
33456
33457 .vitem &$mime_content_disposition$&
33458 This variable contains the normalized content of the &'Content-Disposition:'&
33459 header. You can expect strings like &"attachment"& or &"inline"& here.
33460
33461 .vitem &$mime_content_id$&
33462 This variable contains the normalized content of the &'Content-ID:'& header.
33463 This is a unique ID that can be used to reference a part from another part.
33464
33465 .vitem &$mime_content_size$&
33466 This variable is set only after the &%decode%& modifier (see above) has been
33467 successfully run. It contains the size of the decoded part in kilobytes. The
33468 size is always rounded up to full kilobytes, so only a completely empty part
33469 has a &$mime_content_size$& of zero.
33470
33471 .vitem &$mime_content_transfer_encoding$&
33472 This variable contains the normalized content of the
33473 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33474 type. Typical values are &"base64"& and &"quoted-printable"&.
33475
33476 .vitem &$mime_content_type$&
33477 If the MIME part has a &'Content-Type:'& header, this variable contains its
33478 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33479 are some examples of popular MIME types, as they may appear in this variable:
33480 .code
33481 text/plain
33482 text/html
33483 application/octet-stream
33484 image/jpeg
33485 audio/midi
33486 .endd
33487 If the MIME part has no &'Content-Type:'& header, this variable contains the
33488 empty string.
33489
33490 .vitem &$mime_decoded_filename$&
33491 This variable is set only after the &%decode%& modifier (see above) has been
33492 successfully run. It contains the full path and filename of the file
33493 containing the decoded data.
33494 .endlist
33495
33496 .cindex "RFC 2047"
33497 .vlist
33498 .vitem &$mime_filename$&
33499 This is perhaps the most important of the MIME variables. It contains a
33500 proposed filename for an attachment, if one was found in either the
33501 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33502 RFC2047
33503 or RFC2231
33504 decoded, but no additional sanity checks are done.
33505  If no filename was
33506 found, this variable contains the empty string.
33507
33508 .vitem &$mime_is_coverletter$&
33509 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33510 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33511 content in the cover letter, while not restricting attachments at all.
33512
33513 The variable contains 1 (true) for a MIME part believed to be part of the
33514 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33515 follows:
33516
33517 .olist
33518 The outermost MIME part of a message is always a cover letter.
33519
33520 .next
33521 If a multipart/alternative or multipart/related MIME part is a cover letter,
33522 so are all MIME subparts within that multipart.
33523
33524 .next
33525 If any other multipart is a cover letter, the first subpart is a cover letter,
33526 and the rest are attachments.
33527
33528 .next
33529 All parts contained within an attachment multipart are attachments.
33530 .endlist olist
33531
33532 As an example, the following will ban &"HTML mail"& (including that sent with
33533 alternative plain text), while allowing HTML files to be attached. HTML
33534 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33535 .code
33536 deny message = HTML mail is not accepted here
33537 !condition = $mime_is_rfc822
33538 condition = $mime_is_coverletter
33539 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33540 .endd
33541 .vitem &$mime_is_multipart$&
33542 This variable has the value 1 (true) when the current part has the main type
33543 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33544 Since multipart entities only serve as containers for other parts, you may not
33545 want to carry out specific actions on them.
33546
33547 .vitem &$mime_is_rfc822$&
33548 This variable has the value 1 (true) if the current part is not a part of the
33549 checked message itself, but part of an attached message. Attached message
33550 decoding is fully recursive.
33551
33552 .vitem &$mime_part_count$&
33553 This variable is a counter that is raised for each processed MIME part. It
33554 starts at zero for the very first part (which is usually a multipart). The
33555 counter is per-message, so it is reset when processing RFC822 attachments (see
33556 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33557 complete, so you can use it in the DATA ACL to determine the number of MIME
33558 parts of a message. For non-MIME messages, this variable contains the value -1.
33559 .endlist
33560
33561
33562
33563 .section "Scanning with regular expressions" "SECTscanregex"
33564 .cindex "content scanning" "with regular expressions"
33565 .cindex "regular expressions" "content scanning with"
33566 You can specify your own custom regular expression matches on the full body of
33567 the message, or on individual MIME parts.
33568
33569 The &%regex%& condition takes one or more regular expressions as arguments and
33570 matches them against the full message (when called in the DATA ACL) or a raw
33571 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33572 linewise, with a maximum line length of 32K characters. That means you cannot
33573 have multiline matches with the &%regex%& condition.
33574
33575 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33576 to 32K of decoded content (the whole content at once, not linewise). If the
33577 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33578 is decoded automatically when &%mime_regex%& is executed (using default path
33579 and filename values). If the decoded data is larger than  32K, only the first
33580 32K characters are checked.
33581
33582 The regular expressions are passed as a colon-separated list. To include a
33583 literal colon, you must double it. Since the whole right-hand side string is
33584 expanded before being used, you must also escape dollar signs and backslashes
33585 with more backslashes, or use the &`\N`& facility to disable expansion.
33586 Here is a simple example that contains two regular expressions:
33587 .code
33588 deny message = contains blacklisted regex ($regex_match_string)
33589      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33590 .endd
33591 The conditions returns true if any one of the regular expressions matches. The
33592 &$regex_match_string$& expansion variable is then set up and contains the
33593 matching regular expression.
33594 The expansion variables &$regex1$& &$regex2$& etc
33595 are set to any substrings captured by the regular expression.
33596
33597 &*Warning*&: With large messages, these conditions can be fairly
33598 CPU-intensive.
33599
33600 .ecindex IIDcosca
33601
33602
33603
33604
33605 . ////////////////////////////////////////////////////////////////////////////
33606 . ////////////////////////////////////////////////////////////////////////////
33607
33608 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33609          "Local scan function"
33610 .scindex IIDlosca "&[local_scan()]& function" "description of"
33611 .cindex "customizing" "input scan using C function"
33612 .cindex "policy control" "by local scan function"
33613 In these days of email worms, viruses, and ever-increasing spam, some sites
33614 want to apply a lot of checking to messages before accepting them.
33615
33616 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33617 passing messages to external virus and spam scanning software. You can also do
33618 a certain amount in Exim itself through string expansions and the &%condition%&
33619 condition in the ACL that runs after the SMTP DATA command or the ACL for
33620 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33621
33622 To allow for further customization to a site's own requirements, there is the
33623 possibility of linking Exim with a private message scanning function, written
33624 in C. If you want to run code that is written in something other than C, you
33625 can of course use a little C stub to call it.
33626
33627 The local scan function is run once for every incoming message, at the point
33628 when Exim is just about to accept the message.
33629 It can therefore be used to control non-SMTP messages from local processes as
33630 well as messages arriving via SMTP.
33631
33632 Exim applies a timeout to calls of the local scan function, and there is an
33633 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33634 Zero means &"no timeout"&.
33635 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33636 before calling the local scan function, so that the most common types of crash
33637 are caught. If the timeout is exceeded or one of those signals is caught, the
33638 incoming message is rejected with a temporary error if it is an SMTP message.
33639 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33640 code. The incident is logged on the main and reject logs.
33641
33642
33643
33644 .section "Building Exim to use a local scan function" "SECID207"
33645 .cindex "&[local_scan()]& function" "building Exim to use"
33646 To make use of the local scan function feature, you must tell Exim where your
33647 function is before building Exim, by setting
33648 both HAVE_LOCAL_SCAN and
33649 LOCAL_SCAN_SOURCE in your
33650 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33651 directory, so you might set
33652 .code
33653 HAVE_LOCAL_SCAN=yes
33654 LOCAL_SCAN_SOURCE=Local/local_scan.c
33655 .endd
33656 for example. The function must be called &[local_scan()]&. It is called by
33657 Exim after it has received a message, when the success return code is about to
33658 be sent. This is after all the ACLs have been run. The return code from your
33659 function controls whether the message is actually accepted or not. There is a
33660 commented template function (that just accepts the message) in the file
33661 _src/local_scan.c_.
33662
33663 If you want to make use of Exim's runtime configuration file to set options
33664 for your &[local_scan()]& function, you must also set
33665 .code
33666 LOCAL_SCAN_HAS_OPTIONS=yes
33667 .endd
33668 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33669
33670
33671
33672
33673 .section "API for local_scan()" "SECTapiforloc"
33674 .cindex "&[local_scan()]& function" "API description"
33675 .cindex &%dlfunc%& "API description"
33676 You must include this line near the start of your code:
33677 .code
33678 #include "local_scan.h"
33679 .endd
33680 This header file defines a number of variables and other values, and the
33681 prototype for the function itself. Exim is coded to use unsigned char values
33682 almost exclusively, and one of the things this header defines is a shorthand
33683 for &`unsigned char`& called &`uschar`&.
33684 It also contains the following macro definitions, to simplify casting character
33685 strings and pointers to character strings:
33686 .code
33687 #define CS   (char *)
33688 #define CCS  (const char *)
33689 #define CSS  (char **)
33690 #define US   (unsigned char *)
33691 #define CUS  (const unsigned char *)
33692 #define USS  (unsigned char **)
33693 .endd
33694 The function prototype for &[local_scan()]& is:
33695 .code
33696 extern int local_scan(int fd, uschar **return_text);
33697 .endd
33698 The arguments are as follows:
33699
33700 .ilist
33701 &%fd%& is a file descriptor for the file that contains the body of the message
33702 (the -D file). The file is open for reading and writing, but updating it is not
33703 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33704
33705 The descriptor is positioned at character 19 of the file, which is the first
33706 character of the body itself, because the first 19 characters are the message
33707 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33708 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33709 case this changes in some future version.
33710 .next
33711 &%return_text%& is an address which you can use to return a pointer to a text
33712 string at the end of the function. The value it points to on entry is NULL.
33713 .endlist
33714
33715 The function must return an &%int%& value which is one of the following macros:
33716
33717 .vlist
33718 .vitem &`LOCAL_SCAN_ACCEPT`&
33719 .vindex "&$local_scan_data$&"
33720 The message is accepted. If you pass back a string of text, it is saved with
33721 the message, and made available in the variable &$local_scan_data$&. No
33722 newlines are permitted (if there are any, they are turned into spaces) and the
33723 maximum length of text is 1000 characters.
33724
33725 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33726 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33727 queued without immediate delivery, and is frozen.
33728
33729 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33730 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33731 queued without immediate delivery.
33732
33733 .vitem &`LOCAL_SCAN_REJECT`&
33734 The message is rejected; the returned text is used as an error message which is
33735 passed back to the sender and which is also logged. Newlines are permitted &--
33736 they cause a multiline response for SMTP rejections, but are converted to
33737 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33738 used.
33739
33740 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33741 The message is temporarily rejected; the returned text is used as an error
33742 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33743 problem"& is used.
33744
33745 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33746 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33747 message is not written to the reject log. It has the effect of unsetting the
33748 &%rejected_header%& log selector for just this rejection. If
33749 &%rejected_header%& is already unset (see the discussion of the
33750 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33751 same as LOCAL_SCAN_REJECT.
33752
33753 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33754 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33755 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33756 .endlist
33757
33758 If the message is not being received by interactive SMTP, rejections are
33759 reported by writing to &%stderr%& or by sending an email, as configured by the
33760 &%-oe%& command line options.
33761
33762
33763
33764 .section "Configuration options for local_scan()" "SECTconoptloc"
33765 .cindex "&[local_scan()]& function" "configuration options"
33766 It is possible to have option settings in the main configuration file
33767 that set values in static variables in the &[local_scan()]& module. If you
33768 want to do this, you must have the line
33769 .code
33770 LOCAL_SCAN_HAS_OPTIONS=yes
33771 .endd
33772 in your &_Local/Makefile_& when you build Exim. (This line is in
33773 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33774 file, you must define static variables to hold the option values, and a table
33775 to define them.
33776
33777 The table must be a vector called &%local_scan_options%&, of type
33778 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33779 and a pointer to the variable that holds the value. The entries must appear in
33780 alphabetical order. Following &%local_scan_options%& you must also define a
33781 variable called &%local_scan_options_count%& that contains the number of
33782 entries in the table. Here is a short example, showing two kinds of option:
33783 .code
33784 static int my_integer_option = 42;
33785 static uschar *my_string_option = US"a default string";
33786
33787 optionlist local_scan_options[] = {
33788   { "my_integer", opt_int,       &my_integer_option },
33789   { "my_string",  opt_stringptr, &my_string_option }
33790 };
33791
33792 int local_scan_options_count =
33793   sizeof(local_scan_options)/sizeof(optionlist);
33794 .endd
33795 The values of the variables can now be changed from Exim's runtime
33796 configuration file by including a local scan section as in this example:
33797 .code
33798 begin local_scan
33799 my_integer = 99
33800 my_string = some string of text...
33801 .endd
33802 The available types of option data are as follows:
33803
33804 .vlist
33805 .vitem &*opt_bool*&
33806 This specifies a boolean (true/false) option. The address should point to a
33807 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33808 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33809 whether such a variable has been set at all, you can initialize it to
33810 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33811 values.)
33812
33813 .vitem &*opt_fixed*&
33814 This specifies a fixed point number, such as is used for load averages.
33815 The address should point to a variable of type &`int`&. The value is stored
33816 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33817
33818 .vitem &*opt_int*&
33819 This specifies an integer; the address should point to a variable of type
33820 &`int`&. The value may be specified in any of the integer formats accepted by
33821 Exim.
33822
33823 .vitem &*opt_mkint*&
33824 This is the same as &%opt_int%&, except that when such a value is output in a
33825 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33826 printed with the suffix K or M.
33827
33828 .vitem &*opt_octint*&
33829 This also specifies an integer, but the value is always interpreted as an
33830 octal integer, whether or not it starts with the digit zero, and it is
33831 always output in octal.
33832
33833 .vitem &*opt_stringptr*&
33834 This specifies a string value; the address must be a pointer to a
33835 variable that points to a string (for example, of type &`uschar *`&).
33836
33837 .vitem &*opt_time*&
33838 This specifies a time interval value. The address must point to a variable of
33839 type &`int`&. The value that is placed there is a number of seconds.
33840 .endlist
33841
33842 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33843 out the values of all the &[local_scan()]& options.
33844
33845
33846
33847 .section "Available Exim variables" "SECID208"
33848 .cindex "&[local_scan()]& function" "available Exim variables"
33849 The header &_local_scan.h_& gives you access to a number of C variables. These
33850 are the only ones that are guaranteed to be maintained from release to release.
33851 Note, however, that you can obtain the value of any Exim expansion variable,
33852 including &$recipients$&, by calling &'expand_string()'&. The exported
33853 C variables are as follows:
33854
33855 .vlist
33856 .vitem &*int&~body_linecount*&
33857 This variable contains the number of lines in the message's body.
33858 It is not valid if the &%spool_files_wireformat%& option is used.
33859
33860 .vitem &*int&~body_zerocount*&
33861 This variable contains the number of binary zero bytes in the message's body.
33862 It is not valid if the &%spool_files_wireformat%& option is used.
33863
33864 .vitem &*unsigned&~int&~debug_selector*&
33865 This variable is set to zero when no debugging is taking place. Otherwise, it
33866 is a bitmap of debugging selectors. Two bits are identified for use in
33867 &[local_scan()]&; they are defined as macros:
33868
33869 .ilist
33870 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33871 testing option that is not privileged &-- any caller may set it. All the
33872 other selector bits can be set only by admin users.
33873
33874 .next
33875 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33876 by the &`+local_scan`& debug selector. It is not included in the default set
33877 of debugging bits.
33878 .endlist ilist
33879
33880 Thus, to write to the debugging output only when &`+local_scan`& has been
33881 selected, you should use code like this:
33882 .code
33883 if ((debug_selector & D_local_scan) != 0)
33884   debug_printf("xxx", ...);
33885 .endd
33886 .vitem &*uschar&~*expand_string_message*&
33887 After a failing call to &'expand_string()'& (returned value NULL), the
33888 variable &%expand_string_message%& contains the error message, zero-terminated.
33889
33890 .vitem &*header_line&~*header_list*&
33891 A pointer to a chain of header lines. The &%header_line%& structure is
33892 discussed below.
33893
33894 .vitem &*header_line&~*header_last*&
33895 A pointer to the last of the header lines.
33896
33897 .vitem &*uschar&~*headers_charset*&
33898 The value of the &%headers_charset%& configuration option.
33899
33900 .vitem &*BOOL&~host_checking*&
33901 This variable is TRUE during a host checking session that is initiated by the
33902 &%-bh%& command line option.
33903
33904 .vitem &*uschar&~*interface_address*&
33905 The IP address of the interface that received the message, as a string. This
33906 is NULL for locally submitted messages.
33907
33908 .vitem &*int&~interface_port*&
33909 The port on which this message was received. When testing with the &%-bh%&
33910 command line option, the value of this variable is -1 unless a port has been
33911 specified via the &%-oMi%& option.
33912
33913 .vitem &*uschar&~*message_id*&
33914 This variable contains Exim's message id for the incoming message (the value of
33915 &$message_exim_id$&) as a zero-terminated string.
33916
33917 .vitem &*uschar&~*received_protocol*&
33918 The name of the protocol by which the message was received.
33919
33920 .vitem &*int&~recipients_count*&
33921 The number of accepted recipients.
33922
33923 .vitem &*recipient_item&~*recipients_list*&
33924 .cindex "recipient" "adding in local scan"
33925 .cindex "recipient" "removing in local scan"
33926 The list of accepted recipients, held in a vector of length
33927 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33928 can add additional recipients by calling &'receive_add_recipient()'& (see
33929 below). You can delete recipients by removing them from the vector and
33930 adjusting the value in &%recipients_count%&. In particular, by setting
33931 &%recipients_count%& to zero you remove all recipients. If you then return the
33932 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33933 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33934 and then call &'receive_add_recipient()'& as often as needed.
33935
33936 .vitem &*uschar&~*sender_address*&
33937 The envelope sender address. For bounce messages this is the empty string.
33938
33939 .vitem &*uschar&~*sender_host_address*&
33940 The IP address of the sending host, as a string. This is NULL for
33941 locally-submitted messages.
33942
33943 .vitem &*uschar&~*sender_host_authenticated*&
33944 The name of the authentication mechanism that was used, or NULL if the message
33945 was not received over an authenticated SMTP connection.
33946
33947 .vitem &*uschar&~*sender_host_name*&
33948 The name of the sending host, if known.
33949
33950 .vitem &*int&~sender_host_port*&
33951 The port on the sending host.
33952
33953 .vitem &*BOOL&~smtp_input*&
33954 This variable is TRUE for all SMTP input, including BSMTP.
33955
33956 .vitem &*BOOL&~smtp_batched_input*&
33957 This variable is TRUE for BSMTP input.
33958
33959 .vitem &*int&~store_pool*&
33960 The contents of this variable control which pool of memory is used for new
33961 requests. See section &<<SECTmemhanloc>>& for details.
33962 .endlist
33963
33964
33965 .section "Structure of header lines" "SECID209"
33966 The &%header_line%& structure contains the members listed below.
33967 You can add additional header lines by calling the &'header_add()'& function
33968 (see below). You can cause header lines to be ignored (deleted) by setting
33969 their type to *.
33970
33971
33972 .vlist
33973 .vitem &*struct&~header_line&~*next*&
33974 A pointer to the next header line, or NULL for the last line.
33975
33976 .vitem &*int&~type*&
33977 A code identifying certain headers that Exim recognizes. The codes are printing
33978 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33979 Notice in particular that any header line whose type is * is not transmitted
33980 with the message. This flagging is used for header lines that have been
33981 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33982 lines.) Effectively, * means &"deleted"&.
33983
33984 .vitem &*int&~slen*&
33985 The number of characters in the header line, including the terminating and any
33986 internal newlines.
33987
33988 .vitem &*uschar&~*text*&
33989 A pointer to the text of the header. It always ends with a newline, followed by
33990 a zero byte. Internal newlines are preserved.
33991 .endlist
33992
33993
33994
33995 .section "Structure of recipient items" "SECID210"
33996 The &%recipient_item%& structure contains these members:
33997
33998 .vlist
33999 .vitem &*uschar&~*address*&
34000 This is a pointer to the recipient address as it was received.
34001
34002 .vitem &*int&~pno*&
34003 This is used in later Exim processing when top level addresses are created by
34004 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34005 and must always contain -1 at this stage.
34006
34007 .vitem &*uschar&~*errors_to*&
34008 If this value is not NULL, bounce messages caused by failing to deliver to the
34009 recipient are sent to the address it contains. In other words, it overrides the
34010 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34011 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34012 an unqualified address, Exim qualifies it using the domain from
34013 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34014 is NULL for all recipients.
34015 .endlist
34016
34017
34018
34019 .section "Available Exim functions" "SECID211"
34020 .cindex "&[local_scan()]& function" "available Exim functions"
34021 The header &_local_scan.h_& gives you access to a number of Exim functions.
34022 These are the only ones that are guaranteed to be maintained from release to
34023 release:
34024
34025 .vlist
34026 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34027        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34028
34029 This function creates a child process that runs the command specified by
34030 &%argv%&. The environment for the process is specified by &%envp%&, which can
34031 be NULL if no environment variables are to be passed. A new umask is supplied
34032 for the process in &%newumask%&.
34033
34034 Pipes to the standard input and output of the new process are set up
34035 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34036 standard error is cloned to the standard output. If there are any file
34037 descriptors &"in the way"& in the new process, they are closed. If the final
34038 argument is TRUE, the new process is made into a process group leader.
34039
34040 The function returns the pid of the new process, or -1 if things go wrong.
34041
34042 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34043 This function waits for a child process to terminate, or for a timeout (in
34044 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34045 return value is as follows:
34046
34047 .ilist
34048 >= 0
34049
34050 The process terminated by a normal exit and the value is the process
34051 ending status.
34052
34053 .next
34054 < 0 and > &--256
34055
34056 The process was terminated by a signal and the value is the negation of the
34057 signal number.
34058
34059 .next
34060 &--256
34061
34062 The process timed out.
34063 .next
34064 &--257
34065
34066 The was some other error in wait(); &%errno%& is still set.
34067 .endlist
34068
34069 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34070 This function provide you with a means of submitting a new message to
34071 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34072 want, but this packages it all up for you.) The function creates a pipe,
34073 forks a subprocess that is running
34074 .code
34075 exim -t -oem -oi -f <>
34076 .endd
34077 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34078 that is connected to the standard input. The yield of the function is the PID
34079 of the subprocess. You can then write a message to the file descriptor, with
34080 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34081
34082 When you have finished, call &'child_close()'& to wait for the process to
34083 finish and to collect its ending status. A timeout value of zero is usually
34084 fine in this circumstance. Unless you have made a mistake with the recipient
34085 addresses, you should get a return code of zero.
34086
34087
34088 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34089        *sender_authentication)*&
34090 This function is a more sophisticated version of &'child_open()'&. The command
34091 that it runs is:
34092 .display
34093 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34094 .endd
34095 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34096
34097
34098 .vitem &*void&~debug_printf(char&~*,&~...)*&
34099 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34100 output is written to the standard error stream. If no debugging is selected,
34101 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34102 conditional on the &`local_scan`& debug selector by coding like this:
34103 .code
34104 if ((debug_selector & D_local_scan) != 0)
34105   debug_printf("xxx", ...);
34106 .endd
34107
34108 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34109 This is an interface to Exim's string expansion code. The return value is the
34110 expanded string, or NULL if there was an expansion failure.
34111 The C variable &%expand_string_message%& contains an error message after an
34112 expansion failure. If expansion does not change the string, the return value is
34113 the pointer to the input string. Otherwise, the return value points to a new
34114 block of memory that was obtained by a call to &'store_get()'&. See section
34115 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34116
34117 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34118 This function allows you to an add additional header line at the end of the
34119 existing ones. The first argument is the type, and should normally be a space
34120 character. The second argument is a format string and any number of
34121 substitution arguments as for &[sprintf()]&. You may include internal newlines
34122 if you want, and you must ensure that the string ends with a newline.
34123
34124 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34125         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34126 This function adds a new header line at a specified point in the header
34127 chain. The header itself is specified as for &'header_add()'&.
34128
34129 If &%name%& is NULL, the new header is added at the end of the chain if
34130 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34131 NULL, the header lines are searched for the first non-deleted header that
34132 matches the name. If one is found, the new header is added before it if
34133 &%after%& is false. If &%after%& is true, the new header is added after the
34134 found header and any adjacent subsequent ones with the same name (even if
34135 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34136 option controls where the header is added. If it is true, addition is at the
34137 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34138 headers, or at the top if there are no &'Received:'& headers, you could use
34139 .code
34140 header_add_at_position(TRUE, US"Received", TRUE,
34141   ' ', "X-xxx: ...");
34142 .endd
34143 Normally, there is always at least one non-deleted &'Received:'& header, but
34144 there may not be if &%received_header_text%& expands to an empty string.
34145
34146
34147 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34148 This function removes header lines. If &%occurrence%& is zero or negative, all
34149 occurrences of the header are removed. If occurrence is greater than zero, that
34150 particular instance of the header is removed. If no header(s) can be found that
34151 match the specification, the function does nothing.
34152
34153
34154 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34155         int&~length,&~BOOL&~notdel)*&"
34156 This function tests whether the given header has the given name. It is not just
34157 a string comparison, because white space is permitted between the name and the
34158 colon. If the &%notdel%& argument is true, a false return is forced for all
34159 &"deleted"& headers; otherwise they are not treated specially. For example:
34160 .code
34161 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34162 .endd
34163 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34164 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34165 This function base64-encodes a string, which is passed by address and length.
34166 The text may contain bytes of any value, including zero. The result is passed
34167 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34168 zero-terminated.
34169
34170 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34171 This function decodes a base64-encoded string. Its arguments are a
34172 zero-terminated base64-encoded string and the address of a variable that is set
34173 to point to the result, which is in dynamic memory. The length of the decoded
34174 string is the yield of the function. If the input is invalid base64 data, the
34175 yield is -1. A zero byte is added to the end of the output string to make it
34176 easy to interpret as a C string (assuming it contains no zeros of its own). The
34177 added zero byte is not included in the returned count.
34178
34179 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34180 This function checks for a match in a domain list. Domains are always
34181 matched caselessly. The return value is one of the following:
34182 .display
34183 &`OK     `& match succeeded
34184 &`FAIL   `& match failed
34185 &`DEFER  `& match deferred
34186 .endd
34187 DEFER is usually caused by some kind of lookup defer, such as the
34188 inability to contact a database.
34189
34190 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34191         BOOL&~caseless)*&"
34192 This function checks for a match in a local part list. The third argument
34193 controls case-sensitivity. The return values are as for
34194 &'lss_match_domain()'&.
34195
34196 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34197         BOOL&~caseless)*&"
34198 This function checks for a match in an address list. The third argument
34199 controls the case-sensitivity of the local part match. The domain is always
34200 matched caselessly. The return values are as for &'lss_match_domain()'&.
34201
34202 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34203         uschar&~*list)*&"
34204 This function checks for a match in a host list. The most common usage is
34205 expected to be
34206 .code
34207 lss_match_host(sender_host_name, sender_host_address, ...)
34208 .endd
34209 .vindex "&$sender_host_address$&"
34210 An empty address field matches an empty item in the host list. If the host name
34211 is NULL, the name corresponding to &$sender_host_address$& is automatically
34212 looked up if a host name is required to match an item in the list. The return
34213 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34214 returns ERROR in the case when it had to look up a host name, but the lookup
34215 failed.
34216
34217 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34218         *format,&~...)*&"
34219 This function writes to Exim's log files. The first argument should be zero (it
34220 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34221 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34222 them. It specifies to which log or logs the message is written. The remaining
34223 arguments are a format and relevant insertion arguments. The string should not
34224 contain any newlines, not even at the end.
34225
34226
34227 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34228 This function adds an additional recipient to the message. The first argument
34229 is the recipient address. If it is unqualified (has no domain), it is qualified
34230 with the &%qualify_recipient%& domain. The second argument must always be -1.
34231
34232 This function does not allow you to specify a private &%errors_to%& address (as
34233 described with the structure of &%recipient_item%& above), because it pre-dates
34234 the addition of that field to the structure. However, it is easy to add such a
34235 value afterwards. For example:
34236 .code
34237  receive_add_recipient(US"monitor@mydom.example", -1);
34238  recipients_list[recipients_count-1].errors_to =
34239    US"postmaster@mydom.example";
34240 .endd
34241
34242 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34243 This is a convenience function to remove a named recipient from the list of
34244 recipients. It returns true if a recipient was removed, and false if no
34245 matching recipient could be found. The argument must be a complete email
34246 address.
34247 .endlist
34248
34249
34250 .cindex "RFC 2047"
34251 .vlist
34252 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34253   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34254 This function decodes strings that are encoded according to RFC 2047. Typically
34255 these are the contents of header lines. First, each &"encoded word"& is decoded
34256 from the Q or B encoding into a byte-string. Then, if provided with the name of
34257 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34258 made  to translate the result to the named character set. If this fails, the
34259 binary string is returned with an error message.
34260
34261 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34262 maximum MIME word length is enforced. The third argument is the target
34263 encoding, or NULL if no translation is wanted.
34264
34265 .cindex "binary zero" "in RFC 2047 decoding"
34266 .cindex "RFC 2047" "binary zero in"
34267 If a binary zero is encountered in the decoded string, it is replaced by the
34268 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34269 not be 0 because header lines are handled as zero-terminated strings.
34270
34271 The function returns the result of processing the string, zero-terminated; if
34272 &%lenptr%& is not NULL, the length of the result is set in the variable to
34273 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34274
34275 If an error is encountered, the function returns NULL and uses the &%error%&
34276 argument to return an error message. The variable pointed to by &%error%& is
34277 set to NULL if there is no error; it may be set non-NULL even when the function
34278 returns a non-NULL value if decoding was successful, but there was a problem
34279 with translation.
34280
34281
34282 .vitem &*int&~smtp_fflush(void)*&
34283 This function is used in conjunction with &'smtp_printf()'&, as described
34284 below.
34285
34286 .vitem &*void&~smtp_printf(char&~*,&~...)*&
34287 The arguments of this function are like &[printf()]&; it writes to the SMTP
34288 output stream. You should use this function only when there is an SMTP output
34289 stream, that is, when the incoming message is being received via interactive
34290 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34291 is FALSE. If you want to test for an incoming message from another host (as
34292 opposed to a local process that used the &%-bs%& command line option), you can
34293 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34294 is involved.
34295
34296 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34297 output function, so it can be used for all forms of SMTP connection.
34298
34299 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34300 must start with an appropriate response code: 550 if you are going to return
34301 LOCAL_SCAN_REJECT, 451 if you are going to return
34302 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34303 initial lines of a multi-line response, the code must be followed by a hyphen
34304 to indicate that the line is not the final response line. You must also ensure
34305 that the lines you write terminate with CRLF. For example:
34306 .code
34307 smtp_printf("550-this is some extra info\r\n");
34308 return LOCAL_SCAN_REJECT;
34309 .endd
34310 Note that you can also create multi-line responses by including newlines in
34311 the data returned via the &%return_text%& argument. The added value of using
34312 &'smtp_printf()'& is that, for instance, you could introduce delays between
34313 multiple output lines.
34314
34315 The &'smtp_printf()'& function does not return any error indication, because it
34316 does not automatically flush pending output, and therefore does not test
34317 the state of the stream. (In the main code of Exim, flushing and error
34318 detection is done when Exim is ready for the next SMTP input command.) If
34319 you want to flush the output and check for an error (for example, the
34320 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34321 arguments. It flushes the output stream, and returns a non-zero value if there
34322 is an error.
34323
34324 .vitem &*void&~*store_get(int)*&
34325 This function accesses Exim's internal store (memory) manager. It gets a new
34326 chunk of memory whose size is given by the argument. Exim bombs out if it ever
34327 runs out of memory. See the next section for a discussion of memory handling.
34328
34329 .vitem &*void&~*store_get_perm(int)*&
34330 This function is like &'store_get()'&, but it always gets memory from the
34331 permanent pool. See the next section for a discussion of memory handling.
34332
34333 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34334 See below.
34335
34336 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34337 See below.
34338
34339 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34340 These three functions create strings using Exim's dynamic memory facilities.
34341 The first makes a copy of an entire string. The second copies up to a maximum
34342 number of characters, indicated by the second argument. The third uses a format
34343 and insertion arguments to create a new string. In each case, the result is a
34344 pointer to a new string in the current memory pool. See the next section for
34345 more discussion.
34346 .endlist
34347
34348
34349
34350 .section "More about Exim's memory handling" "SECTmemhanloc"
34351 .cindex "&[local_scan()]& function" "memory handling"
34352 No function is provided for freeing memory, because that is never needed.
34353 The dynamic memory that Exim uses when receiving a message is automatically
34354 recycled if another message is received by the same process (this applies only
34355 to incoming SMTP connections &-- other input methods can supply only one
34356 message at a time). After receiving the last message, a reception process
34357 terminates.
34358
34359 Because it is recycled, the normal dynamic memory cannot be used for holding
34360 data that must be preserved over a number of incoming messages on the same SMTP
34361 connection. However, Exim in fact uses two pools of dynamic memory; the second
34362 one is not recycled, and can be used for this purpose.
34363
34364 If you want to allocate memory that remains available for subsequent messages
34365 in the same SMTP connection, you should set
34366 .code
34367 store_pool = POOL_PERM
34368 .endd
34369 before calling the function that does the allocation. There is no need to
34370 restore the value if you do not need to; however, if you do want to revert to
34371 the normal pool, you can either restore the previous value of &%store_pool%& or
34372 set it explicitly to POOL_MAIN.
34373
34374 The pool setting applies to all functions that get dynamic memory, including
34375 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34376 There is also a convenience function called &'store_get_perm()'& that gets a
34377 block of memory from the permanent pool while preserving the value of
34378 &%store_pool%&.
34379 .ecindex IIDlosca
34380
34381
34382
34383
34384 . ////////////////////////////////////////////////////////////////////////////
34385 . ////////////////////////////////////////////////////////////////////////////
34386
34387 .chapter "System-wide message filtering" "CHAPsystemfilter"
34388 .scindex IIDsysfil1 "filter" "system filter"
34389 .scindex IIDsysfil2 "filtering all mail"
34390 .scindex IIDsysfil3 "system filter"
34391 The previous chapters (on ACLs and the local scan function) describe checks
34392 that can be applied to messages before they are accepted by a host. There is
34393 also a mechanism for checking messages once they have been received, but before
34394 they are delivered. This is called the &'system filter'&.
34395
34396 The system filter operates in a similar manner to users' filter files, but it
34397 is run just once per message (however many recipients the message has).
34398 It should not normally be used as a substitute for routing, because &%deliver%&
34399 commands in a system router provide new envelope recipient addresses.
34400 The system filter must be an Exim filter. It cannot be a Sieve filter.
34401
34402 The system filter is run at the start of a delivery attempt, before any routing
34403 is done. If a message fails to be completely delivered at the first attempt,
34404 the system filter is run again at the start of every retry.
34405 If you want your filter to do something only once per message, you can make use
34406 of the &%first_delivery%& condition in an &%if%& command in the filter to
34407 prevent it happening on retries.
34408
34409 .vindex "&$domain$&"
34410 .vindex "&$local_part$&"
34411 &*Warning*&: Because the system filter runs just once, variables that are
34412 specific to individual recipient addresses, such as &$local_part$& and
34413 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34414 you want to run a centrally-specified filter for each recipient address
34415 independently, you can do so by setting up a suitable &(redirect)& router, as
34416 described in section &<<SECTperaddfil>>& below.
34417
34418
34419 .section "Specifying a system filter" "SECID212"
34420 .cindex "uid (user id)" "system filter"
34421 .cindex "gid (group id)" "system filter"
34422 The name of the file that contains the system filter must be specified by
34423 setting &%system_filter%&. If you want the filter to run under a uid and gid
34424 other than root, you must also set &%system_filter_user%& and
34425 &%system_filter_group%& as appropriate. For example:
34426 .code
34427 system_filter = /etc/mail/exim.filter
34428 system_filter_user = exim
34429 .endd
34430 If a system filter generates any deliveries directly to files or pipes (via the
34431 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34432 specified by setting &%system_filter_file_transport%& and
34433 &%system_filter_pipe_transport%&, respectively. Similarly,
34434 &%system_filter_reply_transport%& must be set to handle any messages generated
34435 by the &%reply%& command.
34436
34437
34438 .section "Testing a system filter" "SECID213"
34439 You can run simple tests of a system filter in the same way as for a user
34440 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34441 are permitted only in system filters are recognized.
34442
34443 If you want to test the combined effect of a system filter and a user filter,
34444 you can use both &%-bF%& and &%-bf%& on the same command line.
34445
34446
34447
34448 .section "Contents of a system filter" "SECID214"
34449 The language used to specify system filters is the same as for users' filter
34450 files. It is described in the separate end-user document &'Exim's interface to
34451 mail filtering'&. However, there are some additional features that are
34452 available only in system filters; these are described in subsequent sections.
34453 If they are encountered in a user's filter file or when testing with &%-bf%&,
34454 they cause errors.
34455
34456 .cindex "frozen messages" "manual thaw; testing in filter"
34457 There are two special conditions which, though available in users' filter
34458 files, are designed for use in system filters. The condition &%first_delivery%&
34459 is true only for the first attempt at delivering a message, and
34460 &%manually_thawed%& is true only if the message has been frozen, and
34461 subsequently thawed by an admin user. An explicit forced delivery counts as a
34462 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34463
34464 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34465 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34466 succeed, it will not be tried again.
34467 If you want Exim to retry an unseen delivery until it succeeds, you should
34468 arrange to set it up every time the filter runs.
34469
34470 When a system filter finishes running, the values of the variables &$n0$& &--
34471 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34472 users' filter files. Thus a system filter can, for example, set up &"scores"&
34473 to which users' filter files can refer.
34474
34475
34476
34477 .section "Additional variable for system filters" "SECID215"
34478 .vindex "&$recipients$&"
34479 The expansion variable &$recipients$&, containing a list of all the recipients
34480 of the message (separated by commas and white space), is available in system
34481 filters. It is not available in users' filters for privacy reasons.
34482
34483
34484
34485 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34486 .cindex "freezing messages"
34487 .cindex "message" "freezing"
34488 .cindex "message" "forced failure"
34489 .cindex "&%fail%&" "in system filter"
34490 .cindex "&%freeze%& in system filter"
34491 .cindex "&%defer%& in system filter"
34492 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34493 always available in system filters, but are not normally enabled in users'
34494 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34495 for the &(redirect)& router.) These commands can optionally be followed by the
34496 word &%text%& and a string containing an error message, for example:
34497 .code
34498 fail text "this message looks like spam to me"
34499 .endd
34500 The keyword &%text%& is optional if the next character is a double quote.
34501
34502 The &%defer%& command defers delivery of the original recipients of the
34503 message. The &%fail%& command causes all the original recipients to be failed,
34504 and a bounce message to be created. The &%freeze%& command suspends all
34505 delivery attempts for the original recipients. In all cases, any new deliveries
34506 that are specified by the filter are attempted as normal after the filter has
34507 run.
34508
34509 The &%freeze%& command is ignored if the message has been manually unfrozen and
34510 not manually frozen since. This means that automatic freezing by a system
34511 filter can be used as a way of checking out suspicious messages. If a message
34512 is found to be all right, manually unfreezing it allows it to be delivered.
34513
34514 .cindex "log" "&%fail%& command log line"
34515 .cindex "&%fail%&" "log line; reducing"
34516 The text given with a fail command is used as part of the bounce message as
34517 well as being written to the log. If the message is quite long, this can fill
34518 up a lot of log space when such failures are common. To reduce the size of the
34519 log message, Exim interprets the text in a special way if it starts with the
34520 two characters &`<<`& and contains &`>>`& later. The text between these two
34521 strings is written to the log, and the rest of the text is used in the bounce
34522 message. For example:
34523 .code
34524 fail "<<filter test 1>>Your message is rejected \
34525      because it contains attachments that we are \
34526      not prepared to receive."
34527 .endd
34528
34529 .cindex "loop" "caused by &%fail%&"
34530 Take great care with the &%fail%& command when basing the decision to fail on
34531 the contents of the message, because the bounce message will of course include
34532 the contents of the original message and will therefore trigger the &%fail%&
34533 command again (causing a mail loop) unless steps are taken to prevent this.
34534 Testing the &%error_message%& condition is one way to prevent this. You could
34535 use, for example
34536 .code
34537 if $message_body contains "this is spam" and not error_message
34538 then fail text "spam is not wanted here" endif
34539 .endd
34540 though of course that might let through unwanted bounce messages. The
34541 alternative is clever checking of the body and/or headers to detect bounces
34542 generated by the filter.
34543
34544 The interpretation of a system filter file ceases after a
34545 &%defer%&,
34546 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34547 set up earlier in the filter file are honoured, so you can use a sequence such
34548 as
34549 .code
34550 mail ...
34551 freeze
34552 .endd
34553 to send a specified message when the system filter is freezing (or deferring or
34554 failing) a message. The normal deliveries for the message do not, of course,
34555 take place.
34556
34557
34558
34559 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34560 .cindex "header lines" "adding; in system filter"
34561 .cindex "header lines" "removing; in system filter"
34562 .cindex "filter" "header lines; adding/removing"
34563 Two filter commands that are available only in system filters are:
34564 .code
34565 headers add <string>
34566 headers remove <string>
34567 .endd
34568 The argument for the &%headers add%& is a string that is expanded and then
34569 added to the end of the message's headers. It is the responsibility of the
34570 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34571 space is ignored, and if the string is otherwise empty, or if the expansion is
34572 forced to fail, the command has no effect.
34573
34574 You can use &"\n"& within the string, followed by white space, to specify
34575 continued header lines. More than one header may be added in one command by
34576 including &"\n"& within the string without any following white space. For
34577 example:
34578 .code
34579 headers add "X-header-1: ....\n  \
34580              continuation of X-header-1 ...\n\
34581              X-header-2: ...."
34582 .endd
34583 Note that the header line continuation white space after the first newline must
34584 be placed before the backslash that continues the input string, because white
34585 space after input continuations is ignored.
34586
34587 The argument for &%headers remove%& is a colon-separated list of header names.
34588 This command applies only to those headers that are stored with the message;
34589 those that are added at delivery time (such as &'Envelope-To:'& and
34590 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34591 header with the same name, they are all removed.
34592
34593 The &%headers%& command in a system filter makes an immediate change to the set
34594 of header lines that was received with the message (with possible additions
34595 from ACL processing). Subsequent commands in the system filter operate on the
34596 modified set, which also forms the basis for subsequent message delivery.
34597 Unless further modified during routing or transporting, this set of headers is
34598 used for all recipients of the message.
34599
34600 During routing and transporting, the variables that refer to the contents of
34601 header lines refer only to those lines that are in this set. Thus, header lines
34602 that are added by a system filter are visible to users' filter files and to all
34603 routers and transports. This contrasts with the manipulation of header lines by
34604 routers and transports, which is not immediate, but which instead is saved up
34605 until the message is actually being written (see section
34606 &<<SECTheadersaddrem>>&).
34607
34608 If the message is not delivered at the first attempt, header lines that were
34609 added by the system filter are stored with the message, and so are still
34610 present at the next delivery attempt. Header lines that were removed are still
34611 present, but marked &"deleted"& so that they are not transported with the
34612 message. For this reason, it is usual to make the &%headers%& command
34613 conditional on &%first_delivery%& so that the set of header lines is not
34614 modified more than once.
34615
34616 Because header modification in a system filter acts immediately, you have to
34617 use an indirect approach if you want to modify the contents of a header line.
34618 For example:
34619 .code
34620 headers add "Old-Subject: $h_subject:"
34621 headers remove "Subject"
34622 headers add "Subject: new subject (was: $h_old-subject:)"
34623 headers remove "Old-Subject"
34624 .endd
34625
34626
34627
34628 .section "Setting an errors address in a system filter" "SECID217"
34629 .cindex "envelope from"
34630 .cindex "envelope sender"
34631 In a system filter, if a &%deliver%& command is followed by
34632 .code
34633 errors_to <some address>
34634 .endd
34635 in order to change the envelope sender (and hence the error reporting) for that
34636 delivery, any address may be specified. (In a user filter, only the current
34637 user's address can be set.) For example, if some mail is being monitored, you
34638 might use
34639 .code
34640 unseen deliver monitor@spying.example errors_to root@local.example
34641 .endd
34642 to take a copy which would not be sent back to the normal error reporting
34643 address if its delivery failed.
34644
34645
34646
34647 .section "Per-address filtering" "SECTperaddfil"
34648 .vindex "&$domain$&"
34649 .vindex "&$local_part$&"
34650 In contrast to the system filter, which is run just once per message for each
34651 delivery attempt, it is also possible to set up a system-wide filtering
34652 operation that runs once for each recipient address. In this case, variables
34653 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34654 filter file could be made dependent on them. This is an example of a router
34655 which implements such a filter:
34656 .code
34657 central_filter:
34658   check_local_user
34659   driver = redirect
34660   domains = +local_domains
34661   file = /central/filters/$local_part
34662   no_verify
34663   allow_filter
34664   allow_freeze
34665 .endd
34666 The filter is run in a separate process under its own uid. Therefore, either
34667 &%check_local_user%& must be set (as above), in which case the filter is run as
34668 the local user, or the &%user%& option must be used to specify which user to
34669 use. If both are set, &%user%& overrides.
34670
34671 Care should be taken to ensure that none of the commands in the filter file
34672 specify a significant delivery if the message is to go on to be delivered to
34673 its intended recipient. The router will not then claim to have dealt with the
34674 address, so it will be passed on to subsequent routers to be delivered in the
34675 normal way.
34676 .ecindex IIDsysfil1
34677 .ecindex IIDsysfil2
34678 .ecindex IIDsysfil3
34679
34680
34681
34682
34683
34684
34685 . ////////////////////////////////////////////////////////////////////////////
34686 . ////////////////////////////////////////////////////////////////////////////
34687
34688 .chapter "Message processing" "CHAPmsgproc"
34689 .scindex IIDmesproc "message" "general processing"
34690 Exim performs various transformations on the sender and recipient addresses of
34691 all messages that it handles, and also on the messages' header lines. Some of
34692 these are optional and configurable, while others always take place. All of
34693 this processing, except rewriting as a result of routing, and the addition or
34694 removal of header lines while delivering, happens when a message is received,
34695 before it is placed on Exim's queue.
34696
34697 Some of the automatic processing takes place by default only for
34698 &"locally-originated"& messages. This adjective is used to describe messages
34699 that are not received over TCP/IP, but instead are passed to an Exim process on
34700 its standard input. This includes the interactive &"local SMTP"& case that is
34701 set up by the &%-bs%& command line option.
34702
34703 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34704 or ::1) are not considered to be locally-originated. Exim does not treat the
34705 loopback interface specially in any way.
34706
34707 If you want the loopback interface to be treated specially, you must ensure
34708 that there are appropriate entries in your ACLs.
34709
34710
34711
34712
34713 .section "Submission mode for non-local messages" "SECTsubmodnon"
34714 .cindex "message" "submission"
34715 .cindex "submission mode"
34716 Processing that happens automatically for locally-originated messages (unless
34717 &%suppress_local_fixups%& is set) can also be requested for messages that are
34718 received over TCP/IP. The term &"submission mode"& is used to describe this
34719 state. Submission mode is set by the modifier
34720 .code
34721 control = submission
34722 .endd
34723 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34724 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34725 a local submission, and is normally used when the source of the message is
34726 known to be an MUA running on a client host (as opposed to an MTA). For
34727 example, to set submission mode for messages originating on the IPv4 loopback
34728 interface, you could include the following in the MAIL ACL:
34729 .code
34730 warn  hosts = 127.0.0.1
34731       control = submission
34732 .endd
34733 .cindex "&%sender_retain%& submission option"
34734 There are some options that can be used when setting submission mode. A slash
34735 is used to separate options. For example:
34736 .code
34737 control = submission/sender_retain
34738 .endd
34739 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34740 true and &%local_from_check%& false for the current incoming message. The first
34741 of these allows an existing &'Sender:'& header in the message to remain, and
34742 the second suppresses the check to ensure that &'From:'& matches the
34743 authenticated sender. With this setting, Exim still fixes up messages by adding
34744 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34745 attempt to check sender authenticity in header lines.
34746
34747 When &%sender_retain%& is not set, a submission mode setting may specify a
34748 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34749 example:
34750 .code
34751 control = submission/domain=some.domain
34752 .endd
34753 The domain may be empty. How this value is used is described in sections
34754 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34755 that allows you to specify the user's full name for inclusion in a created
34756 &'Sender:'& or &'From:'& header line. For example:
34757 .code
34758 accept authenticated = *
34759        control = submission/domain=wonderland.example/\
34760                             name=${lookup {$authenticated_id} \
34761                                    lsearch {/etc/exim/namelist}}
34762 .endd
34763 Because the name may contain any characters, including slashes, the &%name%&
34764 option must be given last. The remainder of the string is used as the name. For
34765 the example above, if &_/etc/exim/namelist_& contains:
34766 .code
34767 bigegg:  Humpty Dumpty
34768 .endd
34769 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34770 line would be:
34771 .code
34772 Sender: Humpty Dumpty <bigegg@wonderland.example>
34773 .endd
34774 .cindex "return path" "in submission mode"
34775 By default, submission mode forces the return path to the same address as is
34776 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34777 specified, the return path is also left unchanged.
34778
34779 &*Note*&: The changes caused by submission mode take effect after the predata
34780 ACL. This means that any sender checks performed before the fix-ups use the
34781 untrusted sender address specified by the user, not the trusted sender address
34782 specified by submission mode. Although this might be slightly unexpected, it
34783 does mean that you can configure ACL checks to spot that a user is trying to
34784 spoof another's address.
34785
34786 .section "Line endings" "SECTlineendings"
34787 .cindex "line endings"
34788 .cindex "carriage return"
34789 .cindex "linefeed"
34790 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34791 linefeed) is the line ending for messages transmitted over the Internet using
34792 SMTP over TCP/IP. However, within individual operating systems, different
34793 conventions are used. For example, Unix-like systems use just LF, but others
34794 use CRLF or just CR.
34795
34796 Exim was designed for Unix-like systems, and internally, it stores messages
34797 using the system's convention of a single LF as a line terminator. When
34798 receiving a message, all line endings are translated to this standard format.
34799 Originally, it was thought that programs that passed messages directly to an
34800 MTA within an operating system would use that system's convention. Experience
34801 has shown that this is not the case; for example, there are Unix applications
34802 that use CRLF in this circumstance. For this reason, and for compatibility with
34803 other MTAs, the way Exim handles line endings for all messages is now as
34804 follows:
34805
34806 .ilist
34807 LF not preceded by CR is treated as a line ending.
34808 .next
34809 CR is treated as a line ending; if it is immediately followed by LF, the LF
34810 is ignored.
34811 .next
34812 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34813 nor a local message in the state where a line containing only a dot is a
34814 terminator.
34815 .next
34816 If a bare CR is encountered within a header line, an extra space is added after
34817 the line terminator so as not to end the header line. The reasoning behind this
34818 is that bare CRs in header lines are most likely either to be mistakes, or
34819 people trying to play silly games.
34820 .next
34821 If the first header line received in a message ends with CRLF, a subsequent
34822 bare LF in a header line is treated in the same way as a bare CR in a header
34823 line.
34824 .endlist
34825
34826
34827
34828
34829
34830 .section "Unqualified addresses" "SECID218"
34831 .cindex "unqualified addresses"
34832 .cindex "address" "qualification"
34833 By default, Exim expects every envelope address it receives from an external
34834 host to be fully qualified. Unqualified addresses cause negative responses to
34835 SMTP commands. However, because SMTP is used as a means of transporting
34836 messages from MUAs running on personal workstations, there is sometimes a
34837 requirement to accept unqualified addresses from specific hosts or IP networks.
34838
34839 Exim has two options that separately control which hosts may send unqualified
34840 sender or recipient addresses in SMTP commands, namely
34841 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34842 cases, if an unqualified address is accepted, it is qualified by adding the
34843 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34844
34845 .oindex "&%qualify_domain%&"
34846 .oindex "&%qualify_recipient%&"
34847 Unqualified addresses in header lines are automatically qualified for messages
34848 that are locally originated, unless the &%-bnq%& option is given on the command
34849 line. For messages received over SMTP, unqualified addresses in header lines
34850 are qualified only if unqualified addresses are permitted in SMTP commands. In
34851 other words, such qualification is also controlled by
34852 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34853
34854
34855
34856
34857 .section "The UUCP From line" "SECID219"
34858 .cindex "&""From""& line"
34859 .cindex "UUCP" "&""From""& line"
34860 .cindex "sender" "address"
34861 .oindex "&%uucp_from_pattern%&"
34862 .oindex "&%uucp_from_sender%&"
34863 .cindex "envelope from"
34864 .cindex "envelope sender"
34865 .cindex "Sendmail compatibility" "&""From""& line"
34866 Messages that have come from UUCP (and some other applications) often begin
34867 with a line containing the envelope sender and a timestamp, following the word
34868 &"From"&. Examples of two common formats are:
34869 .code
34870 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34871 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34872 .endd
34873 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34874 Exim recognizes such lines at the start of messages that are submitted to it
34875 via the command line (that is, on the standard input). It does not recognize
34876 such lines in incoming SMTP messages, unless the sending host matches
34877 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34878 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34879 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34880 default value matches the two common cases shown above and puts the address
34881 that follows &"From"& into &$1$&.
34882
34883 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34884 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34885 a trusted user, the message's sender address is constructed by expanding the
34886 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34887 then parsed as an RFC 2822 address. If there is no domain, the local part is
34888 qualified with &%qualify_domain%& unless it is the empty string. However, if
34889 the command line &%-f%& option is used, it overrides the &"From"& line.
34890
34891 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34892 sender address is not changed. This is also the case for incoming SMTP messages
34893 that are permitted to contain &"From"& lines.
34894
34895 Only one &"From"& line is recognized. If there is more than one, the second is
34896 treated as a data line that starts the body of the message, as it is not valid
34897 as a header line. This also happens if a &"From"& line is present in an
34898 incoming SMTP message from a source that is not permitted to send them.
34899
34900
34901
34902 .section "Resent- header lines" "SECID220"
34903 .cindex "&%Resent-%& header lines"
34904 .cindex "header lines" "Resent-"
34905 RFC 2822 makes provision for sets of header lines starting with the string
34906 &`Resent-`& to be added to a message when it is resent by the original
34907 recipient to somebody else. These headers are &'Resent-Date:'&,
34908 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34909 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34910
34911 .blockquote
34912 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34913 processing of replies or other such automatic actions on messages.'&
34914 .endblockquote
34915
34916 This leaves things a bit vague as far as other processing actions such as
34917 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34918 follows:
34919
34920 .ilist
34921 A &'Resent-From:'& line that just contains the login id of the submitting user
34922 is automatically rewritten in the same way as &'From:'& (see below).
34923 .next
34924 If there's a rewriting rule for a particular header line, it is also applied to
34925 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34926 &'From:'& also rewrites &'Resent-From:'&.
34927 .next
34928 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34929 also removed.
34930 .next
34931 For a locally-submitted message,
34932 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34933 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34934 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34935 included in log lines in this case.
34936 .next
34937 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34938 &%Resent-%& header lines are present.
34939 .endlist
34940
34941
34942
34943
34944 .section "The Auto-Submitted: header line" "SECID221"
34945 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34946 includes the header line:
34947 .code
34948 Auto-Submitted: auto-replied
34949 .endd
34950
34951 .section "The Bcc: header line" "SECID222"
34952 .cindex "&'Bcc:'& header line"
34953 If Exim is called with the &%-t%& option, to take recipient addresses from a
34954 message's header, it removes any &'Bcc:'& header line that may exist (after
34955 extracting its addresses). If &%-t%& is not present on the command line, any
34956 existing &'Bcc:'& is not removed.
34957
34958
34959 .section "The Date: header line" "SECID223"
34960 .cindex "&'Date:'& header line"
34961 .cindex "header lines" "Date:"
34962 If a locally-generated or submission-mode message has no &'Date:'& header line,
34963 Exim adds one, using the current date and time, unless the
34964 &%suppress_local_fixups%& control has been specified.
34965
34966 .section "The Delivery-date: header line" "SECID224"
34967 .cindex "&'Delivery-date:'& header line"
34968 .oindex "&%delivery_date_remove%&"
34969 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34970 set. Exim can be configured to add them to the final delivery of messages. (See
34971 the generic &%delivery_date_add%& transport option.) They should not be present
34972 in messages in transit. If the &%delivery_date_remove%& configuration option is
34973 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34974 messages.
34975
34976
34977 .section "The Envelope-to: header line" "SECID225"
34978 .cindex "&'Envelope-to:'& header line"
34979 .cindex "header lines" "Envelope-to:"
34980 .oindex "&%envelope_to_remove%&"
34981 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34982 Exim can be configured to add them to the final delivery of messages. (See the
34983 generic &%envelope_to_add%& transport option.) They should not be present in
34984 messages in transit. If the &%envelope_to_remove%& configuration option is set
34985 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34986 messages.
34987
34988
34989 .section "The From: header line" "SECTthefrohea"
34990 .cindex "&'From:'& header line"
34991 .cindex "header lines" "From:"
34992 .cindex "Sendmail compatibility" "&""From""& line"
34993 .cindex "message" "submission"
34994 .cindex "submission mode"
34995 If a submission-mode message does not contain a &'From:'& header line, Exim
34996 adds one if either of the following conditions is true:
34997
34998 .ilist
34999 The envelope sender address is not empty (that is, this is not a bounce
35000 message). The added header line copies the envelope sender address.
35001 .next
35002 .vindex "&$authenticated_id$&"
35003 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35004 .olist
35005 .vindex "&$qualify_domain$&"
35006 If no domain is specified by the submission control, the local part is
35007 &$authenticated_id$& and the domain is &$qualify_domain$&.
35008 .next
35009 If a non-empty domain is specified by the submission control, the local
35010 part is &$authenticated_id$&, and the domain is the specified domain.
35011 .next
35012 If an empty domain is specified by the submission control,
35013 &$authenticated_id$& is assumed to be the complete address.
35014 .endlist
35015 .endlist
35016
35017 A non-empty envelope sender takes precedence.
35018
35019 If a locally-generated incoming message does not contain a &'From:'& header
35020 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35021 containing the sender's address. The calling user's login name and full name
35022 are used to construct the address, as described in section &<<SECTconstr>>&.
35023 They are obtained from the password data by calling &[getpwuid()]& (but see the
35024 &%unknown_login%& configuration option). The address is qualified with
35025 &%qualify_domain%&.
35026
35027 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35028 &'From:'& header line containing just the unqualified login name of the calling
35029 user, this is replaced by an address containing the user's login name and full
35030 name as described in section &<<SECTconstr>>&.
35031
35032
35033 .section "The Message-ID: header line" "SECID226"
35034 .cindex "&'Message-ID:'& header line"
35035 .cindex "header lines" "Message-ID:"
35036 .cindex "message" "submission"
35037 .oindex "&%message_id_header_text%&"
35038 If a locally-generated or submission-mode incoming message does not contain a
35039 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35040 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35041 to the message. If there are any &'Resent-:'& headers in the message, it
35042 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35043 message id, preceded by the letter E to ensure it starts with a letter, and
35044 followed by @ and the primary host name. Additional information can be included
35045 in this header line by setting the &%message_id_header_text%& and/or
35046 &%message_id_header_domain%& options.
35047
35048
35049 .section "The Received: header line" "SECID227"
35050 .cindex "&'Received:'& header line"
35051 .cindex "header lines" "Received:"
35052 A &'Received:'& header line is added at the start of every message. The
35053 contents are defined by the &%received_header_text%& configuration option, and
35054 Exim automatically adds a semicolon and a timestamp to the configured string.
35055
35056 The &'Received:'& header is generated as soon as the message's header lines
35057 have been received. At this stage, the timestamp in the &'Received:'& header
35058 line is the time that the message started to be received. This is the value
35059 that is seen by the DATA ACL and by the &[local_scan()]& function.
35060
35061 Once a message is accepted, the timestamp in the &'Received:'& header line is
35062 changed to the time of acceptance, which is (apart from a small delay while the
35063 -H spool file is written) the earliest time at which delivery could start.
35064
35065
35066 .section "The References: header line" "SECID228"
35067 .cindex "&'References:'& header line"
35068 .cindex "header lines" "References:"
35069 Messages created by the &(autoreply)& transport include a &'References:'&
35070 header line. This is constructed according to the rules that are described in
35071 section 3.64 of RFC 2822 (which states that replies should contain such a
35072 header line), and section 3.14 of RFC 3834 (which states that automatic
35073 responses are not different in this respect). However, because some mail
35074 processing software does not cope well with very long header lines, no more
35075 than 12 message IDs are copied from the &'References:'& header line in the
35076 incoming message. If there are more than 12, the first one and then the final
35077 11 are copied, before adding the message ID of the incoming message.
35078
35079
35080
35081 .section "The Return-path: header line" "SECID229"
35082 .cindex "&'Return-path:'& header line"
35083 .cindex "header lines" "Return-path:"
35084 .oindex "&%return_path_remove%&"
35085 &'Return-path:'& header lines are defined as something an MTA may insert when
35086 it does the final delivery of messages. (See the generic &%return_path_add%&
35087 transport option.) Therefore, they should not be present in messages in
35088 transit. If the &%return_path_remove%& configuration option is set (the
35089 default), Exim removes &'Return-path:'& header lines from incoming messages.
35090
35091
35092
35093 .section "The Sender: header line" "SECTthesenhea"
35094 .cindex "&'Sender:'& header line"
35095 .cindex "message" "submission"
35096 .cindex "header lines" "Sender:"
35097 For a locally-originated message from an untrusted user, Exim may remove an
35098 existing &'Sender:'& header line, and it may add a new one. You can modify
35099 these actions by setting the &%local_sender_retain%& option true, the
35100 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35101 control setting.
35102
35103 When a local message is received from an untrusted user and
35104 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35105 control has not been set, a check is made to see if the address given in the
35106 &'From:'& header line is the correct (local) sender of the message. The address
35107 that is expected has the login name as the local part and the value of
35108 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35109 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35110 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35111 line is added to the message.
35112
35113 If you set &%local_from_check%& false, this checking does not occur. However,
35114 the removal of an existing &'Sender:'& line still happens, unless you also set
35115 &%local_sender_retain%& to be true. It is not possible to set both of these
35116 options true at the same time.
35117
35118 .cindex "submission mode"
35119 By default, no processing of &'Sender:'& header lines is done for messages
35120 received over TCP/IP or for messages submitted by trusted users. However, when
35121 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35122 not specified on the submission control, the following processing takes place:
35123
35124 .vindex "&$authenticated_id$&"
35125 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35126 authenticated, and &$authenticated_id$& is not empty, a sender address is
35127 created as follows:
35128
35129 .ilist
35130 .vindex "&$qualify_domain$&"
35131 If no domain is specified by the submission control, the local part is
35132 &$authenticated_id$& and the domain is &$qualify_domain$&.
35133 .next
35134 If a non-empty domain is specified by the submission control, the local part
35135 is &$authenticated_id$&, and the domain is the specified domain.
35136 .next
35137 If an empty domain is specified by the submission control,
35138 &$authenticated_id$& is assumed to be the complete address.
35139 .endlist
35140
35141 This address is compared with the address in the &'From:'& header line. If they
35142 are different, a &'Sender:'& header line containing the created address is
35143 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35144 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35145
35146 .cindex "return path" "created from &'Sender:'&"
35147 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35148 the message (the envelope sender address) is changed to be the same address,
35149 except in the case of submission mode when &%sender_retain%& is specified.
35150
35151
35152
35153 .section "Adding and removing header lines in routers and transports" &&&
35154          "SECTheadersaddrem"
35155 .cindex "header lines" "adding; in router or transport"
35156 .cindex "header lines" "removing; in router or transport"
35157 When a message is delivered, the addition and removal of header lines can be
35158 specified in a system filter, or on any of the routers and transports that
35159 process the message. Section &<<SECTaddremheasys>>& contains details about
35160 modifying headers in a system filter. Header lines can also be added in an ACL
35161 as a message is received (see section &<<SECTaddheadacl>>&).
35162
35163 In contrast to what happens in a system filter, header modifications that are
35164 specified on routers and transports apply only to the particular recipient
35165 addresses that are being processed by those routers and transports. These
35166 changes do not actually take place until a copy of the message is being
35167 transported. Therefore, they do not affect the basic set of header lines, and
35168 they do not affect the values of the variables that refer to header lines.
35169
35170 &*Note*&: In particular, this means that any expansions in the configuration of
35171 the transport cannot refer to the modified header lines, because such
35172 expansions all occur before the message is actually transported.
35173
35174 For both routers and transports, the argument of a &%headers_add%&
35175 option must be in the form of one or more RFC 2822 header lines, separated by
35176 newlines (coded as &"\n"&). For example:
35177 .code
35178 headers_add = X-added-header: added by $primary_hostname\n\
35179               X-added-second: another added header line
35180 .endd
35181 Exim does not check the syntax of these added header lines.
35182
35183 Multiple &%headers_add%& options for a single router or transport can be
35184 specified; the values will append to a single list of header lines.
35185 Each header-line is separately expanded.
35186
35187 The argument of a &%headers_remove%& option must consist of a colon-separated
35188 list of header names. This is confusing, because header names themselves are
35189 often terminated by colons. In this case, the colons are the list separators,
35190 not part of the names. For example:
35191 .code
35192 headers_remove = return-receipt-to:acknowledge-to
35193 .endd
35194
35195 Multiple &%headers_remove%& options for a single router or transport can be
35196 specified; the arguments will append to a single header-names list.
35197 Each item is separately expanded.
35198 Note that colons in complex expansions which are used to
35199 form all or part of a &%headers_remove%& list
35200 will act as list separators.
35201
35202 When &%headers_add%& or &%headers_remove%& is specified on a router,
35203 items are expanded at routing time,
35204 and then associated with all addresses that are
35205 accepted by that router, and also with any new addresses that it generates. If
35206 an address passes through several routers as a result of aliasing or
35207 forwarding, the changes are cumulative.
35208
35209 .oindex "&%unseen%&"
35210 However, this does not apply to multiple routers that result from the use of
35211 the &%unseen%& option. Any header modifications that were specified by the
35212 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35213
35214 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35215 settings cannot be delivered together in a batch, so a transport is always
35216 dealing with a set of addresses that have the same header-processing
35217 requirements.
35218
35219 The transport starts by writing the original set of header lines that arrived
35220 with the message, possibly modified by the system filter. As it writes out
35221 these lines, it consults the list of header names that were attached to the
35222 recipient address(es) by &%headers_remove%& options in routers, and it also
35223 consults the transport's own &%headers_remove%& option. Header lines whose
35224 names are on either of these lists are not written out. If there are multiple
35225 instances of any listed header, they are all skipped.
35226
35227 After the remaining original header lines have been written, new header
35228 lines that were specified by routers' &%headers_add%& options are written, in
35229 the order in which they were attached to the address. These are followed by any
35230 header lines specified by the transport's &%headers_add%& option.
35231
35232 This way of handling header line modifications in routers and transports has
35233 the following consequences:
35234
35235 .ilist
35236 The original set of header lines, possibly modified by the system filter,
35237 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35238 to it, at all times.
35239 .next
35240 Header lines that are added by a router's
35241 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35242 expansion syntax in subsequent routers or the transport.
35243 .next
35244 Conversely, header lines that are specified for removal by &%headers_remove%&
35245 in a router remain visible to subsequent routers and the transport.
35246 .next
35247 Headers added to an address by &%headers_add%& in a router cannot be removed by
35248 a later router or by a transport.
35249 .next
35250 An added header can refer to the contents of an original header that is to be
35251 removed, even it has the same name as the added header. For example:
35252 .code
35253 headers_remove = subject
35254 headers_add = Subject: new subject (was: $h_subject:)
35255 .endd
35256 .endlist
35257
35258 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35259 for a &(redirect)& router that has the &%one_time%& option set.
35260
35261
35262
35263
35264
35265 .section "Constructed addresses" "SECTconstr"
35266 .cindex "address" "constructed"
35267 .cindex "constructed address"
35268 When Exim constructs a sender address for a locally-generated message, it uses
35269 the form
35270 .display
35271 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35272 .endd
35273 For example:
35274 .code
35275 Zaphod Beeblebrox <zaphod@end.univ.example>
35276 .endd
35277 The user name is obtained from the &%-F%& command line option if set, or
35278 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35279 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35280 ampersand character, this is replaced by the login name with the first letter
35281 upper cased, as is conventional in a number of operating systems. See the
35282 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35283 The &%unknown_username%& option can be used to specify user names in cases when
35284 there is no password file entry.
35285
35286 .cindex "RFC 2047"
35287 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35288 parts of it if necessary. In addition, if it contains any non-printing
35289 characters, it is encoded as described in RFC 2047, which defines a way of
35290 including non-ASCII characters in header lines. The value of the
35291 &%headers_charset%& option specifies the name of the encoding that is used (the
35292 characters are assumed to be in this encoding). The setting of
35293 &%print_topbitchars%& controls whether characters with the top bit set (that
35294 is, with codes greater than 127) count as printing characters or not.
35295
35296
35297
35298 .section "Case of local parts" "SECID230"
35299 .cindex "case of local parts"
35300 .cindex "local part" "case of"
35301 RFC 2822 states that the case of letters in the local parts of addresses cannot
35302 be assumed to be non-significant. Exim preserves the case of local parts of
35303 addresses, but by default it uses a lower-cased form when it is routing,
35304 because on most Unix systems, usernames are in lower case and case-insensitive
35305 routing is required. However, any particular router can be made to use the
35306 original case for local parts by setting the &%caseful_local_part%& generic
35307 router option.
35308
35309 .cindex "mixed-case login names"
35310 If you must have mixed-case user names on your system, the best way to proceed,
35311 assuming you want case-independent handling of incoming email, is to set up
35312 your first router to convert incoming local parts in your domains to the
35313 correct case by means of a file lookup. For example:
35314 .code
35315 correct_case:
35316   driver = redirect
35317   domains = +local_domains
35318   data = ${lookup{$local_part}cdb\
35319               {/etc/usercased.cdb}{$value}fail}\
35320               @$domain
35321 .endd
35322 For this router, the local part is forced to lower case by the default action
35323 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35324 up a new local part in the correct case. If you then set &%caseful_local_part%&
35325 on any subsequent routers which process your domains, they will operate on
35326 local parts with the correct case in a case-sensitive manner.
35327
35328
35329
35330 .section "Dots in local parts" "SECID231"
35331 .cindex "dot" "in local part"
35332 .cindex "local part" "dots in"
35333 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35334 part may not begin or end with a dot, nor have two consecutive dots in the
35335 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35336 empty components for compatibility.
35337
35338
35339
35340 .section "Rewriting addresses" "SECID232"
35341 .cindex "rewriting" "addresses"
35342 Rewriting of sender and recipient addresses, and addresses in headers, can
35343 happen automatically, or as the result of configuration options, as described
35344 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35345 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35346
35347 Automatic rewriting includes qualification, as mentioned above. The other case
35348 in which it can happen is when an incomplete non-local domain is given. The
35349 routing process may cause this to be expanded into the full domain name. For
35350 example, a header such as
35351 .code
35352 To: hare@teaparty
35353 .endd
35354 might get rewritten as
35355 .code
35356 To: hare@teaparty.wonderland.fict.example
35357 .endd
35358 Rewriting as a result of routing is the one kind of message processing that
35359 does not happen at input time, as it cannot be done until the address has
35360 been routed.
35361
35362 Strictly, one should not do &'any'& deliveries of a message until all its
35363 addresses have been routed, in case any of the headers get changed as a
35364 result of routing. However, doing this in practice would hold up many
35365 deliveries for unreasonable amounts of time, just because one address could not
35366 immediately be routed. Exim therefore does not delay other deliveries when
35367 routing of one or more addresses is deferred.
35368 .ecindex IIDmesproc
35369
35370
35371
35372 . ////////////////////////////////////////////////////////////////////////////
35373 . ////////////////////////////////////////////////////////////////////////////
35374
35375 .chapter "SMTP processing" "CHAPSMTP"
35376 .scindex IIDsmtpproc1 "SMTP" "processing details"
35377 .scindex IIDsmtpproc2 "LMTP" "processing details"
35378 Exim supports a number of different ways of using the SMTP protocol, and its
35379 LMTP variant, which is an interactive protocol for transferring messages into a
35380 closed mail store application. This chapter contains details of how SMTP is
35381 processed. For incoming mail, the following are available:
35382
35383 .ilist
35384 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35385 .next
35386 SMTP over the standard input and output (the &%-bs%& option);
35387 .next
35388 Batched SMTP on the standard input (the &%-bS%& option).
35389 .endlist
35390
35391 For mail delivery, the following are available:
35392
35393 .ilist
35394 SMTP over TCP/IP (the &(smtp)& transport);
35395 .next
35396 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35397 &"lmtp"&);
35398 .next
35399 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35400 transport);
35401 .next
35402 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35403 the &%use_bsmtp%& option set).
35404 .endlist
35405
35406 &'Batched SMTP'& is the name for a process in which batches of messages are
35407 stored in or read from files (or pipes), in a format in which SMTP commands are
35408 used to contain the envelope information.
35409
35410
35411
35412 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35413 .cindex "SMTP" "outgoing over TCP/IP"
35414 .cindex "outgoing SMTP over TCP/IP"
35415 .cindex "LMTP" "over TCP/IP"
35416 .cindex "outgoing LMTP over TCP/IP"
35417 .cindex "EHLO"
35418 .cindex "HELO"
35419 .cindex "SIZE option on MAIL command"
35420 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35421 The &%protocol%& option selects which protocol is to be used, but the actual
35422 processing is the same in both cases.
35423
35424 If, in response to its EHLO command, Exim is told that the SIZE
35425 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35426 command. The value of <&'n'&> is the message size plus the value of the
35427 &%size_addition%& option (default 1024) to allow for additions to the message
35428 such as per-transport header lines, or changes made in a
35429 .cindex "transport" "filter"
35430 .cindex "filter" "transport filter"
35431 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35432 suppressed.
35433
35434 If the remote server advertises support for PIPELINING, Exim uses the
35435 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35436 required for the transaction.
35437
35438 If the remote server advertises support for the STARTTLS command, and Exim
35439 was built to support TLS encryption, it tries to start a TLS session unless the
35440 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35441 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35442 is called for verification.
35443
35444 If the remote server advertises support for the AUTH command, Exim scans
35445 the authenticators configuration for any suitable client settings, as described
35446 in chapter &<<CHAPSMTPAUTH>>&.
35447
35448 .cindex "carriage return"
35449 .cindex "linefeed"
35450 Responses from the remote host are supposed to be terminated by CR followed by
35451 LF. However, there are known to be hosts that do not send CR characters, so in
35452 order to be able to interwork with such hosts, Exim treats LF on its own as a
35453 line terminator.
35454
35455 If a message contains a number of different addresses, all those with the same
35456 characteristics (for example, the same envelope sender) that resolve to the
35457 same set of hosts, in the same order, are sent in a single SMTP transaction,
35458 even if they are for different domains, unless there are more than the setting
35459 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35460 they are split into groups containing no more than &%max_rcpt%&s addresses
35461 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35462 in parallel sessions. The order of hosts with identical MX values is not
35463 significant when checking whether addresses can be batched in this way.
35464
35465 When the &(smtp)& transport suffers a temporary failure that is not
35466 message-related, Exim updates its transport-specific database, which contains
35467 records indexed by host name that remember which messages are waiting for each
35468 particular host. It also updates the retry database with new retry times.
35469
35470 .cindex "hints database" "retry keys"
35471 Exim's retry hints are based on host name plus IP address, so if one address of
35472 a multi-homed host is broken, it will soon be skipped most of the time.
35473 See the next section for more detail about error handling.
35474
35475 .cindex "SMTP" "passed connection"
35476 .cindex "SMTP" "batching over TCP/IP"
35477 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35478 looks in the hints database for the transport to see if there are any queued
35479 messages waiting for the host to which it is connected. If it finds one, it
35480 creates a new Exim process using the &%-MC%& option (which can only be used by
35481 a process running as root or the Exim user) and passes the TCP/IP socket to it
35482 so that it can deliver another message using the same socket. The new process
35483 does only those deliveries that are routed to the connected host, and may in
35484 turn pass the socket on to a third process, and so on.
35485
35486 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35487 limit the number of messages sent down a single TCP/IP connection.
35488
35489 .cindex "asterisk" "after IP address"
35490 The second and subsequent messages delivered down an existing connection are
35491 identified in the main log by the addition of an asterisk after the closing
35492 square bracket of the IP address.
35493
35494
35495
35496
35497 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35498 .cindex "error" "in outgoing SMTP"
35499 .cindex "SMTP" "errors in outgoing"
35500 .cindex "host" "error"
35501 Three different kinds of error are recognized for outgoing SMTP: host errors,
35502 message errors, and recipient errors.
35503
35504 .vlist
35505 .vitem "&*Host errors*&"
35506 A host error is not associated with a particular message or with a
35507 particular recipient of a message. The host errors are:
35508
35509 .ilist
35510 Connection refused or timed out,
35511 .next
35512 Any error response code on connection,
35513 .next
35514 Any error response code to EHLO or HELO,
35515 .next
35516 Loss of connection at any time, except after &"."&,
35517 .next
35518 I/O errors at any time,
35519 .next
35520 Timeouts during the session, other than in response to MAIL, RCPT or
35521 the &"."& at the end of the data.
35522 .endlist ilist
35523
35524 For a host error, a permanent error response on connection, or in response to
35525 EHLO, causes all addresses routed to the host to be failed. Any other host
35526 error causes all addresses to be deferred, and retry data to be created for the
35527 host. It is not tried again, for any message, until its retry time arrives. If
35528 the current set of addresses are not all delivered in this run (to some
35529 alternative host), the message is added to the list of those waiting for this
35530 host, so if it is still undelivered when a subsequent successful delivery is
35531 made to the host, it will be sent down the same SMTP connection.
35532
35533 .vitem "&*Message errors*&"
35534 .cindex "message" "error"
35535 A message error is associated with a particular message when sent to a
35536 particular host, but not with a particular recipient of the message. The
35537 message errors are:
35538
35539 .ilist
35540 Any error response code to MAIL, DATA, or the &"."& that terminates
35541 the data,
35542 .next
35543 Timeout after MAIL,
35544 .next
35545 Timeout or loss of connection after the &"."& that terminates the data. A
35546 timeout after the DATA command itself is treated as a host error, as is loss of
35547 connection at any other time.
35548 .endlist ilist
35549
35550 For a message error, a permanent error response (5&'xx'&) causes all addresses
35551 to be failed, and a delivery error report to be returned to the sender. A
35552 temporary error response (4&'xx'&), or one of the timeouts, causes all
35553 addresses to be deferred. Retry data is not created for the host, but instead,
35554 a retry record for the combination of host plus message id is created. The
35555 message is not added to the list of those waiting for this host. This ensures
35556 that the failing message will not be sent to this host again until the retry
35557 time arrives. However, other messages that are routed to the host are not
35558 affected, so if it is some property of the message that is causing the error,
35559 it will not stop the delivery of other mail.
35560
35561 If the remote host specified support for the SIZE parameter in its response
35562 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35563 over-large message will cause a message error because the error arrives as a
35564 response to MAIL.
35565
35566 .vitem "&*Recipient errors*&"
35567 .cindex "recipient" "error"
35568 A recipient error is associated with a particular recipient of a message. The
35569 recipient errors are:
35570
35571 .ilist
35572 Any error response to RCPT,
35573 .next
35574 Timeout after RCPT.
35575 .endlist
35576
35577 For a recipient error, a permanent error response (5&'xx'&) causes the
35578 recipient address to be failed, and a bounce message to be returned to the
35579 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35580 address to be deferred, and routing retry data to be created for it. This is
35581 used to delay processing of the address in subsequent queue runs, until its
35582 routing retry time arrives. This applies to all messages, but because it
35583 operates only in queue runs, one attempt will be made to deliver a new message
35584 to the failing address before the delay starts to operate. This ensures that,
35585 if the failure is really related to the message rather than the recipient
35586 (&"message too big for this recipient"& is a possible example), other messages
35587 have a chance of getting delivered. If a delivery to the address does succeed,
35588 the retry information gets cleared, so all stuck messages get tried again, and
35589 the retry clock is reset.
35590
35591 The message is not added to the list of those waiting for this host. Use of the
35592 host for other messages is unaffected, and except in the case of a timeout,
35593 other recipients are processed independently, and may be successfully delivered
35594 in the current SMTP session. After a timeout it is of course impossible to
35595 proceed with the session, so all addresses get deferred. However, those other
35596 than the one that failed do not suffer any subsequent retry delays. Therefore,
35597 if one recipient is causing trouble, the others have a chance of getting
35598 through when a subsequent delivery attempt occurs before the failing
35599 recipient's retry time.
35600 .endlist
35601
35602 In all cases, if there are other hosts (or IP addresses) available for the
35603 current set of addresses (for example, from multiple MX records), they are
35604 tried in this run for any undelivered addresses, subject of course to their
35605 own retry data. In other words, recipient error retry data does not take effect
35606 until the next delivery attempt.
35607
35608 Some hosts have been observed to give temporary error responses to every
35609 MAIL command at certain times (&"insufficient space"& has been seen). It
35610 would be nice if such circumstances could be recognized, and defer data for the
35611 host itself created, but this is not possible within the current Exim design.
35612 What actually happens is that retry data for every (host, message) combination
35613 is created.
35614
35615 The reason that timeouts after MAIL and RCPT are treated specially is that
35616 these can sometimes arise as a result of the remote host's verification
35617 procedures. Exim makes this assumption, and treats them as if a temporary error
35618 response had been received. A timeout after &"."& is treated specially because
35619 it is known that some broken implementations fail to recognize the end of the
35620 message if the last character of the last line is a binary zero. Thus, it is
35621 helpful to treat this case as a message error.
35622
35623 Timeouts at other times are treated as host errors, assuming a problem with the
35624 host, or the connection to it. If a timeout after MAIL, RCPT,
35625 or &"."& is really a connection problem, the assumption is that at the next try
35626 the timeout is likely to occur at some other point in the dialogue, causing it
35627 then to be treated as a host error.
35628
35629 There is experimental evidence that some MTAs drop the connection after the
35630 terminating &"."& if they do not like the contents of the message for some
35631 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35632 should be given. That is why Exim treats this case as a message rather than a
35633 host error, in order not to delay other messages to the same host.
35634
35635
35636
35637
35638 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35639 .cindex "SMTP" "incoming over TCP/IP"
35640 .cindex "incoming SMTP over TCP/IP"
35641 .cindex "inetd"
35642 .cindex "daemon"
35643 Incoming SMTP messages can be accepted in one of two ways: by running a
35644 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35645 &_/etc/inetd.conf_& should be like this:
35646 .code
35647 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35648 .endd
35649 Exim distinguishes between this case and the case of a locally running user
35650 agent using the &%-bs%& option by checking whether or not the standard input is
35651 a socket. When it is, either the port must be privileged (less than 1024), or
35652 the caller must be root or the Exim user. If any other user passes a socket
35653 with an unprivileged port number, Exim prints a message on the standard error
35654 stream and exits with an error code.
35655
35656 By default, Exim does not make a log entry when a remote host connects or
35657 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35658 unexpected. It can be made to write such log entries by setting the
35659 &%smtp_connection%& log selector.
35660
35661 .cindex "carriage return"
35662 .cindex "linefeed"
35663 Commands from the remote host are supposed to be terminated by CR followed by
35664 LF. However, there are known to be hosts that do not send CR characters. In
35665 order to be able to interwork with such hosts, Exim treats LF on its own as a
35666 line terminator.
35667 Furthermore, because common code is used for receiving messages from all
35668 sources, a CR on its own is also interpreted as a line terminator. However, the
35669 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35670
35671 .cindex "EHLO" "invalid data"
35672 .cindex "HELO" "invalid data"
35673 One area that sometimes gives rise to problems concerns the EHLO or
35674 HELO commands. Some clients send syntactically invalid versions of these
35675 commands, which Exim rejects by default. (This is nothing to do with verifying
35676 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35677 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35678 match the broken hosts that send invalid commands.
35679
35680 .cindex "SIZE option on MAIL command"
35681 .cindex "MAIL" "SIZE option"
35682 The amount of disk space available is checked whenever SIZE is received on
35683 a MAIL command, independently of whether &%message_size_limit%& or
35684 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35685 false. A temporary error is given if there is not enough space. If
35686 &%check_spool_space%& is set, the check is for that amount of space plus the
35687 value given with SIZE, that is, it checks that the addition of the incoming
35688 message will not reduce the space below the threshold.
35689
35690 When a message is successfully received, Exim includes the local message id in
35691 its response to the final &"."& that terminates the data. If the remote host
35692 logs this text it can help with tracing what has happened to a message.
35693
35694 The Exim daemon can limit the number of simultaneous incoming connections it is
35695 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35696 number of simultaneous incoming connections from a single remote host (see the
35697 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35698 rejected using the SMTP temporary error code 421.
35699
35700 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35701 subprocess has finished, as this can get lost at busy times. Instead, it looks
35702 for completed subprocesses every time it wakes up. Provided there are other
35703 things happening (new incoming calls, starts of queue runs), completed
35704 processes will be noticed and tidied away. On very quiet systems you may
35705 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35706 it will be noticed when the daemon next wakes up.
35707
35708 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35709 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35710 high system load &-- for details see the &%smtp_accept_reserve%&,
35711 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35712 applies in both the daemon and &'inetd'& cases.
35713
35714 Exim normally starts a delivery process for each message received, though this
35715 can be varied by means of the &%-odq%& command line option and the
35716 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35717 number of simultaneously running delivery processes started in this way from
35718 SMTP input can be limited by the &%smtp_accept_queue%& and
35719 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35720 subsequently received messages are just put on the input queue without starting
35721 a delivery process.
35722
35723 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35724 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35725 started up from the &'inetd'& daemon, because in that case each connection is
35726 handled by an entirely independent Exim process. Control by load average is,
35727 however, available with &'inetd'&.
35728
35729 Exim can be configured to verify addresses in incoming SMTP commands as they
35730 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35731 to rewrite addresses at this time &-- before any syntax checking is done. See
35732 section &<<SECTrewriteS>>&.
35733
35734 Exim can also be configured to limit the rate at which a client host submits
35735 MAIL and RCPT commands in a single SMTP session. See the
35736 &%smtp_ratelimit_hosts%& option.
35737
35738
35739
35740 .section "Unrecognized SMTP commands" "SECID234"
35741 .cindex "SMTP" "unrecognized commands"
35742 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35743 commands during a single SMTP connection, it drops the connection after sending
35744 the error response to the last command. The default value for
35745 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35746 abuse that subvert web servers into making connections to SMTP ports; in these
35747 circumstances, a number of non-SMTP lines are sent first.
35748
35749
35750 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35751 .cindex "SMTP" "syntax errors"
35752 .cindex "SMTP" "protocol errors"
35753 A syntax error is detected if an SMTP command is recognized, but there is
35754 something syntactically wrong with its data, for example, a malformed email
35755 address in a RCPT command. Protocol errors include invalid command
35756 sequencing such as RCPT before MAIL. If Exim receives more than
35757 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35758 drops the connection after sending the error response to the last command. The
35759 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35760 broken clients that loop sending bad commands (yes, it has been seen).
35761
35762
35763
35764 .section "Use of non-mail SMTP commands" "SECID236"
35765 .cindex "SMTP" "non-mail commands"
35766 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35767 DATA. Exim counts such commands, and drops the connection if there are too
35768 many of them in a single SMTP session. This action catches some
35769 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35770 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35771 defines what &"too many"& means. Its default value is 10.
35772
35773 When a new message is expected, one occurrence of RSET is not counted. This
35774 allows a client to send one RSET between messages (this is not necessary,
35775 but some clients do it). Exim also allows one uncounted occurrence of HELO
35776 or EHLO, and one occurrence of STARTTLS between messages. After
35777 starting up a TLS session, another EHLO is expected, and so it too is not
35778 counted.
35779
35780 The first occurrence of AUTH in a connection, or immediately following
35781 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35782 RCPT, DATA, and QUIT are counted.
35783
35784 You can control which hosts are subject to the limit set by
35785 &%smtp_accept_max_nonmail%& by setting
35786 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35787 the limit apply to all hosts. This option means that you can exclude any
35788 specific badly-behaved hosts that you have to live with.
35789
35790
35791
35792
35793 .section "The VRFY and EXPN commands" "SECID237"
35794 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35795 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35796 appropriate) in order to decide whether the command should be accepted or not.
35797
35798 .cindex "VRFY" "processing"
35799 When no ACL is defined for VRFY, or if it rejects without
35800 setting an explicit response code, the command is accepted
35801 (with a 252 SMTP response code)
35802 in order to support awkward clients that do a VRFY before every RCPT.
35803 When VRFY is accepted, it runs exactly the same code as when Exim is
35804 called with the &%-bv%& option, and returns 250/451/550
35805 SMTP response codes.
35806
35807 .cindex "EXPN" "processing"
35808 If no ACL for EXPN is defined, the command is rejected.
35809 When EXPN is accepted, a single-level expansion of the address is done.
35810 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35811 than a verification (the &%-bv%& option). If an unqualified local part is given
35812 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35813 of VRFY and EXPN commands are logged on the main and reject logs, and
35814 VRFY verification failures are logged on the main log for consistency with
35815 RCPT failures.
35816
35817
35818
35819 .section "The ETRN command" "SECTETRN"
35820 .cindex "ETRN" "processing"
35821 RFC 1985 describes an SMTP command called ETRN that is designed to
35822 overcome the security problems of the TURN command (which has fallen into
35823 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35824 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35825 should be accepted or not. If no ACL is defined, the command is rejected.
35826
35827 The ETRN command is concerned with &"releasing"& messages that are awaiting
35828 delivery to certain hosts. As Exim does not organize its message queue by host,
35829 the only form of ETRN that is supported by default is the one where the
35830 text starts with the &"#"& prefix, in which case the remainder of the text is
35831 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35832 the &%-R%& option to happen, with the remainder of the ETRN text as its
35833 argument. For example,
35834 .code
35835 ETRN #brigadoon
35836 .endd
35837 runs the command
35838 .code
35839 exim -R brigadoon
35840 .endd
35841 which causes a delivery attempt on all messages with undelivered addresses
35842 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35843 default), Exim prevents the simultaneous execution of more than one queue run
35844 for the same argument string as a result of an ETRN command. This stops
35845 a misbehaving client from starting more than one queue runner at once.
35846
35847 .cindex "hints database" "ETRN serialization"
35848 Exim implements the serialization by means of a hints database in which a
35849 record is written whenever a process is started by ETRN, and deleted when
35850 the process completes. However, Exim does not keep the SMTP session waiting for
35851 the ETRN process to complete. Once ETRN is accepted, the client is sent
35852 a &"success"& return code. Obviously there is scope for hints records to get
35853 left lying around if there is a system or program crash. To guard against this,
35854 Exim ignores any records that are more than six hours old.
35855
35856 .oindex "&%smtp_etrn_command%&"
35857 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35858 used. This specifies a command that is run whenever ETRN is received,
35859 whatever the form of its argument. For
35860 example:
35861 .code
35862 smtp_etrn_command = /etc/etrn_command $domain \
35863                     $sender_host_address
35864 .endd
35865 .vindex "&$domain$&"
35866 The string is split up into arguments which are independently expanded. The
35867 expansion variable &$domain$& is set to the argument of the ETRN command,
35868 and no syntax checking is done on the contents of this argument. Exim does not
35869 wait for the command to complete, so its status code is not checked. Exim runs
35870 under its own uid and gid when receiving incoming SMTP, so it is not possible
35871 for it to change them before running the command.
35872
35873
35874
35875 .section "Incoming local SMTP" "SECID238"
35876 .cindex "SMTP" "local incoming"
35877 Some user agents use SMTP to pass messages to their local MTA using the
35878 standard input and output, as opposed to passing the envelope on the command
35879 line and writing the message to the standard input. This is supported by the
35880 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35881 messages over TCP/IP (including the use of ACLs), except that the envelope
35882 sender given in a MAIL command is ignored unless the caller is trusted. In
35883 an ACL you can detect this form of SMTP input by testing for an empty host
35884 identification. It is common to have this as the first line in the ACL that
35885 runs for RCPT commands:
35886 .code
35887 accept hosts = :
35888 .endd
35889 This accepts SMTP messages from local processes without doing any other tests.
35890
35891
35892
35893 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35894 .cindex "SMTP" "batched outgoing"
35895 .cindex "batched SMTP output"
35896 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35897 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35898 be output in BSMTP format. No SMTP responses are possible for this form of
35899 delivery. All it is doing is using SMTP commands as a way of transmitting the
35900 envelope along with the message.
35901
35902 The message is written to the file or pipe preceded by the SMTP commands
35903 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35904 the message that start with a dot have an extra dot added. The SMTP command
35905 HELO is not normally used. If it is required, the &%message_prefix%& option
35906 can be used to specify it.
35907
35908 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35909 one recipient address at a time by default. However, you can arrange for them
35910 to handle several addresses at once by setting the &%batch_max%& option. When
35911 this is done for BSMTP, messages may contain multiple RCPT commands. See
35912 chapter &<<CHAPbatching>>& for more details.
35913
35914 .vindex "&$host$&"
35915 When one or more addresses are routed to a BSMTP transport by a router that
35916 sets up a host list, the name of the first host on the list is available to the
35917 transport in the variable &$host$&. Here is an example of such a transport and
35918 router:
35919 .code
35920 begin routers
35921 route_append:
35922   driver = manualroute
35923   transport = smtp_appendfile
35924   route_list = domain.example  batch.host.example
35925
35926 begin transports
35927 smtp_appendfile:
35928   driver = appendfile
35929   directory = /var/bsmtp/$host
35930   batch_max = 1000
35931   use_bsmtp
35932   user = exim
35933 .endd
35934 This causes messages addressed to &'domain.example'& to be written in BSMTP
35935 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35936 message (unless there are more than 1000 recipients).
35937
35938
35939
35940 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35941 .cindex "SMTP" "batched incoming"
35942 .cindex "batched SMTP input"
35943 The &%-bS%& command line option causes Exim to accept one or more messages by
35944 reading SMTP on the standard input, but to generate no responses. If the caller
35945 is trusted, the senders in the MAIL commands are believed; otherwise the
35946 sender is always the caller of Exim. Unqualified senders and receivers are not
35947 rejected (there seems little point) but instead just get qualified. HELO
35948 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35949 as NOOP; QUIT quits.
35950
35951 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35952 ACL is run in the same way as for non-SMTP local input.
35953
35954 If an error is detected while reading a message, including a missing &"."& at
35955 the end, Exim gives up immediately. It writes details of the error to the
35956 standard output in a stylized way that the calling program should be able to
35957 make some use of automatically, for example:
35958 .code
35959 554 Unexpected end of file
35960 Transaction started in line 10
35961 Error detected in line 14
35962 .endd
35963 It writes a more verbose version, for human consumption, to the standard error
35964 file, for example:
35965 .code
35966 An error was detected while processing a file of BSMTP input.
35967 The error message was:
35968
35969 501 '>' missing at end of address
35970
35971 The SMTP transaction started in line 10.
35972 The error was detected in line 12.
35973 The SMTP command at fault was:
35974
35975 rcpt to:<malformed@in.com.plete
35976
35977 1 previous message was successfully processed.
35978 The rest of the batch was abandoned.
35979 .endd
35980 The return code from Exim is zero only if there were no errors. It is 1 if some
35981 messages were accepted before an error was detected, and 2 if no messages were
35982 accepted.
35983 .ecindex IIDsmtpproc1
35984 .ecindex IIDsmtpproc2
35985
35986
35987
35988 . ////////////////////////////////////////////////////////////////////////////
35989 . ////////////////////////////////////////////////////////////////////////////
35990
35991 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35992          "Customizing messages"
35993 When a message fails to be delivered, or remains in the queue for more than a
35994 configured amount of time, Exim sends a message to the original sender, or
35995 to an alternative configured address. The text of these messages is built into
35996 the code of Exim, but it is possible to change it, either by adding a single
35997 string, or by replacing each of the paragraphs by text supplied in a file.
35998
35999 The &'From:'& and &'To:'& header lines are automatically generated; you can
36000 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36001 option. Exim also adds the line
36002 .code
36003 Auto-Submitted: auto-generated
36004 .endd
36005 to all warning and bounce messages,
36006
36007
36008 .section "Customizing bounce messages" "SECID239"
36009 .cindex "customizing" "bounce message"
36010 .cindex "bounce message" "customizing"
36011 If &%bounce_message_text%& is set, its contents are included in the default
36012 message immediately after &"This message was created automatically by mail
36013 delivery software."& The string is not expanded. It is not used if
36014 &%bounce_message_file%& is set.
36015
36016 When &%bounce_message_file%& is set, it must point to a template file for
36017 constructing error messages. The file consists of a series of text items,
36018 separated by lines consisting of exactly four asterisks. If the file cannot be
36019 opened, default text is used and a message is written to the main and panic
36020 logs. If any text item in the file is empty, default text is used for that
36021 item.
36022
36023 .vindex "&$bounce_recipient$&"
36024 .vindex "&$bounce_return_size_limit$&"
36025 Each item of text that is read from the file is expanded, and there are two
36026 expansion variables which can be of use here: &$bounce_recipient$& is set to
36027 the recipient of an error message while it is being created, and
36028 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36029 option, rounded to a whole number.
36030
36031 The items must appear in the file in the following order:
36032
36033 .ilist
36034 The first item is included in the headers, and should include at least a
36035 &'Subject:'& header. Exim does not check the syntax of these headers.
36036 .next
36037 The second item forms the start of the error message. After it, Exim lists the
36038 failing addresses with their error messages.
36039 .next
36040 The third item is used to introduce any text from pipe transports that is to be
36041 returned to the sender. It is omitted if there is no such text.
36042 .next
36043 The fourth, fifth and sixth items will be ignored and may be empty.
36044 The fields exist for back-compatibility
36045 .endlist
36046
36047 The default state (&%bounce_message_file%& unset) is equivalent to the
36048 following file, in which the sixth item is empty. The &'Subject:'& and some
36049 other lines have been split in order to fit them on the page:
36050 .code
36051 Subject: Mail delivery failed
36052   ${if eq{$sender_address}{$bounce_recipient}
36053   {: returning message to sender}}
36054 ****
36055 This message was created automatically by mail delivery software.
36056
36057 A message ${if eq{$sender_address}{$bounce_recipient}
36058   {that you sent }{sent by
36059
36060 <$sender_address>
36061
36062 }}could not be delivered to all of its recipients.
36063 This is a permanent error. The following address(es) failed:
36064 ****
36065 The following text was generated during the delivery attempt(s):
36066 ****
36067 ------ This is a copy of the message, including all the headers.
36068   ------
36069 ****
36070 ------ The body of the message is $message_size characters long;
36071   only the first
36072 ------ $bounce_return_size_limit or so are included here.
36073 ****
36074 .endd
36075 .section "Customizing warning messages" "SECTcustwarn"
36076 .cindex "customizing" "warning message"
36077 .cindex "warning of delay" "customizing the message"
36078 The option &%warn_message_file%& can be pointed at a template file for use when
36079 warnings about message delays are created. In this case there are only three
36080 text sections:
36081
36082 .ilist
36083 The first item is included in the headers, and should include at least a
36084 &'Subject:'& header. Exim does not check the syntax of these headers.
36085 .next
36086 The second item forms the start of the warning message. After it, Exim lists
36087 the delayed addresses.
36088 .next
36089 The third item then ends the message.
36090 .endlist
36091
36092 The default state is equivalent to the following file, except that some lines
36093 have been split here, in order to fit them on the page:
36094 .code
36095 Subject: Warning: message $message_exim_id delayed
36096   $warn_message_delay
36097 ****
36098 This message was created automatically by mail delivery software.
36099
36100 A message ${if eq{$sender_address}{$warn_message_recipients}
36101 {that you sent }{sent by
36102
36103 <$sender_address>
36104
36105 }}has not been delivered to all of its recipients after
36106 more than $warn_message_delay in the queue on $primary_hostname.
36107
36108 The message identifier is:     $message_exim_id
36109 The subject of the message is: $h_subject
36110 The date of the message is:    $h_date
36111
36112 The following address(es) have not yet been delivered:
36113 ****
36114 No action is required on your part. Delivery attempts will
36115 continue for some time, and this warning may be repeated at
36116 intervals if the message remains undelivered. Eventually the
36117 mail delivery software will give up, and when that happens,
36118 the message will be returned to you.
36119 .endd
36120 .vindex "&$warn_message_delay$&"
36121 .vindex "&$warn_message_recipients$&"
36122 However, in the default state the subject and date lines are omitted if no
36123 appropriate headers exist. During the expansion of this file,
36124 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36125 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36126 of recipients for the warning message. There may be more than one if there are
36127 multiple addresses with different &%errors_to%& settings on the routers that
36128 handled them.
36129
36130
36131
36132
36133 . ////////////////////////////////////////////////////////////////////////////
36134 . ////////////////////////////////////////////////////////////////////////////
36135
36136 .chapter "Some common configuration settings" "CHAPcomconreq"
36137 This chapter discusses some configuration settings that seem to be fairly
36138 common. More examples and discussion can be found in the Exim book.
36139
36140
36141
36142 .section "Sending mail to a smart host" "SECID240"
36143 .cindex "smart host" "example router"
36144 If you want to send all mail for non-local domains to a &"smart host"&, you
36145 should replace the default &(dnslookup)& router with a router which does the
36146 routing explicitly:
36147 .code
36148 send_to_smart_host:
36149   driver = manualroute
36150   route_list = !+local_domains smart.host.name
36151   transport = remote_smtp
36152 .endd
36153 You can use the smart host's IP address instead of the name if you wish.
36154 If you are using Exim only to submit messages to a smart host, and not for
36155 receiving incoming messages, you can arrange for it to do the submission
36156 synchronously by setting the &%mua_wrapper%& option (see chapter
36157 &<<CHAPnonqueueing>>&).
36158
36159
36160
36161
36162 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36163 .cindex "mailing lists"
36164 Exim can be used to run simple mailing lists, but for large and/or complicated
36165 requirements, the use of additional specialized mailing list software such as
36166 Majordomo or Mailman is recommended.
36167
36168 The &(redirect)& router can be used to handle mailing lists where each list
36169 is maintained in a separate file, which can therefore be managed by an
36170 independent manager. The &%domains%& router option can be used to run these
36171 lists in a separate domain from normal mail. For example:
36172 .code
36173 lists:
36174   driver = redirect
36175   domains = lists.example
36176   file = /usr/lists/$local_part
36177   forbid_pipe
36178   forbid_file
36179   errors_to = $local_part-request@lists.example
36180   no_more
36181 .endd
36182 This router is skipped for domains other than &'lists.example'&. For addresses
36183 in that domain, it looks for a file that matches the local part. If there is no
36184 such file, the router declines, but because &%no_more%& is set, no subsequent
36185 routers are tried, and so the whole delivery fails.
36186
36187 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36188 expanded into a filename or a pipe delivery, which is usually inappropriate in
36189 a mailing list.
36190
36191 .oindex "&%errors_to%&"
36192 The &%errors_to%& option specifies that any delivery errors caused by addresses
36193 taken from a mailing list are to be sent to the given address rather than the
36194 original sender of the message. However, before acting on this, Exim verifies
36195 the error address, and ignores it if verification fails.
36196
36197 For example, using the configuration above, mail sent to
36198 &'dicts@lists.example'& is passed on to those addresses contained in
36199 &_/usr/lists/dicts_&, with error reports directed to
36200 &'dicts-request@lists.example'&, provided that this address can be verified.
36201 There could be a file called &_/usr/lists/dicts-request_& containing
36202 the address(es) of this particular list's manager(s), but other approaches,
36203 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36204 or &%local_part_suffix%& options) to handle addresses of the form
36205 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36206
36207
36208
36209 .section "Syntax errors in mailing lists" "SECID241"
36210 .cindex "mailing lists" "syntax errors in"
36211 If an entry in redirection data contains a syntax error, Exim normally defers
36212 delivery of the original address. That means that a syntax error in a mailing
36213 list holds up all deliveries to the list. This may not be appropriate when a
36214 list is being maintained automatically from data supplied by users, and the
36215 addresses are not rigorously checked.
36216
36217 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36218 entries that fail to parse, noting the incident in the log. If in addition
36219 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36220 whenever a broken address is skipped. It is usually appropriate to set
36221 &%syntax_errors_to%& to the same address as &%errors_to%&.
36222
36223
36224
36225 .section "Re-expansion of mailing lists" "SECID242"
36226 .cindex "mailing lists" "re-expansion of"
36227 Exim remembers every individual address to which a message has been delivered,
36228 in order to avoid duplication, but it normally stores only the original
36229 recipient addresses with a message. If all the deliveries to a mailing list
36230 cannot be done at the first attempt, the mailing list is re-expanded when the
36231 delivery is next tried. This means that alterations to the list are taken into
36232 account at each delivery attempt, so addresses that have been added to
36233 the list since the message arrived will therefore receive a copy of the
36234 message, even though it pre-dates their subscription.
36235
36236 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36237 on the &(redirect)& router. If this is done, any addresses generated by the
36238 router that fail to deliver at the first attempt are added to the message as
36239 &"top level"& addresses, and the parent address that generated them is marked
36240 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36241 subsequent delivery attempts. The disadvantage of this is that if any of the
36242 failing addresses are incorrect, correcting them in the file has no effect on
36243 pre-existing messages.
36244
36245 The original top-level address is remembered with each of the generated
36246 addresses, and is output in any log messages. However, any intermediate parent
36247 addresses are not recorded. This makes a difference to the log only if the
36248 &%all_parents%& selector is set, but for mailing lists there is normally only
36249 one level of expansion anyway.
36250
36251
36252
36253 .section "Closed mailing lists" "SECID243"
36254 .cindex "mailing lists" "closed"
36255 The examples so far have assumed open mailing lists, to which anybody may
36256 send mail. It is also possible to set up closed lists, where mail is accepted
36257 from specified senders only. This is done by making use of the generic
36258 &%senders%& option to restrict the router that handles the list.
36259
36260 The following example uses the same file as a list of recipients and as a list
36261 of permitted senders. It requires three routers:
36262 .code
36263 lists_request:
36264   driver = redirect
36265   domains = lists.example
36266   local_part_suffix = -request
36267   file = /usr/lists/$local_part$local_part_suffix
36268   no_more
36269
36270 lists_post:
36271   driver = redirect
36272   domains = lists.example
36273   senders = ${if exists {/usr/lists/$local_part}\
36274              {lsearch;/usr/lists/$local_part}{*}}
36275   file = /usr/lists/$local_part
36276   forbid_pipe
36277   forbid_file
36278   errors_to = $local_part-request@lists.example
36279   no_more
36280
36281 lists_closed:
36282   driver = redirect
36283   domains = lists.example
36284   allow_fail
36285   data = :fail: $local_part@lists.example is a closed mailing list
36286 .endd
36287 All three routers have the same &%domains%& setting, so for any other domains,
36288 they are all skipped. The first router runs only if the local part ends in
36289 &%-request%&. It handles messages to the list manager(s) by means of an open
36290 mailing list.
36291
36292 The second router runs only if the &%senders%& precondition is satisfied. It
36293 checks for the existence of a list that corresponds to the local part, and then
36294 checks that the sender is on the list by means of a linear search. It is
36295 necessary to check for the existence of the file before trying to search it,
36296 because otherwise Exim thinks there is a configuration error. If the file does
36297 not exist, the expansion of &%senders%& is *, which matches all senders. This
36298 means that the router runs, but because there is no list, declines, and
36299 &%no_more%& ensures that no further routers are run. The address fails with an
36300 &"unrouteable address"& error.
36301
36302 The third router runs only if the second router is skipped, which happens when
36303 a mailing list exists, but the sender is not on it. This router forcibly fails
36304 the address, giving a suitable error message.
36305
36306
36307
36308
36309 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36310 .cindex "VERP"
36311 .cindex "Variable Envelope Return Paths"
36312 .cindex "envelope from"
36313 .cindex "envelope sender"
36314 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36315 are a way of helping mailing list administrators discover which subscription
36316 address is the cause of a particular delivery failure. The idea is to encode
36317 the original recipient address in the outgoing envelope sender address, so that
36318 if the message is forwarded by another host and then subsequently bounces, the
36319 original recipient can be extracted from the recipient address of the bounce.
36320
36321 .oindex &%errors_to%&
36322 .oindex &%return_path%&
36323 Envelope sender addresses can be modified by Exim using two different
36324 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36325 list examples), or the &%return_path%& option on a transport. The second of
36326 these is effective only if the message is successfully delivered to another
36327 host; it is not used for errors detected on the local host (see the description
36328 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36329 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36330 .code
36331 verp_smtp:
36332   driver = smtp
36333   max_rcpt = 1
36334   return_path = \
36335     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36336       {$1-request+$local_part=$domain@your.dom.example}fail}
36337 .endd
36338 This has the effect of rewriting the return path (envelope sender) on outgoing
36339 SMTP messages, if the local part of the original return path ends in
36340 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36341 local part and domain of the recipient into the return path. Suppose, for
36342 example, that a message whose return path has been set to
36343 &'somelist-request@your.dom.example'& is sent to
36344 &'subscriber@other.dom.example'&. In the transport, the return path is
36345 rewritten as
36346 .code
36347 somelist-request+subscriber=other.dom.example@your.dom.example
36348 .endd
36349 .vindex "&$local_part$&"
36350 For this to work, you must tell Exim to send multiple copies of messages that
36351 have more than one recipient, so that each copy has just one recipient. This is
36352 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36353 might be sent to several different recipients in the same domain, in which case
36354 &$local_part$& is not available in the transport, because it is not unique.
36355
36356 Unless your host is doing nothing but mailing list deliveries, you should
36357 probably use a separate transport for the VERP deliveries, so as not to use
36358 extra resources in making one-per-recipient copies for other deliveries. This
36359 can easily be done by expanding the &%transport%& option in the router:
36360 .code
36361 dnslookup:
36362   driver = dnslookup
36363   domains = ! +local_domains
36364   transport = \
36365     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36366       {verp_smtp}{remote_smtp}}
36367   no_more
36368 .endd
36369 If you want to change the return path using &%errors_to%& in a router instead
36370 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36371 routers that handle mailing list addresses. This will ensure that all delivery
36372 errors, including those detected on the local host, are sent to the VERP
36373 address.
36374
36375 On a host that does no local deliveries and has no manual routing, only the
36376 &(dnslookup)& router needs to be changed. A special transport is not needed for
36377 SMTP deliveries. Every mailing list recipient has its own return path value,
36378 and so Exim must hand them to the transport one at a time. Here is an example
36379 of a &(dnslookup)& router that implements VERP:
36380 .code
36381 verp_dnslookup:
36382   driver = dnslookup
36383   domains = ! +local_domains
36384   transport = remote_smtp
36385   errors_to = \
36386     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36387      {$1-request+$local_part=$domain@your.dom.example}fail}
36388   no_more
36389 .endd
36390 Before you start sending out messages with VERPed return paths, you must also
36391 configure Exim to accept the bounce messages that come back to those paths.
36392 Typically this is done by setting a &%local_part_suffix%& option for a
36393 router, and using this to route the messages to wherever you want to handle
36394 them.
36395
36396 The overhead incurred in using VERP depends very much on the size of the
36397 message, the number of recipient addresses that resolve to the same remote
36398 host, and the speed of the connection over which the message is being sent. If
36399 a lot of addresses resolve to the same host and the connection is slow, sending
36400 a separate copy of the message for each address may take substantially longer
36401 than sending a single copy with many recipients (for which VERP cannot be
36402 used).
36403
36404
36405
36406
36407
36408
36409 .section "Virtual domains" "SECTvirtualdomains"
36410 .cindex "virtual domains"
36411 .cindex "domain" "virtual"
36412 The phrase &'virtual domain'& is unfortunately used with two rather different
36413 meanings:
36414
36415 .ilist
36416 A domain for which there are no real mailboxes; all valid local parts are
36417 aliases for other email addresses. Common examples are organizational
36418 top-level domains and &"vanity"& domains.
36419 .next
36420 One of a number of independent domains that are all handled by the same host,
36421 with mailboxes on that host, but where the mailbox owners do not necessarily
36422 have login accounts on that host.
36423 .endlist
36424
36425 The first usage is probably more common, and does seem more &"virtual"& than
36426 the second. This kind of domain can be handled in Exim with a straightforward
36427 aliasing router. One approach is to create a separate alias file for each
36428 virtual domain. Exim can test for the existence of the alias file to determine
36429 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36430 to a router of this form:
36431 .code
36432 virtual:
36433   driver = redirect
36434   domains = dsearch;/etc/mail/virtual
36435   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36436   no_more
36437 .endd
36438 The &%domains%& option specifies that the router is to be skipped, unless there
36439 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36440 domain that is being processed. When the router runs, it looks up the local
36441 part in the file to find a new address (or list of addresses). The &%no_more%&
36442 setting ensures that if the lookup fails (leading to &%data%& being an empty
36443 string), Exim gives up on the address without trying any subsequent routers.
36444
36445 This one router can handle all the virtual domains because the alias filenames
36446 follow a fixed pattern. Permissions can be arranged so that appropriate people
36447 can edit the different alias files. A successful aliasing operation results in
36448 a new envelope recipient address, which is then routed from scratch.
36449
36450 The other kind of &"virtual"& domain can also be handled in a straightforward
36451 way. One approach is to create a file for each domain containing a list of
36452 valid local parts, and use it in a router like this:
36453 .code
36454 my_domains:
36455   driver = accept
36456   domains = dsearch;/etc/mail/domains
36457   local_parts = lsearch;/etc/mail/domains/$domain
36458   transport = my_mailboxes
36459 .endd
36460 The address is accepted if there is a file for the domain, and the local part
36461 can be found in the file. The &%domains%& option is used to check for the
36462 file's existence because &%domains%& is tested before the &%local_parts%&
36463 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36464 because that option is tested after &%local_parts%&. The transport is as
36465 follows:
36466 .code
36467 my_mailboxes:
36468   driver = appendfile
36469   file = /var/mail/$domain/$local_part
36470   user = mail
36471 .endd
36472 This uses a directory of mailboxes for each domain. The &%user%& setting is
36473 required, to specify which uid is to be used for writing to the mailboxes.
36474
36475 The configuration shown here is just one example of how you might support this
36476 requirement. There are many other ways this kind of configuration can be set
36477 up, for example, by using a database instead of separate files to hold all the
36478 information about the domains.
36479
36480
36481
36482 .section "Multiple user mailboxes" "SECTmulbox"
36483 .cindex "multiple mailboxes"
36484 .cindex "mailbox" "multiple"
36485 .cindex "local part" "prefix"
36486 .cindex "local part" "suffix"
36487 Heavy email users often want to operate with multiple mailboxes, into which
36488 incoming mail is automatically sorted. A popular way of handling this is to
36489 allow users to use multiple sender addresses, so that replies can easily be
36490 identified. Users are permitted to add prefixes or suffixes to their local
36491 parts for this purpose. The wildcard facility of the generic router options
36492 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36493 example, consider this router:
36494 .code
36495 userforward:
36496   driver = redirect
36497   check_local_user
36498   file = $home/.forward
36499   local_part_suffix = -*
36500   local_part_suffix_optional
36501   allow_filter
36502 .endd
36503 .vindex "&$local_part_suffix$&"
36504 It runs a user's &_.forward_& file for all local parts of the form
36505 &'username-*'&. Within the filter file the user can distinguish different
36506 cases by testing the variable &$local_part_suffix$&. For example:
36507 .code
36508 if $local_part_suffix contains -special then
36509 save /home/$local_part/Mail/special
36510 endif
36511 .endd
36512 If the filter file does not exist, or does not deal with such addresses, they
36513 fall through to subsequent routers, and, assuming no subsequent use of the
36514 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36515 control over which suffixes are valid.
36516
36517 Alternatively, a suffix can be used to trigger the use of a different
36518 &_.forward_& file &-- which is the way a similar facility is implemented in
36519 another MTA:
36520 .code
36521 userforward:
36522   driver = redirect
36523   check_local_user
36524   file = $home/.forward$local_part_suffix
36525   local_part_suffix = -*
36526   local_part_suffix_optional
36527   allow_filter
36528 .endd
36529 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36530 example, &_.forward-special_& is used. Once again, if the appropriate file
36531 does not exist, or does not deal with the address, it is passed on to
36532 subsequent routers, which could, if required, look for an unqualified
36533 &_.forward_& file to use as a default.
36534
36535
36536
36537 .section "Simplified vacation processing" "SECID244"
36538 .cindex "vacation processing"
36539 The traditional way of running the &'vacation'& program is for a user to set up
36540 a pipe command in a &_.forward_& file
36541 (see section &<<SECTspecitredli>>& for syntax details).
36542 This is prone to error by inexperienced users. There are two features of Exim
36543 that can be used to make this process simpler for users:
36544
36545 .ilist
36546 A local part prefix such as &"vacation-"& can be specified on a router which
36547 can cause the message to be delivered directly to the &'vacation'& program, or
36548 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36549 &_.forward_& file are then much simpler. For example:
36550 .code
36551 spqr, vacation-spqr
36552 .endd
36553 .next
36554 The &%require_files%& generic router option can be used to trigger a
36555 vacation delivery by checking for the existence of a certain file in the
36556 user's home directory. The &%unseen%& generic option should also be used, to
36557 ensure that the original delivery also proceeds. In this case, all the user has
36558 to do is to create a file called, say, &_.vacation_&, containing a vacation
36559 message.
36560 .endlist
36561
36562 Another advantage of both these methods is that they both work even when the
36563 use of arbitrary pipes by users is locked out.
36564
36565
36566
36567 .section "Taking copies of mail" "SECID245"
36568 .cindex "message" "copying every"
36569 Some installations have policies that require archive copies of all messages to
36570 be made. A single copy of each message can easily be taken by an appropriate
36571 command in a system filter, which could, for example, use a different file for
36572 each day's messages.
36573
36574 There is also a shadow transport mechanism that can be used to take copies of
36575 messages that are successfully delivered by local transports, one copy per
36576 delivery. This could be used, &'inter alia'&, to implement automatic
36577 notification of delivery by sites that insist on doing such things.
36578
36579
36580
36581 .section "Intermittently connected hosts" "SECID246"
36582 .cindex "intermittently connected hosts"
36583 It has become quite common (because it is cheaper) for hosts to connect to the
36584 Internet periodically rather than remain connected all the time. The normal
36585 arrangement is that mail for such hosts accumulates on a system that is
36586 permanently connected.
36587
36588 Exim was designed for use on permanently connected hosts, and so it is not
36589 particularly well-suited to use in an intermittently connected environment.
36590 Nevertheless there are some features that can be used.
36591
36592
36593 .section "Exim on the upstream server host" "SECID247"
36594 It is tempting to arrange for incoming mail for the intermittently connected
36595 host to remain in Exim's queue until the client connects. However, this
36596 approach does not scale very well. Two different kinds of waiting message are
36597 being mixed up in the same queue &-- those that cannot be delivered because of
36598 some temporary problem, and those that are waiting for their destination host
36599 to connect. This makes it hard to manage the queue, as well as wasting
36600 resources, because each queue runner scans the entire queue.
36601
36602 A better approach is to separate off those messages that are waiting for an
36603 intermittently connected host. This can be done by delivering these messages
36604 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36605 format, from where they are transmitted by other software when their
36606 destination connects. This makes it easy to collect all the mail for one host
36607 in a single directory, and to apply local timeout rules on a per-message basis
36608 if required.
36609
36610 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36611 you are doing this, you should configure Exim with a long retry period for the
36612 intermittent host. For example:
36613 .code
36614 cheshire.wonderland.fict.example    *   F,5d,24h
36615 .endd
36616 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36617 which messages it has queued up for that host. Once the intermittent host comes
36618 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36619 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36620 causes all the queued up messages to be delivered, often down a single SMTP
36621 connection. While the host remains connected, any new messages get delivered
36622 immediately.
36623
36624 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36625 issued with a different IP address each time it connects, Exim's retry
36626 mechanisms on the holding host get confused, because the IP address is normally
36627 used as part of the key string for holding retry information. This can be
36628 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36629 Since this has disadvantages for permanently connected hosts, it is best to
36630 arrange a separate transport for the intermittently connected ones.
36631
36632
36633
36634 .section "Exim on the intermittently connected client host" "SECID248"
36635 The value of &%smtp_accept_queue_per_connection%& should probably be
36636 increased, or even set to zero (that is, disabled) on the intermittently
36637 connected host, so that all incoming messages down a single connection get
36638 delivered immediately.
36639
36640 .cindex "SMTP" "passed connection"
36641 .cindex "SMTP" "multiple deliveries"
36642 .cindex "multiple SMTP deliveries"
36643 Mail waiting to be sent from an intermittently connected host will probably
36644 not have been routed, because without a connection DNS lookups are not
36645 possible. This means that if a normal queue run is done at connection time,
36646 each message is likely to be sent in a separate SMTP session. This can be
36647 avoided by starting the queue run with a command line option beginning with
36648 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36649 first pass, routing is done but no deliveries take place. The second pass is a
36650 normal queue run; since all the messages have been previously routed, those
36651 destined for the same host are likely to get sent as multiple deliveries in a
36652 single SMTP connection.
36653
36654
36655
36656 . ////////////////////////////////////////////////////////////////////////////
36657 . ////////////////////////////////////////////////////////////////////////////
36658
36659 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36660          "Exim as a non-queueing client"
36661 .cindex "client, non-queueing"
36662 .cindex "smart host" "suppressing queueing"
36663 On a personal computer, it is a common requirement for all
36664 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36665 configured to operate that way, for all the popular operating systems.
36666 However, there are some MUAs for Unix-like systems that cannot be so
36667 configured: they submit messages using the command line interface of
36668 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36669 messages this way.
36670
36671 If the personal computer runs continuously, there is no problem, because it can
36672 run a conventional MTA that handles delivery to the smart host, and deal with
36673 any delays via its queueing mechanism. However, if the computer does not run
36674 continuously or runs different operating systems at different times, queueing
36675 email is not desirable.
36676
36677 There is therefore a requirement for something that can provide the
36678 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36679 any queueing or retrying facilities. Furthermore, the delivery to the smart
36680 host should be synchronous, so that if it fails, the sending MUA is immediately
36681 informed. In other words, we want something that extends an MUA that submits
36682 to a local MTA via the command line so that it behaves like one that submits
36683 to a remote smart host using TCP/SMTP.
36684
36685 There are a number of applications (for example, there is one called &'ssmtp'&)
36686 that do this job. However, people have found them to be lacking in various
36687 ways. For instance, you might want to allow aliasing and forwarding to be done
36688 before sending a message to the smart host.
36689
36690 Exim already had the necessary infrastructure for doing this job. Just a few
36691 tweaks were needed to make it behave as required, though it is somewhat of an
36692 overkill to use a fully-featured MTA for this purpose.
36693
36694 .oindex "&%mua_wrapper%&"
36695 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36696 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36697 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36698 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36699 compatible router and transport configuration. Typically there will be just one
36700 router and one transport, sending everything to a smart host.
36701
36702 When run in MUA wrapping mode, the behaviour of Exim changes in the
36703 following ways:
36704
36705 .ilist
36706 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36707 In other words, the only way to submit messages is via the command line.
36708 .next
36709 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36710 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36711 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36712 does not finish until the delivery attempt is complete. If the delivery is
36713 successful, a zero return code is given.
36714 .next
36715 Address redirection is permitted, but the final routing for all addresses must
36716 be to the same remote transport, and to the same list of hosts. Furthermore,
36717 the return address (envelope sender) must be the same for all recipients, as
36718 must any added or deleted header lines. In other words, it must be possible to
36719 deliver the message in a single SMTP transaction, however many recipients there
36720 are.
36721 .next
36722 If these conditions are not met, or if routing any address results in a
36723 failure or defer status, or if Exim is unable to deliver all the recipients
36724 successfully to one of the smart hosts, delivery of the entire message fails.
36725 .next
36726 Because no queueing is allowed, all failures are treated as permanent; there
36727 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36728 smart host. Furthermore, because only a single yes/no response can be given to
36729 the caller, it is not possible to deliver to some recipients and not others. If
36730 there is an error (temporary or permanent) for any recipient, all are failed.
36731 .next
36732 If more than one smart host is listed, Exim will try another host after a
36733 connection failure or a timeout, in the normal way. However, if this kind of
36734 failure happens for all the hosts, the delivery fails.
36735 .next
36736 When delivery fails, an error message is written to the standard error stream
36737 (as well as to Exim's log), and Exim exits to the caller with a return code
36738 value 1. The message is expunged from Exim's spool files. No bounce messages
36739 are ever generated.
36740 .next
36741 No retry data is maintained, and any retry rules are ignored.
36742 .next
36743 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36744 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36745 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36746 .endlist
36747
36748 The overall effect is that Exim makes a single synchronous attempt to deliver
36749 the message, failing if there is any kind of problem. Because no local
36750 deliveries are done and no daemon can be run, Exim does not need root
36751 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36752 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36753 the advantages and disadvantages of running without root privilege.
36754
36755
36756
36757
36758 . ////////////////////////////////////////////////////////////////////////////
36759 . ////////////////////////////////////////////////////////////////////////////
36760
36761 .chapter "Log files" "CHAPlog"
36762 .scindex IIDloggen "log" "general description"
36763 .cindex "log" "types of"
36764 Exim writes three different logs, referred to as the main log, the reject log,
36765 and the panic log:
36766
36767 .ilist
36768 .cindex "main log"
36769 The main log records the arrival of each message and each delivery in a single
36770 line in each case. The format is as compact as possible, in an attempt to keep
36771 down the size of log files. Two-character flag sequences make it easy to pick
36772 out these lines. A number of other events are recorded in the main log. Some of
36773 them are optional, in which case the &%log_selector%& option controls whether
36774 they are included or not. A Perl script called &'eximstats'&, which does simple
36775 analysis of main log files, is provided in the Exim distribution (see section
36776 &<<SECTmailstat>>&).
36777 .next
36778 .cindex "reject log"
36779 The reject log records information from messages that are rejected as a result
36780 of a configuration option (that is, for policy reasons).
36781 The first line of each rejection is a copy of the line that is also written to
36782 the main log. Then, if the message's header has been read at the time the log
36783 is written, its contents are written to this log. Only the original header
36784 lines are available; header lines added by ACLs are not logged. You can use the
36785 reject log to check that your policy controls are working correctly; on a busy
36786 host this may be easier than scanning the main log for rejection messages. You
36787 can suppress the writing of the reject log by setting &%write_rejectlog%&
36788 false.
36789 .next
36790 .cindex "panic log"
36791 .cindex "system log"
36792 When certain serious errors occur, Exim writes entries to its panic log. If the
36793 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36794 are usually written to the main log as well, but can get lost amid the mass of
36795 other entries. The panic log should be empty under normal circumstances. It is
36796 therefore a good idea to check it (or to have a &'cron'& script check it)
36797 regularly, in order to become aware of any problems. When Exim cannot open its
36798 panic log, it tries as a last resort to write to the system log (syslog). This
36799 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36800 message itself is written at priority LOG_CRIT.
36801 .endlist
36802
36803 Every log line starts with a timestamp, in the format shown in the following
36804 example. Note that many of the examples shown in this chapter are line-wrapped.
36805 In the log file, this would be all on one line:
36806 .code
36807 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36808   by QUIT
36809 .endd
36810 By default, the timestamps are in the local timezone. There are two
36811 ways of changing this:
36812
36813 .ilist
36814 You can set the &%timezone%& option to a different time zone; in particular, if
36815 you set
36816 .code
36817 timezone = UTC
36818 .endd
36819 the timestamps will be in UTC (aka GMT).
36820 .next
36821 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36822 example:
36823 .code
36824 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36825 .endd
36826 .endlist
36827
36828 .cindex "log" "process ids in"
36829 .cindex "pid (process id)" "in log lines"
36830 Exim does not include its process id in log lines by default, but you can
36831 request that it does so by specifying the &`pid`& log selector (see section
36832 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36833 brackets, immediately after the time and date.
36834
36835
36836
36837
36838 .section "Where the logs are written" "SECTwhelogwri"
36839 .cindex "log" "destination"
36840 .cindex "log" "to file"
36841 .cindex "log" "to syslog"
36842 .cindex "syslog"
36843 The logs may be written to local files, or to syslog, or both. However, it
36844 should be noted that many syslog implementations use UDP as a transport, and
36845 are therefore unreliable in the sense that messages are not guaranteed to
36846 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36847 It has also been reported that on large log files (tens of megabytes) you may
36848 need to tweak syslog to prevent it syncing the file with each write &-- on
36849 Linux this has been seen to make syslog take 90% plus of CPU time.
36850
36851 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36852 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36853 configuration. This latter string is expanded, so it can contain, for example,
36854 references to the host name:
36855 .code
36856 log_file_path = /var/log/$primary_hostname/exim_%slog
36857 .endd
36858 It is generally advisable, however, to set the string in &_Local/Makefile_&
36859 rather than at runtime, because then the setting is available right from the
36860 start of Exim's execution. Otherwise, if there's something it wants to log
36861 before it has read the configuration file (for example, an error in the
36862 configuration file) it will not use the path you want, and may not be able to
36863 log at all.
36864
36865 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36866 list, currently limited to at most two items. This is one option where the
36867 facility for changing a list separator may not be used. The list must always be
36868 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36869 otherwise the item must either be an absolute path, containing &`%s`& at the
36870 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36871 implying the use of a default path.
36872
36873 When Exim encounters an empty item in the list, it searches the list defined by
36874 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36875 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36876 mean &"use the path specified at build time"&. It no such item exists, log
36877 files are written in the &_log_& subdirectory of the spool directory. This is
36878 equivalent to the setting:
36879 .code
36880 log_file_path = $spool_directory/log/%slog
36881 .endd
36882 If you do not specify anything at build time or runtime,
36883 or if you unset the option at runtime (i.e. &`log_file_path = `&),
36884 that is where the logs are written.
36885
36886 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
36887 are in use &-- see section &<<SECTdatlogfil>>& below.
36888
36889 Here are some examples of possible settings:
36890 .display
36891 &`LOG_FILE_PATH=syslog                    `& syslog only
36892 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36893 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36894 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36895 .endd
36896 If there are more than two paths in the list, the first is used and a panic
36897 error is logged.
36898
36899
36900
36901 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36902 .cindex "log" "cycling local files"
36903 .cindex "cycling logs"
36904 .cindex "&'exicyclog'&"
36905 .cindex "log" "local files; writing to"
36906 Some operating systems provide centralized and standardized methods for cycling
36907 log files. For those that do not, a utility script called &'exicyclog'& is
36908 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36909 main and reject logs each time it is called. The maximum number of old logs to
36910 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36911
36912 An Exim delivery process opens the main log when it first needs to write to it,
36913 and it keeps the file open in case subsequent entries are required &-- for
36914 example, if a number of different deliveries are being done for the same
36915 message. However, remote SMTP deliveries can take a long time, and this means
36916 that the file may be kept open long after it is renamed if &'exicyclog'& or
36917 something similar is being used to rename log files on a regular basis. To
36918 ensure that a switch of log files is noticed as soon as possible, Exim calls
36919 &[stat()]& on the main log's name before reusing an open file, and if the file
36920 does not exist, or its inode has changed, the old file is closed and Exim
36921 tries to open the main log from scratch. Thus, an old log file may remain open
36922 for quite some time, but no Exim processes should write to it once it has been
36923 renamed.
36924
36925
36926
36927 .section "Datestamped log files" "SECTdatlogfil"
36928 .cindex "log" "datestamped files"
36929 Instead of cycling the main and reject log files by renaming them
36930 periodically, some sites like to use files whose names contain a datestamp,
36931 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36932 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36933 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36934 point where the datestamp is required. For example:
36935 .code
36936 log_file_path = /var/spool/exim/log/%slog-%D
36937 log_file_path = /var/log/exim-%s-%D.log
36938 log_file_path = /var/spool/exim/log/%D-%slog
36939 log_file_path = /var/log/exim/%s.%M
36940 .endd
36941 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36942 examples of names generated by the above examples:
36943 .code
36944 /var/spool/exim/log/mainlog-20021225
36945 /var/log/exim-reject-20021225.log
36946 /var/spool/exim/log/20021225-mainlog
36947 /var/log/exim/main.200212
36948 .endd
36949 When this form of log file is specified, Exim automatically switches to new
36950 files at midnight. It does not make any attempt to compress old logs; you
36951 will need to write your own script if you require this. You should not
36952 run &'exicyclog'& with this form of logging.
36953
36954 The location of the panic log is also determined by &%log_file_path%&, but it
36955 is not datestamped, because rotation of the panic log does not make sense.
36956 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36957 the string. In addition, if it immediately follows a slash, a following
36958 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36959 character is removed. Thus, the four examples above would give these panic
36960 log names:
36961 .code
36962 /var/spool/exim/log/paniclog
36963 /var/log/exim-panic.log
36964 /var/spool/exim/log/paniclog
36965 /var/log/exim/panic
36966 .endd
36967
36968
36969 .section "Logging to syslog" "SECID249"
36970 .cindex "log" "syslog; writing to"
36971 The use of syslog does not change what Exim logs or the format of its messages,
36972 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36973 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36974 that, the same strings are written to syslog as to log files. The syslog
36975 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36976 by default, but you can change these by setting the &%syslog_facility%& and
36977 &%syslog_processname%& options, respectively. If Exim was compiled with
36978 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36979 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36980 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36981 the time and host name to each line.
36982 The three log streams are mapped onto syslog priorities as follows:
36983
36984 .ilist
36985 &'mainlog'& is mapped to LOG_INFO
36986 .next
36987 &'rejectlog'& is mapped to LOG_NOTICE
36988 .next
36989 &'paniclog'& is mapped to LOG_ALERT
36990 .endlist
36991
36992 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36993 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36994 these are routed by syslog to the same place. You can suppress this duplication
36995 by setting &%syslog_duplication%& false.
36996
36997 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36998 entries contain multiple lines when headers are included. To cope with both
36999 these cases, entries written to syslog are split into separate &[syslog()]&
37000 calls at each internal newline, and also after a maximum of
37001 870 data characters. (This allows for a total syslog line length of 1024, when
37002 additions such as timestamps are added.) If you are running a syslog
37003 replacement that can handle lines longer than the 1024 characters allowed by
37004 RFC 3164, you should set
37005 .code
37006 SYSLOG_LONG_LINES=yes
37007 .endd
37008 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37009 lines, but it still splits at internal newlines in &'reject'& log entries.
37010
37011 To make it easy to re-assemble split lines later, each component of a split
37012 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37013 where <&'n'&> is the component number and <&'m'&> is the total number of
37014 components in the entry. The / delimiter is used when the line was split
37015 because it was too long; if it was split because of an internal newline, the \
37016 delimiter is used. For example, supposing the length limit to be 50 instead of
37017 870, the following would be the result of a typical rejection message to
37018 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37019 name, and pid as added by syslog:
37020 .code
37021 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37022 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37023 [3/5]  when scanning for sender: missing or malformed lo
37024 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37025 [5/5] mple>)
37026 .endd
37027 The same error might cause the following lines to be written to &"rejectlog"&
37028 (LOG_NOTICE):
37029 .code
37030 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37031 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37032 [3/18] er when scanning for sender: missing or malformed
37033 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37034 [5\18] .example>)
37035 [6\18] Recipients: ph10@some.domain.cam.example
37036 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37037 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37038 [9\18]        id 16RdAL-0006pc-00
37039 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37040 [11\18] 09:43 +0100
37041 [12\18] F From: <>
37042 [13\18]   Subject: this is a test header
37043 [18\18]   X-something: this is another header
37044 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37045 [16\18] le>
37046 [17\18] B Bcc:
37047 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37048 .endd
37049 Log lines that are neither too long nor contain newlines are written to syslog
37050 without modification.
37051
37052 If only syslog is being used, the Exim monitor is unable to provide a log tail
37053 display, unless syslog is routing &'mainlog'& to a file on the local host and
37054 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37055 where it is.
37056
37057
37058
37059 .section "Log line flags" "SECID250"
37060 One line is written to the main log for each message received, and for each
37061 successful, unsuccessful, and delayed delivery. These lines can readily be
37062 picked out by the distinctive two-character flags that immediately follow the
37063 timestamp. The flags are:
37064 .display
37065 &`<=`&     message arrival
37066 &`(=`&     message fakereject
37067 &`=>`&     normal message delivery
37068 &`->`&     additional address in same delivery
37069 &`>>`&     cutthrough message delivery
37070 &`*>`&     delivery suppressed by &%-N%&
37071 &`**`&     delivery failed; address bounced
37072 &`==`&     delivery deferred; temporary problem
37073 .endd
37074
37075
37076 .section "Logging message reception" "SECID251"
37077 .cindex "log" "reception line"
37078 The format of the single-line entry in the main log that is written for every
37079 message received is shown in the basic example below, which is split over
37080 several lines in order to fit it on the page:
37081 .code
37082 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37083   H=mailer.fict.example [192.168.123.123] U=exim
37084   P=smtp S=5678 id=<incoming message id>
37085 .endd
37086 The address immediately following &"<="& is the envelope sender address. A
37087 bounce message is shown with the sender address &"<>"&, and if it is locally
37088 generated, this is followed by an item of the form
37089 .code
37090 R=<message id>
37091 .endd
37092 which is a reference to the message that caused the bounce to be sent.
37093
37094 .cindex "HELO"
37095 .cindex "EHLO"
37096 For messages from other hosts, the H and U fields identify the remote host and
37097 record the RFC 1413 identity of the user that sent the message, if one was
37098 received. The number given in square brackets is the IP address of the sending
37099 host. If there is a single, unparenthesized  host name in the H field, as
37100 above, it has been verified to correspond to the IP address (see the
37101 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37102 by the remote host in the SMTP HELO or EHLO command, and has not been
37103 verified. If verification yields a different name to that given for HELO or
37104 EHLO, the verified name appears first, followed by the HELO or EHLO
37105 name in parentheses.
37106
37107 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37108 without brackets, in the HELO or EHLO command, leading to entries in
37109 the log containing text like these examples:
37110 .code
37111 H=(10.21.32.43) [192.168.8.34]
37112 H=([10.21.32.43]) [192.168.8.34]
37113 .endd
37114 This can be confusing. Only the final address in square brackets can be relied
37115 on.
37116
37117 For locally generated messages (that is, messages not received over TCP/IP),
37118 the H field is omitted, and the U field contains the login name of the caller
37119 of Exim.
37120
37121 .cindex "authentication" "logging"
37122 .cindex "AUTH" "logging"
37123 For all messages, the P field specifies the protocol used to receive the
37124 message. This is the value that is stored in &$received_protocol$&. In the case
37125 of incoming SMTP messages, the value indicates whether or not any SMTP
37126 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37127 session was encrypted, there is an additional X field that records the cipher
37128 suite that was used.
37129
37130 .cindex log protocol
37131 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37132 hosts that have authenticated themselves using the SMTP AUTH command. The first
37133 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37134 there is an additional item A= followed by the name of the authenticator that
37135 was used. If an authenticated identification was set up by the authenticator's
37136 &%server_set_id%& option, this is logged too, separated by a colon from the
37137 authenticator name.
37138
37139 .cindex "size" "of message"
37140 The id field records the existing message id, if present. The size of the
37141 received message is given by the S field. When the message is delivered,
37142 headers may be removed or added, so that the size of delivered copies of the
37143 message may not correspond with this value (and indeed may be different to each
37144 other).
37145
37146 The &%log_selector%& option can be used to request the logging of additional
37147 data when a message is received. See section &<<SECTlogselector>>& below.
37148
37149
37150
37151 .section "Logging deliveries" "SECID252"
37152 .cindex "log" "delivery line"
37153 The format of the single-line entry in the main log that is written for every
37154 delivery is shown in one of the examples below, for local and remote
37155 deliveries, respectively. Each example has been split into multiple lines in order
37156 to fit it on the page:
37157 .code
37158 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37159   <marv@hitch.fict.example> R=localuser T=local_delivery
37160 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37161   monk@holistic.fict.example R=dnslookup T=remote_smtp
37162   H=holistic.fict.example [192.168.234.234]
37163 .endd
37164 For ordinary local deliveries, the original address is given in angle brackets
37165 after the final delivery address, which might be a pipe or a file. If
37166 intermediate address(es) exist between the original and the final address, the
37167 last of these is given in parentheses after the final address. The R and T
37168 fields record the router and transport that were used to process the address.
37169
37170 If SMTP AUTH was used for the delivery there is an additional item A=
37171 followed by the name of the authenticator that was used.
37172 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37173 option, this is logged too, separated by a colon from the authenticator name.
37174
37175 If a shadow transport was run after a successful local delivery, the log line
37176 for the successful delivery has an item added on the end, of the form
37177 .display
37178 &`ST=<`&&'shadow transport name'&&`>`&
37179 .endd
37180 If the shadow transport did not succeed, the error message is put in
37181 parentheses afterwards.
37182
37183 .cindex "asterisk" "after IP address"
37184 When more than one address is included in a single delivery (for example, two
37185 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37186 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37187 down a single SMTP connection, an asterisk follows the IP address in the log
37188 lines for the second and subsequent messages.
37189 When two or more messages are delivered down a single TLS connection, the
37190 DNS and some TLS-related information logged for the first message delivered
37191 will not be present in the log lines for the second and subsequent messages.
37192 TLS cipher information is still available.
37193
37194 .cindex "delivery" "cutthrough; logging"
37195 .cindex "cutthrough" "logging"
37196 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37197 line precedes the reception line, since cutthrough waits for a possible
37198 rejection from the destination in case it can reject the sourced item.
37199
37200 The generation of a reply message by a filter file gets logged as a
37201 &"delivery"& to the addressee, preceded by &">"&.
37202
37203 The &%log_selector%& option can be used to request the logging of additional
37204 data when a message is delivered. See section &<<SECTlogselector>>& below.
37205
37206
37207 .section "Discarded deliveries" "SECID253"
37208 .cindex "discarded messages"
37209 .cindex "message" "discarded"
37210 .cindex "delivery" "discarded; logging"
37211 When a message is discarded as a result of the command &"seen finish"& being
37212 obeyed in a filter file which generates no deliveries, a log entry of the form
37213 .code
37214 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37215   <low.club@bridge.example> R=userforward
37216 .endd
37217 is written, to record why no deliveries are logged. When a message is discarded
37218 because it is aliased to &":blackhole:"& the log line is like this:
37219 .code
37220 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37221   <hole@nowhere.example> R=blackhole_router
37222 .endd
37223
37224
37225 .section "Deferred deliveries" "SECID254"
37226 When a delivery is deferred, a line of the following form is logged:
37227 .code
37228 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37229   R=dnslookup T=smtp defer (146): Connection refused
37230 .endd
37231 In the case of remote deliveries, the error is the one that was given for the
37232 last IP address that was tried. Details of individual SMTP failures are also
37233 written to the log, so the above line would be preceded by something like
37234 .code
37235 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37236   mail1.endrest.example [192.168.239.239]: Connection refused
37237 .endd
37238 When a deferred address is skipped because its retry time has not been reached,
37239 a message is written to the log, but this can be suppressed by setting an
37240 appropriate value in &%log_selector%&.
37241
37242
37243
37244 .section "Delivery failures" "SECID255"
37245 .cindex "delivery" "failure; logging"
37246 If a delivery fails because an address cannot be routed, a line of the
37247 following form is logged:
37248 .code
37249 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37250   <jim@trek99.example>: unknown mail domain
37251 .endd
37252 If a delivery fails at transport time, the router and transport are shown, and
37253 the response from the remote host is included, as in this example:
37254 .code
37255 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37256   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37257   after pipelined RCPT TO:<ace400@pb.example>: host
37258   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37259   <ace400@pb.example>...Addressee unknown
37260 .endd
37261 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37262 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37263 disabling PIPELINING. The log lines for all forms of delivery failure are
37264 flagged with &`**`&.
37265
37266
37267
37268 .section "Fake deliveries" "SECID256"
37269 .cindex "delivery" "fake; logging"
37270 If a delivery does not actually take place because the &%-N%& option has been
37271 used to suppress it, a normal delivery line is written to the log, except that
37272 &"=>"& is replaced by &"*>"&.
37273
37274
37275
37276 .section "Completion" "SECID257"
37277 A line of the form
37278 .code
37279 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37280 .endd
37281 is written to the main log when a message is about to be removed from the spool
37282 at the end of its processing.
37283
37284
37285
37286
37287 .section "Summary of Fields in Log Lines" "SECID258"
37288 .cindex "log" "summary of fields"
37289 A summary of the field identifiers that are used in log lines is shown in
37290 the following table:
37291 .display
37292 &`A   `&        authenticator name (and optional id and sender)
37293 &`C   `&        SMTP confirmation on delivery
37294 &`    `&        command list for &"no mail in SMTP session"&
37295 &`CV  `&        certificate verification status
37296 &`D   `&        duration of &"no mail in SMTP session"&
37297 &`DKIM`&        domain verified in incoming message
37298 &`DN  `&        distinguished name from peer certificate
37299 &`DS  `&        DNSSEC secured lookups
37300 &`DT  `&        on &`=>`& lines: time taken for a delivery
37301 &`F   `&        sender address (on delivery lines)
37302 &`H   `&        host name and IP address
37303 &`I   `&        local interface used
37304 &`id  `&        message id (from header) for incoming message
37305 &`K   `&        CHUNKING extension used
37306 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37307 &`M8S `&        8BITMIME status for incoming message
37308 &`P   `&        on &`<=`& lines: protocol used
37309 &`    `&        on &`=>`& and &`**`& lines: return path
37310 &`PRDR`&        PRDR extension used
37311 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37312 &`Q   `&        alternate queue name
37313 &`QT  `&        on &`=>`& lines: time spent on queue so far
37314 &`    `&        on &"Completed"& lines: time spent on queue
37315 &`R   `&        on &`<=`& lines: reference for local bounce
37316 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37317 &`RT  `&        on &`<=`& lines: time taken for reception
37318 &`S   `&        size of message in bytes
37319 &`SNI `&        server name indication from TLS client hello
37320 &`ST  `&        shadow transport name
37321 &`T   `&        on &`<=`& lines: message subject (topic)
37322 &`TFO `&        connection took advantage of TCP Fast Open
37323 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37324 &`U   `&        local user or RFC 1413 identity
37325 &`X   `&        TLS cipher suite
37326 .endd
37327
37328
37329 .section "Other log entries" "SECID259"
37330 Various other types of log entry are written from time to time. Most should be
37331 self-explanatory. Among the more common are:
37332
37333 .ilist
37334 .cindex "retry" "time not reached"
37335 &'retry time not reached'&&~&~An address previously suffered a temporary error
37336 during routing or local delivery, and the time to retry has not yet arrived.
37337 This message is not written to an individual message log file unless it happens
37338 during the first delivery attempt.
37339 .next
37340 &'retry time not reached for any host'&&~&~An address previously suffered
37341 temporary errors during remote delivery, and the retry time has not yet arrived
37342 for any of the hosts to which it is routed.
37343 .next
37344 .cindex "spool directory" "file locked"
37345 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37346 some other Exim process is already working on the message. This can be quite
37347 common if queue running processes are started at frequent intervals. The
37348 &'exiwhat'& utility script can be used to find out what Exim processes are
37349 doing.
37350 .next
37351 .cindex "error" "ignored"
37352 &'error ignored'&&~&~There are several circumstances that give rise to this
37353 message:
37354 .olist
37355 Exim failed to deliver a bounce message whose age was greater than
37356 &%ignore_bounce_errors_after%&. The bounce was discarded.
37357 .next
37358 A filter file set up a delivery using the &"noerror"& option, and the delivery
37359 failed. The delivery was discarded.
37360 .next
37361 A delivery set up by a router configured with
37362 . ==== As this is a nested list, any displays it contains must be indented
37363 . ==== as otherwise they are too far to the left.
37364 .code
37365     errors_to = <>
37366 .endd
37367 failed. The delivery was discarded.
37368 .endlist olist
37369 .next
37370 .cindex DKIM "log line"
37371 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37372 logging and the message has a DKIM signature header.
37373 .endlist ilist
37374
37375
37376
37377
37378
37379 .section "Reducing or increasing what is logged" "SECTlogselector"
37380 .cindex "log" "selectors"
37381 By setting the &%log_selector%& global option, you can disable some of Exim's
37382 default logging, or you can request additional logging. The value of
37383 &%log_selector%& is made up of names preceded by plus or minus characters. For
37384 example:
37385 .code
37386 log_selector = +arguments -retry_defer
37387 .endd
37388 The list of optional log items is in the following table, with the default
37389 selection marked by asterisks:
37390 .display
37391 &` 8bitmime                   `&  received 8BITMIME status
37392 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37393 &` address_rewrite            `&  address rewriting
37394 &` all_parents                `&  all parents in => lines
37395 &` arguments                  `&  command line arguments
37396 &`*connection_reject          `&  connection rejections
37397 &`*delay_delivery             `&  immediate delivery delayed
37398 &` deliver_time               `&  time taken to perform delivery
37399 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37400 &`*dkim                       `&  DKIM verified domain on <= lines
37401 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37402 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37403 &` dnssec                     `&  DNSSEC secured lookups
37404 &`*etrn                       `&  ETRN commands
37405 &`*host_lookup_failed         `&  as it says
37406 &` ident_timeout              `&  timeout for ident connection
37407 &` incoming_interface         `&  local interface on <= and => lines
37408 &` incoming_port              `&  remote port on <= lines
37409 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37410 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37411 &`*msg_id                     `&  on <= lines, Message-ID: header value
37412 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37413 &` outgoing_interface         `&  local interface on => lines
37414 &` outgoing_port              `&  add remote port to => lines
37415 &`*queue_run                  `&  start and end queue runs
37416 &` queue_time                 `&  time on queue for one recipient
37417 &` queue_time_overall         `&  time on queue for whole message
37418 &` pid                        `&  Exim process id
37419 &` pipelining                 `&  PIPELINING use, on <= and => lines
37420 &` proxy                      `&  proxy address on <= and => lines
37421 &` receive_time               `&  time taken to receive message
37422 &` received_recipients        `&  recipients on <= lines
37423 &` received_sender            `&  sender on <= lines
37424 &`*rejected_header            `&  header contents on reject log
37425 &`*retry_defer                `&  &"retry time not reached"&
37426 &` return_path_on_delivery    `&  put return path on => and ** lines
37427 &` sender_on_delivery         `&  add sender to => lines
37428 &`*sender_verify_fail         `&  sender verification failures
37429 &`*size_reject                `&  rejection because too big
37430 &`*skip_delivery              `&  delivery skipped in a queue run
37431 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37432 &` smtp_connection            `&  incoming SMTP connections
37433 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37434 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37435 &` smtp_no_mail               `&  session with no MAIL commands
37436 &` smtp_protocol_error        `&  SMTP protocol errors
37437 &` smtp_syntax_error          `&  SMTP syntax errors
37438 &` subject                    `&  contents of &'Subject:'& on <= lines
37439 &`*tls_certificate_verified   `&  certificate verification status
37440 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37441 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37442 &` tls_sni                    `&  TLS SNI on <= lines
37443 &` unknown_in_list            `&  DNS lookup failed in list match
37444
37445 &` all                        `&  all of the above
37446 .endd
37447 See also the &%slow_lookup_log%& main configuration option,
37448 section &<<SECID99>>&
37449
37450 More details on each of these items follows:
37451
37452 .ilist
37453 .cindex "8BITMIME"
37454 .cindex "log" "8BITMIME"
37455 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37456 which may help in tracking down interoperability issues with ancient MTAs
37457 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37458 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37459 &`7BIT`& and &`8BITMIME`& respectively.
37460 .next
37461 .cindex "&%warn%& ACL verb" "log when skipping"
37462 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37463 its conditions cannot be evaluated, a log line to this effect is written if
37464 this log selector is set.
37465 .next
37466 .cindex "log" "rewriting"
37467 .cindex "rewriting" "logging"
37468 &%address_rewrite%&: This applies both to global rewrites and per-transport
37469 rewrites, but not to rewrites in filters run as an unprivileged user (because
37470 such users cannot access the log).
37471 .next
37472 .cindex "log" "full parentage"
37473 &%all_parents%&: Normally only the original and final addresses are logged on
37474 delivery lines; with this selector, intermediate parents are given in
37475 parentheses between them.
37476 .next
37477 .cindex "log" "Exim arguments"
37478 .cindex "Exim arguments, logging"
37479 &%arguments%&: This causes Exim to write the arguments with which it was called
37480 to the main log, preceded by the current working directory. This is a debugging
37481 feature, added to make it easier to find out how certain MUAs call
37482 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37483 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37484 that are empty or that contain white space are quoted. Non-printing characters
37485 are shown as escape sequences. This facility cannot log unrecognized arguments,
37486 because the arguments are checked before the configuration file is read. The
37487 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37488 between the caller and Exim.
37489 .next
37490 .cindex "log" "connection rejections"
37491 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37492 connection is rejected, for whatever reason.
37493 .next
37494 .cindex "log" "delayed delivery"
37495 .cindex "delayed delivery, logging"
37496 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37497 started for an incoming message because the load is too high or too many
37498 messages were received on one connection. Logging does not occur if no delivery
37499 process is started because &%queue_only%& is set or &%-odq%& was used.
37500 .next
37501 .cindex "log" "delivery duration"
37502 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37503 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37504 If millisecond logging is enabled, short times will be shown with greater
37505 precision, eg. &`DT=0.304s`&.
37506 .next
37507 .cindex "log" "message size on delivery"
37508 .cindex "size" "of message"
37509 &%delivery_size%&: For each delivery, the size of message delivered is added to
37510 the &"=>"& line, tagged with S=.
37511 .next
37512 .cindex log "DKIM verification"
37513 .cindex DKIM "verification logging"
37514 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37515 verifies successfully a tag of DKIM is added, with one of the verified domains.
37516 .next
37517 .cindex log "DKIM verification"
37518 .cindex DKIM "verification logging"
37519 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37520 .next
37521 .cindex "log" "dnslist defer"
37522 .cindex "DNS list" "logging defer"
37523 .cindex "black list (DNS)"
37524 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37525 DNS black list suffers a temporary error.
37526 .next
37527 .cindex log dnssec
37528 .cindex dnssec logging
37529 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37530 dns lookups gave secure results a tag of DS is added.
37531 For acceptance this covers the reverse and forward lookups for host name verification.
37532 It does not cover helo-name verification.
37533 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37534 .next
37535 .cindex "log" "ETRN commands"
37536 .cindex "ETRN" "logging"
37537 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37538 is run to determine whether or not it is actually accepted. An invalid ETRN
37539 command, or one received within a message transaction is not logged by this
37540 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37541 .next
37542 .cindex "log" "host lookup failure"
37543 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37544 any addresses, or when a lookup of an IP address fails to find a host name, a
37545 log line is written. This logging does not apply to direct DNS lookups when
37546 routing email addresses, but it does apply to &"byname"& lookups.
37547 .next
37548 .cindex "log" "ident timeout"
37549 .cindex "RFC 1413" "logging timeout"
37550 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37551 client's ident port times out.
37552 .next
37553 .cindex "log" "incoming interface"
37554 .cindex "log" "local interface"
37555 .cindex "log" "local address and port"
37556 .cindex "TCP/IP" "logging local address and port"
37557 .cindex "interface" "logging"
37558 &%incoming_interface%&: The interface on which a message was received is added
37559 to the &"<="& line as an IP address in square brackets, tagged by I= and
37560 followed by a colon and the port number. The local interface and port are also
37561 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37562 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37563 The latter can be disabled by turning off the &%outgoing_interface%& option.
37564 .next
37565 .cindex log "incoming proxy address"
37566 .cindex proxy "logging proxy address"
37567 .cindex "TCP/IP" "logging proxy address"
37568 &%proxy%&: The internal (closest to the system running Exim) IP address
37569 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37570 on a proxied connection
37571 or the &"=>"& line for a message delivered on a proxied connection.
37572 See &<<SECTproxyInbound>>& for more information.
37573 .next
37574 .cindex "log" "incoming remote port"
37575 .cindex "port" "logging remote"
37576 .cindex "TCP/IP" "logging incoming remote port"
37577 .vindex "&$sender_fullhost$&"
37578 .vindex "&$sender_rcvhost$&"
37579 &%incoming_port%&: The remote port number from which a message was received is
37580 added to log entries and &'Received:'& header lines, following the IP address
37581 in square brackets, and separated from it by a colon. This is implemented by
37582 changing the value that is put in the &$sender_fullhost$& and
37583 &$sender_rcvhost$& variables. Recording the remote port number has become more
37584 important with the widening use of NAT (see RFC 2505).
37585 .next
37586 .cindex "log" "dropped connection"
37587 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37588 connection is unexpectedly dropped.
37589 .next
37590 .cindex "log" "millisecond timestamps"
37591 .cindex millisecond logging
37592 .cindex timestamps "millisecond, in logs"
37593 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37594 appended to the seconds value.
37595 .next
37596 .new
37597 .cindex "log" "message id"
37598 &%msg_id%&: The value of the Message-ID: header.
37599 .next
37600 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37601 This will be either because the message is a bounce, or was submitted locally
37602 (submission mode) without one.
37603 The field identifier will have an asterix appended: &"id*="&.
37604 .wen
37605 .next
37606 .cindex "log" "outgoing interface"
37607 .cindex "log" "local interface"
37608 .cindex "log" "local address and port"
37609 .cindex "TCP/IP" "logging local address and port"
37610 .cindex "interface" "logging"
37611 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37612 interface on which a message was sent is added to delivery lines as an I= tag
37613 followed by IP address in square brackets. You can disable this by turning
37614 off the &%outgoing_interface%& option.
37615 .next
37616 .cindex "log" "outgoing remote port"
37617 .cindex "port" "logging outgoing remote"
37618 .cindex "TCP/IP" "logging outgoing remote port"
37619 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37620 containing => tags) following the IP address.
37621 The local port is also added if &%incoming_interface%& and
37622 &%outgoing_interface%& are both enabled.
37623 This option is not included in the default setting, because for most ordinary
37624 configurations, the remote port number is always 25 (the SMTP port), and the
37625 local port is a random ephemeral port.
37626 .next
37627 .cindex "log" "process ids in"
37628 .cindex "pid (process id)" "in log lines"
37629 &%pid%&: The current process id is added to every log line, in square brackets,
37630 immediately after the time and date.
37631 .next
37632 .cindex log pipelining
37633 .cindex pipelining "logging outgoing"
37634 &%pipelining%&: A field is added to delivery and accept
37635 log lines when the ESMTP PIPELINING extension was used.
37636 The field is a single "L".
37637
37638 On accept lines, where PIPELINING was offered but not used by the client,
37639 the field has a minus appended.
37640
37641 .new
37642 .cindex "pipelining" "early connection"
37643 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37644 accept "L" fields have a period appended if the feature was
37645 offered but not used, or an asterisk appended if used.
37646 Delivery "L" fields have an asterisk appended if used.
37647 .wen
37648
37649 .next
37650 .cindex "log" "queue run"
37651 .cindex "queue runner" "logging"
37652 &%queue_run%&: The start and end of every queue run are logged.
37653 .next
37654 .cindex "log" "queue time"
37655 &%queue_time%&: The amount of time the message has been in the queue on the
37656 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37657 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37658 includes reception time as well as the delivery time for the current address.
37659 This means that it may be longer than the difference between the arrival and
37660 delivery log line times, because the arrival log line is not written until the
37661 message has been successfully received.
37662 If millisecond logging is enabled, short times will be shown with greater
37663 precision, eg. &`QT=1.578s`&.
37664 .next
37665 &%queue_time_overall%&: The amount of time the message has been in the queue on
37666 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37667 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37668 message, so it includes reception time as well as the total delivery time.
37669 .next
37670 .cindex "log" "receive duration"
37671 &%receive_time%&: For each message, the amount of real time it has taken to
37672 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37673 If millisecond logging is enabled, short times will be shown with greater
37674 precision, eg. &`RT=0.204s`&.
37675 .next
37676 .cindex "log" "recipients"
37677 &%received_recipients%&: The recipients of a message are listed in the main log
37678 as soon as the message is received. The list appears at the end of the log line
37679 that is written when a message is received, preceded by the word &"for"&. The
37680 addresses are listed after they have been qualified, but before any rewriting
37681 has taken place.
37682 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37683 in the list.
37684 .next
37685 .cindex "log" "sender reception"
37686 &%received_sender%&: The unrewritten original sender of a message is added to
37687 the end of the log line that records the message's arrival, after the word
37688 &"from"& (before the recipients if &%received_recipients%& is also set).
37689 .next
37690 .cindex "log" "header lines for rejection"
37691 &%rejected_header%&: If a message's header has been received at the time a
37692 rejection is written to the reject log, the complete header is added to the
37693 log. Header logging can be turned off individually for messages that are
37694 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37695 .next
37696 .cindex "log" "retry defer"
37697 &%retry_defer%&: A log line is written if a delivery is deferred because a
37698 retry time has not yet been reached. However, this &"retry time not reached"&
37699 message is always omitted from individual message logs after the first delivery
37700 attempt.
37701 .next
37702 .cindex "log" "return path"
37703 &%return_path_on_delivery%&: The return path that is being transmitted with
37704 the message is included in delivery and bounce lines, using the tag P=.
37705 This is omitted if no delivery actually happens, for example, if routing fails,
37706 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37707 .next
37708 .cindex "log" "sender on delivery"
37709 &%sender_on_delivery%&: The message's sender address is added to every delivery
37710 and bounce line, tagged by F= (for &"from"&).
37711 This is the original sender that was received with the message; it is not
37712 necessarily the same as the outgoing return path.
37713 .next
37714 .cindex "log" "sender verify failure"
37715 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37716 gives details of a sender verification failure is not written. Log lines for
37717 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37718 detail is lost.
37719 .next
37720 .cindex "log" "size rejection"
37721 &%size_reject%&: A log line is written whenever a message is rejected because
37722 it is too big.
37723 .next
37724 .cindex "log" "frozen messages; skipped"
37725 .cindex "frozen messages" "logging skipping"
37726 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37727 queue run because it is frozen or because another process is already delivering
37728 it.
37729 .cindex "&""spool file is locked""&"
37730 The message that is written is &"spool file is locked"&.
37731 .next
37732 .cindex "log" "smtp confirmation"
37733 .cindex "SMTP" "logging confirmation"
37734 .cindex "LMTP" "logging confirmation"
37735 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37736 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37737 A number of MTAs (including Exim) return an identifying string in this
37738 response.
37739 .next
37740 .cindex "log" "SMTP connections"
37741 .cindex "SMTP" "logging connections"
37742 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37743 established or closed, unless the connection is from a host that matches
37744 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37745 only when the closure is unexpected.) This applies to connections from local
37746 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37747 dropped in the middle of a message, a log line is always written, whether or
37748 not this selector is set, but otherwise nothing is written at the start and end
37749 of connections unless this selector is enabled.
37750
37751 For TCP/IP connections to an Exim daemon, the current number of connections is
37752 included in the log message for each new connection, but note that the count is
37753 reset if the daemon is restarted.
37754 Also, because connections are closed (and the closure is logged) in
37755 subprocesses, the count may not include connections that have been closed but
37756 whose termination the daemon has not yet noticed. Thus, while it is possible to
37757 match up the opening and closing of connections in the log, the value of the
37758 logged counts may not be entirely accurate.
37759 .next
37760 .cindex "log" "SMTP transaction; incomplete"
37761 .cindex "SMTP" "logging incomplete transactions"
37762 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37763 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37764 and the message sender plus any accepted recipients are included in the log
37765 line. This can provide evidence of dictionary attacks.
37766 .next
37767 .cindex "log" "non-MAIL SMTP sessions"
37768 .cindex "MAIL" "logging session without"
37769 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37770 connection terminates without having issued a MAIL command. This includes both
37771 the case when the connection is dropped, and the case when QUIT is used. It
37772 does not include cases where the connection is rejected right at the start (by
37773 an ACL, or because there are too many connections, or whatever). These cases
37774 already have their own log lines.
37775
37776 The log line that is written contains the identity of the client in the usual
37777 way, followed by D= and a time, which records the duration of the connection.
37778 If the connection was authenticated, this fact is logged exactly as it is for
37779 an incoming message, with an A= item. If the connection was encrypted, CV=,
37780 DN=, and X= items may appear as they do for an incoming message, controlled by
37781 the same logging options.
37782
37783 Finally, if any SMTP commands were issued during the connection, a C= item
37784 is added to the line, listing the commands that were used. For example,
37785 .code
37786 C=EHLO,QUIT
37787 .endd
37788 shows that the client issued QUIT straight after EHLO. If there were fewer
37789 than 20 commands, they are all listed. If there were more than 20 commands,
37790 the last 20 are listed, preceded by &"..."&. However, with the default
37791 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37792 have been aborted before 20 non-mail commands are processed.
37793 .next
37794 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37795 colon-separated, is appended to the A= item for a message arrival or delivery
37796 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37797 was accepted or used.
37798 .next
37799 .cindex "log" "SMTP protocol error"
37800 .cindex "SMTP" "logging protocol error"
37801 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37802 encountered. Exim does not have perfect detection of all protocol errors
37803 because of transmission delays and the use of pipelining. If PIPELINING has
37804 been advertised to a client, an Exim server assumes that the client will use
37805 it, and therefore it does not count &"expected"& errors (for example, RCPT
37806 received after rejecting MAIL) as protocol errors.
37807 .next
37808 .cindex "SMTP" "logging syntax errors"
37809 .cindex "SMTP" "syntax errors; logging"
37810 .cindex "SMTP" "unknown command; logging"
37811 .cindex "log" "unknown SMTP command"
37812 .cindex "log" "SMTP syntax error"
37813 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37814 encountered. An unrecognized command is treated as a syntax error. For an
37815 external connection, the host identity is given; for an internal connection
37816 using &%-bs%& the sender identification (normally the calling user) is given.
37817 .next
37818 .cindex "log" "subject"
37819 .cindex "subject, logging"
37820 &%subject%&: The subject of the message is added to the arrival log line,
37821 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37822 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37823 specifies whether characters with values greater than 127 should be logged
37824 unchanged, or whether they should be rendered as escape sequences.
37825 .next
37826 .cindex "log" "certificate verification"
37827 .cindex log DANE
37828 .cindex DANE logging
37829 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37830 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37831 verified
37832 using a CA trust anchor,
37833 &`CA=dane`& if using a DNS trust anchor,
37834 and &`CV=no`& if not.
37835 .next
37836 .cindex "log" "TLS cipher"
37837 .cindex "TLS" "logging cipher"
37838 &%tls_cipher%&: When a message is sent or received over an encrypted
37839 connection, the cipher suite used is added to the log line, preceded by X=.
37840 .next
37841 .cindex "log" "TLS peer DN"
37842 .cindex "TLS" "logging peer DN"
37843 &%tls_peerdn%&: When a message is sent or received over an encrypted
37844 connection, and a certificate is supplied by the remote host, the peer DN is
37845 added to the log line, preceded by DN=.
37846 .next
37847 .cindex "log" "TLS SNI"
37848 .cindex "TLS" "logging SNI"
37849 &%tls_sni%&: When a message is received over an encrypted connection, and
37850 the remote host provided the Server Name Indication extension, the SNI is
37851 added to the log line, preceded by SNI=.
37852 .next
37853 .cindex "log" "DNS failure in list"
37854 &%unknown_in_list%&: This setting causes a log entry to be written when the
37855 result of a list match is failure because a DNS lookup failed.
37856 .endlist
37857
37858
37859 .section "Message log" "SECID260"
37860 .cindex "message" "log file for"
37861 .cindex "log" "message log; description of"
37862 .cindex "&_msglog_& directory"
37863 .oindex "&%preserve_message_logs%&"
37864 In addition to the general log files, Exim writes a log file for each message
37865 that it handles. The names of these per-message logs are the message ids, and
37866 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37867 message log contains copies of the log lines that apply to the message. This
37868 makes it easier to inspect the status of an individual message without having
37869 to search the main log. A message log is deleted when processing of the message
37870 is complete, unless &%preserve_message_logs%& is set, but this should be used
37871 only with great care because they can fill up your disk very quickly.
37872
37873 On a heavily loaded system, it may be desirable to disable the use of
37874 per-message logs, in order to reduce disk I/O. This can be done by setting the
37875 &%message_logs%& option false.
37876 .ecindex IIDloggen
37877
37878
37879
37880
37881 . ////////////////////////////////////////////////////////////////////////////
37882 . ////////////////////////////////////////////////////////////////////////////
37883
37884 .chapter "Exim utilities" "CHAPutils"
37885 .scindex IIDutils "utilities"
37886 A number of utility scripts and programs are supplied with Exim and are
37887 described in this chapter. There is also the Exim Monitor, which is covered in
37888 the next chapter. The utilities described here are:
37889
37890 .itable none 0 0 3  7* left  15* left  40* left
37891 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37892   "list what Exim processes are doing"
37893 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37894 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37895 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37896 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37897                                                 various criteria"
37898 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37899 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37900   "extract statistics from the log"
37901 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37902   "check address acceptance from given IP"
37903 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37904 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37905 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37906 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37907 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37908 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37909 .endtable
37910
37911 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37912 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37913 &url(https://duncanthrax.net/exilog/) for details.
37914
37915
37916
37917
37918 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37919 .cindex "&'exiwhat'&"
37920 .cindex "process, querying"
37921 .cindex "SIGUSR1"
37922 On operating systems that can restart a system call after receiving a signal
37923 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37924 a line describing what it is doing to the file &_exim-process.info_& in the
37925 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37926 processes it can find, having first emptied the file. It then waits for one
37927 second to allow the Exim processes to react before displaying the results. In
37928 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37929 send the signal to the Exim processes, so it is normally run as root.
37930
37931 &*Warning*&: This is not an efficient process. It is intended for occasional
37932 use by system administrators. It is not sensible, for example, to set up a
37933 script that sends SIGUSR1 signals to Exim processes at short intervals.
37934
37935
37936 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37937 varies in different operating systems. Not only are different options used,
37938 but the format of the output is different. For this reason, there are some
37939 system configuration options that configure exactly how &'exiwhat'& works. If
37940 it doesn't seem to be working for you, check the following compile-time
37941 options:
37942 .display
37943 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37944 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37945 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37946 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37947 .endd
37948 An example of typical output from &'exiwhat'& is
37949 .code
37950 164 daemon: -q1h, listening on port 25
37951 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37952 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37953   [10.19.42.42] (editor@ref.example)
37954 10592 handling incoming call from [192.168.243.242]
37955 10628 accepting a local non-SMTP message
37956 .endd
37957 The first number in the output line is the process number. The third line has
37958 been split here, in order to fit it on the page.
37959
37960
37961
37962 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37963 .cindex "&'exiqgrep'&"
37964 .cindex "queue" "grepping"
37965 This utility is a Perl script contributed by Matt Hubbard. It runs
37966 .code
37967 exim -bpu
37968 .endd
37969 or (in case &*-a*& switch is specified)
37970 .code
37971 exim -bp
37972 .endd
37973 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37974 contain alternate exim configuration the queue management might be using.
37975
37976 to obtain a queue listing, and then greps the output to select messages
37977 that match given criteria. The following selection options are available:
37978
37979 .vlist
37980 .vitem &*-f*&&~<&'regex'&>
37981 Match the sender address using a case-insensitive search. The field that is
37982 tested is enclosed in angle brackets, so you can test for bounce messages with
37983 .code
37984 exiqgrep -f '^<>$'
37985 .endd
37986 .vitem &*-r*&&~<&'regex'&>
37987 Match a recipient address using a case-insensitive search. The field that is
37988 tested is not enclosed in angle brackets.
37989
37990 .vitem &*-s*&&~<&'regex'&>
37991 Match against the size field.
37992
37993 .vitem &*-y*&&~<&'seconds'&>
37994 Match messages that are younger than the given time.
37995
37996 .vitem &*-o*&&~<&'seconds'&>
37997 Match messages that are older than the given time.
37998
37999 .vitem &*-z*&
38000 Match only frozen messages.
38001
38002 .vitem &*-x*&
38003 Match only non-frozen messages.
38004
38005 .new
38006 .vitem &*-G*&&~<&'queuename'&>
38007 Match only messages in the given queue.  Without this, the default queue is searched.
38008 .wen
38009 .endlist
38010
38011 The following options control the format of the output:
38012
38013 .vlist
38014 .vitem &*-c*&
38015 Display only the count of matching messages.
38016
38017 .vitem &*-l*&
38018 Long format &-- display the full message information as output by Exim. This is
38019 the default.
38020
38021 .vitem &*-i*&
38022 Display message ids only.
38023
38024 .vitem &*-b*&
38025 Brief format &-- one line per message.
38026
38027 .vitem &*-R*&
38028 Display messages in reverse order.
38029
38030 .vitem &*-a*&
38031 Include delivered recipients in queue listing.
38032 .endlist
38033
38034 There is one more option, &%-h%&, which outputs a list of options.
38035
38036
38037
38038 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38039 .cindex "&'exiqsumm'&"
38040 .cindex "queue" "summary"
38041 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38042 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38043 running a command such as
38044 .code
38045 exim -bp | exiqsumm
38046 .endd
38047 The output consists of one line for each domain that has messages waiting for
38048 it, as in the following example:
38049 .code
38050 3   2322   74m   66m  msn.com.example
38051 .endd
38052 Each line lists the number of pending deliveries for a domain, their total
38053 volume, and the length of time that the oldest and the newest messages have
38054 been waiting. Note that the number of pending deliveries is greater than the
38055 number of messages when messages have more than one recipient.
38056
38057 A summary line is output at the end. By default the output is sorted on the
38058 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38059 the output to be sorted by oldest message and by count of messages,
38060 respectively. There are also three options that split the messages for each
38061 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38062 separates frozen messages, and &%-s%& separates messages according to their
38063 sender.
38064
38065 The output of &'exim -bp'& contains the original addresses in the message, so
38066 this also applies to the output from &'exiqsumm'&. No domains from addresses
38067 generated by aliasing or forwarding are included (unless the &%one_time%&
38068 option of the &(redirect)& router has been used to convert them into &"top
38069 level"& addresses).
38070
38071
38072
38073
38074 .section "Extracting specific information from the log (exigrep)" &&&
38075          "SECTextspeinf"
38076 .cindex "&'exigrep'&"
38077 .cindex "log" "extracts; grepping for"
38078 The &'exigrep'& utility is a Perl script that searches one or more main log
38079 files for entries that match a given pattern. When it finds a match, it
38080 extracts all the log entries for the relevant message, not just those that
38081 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38082 given message, or all mail for a given user, or for a given host, for example.
38083 The input files can be in Exim log format or syslog format.
38084 If a matching log line is not associated with a specific message, it is
38085 included in &'exigrep'&'s output without any additional lines. The usage is:
38086 .display
38087 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38088 .endd
38089 If no log filenames are given on the command line, the standard input is read.
38090
38091 The &%-t%& argument specifies a number of seconds. It adds an additional
38092 condition for message selection. Messages that are complete are shown only if
38093 they spent more than <&'n'&> seconds in the queue.
38094
38095 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38096 makes it case-sensitive. This may give a performance improvement when searching
38097 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38098 option; with &%-I%& they do not. In both cases it is possible to change the
38099 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38100
38101 The &%-l%& option means &"literal"&, that is, treat all characters in the
38102 pattern as standing for themselves. Otherwise the pattern must be a Perl
38103 regular expression.
38104
38105 The &%-v%& option inverts the matching condition. That is, a line is selected
38106 if it does &'not'& match the pattern.
38107
38108 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38109 that are generated as a result/response to a message that &'exigrep'& matched
38110 normally.
38111
38112 Example of &%-M%&:
38113 user_a sends a message to user_b, which generates a bounce back to user_b. If
38114 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38115 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38116 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38117 when searching for &"user_a"& will show both messages since the bounce is
38118 &"related"& to or a &"result"& of the first message that was found by the
38119 search term.
38120
38121 If the location of a &'zcat'& command is known from the definition of
38122 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38123 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38124 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38125 autodetection of some well known compression extensions.
38126
38127
38128 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38129 .cindex "&'exipick'&"
38130 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38131 lists messages from the queue according to a variety of criteria. For details
38132 of &'exipick'&'s facilities, run &'exipick'& with
38133 the &%--help%& option.
38134
38135
38136 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38137 .cindex "log" "cycling local files"
38138 .cindex "cycling logs"
38139 .cindex "&'exicyclog'&"
38140 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38141 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38142 you are using log files with datestamps in their names (see section
38143 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38144 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38145 There are two command line options for &'exicyclog'&:
38146 .ilist
38147 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38148 default that is set when Exim is built. The default default is 10.
38149 .next
38150 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38151 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38152 overriding the script's default, which is to find the setting from Exim's
38153 configuration.
38154 .endlist
38155
38156 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38157 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38158 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38159 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38160 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38161 logs are handled similarly.
38162
38163 If the limit is greater than 99, the script uses 3-digit numbers such as
38164 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38165 to one that is greater, or &'vice versa'&, you will have to fix the names of
38166 any existing log files.
38167
38168 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38169 the end are deleted. All files with numbers greater than 01 are compressed,
38170 using a compression command which is configured by the COMPRESS_COMMAND
38171 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38172 root &%crontab%& entry of the form
38173 .code
38174 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38175 .endd
38176 assuming you have used the name &"exim"& for the Exim user. You can run
38177 &'exicyclog'& as root if you wish, but there is no need.
38178
38179
38180
38181 .section "Mail statistics (eximstats)" "SECTmailstat"
38182 .cindex "statistics"
38183 .cindex "&'eximstats'&"
38184 A Perl script called &'eximstats'& is provided for extracting statistical
38185 information from log files. The output is either plain text, or HTML.
38186 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38187 . --- 404 error and everything else points to that.
38188
38189 The &'eximstats'& script has been hacked about quite a bit over time. The
38190 latest version is the result of some extensive revision by Steve Campbell. A
38191 lot of information is given by default, but there are options for suppressing
38192 various parts of it. Following any options, the arguments to the script are a
38193 list of files, which should be main log files. For example:
38194 .code
38195 eximstats -nr /var/spool/exim/log/mainlog.01
38196 .endd
38197 By default, &'eximstats'& extracts information about the number and volume of
38198 messages received from or delivered to various hosts. The information is sorted
38199 both by message count and by volume, and the top fifty hosts in each category
38200 are listed on the standard output. Similar information, based on email
38201 addresses or domains instead of hosts can be requested by means of various
38202 options. For messages delivered and received locally, similar statistics are
38203 also produced per user.
38204
38205 The output also includes total counts and statistics about delivery errors, and
38206 histograms showing the number of messages received and deliveries made in each
38207 hour of the day. A delivery with more than one address in its envelope (for
38208 example, an SMTP transaction with more than one RCPT command) is counted
38209 as a single delivery by &'eximstats'&.
38210
38211 Though normally more deliveries than receipts are reported (as messages may
38212 have multiple recipients), it is possible for &'eximstats'& to report more
38213 messages received than delivered, even though the queue is empty at the start
38214 and end of the period in question. If an incoming message contains no valid
38215 recipients, no deliveries are recorded for it. A bounce message is handled as
38216 an entirely separate message.
38217
38218 &'eximstats'& always outputs a grand total summary giving the volume and number
38219 of messages received and deliveries made, and the number of hosts involved in
38220 each case. It also outputs the number of messages that were delayed (that is,
38221 not completely delivered at the first attempt), and the number that had at
38222 least one address that failed.
38223
38224 The remainder of the output is in sections that can be independently disabled
38225 or modified by various options. It consists of a summary of deliveries by
38226 transport, histograms of messages received and delivered per time interval
38227 (default per hour), information about the time messages spent in the queue,
38228 a list of relayed messages, lists of the top fifty sending hosts, local
38229 senders, destination hosts, and destination local users by count and by volume,
38230 and a list of delivery errors that occurred.
38231
38232 The relay information lists messages that were actually relayed, that is, they
38233 came from a remote host and were directly delivered to some other remote host,
38234 without being processed (for example, for aliasing or forwarding) locally.
38235
38236 There are quite a few options for &'eximstats'& to control exactly what it
38237 outputs. These are documented in the Perl script itself, and can be extracted
38238 by running the command &(perldoc)& on the script. For example:
38239 .code
38240 perldoc /usr/exim/bin/eximstats
38241 .endd
38242
38243 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38244 .cindex "&'exim_checkaccess'&"
38245 .cindex "policy control" "checking access"
38246 .cindex "checking access"
38247 The &%-bh%& command line argument allows you to run a fake SMTP session with
38248 debugging output, in order to check what Exim is doing when it is applying
38249 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38250 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38251 sometimes you just want to answer the question &"Does this address have
38252 access?"& without bothering with any further details.
38253
38254 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38255 two arguments, an IP address and an email address:
38256 .code
38257 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38258 .endd
38259 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38260 given email address would be accepted in a RCPT command in a TCP/IP
38261 connection from the host with the given IP address. The output of the utility
38262 is either the word &"accepted"&, or the SMTP error response, for example:
38263 .code
38264 Rejected:
38265 550 Relay not permitted
38266 .endd
38267 When running this test, the utility uses &`<>`& as the envelope sender address
38268 for the MAIL command, but you can change this by providing additional
38269 options. These are passed directly to the Exim command. For example, to specify
38270 that the test is to be run with the sender address &'himself@there.example'&
38271 you can use:
38272 .code
38273 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38274                  -f himself@there.example
38275 .endd
38276 Note that these additional Exim command line items must be given after the two
38277 mandatory arguments.
38278
38279 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38280 while running its checks. You can run checks that include callouts by using
38281 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38282
38283
38284
38285 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38286 .cindex "DBM" "building dbm files"
38287 .cindex "building DBM files"
38288 .cindex "&'exim_dbmbuild'&"
38289 .cindex "lower casing"
38290 .cindex "binary zero" "in lookup key"
38291 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38292 the format used by the &(lsearch)& lookup (see section
38293 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38294 names as keys and the remainder of the information as data. The lower-casing
38295 can be prevented by calling the program with the &%-nolc%& option.
38296
38297 A terminating zero is included as part of the key string. This is expected by
38298 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38299 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38300 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38301 files.
38302
38303 The program requires two arguments: the name of the input file (which can be a
38304 single hyphen to indicate the standard input), and the name of the output file.
38305 It creates the output under a temporary name, and then renames it if all went
38306 well.
38307
38308 .cindex "USE_DB"
38309 If the native DB interface is in use (USE_DB is set in a compile-time
38310 configuration file &-- this is common in free versions of Unix) the two
38311 filenames must be different, because in this mode the Berkeley DB functions
38312 create a single output file using exactly the name given. For example,
38313 .code
38314 exim_dbmbuild /etc/aliases /etc/aliases.db
38315 .endd
38316 reads the system alias file and creates a DBM version of it in
38317 &_/etc/aliases.db_&.
38318
38319 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38320 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38321 environment, the suffixes are added to the second argument of
38322 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38323 when the Berkeley functions are used in compatibility mode (though this is not
38324 recommended), because in that case it adds a &_.db_& suffix to the filename.
38325
38326 If a duplicate key is encountered, the program outputs a warning, and when it
38327 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38328 option is used. By default, only the first of a set of duplicates is used &--
38329 this makes it compatible with &(lsearch)& lookups. There is an option
38330 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38331 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38332 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38333 return code is 2.
38334
38335
38336
38337
38338 .section "Finding individual retry times (exinext)" "SECTfinindret"
38339 .cindex "retry" "times"
38340 .cindex "&'exinext'&"
38341 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38342 fish specific information out of the retry database. Given a mail domain (or a
38343 complete address), it looks up the hosts for that domain, and outputs any retry
38344 information for the hosts or for the domain. At present, the retry information
38345 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38346 output. For example:
38347 .code
38348 $ exinext piglet@milne.fict.example
38349 kanga.milne.example:192.168.8.1 error 146: Connection refused
38350   first failed: 21-Feb-1996 14:57:34
38351   last tried:   21-Feb-1996 14:57:34
38352   next try at:  21-Feb-1996 15:02:34
38353 roo.milne.example:192.168.8.3 error 146: Connection refused
38354   first failed: 20-Jan-1996 13:12:08
38355   last tried:   21-Feb-1996 11:42:03
38356   next try at:  21-Feb-1996 19:42:03
38357   past final cutoff time
38358 .endd
38359 You can also give &'exinext'& a local part, without a domain, and it
38360 will give any retry information for that local part in your default domain.
38361 A message id can be used to obtain retry information pertaining to a specific
38362 message. This exists only when an attempt to deliver a message to a remote host
38363 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38364 &'exinext'& is not particularly efficient, but then it is not expected to be
38365 run very often.
38366
38367 The &'exinext'& utility calls Exim to find out information such as the location
38368 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38369 passed on to the &'exim'& commands. The first specifies an alternate Exim
38370 configuration file, and the second sets macros for use within the configuration
38371 file. These features are mainly to help in testing, but might also be useful in
38372 environments where more than one configuration file is in use.
38373
38374
38375
38376 .section "Hints database maintenance" "SECThindatmai"
38377 .cindex "hints database" "maintenance"
38378 .cindex "maintaining Exim's hints database"
38379 Three utility programs are provided for maintaining the DBM files that Exim
38380 uses to contain its delivery hint information. Each program requires two
38381 arguments. The first specifies the name of Exim's spool directory, and the
38382 second is the name of the database it is to operate on. These are as follows:
38383
38384 .ilist
38385 &'retry'&: the database of retry information
38386 .next
38387 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38388 for remote hosts
38389 .next
38390 &'callout'&: the callout cache
38391 .next
38392 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38393 .next
38394 &'misc'&: other hints data
38395 .endlist
38396
38397 The &'misc'& database is used for
38398
38399 .ilist
38400 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38401 .next
38402 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38403 &(smtp)& transport)
38404 .next
38405 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38406 in a transport)
38407 .endlist
38408
38409
38410
38411 .section "exim_dumpdb" "SECID261"
38412 .cindex "&'exim_dumpdb'&"
38413 The entire contents of a database are written to the standard output by the
38414 &'exim_dumpdb'& program, which has no options or arguments other than the
38415 spool and database names. For example, to dump the retry database:
38416 .code
38417 exim_dumpdb /var/spool/exim retry
38418 .endd
38419 Two lines of output are produced for each entry:
38420 .code
38421 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38422 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38423 .endd
38424 The first item on the first line is the key of the record. It starts with one
38425 of the letters R, or T, depending on whether it refers to a routing or
38426 transport retry. For a local delivery, the next part is the local address; for
38427 a remote delivery it is the name of the remote host, followed by its failing IP
38428 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38429 transport). If the remote port is not the standard one (port 25), it is added
38430 to the IP address. Then there follows an error code, an additional error code,
38431 and a textual description of the error.
38432
38433 The three times on the second line are the time of first failure, the time of
38434 the last delivery attempt, and the computed time for the next attempt. The line
38435 ends with an asterisk if the cutoff time for the last retry rule has been
38436 exceeded.
38437
38438 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38439 consists of a host name followed by a list of ids for messages that are or were
38440 waiting to be delivered to that host. If there are a very large number for any
38441 one host, continuation records, with a sequence number added to the host name,
38442 may be seen. The data in these records is often out of date, because a message
38443 may be routed to several alternative hosts, and Exim makes no effort to keep
38444 cross-references.
38445
38446
38447
38448 .section "exim_tidydb" "SECID262"
38449 .cindex "&'exim_tidydb'&"
38450 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38451 database. If run with no options, it removes all records that are more than 30
38452 days old. The age is calculated from the date and time that the record was last
38453 updated. Note that, in the case of the retry database, it is &'not'& the time
38454 since the first delivery failure. Information about a host that has been down
38455 for more than 30 days will remain in the database, provided that the record is
38456 updated sufficiently often.
38457
38458 The cutoff date can be altered by means of the &%-t%& option, which must be
38459 followed by a time. For example, to remove all records older than a week from
38460 the retry database:
38461 .code
38462 exim_tidydb -t 7d /var/spool/exim retry
38463 .endd
38464 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38465 message ids. In the former these appear as data in records keyed by host &--
38466 they were messages that were waiting for that host &-- and in the latter they
38467 are the keys for retry information for messages that have suffered certain
38468 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38469 message ids in database records are those of messages that are still on the
38470 queue. Message ids for messages that no longer exist are removed from
38471 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38472 For the &'retry'& database, records whose keys are non-existent message ids are
38473 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38474 whenever it removes information from the database.
38475
38476 Certain records are automatically removed by Exim when they are no longer
38477 needed, but others are not. For example, if all the MX hosts for a domain are
38478 down, a retry record is created for each one. If the primary MX host comes back
38479 first, its record is removed when Exim successfully delivers to it, but the
38480 records for the others remain because Exim has not tried to use those hosts.
38481
38482 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38483 hints databases. You should do this at a quiet time of day, because it requires
38484 a database to be locked (and therefore inaccessible to Exim) while it does its
38485 work. Removing records from a DBM file does not normally make the file smaller,
38486 but all the common DBM libraries are able to re-use the space that is released.
38487 After an initial phase of increasing in size, the databases normally reach a
38488 point at which they no longer get any bigger, as long as they are regularly
38489 tidied.
38490
38491 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38492 databases is likely to keep on increasing.
38493
38494
38495
38496
38497 .section "exim_fixdb" "SECID263"
38498 .cindex "&'exim_fixdb'&"
38499 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38500 Its main use is for testing Exim, but it might also be occasionally useful for
38501 getting round problems in a live system. It has no options, and its interface
38502 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38503 key of a database record can then be entered, and the data for that record is
38504 displayed.
38505
38506 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38507 except the &'retry'& database, that is the only operation that can be carried
38508 out. For the &'retry'& database, each field is output preceded by a number, and
38509 data for individual fields can be changed by typing the field number followed
38510 by new data, for example:
38511 .code
38512 > 4 951102:1000
38513 .endd
38514 resets the time of the next delivery attempt. Time values are given as a
38515 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38516 used as optional separators.
38517
38518
38519
38520
38521 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38522 .cindex "mailbox" "maintenance"
38523 .cindex "&'exim_lock'&"
38524 .cindex "locking mailboxes"
38525 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38526 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38527 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38528 a user agent while investigating a problem. The utility requires the name of
38529 the file as its first argument. If the locking is successful, the second
38530 argument is run as a command (using C's &[system()]& function); if there is no
38531 second argument, the value of the SHELL environment variable is used; if this
38532 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38533 is unlocked and the utility ends. The following options are available:
38534
38535 .vlist
38536 .vitem &%-fcntl%&
38537 Use &[fcntl()]& locking on the open mailbox.
38538
38539 .vitem &%-flock%&
38540 Use &[flock()]& locking on the open mailbox, provided the operating system
38541 supports it.
38542
38543 .vitem &%-interval%&
38544 This must be followed by a number, which is a number of seconds; it sets the
38545 interval to sleep between retries (default 3).
38546
38547 .vitem &%-lockfile%&
38548 Create a lock file before opening the mailbox.
38549
38550 .vitem &%-mbx%&
38551 Lock the mailbox using MBX rules.
38552
38553 .vitem &%-q%&
38554 Suppress verification output.
38555
38556 .vitem &%-retries%&
38557 This must be followed by a number; it sets the number of times to try to get
38558 the lock (default 10).
38559
38560 .vitem &%-restore_time%&
38561 This option causes &%exim_lock%& to restore the modified and read times to the
38562 locked file before exiting. This allows you to access a locked mailbox (for
38563 example, to take a backup copy) without disturbing the times that the user
38564 subsequently sees.
38565
38566 .vitem &%-timeout%&
38567 This must be followed by a number, which is a number of seconds; it sets a
38568 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38569 default), a non-blocking call is used.
38570
38571 .vitem &%-v%&
38572 Generate verbose output.
38573 .endlist
38574
38575 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38576 default is to create a lock file and also to use &[fcntl()]& locking on the
38577 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38578 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38579 requires that the directory containing the file be writeable. Locking by lock
38580 file does not last forever; Exim assumes that a lock file is expired if it is
38581 more than 30 minutes old.
38582
38583 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38584 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38585 to be taken out on the open mailbox, and an exclusive lock on the file
38586 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38587 number of the mailbox file. When the locking is released, if an exclusive lock
38588 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38589
38590 The default output contains verification of the locking that takes place. The
38591 &%-v%& option causes some additional information to be given. The &%-q%& option
38592 suppresses all output except error messages.
38593
38594 A command such as
38595 .code
38596 exim_lock /var/spool/mail/spqr
38597 .endd
38598 runs an interactive shell while the file is locked, whereas
38599 .display
38600 &`exim_lock -q /var/spool/mail/spqr <<End`&
38601 <&'some commands'&>
38602 &`End`&
38603 .endd
38604 runs a specific non-interactive sequence of commands while the file is locked,
38605 suppressing all verification output. A single command can be run by a command
38606 such as
38607 .code
38608 exim_lock -q /var/spool/mail/spqr \
38609   "cp /var/spool/mail/spqr /some/where"
38610 .endd
38611 Note that if a command is supplied, it must be entirely contained within the
38612 second argument &-- hence the quotes.
38613 .ecindex IIDutils
38614
38615
38616 . ////////////////////////////////////////////////////////////////////////////
38617 . ////////////////////////////////////////////////////////////////////////////
38618
38619 .chapter "The Exim monitor" "CHAPeximon"
38620 .scindex IIDeximon "Exim monitor" "description"
38621 .cindex "X-windows"
38622 .cindex "&'eximon'&"
38623 .cindex "Local/eximon.conf"
38624 .cindex "&_exim_monitor/EDITME_&"
38625 The Exim monitor is an application which displays in an X window information
38626 about the state of Exim's queue and what Exim is doing. An admin user can
38627 perform certain operations on messages from this GUI interface; however all
38628 such facilities are also available from the command line, and indeed, the
38629 monitor itself makes use of the command line to perform any actions requested.
38630
38631
38632
38633 .section "Running the monitor" "SECID264"
38634 The monitor is started by running the script called &'eximon'&. This is a shell
38635 script that sets up a number of environment variables, and then runs the
38636 binary called &_eximon.bin_&. The default appearance of the monitor window can
38637 be changed by editing the &_Local/eximon.conf_& file created by editing
38638 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38639 parameters are for.
38640
38641 The parameters that get built into the &'eximon'& script can be overridden for
38642 a particular invocation by setting up environment variables of the same names,
38643 preceded by &`EXIMON_`&. For example, a shell command such as
38644 .code
38645 EXIMON_LOG_DEPTH=400 eximon
38646 .endd
38647 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38648 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38649 overrides the Exim log file configuration. This makes it possible to have
38650 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38651 syslog messages are routed to a file on the local host.
38652
38653 X resources can be used to change the appearance of the window in the normal
38654 way. For example, a resource setting of the form
38655 .code
38656 Eximon*background: gray94
38657 .endd
38658 changes the colour of the background to light grey rather than white. The
38659 stripcharts are drawn with both the data lines and the reference lines in
38660 black. This means that the reference lines are not visible when on top of the
38661 data. However, their colour can be changed by setting a resource called
38662 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38663 For example, if your X server is running Unix, you could set up lighter
38664 reference lines in the stripcharts by obeying
38665 .code
38666 xrdb -merge <<End
38667 Eximon*highlight: gray
38668 End
38669 .endd
38670 .cindex "admin user"
38671 In order to see the contents of messages in the queue, and to operate on them,
38672 &'eximon'& must either be run as root or by an admin user.
38673
38674 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38675 contain X11 resource parameters interpreted by the X11 library.  In addition,
38676 if the first parameter starts with the string "gdb" then it is removed and the
38677 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38678 versioned variants of gdb can be invoked).
38679
38680 The monitor's window is divided into three parts. The first contains one or
38681 more stripcharts and two action buttons, the second contains a &"tail"& of the
38682 main log file, and the third is a display of the queue of messages awaiting
38683 delivery, with two more action buttons. The following sections describe these
38684 different parts of the display.
38685
38686
38687
38688
38689 .section "The stripcharts" "SECID265"
38690 .cindex "stripchart"
38691 The first stripchart is always a count of messages in the queue. Its name can
38692 be configured by setting QUEUE_STRIPCHART_NAME in the
38693 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38694 configuration script by regular expression matches on log file entries, making
38695 it possible to display, for example, counts of messages delivered to certain
38696 hosts or using certain transports. The supplied defaults display counts of
38697 received and delivered messages, and of local and SMTP deliveries. The default
38698 period between stripchart updates is one minute; this can be adjusted by a
38699 parameter in the &_Local/eximon.conf_& file.
38700
38701 The stripchart displays rescale themselves automatically as the value they are
38702 displaying changes. There are always 10 horizontal lines in each chart; the
38703 title string indicates the value of each division when it is greater than one.
38704 For example, &"x2"& means that each division represents a value of 2.
38705
38706 It is also possible to have a stripchart which shows the percentage fullness of
38707 a particular disk partition, which is useful when local deliveries are confined
38708 to a single partition.
38709
38710 .cindex "&%statvfs%& function"
38711 This relies on the availability of the &[statvfs()]& function or equivalent in
38712 the operating system. Most, but not all versions of Unix that support Exim have
38713 this. For this particular stripchart, the top of the chart always represents
38714 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38715 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38716 &_Local/eximon.conf_& file.
38717
38718
38719
38720
38721 .section "Main action buttons" "SECID266"
38722 .cindex "size" "of monitor window"
38723 .cindex "Exim monitor" "window size"
38724 .cindex "window size"
38725 Below the stripcharts there is an action button for quitting the monitor. Next
38726 to this is another button marked &"Size"&. They are placed here so that
38727 shrinking the window to its default minimum size leaves just the queue count
38728 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38729 the window to expand to its maximum size, unless it is already at the maximum,
38730 in which case it is reduced to its minimum.
38731
38732 When expanding to the maximum, if the window cannot be fully seen where it
38733 currently is, it is moved back to where it was the last time it was at full
38734 size. When it is expanding from its minimum size, the old position is
38735 remembered, and next time it is reduced to the minimum it is moved back there.
38736
38737 The idea is that you can keep a reduced window just showing one or two
38738 stripcharts at a convenient place on your screen, easily expand it to show
38739 the full window when required, and just as easily put it back to what it was.
38740 The idea is copied from what the &'twm'& window manager does for its
38741 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38742 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38743
38744 Normally, the monitor starts up with the window at its full size, but it can be
38745 built so that it starts up with the window at its smallest size, by setting
38746 START_SMALL=yes in &_Local/eximon.conf_&.
38747
38748
38749
38750 .section "The log display" "SECID267"
38751 .cindex "log" "tail of; in monitor"
38752 The second section of the window is an area in which a display of the tail of
38753 the main log is maintained.
38754 To save space on the screen, the timestamp on each log line is shortened by
38755 removing the date and, if &%log_timezone%& is set, the timezone.
38756 The log tail is not available when the only destination for logging data is
38757 syslog, unless the syslog lines are routed to a local file whose name is passed
38758 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38759
38760 The log sub-window has a scroll bar at its lefthand side which can be used to
38761 move back to look at earlier text, and the up and down arrow keys also have a
38762 scrolling effect. The amount of log that is kept depends on the setting of
38763 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38764 to use. When this is full, the earlier 50% of data is discarded &-- this is
38765 much more efficient than throwing it away line by line. The sub-window also has
38766 a horizontal scroll bar for accessing the ends of long log lines. This is the
38767 only means of horizontal scrolling; the right and left arrow keys are not
38768 available. Text can be cut from this part of the window using the mouse in the
38769 normal way. The size of this subwindow is controlled by parameters in the
38770 configuration file &_Local/eximon.conf_&.
38771
38772 Searches of the text in the log window can be carried out by means of the ^R
38773 and ^S keystrokes, which default to a reverse and a forward search,
38774 respectively. The search covers only the text that is displayed in the window.
38775 It cannot go further back up the log.
38776
38777 The point from which the search starts is indicated by a caret marker. This is
38778 normally at the end of the text in the window, but can be positioned explicitly
38779 by pointing and clicking with the left mouse button, and is moved automatically
38780 by a successful search. If new text arrives in the window when it is scrolled
38781 back, the caret remains where it is, but if the window is not scrolled back,
38782 the caret is moved to the end of the new text.
38783
38784 Pressing ^R or ^S pops up a window into which the search text can be typed.
38785 There are buttons for selecting forward or reverse searching, for carrying out
38786 the search, and for cancelling. If the &"Search"& button is pressed, the search
38787 happens and the window remains so that further searches can be done. If the
38788 &"Return"& key is pressed, a single search is done and the window is closed. If
38789 ^C is typed the search is cancelled.
38790
38791 The searching facility is implemented using the facilities of the Athena text
38792 widget. By default this pops up a window containing both &"search"& and
38793 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38794 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38795 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38796 provided version of &%TextPop%& when the remaining parts of the text widget
38797 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38798 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38799 on these systems, at the expense of having unwanted items in the search popup
38800 window.
38801
38802
38803
38804 .section "The queue display" "SECID268"
38805 .cindex "queue" "display in monitor"
38806 The bottom section of the monitor window contains a list of all messages that
38807 are in the queue, which includes those currently being received or delivered,
38808 as well as those awaiting delivery. The size of this subwindow is controlled by
38809 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38810 at which it is updated is controlled by another parameter in the same file &--
38811 the default is 5 minutes, since queue scans can be quite expensive. However,
38812 there is an &"Update"& action button just above the display which can be used
38813 to force an update of the queue display at any time.
38814
38815 When a host is down for some time, a lot of pending mail can build up for it,
38816 and this can make it hard to deal with other messages in the queue. To help
38817 with this situation there is a button next to &"Update"& called &"Hide"&. If
38818 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38819 type anything in here and press &"Return"&, the text is added to a chain of
38820 such texts, and if every undelivered address in a message matches at least one
38821 of the texts, the message is not displayed.
38822
38823 If there is an address that does not match any of the texts, all the addresses
38824 are displayed as normal. The matching happens on the ends of addresses so, for
38825 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38826 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38827 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38828 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38829 a hide request is automatically cancelled after one hour.
38830
38831 While the dialogue box is displayed, you can't press any buttons or do anything
38832 else to the monitor window. For this reason, if you want to cut text from the
38833 queue display to use in the dialogue box, you have to do the cutting before
38834 pressing the &"Hide"& button.
38835
38836 The queue display contains, for each unhidden queued message, the length of
38837 time it has been in the queue, the size of the message, the message id, the
38838 message sender, and the first undelivered recipient, all on one line. If it is
38839 a bounce message, the sender is shown as &"<>"&. If there is more than one
38840 recipient to which the message has not yet been delivered, subsequent ones are
38841 listed on additional lines, up to a maximum configured number, following which
38842 an ellipsis is displayed. Recipients that have already received the message are
38843 not shown.
38844
38845 .cindex "frozen messages" "display"
38846 If a message is frozen, an asterisk is displayed at the left-hand side.
38847
38848 The queue display has a vertical scroll bar, and can also be scrolled by means
38849 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38850 The text searching facilities, as described above for the log window, are also
38851 available, but the caret is always moved to the end of the text when the queue
38852 display is updated.
38853
38854
38855
38856 .section "The queue menu" "SECID269"
38857 .cindex "queue" "menu in monitor"
38858 If the &%shift%& key is held down and the left button is clicked when the mouse
38859 pointer is over the text for any message, an action menu pops up, and the first
38860 line of the queue display for the message is highlighted. This does not affect
38861 any selected text.
38862
38863 If you want to use some other event for popping up the menu, you can set the
38864 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38865 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38866 value set in this parameter is a standard X event description. For example, to
38867 run eximon using &%ctrl%& rather than &%shift%& you could use
38868 .code
38869 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38870 .endd
38871 The title of the menu is the message id, and it contains entries which act as
38872 follows:
38873
38874 .ilist
38875 &'message log'&: The contents of the message log for the message are displayed
38876 in a new text window.
38877 .next
38878 &'headers'&: Information from the spool file that contains the envelope
38879 information and headers is displayed in a new text window. See chapter
38880 &<<CHAPspool>>& for a description of the format of spool files.
38881 .next
38882 &'body'&: The contents of the spool file containing the body of the message are
38883 displayed in a new text window. There is a default limit of 20,000 bytes to the
38884 amount of data displayed. This can be changed by setting the BODY_MAX
38885 option at compile time, or the EXIMON_BODY_MAX option at runtime.
38886 .next
38887 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38888 delivery of the message. This causes an automatic thaw if the message is
38889 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38890 a new text window. The delivery is run in a separate process, to avoid holding
38891 up the monitor while the delivery proceeds.
38892 .next
38893 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38894 that the message be frozen.
38895 .next
38896 .cindex "thawing messages"
38897 .cindex "unfreezing messages"
38898 .cindex "frozen messages" "thawing"
38899 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38900 that the message be thawed.
38901 .next
38902 .cindex "delivery" "forcing failure"
38903 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38904 that Exim gives up trying to deliver the message. A bounce message is generated
38905 for any remaining undelivered addresses.
38906 .next
38907 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38908 that the message be deleted from the system without generating a bounce
38909 message.
38910 .next
38911 &'add recipient'&: A dialog box is displayed into which a recipient address can
38912 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38913 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38914 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38915 causes a call to Exim to be made using the &%-Mar%& option to request that an
38916 additional recipient be added to the message, unless the entry box is empty, in
38917 which case no action is taken.
38918 .next
38919 &'mark delivered'&: A dialog box is displayed into which a recipient address
38920 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38921 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38922 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38923 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38924 recipient address as already delivered, unless the entry box is empty, in which
38925 case no action is taken.
38926 .next
38927 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38928 mark all recipient addresses as already delivered.
38929 .next
38930 &'edit sender'&: A dialog box is displayed initialized with the current
38931 sender's address. Pressing RETURN causes a call to Exim to be made using the
38932 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38933 in which case no action is taken. If you want to set an empty sender (as in
38934 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38935 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38936 the address is qualified with that domain.
38937 .endlist
38938
38939 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38940 other cases when a call to Exim is made, if there is any output from Exim (in
38941 particular, if the command fails) a window containing the command and the
38942 output is displayed. Otherwise, the results of the action are normally apparent
38943 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38944 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38945 if no output is generated.
38946
38947 The queue display is automatically updated for actions such as freezing and
38948 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38949 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38950 force an update of the display after one of these actions.
38951
38952 In any text window that is displayed as result of a menu action, the normal
38953 cut-and-paste facility is available, and searching can be carried out using ^R
38954 and ^S, as described above for the log tail window.
38955 .ecindex IIDeximon
38956
38957
38958
38959
38960
38961 . ////////////////////////////////////////////////////////////////////////////
38962 . ////////////////////////////////////////////////////////////////////////////
38963
38964 .chapter "Security considerations" "CHAPsecurity"
38965 .scindex IIDsecurcon "security" "discussion of"
38966 This chapter discusses a number of issues concerned with security, some of
38967 which are also covered in other parts of this manual.
38968
38969 For reasons that this author does not understand, some people have promoted
38970 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38971 existence of this chapter in the documentation. However, the intent of the
38972 chapter is simply to describe the way Exim works in relation to certain
38973 security concerns, not to make any specific claims about the effectiveness of
38974 its security as compared with other MTAs.
38975
38976 What follows is a description of the way Exim is supposed to be. Best efforts
38977 have been made to try to ensure that the code agrees with the theory, but an
38978 absence of bugs can never be guaranteed. Any that are reported will get fixed
38979 as soon as possible.
38980
38981
38982 .section "Building a more &""hardened""& Exim" "SECID286"
38983 .cindex "security" "build-time features"
38984 There are a number of build-time options that can be set in &_Local/Makefile_&
38985 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38986 Exim administrator who does not have the root password, or by someone who has
38987 penetrated the Exim (but not the root) account. These options are as follows:
38988
38989 .ilist
38990 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38991 start of any filenames used with the &%-C%& option. When it is set, these
38992 filenames are also not allowed to contain the sequence &"/../"&. (However, if
38993 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38994 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38995 default setting for &%ALT_CONFIG_PREFIX%&.
38996
38997 If the permitted configuration files are confined to a directory to
38998 which only root has access, this guards against someone who has broken
38999 into the Exim account from running a privileged Exim with an arbitrary
39000 configuration file, and using it to break into other accounts.
39001 .next
39002
39003 If a non-trusted configuration file (i.e. not the default configuration file
39004 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39005 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39006 the next item), then root privilege is retained only if the caller of Exim is
39007 root. This locks out the possibility of testing a configuration using &%-C%&
39008 right through message reception and delivery, even if the caller is root. The
39009 reception works, but by that time, Exim is running as the Exim user, so when
39010 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39011 privilege to be lost. However, root can test reception and delivery using two
39012 separate commands.
39013
39014 .next
39015 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39016 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39017 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39018 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39019 the restrictive side.  Requiring build-time selection of safe macros is onerous
39020 but this option is intended solely as a transition mechanism to permit
39021 previously-working configurations to continue to work after release 4.73.
39022 .next
39023 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39024 is disabled.
39025 .next
39026 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39027 never to be used for any deliveries. This is like the &%never_users%& runtime
39028 option, but it cannot be overridden; the runtime option adds additional users
39029 to the list. The default setting is &"root"&; this prevents a non-root user who
39030 is permitted to modify the runtime file from using Exim as a way to get root.
39031 .endlist
39032
39033
39034
39035 .section "Root privilege" "SECID270"
39036 .cindex "setuid"
39037 .cindex "root privilege"
39038 The Exim binary is normally setuid to root, which means that it gains root
39039 privilege (runs as root) when it starts execution. In some special cases (for
39040 example, when the daemon is not in use and there are no local deliveries), it
39041 may be possible to run Exim setuid to some user other than root. This is
39042 discussed in the next section. However, in most installations, root privilege
39043 is required for two things:
39044
39045 .ilist
39046 To set up a socket connected to the standard SMTP port (25) when initialising
39047 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39048 not required.
39049 .next
39050 To be able to change uid and gid in order to read users' &_.forward_& files and
39051 perform local deliveries as the receiving user or as specified in the
39052 configuration.
39053 .endlist
39054
39055 It is not necessary to be root to do any of the other things Exim does, such as
39056 receiving messages and delivering them externally over SMTP, and it is
39057 obviously more secure if Exim does not run as root except when necessary.
39058 For this reason, a user and group for Exim to use must be defined in
39059 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39060 group"&. Their values can be changed by the runtime configuration, though this
39061 is not recommended. Often a user called &'exim'& is used, but some sites use
39062 &'mail'& or another user name altogether.
39063
39064 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39065 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39066 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39067
39068 After a new Exim process has interpreted its command line options, it changes
39069 uid and gid in the following cases:
39070
39071 .ilist
39072 .oindex "&%-C%&"
39073 .oindex "&%-D%&"
39074 If the &%-C%& option is used to specify an alternate configuration file, or if
39075 the &%-D%& option is used to define macro values for the configuration, and the
39076 calling process is not running as root, the uid and gid are changed to those of
39077 the calling process.
39078 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39079 option may not be used at all.
39080 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39081 can be supplied if the calling process is running as root, the Exim run-time
39082 user or CONFIGURE_OWNER, if defined.
39083 .next
39084 .oindex "&%-be%&"
39085 .oindex "&%-bf%&"
39086 .oindex "&%-bF%&"
39087 If the expansion test option (&%-be%&) or one of the filter testing options
39088 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39089 calling process.
39090 .next
39091 If the process is not a daemon process or a queue runner process or a delivery
39092 process or a process for testing address routing (started with &%-bt%&), the
39093 uid and gid are changed to the Exim user and group. This means that Exim always
39094 runs under its own uid and gid when receiving messages. This also applies when
39095 testing address verification
39096 .oindex "&%-bv%&"
39097 .oindex "&%-bh%&"
39098 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39099 option).
39100 .next
39101 For a daemon, queue runner, delivery, or address testing process, the uid
39102 remains as root at this stage, but the gid is changed to the Exim group.
39103 .endlist
39104
39105 The processes that initially retain root privilege behave as follows:
39106
39107 .ilist
39108 A daemon process changes the gid to the Exim group and the uid to the Exim
39109 user after setting up one or more listening sockets. The &[initgroups()]&
39110 function is called, so that if the Exim user is in any additional groups, they
39111 will be used during message reception.
39112 .next
39113 A queue runner process retains root privilege throughout its execution. Its
39114 job is to fork a controlled sequence of delivery processes.
39115 .next
39116 A delivery process retains root privilege throughout most of its execution,
39117 but any actual deliveries (that is, the transports themselves) are run in
39118 subprocesses which always change to a non-root uid and gid. For local
39119 deliveries this is typically the uid and gid of the owner of the mailbox; for
39120 remote deliveries, the Exim uid and gid are used. Once all the delivery
39121 subprocesses have been run, a delivery process changes to the Exim uid and gid
39122 while doing post-delivery tidying up such as updating the retry database and
39123 generating bounce and warning messages.
39124
39125 While the recipient addresses in a message are being routed, the delivery
39126 process runs as root. However, if a user's filter file has to be processed,
39127 this is done in a subprocess that runs under the individual user's uid and
39128 gid. A system filter is run as root unless &%system_filter_user%& is set.
39129 .next
39130 A process that is testing addresses (the &%-bt%& option) runs as root so that
39131 the routing is done in the same environment as a message delivery.
39132 .endlist
39133
39134
39135
39136
39137 .section "Running Exim without privilege" "SECTrunexiwitpri"
39138 .cindex "privilege, running without"
39139 .cindex "unprivileged running"
39140 .cindex "root privilege" "running without"
39141 Some installations like to run Exim in an unprivileged state for more of its
39142 operation, for added security. Support for this mode of operation is provided
39143 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39144 gid are changed to the Exim user and group at the start of a delivery process
39145 (and also queue runner and address testing processes). This means that address
39146 routing is no longer run as root, and the deliveries themselves cannot change
39147 to any other uid.
39148
39149 .cindex SIGHUP
39150 .cindex "daemon" "restarting"
39151 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39152 that the daemon can still be started in the usual way, and it can respond
39153 correctly to SIGHUP because the re-invocation regains root privilege.
39154
39155 An alternative approach is to make Exim setuid to the Exim user and also setgid
39156 to the Exim group. If you do this, the daemon must be started from a root
39157 process. (Calling Exim from a root process makes it behave in the way it does
39158 when it is setuid root.) However, the daemon cannot restart itself after a
39159 SIGHUP signal because it cannot regain privilege.
39160
39161 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39162 stops Exim from trying to re-invoke itself to do a delivery after a message has
39163 been received. Such a re-invocation is a waste of resources because it has no
39164 effect.
39165
39166 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39167 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39168 to the Exim user seems a clean approach, but there is one complication:
39169
39170 In this style of operation, Exim is running with the real uid and gid set to
39171 those of the calling process, and the effective uid/gid set to Exim's values.
39172 Ideally, any association with the calling process' uid/gid should be dropped,
39173 that is, the real uid/gid should be reset to the effective values so as to
39174 discard any privileges that the caller may have. While some operating systems
39175 have a function that permits this action for a non-root effective uid, quite a
39176 number of them do not. Because of this lack of standardization, Exim does not
39177 address this problem at this time.
39178
39179 For this reason, the recommended approach for &"mostly unprivileged"& running
39180 is to keep the Exim binary setuid to root, and to set
39181 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39182 be used in the most straightforward way.
39183
39184 If you configure Exim not to run delivery processes as root, there are a
39185 number of restrictions on what you can do:
39186
39187 .ilist
39188 You can deliver only as the Exim user/group. You should  explicitly use the
39189 &%user%& and &%group%& options to override routers or local transports that
39190 normally deliver as the recipient. This makes sure that configurations that
39191 work in this mode function the same way in normal mode. Any implicit or
39192 explicit specification of another user causes an error.
39193 .next
39194 Use of &_.forward_& files is severely restricted, such that it is usually
39195 not worthwhile to include them in the configuration.
39196 .next
39197 Users who wish to use &_.forward_& would have to make their home directory and
39198 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39199 and their equivalents in Exim filters, cannot be used. While they could be
39200 enabled in the Exim user's name, that would be insecure and not very useful.
39201 .next
39202 Unless the local user mailboxes are all owned by the Exim user (possible in
39203 some POP3 or IMAP-only environments):
39204
39205 .olist
39206 They must be owned by the Exim group and be writeable by that group. This
39207 implies you must set &%mode%& in the appendfile configuration, as well as the
39208 mode of the mailbox files themselves.
39209 .next
39210 You must set &%no_check_owner%&, since most or all of the files will not be
39211 owned by the Exim user.
39212 .next
39213 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39214 on a newly created mailbox when unprivileged. This also implies that new
39215 mailboxes need to be created manually.
39216 .endlist olist
39217 .endlist ilist
39218
39219
39220 These restrictions severely restrict what can be done in local deliveries.
39221 However, there are no restrictions on remote deliveries. If you are running a
39222 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39223 gives more security at essentially no cost.
39224
39225 If you are using the &%mua_wrapper%& facility (see chapter
39226 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39227
39228
39229
39230
39231 .section "Delivering to local files" "SECID271"
39232 Full details of the checks applied by &(appendfile)& before it writes to a file
39233 are given in chapter &<<CHAPappendfile>>&.
39234
39235
39236
39237 .section "Running local commands" "SECTsecconslocalcmds"
39238 .cindex "security" "local commands"
39239 .cindex "security" "command injection attacks"
39240 There are a number of ways in which an administrator can configure Exim to run
39241 commands based upon received, untrustworthy, data. Further, in some
39242 configurations a user who can control a &_.forward_& file can also arrange to
39243 run commands. Configuration to check includes, but is not limited to:
39244
39245 .ilist
39246 Use of &%use_shell%& in the pipe transport: various forms of shell command
39247 injection may be possible with this option present. It is dangerous and should
39248 be used only with considerable caution. Consider constraints which whitelist
39249 allowed characters in a variable which is to be used in a pipe transport that
39250 has &%use_shell%& enabled.
39251 .next
39252 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39253 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39254 &_.forward_& files in a redirect router. If Exim is running on a central mail
39255 hub to which ordinary users do not have shell access, but home directories are
39256 NFS mounted (for instance) then administrators should review the list of these
39257 forbid options available, and should bear in mind that the options that may
39258 need forbidding can change as new features are added between releases.
39259 .next
39260 The &%${run...}%& expansion item does not use a shell by default, but
39261 administrators can configure use of &_/bin/sh_& as part of the command.
39262 Such invocations should be viewed with prejudicial suspicion.
39263 .next
39264 Administrators who use embedded Perl are advised to explore how Perl's
39265 taint checking might apply to their usage.
39266 .next
39267 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39268 administrators are well advised to view its use with suspicion, in case (for
39269 instance) it allows a local-part to contain embedded Exim directives.
39270 .next
39271 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39272 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39273 each can reference arbitrary lists and files, rather than just being a list
39274 of opaque strings.
39275 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39276 real-world security vulnerabilities caused by its use with untrustworthy data
39277 injected in, for SQL injection attacks.
39278 Consider the use of the &%inlisti%& expansion condition instead.
39279 .endlist
39280
39281
39282
39283
39284 .section "Trust in configuration data" "SECTsecconfdata"
39285 .cindex "security" "data sources"
39286 .cindex "security" "regular expressions"
39287 .cindex "regular expressions" "security"
39288 .cindex "PCRE" "security"
39289 If configuration data for Exim can come from untrustworthy sources, there
39290 are some issues to be aware of:
39291
39292 .ilist
39293 Use of &%${expand...}%& may provide a path for shell injection attacks.
39294 .next
39295 Letting untrusted data provide a regular expression is unwise.
39296 .next
39297 Using &%${match...}%& to apply a fixed regular expression against untrusted
39298 data may result in pathological behaviour within PCRE.  Be aware of what
39299 "backtracking" means and consider options for being more strict with a regular
39300 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39301 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39302 possessive quantifiers or just not using regular expressions against untrusted
39303 data.
39304 .next
39305 It can be important to correctly use &%${quote:...}%&,
39306 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39307 items to ensure that data is correctly constructed.
39308 .next
39309 Some lookups might return multiple results, even though normal usage is only
39310 expected to yield one result.
39311 .endlist
39312
39313
39314
39315
39316 .section "IPv4 source routing" "SECID272"
39317 .cindex "source routing" "in IP packets"
39318 .cindex "IP source routing"
39319 Many operating systems suppress IP source-routed packets in the kernel, but
39320 some cannot be made to do this, so Exim does its own check. It logs incoming
39321 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39322 IPv6. No special checking is currently done.
39323
39324
39325
39326 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39327 Support for these SMTP commands is disabled by default. If required, they can
39328 be enabled by defining suitable ACLs.
39329
39330
39331
39332
39333 .section "Privileged users" "SECID274"
39334 .cindex "trusted users"
39335 .cindex "admin user"
39336 .cindex "privileged user"
39337 .cindex "user" "trusted"
39338 .cindex "user" "admin"
39339 Exim recognizes two sets of users with special privileges. Trusted users are
39340 able to submit new messages to Exim locally, but supply their own sender
39341 addresses and information about a sending host. For other users submitting
39342 local messages, Exim sets up the sender address from the uid, and doesn't
39343 permit a remote host to be specified.
39344
39345 .oindex "&%-f%&"
39346 However, an untrusted user is permitted to use the &%-f%& command line option
39347 in the special form &%-f <>%& to indicate that a delivery failure for the
39348 message should not cause an error report. This affects the message's envelope,
39349 but it does not affect the &'Sender:'& header. Untrusted users may also be
39350 permitted to use specific forms of address with the &%-f%& option by setting
39351 the &%untrusted_set_sender%& option.
39352
39353 Trusted users are used to run processes that receive mail messages from some
39354 other mail domain and pass them on to Exim for delivery either locally, or over
39355 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39356 as any user listed in the &%trusted_users%& configuration option, or under any
39357 group listed in the &%trusted_groups%& option.
39358
39359 Admin users are permitted to do things to the messages on Exim's queue. They
39360 can freeze or thaw messages, cause them to be returned to their senders, remove
39361 them entirely, or modify them in various ways. In addition, admin users can run
39362 the Exim monitor and see all the information it is capable of providing, which
39363 includes the contents of files on the spool.
39364
39365 .oindex "&%-M%&"
39366 .oindex "&%-q%&"
39367 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39368 delivery of messages on its queue is restricted to admin users. This
39369 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39370 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39371 queue is also restricted to admin users. This restriction can be relaxed by
39372 setting &%no_queue_list_requires_admin%&.
39373
39374 Exim recognizes an admin user if the calling process is running as root or as
39375 the Exim user or if any of the groups associated with the calling process is
39376 the Exim group. It is not necessary actually to be running under the Exim
39377 group. However, if admin users who are not root or the Exim user are to access
39378 the contents of files on the spool via the Exim monitor (which runs
39379 unprivileged), Exim must be built to allow group read access to its spool
39380 files.
39381
39382 By default, regular users are trusted to perform basic testing and
39383 introspection commands, as themselves.  This setting can be tightened by
39384 setting the &%commandline_checks_require_admin%& option.
39385 This affects most of the checking options,
39386 such as &%-be%& and anything else &%-b*%&.
39387
39388
39389 .section "Spool files" "SECID275"
39390 .cindex "spool directory" "files"
39391 Exim's spool directory and everything it contains is owned by the Exim user and
39392 set to the Exim group. The mode for spool files is defined in the
39393 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39394 any user who is a member of the Exim group can access these files.
39395
39396
39397
39398 .section "Use of argv[0]" "SECID276"
39399 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39400 of specific strings, Exim assumes certain options. For example, calling Exim
39401 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39402 to calling it with the option &%-bS%&. There are no security implications in
39403 this.
39404
39405
39406
39407 .section "Use of %f formatting" "SECID277"
39408 The only use made of &"%f"& by Exim is in formatting load average values. These
39409 are actually stored in integer variables as 1000 times the load average.
39410 Consequently, their range is limited and so therefore is the length of the
39411 converted output.
39412
39413
39414
39415 .section "Embedded Exim path" "SECID278"
39416 Exim uses its own path name, which is embedded in the code, only when it needs
39417 to re-exec in order to regain root privilege. Therefore, it is not root when it
39418 does so. If some bug allowed the path to get overwritten, it would lead to an
39419 arbitrary program's being run as exim, not as root.
39420
39421
39422
39423 .section "Dynamic module directory" "SECTdynmoddir"
39424 Any dynamically loadable modules must be installed into the directory
39425 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39426 loading it.
39427
39428
39429 .section "Use of sprintf()" "SECID279"
39430 .cindex "&[sprintf()]&"
39431 A large number of occurrences of &"sprintf"& in the code are actually calls to
39432 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39433 The intermediate formatting is done into a large fixed buffer by a function
39434 that runs through the format string itself, and checks the length of each
39435 conversion before performing it, thus preventing buffer overruns.
39436
39437 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39438 the output buffer is known to be sufficiently long to contain the converted
39439 string.
39440
39441
39442
39443 .section "Use of debug_printf() and log_write()" "SECID280"
39444 Arbitrary strings are passed to both these functions, but they do their
39445 formatting by calling the function &'string_vformat()'&, which runs through
39446 the format string itself, and checks the length of each conversion.
39447
39448
39449
39450 .section "Use of strcat() and strcpy()" "SECID281"
39451 These are used only in cases where the output buffer is known to be large
39452 enough to hold the result.
39453 .ecindex IIDsecurcon
39454
39455
39456
39457
39458 . ////////////////////////////////////////////////////////////////////////////
39459 . ////////////////////////////////////////////////////////////////////////////
39460
39461 .chapter "Format of spool files" "CHAPspool"
39462 .scindex IIDforspo1 "format" "spool files"
39463 .scindex IIDforspo2 "spool directory" "format of files"
39464 .scindex IIDforspo3 "spool files" "format of"
39465 .cindex "spool files" "editing"
39466 A message on Exim's queue consists of two files, whose names are the message id
39467 followed by -D and -H, respectively. The data portion of the message is kept in
39468 the -D file on its own. The message's envelope, status, and headers are all
39469 kept in the -H file, whose format is described in this chapter. Each of these
39470 two files contains the final component of its own name as its first line. This
39471 is insurance against disk crashes where the directory is lost but the files
39472 themselves are recoverable.
39473
39474 The file formats may be changed, or new formats added, at any release.
39475 Spool files are not intended as an interface to other programs
39476 and should not be used as such.
39477
39478 Some people are tempted into editing -D files in order to modify messages. You
39479 need to be extremely careful if you do this; it is not recommended and you are
39480 on your own if you do it. Here are some of the pitfalls:
39481
39482 .ilist
39483 You must ensure that Exim does not try to deliver the message while you are
39484 fiddling with it. The safest way is to take out a write lock on the -D file,
39485 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39486 place, the lock will be retained. If you write a new file and rename it, the
39487 lock will be lost at the instant of rename.
39488 .next
39489 .vindex "&$body_linecount$&"
39490 If you change the number of lines in the file, the value of
39491 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39492 cause incomplete transmission of messages or undeliverable messages.
39493 .next
39494 If the message is in MIME format, you must take care not to break it.
39495 .next
39496 If the message is cryptographically signed, any change will invalidate the
39497 signature.
39498 .endlist
39499 All in all, modifying -D files is fraught with danger.
39500
39501 Files whose names end with -J may also be seen in the &_input_& directory (or
39502 its subdirectories when &%split_spool_directory%& is set). These are journal
39503 files, used to record addresses to which the message has been delivered during
39504 the course of a delivery attempt. If there are still undelivered recipients at
39505 the end, the -H file is updated, and the -J file is deleted. If, however, there
39506 is some kind of crash (for example, a power outage) before this happens, the -J
39507 file remains in existence. When Exim next processes the message, it notices the
39508 -J file and uses it to update the -H file before starting the next delivery
39509 attempt.
39510
39511 Files whose names end with -K or .eml may also be seen in the spool.
39512 These are temporaries used for DKIM or malware processing, when that is used.
39513 They should be tidied up by normal operations; any old ones are probably
39514 relics of crashes and can be removed.
39515
39516 .section "Format of the -H file" "SECID282"
39517 .cindex "uid (user id)" "in spool file"
39518 .cindex "gid (group id)" "in spool file"
39519 The second line of the -H file contains the login name for the uid of the
39520 process that called Exim to read the message, followed by the numerical uid and
39521 gid. For a locally generated message, this is normally the user who sent the
39522 message. For a message received over TCP/IP via the daemon, it is
39523 normally the Exim user.
39524
39525 The third line of the file contains the address of the message's sender as
39526 transmitted in the envelope, contained in angle brackets. The sender address is
39527 empty for bounce messages. For incoming SMTP mail, the sender address is given
39528 in the MAIL command. For locally generated mail, the sender address is
39529 created by Exim from the login name of the current user and the configured
39530 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39531 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39532 &"<>"& or an address that matches &%untrusted_set_senders%&.
39533
39534 The fourth line contains two numbers. The first is the time that the message
39535 was received, in the conventional Unix form &-- the number of seconds since the
39536 start of the epoch. The second number is a count of the number of messages
39537 warning of delayed delivery that have been sent to the sender.
39538
39539 There follow a number of lines starting with a hyphen. These can appear in any
39540 order, and are omitted when not relevant:
39541
39542 .vlist
39543 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39544 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39545 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39546 recognized, to provide backward compatibility. In the old format, a line of
39547 this form is present for every ACL variable that is not empty. The number
39548 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39549 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39550 the data string for the variable. The string itself starts at the beginning of
39551 the next line, and is followed by a newline character. It may contain internal
39552 newlines.
39553
39554 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39555 A line of this form is present for every ACL connection variable that is
39556 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39557 The length is the length of the data string for the variable. The string itself
39558 starts at the beginning of the next line, and is followed by a newline
39559 character. It may contain internal newlines.
39560
39561 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39562 A line of this form is present for every ACL message variable that is defined.
39563 Note that there is a space between &%-aclm%& and the rest of the name. The
39564 length is the length of the data string for the variable. The string itself
39565 starts at the beginning of the next line, and is followed by a newline
39566 character. It may contain internal newlines.
39567
39568 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39569 This is present if, when the message was received over SMTP, the value of
39570 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39571
39572 .vitem &%-allow_unqualified_recipient%&
39573 This is present if unqualified recipient addresses are permitted in header
39574 lines (to stop such addresses from being qualified if rewriting occurs at
39575 transport time). Local messages that were input using &%-bnq%& and remote
39576 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39577
39578 .vitem &%-allow_unqualified_sender%&
39579 This is present if unqualified sender addresses are permitted in header lines
39580 (to stop such addresses from being qualified if rewriting occurs at transport
39581 time). Local messages that were input using &%-bnq%& and remote messages from
39582 hosts that match &%sender_unqualified_hosts%& set this flag.
39583
39584 .vitem "&%-auth_id%&&~<&'text'&>"
39585 The id information for a message received on an authenticated SMTP connection
39586 &-- the value of the &$authenticated_id$& variable.
39587
39588 .vitem "&%-auth_sender%&&~<&'address'&>"
39589 The address of an authenticated sender &-- the value of the
39590 &$authenticated_sender$& variable.
39591
39592 .vitem "&%-body_linecount%&&~<&'number'&>"
39593 This records the number of lines in the body of the message, and is
39594 present unless &%-spool_file_wireformat%& is.
39595
39596 .vitem "&%-body_zerocount%&&~<&'number'&>"
39597 This records the number of binary zero bytes in the body of the message, and is
39598 present if the number is greater than zero.
39599
39600 .vitem &%-deliver_firsttime%&
39601 This is written when a new message is first added to the spool. When the spool
39602 file is updated after a deferral, it is omitted.
39603
39604 .vitem "&%-frozen%&&~<&'time'&>"
39605 .cindex "frozen messages" "spool data"
39606 The message is frozen, and the freezing happened at <&'time'&>.
39607
39608 .vitem "&%-helo_name%&&~<&'text'&>"
39609 This records the host name as specified by a remote host in a HELO or EHLO
39610 command.
39611
39612 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39613 This records the IP address of the host from which the message was received and
39614 the remote port number that was used. It is omitted for locally generated
39615 messages.
39616
39617 .vitem "&%-host_auth%&&~<&'text'&>"
39618 If the message was received on an authenticated SMTP connection, this records
39619 the name of the authenticator &-- the value of the
39620 &$sender_host_authenticated$& variable.
39621
39622 .vitem &%-host_lookup_failed%&
39623 This is present if an attempt to look up the sending host's name from its IP
39624 address failed. It corresponds to the &$host_lookup_failed$& variable.
39625
39626 .vitem "&%-host_name%&&~<&'text'&>"
39627 .cindex "reverse DNS lookup"
39628 .cindex "DNS" "reverse lookup"
39629 This records the name of the remote host from which the message was received,
39630 if the host name was looked up from the IP address when the message was being
39631 received. It is not present if no reverse lookup was done.
39632
39633 .vitem "&%-ident%&&~<&'text'&>"
39634 For locally submitted messages, this records the login of the originating user,
39635 unless it was a trusted user and the &%-oMt%& option was used to specify an
39636 ident value. For messages received over TCP/IP, this records the ident string
39637 supplied by the remote host, if any.
39638
39639 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39640 This records the IP address of the local interface and the port number through
39641 which a message was received from a remote host. It is omitted for locally
39642 generated messages.
39643
39644 .vitem &%-local%&
39645 The message is from a local sender.
39646
39647 .vitem &%-localerror%&
39648 The message is a locally-generated bounce message.
39649
39650 .vitem "&%-local_scan%&&~<&'string'&>"
39651 This records the data string that was returned by the &[local_scan()]& function
39652 when the message was received &-- the value of the &$local_scan_data$&
39653 variable. It is omitted if no data was returned.
39654
39655 .vitem &%-manual_thaw%&
39656 The message was frozen but has been thawed manually, that is, by an explicit
39657 Exim command rather than via the auto-thaw process.
39658
39659 .vitem &%-N%&
39660 A testing delivery process was started using the &%-N%& option to suppress any
39661 actual deliveries, but delivery was deferred. At any further delivery attempts,
39662 &%-N%& is assumed.
39663
39664 .vitem &%-received_protocol%&
39665 This records the value of the &$received_protocol$& variable, which contains
39666 the name of the protocol by which the message was received.
39667
39668 .vitem &%-sender_set_untrusted%&
39669 The envelope sender of this message was set by an untrusted local caller (used
39670 to ensure that the caller is displayed in queue listings).
39671
39672 .vitem "&%-spam_score_int%&&~<&'number'&>"
39673 If a message was scanned by SpamAssassin, this is present. It records the value
39674 of &$spam_score_int$&.
39675
39676 .vitem &%-spool_file_wireformat%&
39677 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39678 rather than Unix-format.
39679 The line-ending is CRLF rather than newline.
39680 There is still, however, no leading-dot-stuffing.
39681
39682 .vitem &%-tls_certificate_verified%&
39683 A TLS certificate was received from the client that sent this message, and the
39684 certificate was verified by the server.
39685
39686 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39687 When the message was received over an encrypted connection, this records the
39688 name of the cipher suite that was used.
39689
39690 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39691 When the message was received over an encrypted connection, and a certificate
39692 was received from the client, this records the Distinguished Name from that
39693 certificate.
39694 .endlist
39695
39696 .new
39697 Any of the above may have an extra hyphen prepended, to indicate the the
39698 corresponding data is untrusted.
39699 .wen
39700
39701 Following the options there is a list of those addresses to which the message
39702 is not to be delivered. This set of addresses is initialized from the command
39703 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39704 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39705 the address is added to this set. The addresses are kept internally as a
39706 balanced binary tree, and it is a representation of that tree which is written
39707 to the spool file. If an address is expanded via an alias or forward file, the
39708 original address is added to the tree when deliveries to all its child
39709 addresses are complete.
39710
39711 If the tree is empty, there is a single line in the spool file containing just
39712 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39713 Y or N, followed by an address. The address is the value for the node of the
39714 tree, and the letters indicate whether the node has a left branch and/or a
39715 right branch attached to it, respectively. If branches exist, they immediately
39716 follow. Here is an example of a three-node tree:
39717 .code
39718 YY darcy@austen.fict.example
39719 NN alice@wonderland.fict.example
39720 NN editor@thesaurus.ref.example
39721 .endd
39722 After the non-recipients tree, there is a list of the message's recipients.
39723 This is a simple list, preceded by a count. It includes all the original
39724 recipients of the message, including those to whom the message has already been
39725 delivered. In the simplest case, the list contains one address per line. For
39726 example:
39727 .code
39728 4
39729 editor@thesaurus.ref.example
39730 darcy@austen.fict.example
39731 rdo@foundation
39732 alice@wonderland.fict.example
39733 .endd
39734 However, when a child address has been added to the top-level addresses as a
39735 result of the use of the &%one_time%& option on a &(redirect)& router, each
39736 line is of the following form:
39737 .display
39738 <&'top-level address'&> <&'errors_to address'&> &&&
39739   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39740 .endd
39741 The 01 flag bit indicates the presence of the three other fields that follow
39742 the top-level address. Other bits may be used in future to support additional
39743 fields. The <&'parent number'&> is the offset in the recipients list of the
39744 original parent of the &"one time"& address. The first two fields are the
39745 envelope sender that is associated with this address and its length. If the
39746 length is zero, there is no special envelope sender (there are then two space
39747 characters in the line). A non-empty field can arise from a &(redirect)& router
39748 that has an &%errors_to%& setting.
39749
39750
39751 A blank line separates the envelope and status information from the headers
39752 which follow. A header may occupy several lines of the file, and to save effort
39753 when reading it in, each header is preceded by a number and an identifying
39754 character. The number is the number of characters in the header, including any
39755 embedded newlines and the terminating newline. The character is one of the
39756 following:
39757
39758 .table2 50pt
39759 .row <&'blank'&>         "header in which Exim has no special interest"
39760 .row &`B`&               "&'Bcc:'& header"
39761 .row &`C`&               "&'Cc:'& header"
39762 .row &`F`&               "&'From:'& header"
39763 .row &`I`&               "&'Message-id:'& header"
39764 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39765 .row &`R`&               "&'Reply-To:'& header"
39766 .row &`S`&               "&'Sender:'& header"
39767 .row &`T`&               "&'To:'& header"
39768 .row &`*`&               "replaced or deleted header"
39769 .endtable
39770
39771 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39772 purposes. They are not transmitted when the message is delivered. Here is a
39773 typical set of headers:
39774 .code
39775 111P Received: by hobbit.fict.example with local (Exim 4.00)
39776 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39777 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39778 038* X-rewrote-sender: bb@hobbit.fict.example
39779 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39780 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39781 099* To: alice@wonderland.fict.example, rdo@foundation,
39782 darcy@austen.fict.example, editor@thesaurus.ref.example
39783 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39784 darcy@austen.fict.example, editor@thesaurus.ref.example
39785 038  Date: Fri, 11 May 2001 10:28:59 +0100
39786 .endd
39787 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39788 &'To:'& header have been rewritten, the last one because routing expanded the
39789 unqualified domain &'foundation'&.
39790 .ecindex IIDforspo1
39791 .ecindex IIDforspo2
39792 .ecindex IIDforspo3
39793
39794 .section "Format of the -D file" "SECID282a"
39795 The data file is traditionally in Unix-standard format: lines are ended with
39796 an ASCII newline character.
39797 However, when the &%spool_wireformat%& main option is used some -D files
39798 can have an alternate format.
39799 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39800 The -D file lines (not including the first name-component line) are
39801 suitable for direct copying to the wire when transmitting using the
39802 ESMTP CHUNKING option, meaning lower processing overhead.
39803 Lines are terminated with an ASCII CRLF pair.
39804 There is no dot-stuffing (and no dot-termination).
39805
39806 . ////////////////////////////////////////////////////////////////////////////
39807 . ////////////////////////////////////////////////////////////////////////////
39808
39809 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
39810          "DKIM, SPF and DMARC Support"
39811
39812 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39813 .cindex "DKIM"
39814
39815 DKIM is a mechanism by which messages sent by some entity can be provably
39816 linked to a domain which that entity controls.  It permits reputation to
39817 be tracked on a per-domain basis, rather than merely upon source IP address.
39818 DKIM is documented in RFC 6376.
39819
39820 As DKIM relies on the message being unchanged in transit, messages handled
39821 by a mailing-list (which traditionally adds to the message) will not match
39822 any original DKIM signature.
39823
39824 DKIM support is compiled into Exim by default if TLS support is present.
39825 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39826
39827 Exim's DKIM implementation allows for
39828 .olist
39829 Signing outgoing messages: This function is implemented in the SMTP transport.
39830 It can co-exist with all other Exim features
39831 (including transport filters)
39832 except cutthrough delivery.
39833 .next
39834 Verifying signatures in incoming messages: This is implemented by an additional
39835 ACL (acl_smtp_dkim), which can be called several times per message, with
39836 different signature contexts.
39837 .endlist
39838
39839 In typical Exim style, the verification implementation does not include any
39840 default "policy". Instead it enables you to build your own policy using
39841 Exim's standard controls.
39842
39843 Please note that verification of DKIM signatures in incoming mail is turned
39844 on by default for logging (in the <= line) purposes.
39845
39846 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39847 When set, for each signature in incoming email,
39848 exim will log a line displaying the most important signature details, and the
39849 signature status. Here is an example (with line-breaks added for clarity):
39850 .code
39851 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39852     d=facebookmail.com s=q1-2009b
39853     c=relaxed/relaxed a=rsa-sha1
39854     i=@facebookmail.com t=1252484542 [verification succeeded]
39855 .endd
39856
39857 You might want to turn off DKIM verification processing entirely for internal
39858 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39859 control modifier. This should typically be done in the RCPT ACL, at points
39860 where you accept mail from relay sources (internal hosts or authenticated
39861 senders).
39862
39863
39864 .section "Signing outgoing messages" "SECDKIMSIGN"
39865 .cindex "DKIM" "signing"
39866
39867 For signing to be usable you must have published a DKIM record in DNS.
39868 Note that RFC 8301 (which does not cover EC keys) says:
39869 .code
39870 rsa-sha1 MUST NOT be used for signing or verifying.
39871
39872 Signers MUST use RSA keys of at least 1024 bits for all keys.
39873 Signers SHOULD use RSA keys of at least 2048 bits.
39874 .endd
39875
39876 Note also that the key content (the 'p=' field)
39877 in the DNS record is different between RSA and EC keys;
39878 for the former it is the base64 of the ASN.1 for the RSA public key
39879 (equivalent to the private-key .pem with the header/trailer stripped)
39880 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39881
39882 Signing is enabled by setting private options on the SMTP transport.
39883 These options take (expandable) strings as arguments.
39884
39885 .option dkim_domain smtp string list&!! unset
39886 The domain(s) you want to sign with.
39887 After expansion, this can be a list.
39888 Each element in turn,
39889 .new
39890 lowercased,
39891 .wen
39892 is put into the &%$dkim_domain%& expansion variable
39893 while expanding the remaining signing options.
39894 If it is empty after expansion, DKIM signing is not done,
39895 and no error will result even if &%dkim_strict%& is set.
39896
39897 .option dkim_selector smtp string list&!! unset
39898 This sets the key selector string.
39899 After expansion, which can use &$dkim_domain$&, this can be a list.
39900 Each element in turn is put in the expansion
39901 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39902 option along with &%$dkim_domain%&.
39903 If the option is empty after expansion, DKIM signing is not done for this domain,
39904 and no error will result even if &%dkim_strict%& is set.
39905
39906 .option dkim_private_key smtp string&!! unset
39907 This sets the private key to use.
39908 You can use the &%$dkim_domain%& and
39909 &%$dkim_selector%& expansion variables to determine the private key to use.
39910 The result can either
39911 .ilist
39912 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39913 .next
39914 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39915 be a valid Ed25519 private key (same format as above)
39916 .next
39917 start with a slash, in which case it is treated as a file that contains
39918 the private key
39919 .next
39920 be "0", "false" or the empty string, in which case the message will not
39921 be signed. This case will not result in an error, even if &%dkim_strict%&
39922 is set.
39923 .endlist
39924
39925 To generate keys under OpenSSL:
39926 .code
39927 openssl genrsa -out dkim_rsa.private 2048
39928 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39929 .endd
39930 Take the base-64 lines from the output of the second command, concatenated,
39931 for the DNS TXT record.
39932 See section 3.6 of RFC6376 for the record specification.
39933
39934 Under GnuTLS:
39935 .code
39936 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39937 certtool --load-privkey=dkim_rsa.private --pubkey-info
39938 .endd
39939
39940 Note that RFC 8301 says:
39941 .code
39942 Signers MUST use RSA keys of at least 1024 bits for all keys.
39943 Signers SHOULD use RSA keys of at least 2048 bits.
39944 .endd
39945
39946 .new
39947 EC keys for DKIM are defined by RFC 8463.
39948 .wen
39949 They are considerably smaller than RSA keys for equivalent protection.
39950 As they are a recent development, users should consider dual-signing
39951 (by setting a list of selectors, and an expansion for this option)
39952 for some transition period.
39953 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39954 for EC keys.
39955
39956 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39957 .code
39958 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39959 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39960 .endd
39961
39962 To produce the required public key value for a DNS record:
39963 .code
39964 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39965 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39966 .endd
39967
39968 .new
39969 Exim also supports an alternate format
39970 of Ed25519 keys in DNS which was a candidate during development
39971 of the standard, but not adopted.
39972 A future release will probably drop that support.
39973 .wen
39974
39975 .option dkim_hash smtp string&!! sha256
39976 Can be set to any one of the supported hash methods, which are:
39977 .ilist
39978 &`sha1`& &-- should not be used, is old and insecure
39979 .next
39980 &`sha256`& &-- the default
39981 .next
39982 &`sha512`& &-- possibly more secure but less well supported
39983 .endlist
39984
39985 Note that RFC 8301 says:
39986 .code
39987 rsa-sha1 MUST NOT be used for signing or verifying.
39988 .endd
39989
39990 .option dkim_identity smtp string&!! unset
39991 If set after expansion, the value is used to set an "i=" tag in
39992 the signing header.  The DKIM standards restrict the permissible
39993 syntax of this optional tag to a mail address, with possibly-empty
39994 local part, an @, and a domain identical to or subdomain of the "d="
39995 tag value.  Note that Exim does not check the value.
39996
39997 .option dkim_canon smtp string&!! unset
39998 This option sets the canonicalization method used when signing a message.
39999 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40000 The option defaults to "relaxed" when unset. Note: the current implementation
40001 only supports signing with the same canonicalization method for both headers and body.
40002
40003 .option dkim_strict smtp string&!! unset
40004 This  option  defines  how  Exim  behaves  when  signing a message that
40005 should be signed fails for some reason.  When the expansion evaluates to
40006 either "1" or "true", Exim will defer. Otherwise Exim will send the message
40007 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40008 variables here.
40009
40010 .option dkim_sign_headers smtp string&!! "see below"
40011 If set, this option must expand to a colon-separated
40012 list of header names.
40013 Headers with these names, or the absence or such a header, will be included
40014 in the message signature.
40015 When unspecified, the header names listed in RFC4871 will be used,
40016 whether or not each header is present in the message.
40017 The default list is available for the expansion in the macro
40018 "_DKIM_SIGN_HEADERS".
40019
40020 If a name is repeated, multiple headers by that name (or the absence thereof)
40021 will be signed.  The textually later headers in the headers part of the
40022 message are signed first, if there are multiples.
40023
40024 A name can be prefixed with either an '=' or a '+' character.
40025 If an '=' prefix is used, all headers that are present with this name
40026 will be signed.
40027 If a '+' prefix if used, all headers that are present with this name
40028 will be signed, and one signature added for a missing header with the
40029 name will be appended.
40030
40031 .option dkim_timestamps smtp integer&!! unset
40032 This option controls the inclusion of timestamp information in the signature.
40033 If not set, no such information will be included.
40034 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40035 for the expiry tag
40036 (eg. 1209600 for two weeks);
40037 both creation (t=) and expiry (x=) tags will be included.
40038
40039 RFC 6376 lists these tags as RECOMMENDED.
40040
40041
40042 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40043 .cindex "DKIM" "verification"
40044
40045 Verification of DKIM signatures in SMTP incoming email is done for all
40046 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40047 .new
40048 .cindex DKIM "selecting signature algorithms"
40049 Individual classes of signature algorithm can be ignored by changing
40050 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40051 The &%dkim_verify_minimal%& option can be set to cease verification
40052 processing for a message once the first passing signature is found.
40053 .wen
40054
40055 .cindex authentication "expansion item"
40056 Performing verification sets up information used by the
40057 &%authresults%& expansion item.
40058
40059 .new
40060 For most purposes the default option settings suffice and the remainder
40061 of this section can be ignored.
40062 .wen
40063
40064 The results of verification are made available to the
40065 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40066 A missing ACL definition defaults to accept.
40067 By default, the ACL is called once for each
40068 syntactically(!) correct signature in the incoming message.
40069 If any ACL call does not accept, the message is not accepted.
40070 If a cutthrough delivery was in progress for the message, that is
40071 summarily dropped (having wasted the transmission effort).
40072
40073 To evaluate the verification result in the ACL
40074 a large number of expansion variables
40075 containing the signature status and its details are set up during the
40076 runtime of the ACL.
40077
40078 Calling the ACL only for existing signatures is not sufficient to build
40079 more advanced policies. For that reason, the main option
40080 &%dkim_verify_signers%&, and an expansion variable
40081 &%$dkim_signers%& exist.
40082
40083 The main option &%dkim_verify_signers%& can be set to a colon-separated
40084 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40085 called. It is expanded when the message has been received. At this point,
40086 the expansion variable &%$dkim_signers%& already contains a colon-separated
40087 list of signer domains and identities for the message. When
40088 &%dkim_verify_signers%& is not specified in the main configuration,
40089 it defaults as:
40090 .code
40091 dkim_verify_signers = $dkim_signers
40092 .endd
40093 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40094 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40095 call the ACL for known domains or identities. This would be achieved as follows:
40096 .code
40097 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40098 .endd
40099 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40100 and "ebay.com", plus all domains and identities that have signatures in the message.
40101 You can also be more creative in constructing your policy. For example:
40102 .code
40103 dkim_verify_signers = $sender_address_domain:$dkim_signers
40104 .endd
40105
40106 If a domain or identity is listed several times in the (expanded) value of
40107 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40108
40109 .new
40110 Note that if the option is set using untrustworthy data
40111 (such as the From: header)
40112 care should be taken to force lowercase for domains
40113 and for the domain part if identities.
40114 The default setting can be regarded as trustworthy in this respect.
40115 .wen
40116
40117 If multiple signatures match a domain (or identity), the ACL is called once
40118 for each matching signature.
40119
40120
40121 Inside the DKIM ACL, the following expansion variables are
40122 available (from most to least important):
40123
40124
40125 .vlist
40126 .vitem &%$dkim_cur_signer%&
40127 The signer that is being evaluated in this ACL run. This can be a domain or
40128 an identity. This is one of the list items from the expanded main option
40129 &%dkim_verify_signers%& (see above).
40130
40131 .vitem &%$dkim_verify_status%&
40132 Within the DKIM ACL,
40133 a string describing the general status of the signature. One of
40134 .ilist
40135 &%none%&: There is no signature in the message for the current domain or
40136 identity (as reflected by &%$dkim_cur_signer%&).
40137 .next
40138 &%invalid%&: The signature could not be verified due to a processing error.
40139 More detail is available in &%$dkim_verify_reason%&.
40140 .next
40141 &%fail%&: Verification of the signature failed.  More detail is
40142 available in &%$dkim_verify_reason%&.
40143 .next
40144 &%pass%&: The signature passed verification. It is valid.
40145 .endlist
40146
40147 This variable can be overwritten using an ACL 'set' modifier.
40148 This might, for instance, be done to enforce a policy restriction on
40149 hash-method or key-size:
40150 .code
40151   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40152        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40153        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40154                                   {< {$dkim_key_length}{1024}}}}
40155        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40156        set dkim_verify_status = fail
40157        set dkim_verify_reason = hash too weak or key too short
40158 .endd
40159
40160 So long as a DKIM ACL is defined (it need do no more than accept),
40161 after all the DKIM ACL runs have completed, the value becomes a
40162 colon-separated list of the values after each run.
40163 This is maintained for the mime, prdr and data ACLs.
40164
40165 .vitem &%$dkim_verify_reason%&
40166 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40167 "fail" or "invalid". One of
40168 .ilist
40169 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40170 key for the domain could not be retrieved. This may be a temporary problem.
40171 .next
40172 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40173 record for the domain is syntactically invalid.
40174 .next
40175 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40176 body hash does not match the one specified in the signature header. This
40177 means that the message body was modified in transit.
40178 .next
40179 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40180 could not be verified. This may mean that headers were modified,
40181 re-written or otherwise changed in a way which is incompatible with
40182 DKIM verification. It may of course also mean that the signature is forged.
40183 .endlist
40184
40185 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40186
40187 .vitem &%$dkim_domain%&
40188 The signing domain. IMPORTANT: This variable is only populated if there is
40189 an actual signature in the message for the current domain or identity (as
40190 reflected by &%$dkim_cur_signer%&).
40191
40192 .vitem &%$dkim_identity%&
40193 The signing identity, if present. IMPORTANT: This variable is only populated
40194 if there is an actual signature in the message for the current domain or
40195 identity (as reflected by &%$dkim_cur_signer%&).
40196
40197 .vitem &%$dkim_selector%&
40198 The key record selector string.
40199
40200 .vitem &%$dkim_algo%&
40201 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40202 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40203 may also be 'ed25519-sha256'.
40204 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40205 for EC keys.
40206
40207 Note that RFC 8301 says:
40208 .code
40209 rsa-sha1 MUST NOT be used for signing or verifying.
40210
40211 DKIM signatures identified as having been signed with historic
40212 algorithms (currently, rsa-sha1) have permanently failed evaluation
40213 .endd
40214
40215 To enforce this you must either have a DKIM ACL which checks this variable
40216 and overwrites the &$dkim_verify_status$& variable as discussed above,
40217 .new
40218 or have set the main option &%dkim_verify_hashes%& to exclude
40219 processing of such signatures.
40220 .wen
40221
40222 .vitem &%$dkim_canon_body%&
40223 The body canonicalization method. One of 'relaxed' or 'simple'.
40224
40225 .vitem &%$dkim_canon_headers%&
40226 The header canonicalization method. One of 'relaxed' or 'simple'.
40227
40228 .vitem &%$dkim_copiedheaders%&
40229 A transcript of headers and their values which are included in the signature
40230 (copied from the 'z=' tag of the signature).
40231 Note that RFC6376 requires that verification fail if the From: header is
40232 not included in the signature.  Exim does not enforce this; sites wishing
40233 strict enforcement should code the check explicitly.
40234
40235 .vitem &%$dkim_bodylength%&
40236 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40237 limit was set by the signer, "9999999999999" is returned. This makes sure
40238 that this variable always expands to an integer value.
40239 &*Note:*& The presence of the signature tag specifying a signing body length
40240 is one possible route to spoofing of valid DKIM signatures.
40241 A paranoid implementation might wish to regard signature where this variable
40242 shows less than the "no limit" return as being invalid.
40243
40244 .vitem &%$dkim_created%&
40245 UNIX timestamp reflecting the date and time when the signature was created.
40246 When this was not specified by the signer, "0" is returned.
40247
40248 .vitem &%$dkim_expires%&
40249 UNIX timestamp reflecting the date and time when the signer wants the
40250 signature to be treated as "expired". When this was not specified by the
40251 signer, "9999999999999" is returned. This makes it possible to do useful
40252 integer size comparisons against this value.
40253 Note that Exim does not check this value.
40254
40255 .vitem &%$dkim_headernames%&
40256 A colon-separated list of names of headers included in the signature.
40257
40258 .vitem &%$dkim_key_testing%&
40259 "1" if the key record has the "testing" flag set, "0" if not.
40260
40261 .vitem &%$dkim_key_nosubdomains%&
40262 "1" if the key record forbids subdomaining, "0" otherwise.
40263
40264 .vitem &%$dkim_key_srvtype%&
40265 Service type (tag s=) from the key record. Defaults to "*" if not specified
40266 in the key record.
40267
40268 .vitem &%$dkim_key_granularity%&
40269 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40270 in the key record.
40271
40272 .vitem &%$dkim_key_notes%&
40273 Notes from the key record (tag n=).
40274
40275 .vitem &%$dkim_key_length%&
40276 Number of bits in the key.
40277
40278 Note that RFC 8301 says:
40279 .code
40280 Verifiers MUST NOT consider signatures using RSA keys of
40281 less than 1024 bits as valid signatures.
40282 .endd
40283
40284 To enforce this you must have a DKIM ACL which checks this variable
40285 and overwrites the &$dkim_verify_status$& variable as discussed above.
40286 As EC keys are much smaller, the check should only do this for RSA keys.
40287
40288 .endlist
40289
40290 In addition, two ACL conditions are provided:
40291
40292 .vlist
40293 .vitem &%dkim_signers%&
40294 ACL condition that checks a colon-separated list of domains or identities
40295 for a match against the domain or identity that the ACL is currently verifying
40296 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40297 verb to a group of domains or identities. For example:
40298
40299 .code
40300 # Warn when Mail purportedly from GMail has no gmail signature
40301 warn log_message = GMail sender without gmail.com DKIM signature
40302      sender_domains = gmail.com
40303      dkim_signers = gmail.com
40304      dkim_status = none
40305 .endd
40306
40307 Note that the above does not check for a total lack of DKIM signing;
40308 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40309
40310 .vitem &%dkim_status%&
40311 ACL condition that checks a colon-separated list of possible DKIM verification
40312 results against the actual result of verification. This is typically used
40313 to restrict an ACL verb to a list of verification outcomes, for example:
40314
40315 .code
40316 deny message = Mail from Paypal with invalid/missing signature
40317      sender_domains = paypal.com:paypal.de
40318      dkim_signers = paypal.com:paypal.de
40319      dkim_status = none:invalid:fail
40320 .endd
40321
40322 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40323 see the documentation of the &%$dkim_verify_status%& expansion variable above
40324 for more information of what they mean.
40325 .endlist
40326
40327
40328
40329
40330 .section "SPF (Sender Policy Framework)" SECSPF
40331 .cindex SPF verification
40332
40333 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40334 messages with its domain in the envelope from, documented by RFC 7208.
40335 For more information on SPF see &url(http://www.openspf.org).
40336 . --- 2018-09-07: still not https
40337
40338 Messages sent by a system not authorised will fail checking of such assertions.
40339 This includes retransmissions done by traditional forwarders.
40340
40341 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40342 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40343 &url(https://www.libspf2.org/).
40344 There is no Exim involvement in the transmission of messages;
40345 publishing certain DNS records is all that is required.
40346
40347 For verification, an ACL condition and an expansion lookup are provided.
40348 .cindex authentication "expansion item"
40349 Performing verification sets up information used by the
40350 &%authresults%& expansion item.
40351
40352
40353 .cindex SPF "ACL condition"
40354 .cindex ACL "spf condition"
40355 The ACL condition "spf" can be used at or after the MAIL ACL.
40356 It takes as an argument a list of strings giving the outcome of the SPF check,
40357 and will succeed for any matching outcome.
40358 Valid strings are:
40359 .vlist
40360 .vitem &%pass%&
40361 The SPF check passed, the sending host is positively verified by SPF.
40362
40363 .vitem &%fail%&
40364 The SPF check failed, the sending host is NOT allowed to send mail for the
40365 domain in the envelope-from address.
40366
40367 .vitem &%softfail%&
40368 The SPF check failed, but the queried domain can't absolutely confirm that this
40369 is a forgery.
40370
40371 .vitem &%none%&
40372 The queried domain does not publish SPF records.
40373
40374 .vitem &%neutral%&
40375 The SPF check returned a "neutral" state.  This means the queried domain has
40376 published a SPF record, but wants to allow outside servers to send mail under
40377 its domain as well.  This should be treated like "none".
40378
40379 .vitem &%permerror%&
40380 This indicates a syntax error in the SPF record of the queried domain.
40381 You may deny messages when this occurs.
40382
40383 .vitem &%temperror%&
40384 This indicates a temporary error during all processing, including Exim's
40385 SPF processing.  You may defer messages when this occurs.
40386 .endlist
40387
40388 You can prefix each string with an exclamation mark to  invert
40389 its meaning,  for example  "!fail" will  match all  results but
40390 "fail".  The  string  list is  evaluated  left-to-right,  in a
40391 short-circuit fashion.
40392
40393 Example:
40394 .code
40395 deny spf = fail
40396      message = $sender_host_address is not allowed to send mail from \
40397                ${if def:sender_address_domain \
40398                     {$sender_address_domain}{$sender_helo_name}}.  \
40399                Please see http://www.openspf.org/Why?scope=\
40400                ${if def:sender_address_domain {mfrom}{helo}};\
40401                identity=${if def:sender_address_domain \
40402                              {$sender_address}{$sender_helo_name}};\
40403                ip=$sender_host_address
40404 .endd
40405
40406 When the spf condition has run, it sets up several expansion
40407 variables:
40408
40409 .cindex SPF "verification variables"
40410 .vlist
40411 .vitem &$spf_header_comment$&
40412 .vindex &$spf_header_comment$&
40413   This contains a human-readable string describing the outcome
40414   of the SPF check. You can add it to a custom header or use
40415   it for logging purposes.
40416
40417 .vitem &$spf_received$&
40418 .vindex &$spf_received$&
40419   This contains a complete Received-SPF: header that can be
40420   added to the message. Please note that according to the SPF
40421   draft, this header must be added at the top of the header
40422   list. Please see section 10 on how you can do this.
40423
40424   Note: in case of "Best-guess" (see below), the convention is
40425   to put this string in a header called X-SPF-Guess: instead.
40426
40427 .vitem &$spf_result$&
40428 .vindex &$spf_result$&
40429   This contains the outcome of the SPF check in string form,
40430   one of pass, fail, softfail, none, neutral, permerror or
40431   temperror.
40432
40433 .vitem &$spf_result_guessed$&
40434 .vindex &$spf_result_guessed$&
40435   This boolean is true only if a best-guess operation was used
40436   and required in order to obtain a result.
40437
40438 .vitem &$spf_smtp_comment$&
40439 .vindex &$spf_smtp_comment$&
40440   This contains a string that can be used in a SMTP response
40441   to the calling party. Useful for "fail".
40442 .endlist
40443
40444
40445 .cindex SPF "ACL condition"
40446 .cindex ACL "spf_guess condition"
40447 .cindex SPF "best guess"
40448 In addition to SPF, you can also perform checks for so-called
40449 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40450 SPF, but it is supported by the same framework that enables SPF
40451 capability.
40452 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
40453 for a description of what it means.
40454 . --- 2018-09-07: still not https:
40455
40456 To access this feature, simply use the spf_guess condition in place
40457 of the spf one.  For example:
40458
40459 .code
40460 deny spf_guess = fail
40461      message = $sender_host_address doesn't look trustworthy to me
40462 .endd
40463
40464 In case you decide to reject messages based on this check, you
40465 should note that although it uses the same framework, "Best-guess"
40466 is not SPF, and therefore you should not mention SPF at all in your
40467 reject message.
40468
40469 When the spf_guess condition has run, it sets up the same expansion
40470 variables as when spf condition is run, described above.
40471
40472 Additionally, since Best-guess is not standardized, you may redefine
40473 what "Best-guess" means to you by redefining the main configuration
40474 &%spf_guess%& option.
40475 For example, the following:
40476
40477 .code
40478 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40479 .endd
40480
40481 would relax host matching rules to a broader network range.
40482
40483
40484 .cindex SPF "lookup expansion"
40485 .cindex lookup spf
40486 A lookup expansion is also available. It takes an email
40487 address as the key and an IP address
40488 .new
40489 (v4 or v6)
40490 .wen
40491 as the database:
40492
40493 .code
40494   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40495 .endd
40496
40497 The lookup will return the same result strings as can appear in
40498 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40499
40500
40501
40502
40503
40504 .new
40505 .section DMARC SECDMARC
40506 .cindex DMARC verification
40507
40508 DMARC combines feedback from SPF, DKIM, and header From: in order
40509 to attempt to provide better indicators of the authenticity of an
40510 email.  This document does not explain the fundamentals; you
40511 should read and understand how it works by visiting the website at
40512 &url(http://www.dmarc.org/).
40513
40514 If Exim is built with DMARC support,
40515 the libopendmarc library is used.
40516
40517 For building Exim yourself, obtain the library from
40518 &url(http://sourceforge.net/projects/opendmarc/)
40519 to obtain a copy, or find it in your favorite rpm package
40520 repository.  You will need to attend to the local/Makefile feature
40521 SUPPORT_DMARC and the associated LDFLAGS addition.
40522 This description assumes
40523 that headers will be in /usr/local/include, and that the libraries
40524 are in /usr/local/lib.
40525
40526 . subsection
40527
40528 There are three main-configuration options:
40529 .cindex DMARC "configuration options"
40530
40531 The &%dmarc_tld_file%& option
40532 .oindex &%dmarc_tld_file%&
40533 defines the location of a text file of valid
40534 top level domains the opendmarc library uses
40535 during domain parsing. Maintained by Mozilla,
40536 the most current version can be downloaded
40537 from a link at &url(https://publicsuffix.org/list/, currently pointing
40538 at https://publicsuffix.org/list/public_suffix_list.dat)
40539 See also util/renew-opendmarc-tlds.sh script.
40540 The default for the option is /etc/exim/opendmarc.tlds.
40541
40542
40543 The &%dmarc_history_file%& option, if set
40544 .oindex &%dmarc_history_file%&
40545 defines the location of a file to log results
40546 of dmarc verification on inbound emails. The
40547 contents are importable by the opendmarc tools
40548 which will manage the data, send out DMARC
40549 reports, and expire the data. Make sure the
40550 directory of this file is writable by the user
40551 exim runs as.
40552 The default is unset.
40553
40554 The &%dmarc_forensic_sender%& option
40555 .oindex &%dmarc_forensic_sender%&
40556 defines an alternate email address to use when sending a
40557 forensic report detailing alignment failures
40558 if a sender domain's dmarc record specifies it
40559 and you have configured Exim to send them.
40560 If set, this is expanded and used for the
40561 From: header line; the address is extracted
40562 from it and used for the envelope from.
40563 If not set (the default), the From: header is expanded from
40564 the dsn_from option, and <> is used for the
40565 envelope from.
40566
40567 . I wish we had subsections...
40568
40569 .cindex DMARC controls
40570 By default, the DMARC processing will run for any remote,
40571 non-authenticated user.  It makes sense to only verify DMARC
40572 status of messages coming from remote, untrusted sources.  You can
40573 use standard conditions such as hosts, senders, etc, to decide that
40574 DMARC verification should *not* be performed for them and disable
40575 DMARC with a control setting:
40576 .code
40577   control = dmarc_disable_verify
40578 .endd
40579 A DMARC record can also specify a "forensic address", which gives
40580 exim an email address to submit reports about failed alignment.
40581 Exim does not do this by default because in certain conditions it
40582 results in unintended information leakage (what lists a user might
40583 be subscribed to, etc).  You must configure exim to submit forensic
40584 reports to the owner of the domain.  If the DMARC record contains a
40585 forensic address and you specify the control statement below, then
40586 exim will send these forensic emails.  It's also advised that you
40587 configure a dmarc_forensic_sender because the default sender address
40588 construction might be inadequate.
40589 .code
40590   control = dmarc_enable_forensic
40591 .endd
40592 (AGAIN: You can choose not to send these forensic reports by simply
40593 not putting the dmarc_enable_forensic control line at any point in
40594 your exim config.  If you don't tell it to send them, it will not
40595 send them.)
40596
40597 There are no options to either control.  Both must appear before
40598 the DATA acl.
40599
40600 . subsection
40601
40602 DMARC checks cam be run on incoming SMTP  messages by using the
40603 "dmarc_status" ACL condition in the DATA ACL.  You are required to
40604 call the "spf" condition first in the ACLs, then the "dmarc_status"
40605 condition.  Putting this condition in the ACLs is required in order
40606 for a DMARC check to actually occur.  All of the variables are set
40607 up before the DATA ACL, but there is no actual DMARC check that
40608 occurs until a "dmarc_status" condition is encountered in the ACLs.
40609
40610 The dmarc_status condition takes a list of strings on its
40611 right-hand side.  These strings describe recommended action based
40612 on the DMARC check.  To understand what the policy recommendations
40613 mean, refer to the DMARC website above.  Valid strings are:
40614 .display
40615 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40616 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40617 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40618 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40619 &'norecord    '& No policy section in the DMARC record for this sender domain.
40620 &'nofrom      '& Unable to determine the domain of the sender.
40621 &'temperror   '& Library error or dns error.
40622 &'off         '& The DMARC check was disabled for this email.
40623 .endd
40624 You can prefix each string with an exclamation mark to invert its
40625 meaning, for example "!accept" will match all results but
40626 "accept".  The string list is evaluated left-to-right in a
40627 short-circuit fashion.  When a string matches the outcome of the
40628 DMARC check, the condition succeeds.  If none of the listed
40629 strings matches the outcome of the DMARC check, the condition
40630 fails.
40631
40632 Of course, you can also use any other lookup method that Exim
40633 supports, including LDAP, Postgres, MySQL, etc, as long as the
40634 result is a list of colon-separated strings.
40635
40636 Performing the check sets up information used by the
40637 &%authresults%& expansion item.
40638
40639 Several expansion variables are set before the DATA ACL is
40640 processed, and you can use them in this ACL.  The following
40641 expansion variables are available:
40642
40643 &$dmarc_status$&
40644 .vindex &$dmarc_status$&
40645 .cindex DMARC result
40646 is a one word status indicating what the DMARC library
40647 thinks of the email.  It is a combination of the results of
40648 DMARC record lookup and the SPF/DKIM/DMARC processing results
40649 (if a DMARC record was found).  The actual policy declared
40650 in the DMARC record is in a separate expansion variable.
40651
40652 &$dmarc_status_text$&
40653 .vindex &$dmarc_status_text$&
40654 is a slightly longer, human readable status.
40655
40656 &$dmarc_used_domain$&
40657 .vindex &$dmarc_used_domain$&
40658 is the domain which DMARC used to look up the DMARC policy record.
40659
40660 &$dmarc_domain_policy$&
40661 .vindex &$dmarc_domain_policy$&
40662 is the policy declared in the DMARC record.  Valid values
40663 are "none", "reject" and "quarantine".  It is blank when there
40664 is any error, including no DMARC record.
40665
40666 . subsection
40667
40668 By default, Exim's DMARC configuration is intended to be
40669 non-intrusive and conservative.  To facilitate this, Exim will not
40670 create any type of logging files without explicit configuration by
40671 you, the admin.  Nor will Exim send out any emails/reports about
40672 DMARC issues without explicit configuration by you, the admin (other
40673 than typical bounce messages that may come about due to ACL
40674 processing or failure delivery issues).
40675
40676 In order to log statistics suitable to be imported by the opendmarc
40677 tools, you need to:
40678 .ilist
40679 Configure the global setting dmarc_history_file
40680 .next
40681 Configure cron jobs to call the appropriate opendmarc history
40682 import scripts and truncating the dmarc_history_file
40683 .endlist
40684
40685 In order to send forensic reports, you need to:
40686 .ilist
40687 Configure the global setting dmarc_forensic_sender
40688 .next
40689 Configure, somewhere before the DATA ACL, the control option to
40690 enable sending DMARC forensic reports
40691 .endlist
40692
40693 . subsection
40694
40695 Example usage:
40696 .code
40697 (RCPT ACL)
40698   warn    domains        = +local_domains
40699           hosts          = +local_hosts
40700           control        = dmarc_disable_verify
40701
40702   warn    !domains       = +screwed_up_dmarc_records
40703           control        = dmarc_enable_forensic
40704
40705   warn    condition      = (lookup if destined to mailing list)
40706           set acl_m_mailing_list = 1
40707
40708 (DATA ACL)
40709   warn    dmarc_status   = accept : none : off
40710           !authenticated = *
40711           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40712
40713   warn    dmarc_status   = !accept
40714           !authenticated = *
40715           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40716
40717   warn    dmarc_status   = quarantine
40718           !authenticated = *
40719           set $acl_m_quarantine = 1
40720           # Do something in a transport with this flag variable
40721
40722   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40723           condition      = ${if eq{$acl_m_mailing_list}{1}}
40724           message        = Messages from $dmarc_used_domain break mailing lists
40725
40726   deny    dmarc_status   = reject
40727           !authenticated = *
40728           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40729
40730   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40731 .endd
40732
40733 .wen
40734
40735
40736
40737
40738 . ////////////////////////////////////////////////////////////////////////////
40739 . ////////////////////////////////////////////////////////////////////////////
40740
40741 .chapter "Proxies" "CHAPproxies" &&&
40742          "Proxy support"
40743 .cindex "proxy support"
40744 .cindex "proxy" "access via"
40745
40746 A proxy is an intermediate system through which communication is passed.
40747 Proxies may provide a security, availability or load-distribution function.
40748
40749
40750 .section "Inbound proxies" SECTproxyInbound
40751 .cindex proxy inbound
40752 .cindex proxy "server side"
40753 .cindex proxy "Proxy protocol"
40754 .cindex "Proxy protocol" proxy
40755
40756 Exim has support for receiving inbound SMTP connections via a proxy
40757 that uses &"Proxy Protocol"& to speak to it.
40758 To include this support, include &"SUPPORT_PROXY=yes"&
40759 in Local/Makefile.
40760
40761 It was built on the HAProxy specification, found at
40762 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40763
40764 The purpose of this facility is so that an application load balancer,
40765 such as HAProxy, can sit in front of several Exim servers
40766 to distribute load.
40767 Exim uses the local protocol communication with the proxy to obtain
40768 the remote SMTP system IP address and port information.
40769 There is no logging if a host passes or
40770 fails Proxy Protocol negotiation, but it can easily be determined and
40771 recorded in an ACL (example is below).
40772
40773 Use of a proxy is enabled by setting the &%hosts_proxy%&
40774 main configuration option to a hostlist; connections from these
40775 hosts will use Proxy Protocol.
40776 Exim supports both version 1 and version 2 of the Proxy Protocol and
40777 automatically determines which version is in use.
40778
40779 The Proxy Protocol header is the first data received on a TCP connection
40780 and is inserted before any TLS-on-connect handshake from the client; Exim
40781 negotiates TLS between Exim-as-server and the remote client, not between
40782 Exim and the proxy server.
40783
40784 The following expansion variables are usable
40785 (&"internal"& and &"external"& here refer to the interfaces
40786 of the proxy):
40787 .display
40788 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40789 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40790 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40791 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40792 &'proxy_session            '& boolean: SMTP connection via proxy
40793 .endd
40794 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40795 there was a protocol error.
40796 The variables &$sender_host_address$& and &$sender_host_port$&
40797 will have values for the actual client system, not the proxy.
40798
40799 Since the real connections are all coming from the proxy, and the
40800 per host connection tracking is done before Proxy Protocol is
40801 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40802 handle all of the parallel volume you expect per inbound proxy.
40803 With the option set so high, you lose the ability
40804 to protect your server from many connections from one IP.
40805 In order to prevent your server from overload, you
40806 need to add a per connection ratelimit to your connect ACL.
40807 A possible solution is:
40808 .display
40809   # Set max number of connections per host
40810   LIMIT   = 5
40811   # Or do some kind of IP lookup in a flat file or database
40812   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40813
40814   defer   message        = Too many connections from this IP right now
40815           ratelimit      = LIMIT / 5s / per_conn / strict
40816 .endd
40817
40818
40819
40820 .section "Outbound proxies" SECTproxySOCKS
40821 .cindex proxy outbound
40822 .cindex proxy "client side"
40823 .cindex proxy SOCKS
40824 .cindex SOCKS proxy
40825 Exim has support for sending outbound SMTP via a proxy
40826 using a protocol called SOCKS5 (defined by RFC1928).
40827 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40828 Local/Makefile.
40829
40830 Use of a proxy is enabled by setting the &%socks_proxy%& option
40831 on an smtp transport.
40832 The option value is expanded and should then be a list
40833 (colon-separated by default) of proxy specifiers.
40834 Each proxy specifier is a list
40835 (space-separated by default) where the initial element
40836 is an IP address and any subsequent elements are options.
40837
40838 Options are a string <name>=<value>.
40839 The list of options is in the following table:
40840 .display
40841 &'auth   '& authentication method
40842 &'name   '& authentication username
40843 &'pass   '& authentication password
40844 &'port   '& tcp port
40845 &'tmo    '& connection timeout
40846 &'pri    '& priority
40847 &'weight '& selection bias
40848 .endd
40849
40850 More details on each of these options follows:
40851
40852 .ilist
40853 .cindex authentication "to proxy"
40854 .cindex proxy authentication
40855 &%auth%&: Either &"none"& (default) or &"name"&.
40856 Using &"name"& selects username/password authentication per RFC 1929
40857 for access to the proxy.
40858 Default is &"none"&.
40859 .next
40860 &%name%&: sets the username for the &"name"& authentication method.
40861 Default is empty.
40862 .next
40863 &%pass%&: sets the password for the &"name"& authentication method.
40864 Default is empty.
40865 .next
40866 &%port%&: the TCP port number to use for the connection to the proxy.
40867 Default is 1080.
40868 .next
40869 &%tmo%&: sets a connection timeout in seconds for this proxy.
40870 Default is 5.
40871 .next
40872 &%pri%&: specifies a priority for the proxy within the list,
40873 higher values being tried first.
40874 The default priority is 1.
40875 .next
40876 &%weight%&: specifies a selection bias.
40877 Within a priority set servers are queried in a random fashion,
40878 weighted by this value.
40879 The default value for selection bias is 1.
40880 .endlist
40881
40882 Proxies from the list are tried according to their priority
40883 and weight settings until one responds.  The timeout for the
40884 overall connection applies to the set of proxied attempts.
40885
40886 .section Logging SECTproxyLog
40887 To log the (local) IP of a proxy in the incoming or delivery logline,
40888 add &"+proxy"& to the &%log_selector%& option.
40889 This will add a component tagged with &"PRX="& to the line.
40890
40891 . ////////////////////////////////////////////////////////////////////////////
40892 . ////////////////////////////////////////////////////////////////////////////
40893
40894 .chapter "Internationalisation" "CHAPi18n" &&&
40895          "Internationalisation""
40896 .cindex internationalisation "email address"
40897 .cindex EAI
40898 .cindex i18n
40899 .cindex utf8 "mail name handling"
40900
40901 Exim has support for Internationalised mail names.
40902 To include this it must be built with SUPPORT_I18N and the libidn library.
40903 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40904
40905 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40906 instead of it) then IDNA2008 is supported; this adds an extra library
40907 requirement, upon libidn2.
40908
40909 .section "MTA operations" SECTi18nMTA
40910 .cindex SMTPUTF8 "ESMTP option"
40911 The main configuration option &%smtputf8_advertise_hosts%& specifies
40912 a host list.  If this matches the sending host and
40913 accept_8bitmime is true (the default) then the ESMTP option
40914 SMTPUTF8 will be advertised.
40915
40916 If the sender specifies the SMTPUTF8 option on a MAIL command
40917 international handling for the message is enabled and
40918 the expansion variable &$message_smtputf8$& will have value TRUE.
40919
40920 The option &%allow_utf8_domains%& is set to true for this
40921 message. All DNS lookups are converted to a-label form
40922 whatever the setting of &%allow_utf8_domains%&
40923 when Exim is built with SUPPORT_I18N.
40924
40925 Both localparts and domain are maintained as the original
40926 UTF-8 form internally; any comparison or regular-expression use will
40927 require appropriate care.  Filenames created, eg. by
40928 the appendfile transport, will have UTF-8 names.
40929
40930 HELO names sent by the smtp transport will have any UTF-8
40931 components expanded to a-label form,
40932 and any certificate name checks will be done using the a-label
40933 form of the name.
40934
40935 .cindex log protocol
40936 .cindex SMTPUTF8 logging
40937 .cindex i18n logging
40938 Log lines and Received-by: header lines will acquire a "utf8"
40939 prefix on the protocol element, eg. utf8esmtp.
40940
40941 The following expansion operators can be used:
40942 .code
40943 ${utf8_domain_to_alabel:str}
40944 ${utf8_domain_from_alabel:str}
40945 ${utf8_localpart_to_alabel:str}
40946 ${utf8_localpart_from_alabel:str}
40947 .endd
40948
40949 .cindex utf8 "address downconversion"
40950 .cindex i18n "utf8 address downconversion"
40951 The RCPT ACL
40952 may use the following modifier:
40953 .display
40954 control = utf8_downconvert
40955 control = utf8_downconvert/<value>
40956 .endd
40957 This sets a flag requiring that addresses are converted to
40958 a-label form before smtp delivery, for use in a
40959 Message Submission Agent context.
40960 If a value is appended it may be:
40961 .display
40962 &`1  `& (default) mandatory downconversion
40963 &`0  `& no downconversion
40964 &`-1 `& if SMTPUTF8 not supported by destination host
40965 .endd
40966
40967 If mua_wrapper is set, the utf8_downconvert control
40968 is initially set to -1.
40969
40970 The smtp transport has an option &%utf8_downconvert%&.
40971 If set it must expand to one of the three values described above,
40972 and it overrides any previously set value.
40973
40974
40975 There is no explicit support for VRFY and EXPN.
40976 Configurations supporting these should inspect
40977 &$smtp_command_argument$& for an SMTPUTF8 argument.
40978
40979 There is no support for LMTP on Unix sockets.
40980 Using the "lmtp" protocol option on an smtp transport,
40981 for LMTP over TCP, should work as expected.
40982
40983 There is no support for DSN unitext handling,
40984 and no provision for converting logging from or to UTF-8.
40985
40986
40987
40988 .section "MDA operations" SECTi18nMDA
40989 To aid in constructing names suitable for IMAP folders
40990 the following expansion operator can be used:
40991 .code
40992 ${imapfolder {<string>} {<sep>} {<specials>}}
40993 .endd
40994
40995 The string is converted from the charset specified by
40996 the "headers charset" command (in a filter file)
40997 or &%headers_charset%& main configuration option (otherwise),
40998 to the
40999 modified UTF-7 encoding specified by RFC 2060,
41000 with the following exception: All occurrences of <sep>
41001 (which has to be a single character)
41002 are replaced with periods ("."), and all periods and slashes that are not
41003 <sep> and are not in the <specials> string are BASE64 encoded.
41004
41005 The third argument can be omitted, defaulting to an empty string.
41006 The second argument can be omitted, defaulting to "/".
41007
41008 This is the encoding used by Courier for Maildir names on disk, and followed
41009 by many other IMAP servers.
41010
41011 Examples:
41012 .display
41013 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41014 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41015 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41016 .endd
41017
41018 Note that the source charset setting is vital, and also that characters
41019 must be representable in UTF-16.
41020
41021
41022 . ////////////////////////////////////////////////////////////////////////////
41023 . ////////////////////////////////////////////////////////////////////////////
41024
41025 .chapter "Events" "CHAPevents" &&&
41026          "Events"
41027 .cindex events
41028
41029 The events mechanism in Exim can be used to intercept processing at a number
41030 of points.  It was originally invented to give a way to do customised logging
41031 actions (for example, to a database) but can also be used to modify some
41032 processing actions.
41033
41034 Most installations will never need to use Events.
41035 The support can be left out of a build by defining DISABLE_EVENT=yes
41036 in &_Local/Makefile_&.
41037
41038 There are two major classes of events: main and transport.
41039 The main configuration option &%event_action%& controls reception events;
41040 a transport option &%event_action%& controls delivery events.
41041
41042 Both options are a string which is expanded when the event fires.
41043 An example might look like:
41044 .cindex logging custom
41045 .code
41046 event_action = ${if eq {msg:delivery}{$event_name} \
41047 {${lookup pgsql {SELECT * FROM record_Delivery( \
41048     '${quote_pgsql:$sender_address_domain}',\
41049     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41050     '${quote_pgsql:$domain}', \
41051     '${quote_pgsql:${lc:$local_part}}', \
41052     '${quote_pgsql:$host_address}', \
41053     '${quote_pgsql:${lc:$host}}', \
41054     '${quote_pgsql:$message_exim_id}')}} \
41055 } {}}
41056 .endd
41057
41058 Events have names which correspond to the point in process at which they fire.
41059 The name is placed in the variable &$event_name$& and the event action
41060 expansion must check this, as it will be called for every possible event type.
41061
41062 .new
41063 The current list of events is:
41064 .wen
41065 .display
41066 &`dane:fail              after    transport  `& per connection
41067 &`msg:complete           after    main       `& per message
41068 &`msg:delivery           after    transport  `& per recipient
41069 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41070 &`msg:rcpt:defer         after    transport  `& per recipient
41071 &`msg:host:defer         after    transport  `& per attempt
41072 &`msg:fail:delivery      after    transport  `& per recipient
41073 &`msg:fail:internal      after    main       `& per recipient
41074 &`tcp:connect            before   transport  `& per connection
41075 &`tcp:close              after    transport  `& per connection
41076 &`tls:cert               before   both       `& per certificate in verification chain
41077 &`smtp:connect           after    transport  `& per connection
41078 &`smtp:ehlo              after    transport  `& per connection
41079 .endd
41080 New event types may be added in future.
41081
41082 The event name is a colon-separated list, defining the type of
41083 event in a tree of possibilities.  It may be used as a list
41084 or just matched on as a whole.  There will be no spaces in the name.
41085
41086 The second column in the table above describes whether the event fires
41087 before or after the action is associates with.  Those which fire before
41088 can be used to affect that action (more on this below).
41089
41090 The third column in the table above says what section of the configuration
41091 should define the event action.
41092
41093 An additional variable, &$event_data$&, is filled with information varying
41094 with the event type:
41095 .display
41096 &`dane:fail            `& failure reason
41097 &`msg:delivery         `& smtp confirmation message
41098 &`msg:fail:internal    `& failure reason
41099 &`msg:fail:delivery    `& smtp error message
41100 &`msg:rcpt:host:defer  `& error string
41101 &`msg:rcpt:defer       `& error string
41102 &`msg:host:defer       `& error string
41103 &`tls:cert             `& verification chain depth
41104 &`smtp:connect         `& smtp banner
41105 &`smtp:ehlo            `& smtp ehlo response
41106 .endd
41107
41108 The :defer events populate one extra variable: &$event_defer_errno$&.
41109
41110 For complex operations an ACL expansion can be used in &%event_action%&
41111 however due to the multiple contexts that Exim operates in during
41112 the course of its processing:
41113 .ilist
41114 variables set in transport events will not be visible outside that
41115 transport call
41116 .next
41117 acl_m variables in a server context are lost on a new connection,
41118 and after smtp helo/ehlo/mail/starttls/rset commands
41119 .endlist
41120 Using an ACL expansion with the logwrite modifier can be
41121 a useful way of writing to the main log.
41122
41123 The expansion of the event_action option should normally
41124 return an empty string.  Should it return anything else the
41125 following will be forced:
41126 .display
41127 &`tcp:connect      `&  do not connect
41128 &`tls:cert         `&  refuse verification
41129 &`smtp:connect     `&  close connection
41130 .endd
41131 All other message types ignore the result string, and
41132 no other use is made of it.
41133
41134 For a tcp:connect event, if the connection is being made to a proxy
41135 then the address and port variables will be that of the proxy and not
41136 the target system.
41137
41138 For tls:cert events, if GnuTLS is in use this will trigger only per
41139 chain element received on the connection.
41140 For OpenSSL it will trigger for every chain element including those
41141 loaded locally.
41142
41143 . ////////////////////////////////////////////////////////////////////////////
41144 . ////////////////////////////////////////////////////////////////////////////
41145
41146 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41147          "Adding drivers or lookups"
41148 .cindex "adding drivers"
41149 .cindex "new drivers, adding"
41150 .cindex "drivers" "adding new"
41151 The following actions have to be taken in order to add a new router, transport,
41152 authenticator, or lookup type to Exim:
41153
41154 .olist
41155 Choose a name for the driver or lookup type that does not conflict with any
41156 existing name; I will use &"newdriver"& in what follows.
41157 .next
41158 Add to &_src/EDITME_& the line:
41159 .display
41160 <&'type'&>&`_NEWDRIVER=yes`&
41161 .endd
41162 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41163 code is not to be included in the binary by default, comment this line out. You
41164 should also add any relevant comments about the driver or lookup type.
41165 .next
41166 Add to &_src/config.h.defaults_& the line:
41167 .code
41168 #define <type>_NEWDRIVER
41169 .endd
41170 .next
41171 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41172 and create a table entry as is done for all the other drivers and lookup types.
41173 .next
41174 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41175 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41176 Add your &`NEWDRIVER`& to that list.
41177 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41178 simple form that most lookups have.
41179 .next
41180 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41181 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41182 driver or lookup type and add it to the definition of OBJ.
41183 .next
41184 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41185 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41186 .next
41187 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41188 &_src_&.
41189 .next
41190 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41191 as for other drivers and lookups.
41192 .endlist
41193
41194 Then all you need to do is write the code! A good way to start is to make a
41195 proforma by copying an existing module of the same type, globally changing all
41196 occurrences of the name, and cutting out most of the code. Note that any
41197 options you create must be listed in alphabetical order, because the tables are
41198 searched using a binary chop procedure.
41199
41200 There is a &_README_& file in each of the sub-directories of &_src_& describing
41201 the interface that is expected.
41202
41203
41204
41205
41206 . ////////////////////////////////////////////////////////////////////////////
41207 . ////////////////////////////////////////////////////////////////////////////
41208
41209 . /////////////////////////////////////////////////////////////////////////////
41210 . These lines are processing instructions for the Simple DocBook Processor that
41211 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41212 . PDFs than using xmlto and fop. They will be ignored by all other XML
41213 . processors.
41214 . /////////////////////////////////////////////////////////////////////////////
41215
41216 .literal xml
41217 <?sdop
41218   format="newpage"
41219   foot_right_recto="&chaptertitle;"
41220   foot_right_verso="&chaptertitle;"
41221 ?>
41222 .literal off
41223
41224 .makeindex "Options index"   "option"
41225 .makeindex "Variables index" "variable"
41226 .makeindex "Concept index"   "concept"
41227
41228
41229 . /////////////////////////////////////////////////////////////////////////////
41230 . /////////////////////////////////////////////////////////////////////////////