DKIM/CHUNKING: support CHUNKING when a transport_filter is used, if DKIM signing...
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.92"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2018
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .cindex "documentation"
375 This edition of the Exim specification applies to version &version() of Exim.
376 Substantive changes from the &previousversion; edition are marked in some
377 renditions of this document; this paragraph is so marked if the rendition is
378 capable of showing a change indicator.
379
380 This document is very much a reference manual; it is not a tutorial. The reader
381 is expected to have some familiarity with the SMTP mail transfer protocol and
382 with general Unix system administration. Although there are some discussions
383 and examples in places, the information is mostly organized in a way that makes
384 it easy to look up, rather than in a natural order for sequential reading.
385 Furthermore, this manual aims to cover every aspect of Exim in detail, including
386 a number of rarely-used, special-purpose features that are unlikely to be of
387 very wide interest.
388
389 .cindex "books about Exim"
390 An &"easier"& discussion of Exim which provides more in-depth explanatory,
391 introductory, and tutorial material can be found in a book entitled &'The Exim
392 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
393 (&url(https://www.uit.co.uk/exim-book/)).
394
395 The book also contains a chapter that gives a general introduction to SMTP and
396 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
397 with the latest release of Exim. (Note that the earlier book about Exim,
398 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
399
400 .cindex "Debian" "information sources"
401 If you are using a Debian distribution of Exim, you will find information about
402 Debian-specific features in the file
403 &_/usr/share/doc/exim4-base/README.Debian_&.
404 The command &(man update-exim.conf)& is another source of Debian-specific
405 information.
406
407 .cindex "&_doc/NewStuff_&"
408 .cindex "&_doc/ChangeLog_&"
409 .cindex "change log"
410 As Exim develops, there may be features in newer versions that have not
411 yet made it into this document, which is updated only when the most significant
412 digit of the fractional part of the version number changes. Specifications of
413 new features that are not yet in this manual are placed in the file
414 &_doc/NewStuff_& in the Exim distribution.
415
416 Some features may be classified as &"experimental"&. These may change
417 incompatibly while they are developing, or even be withdrawn. For this reason,
418 they are not documented in this manual. Information about experimental features
419 can be found in the file &_doc/experimental.txt_&.
420
421 All changes to Exim (whether new features, bug fixes, or other kinds of
422 change) are noted briefly in the file called &_doc/ChangeLog_&.
423
424 .cindex "&_doc/spec.txt_&"
425 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
426 that it can easily be searched with a text editor. Other files in the &_doc_&
427 directory are:
428
429 .table2 100pt
430 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
431 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
432 .row &_exim.8_&              "a man page of Exim's command line options"
433 .row &_experimental.txt_&    "documentation of experimental features"
434 .row &_filter.txt_&          "specification of the filter language"
435 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
436 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
437 .row &_openssl.txt_&         "installing a current OpenSSL release"
438 .endtable
439
440 The main specification and the specification of the filtering language are also
441 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
442 &<<SECTavail>>& below tells you how to get hold of these.
443
444
445
446 .section "FTP site and websites" "SECID2"
447 .cindex "website"
448 .cindex "FTP site"
449 The primary site for Exim source distributions is the &%exim.org%& FTP site,
450 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
451 website, are hosted at the University of Cambridge.
452
453 .cindex "wiki"
454 .cindex "FAQ"
455 As well as Exim distribution tar files, the Exim website contains a number of
456 differently formatted versions of the documentation. A recent addition to the
457 online information is the Exim wiki (&url(https://wiki.exim.org)),
458 which contains what used to be a separate FAQ, as well as various other
459 examples, tips, and know-how that have been contributed by Exim users.
460 The wiki site should always redirect to the correct place, which is currently
461 provided by GitHub, and is open to editing by anyone with a GitHub account.
462
463 .cindex Bugzilla
464 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
465 this to report bugs, and also to add items to the wish list. Please search
466 first to check that you are not duplicating a previous entry.
467 Please do not ask for configuration help in the bug-tracker.
468
469
470 .section "Mailing lists" "SECID3"
471 .cindex "mailing lists" "for Exim users"
472 The following Exim mailing lists exist:
473
474 .table2 140pt
475 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
476 .row &'exim-users@exim.org'&      "General discussion list"
477 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
478 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
479 .endtable
480
481 You can subscribe to these lists, change your existing subscriptions, and view
482 or search the archives via the mailing lists link on the Exim home page.
483 .cindex "Debian" "mailing list for"
484 If you are using a Debian distribution of Exim, you may wish to subscribe to
485 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
486 via this web page:
487 .display
488 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
489 .endd
490 Please ask Debian-specific questions on that list and not on the general Exim
491 lists.
492
493 .section "Bug reports" "SECID5"
494 .cindex "bug reports"
495 .cindex "reporting bugs"
496 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
497 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
498 whether some behaviour is a bug or not, the best thing to do is to post a
499 message to the &'exim-dev'& mailing list and have it discussed.
500
501
502
503 .section "Where to find the Exim distribution" "SECTavail"
504 .cindex "FTP site"
505 .cindex "HTTPS download site"
506 .cindex "distribution" "FTP site"
507 .cindex "distribution" "https site"
508 The master distribution site for the Exim distribution is
509 .display
510 &url(https://downloads.exim.org/)
511 .endd
512 The service is available over HTTPS, HTTP and FTP.
513 We encourage people to migrate to HTTPS.
514
515 The content served at &url(https://downloads.exim.org/) is identical to the
516 content served at &url(https://ftp.exim.org/pub/exim) and
517 &url(ftp://ftp.exim.org/pub/exim).
518
519 If accessing via a hostname containing &'ftp'&, then the file references that
520 follow are relative to the &_exim_& directories at these sites.
521 If accessing via the hostname &'downloads'& then the subdirectories described
522 here are top-level directories.
523
524 There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the top exim directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.xz_&
533 &_exim-n.nn.tar.gz_&
534 &_exim-n.nn.tar.bz2_&
535 .endd
536 where &'n.nn'& is the highest such version number in the directory. The three
537 files contain identical data; the only difference is the type of compression.
538 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
539 most portable to old systems.
540
541 .cindex "distribution" "signing details"
542 .cindex "distribution" "public key"
543 .cindex "public key for signed distribution"
544 The distributions will be PGP signed by an individual key of the Release
545 Coordinator.  This key will have a uid containing an email address in the
546 &'exim.org'& domain and will have signatures from other people, including
547 other Exim maintainers.  We expect that the key will be in the "strong set" of
548 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
549 PGP keys, a version of which can be found in the release directory in the file
550 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
551 such as &'pool.sks-keyservers.net'&.
552
553 At the time of the last update, releases were being made by Jeremy Harris and signed
554 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
555 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
556 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
557
558 The signatures for the tar bundles are in:
559 .display
560 &_exim-n.nn.tar.xz.asc_&
561 &_exim-n.nn.tar.gz.asc_&
562 &_exim-n.nn.tar.bz2.asc_&
563 .endd
564 For each released version, the log of changes is made available in a
565 separate file in the directory &_ChangeLogs_& so that it is possible to
566 find out what has changed without having to download the entire distribution.
567
568 .cindex "documentation" "available formats"
569 The main distribution contains ASCII versions of this specification and other
570 documentation; other formats of the documents are available in separate files
571 inside the &_exim4_& directory of the FTP site:
572 .display
573 &_exim-html-n.nn.tar.gz_&
574 &_exim-pdf-n.nn.tar.gz_&
575 &_exim-postscript-n.nn.tar.gz_&
576 &_exim-texinfo-n.nn.tar.gz_&
577 .endd
578 These tar files contain only the &_doc_& directory, not the complete
579 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
580
581
582 .section "Limitations" "SECID6"
583 .ilist
584 .cindex "limitations of Exim"
585 .cindex "bang paths" "not handled by Exim"
586 Exim is designed for use as an Internet MTA, and therefore handles addresses in
587 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
588 simple two-component bang paths can be converted by a straightforward rewriting
589 configuration. This restriction does not prevent Exim from being interfaced to
590 UUCP as a transport mechanism, provided that domain addresses are used.
591 .next
592 .cindex "domainless addresses"
593 .cindex "address" "without domain"
594 Exim insists that every address it handles has a domain attached. For incoming
595 local messages, domainless addresses are automatically qualified with a
596 configured domain value. Configuration options specify from which remote
597 systems unqualified addresses are acceptable. These are then qualified on
598 arrival.
599 .next
600 .cindex "transport" "external"
601 .cindex "external transports"
602 The only external transport mechanisms that are currently implemented are SMTP
603 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
604 transport is available, and there are facilities for writing messages to files
605 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
606 to send messages to other transport mechanisms such as UUCP, provided they can
607 handle domain-style addresses. Batched SMTP input is also catered for.
608 .next
609 Exim is not designed for storing mail for dial-in hosts. When the volumes of
610 such mail are large, it is better to get the messages &"delivered"& into files
611 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
612 other means.
613 .next
614 Although Exim does have basic facilities for scanning incoming messages, these
615 are not comprehensive enough to do full virus or spam scanning. Such operations
616 are best carried out using additional specialized software packages. If you
617 compile Exim with the content-scanning extension, straightforward interfaces to
618 a number of common scanners are provided.
619 .endlist
620
621
622 .section "Runtime configuration" "SECID7"
623 Exim's runtime configuration is held in a single text file that is divided
624 into a number of sections. The entries in this file consist of keywords and
625 values, in the style of Smail 3 configuration files. A default configuration
626 file which is suitable for simple online installations is provided in the
627 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
628
629
630 .section "Calling interface" "SECID8"
631 .cindex "Sendmail compatibility" "command line interface"
632 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
633 can be a straight replacement for &_/usr/lib/sendmail_& or
634 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
635 about Sendmail in order to run Exim. For actions other than sending messages,
636 Sendmail-compatible options also exist, but those that produce output (for
637 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
638 format. There are also some additional options that are compatible with Smail
639 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
640 documents all Exim's command line options. This information is automatically
641 made into the man page that forms part of the Exim distribution.
642
643 Control of messages in the queue can be done via certain privileged command
644 line options. There is also an optional monitor program called &'eximon'&,
645 which displays current information in an X window, and which contains a menu
646 interface to Exim's command line administration options.
647
648
649
650 .section "Terminology" "SECID9"
651 .cindex "terminology definitions"
652 .cindex "body of message" "definition of"
653 The &'body'& of a message is the actual data that the sender wants to transmit.
654 It is the last part of a message and is separated from the &'header'& (see
655 below) by a blank line.
656
657 .cindex "bounce message" "definition of"
658 When a message cannot be delivered, it is normally returned to the sender in a
659 delivery failure message or a &"non-delivery report"& (NDR). The term
660 &'bounce'& is commonly used for this action, and the error reports are often
661 called &'bounce messages'&. This is a convenient shorthand for &"delivery
662 failure error report"&. Such messages have an empty sender address in the
663 message's &'envelope'& (see below) to ensure that they cannot themselves give
664 rise to further bounce messages.
665
666 The term &'default'& appears frequently in this manual. It is used to qualify a
667 value which is used in the absence of any setting in the configuration. It may
668 also qualify an action which is taken unless a configuration setting specifies
669 otherwise.
670
671 The term &'defer'& is used when the delivery of a message to a specific
672 destination cannot immediately take place for some reason (a remote host may be
673 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
674 until a later time.
675
676 The word &'domain'& is sometimes used to mean all but the first component of a
677 host's name. It is &'not'& used in that sense here, where it normally refers to
678 the part of an email address following the @ sign.
679
680 .cindex "envelope, definition of"
681 .cindex "sender" "definition of"
682 A message in transit has an associated &'envelope'&, as well as a header and a
683 body. The envelope contains a sender address (to which bounce messages should
684 be delivered), and any number of recipient addresses. References to the
685 sender or the recipients of a message usually mean the addresses in the
686 envelope. An MTA uses these addresses for delivery, and for returning bounce
687 messages, not the addresses that appear in the header lines.
688
689 .cindex "message" "header, definition of"
690 .cindex "header section" "definition of"
691 The &'header'& of a message is the first part of a message's text, consisting
692 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
693 &'Subject:'&, etc. Long header lines can be split over several text lines by
694 indenting the continuations. The header is separated from the body by a blank
695 line.
696
697 .cindex "local part" "definition of"
698 .cindex "domain" "definition of"
699 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
700 part of an email address that precedes the @ sign. The part that follows the
701 @ sign is called the &'domain'& or &'mail domain'&.
702
703 .cindex "local delivery" "definition of"
704 .cindex "remote delivery, definition of"
705 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
706 delivery to a file or a pipe on the local host from delivery by SMTP over
707 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
708 host it is running on are &'remote'&.
709
710 .cindex "return path" "definition of"
711 &'Return path'& is another name that is used for the sender address in a
712 message's envelope.
713
714 .cindex "queue" "definition of"
715 The term &'queue'& is used to refer to the set of messages awaiting delivery
716 because this term is in widespread use in the context of MTAs. However, in
717 Exim's case, the reality is more like a pool than a queue, because there is
718 normally no ordering of waiting messages.
719
720 .cindex "queue runner" "definition of"
721 The term &'queue runner'& is used to describe a process that scans the queue
722 and attempts to deliver those messages whose retry times have come. This term
723 is used by other MTAs and also relates to the command &%runq%&, but in Exim
724 the waiting messages are normally processed in an unpredictable order.
725
726 .cindex "spool directory" "definition of"
727 The term &'spool directory'& is used for a directory in which Exim keeps the
728 messages in its queue &-- that is, those that it is in the process of
729 delivering. This should not be confused with the directory in which local
730 mailboxes are stored, which is called a &"spool directory"& by some people. In
731 the Exim documentation, &"spool"& is always used in the first sense.
732
733
734
735
736
737
738 . ////////////////////////////////////////////////////////////////////////////
739 . ////////////////////////////////////////////////////////////////////////////
740
741 .chapter "Incorporated code" "CHID2"
742 .cindex "incorporated code"
743 .cindex "regular expressions" "library"
744 .cindex "PCRE"
745 .cindex "OpenDMARC"
746 A number of pieces of external code are included in the Exim distribution.
747
748 .ilist
749 Regular expressions are supported in the main Exim program and in the
750 Exim monitor using the freely-distributable PCRE library, copyright
751 &copy; University of Cambridge. The source to PCRE is no longer shipped with
752 Exim, so you will need to use the version of PCRE shipped with your system,
753 or obtain and install the full version of the library from
754 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
755 .next
756 .cindex "cdb" "acknowledgment"
757 Support for the cdb (Constant DataBase) lookup method is provided by code
758 contributed by Nigel Metheringham of (at the time he contributed it) Planet
759 Online Ltd. The implementation is completely contained within the code of Exim.
760 It does not link against an external cdb library. The code contains the
761 following statements:
762
763 .blockquote
764 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
765
766 This program is free software; you can redistribute it and/or modify it under
767 the terms of the GNU General Public License as published by the Free Software
768 Foundation; either version 2 of the License, or (at your option) any later
769 version.
770 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
771 the spec and sample code for cdb can be obtained from
772 &url(https://cr.yp.to/cdb.html). This implementation borrows
773 some code from Dan Bernstein's implementation (which has no license
774 restrictions applied to it).
775 .endblockquote
776 .next
777 .cindex "SPA authentication"
778 .cindex "Samba project"
779 .cindex "Microsoft Secure Password Authentication"
780 Client support for Microsoft's &'Secure Password Authentication'& is provided
781 by code contributed by Marc Prud'hommeaux. Server support was contributed by
782 Tom Kistner. This includes code taken from the Samba project, which is released
783 under the Gnu GPL.
784 .next
785 .cindex "Cyrus"
786 .cindex "&'pwcheck'& daemon"
787 .cindex "&'pwauthd'& daemon"
788 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
789 by code taken from the Cyrus-SASL library and adapted by Alexander S.
790 Sabourenkov. The permission notice appears below, in accordance with the
791 conditions expressed therein.
792
793 .blockquote
794 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
795
796 Redistribution and use in source and binary forms, with or without
797 modification, are permitted provided that the following conditions
798 are met:
799
800 .olist
801 Redistributions of source code must retain the above copyright
802 notice, this list of conditions and the following disclaimer.
803 .next
804 Redistributions in binary form must reproduce the above copyright
805 notice, this list of conditions and the following disclaimer in
806 the documentation and/or other materials provided with the
807 distribution.
808 .next
809 The name &"Carnegie Mellon University"& must not be used to
810 endorse or promote products derived from this software without
811 prior written permission. For permission or any other legal
812 details, please contact
813 .display
814               Office of Technology Transfer
815               Carnegie Mellon University
816               5000 Forbes Avenue
817               Pittsburgh, PA  15213-3890
818               (412) 268-4387, fax: (412) 268-7395
819               tech-transfer@andrew.cmu.edu
820 .endd
821 .next
822 Redistributions of any form whatsoever must retain the following
823 acknowledgment:
824
825 &"This product includes software developed by Computing Services
826 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
827
828 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
829 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
830 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
831 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
832 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
833 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
834 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
835 .endlist
836 .endblockquote
837
838 .next
839 .cindex "Exim monitor" "acknowledgment"
840 .cindex "X-windows"
841 .cindex "Athena"
842 The Exim Monitor program, which is an X-Window application, includes
843 modified versions of the Athena StripChart and TextPop widgets.
844 This code is copyright by DEC and MIT, and their permission notice appears
845 below, in accordance with the conditions expressed therein.
846
847 .blockquote
848 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
849 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
850
851 All Rights Reserved
852
853 Permission to use, copy, modify, and distribute this software and its
854 documentation for any purpose and without fee is hereby granted,
855 provided that the above copyright notice appear in all copies and that
856 both that copyright notice and this permission notice appear in
857 supporting documentation, and that the names of Digital or MIT not be
858 used in advertising or publicity pertaining to distribution of the
859 software without specific, written prior permission.
860
861 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
862 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
863 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
864 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
865 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
866 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
867 SOFTWARE.
868 .endblockquote
869
870 .next
871 .cindex "opendmarc" "acknowledgment"
872 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
873 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
874 derived code are indicated in the respective source files. The full OpenDMARC
875 license is provided in the LICENSE.opendmarc file contained in the distributed
876 source code.
877
878 .next
879 Many people have contributed code fragments, some large, some small, that were
880 not covered by any specific license requirements. It is assumed that the
881 contributors are happy to see their code incorporated into Exim under the GPL.
882 .endlist
883
884
885
886
887
888 . ////////////////////////////////////////////////////////////////////////////
889 . ////////////////////////////////////////////////////////////////////////////
890
891 .chapter "How Exim receives and delivers mail" "CHID11" &&&
892          "Receiving and delivering mail"
893
894
895 .section "Overall philosophy" "SECID10"
896 .cindex "design philosophy"
897 Exim is designed to work efficiently on systems that are permanently connected
898 to the Internet and are handling a general mix of mail. In such circumstances,
899 most messages can be delivered immediately. Consequently, Exim does not
900 maintain independent queues of messages for specific domains or hosts, though
901 it does try to send several messages in a single SMTP connection after a host
902 has been down, and it also maintains per-host retry information.
903
904
905 .section "Policy control" "SECID11"
906 .cindex "policy control" "overview"
907 Policy controls are now an important feature of MTAs that are connected to the
908 Internet. Perhaps their most important job is to stop MTAs from being abused as
909 &"open relays"& by misguided individuals who send out vast amounts of
910 unsolicited junk and want to disguise its source. Exim provides flexible
911 facilities for specifying policy controls on incoming mail:
912
913 .ilist
914 .cindex "&ACL;" "introduction"
915 Exim 4 (unlike previous versions of Exim) implements policy controls on
916 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
917 series of statements that may either grant or deny access. ACLs can be used at
918 several places in the SMTP dialogue while receiving a message from a remote
919 host. However, the most common places are after each RCPT command, and at the
920 very end of the message. The sysadmin can specify conditions for accepting or
921 rejecting individual recipients or the entire message, respectively, at these
922 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
923 error code.
924 .next
925 An ACL is also available for locally generated, non-SMTP messages. In this
926 case, the only available actions are to accept or deny the entire message.
927 .next
928 When Exim is compiled with the content-scanning extension, facilities are
929 provided in the ACL mechanism for passing the message to external virus and/or
930 spam scanning software. The result of such a scan is passed back to the ACL,
931 which can then use it to decide what to do with the message.
932 .next
933 When a message has been received, either from a remote host or from the local
934 host, but before the final acknowledgment has been sent, a locally supplied C
935 function called &[local_scan()]& can be run to inspect the message and decide
936 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
937 is accepted, the list of recipients can be modified by the function.
938 .next
939 Using the &[local_scan()]& mechanism is another way of calling external scanner
940 software. The &%SA-Exim%& add-on package works this way. It does not require
941 Exim to be compiled with the content-scanning extension.
942 .next
943 After a message has been accepted, a further checking mechanism is available in
944 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
945 runs at the start of every delivery process.
946 .endlist
947
948
949
950 .section "User filters" "SECID12"
951 .cindex "filter" "introduction"
952 .cindex "Sieve filter"
953 In a conventional Exim configuration, users are able to run private filters by
954 setting up appropriate &_.forward_& files in their home directories. See
955 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
956 configuration needed to support this, and the separate document entitled
957 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
958 of filtering are available:
959
960 .ilist
961 Sieve filters are written in the standard filtering language that is defined
962 by RFC 3028.
963 .next
964 Exim filters are written in a syntax that is unique to Exim, but which is more
965 powerful than Sieve, which it pre-dates.
966 .endlist
967
968 User filters are run as part of the routing process, described below.
969
970
971
972 .section "Message identification" "SECTmessiden"
973 .cindex "message ids" "details of format"
974 .cindex "format" "of message id"
975 .cindex "id of message"
976 .cindex "base62"
977 .cindex "base36"
978 .cindex "Darwin"
979 .cindex "Cygwin"
980 Every message handled by Exim is given a &'message id'& which is sixteen
981 characters long. It is divided into three parts, separated by hyphens, for
982 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
983 normally encoding numbers in base 62. However, in the Darwin operating
984 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
985 (avoiding the use of lower case letters) is used instead, because the message
986 id is used to construct filenames, and the names of files in those systems are
987 not always case-sensitive.
988
989 .cindex "pid (process id)" "re-use of"
990 The detail of the contents of the message id have changed as Exim has evolved.
991 Earlier versions relied on the operating system not re-using a process id (pid)
992 within one second. On modern operating systems, this assumption can no longer
993 be made, so the algorithm had to be changed. To retain backward compatibility,
994 the format of the message id was retained, which is why the following rules are
995 somewhat eccentric:
996
997 .ilist
998 The first six characters of the message id are the time at which the message
999 started to be received, to a granularity of one second. That is, this field
1000 contains the number of seconds since the start of the epoch (the normal Unix
1001 way of representing the date and time of day).
1002 .next
1003 After the first hyphen, the next six characters are the id of the process that
1004 received the message.
1005 .next
1006 There are two different possibilities for the final two characters:
1007 .olist
1008 .oindex "&%localhost_number%&"
1009 If &%localhost_number%& is not set, this value is the fractional part of the
1010 time of reception, normally in units of 1/2000 of a second, but for systems
1011 that must use base 36 instead of base 62 (because of case-insensitive file
1012 systems), the units are 1/1000 of a second.
1013 .next
1014 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1015 the fractional part of the time, which in this case is in units of 1/200
1016 (1/100) of a second.
1017 .endlist
1018 .endlist
1019
1020 After a message has been received, Exim waits for the clock to tick at the
1021 appropriate resolution before proceeding, so that if another message is
1022 received by the same process, or by another process with the same (re-used)
1023 pid, it is guaranteed that the time will be different. In most cases, the clock
1024 will already have ticked while the message was being received.
1025
1026
1027 .section "Receiving mail" "SECID13"
1028 .cindex "receiving mail"
1029 .cindex "message" "reception"
1030 The only way Exim can receive mail from another host is using SMTP over
1031 TCP/IP, in which case the sender and recipient addresses are transferred using
1032 SMTP commands. However, from a locally running process (such as a user's MUA),
1033 there are several possibilities:
1034
1035 .ilist
1036 If the process runs Exim with the &%-bm%& option, the message is read
1037 non-interactively (usually via a pipe), with the recipients taken from the
1038 command line, or from the body of the message if &%-t%& is also used.
1039 .next
1040 If the process runs Exim with the &%-bS%& option, the message is also read
1041 non-interactively, but in this case the recipients are listed at the start of
1042 the message in a series of SMTP RCPT commands, terminated by a DATA
1043 command. This is called &"batch SMTP"& format,
1044 but it isn't really SMTP. The SMTP commands are just another way of passing
1045 envelope addresses in a non-interactive submission.
1046 .next
1047 If the process runs Exim with the &%-bs%& option, the message is read
1048 interactively, using the SMTP protocol. A two-way pipe is normally used for
1049 passing data between the local process and the Exim process.
1050 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1051 example, the ACLs for SMTP commands are used for this form of submission.
1052 .next
1053 A local process may also make a TCP/IP call to the host's loopback address
1054 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1055 does not treat the loopback address specially. It treats all such connections
1056 in the same way as connections from other hosts.
1057 .endlist
1058
1059
1060 .cindex "message sender, constructed by Exim"
1061 .cindex "sender" "constructed by Exim"
1062 In the three cases that do not involve TCP/IP, the sender address is
1063 constructed from the login name of the user that called Exim and a default
1064 qualification domain (which can be set by the &%qualify_domain%& configuration
1065 option). For local or batch SMTP, a sender address that is passed using the
1066 SMTP MAIL command is ignored. However, the system administrator may allow
1067 certain users (&"trusted users"&) to specify a different sender addresses
1068 unconditionally, or all users to specify certain forms of different sender
1069 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1070 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1071 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1072 users to change sender addresses.
1073
1074 Messages received by either of the non-interactive mechanisms are subject to
1075 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1076 (either over TCP/IP or interacting with a local process) can be checked by a
1077 number of ACLs that operate at different times during the SMTP session. Either
1078 individual recipients or the entire message can be rejected if local policy
1079 requirements are not met. The &[local_scan()]& function (see chapter
1080 &<<CHAPlocalscan>>&) is run for all incoming messages.
1081
1082 Exim can be configured not to start a delivery process when a message is
1083 received; this can be unconditional, or depend on the number of incoming SMTP
1084 connections or the system load. In these situations, new messages wait on the
1085 queue until a queue runner process picks them up. However, in standard
1086 configurations under normal conditions, delivery is started as soon as a
1087 message is received.
1088
1089
1090
1091
1092
1093 .section "Handling an incoming message" "SECID14"
1094 .cindex "spool directory" "files that hold a message"
1095 .cindex "file" "how a message is held"
1096 When Exim accepts a message, it writes two files in its spool directory. The
1097 first contains the envelope information, the current status of the message, and
1098 the header lines, and the second contains the body of the message. The names of
1099 the two spool files consist of the message id, followed by &`-H`& for the
1100 file containing the envelope and header, and &`-D`& for the data file.
1101
1102 .cindex "spool directory" "&_input_& sub-directory"
1103 By default, all these message files are held in a single directory called
1104 &_input_& inside the general Exim spool directory. Some operating systems do
1105 not perform very well if the number of files in a directory gets large; to
1106 improve performance in such cases, the &%split_spool_directory%& option can be
1107 used. This causes Exim to split up the input files into 62 sub-directories
1108 whose names are single letters or digits. When this is done, the queue is
1109 processed one sub-directory at a time instead of all at once, which can improve
1110 overall performance even when there are not enough files in each directory to
1111 affect file system performance.
1112
1113 The envelope information consists of the address of the message's sender and
1114 the addresses of the recipients. This information is entirely separate from
1115 any addresses contained in the header lines. The status of the message includes
1116 a list of recipients who have already received the message. The format of the
1117 first spool file is described in chapter &<<CHAPspool>>&.
1118
1119 .cindex "rewriting" "addresses"
1120 Address rewriting that is specified in the rewrite section of the configuration
1121 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1122 both in the header lines and the envelope, at the time the message is accepted.
1123 If during the course of delivery additional addresses are generated (for
1124 example, via aliasing), these new addresses are rewritten as soon as they are
1125 generated. At the time a message is actually delivered (transported) further
1126 rewriting can take place; because this is a transport option, it can be
1127 different for different forms of delivery. It is also possible to specify the
1128 addition or removal of certain header lines at the time the message is
1129 delivered (see chapters &<<CHAProutergeneric>>& and
1130 &<<CHAPtransportgeneric>>&).
1131
1132
1133
1134 .section "Life of a message" "SECID15"
1135 .cindex "message" "life of"
1136 .cindex "message" "frozen"
1137 A message remains in the spool directory until it is completely delivered to
1138 its recipients or to an error address, or until it is deleted by an
1139 administrator or by the user who originally created it. In cases when delivery
1140 cannot proceed &-- for example when a message can neither be delivered to its
1141 recipients nor returned to its sender, the message is marked &"frozen"& on the
1142 spool, and no more deliveries are attempted.
1143
1144 .cindex "frozen messages" "thawing"
1145 .cindex "message" "thawing frozen"
1146 An administrator can &"thaw"& such messages when the problem has been
1147 corrected, and can also freeze individual messages by hand if necessary. In
1148 addition, an administrator can force a delivery error, causing a bounce message
1149 to be sent.
1150
1151 .oindex "&%timeout_frozen_after%&"
1152 .oindex "&%ignore_bounce_errors_after%&"
1153 There are options called &%ignore_bounce_errors_after%& and
1154 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1155 The first applies only to frozen bounces, the second to all frozen messages.
1156
1157 .cindex "message" "log file for"
1158 .cindex "log" "file for each message"
1159 While Exim is working on a message, it writes information about each delivery
1160 attempt to its main log file. This includes successful, unsuccessful, and
1161 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1162 lines are also written to a separate &'message log'& file for each message.
1163 These logs are solely for the benefit of the administrator and are normally
1164 deleted along with the spool files when processing of a message is complete.
1165 The use of individual message logs can be disabled by setting
1166 &%no_message_logs%&; this might give an improvement in performance on very busy
1167 systems.
1168
1169 .cindex "journal file"
1170 .cindex "file" "journal"
1171 All the information Exim itself needs to set up a delivery is kept in the first
1172 spool file, along with the header lines. When a successful delivery occurs, the
1173 address is immediately written at the end of a journal file, whose name is the
1174 message id followed by &`-J`&. At the end of a delivery run, if there are some
1175 addresses left to be tried again later, the first spool file (the &`-H`& file)
1176 is updated to indicate which these are, and the journal file is then deleted.
1177 Updating the spool file is done by writing a new file and renaming it, to
1178 minimize the possibility of data loss.
1179
1180 Should the system or Exim crash after a successful delivery but before
1181 the spool file has been updated, the journal is left lying around. The next
1182 time Exim attempts to deliver the message, it reads the journal file and
1183 updates the spool file before proceeding. This minimizes the chances of double
1184 deliveries caused by crashes.
1185
1186
1187
1188 .section "Processing an address for delivery" "SECTprocaddress"
1189 .cindex "drivers" "definition of"
1190 .cindex "router" "definition of"
1191 .cindex "transport" "definition of"
1192 The main delivery processing elements of Exim are called &'routers'& and
1193 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1194 number of them is provided in the source distribution, and compile-time options
1195 specify which ones are included in the binary. Runtime options specify which
1196 ones are actually used for delivering messages.
1197
1198 .cindex "drivers" "instance definition"
1199 Each driver that is specified in the runtime configuration is an &'instance'&
1200 of that particular driver type. Multiple instances are allowed; for example,
1201 you can set up several different &(smtp)& transports, each with different
1202 option values that might specify different ports or different timeouts. Each
1203 instance has its own identifying name. In what follows we will normally use the
1204 instance name when discussing one particular instance (that is, one specific
1205 configuration of the driver), and the generic driver name when discussing
1206 the driver's features in general.
1207
1208 A &'router'& is a driver that operates on an address, either determining how
1209 its delivery should happen, by assigning it to a specific transport, or
1210 converting the address into one or more new addresses (for example, via an
1211 alias file). A router may also explicitly choose to fail an address, causing it
1212 to be bounced.
1213
1214 A &'transport'& is a driver that transmits a copy of the message from Exim's
1215 spool to some destination. There are two kinds of transport: for a &'local'&
1216 transport, the destination is a file or a pipe on the local host, whereas for a
1217 &'remote'& transport the destination is some other host. A message is passed
1218 to a specific transport as a result of successful routing. If a message has
1219 several recipients, it may be passed to a number of different transports.
1220
1221 .cindex "preconditions" "definition of"
1222 An address is processed by passing it to each configured router instance in
1223 turn, subject to certain preconditions, until a router accepts the address or
1224 specifies that it should be bounced. We will describe this process in more
1225 detail shortly. First, as a simple example, we consider how each recipient
1226 address in a message is processed in a small configuration of three routers.
1227
1228 To make this a more concrete example, it is described in terms of some actual
1229 routers, but remember, this is only an example. You can configure Exim's
1230 routers in many different ways, and there may be any number of routers in a
1231 configuration.
1232
1233 The first router that is specified in a configuration is often one that handles
1234 addresses in domains that are not recognized specifically by the local host.
1235 Typically these are addresses for arbitrary domains on the Internet. A precondition
1236 is set up which looks for the special domains known to the host (for example,
1237 its own domain name), and the router is run for addresses that do &'not'&
1238 match. Typically, this is a router that looks up domains in the DNS in order to
1239 find the hosts to which this address routes. If it succeeds, the address is
1240 assigned to a suitable SMTP transport; if it does not succeed, the router is
1241 configured to fail the address.
1242
1243 The second router is reached only when the domain is recognized as one that
1244 &"belongs"& to the local host. This router does redirection &-- also known as
1245 aliasing and forwarding. When it generates one or more new addresses from the
1246 original, each of them is routed independently from the start. Otherwise, the
1247 router may cause an address to fail, or it may simply decline to handle the
1248 address, in which case the address is passed to the next router.
1249
1250 The final router in many configurations is one that checks to see if the
1251 address belongs to a local mailbox. The precondition may involve a check to
1252 see if the local part is the name of a login account, or it may look up the
1253 local part in a file or a database. If its preconditions are not met, or if
1254 the router declines, we have reached the end of the routers. When this happens,
1255 the address is bounced.
1256
1257
1258
1259 .section "Processing an address for verification" "SECID16"
1260 .cindex "router" "for verification"
1261 .cindex "verifying address" "overview"
1262 As well as being used to decide how to deliver to an address, Exim's routers
1263 are also used for &'address verification'&. Verification can be requested as
1264 one of the checks to be performed in an ACL for incoming messages, on both
1265 sender and recipient addresses, and it can be tested using the &%-bv%& and
1266 &%-bvs%& command line options.
1267
1268 When an address is being verified, the routers are run in &"verify mode"&. This
1269 does not affect the way the routers work, but it is a state that can be
1270 detected. By this means, a router can be skipped or made to behave differently
1271 when verifying. A common example is a configuration in which the first router
1272 sends all messages to a message-scanning program unless they have been
1273 previously scanned. Thus, the first router accepts all addresses without any
1274 checking, making it useless for verifying. Normally, the &%no_verify%& option
1275 would be set for such a router, causing it to be skipped in verify mode.
1276
1277
1278
1279
1280 .section "Running an individual router" "SECTrunindrou"
1281 .cindex "router" "running details"
1282 .cindex "preconditions" "checking"
1283 .cindex "router" "result of running"
1284 As explained in the example above, a number of preconditions are checked before
1285 running a router. If any are not met, the router is skipped, and the address is
1286 passed to the next router. When all the preconditions on a router &'are'& met,
1287 the router is run. What happens next depends on the outcome, which is one of
1288 the following:
1289
1290 .ilist
1291 &'accept'&: The router accepts the address, and either assigns it to a
1292 transport or generates one or more &"child"& addresses. Processing the
1293 original address ceases
1294 .oindex "&%unseen%&"
1295 unless the &%unseen%& option is set on the router. This option
1296 can be used to set up multiple deliveries with different routing (for example,
1297 for keeping archive copies of messages). When &%unseen%& is set, the address is
1298 passed to the next router. Normally, however, an &'accept'& return marks the
1299 end of routing.
1300
1301 Any child addresses generated by the router are processed independently,
1302 starting with the first router by default. It is possible to change this by
1303 setting the &%redirect_router%& option to specify which router to start at for
1304 child addresses. Unlike &%pass_router%& (see below) the router specified by
1305 &%redirect_router%& may be anywhere in the router configuration.
1306 .next
1307 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1308 requests that the address be passed to another router. By default, the address
1309 is passed to the next router, but this can be changed by setting the
1310 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1311 must be below the current router (to avoid loops).
1312 .next
1313 &'decline'&: The router declines to accept the address because it does not
1314 recognize it at all. By default, the address is passed to the next router, but
1315 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1316 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1317 &'decline'& into &'fail'&.
1318 .next
1319 &'fail'&: The router determines that the address should fail, and queues it for
1320 the generation of a bounce message. There is no further processing of the
1321 original address unless &%unseen%& is set on the router.
1322 .next
1323 &'defer'&: The router cannot handle the address at the present time. (A
1324 database may be offline, or a DNS lookup may have timed out.) No further
1325 processing of the address happens in this delivery attempt. It is tried again
1326 next time the message is considered for delivery.
1327 .next
1328 &'error'&: There is some error in the router (for example, a syntax error in
1329 its configuration). The action is as for defer.
1330 .endlist
1331
1332 If an address reaches the end of the routers without having been accepted by
1333 any of them, it is bounced as unrouteable. The default error message in this
1334 situation is &"unrouteable address"&, but you can set your own message by
1335 making use of the &%cannot_route_message%& option. This can be set for any
1336 router; the value from the last router that &"saw"& the address is used.
1337
1338 Sometimes while routing you want to fail a delivery when some conditions are
1339 met but others are not, instead of passing the address on for further routing.
1340 You can do this by having a second router that explicitly fails the delivery
1341 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1342 facility for this purpose.
1343
1344
1345 .section "Duplicate addresses" "SECID17"
1346 .cindex "case of local parts"
1347 .cindex "address duplicate, discarding"
1348 .cindex "duplicate addresses"
1349 Once routing is complete, Exim scans the addresses that are assigned to local
1350 and remote transports and discards any duplicates that it finds. During this
1351 check, local parts are treated case-sensitively. This happens only when
1352 actually delivering a message; when testing routers with &%-bt%&, all the
1353 routed addresses are shown.
1354
1355
1356
1357 .section "Router preconditions" "SECTrouprecon"
1358 .cindex "router" "preconditions, order of processing"
1359 .cindex "preconditions" "order of processing"
1360 The preconditions that are tested for each router are listed below, in the
1361 order in which they are tested. The individual configuration options are
1362 described in more detail in chapter &<<CHAProutergeneric>>&.
1363
1364 .ilist
1365 .cindex affix "router precondition"
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 .cindex affix "router precondition"
1403 If the &%local_parts%& option is set, the local part of the address must be in
1404 the set of local parts that it defines. If &%local_part_prefix%& or
1405 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1406 part before this check. If you want to do precondition tests on local parts
1407 that include affixes, you can do so by using a &%condition%& option (see below)
1408 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1409 &$local_part_suffix$& as necessary.
1410 .next
1411 .vindex "&$local_user_uid$&"
1412 .vindex "&$local_user_gid$&"
1413 .vindex "&$home$&"
1414 If the &%check_local_user%& option is set, the local part must be the name of
1415 an account on the local host. If this check succeeds, the uid and gid of the
1416 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1417 user's home directory is placed in &$home$&; these values can be used in the
1418 remaining preconditions.
1419 .next
1420 If the &%router_home_directory%& option is set, it is expanded at this point,
1421 because it overrides the value of &$home$&. If this expansion were left till
1422 later, the value of &$home$& as set by &%check_local_user%& would be used in
1423 subsequent tests. Having two different values of &$home$& in the same router
1424 could lead to confusion.
1425 .next
1426 If the &%senders%& option is set, the envelope sender address must be in the
1427 set of addresses that it defines.
1428 .next
1429 If the &%require_files%& option is set, the existence or non-existence of
1430 specified files is tested.
1431 .next
1432 .cindex "customizing" "precondition"
1433 If the &%condition%& option is set, it is evaluated and tested. This option
1434 uses an expanded string to allow you to set up your own custom preconditions.
1435 Expanded strings are described in chapter &<<CHAPexpand>>&.
1436 .endlist
1437
1438
1439 Note that &%require_files%& comes near the end of the list, so you cannot use
1440 it to check for the existence of a file in which to lookup up a domain, local
1441 part, or sender. However, as these options are all expanded, you can use the
1442 &%exists%& expansion condition to make such tests within each condition. The
1443 &%require_files%& option is intended for checking files that the router may be
1444 going to use internally, or which are needed by a specific transport (for
1445 example, &_.procmailrc_&).
1446
1447
1448
1449 .section "Delivery in detail" "SECID18"
1450 .cindex "delivery" "in detail"
1451 When a message is to be delivered, the sequence of events is as follows:
1452
1453 .ilist
1454 If a system-wide filter file is specified, the message is passed to it. The
1455 filter may add recipients to the message, replace the recipients, discard the
1456 message, cause a new message to be generated, or cause the message delivery to
1457 fail. The format of the system filter file is the same as for Exim user filter
1458 files, described in the separate document entitled &'Exim's interfaces to mail
1459 filtering'&.
1460 .cindex "Sieve filter" "not available for system filter"
1461 (&*Note*&: Sieve cannot be used for system filter files.)
1462
1463 Some additional features are available in system filters &-- see chapter
1464 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1465 filter only once per delivery attempt, however many recipients it has. However,
1466 if there are several delivery attempts because one or more addresses could not
1467 be immediately delivered, the system filter is run each time. The filter
1468 condition &%first_delivery%& can be used to detect the first run of the system
1469 filter.
1470 .next
1471 Each recipient address is offered to each configured router, in turn, subject to
1472 its preconditions, until one is able to handle it. If no router can handle the
1473 address, that is, if they all decline, the address is failed. Because routers
1474 can be targeted at particular domains, several locally handled domains can be
1475 processed entirely independently of each other.
1476 .next
1477 .cindex "routing" "loops in"
1478 .cindex "loop" "while routing"
1479 A router that accepts an address may assign it to a local or a remote
1480 transport. However, the transport is not run at this time. Instead, the address
1481 is placed on a list for the particular transport, which will be run later.
1482 Alternatively, the router may generate one or more new addresses (typically
1483 from alias, forward, or filter files). New addresses are fed back into this
1484 process from the top, but in order to avoid loops, a router ignores any address
1485 which has an identically-named ancestor that was processed by itself.
1486 .next
1487 When all the routing has been done, addresses that have been successfully
1488 handled are passed to their assigned transports. When local transports are
1489 doing real local deliveries, they handle only one address at a time, but if a
1490 local transport is being used as a pseudo-remote transport (for example, to
1491 collect batched SMTP messages for transmission by some other means) multiple
1492 addresses can be handled. Remote transports can always handle more than one
1493 address at a time, but can be configured not to do so, or to restrict multiple
1494 addresses to the same domain.
1495 .next
1496 Each local delivery to a file or a pipe runs in a separate process under a
1497 non-privileged uid, and these deliveries are run one at a time. Remote
1498 deliveries also run in separate processes, normally under a uid that is private
1499 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1500 run in parallel. The maximum number of simultaneous remote deliveries for any
1501 one message is set by the &%remote_max_parallel%& option.
1502 The order in which deliveries are done is not defined, except that all local
1503 deliveries happen before any remote deliveries.
1504 .next
1505 .cindex "queue runner"
1506 When it encounters a local delivery during a queue run, Exim checks its retry
1507 database to see if there has been a previous temporary delivery failure for the
1508 address before running the local transport. If there was a previous failure,
1509 Exim does not attempt a new delivery until the retry time for the address is
1510 reached. However, this happens only for delivery attempts that are part of a
1511 queue run. Local deliveries are always attempted when delivery immediately
1512 follows message reception, even if retry times are set for them. This makes for
1513 better behaviour if one particular message is causing problems (for example,
1514 causing quota overflow, or provoking an error in a filter file).
1515 .next
1516 .cindex "delivery" "retry in remote transports"
1517 Remote transports do their own retry handling, since an address may be
1518 deliverable to one of a number of hosts, each of which may have a different
1519 retry time. If there have been previous temporary failures and no host has
1520 reached its retry time, no delivery is attempted, whether in a queue run or
1521 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1522 .next
1523 If there were any permanent errors, a bounce message is returned to an
1524 appropriate address (the sender in the common case), with details of the error
1525 for each failing address. Exim can be configured to send copies of bounce
1526 messages to other addresses.
1527 .next
1528 .cindex "delivery" "deferral"
1529 If one or more addresses suffered a temporary failure, the message is left on
1530 the queue, to be tried again later. Delivery of these addresses is said to be
1531 &'deferred'&.
1532 .next
1533 When all the recipient addresses have either been delivered or bounced,
1534 handling of the message is complete. The spool files and message log are
1535 deleted, though the message log can optionally be preserved if required.
1536 .endlist
1537
1538
1539
1540
1541 .section "Retry mechanism" "SECID19"
1542 .cindex "delivery" "retry mechanism"
1543 .cindex "retry" "description of mechanism"
1544 .cindex "queue runner"
1545 Exim's mechanism for retrying messages that fail to get delivered at the first
1546 attempt is the queue runner process. You must either run an Exim daemon that
1547 uses the &%-q%& option with a time interval to start queue runners at regular
1548 intervals or use some other means (such as &'cron'&) to start them. If you do
1549 not arrange for queue runners to be run, messages that fail temporarily at the
1550 first attempt will remain in your queue forever. A queue runner process works
1551 its way through the queue, one message at a time, trying each delivery that has
1552 passed its retry time.
1553 You can run several queue runners at once.
1554
1555 Exim uses a set of configured rules to determine when next to retry the failing
1556 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1557 should give up trying to deliver to the address, at which point it generates a
1558 bounce message. If no retry rules are set for a particular host, address, and
1559 error combination, no retries are attempted, and temporary errors are treated
1560 as permanent.
1561
1562
1563
1564 .section "Temporary delivery failure" "SECID20"
1565 .cindex "delivery" "temporary failure"
1566 There are many reasons why a message may not be immediately deliverable to a
1567 particular address. Failure to connect to a remote machine (because it, or the
1568 connection to it, is down) is one of the most common. Temporary failures may be
1569 detected during routing as well as during the transport stage of delivery.
1570 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1571 is on a file system where the user is over quota. Exim can be configured to
1572 impose its own quotas on local mailboxes; where system quotas are set they will
1573 also apply.
1574
1575 If a host is unreachable for a period of time, a number of messages may be
1576 waiting for it by the time it recovers, and sending them in a single SMTP
1577 connection is clearly beneficial. Whenever a delivery to a remote host is
1578 deferred,
1579 .cindex "hints database" "deferred deliveries"
1580 Exim makes a note in its hints database, and whenever a successful
1581 SMTP delivery has happened, it looks to see if any other messages are waiting
1582 for the same host. If any are found, they are sent over the same SMTP
1583 connection, subject to a configuration limit as to the maximum number in any
1584 one connection.
1585
1586
1587
1588 .section "Permanent delivery failure" "SECID21"
1589 .cindex "delivery" "permanent failure"
1590 .cindex "bounce message" "when generated"
1591 When a message cannot be delivered to some or all of its intended recipients, a
1592 bounce message is generated. Temporary delivery failures turn into permanent
1593 errors when their timeout expires. All the addresses that fail in a given
1594 delivery attempt are listed in a single message. If the original message has
1595 many recipients, it is possible for some addresses to fail in one delivery
1596 attempt and others to fail subsequently, giving rise to more than one bounce
1597 message. The wording of bounce messages can be customized by the administrator.
1598 See chapter &<<CHAPemsgcust>>& for details.
1599
1600 .cindex "&'X-Failed-Recipients:'& header line"
1601 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1602 failed addresses, for the benefit of programs that try to analyse such messages
1603 automatically.
1604
1605 .cindex "bounce message" "recipient of"
1606 A bounce message is normally sent to the sender of the original message, as
1607 obtained from the message's envelope. For incoming SMTP messages, this is the
1608 address given in the MAIL command. However, when an address is expanded via a
1609 forward or alias file, an alternative address can be specified for delivery
1610 failures of the generated addresses. For a mailing list expansion (see section
1611 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1612 of the list.
1613
1614
1615
1616 .section "Failures to deliver bounce messages" "SECID22"
1617 .cindex "bounce message" "failure to deliver"
1618 If a bounce message (either locally generated or received from a remote host)
1619 itself suffers a permanent delivery failure, the message is left in the queue,
1620 but it is frozen, awaiting the attention of an administrator. There are options
1621 that can be used to make Exim discard such failed messages, or to keep them
1622 for only a short time (see &%timeout_frozen_after%& and
1623 &%ignore_bounce_errors_after%&).
1624
1625
1626
1627
1628
1629 . ////////////////////////////////////////////////////////////////////////////
1630 . ////////////////////////////////////////////////////////////////////////////
1631
1632 .chapter "Building and installing Exim" "CHID3"
1633 .scindex IIDbuex "building Exim"
1634
1635 .section "Unpacking" "SECID23"
1636 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1637 creates a directory with the name of the current release (for example,
1638 &_exim-&version()_&) into which the following files are placed:
1639
1640 .table2 140pt
1641 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1642 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1643   documented"
1644 .irow &_LICENCE_&         "the GNU General Public Licence"
1645 .irow &_Makefile_&        "top-level make file"
1646 .irow &_NOTICE_&          "conditions for the use of Exim"
1647 .irow &_README_&          "list of files, directories and simple build &&&
1648   instructions"
1649 .endtable
1650
1651 Other files whose names begin with &_README_& may also be present. The
1652 following subdirectories are created:
1653
1654 .table2 140pt
1655 .irow &_Local_&           "an empty directory for local configuration files"
1656 .irow &_OS_&              "OS-specific files"
1657 .irow &_doc_&             "documentation files"
1658 .irow &_exim_monitor_&    "source files for the Exim monitor"
1659 .irow &_scripts_&         "scripts used in the build process"
1660 .irow &_src_&             "remaining source files"
1661 .irow &_util_&            "independent utilities"
1662 .endtable
1663
1664 The main utility programs are contained in the &_src_& directory and are built
1665 with the Exim binary. The &_util_& directory contains a few optional scripts
1666 that may be useful to some sites.
1667
1668
1669 .section "Multiple machine architectures and operating systems" "SECID24"
1670 .cindex "building Exim" "multiple OS/architectures"
1671 The building process for Exim is arranged to make it easy to build binaries for
1672 a number of different architectures and operating systems from the same set of
1673 source files. Compilation does not take place in the &_src_& directory.
1674 Instead, a &'build directory'& is created for each architecture and operating
1675 system.
1676 .cindex "symbolic link" "to build directory"
1677 Symbolic links to the sources are installed in this directory, which is where
1678 the actual building takes place. In most cases, Exim can discover the machine
1679 architecture and operating system for itself, but the defaults can be
1680 overridden if necessary.
1681 .cindex compiler requirements
1682 .cindex compiler version
1683 A C99-capable compiler will be required for the build.
1684
1685
1686 .section "PCRE library" "SECTpcre"
1687 .cindex "PCRE library"
1688 Exim no longer has an embedded PCRE library as the vast majority of
1689 modern systems include PCRE as a system library, although you may need to
1690 install the PCRE package or the PCRE development package for your operating
1691 system. If your system has a normal PCRE installation the Exim build
1692 process will need no further configuration. If the library or the
1693 headers are in an unusual location you will need to either set the PCRE_LIBS
1694 and INCLUDE directives appropriately,
1695 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1696 If your operating system has no
1697 PCRE support then you will need to obtain and build the current PCRE
1698 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1699 More information on PCRE is available at &url(https://www.pcre.org/).
1700
1701 .section "DBM libraries" "SECTdb"
1702 .cindex "DBM libraries" "discussion of"
1703 .cindex "hints database" "DBM files used for"
1704 Even if you do not use any DBM files in your configuration, Exim still needs a
1705 DBM library in order to operate, because it uses indexed files for its hints
1706 databases. Unfortunately, there are a number of DBM libraries in existence, and
1707 different operating systems often have different ones installed.
1708
1709 .cindex "Solaris" "DBM library for"
1710 .cindex "IRIX, DBM library for"
1711 .cindex "BSD, DBM library for"
1712 .cindex "Linux, DBM library for"
1713 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1714 Linux distribution, the DBM configuration should happen automatically, and you
1715 may be able to ignore this section. Otherwise, you may have to learn more than
1716 you would like about DBM libraries from what follows.
1717
1718 .cindex "&'ndbm'& DBM library"
1719 Licensed versions of Unix normally contain a library of DBM functions operating
1720 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1721 versions of Unix seem to vary in what they contain as standard. In particular,
1722 some early versions of Linux have no default DBM library, and different
1723 distributors have chosen to bundle different libraries with their packaged
1724 versions. However, the more recent releases seem to have standardized on the
1725 Berkeley DB library.
1726
1727 Different DBM libraries have different conventions for naming the files they
1728 use. When a program opens a file called &_dbmfile_&, there are several
1729 possibilities:
1730
1731 .olist
1732 A traditional &'ndbm'& implementation, such as that supplied as part of
1733 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1734 .next
1735 .cindex "&'gdbm'& DBM library"
1736 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1737 compatibility interface it makes two different hard links to it with names
1738 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1739 filename is used unmodified.
1740 .next
1741 .cindex "Berkeley DB library"
1742 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1743 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1744 programmer exactly the same as the traditional &'ndbm'& implementation.
1745 .next
1746 If the Berkeley package is used in its native mode, it operates on a single
1747 file called &_dbmfile_&; the programmer's interface is somewhat different to
1748 the traditional &'ndbm'& interface.
1749 .next
1750 To complicate things further, there are several very different versions of the
1751 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1752 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1753 Maintenance of some of the earlier releases has ceased. All versions of
1754 Berkeley DB could be obtained from
1755 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1756 page with far newer versions listed.
1757 It is probably wise to plan to move your storage configurations away from
1758 Berkeley DB format, as today there are smaller and simpler alternatives more
1759 suited to Exim's usage model.
1760 .next
1761 .cindex "&'tdb'& DBM library"
1762 Yet another DBM library, called &'tdb'&, is available from
1763 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1764 operates on a single file.
1765 .endlist
1766
1767 .cindex "USE_DB"
1768 .cindex "DBM libraries" "configuration for building"
1769 Exim and its utilities can be compiled to use any of these interfaces. In order
1770 to use any version of the Berkeley DB package in native mode, you must set
1771 USE_DB in an appropriate configuration file (typically
1772 &_Local/Makefile_&). For example:
1773 .code
1774 USE_DB=yes
1775 .endd
1776 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1777 error is diagnosed if you set more than one of these.
1778
1779 At the lowest level, the build-time configuration sets none of these options,
1780 thereby assuming an interface of type (1). However, some operating system
1781 configuration files (for example, those for the BSD operating systems and
1782 Linux) assume type (4) by setting USE_DB as their default, and the
1783 configuration files for Cygwin set USE_GDBM. Anything you set in
1784 &_Local/Makefile_&, however, overrides these system defaults.
1785
1786 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1787 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1788 in one of these lines:
1789 .code
1790 DBMLIB = -ldb
1791 DBMLIB = -ltdb
1792 .endd
1793 Settings like that will work if the DBM library is installed in the standard
1794 place. Sometimes it is not, and the library's header file may also not be in
1795 the default path. You may need to set INCLUDE to specify where the header
1796 file is, and to specify the path to the library more fully in DBMLIB, as in
1797 this example:
1798 .code
1799 INCLUDE=-I/usr/local/include/db-4.1
1800 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1801 .endd
1802 There is further detailed discussion about the various DBM libraries in the
1803 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1804
1805
1806
1807 .section "Pre-building configuration" "SECID25"
1808 .cindex "building Exim" "pre-building configuration"
1809 .cindex "configuration for building Exim"
1810 .cindex "&_Local/Makefile_&"
1811 .cindex "&_src/EDITME_&"
1812 Before building Exim, a local configuration file that specifies options
1813 independent of any operating system has to be created with the name
1814 &_Local/Makefile_&. A template for this file is supplied as the file
1815 &_src/EDITME_&, and it contains full descriptions of all the option settings
1816 therein. These descriptions are therefore not repeated here. If you are
1817 building Exim for the first time, the simplest thing to do is to copy
1818 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1819
1820 There are three settings that you must supply, because Exim will not build
1821 without them. They are the location of the runtime configuration file
1822 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1823 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1824 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1825 a colon-separated list of filenames; Exim uses the first of them that exists.
1826
1827 There are a few other parameters that can be specified either at build time or
1828 at runtime, to enable the same binary to be used on a number of different
1829 machines. However, if the locations of Exim's spool directory and log file
1830 directory (if not within the spool directory) are fixed, it is recommended that
1831 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1832 detected early in Exim's execution (such as a malformed configuration file) can
1833 be logged.
1834
1835 .cindex "content scanning" "specifying at build time"
1836 Exim's interfaces for calling virus and spam scanning software directly from
1837 access control lists are not compiled by default. If you want to include these
1838 facilities, you need to set
1839 .code
1840 WITH_CONTENT_SCAN=yes
1841 .endd
1842 in your &_Local/Makefile_&. For details of the facilities themselves, see
1843 chapter &<<CHAPexiscan>>&.
1844
1845
1846 .cindex "&_Local/eximon.conf_&"
1847 .cindex "&_exim_monitor/EDITME_&"
1848 If you are going to build the Exim monitor, a similar configuration process is
1849 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1850 your installation and saved under the name &_Local/eximon.conf_&. If you are
1851 happy with the default settings described in &_exim_monitor/EDITME_&,
1852 &_Local/eximon.conf_& can be empty, but it must exist.
1853
1854 This is all the configuration that is needed in straightforward cases for known
1855 operating systems. However, the building process is set up so that it is easy
1856 to override options that are set by default or by operating-system-specific
1857 configuration files, for example, to change the C compiler, which
1858 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1859 do this.
1860
1861
1862
1863 .section "Support for iconv()" "SECID26"
1864 .cindex "&[iconv()]& support"
1865 .cindex "RFC 2047"
1866 The contents of header lines in messages may be encoded according to the rules
1867 described RFC 2047. This makes it possible to transmit characters that are not
1868 in the ASCII character set, and to label them as being in a particular
1869 character set. When Exim is inspecting header lines by means of the &%$h_%&
1870 mechanism, it decodes them, and translates them into a specified character set
1871 (default is set at build time). The translation is possible only if the operating system
1872 supports the &[iconv()]& function.
1873
1874 However, some of the operating systems that supply &[iconv()]& do not support
1875 very many conversions. The GNU &%libiconv%& library (available from
1876 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1877 systems to remedy this deficiency, as well as on systems that do not supply
1878 &[iconv()]& at all. After installing &%libiconv%&, you should add
1879 .code
1880 HAVE_ICONV=yes
1881 .endd
1882 to your &_Local/Makefile_& and rebuild Exim.
1883
1884
1885
1886 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1887 .cindex "TLS" "including support for TLS"
1888 .cindex "encryption" "including support for"
1889 .cindex "SUPPORT_TLS"
1890 .cindex "OpenSSL" "building Exim with"
1891 .cindex "GnuTLS" "building Exim with"
1892 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1893 command as per RFC 2487. It can also support legacy clients that expect to
1894 start a TLS session immediately on connection to a non-standard port (see the
1895 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1896 line option).
1897
1898 If you want to build Exim with TLS support, you must first install either the
1899 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1900 implementing SSL.
1901
1902 If OpenSSL is installed, you should set
1903 .code
1904 SUPPORT_TLS=yes
1905 TLS_LIBS=-lssl -lcrypto
1906 .endd
1907 in &_Local/Makefile_&. You may also need to specify the locations of the
1908 OpenSSL library and include files. For example:
1909 .code
1910 SUPPORT_TLS=yes
1911 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1912 TLS_INCLUDE=-I/usr/local/openssl/include/
1913 .endd
1914 .cindex "pkg-config" "OpenSSL"
1915 If you have &'pkg-config'& available, then instead you can just use:
1916 .code
1917 SUPPORT_TLS=yes
1918 USE_OPENSSL_PC=openssl
1919 .endd
1920 .cindex "USE_GNUTLS"
1921 If GnuTLS is installed, you should set
1922 .code
1923 SUPPORT_TLS=yes
1924 USE_GNUTLS=yes
1925 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1926 .endd
1927 in &_Local/Makefile_&, and again you may need to specify the locations of the
1928 library and include files. For example:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1933 TLS_INCLUDE=-I/usr/gnu/include
1934 .endd
1935 .cindex "pkg-config" "GnuTLS"
1936 If you have &'pkg-config'& available, then instead you can just use:
1937 .code
1938 SUPPORT_TLS=yes
1939 USE_GNUTLS=yes
1940 USE_GNUTLS_PC=gnutls
1941 .endd
1942
1943 You do not need to set TLS_INCLUDE if the relevant directory is already
1944 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1945 given in chapter &<<CHAPTLS>>&.
1946
1947
1948
1949
1950 .section "Use of tcpwrappers" "SECID27"
1951
1952 .cindex "tcpwrappers, building Exim to support"
1953 .cindex "USE_TCP_WRAPPERS"
1954 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1955 .cindex "tcp_wrappers_daemon_name"
1956 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1957 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1958 alternative to Exim's own checking facilities for installations that are
1959 already making use of &'tcpwrappers'& for other purposes. To do this, you
1960 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1961 &_tcpd.h_& to be available at compile time, and also ensure that the library
1962 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1963 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1964 you might have
1965 .code
1966 USE_TCP_WRAPPERS=yes
1967 CFLAGS=-O -I/usr/local/include
1968 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1969 .endd
1970 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1971 files is &"exim"&. For example, the line
1972 .code
1973 exim : LOCAL  192.168.1.  .friendly.domain.example
1974 .endd
1975 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1976 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1977 All other connections are denied. The daemon name used by &'tcpwrappers'&
1978 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1979 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1980 configure file. Consult the &'tcpwrappers'& documentation for
1981 further details.
1982
1983
1984 .section "Including support for IPv6" "SECID28"
1985 .cindex "IPv6" "including support for"
1986 Exim contains code for use on systems that have IPv6 support. Setting
1987 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1988 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1989 where the IPv6 support is not fully integrated into the normal include and
1990 library files.
1991
1992 Two different types of DNS record for handling IPv6 addresses have been
1993 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1994 currently seen as the mainstream. Another record type called A6 was proposed
1995 as better than AAAA because it had more flexibility. However, it was felt to be
1996 over-complex, and its status was reduced to &"experimental"&.
1997 Exim used to
1998 have a compile option for including A6 record support but this has now been
1999 withdrawn.
2000
2001
2002
2003 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2004 .cindex "lookup modules"
2005 .cindex "dynamic modules"
2006 .cindex ".so building"
2007 On some platforms, Exim supports not compiling all lookup types directly into
2008 the main binary, instead putting some into external modules which can be loaded
2009 on demand.
2010 This permits packagers to build Exim with support for lookups with extensive
2011 library dependencies without requiring all users to install all of those
2012 dependencies.
2013 Most, but not all, lookup types can be built this way.
2014
2015 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2016 installed; Exim will only load modules from that directory, as a security
2017 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2018 for your OS; see &_OS/Makefile-Linux_& for an example.
2019 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2020 see &_src/EDITME_& for details.
2021
2022 Then, for each module to be loaded dynamically, define the relevant
2023 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2024 For example, this will build in lsearch but load sqlite and mysql support
2025 on demand:
2026 .code
2027 LOOKUP_LSEARCH=yes
2028 LOOKUP_SQLITE=2
2029 LOOKUP_MYSQL=2
2030 .endd
2031
2032
2033 .section "The building process" "SECID29"
2034 .cindex "build directory"
2035 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2036 created, run &'make'& at the top level. It determines the architecture and
2037 operating system types, and creates a build directory if one does not exist.
2038 For example, on a Sun system running Solaris 8, the directory
2039 &_build-SunOS5-5.8-sparc_& is created.
2040 .cindex "symbolic link" "to source files"
2041 Symbolic links to relevant source files are installed in the build directory.
2042
2043 If this is the first time &'make'& has been run, it calls a script that builds
2044 a make file inside the build directory, using the configuration files from the
2045 &_Local_& directory. The new make file is then passed to another instance of
2046 &'make'&. This does the real work, building a number of utility scripts, and
2047 then compiling and linking the binaries for the Exim monitor (if configured), a
2048 number of utility programs, and finally Exim itself. The command &`make
2049 makefile`& can be used to force a rebuild of the make file in the build
2050 directory, should this ever be necessary.
2051
2052 If you have problems building Exim, check for any comments there may be in the
2053 &_README_& file concerning your operating system, and also take a look at the
2054 FAQ, where some common problems are covered.
2055
2056
2057
2058 .section 'Output from &"make"&' "SECID283"
2059 The output produced by the &'make'& process for compile lines is often very
2060 unreadable, because these lines can be very long. For this reason, the normal
2061 output is suppressed by default, and instead output similar to that which
2062 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2063 each module that is being compiled or linked. However, it is still possible to
2064 get the full output, by calling &'make'& like this:
2065 .code
2066 FULLECHO='' make -e
2067 .endd
2068 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2069 command reflection in &'make'&. When you ask for the full output, it is
2070 given in addition to the short output.
2071
2072
2073
2074 .section "Overriding build-time options for Exim" "SECToverride"
2075 .cindex "build-time options, overriding"
2076 The main make file that is created at the beginning of the building process
2077 consists of the concatenation of a number of files which set configuration
2078 values, followed by a fixed set of &'make'& instructions. If a value is set
2079 more than once, the last setting overrides any previous ones. This provides a
2080 convenient way of overriding defaults. The files that are concatenated are, in
2081 order:
2082 .display
2083 &_OS/Makefile-Default_&
2084 &_OS/Makefile-_&<&'ostype'&>
2085 &_Local/Makefile_&
2086 &_Local/Makefile-_&<&'ostype'&>
2087 &_Local/Makefile-_&<&'archtype'&>
2088 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2089 &_OS/Makefile-Base_&
2090 .endd
2091 .cindex "&_Local/Makefile_&"
2092 .cindex "building Exim" "operating system type"
2093 .cindex "building Exim" "architecture type"
2094 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2095 architecture type. &_Local/Makefile_& is required to exist, and the building
2096 process fails if it is absent. The other three &_Local_& files are optional,
2097 and are often not needed.
2098
2099 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2100 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2101 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2102 values are used, thereby providing a means of forcing particular settings.
2103 Otherwise, the scripts try to get values from the &%uname%& command. If this
2104 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2105 of &'ad hoc'& transformations are then applied, to produce the standard names
2106 that Exim expects. You can run these scripts directly from the shell in order
2107 to find out what values are being used on your system.
2108
2109
2110 &_OS/Makefile-Default_& contains comments about the variables that are set
2111 therein. Some (but not all) are mentioned below. If there is something that
2112 needs changing, review the contents of this file and the contents of the make
2113 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2114 default values are.
2115
2116
2117 .cindex "building Exim" "overriding default settings"
2118 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2119 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2120 need to change the original files. Instead, you should make the changes by
2121 putting the new values in an appropriate &_Local_& file. For example,
2122 .cindex "Tru64-Unix build-time settings"
2123 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2124 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2125 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2126 called with the option &%-std1%&, to make it recognize some of the features of
2127 Standard C that Exim uses. (Most other compilers recognize Standard C by
2128 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2129 containing the lines
2130 .code
2131 CC=cc
2132 CFLAGS=-std1
2133 .endd
2134 If you are compiling for just one operating system, it may be easier to put
2135 these lines directly into &_Local/Makefile_&.
2136
2137 Keeping all your local configuration settings separate from the distributed
2138 files makes it easy to transfer them to new versions of Exim simply by copying
2139 the contents of the &_Local_& directory.
2140
2141
2142 .cindex "NIS lookup type" "including support for"
2143 .cindex "NIS+ lookup type" "including support for"
2144 .cindex "LDAP" "including support for"
2145 .cindex "lookup" "inclusion in binary"
2146 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2147 lookup, but not all systems have these components installed, so the default is
2148 not to include the relevant code in the binary. All the different kinds of file
2149 and database lookup that Exim supports are implemented as separate code modules
2150 which are included only if the relevant compile-time options are set. In the
2151 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2152 .code
2153 LOOKUP_LDAP=yes
2154 LOOKUP_NIS=yes
2155 LOOKUP_NISPLUS=yes
2156 .endd
2157 and similar settings apply to the other lookup types. They are all listed in
2158 &_src/EDITME_&. In many cases the relevant include files and interface
2159 libraries need to be installed before compiling Exim.
2160 .cindex "cdb" "including support for"
2161 However, there are some optional lookup types (such as cdb) for which
2162 the code is entirely contained within Exim, and no external include
2163 files or libraries are required. When a lookup type is not included in the
2164 binary, attempts to configure Exim to use it cause runtime configuration
2165 errors.
2166
2167 .cindex "pkg-config" "lookups"
2168 .cindex "pkg-config" "authenticators"
2169 Many systems now use a tool called &'pkg-config'& to encapsulate information
2170 about how to compile against a library; Exim has some initial support for
2171 being able to use pkg-config for lookups and authenticators.  For any given
2172 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2173 variable with the &`_PC`& suffix in the name and assign as the value the
2174 name of the package to be queried.  The results of querying via the
2175 &'pkg-config'& command will be added to the appropriate Makefile variables
2176 with &`+=`& directives, so your version of &'make'& will need to support that
2177 syntax.  For instance:
2178 .code
2179 LOOKUP_SQLITE=yes
2180 LOOKUP_SQLITE_PC=sqlite3
2181 AUTH_GSASL=yes
2182 AUTH_GSASL_PC=libgsasl
2183 AUTH_HEIMDAL_GSSAPI=yes
2184 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2185 .endd
2186
2187 .cindex "Perl" "including support for"
2188 Exim can be linked with an embedded Perl interpreter, allowing Perl
2189 subroutines to be called during string expansion. To enable this facility,
2190 .code
2191 EXIM_PERL=perl.o
2192 .endd
2193 must be defined in &_Local/Makefile_&. Details of this facility are given in
2194 chapter &<<CHAPperl>>&.
2195
2196 .cindex "X11 libraries, location of"
2197 The location of the X11 libraries is something that varies a lot between
2198 operating systems, and there may be different versions of X11 to cope
2199 with. Exim itself makes no use of X11, but if you are compiling the Exim
2200 monitor, the X11 libraries must be available.
2201 The following three variables are set in &_OS/Makefile-Default_&:
2202 .code
2203 X11=/usr/X11R6
2204 XINCLUDE=-I$(X11)/include
2205 XLFLAGS=-L$(X11)/lib
2206 .endd
2207 These are overridden in some of the operating-system configuration files. For
2208 example, in &_OS/Makefile-SunOS5_& there is
2209 .code
2210 X11=/usr/openwin
2211 XINCLUDE=-I$(X11)/include
2212 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2213 .endd
2214 If you need to override the default setting for your operating system, place a
2215 definition of all three of these variables into your
2216 &_Local/Makefile-<ostype>_& file.
2217
2218 .cindex "EXTRALIBS"
2219 If you need to add any extra libraries to the link steps, these can be put in a
2220 variable called EXTRALIBS, which appears in all the link commands, but by
2221 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2222 command for linking the main Exim binary, and not for any associated utilities.
2223
2224 .cindex "DBM libraries" "configuration for building"
2225 There is also DBMLIB, which appears in the link commands for binaries that
2226 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2227 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2228 binary, and which can be used, for example, to include additional X11
2229 libraries.
2230
2231 .cindex "configuration file" "editing"
2232 The make file copes with rebuilding Exim correctly if any of the configuration
2233 files are edited. However, if an optional configuration file is deleted, it is
2234 necessary to touch the associated non-optional file (that is,
2235 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2236
2237
2238 .section "OS-specific header files" "SECID30"
2239 .cindex "&_os.h_&"
2240 .cindex "building Exim" "OS-specific C header files"
2241 The &_OS_& directory contains a number of files with names of the form
2242 &_os.h-<ostype>_&. These are system-specific C header files that should not
2243 normally need to be changed. There is a list of macro settings that are
2244 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2245 are porting Exim to a new operating system.
2246
2247
2248
2249 .section "Overriding build-time options for the monitor" "SECID31"
2250 .cindex "building Eximon"
2251 A similar process is used for overriding things when building the Exim monitor,
2252 where the files that are involved are
2253 .display
2254 &_OS/eximon.conf-Default_&
2255 &_OS/eximon.conf-_&<&'ostype'&>
2256 &_Local/eximon.conf_&
2257 &_Local/eximon.conf-_&<&'ostype'&>
2258 &_Local/eximon.conf-_&<&'archtype'&>
2259 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2260 .endd
2261 .cindex "&_Local/eximon.conf_&"
2262 As with Exim itself, the final three files need not exist, and in this case the
2263 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2264 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2265 variables of the same name, preceded by EXIMON_. For example, setting
2266 EXIMON_LOG_DEPTH in the environment overrides the value of
2267 LOG_DEPTH at runtime.
2268 .ecindex IIDbuex
2269
2270
2271 .section "Installing Exim binaries and scripts" "SECID32"
2272 .cindex "installing Exim"
2273 .cindex "BIN_DIRECTORY"
2274 The command &`make install`& runs the &(exim_install)& script with no
2275 arguments. The script copies binaries and utility scripts into the directory
2276 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2277 .cindex "setuid" "installing Exim with"
2278 The install script copies files only if they are newer than the files they are
2279 going to replace. The Exim binary is required to be owned by root and have the
2280 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2281 install`& as root so that it can set up the Exim binary in this way. However, in
2282 some special situations (for example, if a host is doing no local deliveries)
2283 it may be possible to run Exim without making the binary setuid root (see
2284 chapter &<<CHAPsecurity>>& for details).
2285
2286 .cindex "CONFIGURE_FILE"
2287 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2288 in &_Local/Makefile_&. If this names a single file, and the file does not
2289 exist, the default configuration file &_src/configure.default_& is copied there
2290 by the installation script. If a runtime configuration file already exists, it
2291 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2292 alternative files, no default is installed.
2293
2294 .cindex "system aliases file"
2295 .cindex "&_/etc/aliases_&"
2296 One change is made to the default configuration file when it is installed: the
2297 default configuration contains a router that references a system aliases file.
2298 The path to this file is set to the value specified by
2299 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2300 If the system aliases file does not exist, the installation script creates it,
2301 and outputs a comment to the user.
2302
2303 The created file contains no aliases, but it does contain comments about the
2304 aliases a site should normally have. Mail aliases have traditionally been
2305 kept in &_/etc/aliases_&. However, some operating systems are now using
2306 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2307 Exim's configuration if necessary.
2308
2309 The default configuration uses the local host's name as the only local domain,
2310 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2311 running as the local user. System aliases and &_.forward_& files in users' home
2312 directories are supported, but no NIS or NIS+ support is configured. Domains
2313 other than the name of the local host are routed using the DNS, with delivery
2314 over SMTP.
2315
2316 It is possible to install Exim for special purposes (such as building a binary
2317 distribution) in a private part of the file system. You can do this by a
2318 command such as
2319 .code
2320 make DESTDIR=/some/directory/ install
2321 .endd
2322 This has the effect of pre-pending the specified directory to all the file
2323 paths, except the name of the system aliases file that appears in the default
2324 configuration. (If a default alias file is created, its name &'is'& modified.)
2325 For backwards compatibility, ROOT is used if DESTDIR is not set,
2326 but this usage is deprecated.
2327
2328 .cindex "installing Exim" "what is not installed"
2329 Running &'make install'& does not copy the Exim 4 conversion script
2330 &'convert4r4'&. You will probably run this only once if you are
2331 upgrading from Exim 3. None of the documentation files in the &_doc_&
2332 directory are copied, except for the info files when you have set
2333 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2334
2335 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2336 to their names. The Exim binary itself, however, is handled differently. It is
2337 installed under a name that includes the version number and the compile number,
2338 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2339 called &_exim_& to point to the binary. If you are updating a previous version
2340 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2341 from the directory (as seen by other processes).
2342
2343 .cindex "installing Exim" "testing the script"
2344 If you want to see what the &'make install'& will do before running it for
2345 real, you can pass the &%-n%& option to the installation script by this
2346 command:
2347 .code
2348 make INSTALL_ARG=-n install
2349 .endd
2350 The contents of the variable INSTALL_ARG are passed to the installation
2351 script. You do not need to be root to run this test. Alternatively, you can run
2352 the installation script directly, but this must be from within the build
2353 directory. For example, from the top-level Exim directory you could use this
2354 command:
2355 .code
2356 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2357 .endd
2358 .cindex "installing Exim" "install script options"
2359 There are two other options that can be supplied to the installation script.
2360
2361 .ilist
2362 &%-no_chown%& bypasses the call to change the owner of the installed binary
2363 to root, and the call to make it a setuid binary.
2364 .next
2365 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2366 installed binary.
2367 .endlist
2368
2369 INSTALL_ARG can be used to pass these options to the script. For example:
2370 .code
2371 make INSTALL_ARG=-no_symlink install
2372 .endd
2373 The installation script can also be given arguments specifying which files are
2374 to be copied. For example, to install just the Exim binary, and nothing else,
2375 without creating the symbolic link, you could use:
2376 .code
2377 make INSTALL_ARG='-no_symlink exim' install
2378 .endd
2379
2380
2381
2382 .section "Installing info documentation" "SECTinsinfdoc"
2383 .cindex "installing Exim" "&'info'& documentation"
2384 Not all systems use the GNU &'info'& system for documentation, and for this
2385 reason, the Texinfo source of Exim's documentation is not included in the main
2386 distribution. Instead it is available separately from the FTP site (see section
2387 &<<SECTavail>>&).
2388
2389 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2390 source of the documentation is found in the source tree, running &`make
2391 install`& automatically builds the info files and installs them.
2392
2393
2394
2395 .section "Setting up the spool directory" "SECID33"
2396 .cindex "spool directory" "creating"
2397 When it starts up, Exim tries to create its spool directory if it does not
2398 exist. The Exim uid and gid are used for the owner and group of the spool
2399 directory. Sub-directories are automatically created in the spool directory as
2400 necessary.
2401
2402
2403
2404
2405 .section "Testing" "SECID34"
2406 .cindex "testing" "installation"
2407 Having installed Exim, you can check that the runtime configuration file is
2408 syntactically valid by running the following command, which assumes that the
2409 Exim binary directory is within your PATH environment variable:
2410 .code
2411 exim -bV
2412 .endd
2413 If there are any errors in the configuration file, Exim outputs error messages.
2414 Otherwise it outputs the version number and build date,
2415 the DBM library that is being used, and information about which drivers and
2416 other optional code modules are included in the binary.
2417 Some simple routing tests can be done by using the address testing option. For
2418 example,
2419 .display
2420 &`exim -bt`& <&'local username'&>
2421 .endd
2422 should verify that it recognizes a local mailbox, and
2423 .display
2424 &`exim -bt`& <&'remote address'&>
2425 .endd
2426 a remote one. Then try getting it to deliver mail, both locally and remotely.
2427 This can be done by passing messages directly to Exim, without going through a
2428 user agent. For example:
2429 .code
2430 exim -v postmaster@your.domain.example
2431 From: user@your.domain.example
2432 To: postmaster@your.domain.example
2433 Subject: Testing Exim
2434
2435 This is a test message.
2436 ^D
2437 .endd
2438 The &%-v%& option causes Exim to output some verification of what it is doing.
2439 In this case you should see copies of three log lines, one for the message's
2440 arrival, one for its delivery, and one containing &"Completed"&.
2441
2442 .cindex "delivery" "problems with"
2443 If you encounter problems, look at Exim's log files (&'mainlog'& and
2444 &'paniclog'&) to see if there is any relevant information there. Another source
2445 of information is running Exim with debugging turned on, by specifying the
2446 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2447 with debugging turned on by a command of the form
2448 .display
2449 &`exim -d -M`& <&'exim-message-id'&>
2450 .endd
2451 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2452 produces rather a lot of output, but you can cut this down to specific areas.
2453 For example, if you use &%-d-all+route%& only the debugging information
2454 relevant to routing is included. (See the &%-d%& option in chapter
2455 &<<CHAPcommandline>>& for more details.)
2456
2457 .cindex '&"sticky"& bit'
2458 .cindex "lock files"
2459 One specific problem that has shown up on some sites is the inability to do
2460 local deliveries into a shared mailbox directory, because it does not have the
2461 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2462 writing to a mailbox file, and if it cannot create the lock file, the delivery
2463 is deferred. You can get round this either by setting the &"sticky bit"& on the
2464 directory, or by setting a specific group for local deliveries and allowing
2465 that group to create files in the directory (see the comments above the
2466 &(local_delivery)& transport in the default configuration file). Another
2467 approach is to configure Exim not to use lock files, but just to rely on
2468 &[fcntl()]& locking instead. However, you should do this only if all user
2469 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2470 see chapter &<<CHAPappendfile>>&.
2471
2472 One thing that cannot be tested on a system that is already running an MTA is
2473 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2474 &%-oX%& option can be used to run an Exim daemon that listens on some other
2475 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2476 &'exim_checkaccess'& utility can be used to check out policy controls on
2477 incoming SMTP mail.
2478
2479 Testing a new version on a system that is already running Exim can most easily
2480 be done by building a binary with a different CONFIGURE_FILE setting. From
2481 within the runtime configuration, all other file and directory names
2482 that Exim uses can be altered, in order to keep it entirely clear of the
2483 production version.
2484
2485
2486 .section "Replacing another MTA with Exim" "SECID35"
2487 .cindex "replacing another MTA"
2488 Building and installing Exim for the first time does not of itself put it in
2489 general use. The name by which the system's MTA is called by mail user agents
2490 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2491 operating system), and it is necessary to make this name point to the &'exim'&
2492 binary in order to get the user agents to pass messages to Exim. This is
2493 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2494 or &_/usr/lib/sendmail_&
2495 .cindex "symbolic link" "to &'exim'& binary"
2496 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2497 privilege and executable status from the old MTA. It is then necessary to stop
2498 and restart the mailer daemon, if one is running.
2499
2500 .cindex "FreeBSD, MTA indirection"
2501 .cindex "&_/etc/mail/mailer.conf_&"
2502 Some operating systems have introduced alternative ways of switching MTAs. For
2503 example, if you are running FreeBSD, you need to edit the file
2504 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2505 described. A typical example of the contents of this file for running Exim is
2506 as follows:
2507 .code
2508 sendmail            /usr/exim/bin/exim
2509 send-mail           /usr/exim/bin/exim
2510 mailq               /usr/exim/bin/exim -bp
2511 newaliases          /usr/bin/true
2512 .endd
2513 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2514 your Exim installation is &"live"&. Check it by sending a message from your
2515 favourite user agent.
2516
2517 You should consider what to tell your users about the change of MTA. Exim may
2518 have different capabilities to what was previously running, and there are
2519 various operational differences such as the text of messages produced by
2520 command line options and in bounce messages. If you allow your users to make
2521 use of Exim's filtering capabilities, you should make the document entitled
2522 &'Exim's interface to mail filtering'& available to them.
2523
2524
2525
2526 .section "Upgrading Exim" "SECID36"
2527 .cindex "upgrading Exim"
2528 If you are already running Exim on your host, building and installing a new
2529 version automatically makes it available to MUAs, or any other programs that
2530 call the MTA directly. However, if you are running an Exim daemon, you do need
2531 .cindex restart "on HUP signal"
2532 .cindex signal "HUP, to restart"
2533 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2534 new binary. You do not need to stop processing mail in order to install a new
2535 version of Exim. The install script does not modify an existing runtime
2536 configuration file.
2537
2538
2539
2540
2541 .section "Stopping the Exim daemon on Solaris" "SECID37"
2542 .cindex "Solaris" "stopping Exim on"
2543 The standard command for stopping the mailer daemon on Solaris is
2544 .code
2545 /etc/init.d/sendmail stop
2546 .endd
2547 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2548 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2549 for the text &"sendmail"&; this is not present because the actual program name
2550 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2551 solution is to replace the line that finds the process id with something like
2552 .code
2553 pid=`cat /var/spool/exim/exim-daemon.pid`
2554 .endd
2555 to obtain the daemon's pid directly from the file that Exim saves it in.
2556
2557 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2558 still be received from local processes, and if automatic delivery is configured
2559 (the normal case), deliveries will still occur.
2560
2561
2562
2563
2564 . ////////////////////////////////////////////////////////////////////////////
2565 . ////////////////////////////////////////////////////////////////////////////
2566
2567 .chapter "The Exim command line" "CHAPcommandline"
2568 .scindex IIDclo1 "command line" "options"
2569 .scindex IIDclo2 "options" "command line"
2570 Exim's command line takes the standard Unix form of a sequence of options,
2571 each starting with a hyphen character, followed by a number of arguments. The
2572 options are compatible with the main options of Sendmail, and there are also
2573 some additional options, some of which are compatible with Smail 3. Certain
2574 combinations of options do not make sense, and provoke an error if used.
2575 The form of the arguments depends on which options are set.
2576
2577
2578 .section "Setting options by program name" "SECID38"
2579 .cindex "&'mailq'&"
2580 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2581 were present before any other options.
2582 The &%-bp%& option requests a listing of the contents of the mail queue on the
2583 standard output.
2584 This feature is for compatibility with some systems that contain a command of
2585 that name in one of the standard libraries, symbolically linked to
2586 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2587
2588 .cindex "&'rsmtp'&"
2589 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2590 were present before any other options, for compatibility with Smail. The
2591 &%-bS%& option is used for reading in a number of messages in batched SMTP
2592 format.
2593
2594 .cindex "&'rmail'&"
2595 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2596 &%-oee%& options were present before any other options, for compatibility with
2597 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2598
2599 .cindex "&'runq'&"
2600 .cindex "queue runner"
2601 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2602 were present before any other options, for compatibility with Smail. The &%-q%&
2603 option causes a single queue runner process to be started.
2604
2605 .cindex "&'newaliases'&"
2606 .cindex "alias file" "building"
2607 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2608 If Exim is called under the name &'newaliases'& it behaves as if the option
2609 &%-bi%& were present before any other options, for compatibility with Sendmail.
2610 This option is used for rebuilding Sendmail's alias file. Exim does not have
2611 the concept of a single alias file, but can be configured to run a given
2612 command if called with the &%-bi%& option.
2613
2614
2615 .section "Trusted and admin users" "SECTtrustedadmin"
2616 Some Exim options are available only to &'trusted users'& and others are
2617 available only to &'admin users'&. In the description below, the phrases &"Exim
2618 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2619 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2620 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2621
2622 .ilist
2623 .cindex "trusted users" "definition of"
2624 .cindex "user" "trusted definition of"
2625 The trusted users are root, the Exim user, any user listed in the
2626 &%trusted_users%& configuration option, and any user whose current group or any
2627 supplementary group is one of those listed in the &%trusted_groups%&
2628 configuration option. Note that the Exim group is not automatically trusted.
2629
2630 .cindex '&"From"& line'
2631 .cindex "envelope from"
2632 .cindex "envelope sender"
2633 Trusted users are always permitted to use the &%-f%& option or a leading
2634 &"From&~"& line to specify the envelope sender of a message that is passed to
2635 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2636 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2637 users to set envelope senders.
2638
2639 .cindex "&'From:'& header line"
2640 .cindex "&'Sender:'& header line"
2641 .cindex "header lines" "From:"
2642 .cindex "header lines" "Sender:"
2643 For a trusted user, there is never any check on the contents of the &'From:'&
2644 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2645 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2646
2647 Trusted users may also specify a host name, host address, interface address,
2648 protocol name, ident value, and authentication data when submitting a message
2649 locally. Thus, they are able to insert messages into Exim's queue locally that
2650 have the characteristics of messages received from a remote host. Untrusted
2651 users may in some circumstances use &%-f%&, but can never set the other values
2652 that are available to trusted users.
2653 .next
2654 .cindex "user" "admin definition of"
2655 .cindex "admin user" "definition of"
2656 The admin users are root, the Exim user, and any user that is a member of the
2657 Exim group or of any group listed in the &%admin_groups%& configuration option.
2658 The current group does not have to be one of these groups.
2659
2660 Admin users are permitted to list the queue, and to carry out certain
2661 operations on messages, for example, to force delivery failures. It is also
2662 necessary to be an admin user in order to see the full information provided by
2663 the Exim monitor, and full debugging output.
2664
2665 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2666 Exim to attempt delivery of messages on its queue is restricted to admin users.
2667 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2668 option false (that is, specifying &%no_prod_requires_admin%&).
2669
2670 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2671 is restricted to admin users unless &%queue_list_requires_admin%& is set
2672 false.
2673 .endlist
2674
2675
2676 &*Warning*&: If you configure your system so that admin users are able to
2677 edit Exim's configuration file, you are giving those users an easy way of
2678 getting root. There is further discussion of this issue at the start of chapter
2679 &<<CHAPconf>>&.
2680
2681
2682
2683
2684 .section "Command line options" "SECID39"
2685 Exim's command line options are described in alphabetical order below. If none
2686 of the options that specifies a specific action (such as starting the daemon or
2687 a queue runner, or testing an address, or receiving a message in a specific
2688 format, or listing the queue) are present, and there is at least one argument
2689 on the command line, &%-bm%& (accept a local message on the standard input,
2690 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2691 outputs a brief message about itself and exits.
2692
2693 . ////////////////////////////////////////////////////////////////////////////
2694 . Insert a stylized XML comment here, to identify the start of the command line
2695 . options. This is for the benefit of the Perl script that automatically
2696 . creates a man page for the options.
2697 . ////////////////////////////////////////////////////////////////////////////
2698
2699 .literal xml
2700 <!-- === Start of command line options === -->
2701 .literal off
2702
2703
2704 .vlist
2705 .vitem &%--%&
2706 .oindex "--"
2707 .cindex "options" "command line; terminating"
2708 This is a pseudo-option whose only purpose is to terminate the options and
2709 therefore to cause subsequent command line items to be treated as arguments
2710 rather than options, even if they begin with hyphens.
2711
2712 .vitem &%--help%&
2713 .oindex "&%--help%&"
2714 This option causes Exim to output a few sentences stating what it is.
2715 The same output is generated if the Exim binary is called with no options and
2716 no arguments.
2717
2718 .vitem &%--version%&
2719 .oindex "&%--version%&"
2720 This option is an alias for &%-bV%& and causes version information to be
2721 displayed.
2722
2723 .vitem &%-Ac%& &&&
2724        &%-Am%&
2725 .oindex "&%-Ac%&"
2726 .oindex "&%-Am%&"
2727 These options are used by Sendmail for selecting configuration files and are
2728 ignored by Exim.
2729
2730 .vitem &%-B%&<&'type'&>
2731 .oindex "&%-B%&"
2732 .cindex "8-bit characters"
2733 .cindex "Sendmail compatibility" "8-bit characters"
2734 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2735 clean; it ignores this option.
2736
2737 .vitem &%-bd%&
2738 .oindex "&%-bd%&"
2739 .cindex "daemon"
2740 .cindex "SMTP" "listener"
2741 .cindex "queue runner"
2742 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2743 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2744 that the daemon should also initiate periodic queue runs.
2745
2746 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2747 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2748 disconnect from the controlling terminal. When running this way, it can be
2749 stopped by pressing ctrl-C.
2750
2751 By default, Exim listens for incoming connections to the standard SMTP port on
2752 all the host's running interfaces. However, it is possible to listen on other
2753 ports, on multiple ports, and only on specific interfaces. Chapter
2754 &<<CHAPinterfaces>>& contains a description of the options that control this.
2755
2756 When a listening daemon
2757 .cindex "daemon" "process id (pid)"
2758 .cindex "pid (process id)" "of daemon"
2759 is started without the use of &%-oX%& (that is, without overriding the normal
2760 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2761 in Exim's spool directory. This location can be overridden by setting
2762 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2763 running as root.
2764
2765 When &%-oX%& is used on the command line to start a listening daemon, the
2766 process id is not written to the normal pid file path. However, &%-oP%& can be
2767 used to specify a path on the command line if a pid file is required.
2768
2769 The SIGHUP signal
2770 .cindex "SIGHUP"
2771 .cindex restart "on HUP signal"
2772 .cindex signal "HUP, to restart"
2773 .cindex "daemon" "restarting"
2774 .cindex signal "to reload configuration"
2775 .cindex daemon "reload configuration"
2776 .cindex reload configuration
2777 can be used to cause the daemon to re-execute itself. This should be done
2778 whenever Exim's configuration file, or any file that is incorporated into it by
2779 means of the &%.include%& facility, is changed, and also whenever a new version
2780 of Exim is installed. It is not necessary to do this when other files that are
2781 referenced from the configuration (for example, alias files) are changed,
2782 because these are reread each time they are used.
2783
2784 .vitem &%-bdf%&
2785 .oindex "&%-bdf%&"
2786 This option has the same effect as &%-bd%& except that it never disconnects
2787 from the controlling terminal, even when no debugging is specified.
2788
2789 .vitem &%-be%&
2790 .oindex "&%-be%&"
2791 .cindex "testing" "string expansion"
2792 .cindex "expansion" "testing"
2793 Run Exim in expansion testing mode. Exim discards its root privilege, to
2794 prevent ordinary users from using this mode to read otherwise inaccessible
2795 files. If no arguments are given, Exim runs interactively, prompting for lines
2796 of data. Otherwise, it processes each argument in turn.
2797
2798 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2799 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2800 used without command line arguments. If successful, it uses the &[readline()]&
2801 function, which provides extensive line-editing facilities, for reading the
2802 test data. A line history is supported.
2803
2804 Long expansion expressions can be split over several lines by using backslash
2805 continuations. As in Exim's runtime configuration, white space at the start of
2806 continuation lines is ignored. Each argument or data line is passed through the
2807 string expansion mechanism, and the result is output. Variable values from the
2808 configuration file (for example, &$qualify_domain$&) are available, but no
2809 message-specific values (such as &$message_exim_id$&) are set, because no message
2810 is being processed (but see &%-bem%& and &%-Mset%&).
2811
2812 &*Note*&: If you use this mechanism to test lookups, and you change the data
2813 files or databases you are using, you must exit and restart Exim before trying
2814 the same lookup again. Otherwise, because each Exim process caches the results
2815 of lookups, you will just get the same result as before.
2816
2817 Macro processing is done on lines before string-expansion: new macros can be
2818 defined and macros will be expanded.
2819 Because macros in the config file are often used for secrets, those are only
2820 available to admin users.
2821
2822 .vitem &%-bem%&&~<&'filename'&>
2823 .oindex "&%-bem%&"
2824 .cindex "testing" "string expansion"
2825 .cindex "expansion" "testing"
2826 This option operates like &%-be%& except that it must be followed by the name
2827 of a file. For example:
2828 .code
2829 exim -bem /tmp/testmessage
2830 .endd
2831 The file is read as a message (as if receiving a locally-submitted non-SMTP
2832 message) before any of the test expansions are done. Thus, message-specific
2833 variables such as &$message_size$& and &$header_from:$& are available. However,
2834 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2835 recipients are read from the headers in the normal way, and are shown in the
2836 &$recipients$& variable. Note that recipients cannot be given on the command
2837 line, because further arguments are taken as strings to expand (just like
2838 &%-be%&).
2839
2840 .vitem &%-bF%&&~<&'filename'&>
2841 .oindex "&%-bF%&"
2842 .cindex "system filter" "testing"
2843 .cindex "testing" "system filter"
2844 This option is the same as &%-bf%& except that it assumes that the filter being
2845 tested is a system filter. The additional commands that are available only in
2846 system filters are recognized.
2847
2848 .vitem &%-bf%&&~<&'filename'&>
2849 .oindex "&%-bf%&"
2850 .cindex "filter" "testing"
2851 .cindex "testing" "filter file"
2852 .cindex "forward file" "testing"
2853 .cindex "testing" "forward file"
2854 .cindex "Sieve filter" "testing"
2855 This option runs Exim in user filter testing mode; the file is the filter file
2856 to be tested, and a test message must be supplied on the standard input. If
2857 there are no message-dependent tests in the filter, an empty file can be
2858 supplied.
2859
2860 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2861 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2862 filter and a user filter in the same run. For example:
2863 .code
2864 exim -bF /system/filter -bf /user/filter </test/message
2865 .endd
2866 This is helpful when the system filter adds header lines or sets filter
2867 variables that are used by the user filter.
2868
2869 If the test filter file does not begin with one of the special lines
2870 .code
2871 # Exim filter
2872 # Sieve filter
2873 .endd
2874 it is taken to be a normal &_.forward_& file, and is tested for validity under
2875 that interpretation. See sections &<<SECTitenonfilred>>& to
2876 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2877 redirection lists.
2878
2879 The result of an Exim command that uses &%-bf%&, provided no errors are
2880 detected, is a list of the actions that Exim would try to take if presented
2881 with the message for real. More details of filter testing are given in the
2882 separate document entitled &'Exim's interfaces to mail filtering'&.
2883
2884 When testing a filter file,
2885 .cindex "&""From""& line"
2886 .cindex "envelope from"
2887 .cindex "envelope sender"
2888 .oindex "&%-f%&" "for filter testing"
2889 the envelope sender can be set by the &%-f%& option,
2890 or by a &"From&~"& line at the start of the test message. Various parameters
2891 that would normally be taken from the envelope recipient address of the message
2892 can be set by means of additional command line options (see the next four
2893 options).
2894
2895 .vitem &%-bfd%&&~<&'domain'&>
2896 .oindex "&%-bfd%&"
2897 .vindex "&$qualify_domain$&"
2898 This sets the domain of the recipient address when a filter file is being
2899 tested by means of the &%-bf%& option. The default is the value of
2900 &$qualify_domain$&.
2901
2902 .vitem &%-bfl%&&~<&'local&~part'&>
2903 .oindex "&%-bfl%&"
2904 This sets the local part of the recipient address when a filter file is being
2905 tested by means of the &%-bf%& option. The default is the username of the
2906 process that calls Exim. A local part should be specified with any prefix or
2907 suffix stripped, because that is how it appears to the filter when a message is
2908 actually being delivered.
2909
2910 .vitem &%-bfp%&&~<&'prefix'&>
2911 .oindex "&%-bfp%&"
2912 .cindex affix "filter testing"
2913 This sets the prefix of the local part of the recipient address when a filter
2914 file is being tested by means of the &%-bf%& option. The default is an empty
2915 prefix.
2916
2917 .vitem &%-bfs%&&~<&'suffix'&>
2918 .oindex "&%-bfs%&"
2919 .cindex affix "filter testing"
2920 This sets the suffix of the local part of the recipient address when a filter
2921 file is being tested by means of the &%-bf%& option. The default is an empty
2922 suffix.
2923
2924 .vitem &%-bh%&&~<&'IP&~address'&>
2925 .oindex "&%-bh%&"
2926 .cindex "testing" "incoming SMTP"
2927 .cindex "SMTP" "testing incoming"
2928 .cindex "testing" "relay control"
2929 .cindex "relaying" "testing configuration"
2930 .cindex "policy control" "testing"
2931 .cindex "debugging" "&%-bh%& option"
2932 This option runs a fake SMTP session as if from the given IP address, using the
2933 standard input and output. The IP address may include a port number at the end,
2934 after a full stop. For example:
2935 .code
2936 exim -bh 10.9.8.7.1234
2937 exim -bh fe80::a00:20ff:fe86:a061.5678
2938 .endd
2939 When an IPv6 address is given, it is converted into canonical form. In the case
2940 of the second example above, the value of &$sender_host_address$& after
2941 conversion to the canonical form is
2942 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2943
2944 Comments as to what is going on are written to the standard error file. These
2945 include lines beginning with &"LOG"& for anything that would have been logged.
2946 This facility is provided for testing configuration options for incoming
2947 messages, to make sure they implement the required policy. For example, you can
2948 test your relay controls using &%-bh%&.
2949
2950 &*Warning 1*&:
2951 .cindex "RFC 1413"
2952 You can test features of the configuration that rely on ident (RFC 1413)
2953 information by using the &%-oMt%& option. However, Exim cannot actually perform
2954 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2955 connection.
2956
2957 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2958 are also skipped when testing using &%-bh%&. If you want these callouts to
2959 occur, use &%-bhc%& instead.
2960
2961 Messages supplied during the testing session are discarded, and nothing is
2962 written to any of the real log files. There may be pauses when DNS (and other)
2963 lookups are taking place, and of course these may time out. The &%-oMi%& option
2964 can be used to specify a specific IP interface and port if this is important,
2965 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2966 session were authenticated.
2967
2968 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2969 output just states whether a given recipient address from a given host is
2970 acceptable or not. See section &<<SECTcheckaccess>>&.
2971
2972 Features such as authentication and encryption, where the client input is not
2973 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2974 specialized SMTP test program such as
2975 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2976
2977 .vitem &%-bhc%&&~<&'IP&~address'&>
2978 .oindex "&%-bhc%&"
2979 This option operates in the same way as &%-bh%&, except that address
2980 verification callouts are performed if required. This includes consulting and
2981 updating the callout cache database.
2982
2983 .vitem &%-bi%&
2984 .oindex "&%-bi%&"
2985 .cindex "alias file" "building"
2986 .cindex "building alias file"
2987 .cindex "Sendmail compatibility" "&%-bi%& option"
2988 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2989 Exim does not have the concept of a single alias file, and so it cannot mimic
2990 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2991 tend to appear in various scripts such as NIS make files, so the option must be
2992 recognized.
2993
2994 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2995 configuration option is run, under the uid and gid of the caller of Exim. If
2996 the &%-oA%& option is used, its value is passed to the command as an argument.
2997 The command set by &%bi_command%& may not contain arguments. The command can
2998 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2999 if this is required. If the &%bi_command%& option is not set, calling Exim with
3000 &%-bi%& is a no-op.
3001
3002 . // Keep :help first, then the rest in alphabetical order
3003 .vitem &%-bI:help%&
3004 .oindex "&%-bI:help%&"
3005 .cindex "querying exim information"
3006 We shall provide various options starting &`-bI:`& for querying Exim for
3007 information.  The output of many of these will be intended for machine
3008 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3009 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3010 options shall cause Exim to exit after producing the requested output.
3011
3012 .vitem &%-bI:dscp%&
3013 .oindex "&%-bI:dscp%&"
3014 .cindex "DSCP" "values"
3015 This option causes Exim to emit an alphabetically sorted list of all
3016 recognised DSCP names.
3017
3018 .vitem &%-bI:sieve%&
3019 .oindex "&%-bI:sieve%&"
3020 .cindex "Sieve filter" "capabilities"
3021 This option causes Exim to emit an alphabetically sorted list of all supported
3022 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3023 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3024 &`SIEVE`& capability response line.  As the precise list may depend upon
3025 compile-time build options, which this option will adapt to, this is the only
3026 way to guarantee a correct response.
3027
3028 .vitem &%-bm%&
3029 .oindex "&%-bm%&"
3030 .cindex "local message reception"
3031 This option runs an Exim receiving process that accepts an incoming,
3032 locally-generated message on the standard input. The recipients are given as the
3033 command arguments (except when &%-t%& is also present &-- see below). Each
3034 argument can be a comma-separated list of RFC 2822 addresses. This is the
3035 default option for selecting the overall action of an Exim call; it is assumed
3036 if no other conflicting option is present.
3037
3038 If any addresses in the message are unqualified (have no domain), they are
3039 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3040 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3041 suppressing this for special cases.
3042
3043 Policy checks on the contents of local messages can be enforced by means of
3044 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3045
3046 .cindex "return code" "for &%-bm%&"
3047 The return code is zero if the message is successfully accepted. Otherwise, the
3048 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3049
3050 The format
3051 .cindex "message" "format"
3052 .cindex "format" "message"
3053 .cindex "&""From""& line"
3054 .cindex "UUCP" "&""From""& line"
3055 .cindex "Sendmail compatibility" "&""From""& line"
3056 of the message must be as defined in RFC 2822, except that, for
3057 compatibility with Sendmail and Smail, a line in one of the forms
3058 .code
3059 From sender Fri Jan  5 12:55 GMT 1997
3060 From sender Fri, 5 Jan 97 12:55:01
3061 .endd
3062 (with the weekday optional, and possibly with additional text after the date)
3063 is permitted to appear at the start of the message. There appears to be no
3064 authoritative specification of the format of this line. Exim recognizes it by
3065 matching against the regular expression defined by the &%uucp_from_pattern%&
3066 option, which can be changed if necessary.
3067
3068 .oindex "&%-f%&" "overriding &""From""& line"
3069 The specified sender is treated as if it were given as the argument to the
3070 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3071 preference to the address taken from the message. The caller of Exim must be a
3072 trusted user for the sender of a message to be set in this way.
3073
3074 .vitem &%-bmalware%&&~<&'filename'&>
3075 .oindex "&%-bmalware%&"
3076 .cindex "testing", "malware"
3077 .cindex "malware scan test"
3078 This debugging option causes Exim to scan the given file or directory
3079 (depending on the used scanner interface),
3080 using the malware scanning framework.  The option of &%av_scanner%& influences
3081 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3082 the expansion should have defaults which apply to this invocation.  ACLs are
3083 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3084 will never be populated and &%-bmalware%& will fail.
3085
3086 Exim will have changed working directory before resolving the filename, so
3087 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3088 user when it tries to open the file, rather than as the invoking user.
3089 This option requires admin privileges.
3090
3091 The &%-bmalware%& option will not be extended to be more generally useful,
3092 there are better tools for file-scanning.  This option exists to help
3093 administrators verify their Exim and AV scanner configuration.
3094
3095 .vitem &%-bnq%&
3096 .oindex "&%-bnq%&"
3097 .cindex "address qualification, suppressing"
3098 By default, Exim automatically qualifies unqualified addresses (those
3099 without domains) that appear in messages that are submitted locally (that
3100 is, not over TCP/IP). This qualification applies both to addresses in
3101 envelopes, and addresses in header lines. Sender addresses are qualified using
3102 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3103 defaults to the value of &%qualify_domain%&).
3104
3105 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3106 being used to re-submit messages that originally came from remote hosts after
3107 content scanning, you probably do not want to qualify unqualified addresses in
3108 header lines. (Such lines will be present only if you have not enabled a header
3109 syntax check in the appropriate ACL.)
3110
3111 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3112 messages that originate on the local host. When this is used, unqualified
3113 addresses in the envelope provoke errors (causing message rejection) and
3114 unqualified addresses in header lines are left alone.
3115
3116
3117 .vitem &%-bP%&
3118 .oindex "&%-bP%&"
3119 .cindex "configuration options" "extracting"
3120 .cindex "options" "configuration &-- extracting"
3121 If this option is given with no arguments, it causes the values of all Exim's
3122 main configuration options to be written to the standard output. The values
3123 of one or more specific options can be requested by giving their names as
3124 arguments, for example:
3125 .code
3126 exim -bP qualify_domain hold_domains
3127 .endd
3128 .cindex "hiding configuration option values"
3129 .cindex "configuration options" "hiding value of"
3130 .cindex "options" "hiding value of"
3131 However, any option setting that is preceded by the word &"hide"& in the
3132 configuration file is not shown in full, except to an admin user. For other
3133 users, the output is as in this example:
3134 .code
3135 mysql_servers = <value not displayable>
3136 .endd
3137 If &%config%& is given as an argument, the config is
3138 output, as it was parsed, any include file resolved, any comment removed.
3139
3140 If &%config_file%& is given as an argument, the name of the runtime
3141 configuration file is output. (&%configure_file%& works too, for
3142 backward compatibility.)
3143 If a list of configuration files was supplied, the value that is output here
3144 is the name of the file that was actually used.
3145
3146 .cindex "options" "hiding name of"
3147 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3148 name will not be output.
3149
3150 .cindex "daemon" "process id (pid)"
3151 .cindex "pid (process id)" "of daemon"
3152 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3153 directories where log files and daemon pid files are written are output,
3154 respectively. If these values are unset, log files are written in a
3155 sub-directory of the spool directory called &%log%&, and the pid file is
3156 written directly into the spool directory.
3157
3158 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3159 .code
3160 exim -bP +local_domains
3161 .endd
3162 it searches for a matching named list of any type (domain, host, address, or
3163 local part) and outputs what it finds.
3164
3165 .cindex "options" "router &-- extracting"
3166 .cindex "options" "transport &-- extracting"
3167 .cindex "options" "authenticator &-- extracting"
3168 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3169 followed by the name of an appropriate driver instance, the option settings for
3170 that driver are output. For example:
3171 .code
3172 exim -bP transport local_delivery
3173 .endd
3174 The generic driver options are output first, followed by the driver's private
3175 options. A list of the names of drivers of a particular type can be obtained by
3176 using one of the words &%router_list%&, &%transport_list%&, or
3177 &%authenticator_list%&, and a complete list of all drivers with their option
3178 settings can be obtained by using &%routers%&, &%transports%&, or
3179 &%authenticators%&.
3180
3181 .cindex "environment"
3182 If &%environment%& is given as an argument, the set of environment
3183 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3184 variables.
3185
3186 .cindex "options" "macro &-- extracting"
3187 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3188 are available, similarly to the drivers.  Because macros are sometimes used
3189 for storing passwords, this option is restricted.
3190 The output format is one item per line.
3191 For the "-bP macro <name>" form, if no such macro is found
3192 the exit status will be nonzero.
3193
3194 .vitem &%-bp%&
3195 .oindex "&%-bp%&"
3196 .cindex "queue" "listing messages in"
3197 .cindex "listing" "messages in the queue"
3198 This option requests a listing of the contents of the mail queue on the
3199 standard output. If the &%-bp%& option is followed by a list of message ids,
3200 just those messages are listed. By default, this option can be used only by an
3201 admin user. However, the &%queue_list_requires_admin%& option can be set false
3202 to allow any user to see the queue.
3203
3204 Each message in the queue is displayed as in the following example:
3205 .code
3206 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3207           red.king@looking-glass.fict.example
3208           <other addresses>
3209 .endd
3210 .cindex "message" "size in queue listing"
3211 .cindex "size" "of message"
3212 The first line contains the length of time the message has been in the queue
3213 (in this case 25 minutes), the size of the message (2.9K), the unique local
3214 identifier for the message, and the message sender, as contained in the
3215 envelope. For bounce messages, the sender address is empty, and appears as
3216 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3217 the default sender address, the user's login name is shown in parentheses
3218 before the sender address.
3219
3220 .cindex "frozen messages" "in queue listing"
3221 If the message is frozen (attempts to deliver it are suspended) then the text
3222 &"*** frozen ***"& is displayed at the end of this line.
3223
3224 The recipients of the message (taken from the envelope, not the headers) are
3225 displayed on subsequent lines. Those addresses to which the message has already
3226 been delivered are marked with the letter D. If an original address gets
3227 expanded into several addresses via an alias or forward file, the original is
3228 displayed with a D only when deliveries for all of its child addresses are
3229 complete.
3230
3231
3232 .vitem &%-bpa%&
3233 .oindex "&%-bpa%&"
3234 This option operates like &%-bp%&, but in addition it shows delivered addresses
3235 that were generated from the original top level address(es) in each message by
3236 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3237 of just &"D"&.
3238
3239
3240 .vitem &%-bpc%&
3241 .oindex "&%-bpc%&"
3242 .cindex "queue" "count of messages on"
3243 This option counts the number of messages in the queue, and writes the total
3244 to the standard output. It is restricted to admin users, unless
3245 &%queue_list_requires_admin%& is set false.
3246
3247
3248 .vitem &%-bpr%&
3249 .oindex "&%-bpr%&"
3250 This option operates like &%-bp%&, but the output is not sorted into
3251 chronological order of message arrival. This can speed it up when there are
3252 lots of messages in the queue, and is particularly useful if the output is
3253 going to be post-processed in a way that doesn't need the sorting.
3254
3255 .vitem &%-bpra%&
3256 .oindex "&%-bpra%&"
3257 This option is a combination of &%-bpr%& and &%-bpa%&.
3258
3259 .vitem &%-bpru%&
3260 .oindex "&%-bpru%&"
3261 This option is a combination of &%-bpr%& and &%-bpu%&.
3262
3263
3264 .vitem &%-bpu%&
3265 .oindex "&%-bpu%&"
3266 This option operates like &%-bp%& but shows only undelivered top-level
3267 addresses for each message displayed. Addresses generated by aliasing or
3268 forwarding are not shown, unless the message was deferred after processing by a
3269 router with the &%one_time%& option set.
3270
3271
3272 .vitem &%-brt%&
3273 .oindex "&%-brt%&"
3274 .cindex "testing" "retry configuration"
3275 .cindex "retry" "configuration testing"
3276 This option is for testing retry rules, and it must be followed by up to three
3277 arguments. It causes Exim to look for a retry rule that matches the values
3278 and to write it to the standard output. For example:
3279 .code
3280 exim -brt bach.comp.mus.example
3281 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3282 .endd
3283 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3284 argument, which is required, can be a complete address in the form
3285 &'local_part@domain'&, or it can be just a domain name. If the second argument
3286 contains a dot, it is interpreted as an optional second domain name; if no
3287 retry rule is found for the first argument, the second is tried. This ties in
3288 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3289 rule is found that matches the host, one that matches the mail domain is
3290 sought. Finally, an argument that is the name of a specific delivery error, as
3291 used in setting up retry rules, can be given. For example:
3292 .code
3293 exim -brt haydn.comp.mus.example quota_3d
3294 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3295 .endd
3296
3297 .vitem &%-brw%&
3298 .oindex "&%-brw%&"
3299 .cindex "testing" "rewriting"
3300 .cindex "rewriting" "testing"
3301 This option is for testing address rewriting rules, and it must be followed by
3302 a single argument, consisting of either a local part without a domain, or a
3303 complete address with a fully qualified domain. Exim outputs how this address
3304 would be rewritten for each possible place it might appear. See chapter
3305 &<<CHAPrewrite>>& for further details.
3306
3307 .vitem &%-bS%&
3308 .oindex "&%-bS%&"
3309 .cindex "SMTP" "batched incoming"
3310 .cindex "batched SMTP input"
3311 This option is used for batched SMTP input, which is an alternative interface
3312 for non-interactive local message submission. A number of messages can be
3313 submitted in a single run. However, despite its name, this is not really SMTP
3314 input. Exim reads each message's envelope from SMTP commands on the standard
3315 input, but generates no responses. If the caller is trusted, or
3316 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3317 believed; otherwise the sender is always the caller of Exim.
3318
3319 The message itself is read from the standard input, in SMTP format (leading
3320 dots doubled), terminated by a line containing just a single dot. An error is
3321 provoked if the terminating dot is missing. A further message may then follow.
3322
3323 As for other local message submissions, the contents of incoming batch SMTP
3324 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3325 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3326 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3327
3328 Some other SMTP commands are recognized in the input. HELO and EHLO act
3329 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3330 QUIT quits, ignoring the rest of the standard input.
3331
3332 .cindex "return code" "for &%-bS%&"
3333 If any error is encountered, reports are written to the standard output and
3334 error streams, and Exim gives up immediately. The return code is 0 if no error
3335 was detected; it is 1 if one or more messages were accepted before the error
3336 was detected; otherwise it is 2.
3337
3338 More details of input using batched SMTP are given in section
3339 &<<SECTincomingbatchedSMTP>>&.
3340
3341 .vitem &%-bs%&
3342 .oindex "&%-bs%&"
3343 .cindex "SMTP" "local input"
3344 .cindex "local SMTP input"
3345 This option causes Exim to accept one or more messages by reading SMTP commands
3346 on the standard input, and producing SMTP replies on the standard output. SMTP
3347 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3348 Some user agents use this interface as a way of passing locally-generated
3349 messages to the MTA.
3350
3351 In
3352 .cindex "sender" "source of"
3353 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3354 set, the senders of messages are taken from the SMTP MAIL commands.
3355 Otherwise the content of these commands is ignored and the sender is set up as
3356 the calling user. Unqualified addresses are automatically qualified using
3357 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3358 &%-bnq%& option is used.
3359
3360 .cindex "inetd"
3361 The
3362 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3363 using a listening daemon. Exim can distinguish the two cases by checking
3364 whether the standard input is a TCP/IP socket. When Exim is called from
3365 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3366 above concerning senders and qualification do not apply. In this situation,
3367 Exim behaves in exactly the same way as it does when receiving a message via
3368 the listening daemon.
3369
3370 .vitem &%-bt%&
3371 .oindex "&%-bt%&"
3372 .cindex "testing" "addresses"
3373 .cindex "address" "testing"
3374 This option runs Exim in address testing mode, in which each argument is taken
3375 as a recipient address to be tested for deliverability. The results are
3376 written to the standard output. If a test fails, and the caller is not an admin
3377 user, no details of the failure are output, because these might contain
3378 sensitive information such as usernames and passwords for database lookups.
3379
3380 If no arguments are given, Exim runs in an interactive manner, prompting with a
3381 right angle bracket for addresses to be tested.
3382
3383 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3384 &[readline()]& function, because it is running as &'root'& and there are
3385 security issues.
3386
3387 Each address is handled as if it were the recipient address of a message
3388 (compare the &%-bv%& option). It is passed to the routers and the result is
3389 written to the standard output. However, any router that has
3390 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3391 genuine routing tests if your first router passes everything to a scanner
3392 program.
3393
3394 .cindex "return code" "for &%-bt%&"
3395 The return code is 2 if any address failed outright; it is 1 if no address
3396 failed outright but at least one could not be resolved for some reason. Return
3397 code 0 is given only when all addresses succeed.
3398
3399 .cindex "duplicate addresses"
3400 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3401 addresses after routing is complete, so that only one delivery takes place.
3402 This does not happen when testing with &%-bt%&; the full results of routing are
3403 always shown.
3404
3405 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3406 routers in the configuration makes any tests on the sender address of a
3407 message,
3408 .oindex "&%-f%&" "for address testing"
3409 you can use the &%-f%& option to set an appropriate sender when running
3410 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3411 default qualifying domain. However, if you have set up (for example) routers
3412 whose behaviour depends on the contents of an incoming message, you cannot test
3413 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3414 doing such tests.
3415
3416 .vitem &%-bV%&
3417 .oindex "&%-bV%&"
3418 .cindex "version number of Exim"
3419 This option causes Exim to write the current version number, compilation
3420 number, and compilation date of the &'exim'& binary to the standard output.
3421 It also lists the DBM library that is being used, the optional modules (such as
3422 specific lookup types), the drivers that are included in the binary, and the
3423 name of the runtime configuration file that is in use.
3424
3425 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3426 configuration file. However, this is a static check only. It cannot check
3427 values that are to be expanded. For example, although a misspelt ACL verb is
3428 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3429 alone to discover (for example) all the typos in the configuration; some
3430 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3431 dynamic testing facilities.
3432
3433 .vitem &%-bv%&
3434 .oindex "&%-bv%&"
3435 .cindex "verifying address" "using &%-bv%&"
3436 .cindex "address" "verification"
3437 This option runs Exim in address verification mode, in which each argument is
3438 taken as a recipient address to be verified by the routers. (This does
3439 not involve any verification callouts). During normal operation, verification
3440 happens mostly as a consequence processing a &%verify%& condition in an ACL
3441 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3442 including callouts, see the &%-bh%& and &%-bhc%& options.
3443
3444 If verification fails, and the caller is not an admin user, no details of the
3445 failure are output, because these might contain sensitive information such as
3446 usernames and passwords for database lookups.
3447
3448 If no arguments are given, Exim runs in an interactive manner, prompting with a
3449 right angle bracket for addresses to be verified.
3450
3451 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3452 &[readline()]& function, because it is running as &'exim'& and there are
3453 security issues.
3454
3455 Verification differs from address testing (the &%-bt%& option) in that routers
3456 that have &%no_verify%& set are skipped, and if the address is accepted by a
3457 router that has &%fail_verify%& set, verification fails. The address is
3458 verified as a recipient if &%-bv%& is used; to test verification for a sender
3459 address, &%-bvs%& should be used.
3460
3461 If the &%-v%& option is not set, the output consists of a single line for each
3462 address, stating whether it was verified or not, and giving a reason in the
3463 latter case. Without &%-v%&, generating more than one address by redirection
3464 causes verification to end successfully, without considering the generated
3465 addresses. However, if just one address is generated, processing continues,
3466 and the generated address must verify successfully for the overall verification
3467 to succeed.
3468
3469 When &%-v%& is set, more details are given of how the address has been handled,
3470 and in the case of address redirection, all the generated addresses are also
3471 considered. Verification may succeed for some and fail for others.
3472
3473 The
3474 .cindex "return code" "for &%-bv%&"
3475 return code is 2 if any address failed outright; it is 1 if no address
3476 failed outright but at least one could not be resolved for some reason. Return
3477 code 0 is given only when all addresses succeed.
3478
3479 If any of the routers in the configuration makes any tests on the sender
3480 address of a message, you should use the &%-f%& option to set an appropriate
3481 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3482 calling user at the default qualifying domain.
3483
3484 .vitem &%-bvs%&
3485 .oindex "&%-bvs%&"
3486 This option acts like &%-bv%&, but verifies the address as a sender rather
3487 than a recipient address. This affects any rewriting and qualification that
3488 might happen.
3489
3490 .vitem &%-bw%&
3491 .oindex "&%-bw%&"
3492 .cindex "daemon"
3493 .cindex "inetd"
3494 .cindex "inetd" "wait mode"
3495 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3496 similarly to the &%-bd%& option.  All port specifications on the command-line
3497 and in the configuration file are ignored.  Queue-running may not be specified.
3498
3499 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3500 listening for connections.  This permits the system to start up and have
3501 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3502 each port only when the first connection is received.
3503
3504 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3505 which the daemon will exit, which should cause inetd to listen once more.
3506
3507 .vitem &%-C%&&~<&'filelist'&>
3508 .oindex "&%-C%&"
3509 .cindex "configuration file" "alternate"
3510 .cindex "CONFIGURE_FILE"
3511 .cindex "alternate configuration file"
3512 This option causes Exim to find the runtime configuration file from the given
3513 list instead of from the list specified by the CONFIGURE_FILE
3514 compile-time setting. Usually, the list will consist of just a single filename,
3515 but it can be a colon-separated list of names. In this case, the first
3516 file that exists is used. Failure to open an existing file stops Exim from
3517 proceeding any further along the list, and an error is generated.
3518
3519 When this option is used by a caller other than root, and the list is different
3520 from the compiled-in list, Exim gives up its root privilege immediately, and
3521 runs with the real and effective uid and gid set to those of the caller.
3522 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3523 file contains a list of full pathnames, one per line, for configuration files
3524 which are trusted. Root privilege is retained for any configuration file so
3525 listed, as long as the caller is the Exim user (or the user specified in the
3526 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3527 not writeable by inappropriate users or groups.
3528
3529 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3530 configuration using &%-C%& right through message reception and delivery,
3531 even if the caller is root. The reception works, but by that time, Exim is
3532 running as the Exim user, so when it re-executes to regain privilege for the
3533 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3534 test reception and delivery using two separate commands (one to put a message
3535 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3536
3537 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3538 prefix string with which any file named in a &%-C%& command line option
3539 must start. In addition, the filename must not contain the sequence &`/../`&.
3540 However, if the value of the &%-C%& option is identical to the value of
3541 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3542 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3543 unset, any filename can be used with &%-C%&.
3544
3545 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3546 to a directory to which only root has access. This prevents someone who has
3547 broken into the Exim account from running a privileged Exim with an arbitrary
3548 configuration file.
3549
3550 The &%-C%& facility is useful for ensuring that configuration files are
3551 syntactically correct, but cannot be used for test deliveries, unless the
3552 caller is privileged, or unless it is an exotic configuration that does not
3553 require privilege. No check is made on the owner or group of the files
3554 specified by this option.
3555
3556
3557 .vitem &%-D%&<&'macro'&>=<&'value'&>
3558 .oindex "&%-D%&"
3559 .cindex "macro" "setting on command line"
3560 This option can be used to override macro definitions in the configuration file
3561 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3562 unprivileged caller, it causes Exim to give up its root privilege.
3563 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3564 completely disabled, and its use causes an immediate error exit.
3565
3566 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3567 colon-separated list of macros which are considered safe and, if &%-D%& only
3568 supplies macros from this list, and the values are acceptable, then Exim will
3569 not give up root privilege if the caller is root, the Exim run-time user, or
3570 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3571 to be removed in the future.  Acceptable values for the macros satisfy the
3572 regexp: &`^[A-Za-z0-9_/.-]*$`&
3573
3574 The entire option (including equals sign if present) must all be within one
3575 command line item. &%-D%& can be used to set the value of a macro to the empty
3576 string, in which case the equals sign is optional. These two commands are
3577 synonymous:
3578 .code
3579 exim -DABC  ...
3580 exim -DABC= ...
3581 .endd
3582 To include spaces in a macro definition item, quotes must be used. If you use
3583 quotes, spaces are permitted around the macro name and the equals sign. For
3584 example:
3585 .code
3586 exim '-D ABC = something' ...
3587 .endd
3588 &%-D%& may be repeated up to 10 times on a command line.
3589 Only macro names up to 22 letters long can be set.
3590
3591
3592 .vitem &%-d%&<&'debug&~options'&>
3593 .oindex "&%-d%&"
3594 .cindex "debugging" "list of selectors"
3595 .cindex "debugging" "&%-d%& option"
3596 This option causes debugging information to be written to the standard
3597 error stream. It is restricted to admin users because debugging output may show
3598 database queries that contain password information. Also, the details of users'
3599 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3600 writes an error message to the standard error stream and exits with a non-zero
3601 return code.
3602
3603 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3604 standard debugging data is output. This can be reduced, or increased to include
3605 some more rarely needed information, by directly following &%-d%& with a string
3606 made up of names preceded by plus or minus characters. These add or remove sets
3607 of debugging data, respectively. For example, &%-d+filter%& adds filter
3608 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3609 no spaces are allowed in the debug setting. The available debugging categories
3610 are:
3611 .display
3612 &`acl            `& ACL interpretation
3613 &`auth           `& authenticators
3614 &`deliver        `& general delivery logic
3615 &`dns            `& DNS lookups (see also resolver)
3616 &`dnsbl          `& DNS black list (aka RBL) code
3617 &`exec           `& arguments for &[execv()]& calls
3618 &`expand         `& detailed debugging for string expansions
3619 &`filter         `& filter handling
3620 &`hints_lookup   `& hints data lookups
3621 &`host_lookup    `& all types of name-to-IP address handling
3622 &`ident          `& ident lookup
3623 &`interface      `& lists of local interfaces
3624 &`lists          `& matching things in lists
3625 &`load           `& system load checks
3626 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3627                     &<<CHAPlocalscan>>&)
3628 &`lookup         `& general lookup code and all lookups
3629 &`memory         `& memory handling
3630 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3631 &`pid            `& modifier: add pid to debug output lines
3632 &`process_info   `& setting info for the process log
3633 &`queue_run      `& queue runs
3634 &`receive        `& general message reception logic
3635 &`resolver       `& turn on the DNS resolver's debugging output
3636 &`retry          `& retry handling
3637 &`rewrite        `& address rewriting
3638 &`route          `& address routing
3639 &`timestamp      `& modifier: add timestamp to debug output lines
3640 &`tls            `& TLS logic
3641 &`transport      `& transports
3642 &`uid            `& changes of uid/gid and looking up uid/gid
3643 &`verify         `& address verification logic
3644 &`all            `& almost all of the above (see below), and also &%-v%&
3645 .endd
3646 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3647 for &`-all`&. The reason for this is that &`+all`& is something that people
3648 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3649 is included, an awful lot of output that is very rarely of interest is
3650 generated, so it now has to be explicitly requested. However, &`-all`& does
3651 turn everything off.
3652
3653 .cindex "resolver, debugging output"
3654 .cindex "DNS resolver, debugging output"
3655 The &`resolver`& option produces output only if the DNS resolver was compiled
3656 with DEBUG enabled. This is not the case in some operating systems. Also,
3657 unfortunately, debugging output from the DNS resolver is written to stdout
3658 rather than stderr.
3659
3660 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3661 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3662 However, the &`pid`& selector is forced when debugging is turned on for a
3663 daemon, which then passes it on to any re-executed Exims. Exim also
3664 automatically adds the pid to debug lines when several remote deliveries are
3665 run in parallel.
3666
3667 The &`timestamp`& selector causes the current time to be inserted at the start
3668 of all debug output lines. This can be useful when trying to track down delays
3669 in processing.
3670
3671 .cindex debugging "UTF-8 in"
3672 .cindex UTF-8 "in debug output"
3673 The &`noutf8`& selector disables the use of
3674 UTF-8 line-drawing characters to group related information.
3675 When disabled. ascii-art is used instead.
3676 Using the &`+all`& option does not set this modifier,
3677
3678 If the &%debug_print%& option is set in any driver, it produces output whenever
3679 any debugging is selected, or if &%-v%& is used.
3680
3681 .vitem &%-dd%&<&'debug&~options'&>
3682 .oindex "&%-dd%&"
3683 This option behaves exactly like &%-d%& except when used on a command that
3684 starts a daemon process. In that case, debugging is turned off for the
3685 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3686 behaviour of the daemon without creating as much output as full debugging does.
3687
3688 .vitem &%-dropcr%&
3689 .oindex "&%-dropcr%&"
3690 This is an obsolete option that is now a no-op. It used to affect the way Exim
3691 handled CR and LF characters in incoming messages. What happens now is
3692 described in section &<<SECTlineendings>>&.
3693
3694 .vitem &%-E%&
3695 .oindex "&%-E%&"
3696 .cindex "bounce message" "generating"
3697 This option specifies that an incoming message is a locally-generated delivery
3698 failure report. It is used internally by Exim when handling delivery failures
3699 and is not intended for external use. Its only effect is to stop Exim
3700 generating certain messages to the postmaster, as otherwise message cascades
3701 could occur in some situations. As part of the same option, a message id may
3702 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3703 new message contains the id, following &"R="&, as a cross-reference.
3704
3705 .vitem &%-e%&&'x'&
3706 .oindex "&%-e%&&'x'&"
3707 There are a number of Sendmail options starting with &%-oe%& which seem to be
3708 called by various programs without the leading &%o%& in the option. For
3709 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3710 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3711
3712 .vitem &%-F%&&~<&'string'&>
3713 .oindex "&%-F%&"
3714 .cindex "sender" "name"
3715 .cindex "name" "of sender"
3716 This option sets the sender's full name for use when a locally-generated
3717 message is being accepted. In the absence of this option, the user's &'gecos'&
3718 entry from the password data is used. As users are generally permitted to alter
3719 their &'gecos'& entries, no security considerations are involved. White space
3720 between &%-F%& and the <&'string'&> is optional.
3721
3722 .vitem &%-f%&&~<&'address'&>
3723 .oindex "&%-f%&"
3724 .cindex "sender" "address"
3725 .cindex "address" "sender"
3726 .cindex "trusted users"
3727 .cindex "envelope from"
3728 .cindex "envelope sender"
3729 .cindex "user" "trusted"
3730 This option sets the address of the envelope sender of a locally-generated
3731 message (also known as the return path). The option can normally be used only
3732 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3733 users to use it.
3734
3735 Processes running as root or the Exim user are always trusted. Other
3736 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3737 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3738 of a local message is set to the caller's login name at the default qualify
3739 domain.
3740
3741 There is one exception to the restriction on the use of &%-f%&: an empty sender
3742 can be specified by any user, trusted or not, to create a message that can
3743 never provoke a bounce. An empty sender can be specified either as an empty
3744 string, or as a pair of angle brackets with nothing between them, as in these
3745 examples of shell commands:
3746 .code
3747 exim -f '<>' user@domain
3748 exim -f "" user@domain
3749 .endd
3750 In addition, the use of &%-f%& is not restricted when testing a filter file
3751 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3752 &%-bv%& options.
3753
3754 Allowing untrusted users to change the sender address does not of itself make
3755 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3756 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3757 though this can be overridden by setting &%no_local_from_check%&.
3758
3759 White
3760 .cindex "&""From""& line"
3761 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3762 given as two arguments or one combined argument). The sender of a
3763 locally-generated message can also be set (when permitted) by an initial
3764 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3765 if &%-f%& is also present, it overrides &"From&~"&.
3766
3767 .vitem &%-G%&
3768 .oindex "&%-G%&"
3769 .cindex "submission fixups, suppressing (command-line)"
3770 This option is equivalent to an ACL applying:
3771 .code
3772 control = suppress_local_fixups
3773 .endd
3774 for every message received.  Note that Sendmail will complain about such
3775 bad formatting, where Exim silently just does not fix it up.  This may change
3776 in future.
3777
3778 As this affects audit information, the caller must be a trusted user to use
3779 this option.
3780
3781 .vitem &%-h%&&~<&'number'&>
3782 .oindex "&%-h%&"
3783 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3784 This option is accepted for compatibility with Sendmail, but has no effect. (In
3785 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3786 headers.)
3787
3788 .vitem &%-i%&
3789 .oindex "&%-i%&"
3790 .cindex "Solaris" "&'mail'& command"
3791 .cindex "dot" "in incoming non-SMTP message"
3792 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3793 line by itself should not terminate an incoming, non-SMTP message. I can find
3794 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3795 command in Solaris 2.4 uses it. See also &%-ti%&.
3796
3797 .vitem &%-L%&&~<&'tag'&>
3798 .oindex "&%-L%&"
3799 .cindex "syslog" "process name; set with flag"
3800 This option is equivalent to setting &%syslog_processname%& in the config
3801 file and setting &%log_file_path%& to &`syslog`&.
3802 Its use is restricted to administrators.  The configuration file has to be
3803 read and parsed, to determine access rights, before this is set and takes
3804 effect, so early configuration file errors will not honour this flag.
3805
3806 The tag should not be longer than 32 characters.
3807
3808 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3809 .oindex "&%-M%&"
3810 .cindex "forcing delivery"
3811 .cindex "delivery" "forcing attempt"
3812 .cindex "frozen messages" "forcing delivery"
3813 This option requests Exim to run a delivery attempt on each message in turn. If
3814 any of the messages are frozen, they are automatically thawed before the
3815 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3816 and &%hold_domains%& are ignored.
3817
3818 Retry
3819 .cindex "hints database" "overriding retry hints"
3820 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3821 the normal retry time has not yet been reached. This option requires the caller
3822 to be an admin user. However, there is an option called &%prod_requires_admin%&
3823 which can be set false to relax this restriction (and also the same requirement
3824 for the &%-q%&, &%-R%&, and &%-S%& options).
3825
3826 The deliveries happen synchronously, that is, the original Exim process does
3827 not terminate until all the delivery attempts have finished. No output is
3828 produced unless there is a serious error. If you want to see what is happening,
3829 use the &%-v%& option as well, or inspect Exim's main log.
3830
3831 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3832 .oindex "&%-Mar%&"
3833 .cindex "message" "adding recipients"
3834 .cindex "recipient" "adding"
3835 This option requests Exim to add the addresses to the list of recipients of the
3836 message (&"ar"& for &"add recipients"&). The first argument must be a message
3837 id, and the remaining ones must be email addresses. However, if the message is
3838 active (in the middle of a delivery attempt), it is not altered. This option
3839 can be used only by an admin user.
3840
3841 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3842         &~<&'message&~id'&>"
3843 .oindex "&%-MC%&"
3844 .cindex "SMTP" "passed connection"
3845 .cindex "SMTP" "multiple deliveries"
3846 .cindex "multiple SMTP deliveries"
3847 This option is not intended for use by external callers. It is used internally
3848 by Exim to invoke another instance of itself to deliver a waiting message using
3849 an existing SMTP connection, which is passed as the standard input. Details are
3850 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3851 must be root or the Exim user in order to use it.
3852
3853 .vitem &%-MCA%&
3854 .oindex "&%-MCA%&"
3855 This option is not intended for use by external callers. It is used internally
3856 by Exim in conjunction with the &%-MC%& option. It signifies that the
3857 connection to the remote host has been authenticated.
3858
3859 .vitem &%-MCD%&
3860 .oindex "&%-MCD%&"
3861 This option is not intended for use by external callers. It is used internally
3862 by Exim in conjunction with the &%-MC%& option. It signifies that the
3863 remote host supports the ESMTP &_DSN_& extension.
3864
3865 .vitem &%-MCG%&&~<&'queue&~name'&>
3866 .oindex "&%-MCG%&"
3867 This option is not intended for use by external callers. It is used internally
3868 by Exim in conjunction with the &%-MC%& option. It signifies that an
3869 alternate queue is used, named by the following argument.
3870
3871 .vitem &%-MCK%&
3872 .oindex "&%-MCK%&"
3873 This option is not intended for use by external callers. It is used internally
3874 by Exim in conjunction with the &%-MC%& option. It signifies that a
3875 remote host supports the ESMTP &_CHUNKING_& extension.
3876
3877 .vitem &%-MCP%&
3878 .oindex "&%-MCP%&"
3879 This option is not intended for use by external callers. It is used internally
3880 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3881 which Exim is connected supports pipelining.
3882
3883 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3884 .oindex "&%-MCQ%&"
3885 This option is not intended for use by external callers. It is used internally
3886 by Exim in conjunction with the &%-MC%& option when the original delivery was
3887 started by a queue runner. It passes on the process id of the queue runner,
3888 together with the file descriptor number of an open pipe. Closure of the pipe
3889 signals the final completion of the sequence of processes that are passing
3890 messages through the same SMTP connection.
3891
3892 .vitem &%-MCS%&
3893 .oindex "&%-MCS%&"
3894 This option is not intended for use by external callers. It is used internally
3895 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3896 SMTP SIZE option should be used on messages delivered down the existing
3897 connection.
3898
3899 .vitem &%-MCT%&
3900 .oindex "&%-MCT%&"
3901 This option is not intended for use by external callers. It is used internally
3902 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3903 host to which Exim is connected supports TLS encryption.
3904
3905 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3906 .oindex "&%-MCt%&"
3907 This option is not intended for use by external callers. It is used internally
3908 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3909 connection is being proxied by a parent process for handling TLS encryption.
3910 The arguments give the local address and port being proxied, and the TLS cipher.
3911
3912 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3913 .oindex "&%-Mc%&"
3914 .cindex "hints database" "not overridden by &%-Mc%&"
3915 .cindex "delivery" "manually started &-- not forced"
3916 This option requests Exim to run a delivery attempt on each message, in turn,
3917 but unlike the &%-M%& option, it does check for retry hints, and respects any
3918 that are found. This option is not very useful to external callers. It is
3919 provided mainly for internal use by Exim when it needs to re-invoke itself in
3920 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3921 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3922 respects retry times and other options such as &%hold_domains%& that are
3923 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3924 If you want to run a specific delivery as if in a queue run, you should use
3925 &%-q%& with a message id argument. A distinction between queue run deliveries
3926 and other deliveries is made in one or two places.
3927
3928 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3929 .oindex "&%-Mes%&"
3930 .cindex "message" "changing sender"
3931 .cindex "sender" "changing"
3932 This option requests Exim to change the sender address in the message to the
3933 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3934 &"edit sender"&). There must be exactly two arguments. The first argument must
3935 be a message id, and the second one an email address. However, if the message
3936 is active (in the middle of a delivery attempt), its status is not altered.
3937 This option can be used only by an admin user.
3938
3939 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3940 .oindex "&%-Mf%&"
3941 .cindex "freezing messages"
3942 .cindex "message" "manually freezing"
3943 This option requests Exim to mark each listed message as &"frozen"&. This
3944 prevents any delivery attempts taking place until the message is &"thawed"&,
3945 either manually or as a result of the &%auto_thaw%& configuration option.
3946 However, if any of the messages are active (in the middle of a delivery
3947 attempt), their status is not altered. This option can be used only by an admin
3948 user.
3949
3950 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3951 .oindex "&%-Mg%&"
3952 .cindex "giving up on messages"
3953 .cindex "message" "abandoning delivery attempts"
3954 .cindex "delivery" "abandoning further attempts"
3955 This option requests Exim to give up trying to deliver the listed messages,
3956 including any that are frozen. However, if any of the messages are active,
3957 their status is not altered. For non-bounce messages, a delivery error message
3958 is sent to the sender, containing the text &"cancelled by administrator"&.
3959 Bounce messages are just discarded. This option can be used only by an admin
3960 user.
3961
3962 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3963 .oindex "&%-Mmad%&"
3964 .cindex "delivery" "cancelling all"
3965 This option requests Exim to mark all the recipient addresses in the messages
3966 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3967 message is active (in the middle of a delivery attempt), its status is not
3968 altered. This option can be used only by an admin user.
3969
3970 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3971 .oindex "&%-Mmd%&"
3972 .cindex "delivery" "cancelling by address"
3973 .cindex "recipient" "removing"
3974 .cindex "removing recipients"
3975 This option requests Exim to mark the given addresses as already delivered
3976 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3977 the remaining ones must be email addresses. These are matched to recipient
3978 addresses in the message in a case-sensitive manner. If the message is active
3979 (in the middle of a delivery attempt), its status is not altered. This option
3980 can be used only by an admin user.
3981
3982 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3983 .oindex "&%-Mrm%&"
3984 .cindex "removing messages"
3985 .cindex "abandoning mail"
3986 .cindex "message" "manually discarding"
3987 This option requests Exim to remove the given messages from the queue. No
3988 bounce messages are sent; each message is simply forgotten. However, if any of
3989 the messages are active, their status is not altered. This option can be used
3990 only by an admin user or by the user who originally caused the message to be
3991 placed in the queue.
3992
3993 . .new
3994 . .vitem &%-MS%&
3995 . .oindex "&%-MS%&"
3996 . .cindex REQUIRETLS
3997 . This option is used to request REQUIRETLS processing on the message.
3998 . It is used internally by Exim in conjunction with -E when generating
3999 . a bounce message.
4000 . .wen
4001
4002 .vitem &%-Mset%&&~<&'message&~id'&>
4003 .oindex "&%-Mset%&"
4004 .cindex "testing" "string expansion"
4005 .cindex "expansion" "testing"
4006 This option is useful only in conjunction with &%-be%& (that is, when testing
4007 string expansions). Exim loads the given message from its spool before doing
4008 the test expansions, thus setting message-specific variables such as
4009 &$message_size$& and the header variables. The &$recipients$& variable is made
4010 available. This feature is provided to make it easier to test expansions that
4011 make use of these variables. However, this option can be used only by an admin
4012 user. See also &%-bem%&.
4013
4014 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4015 .oindex "&%-Mt%&"
4016 .cindex "thawing messages"
4017 .cindex "unfreezing messages"
4018 .cindex "frozen messages" "thawing"
4019 .cindex "message" "thawing frozen"
4020 This option requests Exim to &"thaw"& any of the listed messages that are
4021 &"frozen"&, so that delivery attempts can resume. However, if any of the
4022 messages are active, their status is not altered. This option can be used only
4023 by an admin user.
4024
4025 .vitem &%-Mvb%&&~<&'message&~id'&>
4026 .oindex "&%-Mvb%&"
4027 .cindex "listing" "message body"
4028 .cindex "message" "listing body of"
4029 This option causes the contents of the message body (-D) spool file to be
4030 written to the standard output. This option can be used only by an admin user.
4031
4032 .vitem &%-Mvc%&&~<&'message&~id'&>
4033 .oindex "&%-Mvc%&"
4034 .cindex "message" "listing in RFC 2822 format"
4035 .cindex "listing" "message in RFC 2822 format"
4036 This option causes a copy of the complete message (header lines plus body) to
4037 be written to the standard output in RFC 2822 format. This option can be used
4038 only by an admin user.
4039
4040 .vitem &%-Mvh%&&~<&'message&~id'&>
4041 .oindex "&%-Mvh%&"
4042 .cindex "listing" "message headers"
4043 .cindex "header lines" "listing"
4044 .cindex "message" "listing header lines"
4045 This option causes the contents of the message headers (-H) spool file to be
4046 written to the standard output. This option can be used only by an admin user.
4047
4048 .vitem &%-Mvl%&&~<&'message&~id'&>
4049 .oindex "&%-Mvl%&"
4050 .cindex "listing" "message log"
4051 .cindex "message" "listing message log"
4052 This option causes the contents of the message log spool file to be written to
4053 the standard output. This option can be used only by an admin user.
4054
4055 .vitem &%-m%&
4056 .oindex "&%-m%&"
4057 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4058 treats it that way too.
4059
4060 .vitem &%-N%&
4061 .oindex "&%-N%&"
4062 .cindex "debugging" "&%-N%& option"
4063 .cindex "debugging" "suppressing delivery"
4064 This is a debugging option that inhibits delivery of a message at the transport
4065 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4066 it just doesn't actually transport the message, but instead behaves as if it
4067 had successfully done so. However, it does not make any updates to the retry
4068 database, and the log entries for deliveries are flagged with &"*>"& rather
4069 than &"=>"&.
4070
4071 Because &%-N%& discards any message to which it applies, only root or the Exim
4072 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4073 words, an ordinary user can use it only when supplying an incoming message to
4074 which it will apply. Although transportation never fails when &%-N%& is set, an
4075 address may be deferred because of a configuration problem on a transport, or a
4076 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4077 the message, and applies to any subsequent delivery attempts that may happen
4078 for that message.
4079
4080 .vitem &%-n%&
4081 .oindex "&%-n%&"
4082 This option is interpreted by Sendmail to mean &"no aliasing"&.
4083 For normal modes of operation, it is ignored by Exim.
4084 When combined with &%-bP%& it makes the output more terse (suppresses
4085 option names, environment values and config pretty printing).
4086
4087 .vitem &%-O%&&~<&'data'&>
4088 .oindex "&%-O%&"
4089 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4090 Exim.
4091
4092 .vitem &%-oA%&&~<&'file&~name'&>
4093 .oindex "&%-oA%&"
4094 .cindex "Sendmail compatibility" "&%-oA%& option"
4095 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4096 alternative alias filename. Exim handles &%-bi%& differently; see the
4097 description above.
4098
4099 .vitem &%-oB%&&~<&'n'&>
4100 .oindex "&%-oB%&"
4101 .cindex "SMTP" "passed connection"
4102 .cindex "SMTP" "multiple deliveries"
4103 .cindex "multiple SMTP deliveries"
4104 This is a debugging option which limits the maximum number of messages that can
4105 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4106 transport. If <&'n'&> is omitted, the limit is set to 1.
4107
4108 .vitem &%-odb%&
4109 .oindex "&%-odb%&"
4110 .cindex "background delivery"
4111 .cindex "delivery" "in the background"
4112 This option applies to all modes in which Exim accepts incoming messages,
4113 including the listening daemon. It requests &"background"& delivery of such
4114 messages, which means that the accepting process automatically starts a
4115 delivery process for each message received, but does not wait for the delivery
4116 processes to finish.
4117
4118 When all the messages have been received, the reception process exits,
4119 leaving the delivery processes to finish in their own time. The standard output
4120 and error streams are closed at the start of each delivery process.
4121 This is the default action if none of the &%-od%& options are present.
4122
4123 If one of the queueing options in the configuration file
4124 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4125 overrides it if &%queue_only_override%& is set true, which is the default
4126 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4127
4128 .vitem &%-odf%&
4129 .oindex "&%-odf%&"
4130 .cindex "foreground delivery"
4131 .cindex "delivery" "in the foreground"
4132 This option requests &"foreground"& (synchronous) delivery when Exim has
4133 accepted a locally-generated message. (For the daemon it is exactly the same as
4134 &%-odb%&.) A delivery process is automatically started to deliver the message,
4135 and Exim waits for it to complete before proceeding.
4136
4137 The original Exim reception process does not finish until the delivery
4138 process for the final message has ended. The standard error stream is left open
4139 during deliveries.
4140
4141 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4142 false and one of the queueing options in the configuration file is in effect.
4143
4144 If there is a temporary delivery error during foreground delivery, the
4145 message is left in the queue for later delivery, and the original reception
4146 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4147 restricted configuration that never queues messages.
4148
4149
4150 .vitem &%-odi%&
4151 .oindex "&%-odi%&"
4152 This option is synonymous with &%-odf%&. It is provided for compatibility with
4153 Sendmail.
4154
4155 .vitem &%-odq%&
4156 .oindex "&%-odq%&"
4157 .cindex "non-immediate delivery"
4158 .cindex "delivery" "suppressing immediate"
4159 .cindex "queueing incoming messages"
4160 This option applies to all modes in which Exim accepts incoming messages,
4161 including the listening daemon. It specifies that the accepting process should
4162 not automatically start a delivery process for each message received. Messages
4163 are placed in the queue, and remain there until a subsequent queue runner
4164 process encounters them. There are several configuration options (such as
4165 &%queue_only%&) that can be used to queue incoming messages under certain
4166 conditions. This option overrides all of them and also &%-odqs%&. It always
4167 forces queueing.
4168
4169 .vitem &%-odqs%&
4170 .oindex "&%-odqs%&"
4171 .cindex "SMTP" "delaying delivery"
4172 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4173 However, like &%-odb%& and &%-odi%&, this option has no effect if
4174 &%queue_only_override%& is false and one of the queueing options in the
4175 configuration file is in effect.
4176
4177 When &%-odqs%& does operate, a delivery process is started for each incoming
4178 message, in the background by default, but in the foreground if &%-odi%& is
4179 also present. The recipient addresses are routed, and local deliveries are done
4180 in the normal way. However, if any SMTP deliveries are required, they are not
4181 done at this time, so the message remains in the queue until a subsequent queue
4182 runner process encounters it. Because routing was done, Exim knows which
4183 messages are waiting for which hosts, and so a number of messages for the same
4184 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4185 configuration option has the same effect for specific domains. See also the
4186 &%-qq%& option.
4187
4188 .vitem &%-oee%&
4189 .oindex "&%-oee%&"
4190 .cindex "error" "reporting"
4191 If an error is detected while a non-SMTP message is being received (for
4192 example, a malformed address), the error is reported to the sender in a mail
4193 message.
4194
4195 .cindex "return code" "for &%-oee%&"
4196 Provided
4197 this error message is successfully sent, the Exim receiving process
4198 exits with a return code of zero. If not, the return code is 2 if the problem
4199 is that the original message has no recipients, or 1 for any other error.
4200 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4201
4202 .vitem &%-oem%&
4203 .oindex "&%-oem%&"
4204 .cindex "error" "reporting"
4205 .cindex "return code" "for &%-oem%&"
4206 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4207 return code, whether or not the error message was successfully sent.
4208 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4209
4210 .vitem &%-oep%&
4211 .oindex "&%-oep%&"
4212 .cindex "error" "reporting"
4213 If an error is detected while a non-SMTP message is being received, the
4214 error is reported by writing a message to the standard error file (stderr).
4215 .cindex "return code" "for &%-oep%&"
4216 The return code is 1 for all errors.
4217
4218 .vitem &%-oeq%&
4219 .oindex "&%-oeq%&"
4220 .cindex "error" "reporting"
4221 This option is supported for compatibility with Sendmail, but has the same
4222 effect as &%-oep%&.
4223
4224 .vitem &%-oew%&
4225 .oindex "&%-oew%&"
4226 .cindex "error" "reporting"
4227 This option is supported for compatibility with Sendmail, but has the same
4228 effect as &%-oem%&.
4229
4230 .vitem &%-oi%&
4231 .oindex "&%-oi%&"
4232 .cindex "dot" "in incoming non-SMTP message"
4233 This option, which has the same effect as &%-i%&, specifies that a dot on a
4234 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4235 single dot does terminate, though Exim does no special processing for other
4236 lines that start with a dot. This option is set by default if Exim is called as
4237 &'rmail'&. See also &%-ti%&.
4238
4239 .vitem &%-oitrue%&
4240 .oindex "&%-oitrue%&"
4241 This option is treated as synonymous with &%-oi%&.
4242
4243 .vitem &%-oMa%&&~<&'host&~address'&>
4244 .oindex "&%-oMa%&"
4245 .cindex "sender" "host address, specifying for local message"
4246 A number of options starting with &%-oM%& can be used to set values associated
4247 with remote hosts on locally-submitted messages (that is, messages not received
4248 over TCP/IP). These options can be used by any caller in conjunction with the
4249 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4250 other circumstances, they are ignored unless the caller is trusted.
4251
4252 The &%-oMa%& option sets the sender host address. This may include a port
4253 number at the end, after a full stop (period). For example:
4254 .code
4255 exim -bs -oMa 10.9.8.7.1234
4256 .endd
4257 An alternative syntax is to enclose the IP address in square brackets,
4258 followed by a colon and the port number:
4259 .code
4260 exim -bs -oMa [10.9.8.7]:1234
4261 .endd
4262 The IP address is placed in the &$sender_host_address$& variable, and the
4263 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4264 are present on the command line, the sender host IP address is taken from
4265 whichever one is last.
4266
4267 .vitem &%-oMaa%&&~<&'name'&>
4268 .oindex "&%-oMaa%&"
4269 .cindex "authentication" "name, specifying for local message"
4270 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4271 option sets the value of &$sender_host_authenticated$& (the authenticator
4272 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4273 This option can be used with &%-bh%& and &%-bs%& to set up an
4274 authenticated SMTP session without actually using the SMTP AUTH command.
4275
4276 .vitem &%-oMai%&&~<&'string'&>
4277 .oindex "&%-oMai%&"
4278 .cindex "authentication" "id, specifying for local message"
4279 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4280 option sets the value of &$authenticated_id$& (the id that was authenticated).
4281 This overrides the default value (the caller's login id, except with &%-bh%&,
4282 where there is no default) for messages from local sources. See chapter
4283 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4284
4285 .vitem &%-oMas%&&~<&'address'&>
4286 .oindex "&%-oMas%&"
4287 .cindex "authentication" "sender, specifying for local message"
4288 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4289 option sets the authenticated sender value in &$authenticated_sender$&. It
4290 overrides the sender address that is created from the caller's login id for
4291 messages from local sources, except when &%-bh%& is used, when there is no
4292 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4293 specified on a MAIL command overrides this value. See chapter
4294 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4295
4296 .vitem &%-oMi%&&~<&'interface&~address'&>
4297 .oindex "&%-oMi%&"
4298 .cindex "interface" "address, specifying for local message"
4299 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4300 option sets the IP interface address value. A port number may be included,
4301 using the same syntax as for &%-oMa%&. The interface address is placed in
4302 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4303
4304 .vitem &%-oMm%&&~<&'message&~reference'&>
4305 .oindex "&%-oMm%&"
4306 .cindex "message reference" "message reference, specifying for local message"
4307 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4308 option sets the message reference, e.g. message-id, and is logged during
4309 delivery. This is useful when some kind of audit trail is required to tie
4310 messages together. The format of the message reference is checked and will
4311 abort if the format is invalid. The option will only be accepted if exim is
4312 running in trusted mode, not as any regular user.
4313
4314 The best example of a message reference is when Exim sends a bounce message.
4315 The message reference is the message-id of the original message for which Exim
4316 is sending the bounce.
4317
4318 .vitem &%-oMr%&&~<&'protocol&~name'&>
4319 .oindex "&%-oMr%&"
4320 .cindex "protocol, specifying for local message"
4321 .vindex "&$received_protocol$&"
4322 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4323 option sets the received protocol value that is stored in
4324 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4325 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4326 SMTP protocol names (see the description of &$received_protocol$& in section
4327 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4328 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4329 be set by &%-oMr%&. Repeated use of this option is not supported.
4330
4331 .vitem &%-oMs%&&~<&'host&~name'&>
4332 .oindex "&%-oMs%&"
4333 .cindex "sender" "host name, specifying for local message"
4334 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4335 option sets the sender host name in &$sender_host_name$&. When this option is
4336 present, Exim does not attempt to look up a host name from an IP address; it
4337 uses the name it is given.
4338
4339 .vitem &%-oMt%&&~<&'ident&~string'&>
4340 .oindex "&%-oMt%&"
4341 .cindex "sender" "ident string, specifying for local message"
4342 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4343 option sets the sender ident value in &$sender_ident$&. The default setting for
4344 local callers is the login id of the calling process, except when &%-bh%& is
4345 used, when there is no default.
4346
4347 .vitem &%-om%&
4348 .oindex "&%-om%&"
4349 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4350 In Sendmail, this option means &"me too"&, indicating that the sender of a
4351 message should receive a copy of the message if the sender appears in an alias
4352 expansion. Exim always does this, so the option does nothing.
4353
4354 .vitem &%-oo%&
4355 .oindex "&%-oo%&"
4356 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4357 This option is ignored. In Sendmail it specifies &"old style headers"&,
4358 whatever that means.
4359
4360 .vitem &%-oP%&&~<&'path'&>
4361 .oindex "&%-oP%&"
4362 .cindex "pid (process id)" "of daemon"
4363 .cindex "daemon" "process id (pid)"
4364 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4365 value. The option specifies the file to which the process id of the daemon is
4366 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4367 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4368 because in those cases, the normal pid file is not used.
4369
4370 .vitem &%-or%&&~<&'time'&>
4371 .oindex "&%-or%&"
4372 .cindex "timeout" "for non-SMTP input"
4373 This option sets a timeout value for incoming non-SMTP messages. If it is not
4374 set, Exim will wait forever for the standard input. The value can also be set
4375 by the &%receive_timeout%& option. The format used for specifying times is
4376 described in section &<<SECTtimeformat>>&.
4377
4378 .vitem &%-os%&&~<&'time'&>
4379 .oindex "&%-os%&"
4380 .cindex "timeout" "for SMTP input"
4381 .cindex "SMTP" "input timeout"
4382 This option sets a timeout value for incoming SMTP messages. The timeout
4383 applies to each SMTP command and block of data. The value can also be set by
4384 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4385 for specifying times is described in section &<<SECTtimeformat>>&.
4386
4387 .vitem &%-ov%&
4388 .oindex "&%-ov%&"
4389 This option has exactly the same effect as &%-v%&.
4390
4391 .vitem &%-oX%&&~<&'number&~or&~string'&>
4392 .oindex "&%-oX%&"
4393 .cindex "TCP/IP" "setting listening ports"
4394 .cindex "TCP/IP" "setting listening interfaces"
4395 .cindex "port" "receiving TCP/IP"
4396 This option is relevant only when the &%-bd%& (start listening daemon) option
4397 is also given. It controls which ports and interfaces the daemon uses. Details
4398 of the syntax, and how it interacts with configuration file options, are given
4399 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4400 file is written unless &%-oP%& is also present to specify a pid filename.
4401
4402 .vitem &%-pd%&
4403 .oindex "&%-pd%&"
4404 .cindex "Perl" "starting the interpreter"
4405 This option applies when an embedded Perl interpreter is linked with Exim (see
4406 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4407 option, forcing the starting of the interpreter to be delayed until it is
4408 needed.
4409
4410 .vitem &%-ps%&
4411 .oindex "&%-ps%&"
4412 .cindex "Perl" "starting the interpreter"
4413 This option applies when an embedded Perl interpreter is linked with Exim (see
4414 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4415 option, forcing the starting of the interpreter to occur as soon as Exim is
4416 started.
4417
4418 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4419 .oindex "&%-p%&"
4420 For compatibility with Sendmail, this option is equivalent to
4421 .display
4422 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4423 .endd
4424 It sets the incoming protocol and host name (for trusted callers). The
4425 host name and its colon can be omitted when only the protocol is to be set.
4426 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4427 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4428 or &`s`& using this option (but that does not seem a real limitation).
4429 Repeated use of this option is not supported.
4430
4431 .vitem &%-q%&
4432 .oindex "&%-q%&"
4433 .cindex "queue runner" "starting manually"
4434 This option is normally restricted to admin users. However, there is a
4435 configuration option called &%prod_requires_admin%& which can be set false to
4436 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4437 and &%-S%& options).
4438
4439 .cindex "queue runner" "description of operation"
4440 If other commandline options do not specify an action,
4441 the &%-q%& option starts one queue runner process. This scans the queue of
4442 waiting messages, and runs a delivery process for each one in turn. It waits
4443 for each delivery process to finish before starting the next one. A delivery
4444 process may not actually do any deliveries if the retry times for the addresses
4445 have not been reached. Use &%-qf%& (see below) if you want to override this.
4446
4447 If
4448 .cindex "SMTP" "passed connection"
4449 .cindex "SMTP" "multiple deliveries"
4450 .cindex "multiple SMTP deliveries"
4451 the delivery process spawns other processes to deliver other messages down
4452 passed SMTP connections, the queue runner waits for these to finish before
4453 proceeding.
4454
4455 When all the queued messages have been considered, the original queue runner
4456 process terminates. In other words, a single pass is made over the waiting
4457 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4458 this to be repeated periodically.
4459
4460 Exim processes the waiting messages in an unpredictable order. It isn't very
4461 random, but it is likely to be different each time, which is all that matters.
4462 If one particular message screws up a remote MTA, other messages to the same
4463 MTA have a chance of getting through if they get tried first.
4464
4465 It is possible to cause the messages to be processed in lexical message id
4466 order, which is essentially the order in which they arrived, by setting the
4467 &%queue_run_in_order%& option, but this is not recommended for normal use.
4468
4469 .vitem &%-q%&<&'qflags'&>
4470 The &%-q%& option may be followed by one or more flag letters that change its
4471 behaviour. They are all optional, but if more than one is present, they must
4472 appear in the correct order. Each flag is described in a separate item below.
4473
4474 .vitem &%-qq...%&
4475 .oindex "&%-qq%&"
4476 .cindex "queue" "double scanning"
4477 .cindex "queue" "routing"
4478 .cindex "routing" "whole queue before delivery"
4479 An option starting with &%-qq%& requests a two-stage queue run. In the first
4480 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4481 every domain. Addresses are routed, local deliveries happen, but no remote
4482 transports are run.
4483
4484 .cindex "hints database" "remembering routing"
4485 The hints database that remembers which messages are waiting for specific hosts
4486 is updated, as if delivery to those hosts had been deferred. After this is
4487 complete, a second, normal queue scan happens, with routing and delivery taking
4488 place as normal. Messages that are routed to the same host should mostly be
4489 delivered down a single SMTP
4490 .cindex "SMTP" "passed connection"
4491 .cindex "SMTP" "multiple deliveries"
4492 .cindex "multiple SMTP deliveries"
4493 connection because of the hints that were set up during the first queue scan.
4494 This option may be useful for hosts that are connected to the Internet
4495 intermittently.
4496
4497 .vitem &%-q[q]i...%&
4498 .oindex "&%-qi%&"
4499 .cindex "queue" "initial delivery"
4500 If the &'i'& flag is present, the queue runner runs delivery processes only for
4501 those messages that haven't previously been tried. (&'i'& stands for &"initial
4502 delivery"&.) This can be helpful if you are putting messages in the queue using
4503 &%-odq%& and want a queue runner just to process the new messages.
4504
4505 .vitem &%-q[q][i]f...%&
4506 .oindex "&%-qf%&"
4507 .cindex "queue" "forcing delivery"
4508 .cindex "delivery" "forcing in queue run"
4509 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4510 message, whereas without &'f'& only those non-frozen addresses that have passed
4511 their retry times are tried.
4512
4513 .vitem &%-q[q][i]ff...%&
4514 .oindex "&%-qff%&"
4515 .cindex "frozen messages" "forcing delivery"
4516 If &'ff'& is present, a delivery attempt is forced for every message, whether
4517 frozen or not.
4518
4519 .vitem &%-q[q][i][f[f]]l%&
4520 .oindex "&%-ql%&"
4521 .cindex "queue" "local deliveries only"
4522 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4523 be done. If a message requires any remote deliveries, it remains in the queue
4524 for later delivery.
4525
4526 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4527 .oindex "&%-qG%&"
4528 .cindex queue named
4529 .cindex "named queues"
4530 .cindex "queue" "delivering specific messages"
4531 If the &'G'& flag and a name is present, the queue runner operates on the
4532 queue with the given name rather than the default queue.
4533 The name should not contain a &'/'& character.
4534 For a periodic queue run (see below)
4535 append to the name a slash and a time value.
4536
4537 If other commandline options specify an action, a &'-qG<name>'& option
4538 will specify a queue to operate on.
4539 For example:
4540 .code
4541 exim -bp -qGquarantine
4542 mailq -qGquarantine
4543 exim -qGoffpeak -Rf @special.domain.example
4544 .endd
4545
4546 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4547 When scanning the queue, Exim can be made to skip over messages whose ids are
4548 lexically less than a given value by following the &%-q%& option with a
4549 starting message id. For example:
4550 .code
4551 exim -q 0t5C6f-0000c8-00
4552 .endd
4553 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4554 second message id is given, messages whose ids are lexically greater than it
4555 are also skipped. If the same id is given twice, for example,
4556 .code
4557 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4558 .endd
4559 just one delivery process is started, for that message. This differs from
4560 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4561 that it counts as a delivery from a queue run. Note that the selection
4562 mechanism does not affect the order in which the messages are scanned. There
4563 are also other ways of selecting specific sets of messages for delivery in a
4564 queue run &-- see &%-R%& and &%-S%&.
4565
4566 .vitem &%-q%&<&'qflags'&><&'time'&>
4567 .cindex "queue runner" "starting periodically"
4568 .cindex "periodic queue running"
4569 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4570 starting a queue runner process at intervals specified by the given time value
4571 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4572 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4573 single daemon process handles both functions. A common way of starting up a
4574 combined daemon at system boot time is to use a command such as
4575 .code
4576 /usr/exim/bin/exim -bd -q30m
4577 .endd
4578 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4579 process every 30 minutes.
4580
4581 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4582 pid file is written unless one is explicitly requested by the &%-oP%& option.
4583
4584 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4585 .oindex "&%-qR%&"
4586 This option is synonymous with &%-R%&. It is provided for Sendmail
4587 compatibility.
4588
4589 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4590 .oindex "&%-qS%&"
4591 This option is synonymous with &%-S%&.
4592
4593 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4594 .oindex "&%-R%&"
4595 .cindex "queue runner" "for specific recipients"
4596 .cindex "delivery" "to given domain"
4597 .cindex "domain" "delivery to"
4598 The <&'rsflags'&> may be empty, in which case the white space before the string
4599 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4600 which are the possible values for <&'rsflags'&>. White space is required if
4601 <&'rsflags'&> is not empty.
4602
4603 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4604 perform a single queue run, except that, when scanning the messages on the
4605 queue, Exim processes only those that have at least one undelivered recipient
4606 address containing the given string, which is checked in a case-independent
4607 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4608 regular expression; otherwise it is a literal string.
4609
4610 If you want to do periodic queue runs for messages with specific recipients,
4611 you can combine &%-R%& with &%-q%& and a time value. For example:
4612 .code
4613 exim -q25m -R @special.domain.example
4614 .endd
4615 This example does a queue run for messages with recipients in the given domain
4616 every 25 minutes. Any additional flags that are specified with &%-q%& are
4617 applied to each queue run.
4618
4619 Once a message is selected for delivery by this mechanism, all its addresses
4620 are processed. For the first selected message, Exim overrides any retry
4621 information and forces a delivery attempt for each undelivered address. This
4622 means that if delivery of any address in the first message is successful, any
4623 existing retry information is deleted, and so delivery attempts for that
4624 address in subsequently selected messages (which are processed without forcing)
4625 will run. However, if delivery of any address does not succeed, the retry
4626 information is updated, and in subsequently selected messages, the failing
4627 address will be skipped.
4628
4629 .cindex "frozen messages" "forcing delivery"
4630 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4631 all selected messages, not just the first; frozen messages are included when
4632 &'ff'& is present.
4633
4634 The &%-R%& option makes it straightforward to initiate delivery of all messages
4635 to a given domain after a host has been down for some time. When the SMTP
4636 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4637 effect is to run Exim with the &%-R%& option, but it can be configured to run
4638 an arbitrary command instead.
4639
4640 .vitem &%-r%&
4641 .oindex "&%-r%&"
4642 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4643
4644 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4645 .oindex "&%-S%&"
4646 .cindex "delivery" "from given sender"
4647 .cindex "queue runner" "for specific senders"
4648 This option acts like &%-R%& except that it checks the string against each
4649 message's sender instead of against the recipients. If &%-R%& is also set, both
4650 conditions must be met for a message to be selected. If either of the options
4651 has &'f'& or &'ff'& in its flags, the associated action is taken.
4652
4653 .vitem &%-Tqt%&&~<&'times'&>
4654 .oindex "&%-Tqt%&"
4655 This is an option that is exclusively for use by the Exim testing suite. It is not
4656 recognized when Exim is run normally. It allows for the setting up of explicit
4657 &"queue times"& so that various warning/retry features can be tested.
4658
4659 .vitem &%-t%&
4660 .oindex "&%-t%&"
4661 .cindex "recipient" "extracting from header lines"
4662 .cindex "&'Bcc:'& header line"
4663 .cindex "&'Cc:'& header line"
4664 .cindex "&'To:'& header line"
4665 When Exim is receiving a locally-generated, non-SMTP message on its standard
4666 input, the &%-t%& option causes the recipients of the message to be obtained
4667 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4668 from the command arguments. The addresses are extracted before any rewriting
4669 takes place and the &'Bcc:'& header line, if present, is then removed.
4670
4671 .cindex "Sendmail compatibility" "&%-t%& option"
4672 If the command has any arguments, they specify addresses to which the message
4673 is &'not'& to be delivered. That is, the argument addresses are removed from
4674 the recipients list obtained from the headers. This is compatible with Smail 3
4675 and in accordance with the documented behaviour of several versions of
4676 Sendmail, as described in man pages on a number of operating systems (e.g.
4677 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4678 argument addresses to those obtained from the headers, and the O'Reilly
4679 Sendmail book documents it that way. Exim can be made to add argument addresses
4680 instead of subtracting them by setting the option
4681 &%extract_addresses_remove_arguments%& false.
4682
4683 .cindex "&%Resent-%& header lines" "with &%-t%&"
4684 If there are any &%Resent-%& header lines in the message, Exim extracts
4685 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4686 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4687 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4688 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4689
4690 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4691 message is resent several times). The RFC also specifies that they should be
4692 added at the front of the message, and separated by &'Received:'& lines. It is
4693 not at all clear how &%-t%& should operate in the present of multiple sets,
4694 nor indeed exactly what constitutes a &"set"&.
4695 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4696 are often added at the end of the header, and if a message is resent more than
4697 once, it is common for the original set of &%Resent-%& headers to be renamed as
4698 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4699
4700 .vitem &%-ti%&
4701 .oindex "&%-ti%&"
4702 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4703 compatibility with Sendmail.
4704
4705 .vitem &%-tls-on-connect%&
4706 .oindex "&%-tls-on-connect%&"
4707 .cindex "TLS" "use without STARTTLS"
4708 .cindex "TLS" "automatic start"
4709 This option is available when Exim is compiled with TLS support. It forces all
4710 incoming SMTP connections to behave as if the incoming port is listed in the
4711 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4712 &<<CHAPTLS>>& for further details.
4713
4714
4715 .vitem &%-U%&
4716 .oindex "&%-U%&"
4717 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4718 Sendmail uses this option for &"initial message submission"&, and its
4719 documentation states that in future releases, it may complain about
4720 syntactically invalid messages rather than fixing them when this flag is not
4721 set. Exim ignores this option.
4722
4723 .vitem &%-v%&
4724 .oindex "&%-v%&"
4725 This option causes Exim to write information to the standard error stream,
4726 describing what it is doing. In particular, it shows the log lines for
4727 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4728 dialogue is shown. Some of the log lines shown may not actually be written to
4729 the log if the setting of &%log_selector%& discards them. Any relevant
4730 selectors are shown with each log line. If none are shown, the logging is
4731 unconditional.
4732
4733 .vitem &%-x%&
4734 .oindex "&%-x%&"
4735 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4736 National Language Support extended characters in the body of the mail item"&).
4737 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4738 this option.
4739
4740 .vitem &%-X%&&~<&'logfile'&>
4741 .oindex "&%-X%&"
4742 This option is interpreted by Sendmail to cause debug information to be sent
4743 to the named file.  It is ignored by Exim.
4744
4745 .vitem &%-z%&&~<&'log-line'&>
4746 .oindex "&%-z%&"
4747 This option writes its argument to Exim's logfile.
4748 Use is restricted to administrators; the intent is for operational notes.
4749 Quotes should be used to maintain a multi-word item as a single argument,
4750 under most shells.
4751 .endlist
4752
4753 .ecindex IIDclo1
4754 .ecindex IIDclo2
4755
4756
4757 . ////////////////////////////////////////////////////////////////////////////
4758 . Insert a stylized DocBook comment here, to identify the end of the command
4759 . line options. This is for the benefit of the Perl script that automatically
4760 . creates a man page for the options.
4761 . ////////////////////////////////////////////////////////////////////////////
4762
4763 .literal xml
4764 <!-- === End of command line options === -->
4765 .literal off
4766
4767
4768
4769
4770
4771 . ////////////////////////////////////////////////////////////////////////////
4772 . ////////////////////////////////////////////////////////////////////////////
4773
4774
4775 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4776          "The runtime configuration file"
4777
4778 .cindex "runtime configuration"
4779 .cindex "configuration file" "general description"
4780 .cindex "CONFIGURE_FILE"
4781 .cindex "configuration file" "errors in"
4782 .cindex "error" "in configuration file"
4783 .cindex "return code" "for bad configuration"
4784 Exim uses a single runtime configuration file that is read whenever an Exim
4785 binary is executed. Note that in normal operation, this happens frequently,
4786 because Exim is designed to operate in a distributed manner, without central
4787 control.
4788
4789 If a syntax error is detected while reading the configuration file, Exim
4790 writes a message on the standard error, and exits with a non-zero return code.
4791 The message is also written to the panic log. &*Note*&: Only simple syntax
4792 errors can be detected at this time. The values of any expanded options are
4793 not checked until the expansion happens, even when the expansion does not
4794 actually alter the string.
4795
4796 The name of the configuration file is compiled into the binary for security
4797 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4798 most configurations, this specifies a single file. However, it is permitted to
4799 give a colon-separated list of filenames, in which case Exim uses the first
4800 existing file in the list.
4801
4802 .cindex "EXIM_USER"
4803 .cindex "EXIM_GROUP"
4804 .cindex "CONFIGURE_OWNER"
4805 .cindex "CONFIGURE_GROUP"
4806 .cindex "configuration file" "ownership"
4807 .cindex "ownership" "configuration file"
4808 The runtime configuration file must be owned by root or by the user that is
4809 specified at compile time by the CONFIGURE_OWNER option (if set). The
4810 configuration file must not be world-writeable, or group-writeable unless its
4811 group is the root group or the one specified at compile time by the
4812 CONFIGURE_GROUP option.
4813
4814 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4815 to root, anybody who is able to edit the runtime configuration file has an
4816 easy way to run commands as root. If you specify a user or group in the
4817 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4818 who are members of that group will trivially be able to obtain root privileges.
4819
4820 Up to Exim version 4.72, the runtime configuration file was also permitted to
4821 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4822 since it offered a simple privilege escalation for any attacker who managed to
4823 compromise the Exim user account.
4824
4825 A default configuration file, which will work correctly in simple situations,
4826 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4827 defines just one filename, the installation process copies the default
4828 configuration to a new file of that name if it did not previously exist. If
4829 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4830 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4831 configuration.
4832
4833
4834
4835 .section "Using a different configuration file" "SECID40"
4836 .cindex "configuration file" "alternate"
4837 A one-off alternate configuration can be specified by the &%-C%& command line
4838 option, which may specify a single file or a list of files. However, when
4839 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4840 unless the argument for &%-C%& is identical to the built-in value from
4841 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4842 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4843 is useful mainly for checking the syntax of configuration files before
4844 installing them. No owner or group checks are done on a configuration file
4845 specified by &%-C%&, if root privilege has been dropped.
4846
4847 Even the Exim user is not trusted to specify an arbitrary configuration file
4848 with the &%-C%& option to be used with root privileges, unless that file is
4849 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4850 testing a configuration using &%-C%& right through message reception and
4851 delivery, even if the caller is root. The reception works, but by that time,
4852 Exim is running as the Exim user, so when it re-execs to regain privilege for
4853 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4854 can test reception and delivery using two separate commands (one to put a
4855 message in the queue, using &%-odq%&, and another to do the delivery, using
4856 &%-M%&).
4857
4858 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4859 prefix string with which any file named in a &%-C%& command line option must
4860 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4861 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4862 filename can be used with &%-C%&.
4863
4864 One-off changes to a configuration can be specified by the &%-D%& command line
4865 option, which defines and overrides values for macros used inside the
4866 configuration file. However, like &%-C%&, the use of this option by a
4867 non-privileged user causes Exim to discard its root privilege.
4868 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4869 completely disabled, and its use causes an immediate error exit.
4870
4871 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4872 to declare certain macro names trusted, such that root privilege will not
4873 necessarily be discarded.
4874 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4875 considered safe and, if &%-D%& only supplies macros from this list, and the
4876 values are acceptable, then Exim will not give up root privilege if the caller
4877 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4878 transition mechanism and is expected to be removed in the future.  Acceptable
4879 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4880
4881 Some sites may wish to use the same Exim binary on different machines that
4882 share a file system, but to use different configuration files on each machine.
4883 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4884 looks for a file whose name is the configuration filename followed by a dot
4885 and the machine's node name, as obtained from the &[uname()]& function. If this
4886 file does not exist, the standard name is tried. This processing occurs for
4887 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4888
4889 In some esoteric situations different versions of Exim may be run under
4890 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4891 help with this. See the comments in &_src/EDITME_& for details.
4892
4893
4894
4895 .section "Configuration file format" "SECTconffilfor"
4896 .cindex "configuration file" "format of"
4897 .cindex "format" "configuration file"
4898 Exim's configuration file is divided into a number of different parts. General
4899 option settings must always appear at the start of the file. The other parts
4900 are all optional, and may appear in any order. Each part other than the first
4901 is introduced by the word &"begin"& followed by at least one literal
4902 space, and the name of the part. The optional parts are:
4903
4904 .ilist
4905 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4906 &<<CHAPACL>>&).
4907 .next
4908 .cindex "AUTH" "configuration"
4909 &'authenticators'&: Configuration settings for the authenticator drivers. These
4910 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4911 .next
4912 &'routers'&: Configuration settings for the router drivers. Routers process
4913 addresses and determine how the message is to be delivered (see chapters
4914 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4915 .next
4916 &'transports'&: Configuration settings for the transport drivers. Transports
4917 define mechanisms for copying messages to destinations (see chapters
4918 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4919 .next
4920 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4921 If there is no retry section, or if it is empty (that is, no retry rules are
4922 defined), Exim will not retry deliveries. In this situation, temporary errors
4923 are treated the same as permanent errors. Retry rules are discussed in chapter
4924 &<<CHAPretry>>&.
4925 .next
4926 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4927 when new addresses are generated during delivery. Rewriting is discussed in
4928 chapter &<<CHAPrewrite>>&.
4929 .next
4930 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4931 want to use this feature, you must set
4932 .code
4933 LOCAL_SCAN_HAS_OPTIONS=yes
4934 .endd
4935 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4936 facility are given in chapter &<<CHAPlocalscan>>&.
4937 .endlist
4938
4939 .cindex "configuration file" "leading white space in"
4940 .cindex "configuration file" "trailing white space in"
4941 .cindex "white space" "in configuration file"
4942 Leading and trailing white space in configuration lines is always ignored.
4943
4944 Blank lines in the file, and lines starting with a # character (ignoring
4945 leading white space) are treated as comments and are ignored. &*Note*&: A
4946 # character other than at the beginning of a line is not treated specially,
4947 and does not introduce a comment.
4948
4949 Any non-comment line can be continued by ending it with a backslash. Note that
4950 the general rule for white space means that trailing white space after the
4951 backslash and leading white space at the start of continuation
4952 lines is ignored. Comment lines beginning with # (but not empty lines) may
4953 appear in the middle of a sequence of continuation lines.
4954
4955 A convenient way to create a configuration file is to start from the
4956 default, which is supplied in &_src/configure.default_&, and add, delete, or
4957 change settings as required.
4958
4959 The ACLs, retry rules, and rewriting rules have their own syntax which is
4960 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4961 respectively. The other parts of the configuration file have some syntactic
4962 items in common, and these are described below, from section &<<SECTcos>>&
4963 onwards. Before that, the inclusion, macro, and conditional facilities are
4964 described.
4965
4966
4967
4968 .section "File inclusions in the configuration file" "SECID41"
4969 .cindex "inclusions in configuration file"
4970 .cindex "configuration file" "including other files"
4971 .cindex "&`.include`& in configuration file"
4972 .cindex "&`.include_if_exists`& in configuration file"
4973 You can include other files inside Exim's runtime configuration file by
4974 using this syntax:
4975 .display
4976 &`.include`& <&'filename'&>
4977 &`.include_if_exists`& <&'filename'&>
4978 .endd
4979 on a line by itself. Double quotes round the filename are optional. If you use
4980 the first form, a configuration error occurs if the file does not exist; the
4981 second form does nothing for non-existent files.
4982 The first form allows a relative name. It is resolved relative to
4983 the directory of the including file. For the second form an absolute filename
4984 is required.
4985
4986 Includes may be nested to any depth, but remember that Exim reads its
4987 configuration file often, so it is a good idea to keep them to a minimum.
4988 If you change the contents of an included file, you must HUP the daemon,
4989 because an included file is read only when the configuration itself is read.
4990
4991 The processing of inclusions happens early, at a physical line level, so, like
4992 comment lines, an inclusion can be used in the middle of an option setting,
4993 for example:
4994 .code
4995 hosts_lookup = a.b.c \
4996                .include /some/file
4997 .endd
4998 Include processing happens after macro processing (see below). Its effect is to
4999 process the lines of the included file as if they occurred inline where the
5000 inclusion appears.
5001
5002
5003
5004 .section "Macros in the configuration file" "SECTmacrodefs"
5005 .cindex "macro" "description of"
5006 .cindex "configuration file" "macros"
5007 If a line in the main part of the configuration (that is, before the first
5008 &"begin"& line) begins with an upper case letter, it is taken as a macro
5009 definition, and must be of the form
5010 .display
5011 <&'name'&> = <&'rest of line'&>
5012 .endd
5013 The name must consist of letters, digits, and underscores, and need not all be
5014 in upper case, though that is recommended. The rest of the line, including any
5015 continuations, is the replacement text, and has leading and trailing white
5016 space removed. Quotes are not removed. The replacement text can never end with
5017 a backslash character, but this doesn't seem to be a serious limitation.
5018
5019 Macros may also be defined between router, transport, authenticator, or ACL
5020 definitions. They may not, however, be defined within an individual driver or
5021 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5022
5023 .section "Macro substitution" "SECID42"
5024 Once a macro is defined, all subsequent lines in the file (and any included
5025 files) are scanned for the macro name; if there are several macros, the line is
5026 scanned for each, in turn, in the order in which the macros are defined. The
5027 replacement text is not re-scanned for the current macro, though it is scanned
5028 for subsequently defined macros. For this reason, a macro name may not contain
5029 the name of a previously defined macro as a substring. You could, for example,
5030 define
5031 .display
5032 &`ABCD_XYZ = `&<&'something'&>
5033 &`ABCD = `&<&'something else'&>
5034 .endd
5035 but putting the definitions in the opposite order would provoke a configuration
5036 error. Macro expansion is applied to individual physical lines from the file,
5037 before checking for line continuation or file inclusion (see above). If a line
5038 consists solely of a macro name, and the expansion of the macro is empty, the
5039 line is ignored. A macro at the start of a line may turn the line into a
5040 comment line or a &`.include`& line.
5041
5042
5043 .section "Redefining macros" "SECID43"
5044 Once defined, the value of a macro can be redefined later in the configuration
5045 (or in an included file). Redefinition is specified by using &'=='& instead of
5046 &'='&. For example:
5047 .code
5048 MAC =  initial value
5049 ...
5050 MAC == updated value
5051 .endd
5052 Redefinition does not alter the order in which the macros are applied to the
5053 subsequent lines of the configuration file. It is still the same order in which
5054 the macros were originally defined. All that changes is the macro's value.
5055 Redefinition makes it possible to accumulate values. For example:
5056 .code
5057 MAC =  initial value
5058 ...
5059 MAC == MAC and something added
5060 .endd
5061 This can be helpful in situations where the configuration file is built
5062 from a number of other files.
5063
5064 .section "Overriding macro values" "SECID44"
5065 The values set for macros in the configuration file can be overridden by the
5066 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5067 used, unless called by root or the Exim user. A definition on the command line
5068 using the &%-D%& option causes all definitions and redefinitions within the
5069 file to be ignored.
5070
5071
5072
5073 .section "Example of macro usage" "SECID45"
5074 As an example of macro usage, consider a configuration where aliases are looked
5075 up in a MySQL database. It helps to keep the file less cluttered if long
5076 strings such as SQL statements are defined separately as macros, for example:
5077 .code
5078 ALIAS_QUERY = select mailbox from user where \
5079               login='${quote_mysql:$local_part}';
5080 .endd
5081 This can then be used in a &(redirect)& router setting like this:
5082 .code
5083 data = ${lookup mysql{ALIAS_QUERY}}
5084 .endd
5085 In earlier versions of Exim macros were sometimes used for domain, host, or
5086 address lists. In Exim 4 these are handled better by named lists &-- see
5087 section &<<SECTnamedlists>>&.
5088
5089
5090 .section "Builtin macros" "SECTbuiltinmacros"
5091 Exim defines some macros depending on facilities available, which may
5092 differ due to build-time definitions and from one release to another.
5093 All of these macros start with an underscore.
5094 They can be used to conditionally include parts of a configuration
5095 (see below).
5096
5097 The following classes of macros are defined:
5098 .display
5099 &` _HAVE_*                    `&  build-time defines
5100 &` _DRIVER_ROUTER_*           `&  router drivers
5101 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5102 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5103 &` _LOG_*                     `&  log_selector values
5104 &` _OPT_MAIN_*                `&  main config options
5105 &` _OPT_ROUTERS_*             `&  generic router options
5106 &` _OPT_TRANSPORTS_*          `&  generic transport options
5107 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5108 &` _OPT_ROUTER_*_*            `&  private router options
5109 &` _OPT_TRANSPORT_*_*         `&  private transport options
5110 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5111 .endd
5112
5113 Use an &"exim -bP macros"& command to get the list of macros.
5114
5115
5116 .section "Conditional skips in the configuration file" "SECID46"
5117 .cindex "configuration file" "conditional skips"
5118 .cindex "&`.ifdef`&"
5119 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5120 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5121 portions of the configuration file. The processing happens whenever the file is
5122 read (that is, when an Exim binary starts to run).
5123
5124 The implementation is very simple. Instances of the first four directives must
5125 be followed by text that includes the names of one or macros. The condition
5126 that is tested is whether or not any macro substitution has taken place in the
5127 line. Thus:
5128 .code
5129 .ifdef AAA
5130 message_size_limit = 50M
5131 .else
5132 message_size_limit = 100M
5133 .endif
5134 .endd
5135 sets a message size limit of 50M if the macro &`AAA`& is defined
5136 (or &`A`& or &`AA`&), and 100M
5137 otherwise. If there is more than one macro named on the line, the condition
5138 is true if any of them are defined. That is, it is an &"or"& condition. To
5139 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5140
5141 Although you can use a macro expansion to generate one of these directives,
5142 it is not very useful, because the condition &"there was a macro substitution
5143 in this line"& will always be true.
5144
5145 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5146 to clarify complicated nestings.
5147
5148
5149
5150 .section "Common option syntax" "SECTcos"
5151 .cindex "common option syntax"
5152 .cindex "syntax of common options"
5153 .cindex "configuration file" "common option syntax"
5154 For the main set of options, driver options, and &[local_scan()]& options,
5155 each setting is on a line by itself, and starts with a name consisting of
5156 lower-case letters and underscores. Many options require a data value, and in
5157 these cases the name must be followed by an equals sign (with optional white
5158 space) and then the value. For example:
5159 .code
5160 qualify_domain = mydomain.example.com
5161 .endd
5162 .cindex "hiding configuration option values"
5163 .cindex "configuration options" "hiding value of"
5164 .cindex "options" "hiding value of"
5165 Some option settings may contain sensitive data, for example, passwords for
5166 accessing databases. To stop non-admin users from using the &%-bP%& command
5167 line option to read these values, you can precede the option settings with the
5168 word &"hide"&. For example:
5169 .code
5170 hide mysql_servers = localhost/users/admin/secret-password
5171 .endd
5172 For non-admin users, such options are displayed like this:
5173 .code
5174 mysql_servers = <value not displayable>
5175 .endd
5176 If &"hide"& is used on a driver option, it hides the value of that option on
5177 all instances of the same driver.
5178
5179 The following sections describe the syntax used for the different data types
5180 that are found in option settings.
5181
5182
5183 .section "Boolean options" "SECID47"
5184 .cindex "format" "boolean"
5185 .cindex "boolean configuration values"
5186 .oindex "&%no_%&&'xxx'&"
5187 .oindex "&%not_%&&'xxx'&"
5188 Options whose type is given as boolean are on/off switches. There are two
5189 different ways of specifying such options: with and without a data value. If
5190 the option name is specified on its own without data, the switch is turned on;
5191 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5192 boolean options may be followed by an equals sign and one of the words
5193 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5194 the following two settings have exactly the same effect:
5195 .code
5196 queue_only
5197 queue_only = true
5198 .endd
5199 The following two lines also have the same (opposite) effect:
5200 .code
5201 no_queue_only
5202 queue_only = false
5203 .endd
5204 You can use whichever syntax you prefer.
5205
5206
5207
5208
5209 .section "Integer values" "SECID48"
5210 .cindex "integer configuration values"
5211 .cindex "format" "integer"
5212 If an option's type is given as &"integer"&, the value can be given in decimal,
5213 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5214 number is assumed. Otherwise, it is treated as an octal number unless it starts
5215 with the characters &"0x"&, in which case the remainder is interpreted as a
5216 hexadecimal number.
5217
5218 If an integer value is followed by the letter K, it is multiplied by 1024; if
5219 it is followed by the letter M, it is multiplied by 1024x1024;
5220 if by the letter G, 1024x1024x1024.
5221 When the values
5222 of integer option settings are output, values which are an exact multiple of
5223 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5224 and M. The printing style is independent of the actual input format that was
5225 used.
5226
5227
5228 .section "Octal integer values" "SECID49"
5229 .cindex "integer format"
5230 .cindex "format" "octal integer"
5231 If an option's type is given as &"octal integer"&, its value is always
5232 interpreted as an octal number, whether or not it starts with the digit zero.
5233 Such options are always output in octal.
5234
5235
5236 .section "Fixed point numbers" "SECID50"
5237 .cindex "fixed point configuration values"
5238 .cindex "format" "fixed point"
5239 If an option's type is given as &"fixed-point"&, its value must be a decimal
5240 integer, optionally followed by a decimal point and up to three further digits.
5241
5242
5243
5244 .section "Time intervals" "SECTtimeformat"
5245 .cindex "time interval" "specifying in configuration"
5246 .cindex "format" "time interval"
5247 A time interval is specified as a sequence of numbers, each followed by one of
5248 the following letters, with no intervening white space:
5249
5250 .table2 30pt
5251 .irow &%s%& seconds
5252 .irow &%m%& minutes
5253 .irow &%h%& hours
5254 .irow &%d%& days
5255 .irow &%w%& weeks
5256 .endtable
5257
5258 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5259 intervals are output in the same format. Exim does not restrict the values; it
5260 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5261
5262
5263
5264 .section "String values" "SECTstrings"
5265 .cindex "string" "format of configuration values"
5266 .cindex "format" "string"
5267 If an option's type is specified as &"string"&, the value can be specified with
5268 or without double-quotes. If it does not start with a double-quote, the value
5269 consists of the remainder of the line plus any continuation lines, starting at
5270 the first character after any leading white space, with trailing white space
5271 removed, and with no interpretation of the characters in the string. Because
5272 Exim removes comment lines (those beginning with #) at an early stage, they can
5273 appear in the middle of a multi-line string. The following two settings are
5274 therefore equivalent:
5275 .code
5276 trusted_users = uucp:mail
5277 trusted_users = uucp:\
5278                 # This comment line is ignored
5279                 mail
5280 .endd
5281 .cindex "string" "quoted"
5282 .cindex "escape characters in quoted strings"
5283 If a string does start with a double-quote, it must end with a closing
5284 double-quote, and any backslash characters other than those used for line
5285 continuation are interpreted as escape characters, as follows:
5286
5287 .table2 100pt
5288 .irow &`\\`&                     "single backslash"
5289 .irow &`\n`&                     "newline"
5290 .irow &`\r`&                     "carriage return"
5291 .irow &`\t`&                     "tab"
5292 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5293 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5294                                    character"
5295 .endtable
5296
5297 If a backslash is followed by some other character, including a double-quote
5298 character, that character replaces the pair.
5299
5300 Quoting is necessary only if you want to make use of the backslash escapes to
5301 insert special characters, or if you need to specify a value with leading or
5302 trailing spaces. These cases are rare, so quoting is almost never needed in
5303 current versions of Exim. In versions of Exim before 3.14, quoting was required
5304 in order to continue lines, so you may come across older configuration files
5305 and examples that apparently quote unnecessarily.
5306
5307
5308 .section "Expanded strings" "SECID51"
5309 .cindex "expansion" "definition of"
5310 Some strings in the configuration file are subjected to &'string expansion'&,
5311 by which means various parts of the string may be changed according to the
5312 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5313 is as just described; in particular, the handling of backslashes in quoted
5314 strings is done as part of the input process, before expansion takes place.
5315 However, backslash is also an escape character for the expander, so any
5316 backslashes that are required for that reason must be doubled if they are
5317 within a quoted configuration string.
5318
5319
5320 .section "User and group names" "SECID52"
5321 .cindex "user name" "format of"
5322 .cindex "format" "user name"
5323 .cindex "groups" "name format"
5324 .cindex "format" "group name"
5325 User and group names are specified as strings, using the syntax described
5326 above, but the strings are interpreted specially. A user or group name must
5327 either consist entirely of digits, or be a name that can be looked up using the
5328 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5329
5330
5331 .section "List construction" "SECTlistconstruct"
5332 .cindex "list" "syntax of in configuration"
5333 .cindex "format" "list item in configuration"
5334 .cindex "string" "list, definition of"
5335 The data for some configuration options is a list of items, with colon as the
5336 default separator. Many of these options are shown with type &"string list"& in
5337 the descriptions later in this document. Others are listed as &"domain list"&,
5338 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5339 are all the same; however, those other than &"string list"& are subject to
5340 particular kinds of interpretation, as described in chapter
5341 &<<CHAPdomhosaddlists>>&.
5342
5343 In all these cases, the entire list is treated as a single string as far as the
5344 input syntax is concerned. The &%trusted_users%& setting in section
5345 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5346 in a list, it must be entered as two colons. Leading and trailing white space
5347 on each item in a list is ignored. This makes it possible to include items that
5348 start with a colon, and in particular, certain forms of IPv6 address. For
5349 example, the list
5350 .code
5351 local_interfaces = 127.0.0.1 : ::::1
5352 .endd
5353 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5354
5355 &*Note*&: Although leading and trailing white space is ignored in individual
5356 list items, it is not ignored when parsing the list. The space after the first
5357 colon in the example above is necessary. If it were not there, the list would
5358 be interpreted as the two items 127.0.0.1:: and 1.
5359
5360 .section "Changing list separators" "SECTlistsepchange"
5361 .cindex "list separator" "changing"
5362 .cindex "IPv6" "addresses in lists"
5363 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5364 introduced to allow the separator character to be changed. If a list begins
5365 with a left angle bracket, followed by any punctuation character, that
5366 character is used instead of colon as the list separator. For example, the list
5367 above can be rewritten to use a semicolon separator like this:
5368 .code
5369 local_interfaces = <; 127.0.0.1 ; ::1
5370 .endd
5371 This facility applies to all lists, with the exception of the list in
5372 &%log_file_path%&. It is recommended that the use of non-colon separators be
5373 confined to circumstances where they really are needed.
5374
5375 .cindex "list separator" "newline as"
5376 .cindex "newline" "as list separator"
5377 It is also possible to use newline and other control characters (those with
5378 code values less than 32, plus DEL) as separators in lists. Such separators
5379 must be provided literally at the time the list is processed. For options that
5380 are string-expanded, you can write the separator using a normal escape
5381 sequence. This will be processed by the expander before the string is
5382 interpreted as a list. For example, if a newline-separated list of domains is
5383 generated by a lookup, you can process it directly by a line such as this:
5384 .code
5385 domains = <\n ${lookup mysql{.....}}
5386 .endd
5387 This avoids having to change the list separator in such data. You are unlikely
5388 to want to use a control character as a separator in an option that is not
5389 expanded, because the value is literal text. However, it can be done by giving
5390 the value in quotes. For example:
5391 .code
5392 local_interfaces = "<\n 127.0.0.1 \n ::1"
5393 .endd
5394 Unlike printing character separators, which can be included in list items by
5395 doubling, it is not possible to include a control character as data when it is
5396 set as the separator. Two such characters in succession are interpreted as
5397 enclosing an empty list item.
5398
5399
5400
5401 .section "Empty items in lists" "SECTempitelis"
5402 .cindex "list" "empty item in"
5403 An empty item at the end of a list is always ignored. In other words, trailing
5404 separator characters are ignored. Thus, the list in
5405 .code
5406 senders = user@domain :
5407 .endd
5408 contains only a single item. If you want to include an empty string as one item
5409 in a list, it must not be the last item. For example, this list contains three
5410 items, the second of which is empty:
5411 .code
5412 senders = user1@domain : : user2@domain
5413 .endd
5414 &*Note*&: There must be white space between the two colons, as otherwise they
5415 are interpreted as representing a single colon data character (and the list
5416 would then contain just one item). If you want to specify a list that contains
5417 just one, empty item, you can do it as in this example:
5418 .code
5419 senders = :
5420 .endd
5421 In this case, the first item is empty, and the second is discarded because it
5422 is at the end of the list.
5423
5424
5425
5426
5427 .section "Format of driver configurations" "SECTfordricon"
5428 .cindex "drivers" "configuration format"
5429 There are separate parts in the configuration for defining routers, transports,
5430 and authenticators. In each part, you are defining a number of driver
5431 instances, each with its own set of options. Each driver instance is defined by
5432 a sequence of lines like this:
5433 .display
5434 <&'instance name'&>:
5435   <&'option'&>
5436   ...
5437   <&'option'&>
5438 .endd
5439 In the following example, the instance name is &(localuser)&, and it is
5440 followed by three options settings:
5441 .code
5442 localuser:
5443   driver = accept
5444   check_local_user
5445   transport = local_delivery
5446 .endd
5447 For each driver instance, you specify which Exim code module it uses &-- by the
5448 setting of the &%driver%& option &-- and (optionally) some configuration
5449 settings. For example, in the case of transports, if you want a transport to
5450 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5451 a local file you would use the &(appendfile)& driver. Each of the drivers is
5452 described in detail in its own separate chapter later in this manual.
5453
5454 You can have several routers, transports, or authenticators that are based on
5455 the same underlying driver (each must have a different instance name).
5456
5457 The order in which routers are defined is important, because addresses are
5458 passed to individual routers one by one, in order. The order in which
5459 transports are defined does not matter at all. The order in which
5460 authenticators are defined is used only when Exim, as a client, is searching
5461 them to find one that matches an authentication mechanism offered by the
5462 server.
5463
5464 .cindex "generic options"
5465 .cindex "options" "generic &-- definition of"
5466 Within a driver instance definition, there are two kinds of option: &'generic'&
5467 and &'private'&. The generic options are those that apply to all drivers of the
5468 same type (that is, all routers, all transports or all authenticators). The
5469 &%driver%& option is a generic option that must appear in every definition.
5470 .cindex "private options"
5471 The private options are special for each driver, and none need appear, because
5472 they all have default values.
5473
5474 The options may appear in any order, except that the &%driver%& option must
5475 precede any private options, since these depend on the particular driver. For
5476 this reason, it is recommended that &%driver%& always be the first option.
5477
5478 Driver instance names, which are used for reference in log entries and
5479 elsewhere, can be any sequence of letters, digits, and underscores (starting
5480 with a letter) and must be unique among drivers of the same type. A router and
5481 a transport (for example) can each have the same name, but no two router
5482 instances can have the same name. The name of a driver instance should not be
5483 confused with the name of the underlying driver module. For example, the
5484 configuration lines:
5485 .code
5486 remote_smtp:
5487   driver = smtp
5488 .endd
5489 create an instance of the &(smtp)& transport driver whose name is
5490 &(remote_smtp)&. The same driver code can be used more than once, with
5491 different instance names and different option settings each time. A second
5492 instance of the &(smtp)& transport, with different options, might be defined
5493 thus:
5494 .code
5495 special_smtp:
5496   driver = smtp
5497   port = 1234
5498   command_timeout = 10s
5499 .endd
5500 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5501 these transport instances from routers, and these names would appear in log
5502 lines.
5503
5504 Comment lines may be present in the middle of driver specifications. The full
5505 list of option settings for any particular driver instance, including all the
5506 defaulted values, can be extracted by making use of the &%-bP%& command line
5507 option.
5508
5509
5510
5511
5512
5513
5514 . ////////////////////////////////////////////////////////////////////////////
5515 . ////////////////////////////////////////////////////////////////////////////
5516
5517 .chapter "The default configuration file" "CHAPdefconfil"
5518 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5519 .cindex "default" "configuration file &""walk through""&"
5520 The default configuration file supplied with Exim as &_src/configure.default_&
5521 is sufficient for a host with simple mail requirements. As an introduction to
5522 the way Exim is configured, this chapter &"walks through"& the default
5523 configuration, giving brief explanations of the settings. Detailed descriptions
5524 of the options are given in subsequent chapters. The default configuration file
5525 itself contains extensive comments about ways you might want to modify the
5526 initial settings. However, note that there are many options that are not
5527 mentioned at all in the default configuration.
5528
5529
5530
5531 .section "Macros" "SECTdefconfmacros"
5532 All macros should be defined before any options.
5533
5534 One macro is specified, but commented out, in the default configuration:
5535 .code
5536 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5537 .endd
5538 If all off-site mail is expected to be delivered to a "smarthost", then set the
5539 hostname here and uncomment the macro.  This will affect which router is used
5540 later on.  If this is left commented out, then Exim will perform direct-to-MX
5541 deliveries using a &(dnslookup)& router.
5542
5543 In addition to macros defined here, Exim includes a number of built-in macros
5544 to enable configuration to be guarded by a binary built with support for a
5545 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5546
5547
5548 .section "Main configuration settings" "SECTdefconfmain"
5549 The main (global) configuration option settings section must always come first
5550 in the file, after the macros.
5551 The first thing you'll see in the file, after some initial comments, is the line
5552 .code
5553 # primary_hostname =
5554 .endd
5555 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5556 to know the official, fully qualified name of your host, and this is where you
5557 can specify it. However, in most cases you do not need to set this option. When
5558 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5559
5560 The first three non-comment configuration lines are as follows:
5561 .code
5562 domainlist local_domains    = @
5563 domainlist relay_to_domains =
5564 hostlist   relay_from_hosts = 127.0.0.1
5565 .endd
5566 These are not, in fact, option settings. They are definitions of two named
5567 domain lists and one named host list. Exim allows you to give names to lists of
5568 domains, hosts, and email addresses, in order to make it easier to manage the
5569 configuration file (see section &<<SECTnamedlists>>&).
5570
5571 The first line defines a domain list called &'local_domains'&; this is used
5572 later in the configuration to identify domains that are to be delivered
5573 on the local host.
5574
5575 .cindex "@ in a domain list"
5576 There is just one item in this list, the string &"@"&. This is a special form
5577 of entry which means &"the name of the local host"&. Thus, if the local host is
5578 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5579 be delivered locally. Because the local host's name is referenced indirectly,
5580 the same configuration file can be used on different hosts.
5581
5582 The second line defines a domain list called &'relay_to_domains'&, but the
5583 list itself is empty. Later in the configuration we will come to the part that
5584 controls mail relaying through the local host; it allows relaying to any
5585 domains in this list. By default, therefore, no relaying on the basis of a mail
5586 domain is permitted.
5587
5588 The third line defines a host list called &'relay_from_hosts'&. This list is
5589 used later in the configuration to permit relaying from any host or IP address
5590 that matches the list. The default contains just the IP address of the IPv4
5591 loopback interface, which means that processes on the local host are able to
5592 submit mail for relaying by sending it over TCP/IP to that interface. No other
5593 hosts are permitted to submit messages for relaying.
5594
5595 Just to be sure there's no misunderstanding: at this point in the configuration
5596 we aren't actually setting up any controls. We are just defining some domains
5597 and hosts that will be used in the controls that are specified later.
5598
5599 The next two configuration lines are genuine option settings:
5600 .code
5601 acl_smtp_rcpt = acl_check_rcpt
5602 acl_smtp_data = acl_check_data
5603 .endd
5604 These options specify &'Access Control Lists'& (ACLs) that are to be used
5605 during an incoming SMTP session for every recipient of a message (every RCPT
5606 command), and after the contents of the message have been received,
5607 respectively. The names of the lists are &'acl_check_rcpt'& and
5608 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5609 section of the configuration. The RCPT ACL controls which recipients are
5610 accepted for an incoming message &-- if a configuration does not provide an ACL
5611 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5612 contents of a message to be checked.
5613
5614 Two commented-out option settings are next:
5615 .code
5616 # av_scanner = clamd:/tmp/clamd
5617 # spamd_address = 127.0.0.1 783
5618 .endd
5619 These are example settings that can be used when Exim is compiled with the
5620 content-scanning extension. The first specifies the interface to the virus
5621 scanner, and the second specifies the interface to SpamAssassin. Further
5622 details are given in chapter &<<CHAPexiscan>>&.
5623
5624 Three more commented-out option settings follow:
5625 .code
5626 # tls_advertise_hosts = *
5627 # tls_certificate = /etc/ssl/exim.crt
5628 # tls_privatekey = /etc/ssl/exim.pem
5629 .endd
5630 These are example settings that can be used when Exim is compiled with
5631 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5632 first one specifies the list of clients that are allowed to use TLS when
5633 connecting to this server; in this case, the wildcard means all clients. The
5634 other options specify where Exim should find its TLS certificate and private
5635 key, which together prove the server's identity to any clients that connect.
5636 More details are given in chapter &<<CHAPTLS>>&.
5637
5638 Another two commented-out option settings follow:
5639 .code
5640 # daemon_smtp_ports = 25 : 465 : 587
5641 # tls_on_connect_ports = 465
5642 .endd
5643 .cindex "port" "465 and 587"
5644 .cindex "port" "for message submission"
5645 .cindex "message" "submission, ports for"
5646 .cindex "submissions protocol"
5647 .cindex "smtps protocol"
5648 .cindex "ssmtp protocol"
5649 .cindex "SMTP" "submissions protocol"
5650 .cindex "SMTP" "ssmtp protocol"
5651 .cindex "SMTP" "smtps protocol"
5652 These options provide better support for roaming users who wish to use this
5653 server for message submission. They are not much use unless you have turned on
5654 TLS (as described in the previous paragraph) and authentication (about which
5655 more in section &<<SECTdefconfauth>>&).
5656 Mail submission from mail clients (MUAs) should be separate from inbound mail
5657 to your domain (MX delivery) for various good reasons (eg, ability to impose
5658 much saner TLS protocol and ciphersuite requirements without unintended
5659 consequences).
5660 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5661 which uses STARTTLS, so this is the &"submission"& port.
5662 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5663 which should be used in preference to 587.
5664 You should also consider deploying SRV records to help clients find
5665 these ports.
5666 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5667
5668 Two more commented-out options settings follow:
5669 .code
5670 # qualify_domain =
5671 # qualify_recipient =
5672 .endd
5673 The first of these specifies a domain that Exim uses when it constructs a
5674 complete email address from a local login name. This is often needed when Exim
5675 receives a message from a local process. If you do not set &%qualify_domain%&,
5676 the value of &%primary_hostname%& is used. If you set both of these options,
5677 you can have different qualification domains for sender and recipient
5678 addresses. If you set only the first one, its value is used in both cases.
5679
5680 .cindex "domain literal" "recognizing format"
5681 The following line must be uncommented if you want Exim to recognize
5682 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5683 (an IP address within square brackets) instead of a named domain.
5684 .code
5685 # allow_domain_literals
5686 .endd
5687 The RFCs still require this form, but many people think that in the modern
5688 Internet it makes little sense to permit mail to be sent to specific hosts by
5689 quoting their IP addresses. This ancient format has been used by people who
5690 try to abuse hosts by using them for unwanted relaying. However, some
5691 people believe there are circumstances (for example, messages addressed to
5692 &'postmaster'&) where domain literals are still useful.
5693
5694 The next configuration line is a kind of trigger guard:
5695 .code
5696 never_users = root
5697 .endd
5698 It specifies that no delivery must ever be run as the root user. The normal
5699 convention is to set up &'root'& as an alias for the system administrator. This
5700 setting is a guard against slips in the configuration.
5701 The list of users specified by &%never_users%& is not, however, the complete
5702 list; the build-time configuration in &_Local/Makefile_& has an option called
5703 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5704 contents of &%never_users%& are added to this list. By default
5705 FIXED_NEVER_USERS also specifies root.
5706
5707 When a remote host connects to Exim in order to send mail, the only information
5708 Exim has about the host's identity is its IP address. The next configuration
5709 line,
5710 .code
5711 host_lookup = *
5712 .endd
5713 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5714 in order to get a host name. This improves the quality of the logging
5715 information, but if you feel it is too expensive, you can remove it entirely,
5716 or restrict the lookup to hosts on &"nearby"& networks.
5717 Note that it is not always possible to find a host name from an IP address,
5718 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5719 unreachable.
5720
5721 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5722 1413 (hence their names):
5723 .code
5724 rfc1413_hosts = *
5725 rfc1413_query_timeout = 0s
5726 .endd
5727 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5728 Few hosts offer RFC1413 service these days; calls have to be
5729 terminated by a timeout and this needlessly delays the startup
5730 of an incoming SMTP connection.
5731 If you have hosts for which you trust RFC1413 and need this
5732 information, you can change this.
5733
5734 This line enables an efficiency SMTP option.  It is negotiated by clients
5735 and not expected to cause problems but can be disabled if needed.
5736 .code
5737 prdr_enable = true
5738 .endd
5739
5740 When Exim receives messages over SMTP connections, it expects all addresses to
5741 be fully qualified with a domain, as required by the SMTP definition. However,
5742 if you are running a server to which simple clients submit messages, you may
5743 find that they send unqualified addresses. The two commented-out options:
5744 .code
5745 # sender_unqualified_hosts =
5746 # recipient_unqualified_hosts =
5747 .endd
5748 show how you can specify hosts that are permitted to send unqualified sender
5749 and recipient addresses, respectively.
5750
5751 The &%log_selector%& option is used to increase the detail of logging
5752 over the default:
5753 .code
5754 log_selector = +smtp_protocol_error +smtp_syntax_error \
5755                +tls_certificate_verified
5756 .endd
5757
5758 The &%percent_hack_domains%& option is also commented out:
5759 .code
5760 # percent_hack_domains =
5761 .endd
5762 It provides a list of domains for which the &"percent hack"& is to operate.
5763 This is an almost obsolete form of explicit email routing. If you do not know
5764 anything about it, you can safely ignore this topic.
5765
5766 The next two settings in the main part of the default configuration are
5767 concerned with messages that have been &"frozen"& on Exim's queue. When a
5768 message is frozen, Exim no longer continues to try to deliver it. Freezing
5769 occurs when a bounce message encounters a permanent failure because the sender
5770 address of the original message that caused the bounce is invalid, so the
5771 bounce cannot be delivered. This is probably the most common case, but there
5772 are also other conditions that cause freezing, and frozen messages are not
5773 always bounce messages.
5774 .code
5775 ignore_bounce_errors_after = 2d
5776 timeout_frozen_after = 7d
5777 .endd
5778 The first of these options specifies that failing bounce messages are to be
5779 discarded after 2 days in the queue. The second specifies that any frozen
5780 message (whether a bounce message or not) is to be timed out (and discarded)
5781 after a week. In this configuration, the first setting ensures that no failing
5782 bounce message ever lasts a week.
5783
5784 Exim queues it's messages in a spool directory. If you expect to have
5785 large queues, you may consider using this option. It splits the spool
5786 directory into subdirectories to avoid file system degradation from
5787 many files in a single directory, resulting in better performance.
5788 Manual manipulation of queued messages becomes more complex (though fortunately
5789 not often needed).
5790 .code
5791 # split_spool_directory = true
5792 .endd
5793
5794 In an ideal world everybody follows the standards. For non-ASCII
5795 messages RFC 2047 is a standard, allowing a maximum line length of 76
5796 characters. Exim adheres that standard and won't process messages which
5797 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5798 In particular, the Exim maintainers have had multiple reports of
5799 problems from Russian administrators of issues until they disable this
5800 check, because of some popular, yet buggy, mail composition software.
5801 .code
5802 # check_rfc2047_length = false
5803 .endd
5804
5805 If you need to be strictly RFC compliant you may wish to disable the
5806 8BITMIME advertisement. Use this, if you exchange mails with systems
5807 that are not 8-bit clean.
5808 .code
5809 # accept_8bitmime = false
5810 .endd
5811
5812 Libraries you use may depend on specific environment settings.  This
5813 imposes a security risk (e.g. PATH). There are two lists:
5814 &%keep_environment%& for the variables to import as they are, and
5815 &%add_environment%& for variables we want to set to a fixed value.
5816 Note that TZ is handled separately, by the $%timezone%$ runtime
5817 option and by the TIMEZONE_DEFAULT buildtime option.
5818 .code
5819 # keep_environment = ^LDAP
5820 # add_environment = PATH=/usr/bin::/bin
5821 .endd
5822
5823
5824 .section "ACL configuration" "SECID54"
5825 .cindex "default" "ACLs"
5826 .cindex "&ACL;" "default configuration"
5827 In the default configuration, the ACL section follows the main configuration.
5828 It starts with the line
5829 .code
5830 begin acl
5831 .endd
5832 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5833 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5834 and &%acl_smtp_data%& above.
5835
5836 .cindex "RCPT" "ACL for"
5837 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5838 RCPT command specifies one of the message's recipients. The ACL statements
5839 are considered in order, until the recipient address is either accepted or
5840 rejected. The RCPT command is then accepted or rejected, according to the
5841 result of the ACL processing.
5842 .code
5843 acl_check_rcpt:
5844 .endd
5845 This line, consisting of a name terminated by a colon, marks the start of the
5846 ACL, and names it.
5847 .code
5848 accept  hosts = :
5849 .endd
5850 This ACL statement accepts the recipient if the sending host matches the list.
5851 But what does that strange list mean? It doesn't actually contain any host
5852 names or IP addresses. The presence of the colon puts an empty item in the
5853 list; Exim matches this only if the incoming message did not come from a remote
5854 host, because in that case, the remote hostname is empty. The colon is
5855 important. Without it, the list itself is empty, and can never match anything.
5856
5857 What this statement is doing is to accept unconditionally all recipients in
5858 messages that are submitted by SMTP from local processes using the standard
5859 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5860 manner.
5861 .code
5862 deny    message       = Restricted characters in address
5863         domains       = +local_domains
5864         local_parts   = ^[.] : ^.*[@%!/|]
5865
5866 deny    message       = Restricted characters in address
5867         domains       = !+local_domains
5868         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5869 .endd
5870 These statements are concerned with local parts that contain any of the
5871 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5872 Although these characters are entirely legal in local parts (in the case of
5873 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5874 in Internet mail addresses.
5875
5876 The first three have in the past been associated with explicitly routed
5877 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5878 option). Addresses containing these characters are regularly tried by spammers
5879 in an attempt to bypass relaying restrictions, and also by open relay testing
5880 programs. Unless you really need them it is safest to reject these characters
5881 at this early stage. This configuration is heavy-handed in rejecting these
5882 characters for all messages it accepts from remote hosts. This is a deliberate
5883 policy of being as safe as possible.
5884
5885 The first rule above is stricter, and is applied to messages that are addressed
5886 to one of the local domains handled by this host. This is implemented by the
5887 first condition, which restricts it to domains that are listed in the
5888 &'local_domains'& domain list. The &"+"& character is used to indicate a
5889 reference to a named list. In this configuration, there is just one domain in
5890 &'local_domains'&, but in general there may be many.
5891
5892 The second condition on the first statement uses two regular expressions to
5893 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5894 or &"|"&. If you have local accounts that include these characters, you will
5895 have to modify this rule.
5896
5897 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5898 allows them because they have been encountered in practice. (Consider the
5899 common convention of local parts constructed as
5900 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5901 the author of Exim, who has no second initial.) However, a local part starting
5902 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5903 filename (for example, for a mailing list). This is also true for local parts
5904 that contain slashes. A pipe symbol can also be troublesome if the local part
5905 is incorporated unthinkingly into a shell command line.
5906
5907 The second rule above applies to all other domains, and is less strict. This
5908 allows your own users to send outgoing messages to sites that use slashes
5909 and vertical bars in their local parts. It blocks local parts that begin
5910 with a dot, slash, or vertical bar, but allows these characters within the
5911 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5912 and &"!"& is blocked, as before. The motivation here is to prevent your users
5913 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5914 .code
5915 accept  local_parts   = postmaster
5916         domains       = +local_domains
5917 .endd
5918 This statement, which has two conditions, accepts an incoming address if the
5919 local part is &'postmaster'& and the domain is one of those listed in the
5920 &'local_domains'& domain list. The &"+"& character is used to indicate a
5921 reference to a named list. In this configuration, there is just one domain in
5922 &'local_domains'&, but in general there may be many.
5923
5924 The presence of this statement means that mail to postmaster is never blocked
5925 by any of the subsequent tests. This can be helpful while sorting out problems
5926 in cases where the subsequent tests are incorrectly denying access.
5927 .code
5928 require verify        = sender
5929 .endd
5930 This statement requires the sender address to be verified before any subsequent
5931 ACL statement can be used. If verification fails, the incoming recipient
5932 address is refused. Verification consists of trying to route the address, to
5933 see if a bounce message could be delivered to it. In the case of remote
5934 addresses, basic verification checks only the domain, but &'callouts'& can be
5935 used for more verification if required. Section &<<SECTaddressverification>>&
5936 discusses the details of address verification.
5937 .code
5938 accept  hosts         = +relay_from_hosts
5939         control       = submission
5940 .endd
5941 This statement accepts the address if the message is coming from one of the
5942 hosts that are defined as being allowed to relay through this host. Recipient
5943 verification is omitted here, because in many cases the clients are dumb MUAs
5944 that do not cope well with SMTP error responses. For the same reason, the
5945 second line specifies &"submission mode"& for messages that are accepted. This
5946 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5947 messages that are deficient in some way, for example, because they lack a
5948 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5949 probably add recipient verification here, and disable submission mode.
5950 .code
5951 accept  authenticated = *
5952         control       = submission
5953 .endd
5954 This statement accepts the address if the client host has authenticated itself.
5955 Submission mode is again specified, on the grounds that such messages are most
5956 likely to come from MUAs. The default configuration does not define any
5957 authenticators, though it does include some nearly complete commented-out
5958 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5959 fact authenticate until you complete the authenticator definitions.
5960 .code
5961 require message = relay not permitted
5962         domains = +local_domains : +relay_to_domains
5963 .endd
5964 This statement rejects the address if its domain is neither a local domain nor
5965 one of the domains for which this host is a relay.
5966 .code
5967 require verify = recipient
5968 .endd
5969 This statement requires the recipient address to be verified; if verification
5970 fails, the address is rejected.
5971 .code
5972 # deny    message     = rejected because $sender_host_address \
5973 #                       is in a black list at $dnslist_domain\n\
5974 #                       $dnslist_text
5975 #         dnslists    = black.list.example
5976 #
5977 # warn    dnslists    = black.list.example
5978 #         add_header  = X-Warning: $sender_host_address is in \
5979 #                       a black list at $dnslist_domain
5980 #         log_message = found in $dnslist_domain
5981 .endd
5982 These commented-out lines are examples of how you could configure Exim to check
5983 sending hosts against a DNS black list. The first statement rejects messages
5984 from blacklisted hosts, whereas the second just inserts a warning header
5985 line.
5986 .code
5987 # require verify = csa
5988 .endd
5989 This commented-out line is an example of how you could turn on client SMTP
5990 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5991 records.
5992 .code
5993 accept
5994 .endd
5995 The final statement in the first ACL unconditionally accepts any recipient
5996 address that has successfully passed all the previous tests.
5997 .code
5998 acl_check_data:
5999 .endd
6000 This line marks the start of the second ACL, and names it. Most of the contents
6001 of this ACL are commented out:
6002 .code
6003 # deny    malware   = *
6004 #         message   = This message contains a virus \
6005 #                     ($malware_name).
6006 .endd
6007 These lines are examples of how to arrange for messages to be scanned for
6008 viruses when Exim has been compiled with the content-scanning extension, and a
6009 suitable virus scanner is installed. If the message is found to contain a
6010 virus, it is rejected with the given custom error message.
6011 .code
6012 # warn    spam      = nobody
6013 #         message   = X-Spam_score: $spam_score\n\
6014 #                     X-Spam_score_int: $spam_score_int\n\
6015 #                     X-Spam_bar: $spam_bar\n\
6016 #                     X-Spam_report: $spam_report
6017 .endd
6018 These lines are an example of how to arrange for messages to be scanned by
6019 SpamAssassin when Exim has been compiled with the content-scanning extension,
6020 and SpamAssassin has been installed. The SpamAssassin check is run with
6021 &`nobody`& as its user parameter, and the results are added to the message as a
6022 series of extra header line. In this case, the message is not rejected,
6023 whatever the spam score.
6024 .code
6025 accept
6026 .endd
6027 This final line in the DATA ACL accepts the message unconditionally.
6028
6029
6030 .section "Router configuration" "SECID55"
6031 .cindex "default" "routers"
6032 .cindex "routers" "default"
6033 The router configuration comes next in the default configuration, introduced
6034 by the line
6035 .code
6036 begin routers
6037 .endd
6038 Routers are the modules in Exim that make decisions about where to send
6039 messages. An address is passed to each router, in turn, until it is either
6040 accepted, or failed. This means that the order in which you define the routers
6041 matters. Each router is fully described in its own chapter later in this
6042 manual. Here we give only brief overviews.
6043 .code
6044 # domain_literal:
6045 #   driver = ipliteral
6046 #   domains = !+local_domains
6047 #   transport = remote_smtp
6048 .endd
6049 .cindex "domain literal" "default router"
6050 This router is commented out because the majority of sites do not want to
6051 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6052 you uncomment this router, you also need to uncomment the setting of
6053 &%allow_domain_literals%& in the main part of the configuration.
6054
6055 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6056 macro has been defined, per
6057 .code
6058 .ifdef ROUTER_SMARTHOST
6059 smarthost:
6060 #...
6061 .else
6062 dnslookup:
6063 #...
6064 .endif
6065 .endd
6066
6067 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6068 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6069 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6070 skip these routers because of the &%domains%& option.
6071
6072 .code
6073 smarthost:
6074   driver = manualroute
6075   domains = ! +local_domains
6076   transport = smarthost_smtp
6077   route_data = ROUTER_SMARTHOST
6078   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6079   no_more
6080 .endd
6081 This router only handles mail which is not to any local domains; this is
6082 specified by the line
6083 .code
6084 domains = ! +local_domains
6085 .endd
6086 The &%domains%& option lists the domains to which this router applies, but the
6087 exclamation mark is a negation sign, so the router is used only for domains
6088 that are not in the domain list called &'local_domains'& (which was defined at
6089 the start of the configuration). The plus sign before &'local_domains'&
6090 indicates that it is referring to a named list. Addresses in other domains are
6091 passed on to the following routers.
6092
6093 The name of the router driver is &(manualroute)& because we are manually
6094 specifying how mail should be routed onwards, instead of using DNS MX.
6095 While the name of this router instance is arbitrary, the &%driver%& option must
6096 be one of the driver modules that is in the Exim binary.
6097
6098 With no pre-conditions other than &%domains%&, all mail for non-local domains
6099 will be handled by this router, and the &%no_more%& setting will ensure that no
6100 other routers will be used for messages matching the pre-conditions.  See
6101 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6102 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6103 and the macro supplies the value; the address is then queued for the
6104 &(smarthost_smtp)& transport.
6105
6106 .code
6107 dnslookup:
6108   driver = dnslookup
6109   domains = ! +local_domains
6110   transport = remote_smtp
6111   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6112 .ifdef _HAVE_DNSSEC
6113   dnssec_request_domains = *
6114 .endif
6115   no_more
6116 .endd
6117 The &%domains%& option behaves as per smarthost, above.
6118
6119 The name of the router driver is &(dnslookup)&,
6120 and is specified by the &%driver%& option. Do not be confused by the fact that
6121 the name of this router instance is the same as the name of the driver. The
6122 instance name is arbitrary, but the name set in the &%driver%& option must be
6123 one of the driver modules that is in the Exim binary.
6124
6125 The &(dnslookup)& router routes addresses by looking up their domains in the
6126 DNS in order to obtain a list of hosts to which the address is routed. If the
6127 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6128 specified by the &%transport%& option. If the router does not find the domain
6129 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6130 the address fails and is bounced.
6131
6132 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6133 be entirely ignored. This option is present because a number of cases have been
6134 encountered where MX records in the DNS point to host names
6135 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6136 Completely ignoring these IP addresses causes Exim to fail to route the
6137 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6138 continue to try to deliver the message periodically until the address timed
6139 out.
6140 .code
6141 system_aliases:
6142   driver = redirect
6143   allow_fail
6144   allow_defer
6145   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6146 # user = exim
6147   file_transport = address_file
6148   pipe_transport = address_pipe
6149 .endd
6150 Control reaches this and subsequent routers only for addresses in the local
6151 domains. This router checks to see whether the local part is defined as an
6152 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6153 data that it looks up from that file. If no data is found for the local part,
6154 the value of the &%data%& option is empty, causing the address to be passed to
6155 the next router.
6156
6157 &_/etc/aliases_& is a conventional name for the system aliases file that is
6158 often used. That is why it is referenced by from the default configuration
6159 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6160 &_Local/Makefile_& before building Exim.
6161 .code
6162 userforward:
6163   driver = redirect
6164   check_local_user
6165 # local_part_suffix = +* : -*
6166 # local_part_suffix_optional
6167   file = $home/.forward
6168 # allow_filter
6169   no_verify
6170   no_expn
6171   check_ancestor
6172   file_transport = address_file
6173   pipe_transport = address_pipe
6174   reply_transport = address_reply
6175 .endd
6176 This is the most complicated router in the default configuration. It is another
6177 redirection router, but this time it is looking for forwarding data set up by
6178 individual users. The &%check_local_user%& setting specifies a check that the
6179 local part of the address is the login name of a local user. If it is not, the
6180 router is skipped. The two commented options that follow &%check_local_user%&,
6181 namely:
6182 .code
6183 # local_part_suffix = +* : -*
6184 # local_part_suffix_optional
6185 .endd
6186 .vindex "&$local_part_suffix$&"
6187 show how you can specify the recognition of local part suffixes. If the first
6188 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6189 by any sequence of characters, is removed from the local part and placed in the
6190 variable &$local_part_suffix$&. The second suffix option specifies that the
6191 presence of a suffix in the local part is optional. When a suffix is present,
6192 the check for a local login uses the local part with the suffix removed.
6193
6194 When a local user account is found, the file called &_.forward_& in the user's
6195 home directory is consulted. If it does not exist, or is empty, the router
6196 declines. Otherwise, the contents of &_.forward_& are interpreted as
6197 redirection data (see chapter &<<CHAPredirect>>& for more details).
6198
6199 .cindex "Sieve filter" "enabling in default router"
6200 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6201 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6202 is commented out by default), the contents of the file are interpreted as a set
6203 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6204 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6205 separate document entitled &'Exim's interfaces to mail filtering'&.
6206
6207 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6208 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6209 There are two reasons for doing this:
6210
6211 .olist
6212 Whether or not a local user has a &_.forward_& file is not really relevant when
6213 checking an address for validity; it makes sense not to waste resources doing
6214 unnecessary work.
6215 .next
6216 More importantly, when Exim is verifying addresses or handling an EXPN
6217 command during an SMTP session, it is running as the Exim user, not as root.
6218 The group is the Exim group, and no additional groups are set up.
6219 It may therefore not be possible for Exim to read users' &_.forward_& files at
6220 this time.
6221 .endlist
6222
6223 The setting of &%check_ancestor%& prevents the router from generating a new
6224 address that is the same as any previous address that was redirected. (This
6225 works round a problem concerning a bad interaction between aliasing and
6226 forwarding &-- see section &<<SECTredlocmai>>&).
6227
6228 The final three option settings specify the transports that are to be used when
6229 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6230 auto-reply, respectively. For example, if a &_.forward_& file contains
6231 .code
6232 a.nother@elsewhere.example, /home/spqr/archive
6233 .endd
6234 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6235 transport.
6236 .code
6237 localuser:
6238   driver = accept
6239   check_local_user
6240 # local_part_suffix = +* : -*
6241 # local_part_suffix_optional
6242   transport = local_delivery
6243 .endd
6244 The final router sets up delivery into local mailboxes, provided that the local
6245 part is the name of a local login, by accepting the address and assigning it to
6246 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6247 routers, so the address is bounced. The commented suffix settings fulfil the
6248 same purpose as they do for the &(userforward)& router.
6249
6250
6251 .section "Transport configuration" "SECID56"
6252 .cindex "default" "transports"
6253 .cindex "transports" "default"
6254 Transports define mechanisms for actually delivering messages. They operate
6255 only when referenced from routers, so the order in which they are defined does
6256 not matter. The transports section of the configuration starts with
6257 .code
6258 begin transports
6259 .endd
6260 Two remote transports and four local transports are defined.
6261 .code
6262 remote_smtp:
6263   driver = smtp
6264   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6265 .ifdef _HAVE_DANE
6266   hosts_try_dane = *
6267 .endif
6268 .ifdef _HAVE_PRDR
6269   hosts_try_prdr = *
6270 .endif
6271 .endd
6272 This transport is used for delivering messages over SMTP connections.
6273 The list of remote hosts comes from the router.
6274 The &%message_size_limit%& usage is a hack to avoid sending on messages
6275 with over-long lines.  The built-in macro _HAVE_DANE guards configuration
6276 to use DANE for delivery;
6277 see section &<<SECDANE>>& for more details.
6278
6279 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6280 negotiated between client and server and not expected to cause problems
6281 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6282 use of the &%hosts_try_prdr%& configuration option.
6283
6284 The other remote transport is used when delivering to a specific smarthost
6285 with whom there must be some kind of existing relationship, instead of the
6286 usual federated system.
6287
6288 .code
6289 smarthost_smtp:
6290   driver = smtp
6291   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6292   multi_domain
6293   #
6294 .ifdef _HAVE_TLS
6295   # Comment out any of these which you have to, then file a Support
6296   # request with your smarthost provider to get things fixed:
6297   hosts_require_tls = *
6298   tls_verify_hosts = *
6299   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6300   # have to comment it out then this will at least log whether you succeed
6301   # or not:
6302   tls_try_verify_hosts = *
6303   #
6304   # The SNI name should match the name which we'll expect to verify;
6305   # many mail systems don't use SNI and this doesn't matter, but if it does,
6306   # we need to send a name which the remote site will recognize.
6307   # This _should_ be the name which the smarthost operators specified as
6308   # the hostname for sending your mail to.
6309   tls_sni = ROUTER_SMARTHOST
6310   #
6311 .ifdef _HAVE_OPENSSL
6312   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6313 .endif
6314 .ifdef _HAVE_GNUTLS
6315   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6316 .endif
6317 .endif
6318 .ifdef _HAVE_PRDR
6319   hosts_try_prdr = *
6320 .endif
6321 .endd
6322 After the same &%message_size_limit%& hack, we then specify that this Transport
6323 can handle messages to multiple domains in one run.  The assumption here is
6324 that you're routing all non-local mail to the same place and that place is
6325 happy to take all messages from you as quickly as possible.
6326 All other options depend upon built-in macros; if Exim was built without TLS support
6327 then no other options are defined.
6328 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6329 and versions using the &%tls_require_ciphers%& option, where the value to be
6330 used depends upon the library providing TLS.
6331 Beyond that, the options adopt the stance that you should have TLS support available
6332 from your smarthost on today's Internet, so we turn on requiring TLS for the
6333 mail to be delivered, and requiring that the certificate be valid, and match
6334 the expected hostname.  The &%tls_sni%& option can be used by service providers
6335 to select an appropriate certificate to present to you and here we re-use the
6336 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6337 You want to specify the hostname which you'll expect to validate for, and that
6338 should not be subject to insecure tampering via DNS results.
6339
6340 For the &%hosts_try_prdr%& option see the previous transport.
6341
6342 All other options are defaulted.
6343 .code
6344 local_delivery:
6345   driver = appendfile
6346   file = /var/mail/$local_part
6347   delivery_date_add
6348   envelope_to_add
6349   return_path_add
6350 # group = mail
6351 # mode = 0660
6352 .endd
6353 This &(appendfile)& transport is used for local delivery to user mailboxes in
6354 traditional BSD mailbox format. By default it runs under the uid and gid of the
6355 local user, which requires the sticky bit to be set on the &_/var/mail_&
6356 directory. Some systems use the alternative approach of running mail deliveries
6357 under a particular group instead of using the sticky bit. The commented options
6358 show how this can be done.
6359
6360 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6361 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6362 similarly-named options above.
6363 .code
6364 address_pipe:
6365   driver = pipe
6366   return_output
6367 .endd
6368 This transport is used for handling deliveries to pipes that are generated by
6369 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6370 option specifies that any output on stdout or stderr generated by the pipe is to
6371 be returned to the sender.
6372 .code
6373 address_file:
6374   driver = appendfile
6375   delivery_date_add
6376   envelope_to_add
6377   return_path_add
6378 .endd
6379 This transport is used for handling deliveries to files that are generated by
6380 redirection. The name of the file is not specified in this instance of
6381 &(appendfile)&, because it comes from the &(redirect)& router.
6382 .code
6383 address_reply:
6384   driver = autoreply
6385 .endd
6386 This transport is used for handling automatic replies generated by users'
6387 filter files.
6388
6389
6390
6391 .section "Default retry rule" "SECID57"
6392 .cindex "retry" "default rule"
6393 .cindex "default" "retry rule"
6394 The retry section of the configuration file contains rules which affect the way
6395 Exim retries deliveries that cannot be completed at the first attempt. It is
6396 introduced by the line
6397 .code
6398 begin retry
6399 .endd
6400 In the default configuration, there is just one rule, which applies to all
6401 errors:
6402 .code
6403 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6404 .endd
6405 This causes any temporarily failing address to be retried every 15 minutes for
6406 2 hours, then at intervals starting at one hour and increasing by a factor of
6407 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6408 is not delivered after 4 days of temporary failure, it is bounced. The time is
6409 measured from first failure, not from the time the message was received.
6410
6411 If the retry section is removed from the configuration, or is empty (that is,
6412 if no retry rules are defined), Exim will not retry deliveries. This turns
6413 temporary errors into permanent errors.
6414
6415
6416 .section "Rewriting configuration" "SECID58"
6417 The rewriting section of the configuration, introduced by
6418 .code
6419 begin rewrite
6420 .endd
6421 contains rules for rewriting addresses in messages as they arrive. There are no
6422 rewriting rules in the default configuration file.
6423
6424
6425
6426 .section "Authenticators configuration" "SECTdefconfauth"
6427 .cindex "AUTH" "configuration"
6428 The authenticators section of the configuration, introduced by
6429 .code
6430 begin authenticators
6431 .endd
6432 defines mechanisms for the use of the SMTP AUTH command. The default
6433 configuration file contains two commented-out example authenticators
6434 which support plaintext username/password authentication using the
6435 standard PLAIN mechanism and the traditional but non-standard LOGIN
6436 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6437 to support most MUA software.
6438
6439 The example PLAIN authenticator looks like this:
6440 .code
6441 #PLAIN:
6442 #  driver                  = plaintext
6443 #  server_set_id           = $auth2
6444 #  server_prompts          = :
6445 #  server_condition        = Authentication is not yet configured
6446 #  server_advertise_condition = ${if def:tls_in_cipher }
6447 .endd
6448 And the example LOGIN authenticator looks like this:
6449 .code
6450 #LOGIN:
6451 #  driver                  = plaintext
6452 #  server_set_id           = $auth1
6453 #  server_prompts          = <| Username: | Password:
6454 #  server_condition        = Authentication is not yet configured
6455 #  server_advertise_condition = ${if def:tls_in_cipher }
6456 .endd
6457
6458 The &%server_set_id%& option makes Exim remember the authenticated username
6459 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6460 &%server_prompts%& option configures the &(plaintext)& authenticator so
6461 that it implements the details of the specific authentication mechanism,
6462 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6463 when Exim offers authentication to clients; in the examples, this is only
6464 when TLS or SSL has been started, so to enable the authenticators you also
6465 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6466
6467 The &%server_condition%& setting defines how to verify that the username and
6468 password are correct. In the examples it just produces an error message.
6469 To make the authenticators work, you can use a string expansion
6470 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6471
6472 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6473 usercode and password are in different positions.
6474 Chapter &<<CHAPplaintext>>& covers both.
6475
6476 .ecindex IIDconfiwal
6477
6478
6479
6480 . ////////////////////////////////////////////////////////////////////////////
6481 . ////////////////////////////////////////////////////////////////////////////
6482
6483 .chapter "Regular expressions" "CHAPregexp"
6484
6485 .cindex "regular expressions" "library"
6486 .cindex "PCRE"
6487 Exim supports the use of regular expressions in many of its options. It
6488 uses the PCRE regular expression library; this provides regular expression
6489 matching that is compatible with Perl 5. The syntax and semantics of
6490 regular expressions is discussed in
6491 online Perl manpages, in
6492 many Perl reference books, and also in
6493 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6494 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6495 . --- the http: URL here redirects to another page with the ISBN in the URL
6496 . --- where trying to use https: just redirects back to http:, so sticking
6497 . --- to the old URL for now.  2018-09-07.
6498
6499 The documentation for the syntax and semantics of the regular expressions that
6500 are supported by PCRE is included in the PCRE distribution, and no further
6501 description is included here. The PCRE functions are called from Exim using
6502 the default option settings (that is, with no PCRE options set), except that
6503 the PCRE_CASELESS option is set when the matching is required to be
6504 case-insensitive.
6505
6506 In most cases, when a regular expression is required in an Exim configuration,
6507 it has to start with a circumflex, in order to distinguish it from plain text
6508 or an &"ends with"& wildcard. In this example of a configuration setting, the
6509 second item in the colon-separated list is a regular expression.
6510 .code
6511 domains = a.b.c : ^\\d{3} : *.y.z : ...
6512 .endd
6513 The doubling of the backslash is required because of string expansion that
6514 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6515 of this issue, and a way of avoiding the need for doubling backslashes. The
6516 regular expression that is eventually used in this example contains just one
6517 backslash. The circumflex is included in the regular expression, and has the
6518 normal effect of &"anchoring"& it to the start of the string that is being
6519 matched.
6520
6521 There are, however, two cases where a circumflex is not required for the
6522 recognition of a regular expression: these are the &%match%& condition in a
6523 string expansion, and the &%matches%& condition in an Exim filter file. In
6524 these cases, the relevant string is always treated as a regular expression; if
6525 it does not start with a circumflex, the expression is not anchored, and can
6526 match anywhere in the subject string.
6527
6528 In all cases, if you want a regular expression to match at the end of a string,
6529 you must code the $ metacharacter to indicate this. For example:
6530 .code
6531 domains = ^\\d{3}\\.example
6532 .endd
6533 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6534 You need to use:
6535 .code
6536 domains = ^\\d{3}\\.example\$
6537 .endd
6538 if you want &'example'& to be the top-level domain. The backslash before the
6539 $ is needed because string expansion also interprets dollar characters.
6540
6541
6542
6543 . ////////////////////////////////////////////////////////////////////////////
6544 . ////////////////////////////////////////////////////////////////////////////
6545
6546 .chapter "File and database lookups" "CHAPfdlookup"
6547 .scindex IIDfidalo1 "file" "lookups"
6548 .scindex IIDfidalo2 "database" "lookups"
6549 .cindex "lookup" "description of"
6550 Exim can be configured to look up data in files or databases as it processes
6551 messages. Two different kinds of syntax are used:
6552
6553 .olist
6554 A string that is to be expanded may contain explicit lookup requests. These
6555 cause parts of the string to be replaced by data that is obtained from the
6556 lookup. Lookups of this type are conditional expansion items. Different results
6557 can be defined for the cases of lookup success and failure. See chapter
6558 &<<CHAPexpand>>&, where string expansions are described in detail.
6559 The key for the lookup is specified as part of the string expansion.
6560 .next
6561 Lists of domains, hosts, and email addresses can contain lookup requests as a
6562 way of avoiding excessively long linear lists. In this case, the data that is
6563 returned by the lookup is often (but not always) discarded; whether the lookup
6564 succeeds or fails is what really counts. These kinds of list are described in
6565 chapter &<<CHAPdomhosaddlists>>&.
6566 The key for the lookup is given by the context in which the list is expanded.
6567 .endlist
6568
6569 String expansions, lists, and lookups interact with each other in such a way
6570 that there is no order in which to describe any one of them that does not
6571 involve references to the others. Each of these three chapters makes more sense
6572 if you have read the other two first. If you are reading this for the first
6573 time, be aware that some of it will make a lot more sense after you have read
6574 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6575
6576 .section "Examples of different lookup syntax" "SECID60"
6577 It is easy to confuse the two different kinds of lookup, especially as the
6578 lists that may contain the second kind are always expanded before being
6579 processed as lists. Therefore, they may also contain lookups of the first kind.
6580 Be careful to distinguish between the following two examples:
6581 .code
6582 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6583 domains = lsearch;/some/file
6584 .endd
6585 The first uses a string expansion, the result of which must be a domain list.
6586 No strings have been specified for a successful or a failing lookup; the
6587 defaults in this case are the looked-up data and an empty string, respectively.
6588 The expansion takes place before the string is processed as a list, and the
6589 file that is searched could contain lines like this:
6590 .code
6591 192.168.3.4: domain1:domain2:...
6592 192.168.1.9: domain3:domain4:...
6593 .endd
6594 When the lookup succeeds, the result of the expansion is a list of domains (and
6595 possibly other types of item that are allowed in domain lists).
6596
6597 In the second example, the lookup is a single item in a domain list. It causes
6598 Exim to use a lookup to see if the domain that is being processed can be found
6599 in the file. The file could contains lines like this:
6600 .code
6601 domain1:
6602 domain2:
6603 .endd
6604 Any data that follows the keys is not relevant when checking that the domain
6605 matches the list item.
6606
6607 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6608 Consider a file containing lines like this:
6609 .code
6610 192.168.5.6: lsearch;/another/file
6611 .endd
6612 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6613 first &%domains%& setting above generates the second setting, which therefore
6614 causes a second lookup to occur.
6615
6616 The rest of this chapter describes the different lookup types that are
6617 available. Any of them can be used in any part of the configuration where a
6618 lookup is permitted.
6619
6620
6621 .section "Lookup types" "SECID61"
6622 .cindex "lookup" "types of"
6623 .cindex "single-key lookup" "definition of"
6624 Two different types of data lookup are implemented:
6625
6626 .ilist
6627 The &'single-key'& type requires the specification of a file in which to look,
6628 and a single key to search for. The key must be a non-empty string for the
6629 lookup to succeed. The lookup type determines how the file is searched.
6630 .next
6631 .cindex "query-style lookup" "definition of"
6632 The &'query-style'& type accepts a generalized database query. No particular
6633 key value is assumed by Exim for query-style lookups. You can use whichever
6634 Exim variables you need to construct the database query.
6635 .endlist
6636
6637 The code for each lookup type is in a separate source file that is included in
6638 the binary of Exim only if the corresponding compile-time option is set. The
6639 default settings in &_src/EDITME_& are:
6640 .code
6641 LOOKUP_DBM=yes
6642 LOOKUP_LSEARCH=yes
6643 .endd
6644 which means that only linear searching and DBM lookups are included by default.
6645 For some types of lookup (e.g. SQL databases), you need to install appropriate
6646 libraries and header files before building Exim.
6647
6648
6649
6650
6651 .section "Single-key lookup types" "SECTsinglekeylookups"
6652 .cindex "lookup" "single-key types"
6653 .cindex "single-key lookup" "list of types"
6654 The following single-key lookup types are implemented:
6655
6656 .ilist
6657 .cindex "cdb" "description of"
6658 .cindex "lookup" "cdb"
6659 .cindex "binary zero" "in lookup key"
6660 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6661 string without a terminating binary zero. The cdb format is designed for
6662 indexed files that are read frequently and never updated, except by total
6663 re-creation. As such, it is particularly suitable for large files containing
6664 aliases or other indexed data referenced by an MTA. Information about cdb and
6665 tools for building the files can be found in several places:
6666 .display
6667 &url(https://cr.yp.to/cdb.html)
6668 &url(http://www.corpit.ru/mjt/tinycdb.html)
6669 &url(https://packages.debian.org/stable/utils/freecdb)
6670 &url(https://github.com/philpennock/cdbtools) (in Go)
6671 .endd
6672 . --- 2018-09-07: corpit.ru http:-only
6673 A cdb distribution is not needed in order to build Exim with cdb support,
6674 because the code for reading cdb files is included directly in Exim itself.
6675 However, no means of building or testing cdb files is provided with Exim, so
6676 you need to obtain a cdb distribution in order to do this.
6677 .next
6678 .cindex "DBM" "lookup type"
6679 .cindex "lookup" "dbm"
6680 .cindex "binary zero" "in lookup key"
6681 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6682 DBM file by looking up the record with the given key. A terminating binary
6683 zero is included in the key that is passed to the DBM library. See section
6684 &<<SECTdb>>& for a discussion of DBM libraries.
6685
6686 .cindex "Berkeley DB library" "file format"
6687 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6688 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6689 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6690 the DB_UNKNOWN option. This enables it to handle any of the types of database
6691 that the library supports, and can be useful for accessing DBM files created by
6692 other applications. (For earlier DB versions, DB_HASH is always used.)
6693 .next
6694 .cindex "lookup" "dbmjz"
6695 .cindex "lookup" "dbm &-- embedded NULs"
6696 .cindex "sasldb2"
6697 .cindex "dbmjz lookup type"
6698 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6699 interpreted as an Exim list; the elements of the list are joined together with
6700 ASCII NUL characters to form the lookup key.  An example usage would be to
6701 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6702 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6703 &(cram_md5)& authenticator.
6704 .next
6705 .cindex "lookup" "dbmnz"
6706 .cindex "lookup" "dbm &-- terminating zero"
6707 .cindex "binary zero" "in lookup key"
6708 .cindex "Courier"
6709 .cindex "&_/etc/userdbshadow.dat_&"
6710 .cindex "dbmnz lookup type"
6711 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6712 is not included in the key that is passed to the DBM library. You may need this
6713 if you want to look up data in files that are created by or shared with some
6714 other application that does not use terminating zeros. For example, you need to
6715 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6716 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6717 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6718 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6719 .next
6720 .cindex "lookup" "dsearch"
6721 .cindex "dsearch lookup type"
6722 &(dsearch)&: The given file must be a directory; this is searched for an entry
6723 whose name is the key by calling the &[lstat()]& function. The key may not
6724 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6725 the lookup is the name of the entry, which may be a file, directory,
6726 symbolic link, or any other kind of directory entry. An example of how this
6727 lookup can be used to support virtual domains is given in section
6728 &<<SECTvirtualdomains>>&.
6729 .next
6730 .cindex "lookup" "iplsearch"
6731 .cindex "iplsearch lookup type"
6732 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6733 terminated by a colon or white space or the end of the line. The keys in the
6734 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6735 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6736 being interpreted as a key terminator. For example:
6737 .code
6738 1.2.3.4:           data for 1.2.3.4
6739 192.168.0.0/16:    data for 192.168.0.0/16
6740 "abcd::cdab":      data for abcd::cdab
6741 "abcd:abcd::/32"   data for abcd:abcd::/32
6742 .endd
6743 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6744 file is searched linearly, using the CIDR masks where present, until a matching
6745 key is found. The first key that matches is used; there is no attempt to find a
6746 &"best"& match. Apart from the way the keys are matched, the processing for
6747 &(iplsearch)& is the same as for &(lsearch)&.
6748
6749 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6750 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6751 lookup types support only literal keys.
6752
6753 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6754 the implicit key is the host's IP address rather than its name (see section
6755 &<<SECThoslispatsikey>>&).
6756
6757 .new
6758 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6759 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6760 notation before executing the lookup.)
6761 .wen
6762 .next
6763 .new
6764 .cindex lookup json
6765 .cindex json "lookup type"
6766 .cindex JSON expansions
6767 &(json)&: The given file is a text file with a JSON structure.
6768 An element of the structure is extracted, defined by the search key.
6769 The key is a list of subelement selectors
6770 (colon-separated by default but changeable in the usual way)
6771 which are applied in turn to select smaller and smaller portions
6772 of the JSON structure.
6773 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6774 nunbered array element is selected.
6775 Otherwise it must apply to a JSON object; the named element is selected.
6776 The final resulting element can be a simple JSON type or a JSON object
6777 or array; for the latter two a string-representation os the JSON
6778 is returned.
6779 For elements of type string, the returned value is de-quoted.
6780 .wen
6781 .next
6782 .cindex "linear search"
6783 .cindex "lookup" "lsearch"
6784 .cindex "lsearch lookup type"
6785 .cindex "case sensitivity" "in lsearch lookup"
6786 &(lsearch)&: The given file is a text file that is searched linearly for a
6787 line beginning with the search key, terminated by a colon or white space or the
6788 end of the line. The search is case-insensitive; that is, upper and lower case
6789 letters are treated as the same. The first occurrence of the key that is found
6790 in the file is used.
6791
6792 White space between the key and the colon is permitted. The remainder of the
6793 line, with leading and trailing white space removed, is the data. This can be
6794 continued onto subsequent lines by starting them with any amount of white
6795 space, but only a single space character is included in the data at such a
6796 junction. If the data begins with a colon, the key must be terminated by a
6797 colon, for example:
6798 .code
6799 baduser:  :fail:
6800 .endd
6801 Empty lines and lines beginning with # are ignored, even if they occur in the
6802 middle of an item. This is the traditional textual format of alias files. Note
6803 that the keys in an &(lsearch)& file are literal strings. There is no
6804 wildcarding of any kind.
6805
6806 .cindex "lookup" "lsearch &-- colons in keys"
6807 .cindex "white space" "in lsearch key"
6808 In most &(lsearch)& files, keys are not required to contain colons or #
6809 characters, or white space. However, if you need this feature, it is available.
6810 If a key begins with a doublequote character, it is terminated only by a
6811 matching quote (or end of line), and the normal escaping rules apply to its
6812 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6813 quoted keys (exactly as for unquoted keys). There is no special handling of
6814 quotes for the data part of an &(lsearch)& line.
6815
6816 .next
6817 .cindex "NIS lookup type"
6818 .cindex "lookup" "NIS"
6819 .cindex "binary zero" "in lookup key"
6820 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6821 the given key, without a terminating binary zero. There is a variant called
6822 &(nis0)& which does include the terminating binary zero in the key. This is
6823 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6824 aliases; the full map names must be used.
6825
6826 .next
6827 .cindex "wildlsearch lookup type"
6828 .cindex "lookup" "wildlsearch"
6829 .cindex "nwildlsearch lookup type"
6830 .cindex "lookup" "nwildlsearch"
6831 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6832 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6833 the file may be wildcarded. The difference between these two lookup types is
6834 that for &(wildlsearch)&, each key in the file is string-expanded before being
6835 used, whereas for &(nwildlsearch)&, no expansion takes place.
6836
6837 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6838 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6839 file that are regular expressions can be made case-sensitive by the use of
6840 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6841
6842 . ==== As this is a nested list, any displays it contains must be indented
6843 . ==== as otherwise they are too far to the left.
6844
6845 .olist
6846 The string may begin with an asterisk to mean &"ends with"&. For example:
6847 .code
6848     *.a.b.c       data for anything.a.b.c
6849     *fish         data for anythingfish
6850 .endd
6851 .next
6852 The string may begin with a circumflex to indicate a regular expression. For
6853 example, for &(wildlsearch)&:
6854 .code
6855     ^\N\d+\.a\.b\N    data for <digits>.a.b
6856 .endd
6857 Note the use of &`\N`& to disable expansion of the contents of the regular
6858 expression. If you are using &(nwildlsearch)&, where the keys are not
6859 string-expanded, the equivalent entry is:
6860 .code
6861     ^\d+\.a\.b        data for <digits>.a.b
6862 .endd
6863 The case-insensitive flag is set at the start of compiling the regular
6864 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6865 For example, to make the entire pattern case-sensitive:
6866 .code
6867     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6868 .endd
6869
6870 If the regular expression contains white space or colon characters, you must
6871 either quote it (see &(lsearch)& above), or represent these characters in other
6872 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6873 colon. This may be easier than quoting, because if you quote, you have to
6874 escape all the backslashes inside the quotes.
6875
6876 &*Note*&: It is not possible to capture substrings in a regular expression
6877 match for later use, because the results of all lookups are cached. If a lookup
6878 is repeated, the result is taken from the cache, and no actual pattern matching
6879 takes place. The values of all the numeric variables are unset after a
6880 &((n)wildlsearch)& match.
6881
6882 .next
6883 Although I cannot see it being of much use, the general matching function that
6884 is used to implement &((n)wildlsearch)& means that the string may begin with a
6885 lookup name terminated by a semicolon, and followed by lookup data. For
6886 example:
6887 .code
6888     cdb;/some/file  data for keys that match the file
6889 .endd
6890 The data that is obtained from the nested lookup is discarded.
6891 .endlist olist
6892
6893 Keys that do not match any of these patterns are interpreted literally. The
6894 continuation rules for the data are the same as for &(lsearch)&, and keys may
6895 be followed by optional colons.
6896
6897 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6898 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6899 lookup types support only literal keys.
6900
6901 .next
6902 .cindex "lookup" "spf"
6903 If Exim is built with SPF support, manual lookups can be done
6904 (as opposed to the standard ACL condition method.
6905 For details see section &<<SECSPF>>&.
6906 .endlist ilist
6907
6908
6909 .section "Query-style lookup types" "SECTquerystylelookups"
6910 .cindex "lookup" "query-style types"
6911 .cindex "query-style lookup" "list of types"
6912 The supported query-style lookup types are listed below. Further details about
6913 many of them are given in later sections.
6914
6915 .ilist
6916 .cindex "DNS" "as a lookup type"
6917 .cindex "lookup" "DNS"
6918 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6919 are given in the supplied query. The resulting data is the contents of the
6920 records. See section &<<SECTdnsdb>>&.
6921 .next
6922 .cindex "InterBase lookup type"
6923 .cindex "lookup" "InterBase"
6924 &(ibase)&: This does a lookup in an InterBase database.
6925 .next
6926 .cindex "LDAP" "lookup type"
6927 .cindex "lookup" "LDAP"
6928 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6929 returns attributes from a single entry. There is a variant called &(ldapm)&
6930 that permits values from multiple entries to be returned. A third variant
6931 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6932 any attribute values. See section &<<SECTldap>>&.
6933 .next
6934 .cindex "MySQL" "lookup type"
6935 .cindex "lookup" "MySQL"
6936 &(mysql)&: The format of the query is an SQL statement that is passed to a
6937 MySQL database. See section &<<SECTsql>>&.
6938 .next
6939 .cindex "NIS+ lookup type"
6940 .cindex "lookup" "NIS+"
6941 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6942 the field to be returned. See section &<<SECTnisplus>>&.
6943 .next
6944 .cindex "Oracle" "lookup type"
6945 .cindex "lookup" "Oracle"
6946 &(oracle)&: The format of the query is an SQL statement that is passed to an
6947 Oracle database. See section &<<SECTsql>>&.
6948 .next
6949 .cindex "lookup" "passwd"
6950 .cindex "passwd lookup type"
6951 .cindex "&_/etc/passwd_&"
6952 &(passwd)& is a query-style lookup with queries that are just user names. The
6953 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6954 success, the result string is the same as you would get from an &(lsearch)&
6955 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6956 password value. For example:
6957 .code
6958 *:42:42:King Rat:/home/kr:/bin/bash
6959 .endd
6960 .next
6961 .cindex "PostgreSQL lookup type"
6962 .cindex "lookup" "PostgreSQL"
6963 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6964 PostgreSQL database. See section &<<SECTsql>>&.
6965
6966 .next
6967 .cindex "Redis lookup type"
6968 .cindex lookup Redis
6969 &(redis)&: The format of the query is either a simple get or simple set,
6970 passed to a Redis database. See section &<<SECTsql>>&.
6971
6972 .next
6973 .cindex "sqlite lookup type"
6974 .cindex "lookup" "sqlite"
6975 &(sqlite)&: The format of the query is a filename followed by an SQL statement
6976 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6977
6978 .next
6979 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6980 not likely to be useful in normal operation.
6981 .next
6982 .cindex "whoson lookup type"
6983 .cindex "lookup" "whoson"
6984 . --- still http:-only, 2018-09-07
6985 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6986 allows a server to check whether a particular (dynamically allocated) IP
6987 address is currently allocated to a known (trusted) user and, optionally, to
6988 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6989 at one time for &"POP before SMTP"& authentication, but that approach has been
6990 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6991 &"POP before SMTP"& checking using ACL statements such as
6992 .code
6993 require condition = \
6994   ${lookup whoson {$sender_host_address}{yes}{no}}
6995 .endd
6996 The query consists of a single IP address. The value returned is the name of
6997 the authenticated user, which is stored in the variable &$value$&. However, in
6998 this example, the data in &$value$& is not used; the result of the lookup is
6999 one of the fixed strings &"yes"& or &"no"&.
7000 .endlist
7001
7002
7003
7004 .section "Temporary errors in lookups" "SECID63"
7005 .cindex "lookup" "temporary error in"
7006 Lookup functions can return temporary error codes if the lookup cannot be
7007 completed. For example, an SQL or LDAP database might be unavailable. For this
7008 reason, it is not advisable to use a lookup that might do this for critical
7009 options such as a list of local domains.
7010
7011 When a lookup cannot be completed in a router or transport, delivery
7012 of the message (to the relevant address) is deferred, as for any other
7013 temporary error. In other circumstances Exim may assume the lookup has failed,
7014 or may give up altogether.
7015
7016
7017
7018 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7019 .cindex "wildcard lookups"
7020 .cindex "lookup" "default values"
7021 .cindex "lookup" "wildcard"
7022 .cindex "lookup" "* added to type"
7023 .cindex "default" "in single-key lookups"
7024 In this context, a &"default value"& is a value specified by the administrator
7025 that is to be used if a lookup fails.
7026
7027 &*Note:*& This section applies only to single-key lookups. For query-style
7028 lookups, the facilities of the query language must be used. An attempt to
7029 specify a default for a query-style lookup provokes an error.
7030
7031 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7032 and the initial lookup fails, the key &"*"& is looked up in the file to
7033 provide a default value. See also the section on partial matching below.
7034
7035 .cindex "*@ with single-key lookup"
7036 .cindex "lookup" "*@ added to type"
7037 .cindex "alias file" "per-domain default"
7038 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7039 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7040 character, a second lookup is done with everything before the last @ replaced
7041 by *. This makes it possible to provide per-domain defaults in alias files
7042 that include the domains in the keys. If the second lookup fails (or doesn't
7043 take place because there is no @ in the key), &"*"& is looked up.
7044 For example, a &(redirect)& router might contain:
7045 .code
7046 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7047 .endd
7048 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7049 looks up these keys, in this order:
7050 .code
7051 jane@eyre.example
7052 *@eyre.example
7053 *
7054 .endd
7055 The data is taken from whichever key it finds first. &*Note*&: In an
7056 &(lsearch)& file, this does not mean the first of these keys in the file. A
7057 complete scan is done for each key, and only if it is not found at all does
7058 Exim move on to try the next key.
7059
7060
7061
7062 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7063 .cindex "partial matching"
7064 .cindex "wildcard lookups"
7065 .cindex "lookup" "partial matching"
7066 .cindex "lookup" "wildcard"
7067 .cindex "asterisk" "in search type"
7068 The normal operation of a single-key lookup is to search the file for an exact
7069 match with the given key. However, in a number of situations where domains are
7070 being looked up, it is useful to be able to do partial matching. In this case,
7071 information in the file that has a key starting with &"*."& is matched by any
7072 domain that ends with the components that follow the full stop. For example, if
7073 a key in a DBM file is
7074 .code
7075 *.dates.fict.example
7076 .endd
7077 then when partial matching is enabled this is matched by (amongst others)
7078 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7079 by &'dates.fict.example'&, if that does not appear as a separate key in the
7080 file.
7081
7082 &*Note*&: Partial matching is not available for query-style lookups. It is
7083 also not available for any lookup items in address lists (see section
7084 &<<SECTaddresslist>>&).
7085
7086 Partial matching is implemented by doing a series of separate lookups using
7087 keys constructed by modifying the original subject key. This means that it can
7088 be used with any of the single-key lookup types, provided that
7089 partial matching keys
7090 beginning with a special prefix (default &"*."&) are included in the data file.
7091 Keys in the file that do not begin with the prefix are matched only by
7092 unmodified subject keys when partial matching is in use.
7093
7094 Partial matching is requested by adding the string &"partial-"& to the front of
7095 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7096 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7097 is added at the start of the subject key, and it is looked up again. If that
7098 fails, further lookups are tried with dot-separated components removed from the
7099 start of the subject key, one-by-one, and &"*."& added on the front of what
7100 remains.
7101
7102 A minimum number of two non-* components are required. This can be adjusted
7103 by including a number before the hyphen in the search type. For example,
7104 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7105 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7106 subject key is &'2250.dates.fict.example'& then the following keys are looked
7107 up when the minimum number of non-* components is two:
7108 .code
7109 2250.dates.fict.example
7110 *.2250.dates.fict.example
7111 *.dates.fict.example
7112 *.fict.example
7113 .endd
7114 As soon as one key in the sequence is successfully looked up, the lookup
7115 finishes.
7116
7117 .cindex "lookup" "partial matching &-- changing prefix"
7118 .cindex "prefix" "for partial matching"
7119 The use of &"*."& as the partial matching prefix is a default that can be
7120 changed. The motivation for this feature is to allow Exim to operate with file
7121 formats that are used by other MTAs. A different prefix can be supplied in
7122 parentheses instead of the hyphen after &"partial"&. For example:
7123 .code
7124 domains = partial(.)lsearch;/some/file
7125 .endd
7126 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7127 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7128 components is unchanged). The prefix may consist of any punctuation characters
7129 other than a closing parenthesis. It may be empty, for example:
7130 .code
7131 domains = partial1()cdb;/some/file
7132 .endd
7133 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7134 &`a.b.c`&, &`b.c`&, and &`c`&.
7135
7136 If &"partial0"& is specified, what happens at the end (when the lookup with
7137 just one non-wild component has failed, and the original key is shortened right
7138 down to the null string) depends on the prefix:
7139
7140 .ilist
7141 If the prefix has zero length, the whole lookup fails.
7142 .next
7143 If the prefix has length 1, a lookup for just the prefix is done. For
7144 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7145 .next
7146 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7147 remainder is looked up. With the default prefix, therefore, the final lookup is
7148 for &"*"& on its own.
7149 .next
7150 Otherwise, the whole prefix is looked up.
7151 .endlist
7152
7153
7154 If the search type ends in &"*"& or &"*@"& (see section
7155 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7156 this implies happens after all partial lookups have failed. If &"partial0"& is
7157 specified, adding &"*"& to the search type has no effect with the default
7158 prefix, because the &"*"& key is already included in the sequence of partial
7159 lookups. However, there might be a use for lookup types such as
7160 &"partial0(.)lsearch*"&.
7161
7162 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7163 in domain lists and the like. Partial matching works only in terms of
7164 dot-separated components; a key such as &`*fict.example`&
7165 in a database file is useless, because the asterisk in a partial matching
7166 subject key is always followed by a dot.
7167
7168
7169
7170
7171 .section "Lookup caching" "SECID64"
7172 .cindex "lookup" "caching"
7173 .cindex "caching" "lookup data"
7174 Exim caches all lookup results in order to avoid needless repetition of
7175 lookups. However, because (apart from the daemon) Exim operates as a collection
7176 of independent, short-lived processes, this caching applies only within a
7177 single Exim process. There is no inter-process lookup caching facility.
7178
7179 For single-key lookups, Exim keeps the relevant files open in case there is
7180 another lookup that needs them. In some types of configuration this can lead to
7181 many files being kept open for messages with many recipients. To avoid hitting
7182 the operating system limit on the number of simultaneously open files, Exim
7183 closes the least recently used file when it needs to open more files than its
7184 own internal limit, which can be changed via the &%lookup_open_max%& option.
7185
7186 The single-key lookup files are closed and the lookup caches are flushed at
7187 strategic points during delivery &-- for example, after all routing is
7188 complete.
7189
7190
7191
7192
7193 .section "Quoting lookup data" "SECID65"
7194 .cindex "lookup" "quoting"
7195 .cindex "quoting" "in lookups"
7196 When data from an incoming message is included in a query-style lookup, there
7197 is the possibility of special characters in the data messing up the syntax of
7198 the query. For example, a NIS+ query that contains
7199 .code
7200 [name=$local_part]
7201 .endd
7202 will be broken if the local part happens to contain a closing square bracket.
7203 For NIS+, data can be enclosed in double quotes like this:
7204 .code
7205 [name="$local_part"]
7206 .endd
7207 but this still leaves the problem of a double quote in the data. The rule for
7208 NIS+ is that double quotes must be doubled. Other lookup types have different
7209 rules, and to cope with the differing requirements, an expansion operator
7210 of the following form is provided:
7211 .code
7212 ${quote_<lookup-type>:<string>}
7213 .endd
7214 For example, the safest way to write the NIS+ query is
7215 .code
7216 [name="${quote_nisplus:$local_part}"]
7217 .endd
7218 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7219 operator can be used for all lookup types, but has no effect for single-key
7220 lookups, since no quoting is ever needed in their key strings.
7221
7222
7223
7224
7225 .section "More about dnsdb" "SECTdnsdb"
7226 .cindex "dnsdb lookup"
7227 .cindex "lookup" "dnsdb"
7228 .cindex "DNS" "as a lookup type"
7229 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7230 of a record type and a domain name, separated by an equals sign. For example,
7231 an expansion string could contain:
7232 .code
7233 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7234 .endd
7235 If the lookup succeeds, the result is placed in &$value$&, which in this case
7236 is used on its own as the result. If the lookup does not succeed, the
7237 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7238 &<<SECTforexpfai>>& for an explanation of what this means.
7239
7240 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7241 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7242 If no type is given, TXT is assumed.
7243
7244 For any record type, if multiple records are found, the data is returned as a
7245 concatenation, with newline as the default separator. The order, of course,
7246 depends on the DNS resolver. You can specify a different separator character
7247 between multiple records by putting a right angle-bracket followed immediately
7248 by the new separator at the start of the query. For example:
7249 .code
7250 ${lookup dnsdb{>: a=host1.example}}
7251 .endd
7252 It is permitted to specify a space as the separator character. Further
7253 white space is ignored.
7254 For lookup types that return multiple fields per record,
7255 an alternate field separator can be specified using a comma after the main
7256 separator character, followed immediately by the field separator.
7257
7258 .cindex "PTR record" "in &(dnsdb)& lookup"
7259 When the type is PTR,
7260 the data can be an IP address, written as normal; inversion and the addition of
7261 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7262 .code
7263 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7264 .endd
7265 If the data for a PTR record is not a syntactically valid IP address, it is not
7266 altered and nothing is added.
7267
7268 .cindex "MX record" "in &(dnsdb)& lookup"
7269 .cindex "SRV record" "in &(dnsdb)& lookup"
7270 For an MX lookup, both the preference value and the host name are returned for
7271 each record, separated by a space. For an SRV lookup, the priority, weight,
7272 port, and host name are returned for each record, separated by spaces.
7273 The field separator can be modified as above.
7274
7275 .cindex "TXT record" "in &(dnsdb)& lookup"
7276 .cindex "SPF record" "in &(dnsdb)& lookup"
7277 For TXT records with multiple items of data, only the first item is returned,
7278 unless a field separator is specified.
7279 To concatenate items without a separator, use a semicolon instead.
7280 For SPF records the
7281 default behaviour is to concatenate multiple items without using a separator.
7282 .code
7283 ${lookup dnsdb{>\n,: txt=a.b.example}}
7284 ${lookup dnsdb{>\n; txt=a.b.example}}
7285 ${lookup dnsdb{spf=example.org}}
7286 .endd
7287 It is permitted to specify a space as the separator character. Further
7288 white space is ignored.
7289
7290 .cindex "SOA record" "in &(dnsdb)& lookup"
7291 For an SOA lookup, while no result is obtained the lookup is redone with
7292 successively more leading components dropped from the given domain.
7293 Only the primary-nameserver field is returned unless a field separator is
7294 specified.
7295 .code
7296 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7297 .endd
7298
7299 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7300 .cindex "dnsdb modifiers"
7301 .cindex "modifiers" "dnsdb"
7302 .cindex "options" "dnsdb"
7303 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7304 each followed by a comma,
7305 that may appear before the record type.
7306
7307 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7308 temporary DNS error for any of them, the behaviour is controlled by
7309 a defer-option modifier.
7310 The possible keywords are
7311 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7312 With &"strict"& behaviour, any temporary DNS error causes the
7313 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7314 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7315 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7316 error causes the whole lookup to defer only if none of the other lookups
7317 succeed. The default is &"lax"&, so the following lookups are equivalent:
7318 .code
7319 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7320 ${lookup dnsdb{a=one.host.com:two.host.com}}
7321 .endd
7322 Thus, in the default case, as long as at least one of the DNS lookups
7323 yields some data, the lookup succeeds.
7324
7325 .cindex "DNSSEC" "dns lookup"
7326 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7327 The possible keywords are
7328 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7329 With &"strict"& or &"lax"& DNSSEC information is requested
7330 with the lookup.
7331 With &"strict"& a response from the DNS resolver that
7332 is not labelled as authenticated data
7333 is treated as equivalent to a temporary DNS error.
7334 The default is &"never"&.
7335
7336 See also the &$lookup_dnssec_authenticated$& variable.
7337
7338 .cindex timeout "dns lookup"
7339 .cindex "DNS" timeout
7340 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7341 The form is &"retrans_VAL"& where VAL is an Exim time specification
7342 (e.g. &"5s"&).
7343 The default value is set by the main configuration option &%dns_retrans%&.
7344
7345 Retries for the dnsdb lookup can be controlled by a retry modifier.
7346 The form if &"retry_VAL"& where VAL is an integer.
7347 The default count is set by the main configuration option &%dns_retry%&.
7348
7349 .cindex caching "of dns lookup"
7350 .cindex TTL "of dns lookup"
7351 .cindex DNS TTL
7352 Dnsdb lookup results are cached within a single process (and its children).
7353 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7354 value of the set of returned DNS records.
7355
7356
7357 .section "Pseudo dnsdb record types" "SECID66"
7358 .cindex "MX record" "in &(dnsdb)& lookup"
7359 By default, both the preference value and the host name are returned for
7360 each MX record, separated by a space. If you want only host names, you can use
7361 the pseudo-type MXH:
7362 .code
7363 ${lookup dnsdb{mxh=a.b.example}}
7364 .endd
7365 In this case, the preference values are omitted, and just the host names are
7366 returned.
7367
7368 .cindex "name server for enclosing domain"
7369 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7370 records on the given domain, but if none are found, it removes the first
7371 component of the domain name, and tries again. This process continues until NS
7372 records are found or there are no more components left (or there is a DNS
7373 error). In other words, it may return the name servers for a top-level domain,
7374 but it never returns the root name servers. If there are no NS records for the
7375 top-level domain, the lookup fails. Consider these examples:
7376 .code
7377 ${lookup dnsdb{zns=xxx.quercite.com}}
7378 ${lookup dnsdb{zns=xxx.edu}}
7379 .endd
7380 Assuming that in each case there are no NS records for the full domain name,
7381 the first returns the name servers for &%quercite.com%&, and the second returns
7382 the name servers for &%edu%&.
7383
7384 You should be careful about how you use this lookup because, unless the
7385 top-level domain does not exist, the lookup always returns some host names. The
7386 sort of use to which this might be put is for seeing if the name servers for a
7387 given domain are on a blacklist. You can probably assume that the name servers
7388 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7389 such a list.
7390
7391 .cindex "CSA" "in &(dnsdb)& lookup"
7392 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7393 records according to the CSA rules, which are described in section
7394 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7395 not sufficient because of the extra parent domain search behaviour of CSA. The
7396 result of a successful lookup such as:
7397 .code
7398 ${lookup dnsdb {csa=$sender_helo_name}}
7399 .endd
7400 has two space-separated fields: an authorization code and a target host name.
7401 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7402 authorization required but absent, or &"?"& for unknown.
7403
7404 .cindex "A+" "in &(dnsdb)& lookup"
7405 The pseudo-type A+ performs an AAAA
7406 and then an A lookup.  All results are returned; defer processing
7407 (see below) is handled separately for each lookup.  Example:
7408 .code
7409 ${lookup dnsdb {>; a+=$sender_helo_name}}
7410 .endd
7411
7412
7413 .section "Multiple dnsdb lookups" "SECID67"
7414 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7415 However, you can specify a list of domains or IP addresses in a single
7416 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7417 the default separator, but with the ability to change this. For example:
7418 .code
7419 ${lookup dnsdb{one.domain.com:two.domain.com}}
7420 ${lookup dnsdb{a=one.host.com:two.host.com}}
7421 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7422 .endd
7423 In order to retain backwards compatibility, there is one special case: if
7424 the lookup type is PTR and no change of separator is specified, Exim looks
7425 to see if the rest of the string is precisely one IPv6 address. In this
7426 case, it does not treat it as a list.
7427
7428 The data from each lookup is concatenated, with newline separators by default,
7429 in the same way that multiple DNS records for a single item are handled. A
7430 different separator can be specified, as described above.
7431
7432
7433
7434
7435 .section "More about LDAP" "SECTldap"
7436 .cindex "LDAP" "lookup, more about"
7437 .cindex "lookup" "LDAP"
7438 .cindex "Solaris" "LDAP"
7439 The original LDAP implementation came from the University of Michigan; this has
7440 become &"Open LDAP"&, and there are now two different releases. Another
7441 implementation comes from Netscape, and Solaris 7 and subsequent releases
7442 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7443 the lookup function level, their error handling is different. For this reason
7444 it is necessary to set a compile-time variable when building Exim with LDAP, to
7445 indicate which LDAP library is in use. One of the following should appear in
7446 your &_Local/Makefile_&:
7447 .code
7448 LDAP_LIB_TYPE=UMICHIGAN
7449 LDAP_LIB_TYPE=OPENLDAP1
7450 LDAP_LIB_TYPE=OPENLDAP2
7451 LDAP_LIB_TYPE=NETSCAPE
7452 LDAP_LIB_TYPE=SOLARIS
7453 .endd
7454 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7455 same interface as the University of Michigan version.
7456
7457 There are three LDAP lookup types in Exim. These behave slightly differently in
7458 the way they handle the results of a query:
7459
7460 .ilist
7461 &(ldap)& requires the result to contain just one entry; if there are more, it
7462 gives an error.
7463 .next
7464 &(ldapdn)& also requires the result to contain just one entry, but it is the
7465 Distinguished Name that is returned rather than any attribute values.
7466 .next
7467 &(ldapm)& permits the result to contain more than one entry; the attributes
7468 from all of them are returned.
7469 .endlist
7470
7471
7472 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7473 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7474 the data returned by a successful lookup is described in the next section.
7475 First we explain how LDAP queries are coded.
7476
7477
7478 .section "Format of LDAP queries" "SECTforldaque"
7479 .cindex "LDAP" "query format"
7480 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7481 the configuration of a &(redirect)& router one might have this setting:
7482 .code
7483 data = ${lookup ldap \
7484   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7485   c=UK?mailbox?base?}}
7486 .endd
7487 .cindex "LDAP" "with TLS"
7488 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7489 secure (encrypted) LDAP connections. The second of these ensures that an
7490 encrypted TLS connection is used.
7491
7492 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7493 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7494 See the &%ldap_start_tls%& option.
7495
7496 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7497 controlled. Every part of the TLS configuration can be configured by settings in
7498 &_exim.conf_&. Depending on the version of the client libraries installed on
7499 your system, some of the initialization may have required setting options in
7500 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7501 certificates. This revealed a nuance where the current UID that exim was
7502 running as could affect which config files it read. With Exim 4.83, these
7503 methods become optional, only taking effect if not specifically set in
7504 &_exim.conf_&.
7505
7506
7507 .section "LDAP quoting" "SECID68"
7508 .cindex "LDAP" "quoting"
7509 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7510 and the second because the LDAP query is represented as a URL. Furthermore,
7511 within an LDAP query, two different kinds of quoting are required. For this
7512 reason, there are two different LDAP-specific quoting operators.
7513
7514 The &%quote_ldap%& operator is designed for use on strings that are part of
7515 filter specifications. Conceptually, it first does the following conversions on
7516 the string:
7517 .code
7518 *   =>   \2A
7519 (   =>   \28
7520 )   =>   \29
7521 \   =>   \5C
7522 .endd
7523 in accordance with RFC 2254. The resulting string is then quoted according
7524 to the rules for URLs, that is, all non-alphanumeric characters except
7525 .code
7526 ! $ ' - . _ ( ) * +
7527 .endd
7528 are converted to their hex values, preceded by a percent sign. For example:
7529 .code
7530 ${quote_ldap: a(bc)*, a<yz>; }
7531 .endd
7532 yields
7533 .code
7534 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7535 .endd
7536 Removing the URL quoting, this is (with a leading and a trailing space):
7537 .code
7538 a\28bc\29\2A, a<yz>;
7539 .endd
7540 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7541 base DN specifications in queries. Conceptually, it first converts the string
7542 by inserting a backslash in front of any of the following characters:
7543 .code
7544 , + " \ < > ;
7545 .endd
7546 It also inserts a backslash before any leading spaces or # characters, and
7547 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7548 is then quoted according to the rules for URLs. For example:
7549 .code
7550 ${quote_ldap_dn: a(bc)*, a<yz>; }
7551 .endd
7552 yields
7553 .code
7554 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7555 .endd
7556 Removing the URL quoting, this is (with a trailing space):
7557 .code
7558 \ a(bc)*\, a\<yz\>\;\
7559 .endd
7560 There are some further comments about quoting in the section on LDAP
7561 authentication below.
7562
7563
7564 .section "LDAP connections" "SECID69"
7565 .cindex "LDAP" "connections"
7566 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7567 is in use, via a Unix domain socket. The example given above does not specify
7568 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7569 by starting it with
7570 .code
7571 ldap://<hostname>:<port>/...
7572 .endd
7573 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7574 used. When no server is specified in a query, a list of default servers is
7575 taken from the &%ldap_default_servers%& configuration option. This supplies a
7576 colon-separated list of servers which are tried in turn until one successfully
7577 handles a query, or there is a serious error. Successful handling either
7578 returns the requested data, or indicates that it does not exist. Serious errors
7579 are syntactical, or multiple values when only a single value is expected.
7580 Errors which cause the next server to be tried are connection failures, bind
7581 failures, and timeouts.
7582
7583 For each server name in the list, a port number can be given. The standard way
7584 of specifying a host and port is to use a colon separator (RFC 1738). Because
7585 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7586 doubled. For example
7587 .code
7588 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7589 .endd
7590 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7591 to the LDAP library with no server name, and the library's default (normally
7592 the local host) is used.
7593
7594 If you are using the OpenLDAP library, you can connect to an LDAP server using
7595 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7596 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7597 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7598 not available.
7599
7600 For this type of connection, instead of a host name for the server, a pathname
7601 for the socket is required, and the port number is not relevant. The pathname
7602 can be specified either as an item in &%ldap_default_servers%&, or inline in
7603 the query. In the former case, you can have settings such as
7604 .code
7605 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7606 .endd
7607 When the pathname is given in the query, you have to escape the slashes as
7608 &`%2F`& to fit in with the LDAP URL syntax. For example:
7609 .code
7610 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7611 .endd
7612 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7613 a pathname, it uses the Unix domain socket code, even if the query actually
7614 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7615 socket connection. This behaviour means that you can use a setting of
7616 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7617 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7618 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7619 backup host.
7620
7621 If an explicit &`ldapi`& type is given in a query when a host name is
7622 specified, an error is diagnosed. However, if there are more items in
7623 &%ldap_default_servers%&, they are tried. In other words:
7624
7625 .ilist
7626 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7627 interface.
7628 .next
7629 Using &`ldapi`& with a host name causes an error.
7630 .endlist
7631
7632
7633 Using &`ldapi`& with no host or path in the query, and no setting of
7634 &%ldap_default_servers%&, does whatever the library does by default.
7635
7636
7637
7638 .section "LDAP authentication and control information" "SECID70"
7639 .cindex "LDAP" "authentication"
7640 The LDAP URL syntax provides no way of passing authentication and other control
7641 information to the server. To make this possible, the URL in an LDAP query may
7642 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7643 spaces. If a value contains spaces it must be enclosed in double quotes, and
7644 when double quotes are used, backslash is interpreted in the usual way inside
7645 them. The following names are recognized:
7646 .display
7647 &`DEREFERENCE`&  set the dereferencing parameter
7648 &`NETTIME    `&  set a timeout for a network operation
7649 &`USER       `&  set the DN, for authenticating the LDAP bind
7650 &`PASS       `&  set the password, likewise
7651 &`REFERRALS  `&  set the referrals parameter
7652 &`SERVERS    `&  set alternate server list for this query only
7653 &`SIZE       `&  set the limit for the number of entries returned
7654 &`TIME       `&  set the maximum waiting time for a query
7655 .endd
7656 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7657 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7658 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7659 library from trying to follow referrals issued by the LDAP server.
7660
7661 .cindex LDAP timeout
7662 .cindex timeout "LDAP lookup"
7663 The name CONNECT is an obsolete name for NETTIME, retained for
7664 backwards compatibility. This timeout (specified as a number of seconds) is
7665 enforced from the client end for operations that can be carried out over a
7666 network. Specifically, it applies to network connections and calls to the
7667 &'ldap_result()'& function. If the value is greater than zero, it is used if
7668 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7669 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7670 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7671 Netscape SDK; for OpenLDAP no action is taken.
7672
7673 The TIME parameter (also a number of seconds) is passed to the server to
7674 set a server-side limit on the time taken to complete a search.
7675
7676 The SERVERS parameter allows you to specify an alternate list of ldap servers
7677 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7678 default list of ldap servers, and a single lookup can specify a single ldap
7679 server to use.  But when you need to do a lookup with a list of servers that is
7680 different than the default list (maybe different order, maybe a completely
7681 different set of servers), the SERVERS parameter allows you to specify this
7682 alternate list (colon-separated).
7683
7684 Here is an example of an LDAP query in an Exim lookup that uses some of these
7685 values. This is a single line, folded to fit on the page:
7686 .code
7687 ${lookup ldap
7688   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7689   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7690   {$value}fail}
7691 .endd
7692 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7693 any of the auxiliary data. Exim configuration settings that include lookups
7694 which contain password information should be preceded by &"hide"& to prevent
7695 non-admin users from using the &%-bP%& option to see their values.
7696
7697 The auxiliary data items may be given in any order. The default is no
7698 connection timeout (the system timeout is used), no user or password, no limit
7699 on the number of entries returned, and no time limit on queries.
7700
7701 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7702 removes any URL quoting that it may contain before passing it LDAP. Apparently
7703 some libraries do this for themselves, but some do not. Removing the URL
7704 quoting has two advantages:
7705
7706 .ilist
7707 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7708 DNs as with DNs inside actual queries.
7709 .next
7710 It permits spaces inside USER= DNs.
7711 .endlist
7712
7713 For example, a setting such as
7714 .code
7715 USER=cn=${quote_ldap_dn:$1}
7716 .endd
7717 should work even if &$1$& contains spaces.
7718
7719 Expanded data for the PASS= value should be quoted using the &%quote%&
7720 expansion operator, rather than the LDAP quote operators. The only reason this
7721 field needs quoting is to ensure that it conforms to the Exim syntax, which
7722 does not allow unquoted spaces. For example:
7723 .code
7724 PASS=${quote:$3}
7725 .endd
7726 The LDAP authentication mechanism can be used to check passwords as part of
7727 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7728 &<<CHAPexpand>>&.
7729
7730
7731
7732 .section "Format of data returned by LDAP" "SECID71"
7733 .cindex "LDAP" "returned data formats"
7734 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7735 as a sequence of values, for example
7736 .code
7737 cn=manager,o=University of Cambridge,c=UK
7738 .endd
7739 The &(ldap)& lookup type generates an error if more than one entry matches the
7740 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7741 the result between the data from different entries. It is possible for multiple
7742 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7743 you know that whatever values are returned all came from a single entry in the
7744 directory.
7745
7746 In the common case where you specify a single attribute in your LDAP query, the
7747 result is not quoted, and does not contain the attribute name. If the attribute
7748 has multiple values, they are separated by commas. Any comma that is
7749 part of an attribute's value is doubled.
7750
7751 If you specify multiple attributes, the result contains space-separated, quoted
7752 strings, each preceded by the attribute name and an equals sign. Within the
7753 quotes, the quote character, backslash, and newline are escaped with
7754 backslashes, and commas are used to separate multiple values for the attribute.
7755 Any commas in attribute values are doubled
7756 (permitting treatment of the values as a comma-separated list).
7757 Apart from the escaping, the string within quotes takes the same form as the
7758 output when a single attribute is requested. Specifying no attributes is the
7759 same as specifying all of an entry's attributes.
7760
7761 Here are some examples of the output format. The first line of each pair is an
7762 LDAP query, and the second is the data that is returned. The attribute called
7763 &%attr1%& has two values, one of them with an embedded comma, whereas
7764 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7765 (they have SUP &%attr%& in their schema definitions).
7766
7767 .code
7768 ldap:///o=base?attr1?sub?(uid=fred)
7769 value1.1,value1,,2
7770
7771 ldap:///o=base?attr2?sub?(uid=fred)
7772 value two
7773
7774 ldap:///o=base?attr?sub?(uid=fred)
7775 value1.1,value1,,2,value two
7776
7777 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7778 attr1="value1.1,value1,,2" attr2="value two"
7779
7780 ldap:///o=base??sub?(uid=fred)
7781 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7782 .endd
7783 You can
7784 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7785 results of LDAP lookups.
7786 The &%extract%& operator in string expansions can be used to pick out
7787 individual fields from data that consists of &'key'&=&'value'& pairs.
7788 The &%listextract%& operator should be used to pick out individual values
7789 of attributes, even when only a single value is expected.
7790 The doubling of embedded commas allows you to use the returned data as a
7791 comma separated list (using the "<," syntax for changing the input list separator).
7792
7793
7794
7795
7796 .section "More about NIS+" "SECTnisplus"
7797 .cindex "NIS+ lookup type"
7798 .cindex "lookup" "NIS+"
7799 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7800 and field name. If this is given, the result of a successful query is the
7801 contents of the named field; otherwise the result consists of a concatenation
7802 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7803 values containing spaces are quoted. For example, the query
7804 .code
7805 [name=mg1456],passwd.org_dir
7806 .endd
7807 might return the string
7808 .code
7809 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7810 home=/home/mg1456 shell=/bin/bash shadow=""
7811 .endd
7812 (split over two lines here to fit on the page), whereas
7813 .code
7814 [name=mg1456],passwd.org_dir:gcos
7815 .endd
7816 would just return
7817 .code
7818 Martin Guerre
7819 .endd
7820 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7821 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7822 operator is to double any quote characters within the text.
7823
7824
7825
7826 .section "SQL lookups" "SECTsql"
7827 .cindex "SQL lookup types"
7828 .cindex "MySQL" "lookup type"
7829 .cindex "PostgreSQL lookup type"
7830 .cindex "lookup" "MySQL"
7831 .cindex "lookup" "PostgreSQL"
7832 .cindex "Oracle" "lookup type"
7833 .cindex "lookup" "Oracle"
7834 .cindex "InterBase lookup type"
7835 .cindex "lookup" "InterBase"
7836 .cindex "Redis lookup type"
7837 .cindex lookup Redis
7838 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7839 and SQLite
7840 databases. Queries for these databases contain SQL statements, so an example
7841 might be
7842 .code
7843 ${lookup mysql{select mailbox from users where id='userx'}\
7844   {$value}fail}
7845 .endd
7846 If the result of the query contains more than one field, the data for each
7847 field in the row is returned, preceded by its name, so the result of
7848 .code
7849 ${lookup pgsql{select home,name from users where id='userx'}\
7850   {$value}}
7851 .endd
7852 might be
7853 .code
7854 home=/home/userx name="Mister X"
7855 .endd
7856 Empty values and values containing spaces are double quoted, with embedded
7857 quotes escaped by a backslash. If the result of the query contains just one
7858 field, the value is passed back verbatim, without a field name, for example:
7859 .code
7860 Mister X
7861 .endd
7862 If the result of the query yields more than one row, it is all concatenated,
7863 with a newline between the data for each row.
7864
7865
7866 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7867 .cindex "MySQL" "lookup type"
7868 .cindex "PostgreSQL lookup type"
7869 .cindex "lookup" "MySQL"
7870 .cindex "lookup" "PostgreSQL"
7871 .cindex "Oracle" "lookup type"
7872 .cindex "lookup" "Oracle"
7873 .cindex "InterBase lookup type"
7874 .cindex "lookup" "InterBase"
7875 .cindex "Redis lookup type"
7876 .cindex lookup Redis
7877 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7878 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7879 or &%redis_servers%&
7880 option (as appropriate) must be set to a colon-separated list of server
7881 information.
7882 (For MySQL and PostgreSQL, the global option need not be set if all
7883 queries contain their own server information &-- see section
7884 &<<SECTspeserque>>&.)
7885 For all but Redis
7886 each item in the list is a slash-separated list of four
7887 items: host name, database name, user name, and password. In the case of
7888 Oracle, the host name field is used for the &"service name"&, and the database
7889 name field is not used and should be empty. For example:
7890 .code
7891 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7892 .endd
7893 Because password data is sensitive, you should always precede the setting with
7894 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7895 option. Here is an example where two MySQL servers are listed:
7896 .code
7897 hide mysql_servers = localhost/users/root/secret:\
7898                      otherhost/users/root/othersecret
7899 .endd
7900 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7901 because this is a colon-separated list, the colon has to be doubled. For each
7902 query, these parameter groups are tried in order until a connection is made and
7903 a query is successfully processed. The result of a query may be that no data is
7904 found, but that is still a successful query. In other words, the list of
7905 servers provides a backup facility, not a list of different places to look.
7906
7907 For Redis the global option need not be specified if all queries contain their
7908 own server information &-- see section &<<SECTspeserque>>&.
7909 If specified, the option must be set to a colon-separated list of server
7910 information.
7911 Each item in the list is a slash-separated list of three items:
7912 host, database number, and password.
7913 .olist
7914 The host is required and may be either an IPv4 address and optional
7915 port number (separated by a colon, which needs doubling due to the
7916 higher-level list), or a Unix socket pathname enclosed in parentheses
7917 .next
7918 The database number is optional; if present that number is selected in the backend
7919 .next
7920 The password is optional; if present it is used to authenticate to the backend
7921 .endlist
7922
7923 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7924 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7925 respectively, and the characters single-quote, double-quote, and backslash
7926 itself are escaped with backslashes.
7927
7928 The &%quote_redis%& expansion operator
7929 escapes whitespace and backslash characters with a backslash.
7930
7931 .section "Specifying the server in the query" "SECTspeserque"
7932 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7933 it is possible to specify a list of servers with an individual query. This is
7934 done by starting the query with
7935 .display
7936 &`servers=`&&'server1:server2:server3:...'&&`;`&
7937 .endd
7938 Each item in the list may take one of two forms:
7939 .olist
7940 If it contains no slashes it is assumed to be just a host name. The appropriate
7941 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7942 of the same name, and the remaining parameters (database, user, password) are
7943 taken from there.
7944 .next
7945 If it contains any slashes, it is taken as a complete parameter set.
7946 .endlist
7947 The list of servers is used in exactly the same way as the global list.
7948 Once a connection to a server has happened and a query has been
7949 successfully executed, processing of the lookup ceases.
7950
7951 This feature is intended for use in master/slave situations where updates
7952 are occurring and you want to update the master rather than a slave. If the
7953 master is in the list as a backup for reading, you might have a global setting
7954 like this:
7955 .code
7956 mysql_servers = slave1/db/name/pw:\
7957                 slave2/db/name/pw:\
7958                 master/db/name/pw
7959 .endd
7960 In an updating lookup, you could then write:
7961 .code
7962 ${lookup mysql{servers=master; UPDATE ...} }
7963 .endd
7964 That query would then be sent only to the master server. If, on the other hand,
7965 the master is not to be used for reading, and so is not present in the global
7966 option, you can still update it by a query of this form:
7967 .code
7968 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7969 .endd
7970
7971
7972 .section "Special MySQL features" "SECID73"
7973 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7974 causes a connection to the server on the local host by means of a Unix domain
7975 socket. An alternate socket can be specified in parentheses.
7976 An option group name for MySQL option files can be specified in square brackets;
7977 the default value is &"exim"&.
7978 The full syntax of each item in &%mysql_servers%& is:
7979 .display
7980 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7981   <&'database'&>/<&'user'&>/<&'password'&>
7982 .endd
7983 Any of the four sub-parts of the first field can be omitted. For normal use on
7984 the local host it can be left blank or set to just &"localhost"&.
7985
7986 No database need be supplied &-- but if it is absent here, it must be given in
7987 the queries.
7988
7989 If a MySQL query is issued that does not request any data (an insert, update,
7990 or delete command), the result of the lookup is the number of rows affected.
7991
7992 &*Warning*&: This can be misleading. If an update does not actually change
7993 anything (for example, setting a field to the value it already has), the result
7994 is zero because no rows are affected.
7995
7996
7997 .section "Special PostgreSQL features" "SECID74"
7998 PostgreSQL lookups can also use Unix domain socket connections to the database.
7999 This is usually faster and costs less CPU time than a TCP/IP connection.
8000 However it can be used only if the mail server runs on the same machine as the
8001 database server. A configuration line for PostgreSQL via Unix domain sockets
8002 looks like this:
8003 .code
8004 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8005 .endd
8006 In other words, instead of supplying a host name, a path to the socket is
8007 given. The path name is enclosed in parentheses so that its slashes aren't
8008 visually confused with the delimiters for the other server parameters.
8009
8010 If a PostgreSQL query is issued that does not request any data (an insert,
8011 update, or delete command), the result of the lookup is the number of rows
8012 affected.
8013
8014 .section "More about SQLite" "SECTsqlite"
8015 .cindex "lookup" "SQLite"
8016 .cindex "sqlite lookup type"
8017 SQLite is different to the other SQL lookups because a filename is required in
8018 addition to the SQL query. An SQLite database is a single file, and there is no
8019 daemon as in the other SQL databases. The interface to Exim requires the name
8020 of the file, as an absolute path, to be given at the start of the query. It is
8021 separated from the query by white space. This means that the path name cannot
8022 contain white space. Here is a lookup expansion example:
8023 .code
8024 ${lookup sqlite {/some/thing/sqlitedb \
8025   select name from aliases where id='userx';}}
8026 .endd
8027 In a list, the syntax is similar. For example:
8028 .code
8029 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8030    select * from relays where ip='$sender_host_address';
8031 .endd
8032 The only character affected by the &%quote_sqlite%& operator is a single
8033 quote, which it doubles.
8034
8035 .cindex timeout SQLite
8036 .cindex sqlite "lookup timeout"
8037 The SQLite library handles multiple simultaneous accesses to the database
8038 internally. Multiple readers are permitted, but only one process can
8039 update at once. Attempts to access the database while it is being updated
8040 are rejected after a timeout period, during which the SQLite library
8041 waits for the lock to be released. In Exim, the default timeout is set
8042 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8043 option.
8044
8045 .section "More about Redis" "SECTredis"
8046 .cindex "lookup" "Redis"
8047 .cindex "redis lookup type"
8048 Redis is a non-SQL database. Commands are simple get and set.
8049 Examples:
8050 .code
8051 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8052 ${lookup redis{get keyname}}
8053 .endd
8054
8055 As of release 4.91, "lightweight" support for Redis Cluster is available.
8056 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8057 of which must be reachable from the running exim instance. If the cluster has
8058 master/slave replication, the list must contain all the master and slave
8059 servers.
8060
8061 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8062 immediately follow the redirection but treats the response as a DEFER, moving on
8063 to the next server in the &%redis_servers%& list until the correct server is
8064 reached.
8065
8066 .ecindex IIDfidalo1
8067 .ecindex IIDfidalo2
8068
8069
8070 . ////////////////////////////////////////////////////////////////////////////
8071 . ////////////////////////////////////////////////////////////////////////////
8072
8073 .chapter "Domain, host, address, and local part lists" &&&
8074          "CHAPdomhosaddlists" &&&
8075          "Domain, host, and address lists"
8076 .scindex IIDdohoadli "lists of domains; hosts; etc."
8077 A number of Exim configuration options contain lists of domains, hosts,
8078 email addresses, or local parts. For example, the &%hold_domains%& option
8079 contains a list of domains whose delivery is currently suspended. These lists
8080 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8081 arguments to expansion conditions such as &%match_domain%&.
8082
8083 Each item in one of these lists is a pattern to be matched against a domain,
8084 host, email address, or local part, respectively. In the sections below, the
8085 different types of pattern for each case are described, but first we cover some
8086 general facilities that apply to all four kinds of list.
8087
8088 Note that other parts of Exim use a &'string list'& which does not
8089 support all the complexity available in
8090 domain, host, address and local part lists.
8091
8092
8093
8094 .section "Expansion of lists" "SECTlistexpand"
8095 .cindex "expansion" "of lists"
8096 Each list is expanded as a single string before it is used.
8097
8098 &'Exception: the router headers_remove option, where list-item
8099 splitting is done before string-expansion.'&
8100
8101 The result of
8102 expansion must be a list, possibly containing empty items, which is split up
8103 into separate items for matching. By default, colon is the separator character,
8104 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8105 &<<SECTempitelis>>& for details of the list syntax; the second of these
8106 discusses the way to specify empty list items.
8107
8108
8109 If the string expansion is forced to fail, Exim behaves as if the item it is
8110 testing (domain, host, address, or local part) is not in the list. Other
8111 expansion failures cause temporary errors.
8112
8113 If an item in a list is a regular expression, backslashes, dollars and possibly
8114 other special characters in the expression must be protected against
8115 misinterpretation by the string expander. The easiest way to do this is to use
8116 the &`\N`& expansion feature to indicate that the contents of the regular
8117 expression should not be expanded. For example, in an ACL you might have:
8118 .code
8119 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8120                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8121 .endd
8122 The first item is a regular expression that is protected from expansion by
8123 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8124 senders based on the receiving domain.
8125
8126
8127
8128
8129 .section "Negated items in lists" "SECID76"
8130 .cindex "list" "negation"
8131 .cindex "negation" "in lists"
8132 Items in a list may be positive or negative. Negative items are indicated by a
8133 leading exclamation mark, which may be followed by optional white space. A list
8134 defines a set of items (domains, etc). When Exim processes one of these lists,
8135 it is trying to find out whether a domain, host, address, or local part
8136 (respectively) is in the set that is defined by the list. It works like this:
8137
8138 The list is scanned from left to right. If a positive item is matched, the
8139 subject that is being checked is in the set; if a negative item is matched, the
8140 subject is not in the set. If the end of the list is reached without the
8141 subject having matched any of the patterns, it is in the set if the last item
8142 was a negative one, but not if it was a positive one. For example, the list in
8143 .code
8144 domainlist relay_to_domains = !a.b.c : *.b.c
8145 .endd
8146 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8147 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8148 list is positive. However, if the setting were
8149 .code
8150 domainlist relay_to_domains = !a.b.c
8151 .endd
8152 then all domains other than &'a.b.c'& would match because the last item in the
8153 list is negative. In other words, a list that ends with a negative item behaves
8154 as if it had an extra item &`:*`& on the end.
8155
8156 Another way of thinking about positive and negative items in lists is to read
8157 the connector as &"or"& after a positive item and as &"and"& after a negative
8158 item.
8159
8160
8161
8162 .section "File names in lists" "SECTfilnamlis"
8163 .cindex "list" "filename in"
8164 If an item in a domain, host, address, or local part list is an absolute
8165 filename (beginning with a slash character), each line of the file is read and
8166 processed as if it were an independent item in the list, except that further
8167 filenames are not allowed,
8168 and no expansion of the data from the file takes place.
8169 Empty lines in the file are ignored, and the file may also contain comment
8170 lines:
8171
8172 .ilist
8173 For domain and host lists, if a # character appears anywhere in a line of the
8174 file, it and all following characters are ignored.
8175 .next
8176 Because local parts may legitimately contain # characters, a comment in an
8177 address list or local part list file is recognized only if # is preceded by
8178 white space or the start of the line. For example:
8179 .code
8180 not#comment@x.y.z   # but this is a comment
8181 .endd
8182 .endlist
8183
8184 Putting a filename in a list has the same effect as inserting each line of the
8185 file as an item in the list (blank lines and comments excepted). However, there
8186 is one important difference: the file is read each time the list is processed,
8187 so if its contents vary over time, Exim's behaviour changes.
8188
8189 If a filename is preceded by an exclamation mark, the sense of any match
8190 within the file is inverted. For example, if
8191 .code
8192 hold_domains = !/etc/nohold-domains
8193 .endd
8194 and the file contains the lines
8195 .code
8196 !a.b.c
8197 *.b.c
8198 .endd
8199 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8200 any domain matching &`*.b.c`& is not.
8201
8202
8203
8204 .section "An lsearch file is not an out-of-line list" "SECID77"
8205 As will be described in the sections that follow, lookups can be used in lists
8206 to provide indexed methods of checking list membership. There has been some
8207 confusion about the way &(lsearch)& lookups work in lists. Because
8208 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8209 sometimes thought that it is allowed to contain wild cards and other kinds of
8210 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8211 always fixed strings, just as for any other single-key lookup type.
8212
8213 If you want to use a file to contain wild-card patterns that form part of a
8214 list, just give the filename on its own, without a search type, as described
8215 in the previous section. You could also use the &(wildlsearch)& or
8216 &(nwildlsearch)&, but there is no advantage in doing this.
8217
8218
8219
8220
8221 .section "Named lists" "SECTnamedlists"
8222 .cindex "named lists"
8223 .cindex "list" "named"
8224 A list of domains, hosts, email addresses, or local parts can be given a name
8225 which is then used to refer to the list elsewhere in the configuration. This is
8226 particularly convenient if the same list is required in several different
8227 places. It also allows lists to be given meaningful names, which can improve
8228 the readability of the configuration. For example, it is conventional to define
8229 a domain list called &'local_domains'& for all the domains that are handled
8230 locally on a host, using a configuration line such as
8231 .code
8232 domainlist local_domains = localhost:my.dom.example
8233 .endd
8234 Named lists are referenced by giving their name preceded by a plus sign, so,
8235 for example, a router that is intended to handle local domains would be
8236 configured with the line
8237 .code
8238 domains = +local_domains
8239 .endd
8240 The first router in a configuration is often one that handles all domains
8241 except the local ones, using a configuration with a negated item like this:
8242 .code
8243 dnslookup:
8244   driver = dnslookup
8245   domains = ! +local_domains
8246   transport = remote_smtp
8247   no_more
8248 .endd
8249 The four kinds of named list are created by configuration lines starting with
8250 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8251 respectively. Then there follows the name that you are defining, followed by an
8252 equals sign and the list itself. For example:
8253 .code
8254 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8255 addresslist bad_senders = cdb;/etc/badsenders
8256 .endd
8257 A named list may refer to other named lists:
8258 .code
8259 domainlist  dom1 = first.example : second.example
8260 domainlist  dom2 = +dom1 : third.example
8261 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8262 .endd
8263 &*Warning*&: If the last item in a referenced list is a negative one, the
8264 effect may not be what you intended, because the negation does not propagate
8265 out to the higher level. For example, consider:
8266 .code
8267 domainlist  dom1 = !a.b
8268 domainlist  dom2 = +dom1 : *.b
8269 .endd
8270 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8271 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8272 means it matches the second list as well. The effect is not the same as
8273 .code
8274 domainlist  dom2 = !a.b : *.b
8275 .endd
8276 where &'x.y'& does not match. It's best to avoid negation altogether in
8277 referenced lists if you can.
8278
8279 Named lists may have a performance advantage. When Exim is routing an
8280 address or checking an incoming message, it caches the result of tests on named
8281 lists. So, if you have a setting such as
8282 .code
8283 domains = +local_domains
8284 .endd
8285 on several of your routers
8286 or in several ACL statements,
8287 the actual test is done only for the first one. However, the caching works only
8288 if there are no expansions within the list itself or any sublists that it
8289 references. In other words, caching happens only for lists that are known to be
8290 the same each time they are referenced.
8291
8292 By default, there may be up to 16 named lists of each type. This limit can be
8293 extended by changing a compile-time variable. The use of domain and host lists
8294 is recommended for concepts such as local domains, relay domains, and relay
8295 hosts. The default configuration is set up like this.
8296
8297
8298
8299 .section "Named lists compared with macros" "SECID78"
8300 .cindex "list" "named compared with macro"
8301 .cindex "macro" "compared with named list"
8302 At first sight, named lists might seem to be no different from macros in the
8303 configuration file. However, macros are just textual substitutions. If you
8304 write
8305 .code
8306 ALIST = host1 : host2
8307 auth_advertise_hosts = !ALIST
8308 .endd
8309 it probably won't do what you want, because that is exactly the same as
8310 .code
8311 auth_advertise_hosts = !host1 : host2
8312 .endd
8313 Notice that the second host name is not negated. However, if you use a host
8314 list, and write
8315 .code
8316 hostlist alist = host1 : host2
8317 auth_advertise_hosts = ! +alist
8318 .endd
8319 the negation applies to the whole list, and so that is equivalent to
8320 .code
8321 auth_advertise_hosts = !host1 : !host2
8322 .endd
8323
8324
8325 .section "Named list caching" "SECID79"
8326 .cindex "list" "caching of named"
8327 .cindex "caching" "named lists"
8328 While processing a message, Exim caches the result of checking a named list if
8329 it is sure that the list is the same each time. In practice, this means that
8330 the cache operates only if the list contains no $ characters, which guarantees
8331 that it will not change when it is expanded. Sometimes, however, you may have
8332 an expanded list that you know will be the same each time within a given
8333 message. For example:
8334 .code
8335 domainlist special_domains = \
8336            ${lookup{$sender_host_address}cdb{/some/file}}
8337 .endd
8338 This provides a list of domains that depends only on the sending host's IP
8339 address. If this domain list is referenced a number of times (for example,
8340 in several ACL lines, or in several routers) the result of the check is not
8341 cached by default, because Exim does not know that it is going to be the
8342 same list each time.
8343
8344 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8345 cache the result anyway. For example:
8346 .code
8347 domainlist_cache special_domains = ${lookup{...
8348 .endd
8349 If you do this, you should be absolutely sure that caching is going to do
8350 the right thing in all cases. When in doubt, leave it out.
8351
8352
8353
8354 .section "Domain lists" "SECTdomainlist"
8355 .cindex "domain list" "patterns for"
8356 .cindex "list" "domain list"
8357 Domain lists contain patterns that are to be matched against a mail domain.
8358 The following types of item may appear in domain lists:
8359
8360 .ilist
8361 .cindex "primary host name"
8362 .cindex "host name" "matched in domain list"
8363 .oindex "&%primary_hostname%&"
8364 .cindex "domain list" "matching primary host name"
8365 .cindex "@ in a domain list"
8366 If a pattern consists of a single @ character, it matches the local host name,
8367 as set by the &%primary_hostname%& option (or defaulted). This makes it
8368 possible to use the same configuration file on several different hosts that
8369 differ only in their names.
8370 .next
8371 .cindex "@[] in a domain list"
8372 .cindex "domain list" "matching local IP interfaces"
8373 .cindex "domain literal"
8374 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8375 in square brackets (as in an email address that contains a domain literal), but
8376 only if that IP address is recognized as local for email routing purposes. The
8377 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8378 control which of a host's several IP addresses are treated as local.
8379 In today's Internet, the use of domain literals is controversial.
8380 .next
8381 .cindex "@mx_any"
8382 .cindex "@mx_primary"
8383 .cindex "@mx_secondary"
8384 .cindex "domain list" "matching MX pointers to local host"
8385 If a pattern consists of the string &`@mx_any`& it matches any domain that
8386 has an MX record pointing to the local host or to any host that is listed in
8387 .oindex "&%hosts_treat_as_local%&"
8388 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8389 are similar, except that the first matches only when a primary MX target is the
8390 local host, and the second only when no primary MX target is the local host,
8391 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8392 preference value &-- there may of course be more than one of them.
8393
8394 The MX lookup that takes place when matching a pattern of this type is
8395 performed with the resolver options for widening names turned off. Thus, for
8396 example, a single-component domain will &'not'& be expanded by adding the
8397 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8398 options of the &(dnslookup)& router for a discussion of domain widening.
8399
8400 Sometimes you may want to ignore certain IP addresses when using one of these
8401 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8402 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8403 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8404 on a router). For example:
8405 .code
8406 domains = @mx_any/ignore=127.0.0.1
8407 .endd
8408 This example matches any domain that has an MX record pointing to one of
8409 the local host's IP addresses other than 127.0.0.1.
8410
8411 The list of IP addresses is in fact processed by the same code that processes
8412 host lists, so it may contain CIDR-coded network specifications and it may also
8413 contain negative items.
8414
8415 Because the list of IP addresses is a sublist within a domain list, you have to
8416 be careful about delimiters if there is more than one address. Like any other
8417 list, the default delimiter can be changed. Thus, you might have:
8418 .code
8419 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8420           an.other.domain : ...
8421 .endd
8422 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8423 involved, it is easiest to change the delimiter for the main list as well:
8424 .code
8425 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8426           an.other.domain ? ...
8427 .endd
8428 .next
8429 .cindex "asterisk" "in domain list"
8430 .cindex "domain list" "asterisk in"
8431 .cindex "domain list" "matching &""ends with""&"
8432 If a pattern starts with an asterisk, the remaining characters of the pattern
8433 are compared with the terminating characters of the domain. The use of &"*"& in
8434 domain lists differs from its use in partial matching lookups. In a domain
8435 list, the character following the asterisk need not be a dot, whereas partial
8436 matching works only in terms of dot-separated components. For example, a domain
8437 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8438 &'cipher.key.ex'&.
8439
8440 .next
8441 .cindex "regular expressions" "in domain list"
8442 .cindex "domain list" "matching regular expression"
8443 If a pattern starts with a circumflex character, it is treated as a regular
8444 expression, and matched against the domain using a regular expression matching
8445 function. The circumflex is treated as part of the regular expression.
8446 Email domains are case-independent, so this regular expression match is by
8447 default case-independent, but you can make it case-dependent by starting it
8448 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8449 are given in chapter &<<CHAPregexp>>&.
8450
8451 &*Warning*&: Because domain lists are expanded before being processed, you
8452 must escape any backslash and dollar characters in the regular expression, or
8453 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8454 it is not to be expanded (unless you really do want to build a regular
8455 expression by expansion, of course).
8456 .next
8457 .cindex "lookup" "in domain list"
8458 .cindex "domain list" "matching by lookup"
8459 If a pattern starts with the name of a single-key lookup type followed by a
8460 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8461 must be a filename in a suitable format for the lookup type. For example, for
8462 &"cdb;"& it must be an absolute path:
8463 .code
8464 domains = cdb;/etc/mail/local_domains.cdb
8465 .endd
8466 The appropriate type of lookup is done on the file using the domain name as the
8467 key. In most cases, the data that is looked up is not used; Exim is interested
8468 only in whether or not the key is present in the file. However, when a lookup
8469 is used for the &%domains%& option on a router
8470 or a &%domains%& condition in an ACL statement, the data is preserved in the
8471 &$domain_data$& variable and can be referred to in other router options or
8472 other statements in the same ACL.
8473
8474 .next
8475 Any of the single-key lookup type names may be preceded by
8476 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8477 .code
8478 domains = partial-dbm;/partial/domains
8479 .endd
8480 This causes partial matching logic to be invoked; a description of how this
8481 works is given in section &<<SECTpartiallookup>>&.
8482
8483 .next
8484 .cindex "asterisk" "in lookup type"
8485 Any of the single-key lookup types may be followed by an asterisk. This causes
8486 a default lookup for a key consisting of a single asterisk to be done if the
8487 original lookup fails. This is not a useful feature when using a domain list to
8488 select particular domains (because any domain would match), but it might have
8489 value if the result of the lookup is being used via the &$domain_data$&
8490 expansion variable.
8491 .next
8492 If the pattern starts with the name of a query-style lookup type followed by a
8493 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8494 pattern must be an appropriate query for the lookup type, as described in
8495 chapter &<<CHAPfdlookup>>&. For example:
8496 .code
8497 hold_domains = mysql;select domain from holdlist \
8498   where domain = '${quote_mysql:$domain}';
8499 .endd
8500 In most cases, the data that is looked up is not used (so for an SQL query, for
8501 example, it doesn't matter what field you select). Exim is interested only in
8502 whether or not the query succeeds. However, when a lookup is used for the
8503 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8504 variable and can be referred to in other options.
8505 .next
8506 .cindex "domain list" "matching literal domain name"
8507 If none of the above cases apply, a caseless textual comparison is made
8508 between the pattern and the domain.
8509 .endlist
8510
8511 Here is an example that uses several different kinds of pattern:
8512 .code
8513 domainlist funny_domains = \
8514   @ : \
8515   lib.unseen.edu : \
8516   *.foundation.fict.example : \
8517   \N^[1-2]\d{3}\.fict\.example$\N : \
8518   partial-dbm;/opt/data/penguin/book : \
8519   nis;domains.byname : \
8520   nisplus;[name=$domain,status=local],domains.org_dir
8521 .endd
8522 There are obvious processing trade-offs among the various matching modes. Using
8523 an asterisk is faster than a regular expression, and listing a few names
8524 explicitly probably is too. The use of a file or database lookup is expensive,
8525 but may be the only option if hundreds of names are required. Because the
8526 patterns are tested in order, it makes sense to put the most commonly matched
8527 patterns earlier.
8528
8529
8530
8531 .section "Host lists" "SECThostlist"
8532 .cindex "host list" "patterns in"
8533 .cindex "list" "host list"
8534 Host lists are used to control what remote hosts are allowed to do. For
8535 example, some hosts may be allowed to use the local host as a relay, and some
8536 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8537 two different ways, by name or by IP address. In a host list, some types of
8538 pattern are matched to a host name, and some are matched to an IP address.
8539 You need to be particularly careful with this when single-key lookups are
8540 involved, to ensure that the right value is being used as the key.
8541
8542
8543 .section "Special host list patterns" "SECID80"
8544 .cindex "empty item in hosts list"
8545 .cindex "host list" "empty string in"
8546 If a host list item is the empty string, it matches only when no remote host is
8547 involved. This is the case when a message is being received from a local
8548 process using SMTP on the standard input, that is, when a TCP/IP connection is
8549 not used.
8550
8551 .cindex "asterisk" "in host list"
8552 The special pattern &"*"& in a host list matches any host or no host. Neither
8553 the IP address nor the name is actually inspected.
8554
8555
8556
8557 .section "Host list patterns that match by IP address" "SECThoslispatip"
8558 .cindex "host list" "matching IP addresses"
8559 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8560 the incoming address actually appears in the IPv6 host as
8561 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8562 list, it is converted into a traditional IPv4 address first. (Not all operating
8563 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8564 concerns.)
8565
8566 The following types of pattern in a host list check the remote host by
8567 inspecting its IP address:
8568
8569 .ilist
8570 If the pattern is a plain domain name (not a regular expression, not starting
8571 with *, not a lookup of any kind), Exim calls the operating system function
8572 to find the associated IP address(es). Exim uses the newer
8573 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8574 This typically causes a forward DNS lookup of the name. The result is compared
8575 with the IP address of the subject host.
8576
8577 If there is a temporary problem (such as a DNS timeout) with the host name
8578 lookup, a temporary error occurs. For example, if the list is being used in an
8579 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8580 temporary SMTP error code. If no IP address can be found for the host name,
8581 what happens is described in section &<<SECTbehipnot>>& below.
8582
8583 .next
8584 .cindex "@ in a host list"
8585 If the pattern is &"@"&, the primary host name is substituted and used as a
8586 domain name, as just described.
8587
8588 .next
8589 If the pattern is an IP address, it is matched against the IP address of the
8590 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8591 IPv6 addresses can be given in colon-separated format, but the colons have to
8592 be doubled so as not to be taken as item separators when the default list
8593 separator is used. IPv6 addresses are recognized even when Exim is compiled
8594 without IPv6 support. This means that if they appear in a host list on an
8595 IPv4-only host, Exim will not treat them as host names. They are just addresses
8596 that can never match a client host.
8597
8598 .next
8599 .cindex "@[] in a host list"
8600 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8601 the local host. For example, if the local host is an IPv4 host with one
8602 interface address 10.45.23.56, these two ACL statements have the same effect:
8603 .code
8604 accept hosts = 127.0.0.1 : 10.45.23.56
8605 accept hosts = @[]
8606 .endd
8607 .next
8608 .cindex "CIDR notation"
8609 If the pattern is an IP address followed by a slash and a mask length (for
8610 example 10.11.42.0/24), it is matched against the IP address of the subject
8611 host under the given mask. This allows, an entire network of hosts to be
8612 included (or excluded) by a single item. The mask uses CIDR notation; it
8613 specifies the number of address bits that must match, starting from the most
8614 significant end of the address.
8615
8616 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8617 of a range of addresses. It is the number of bits in the network portion of the
8618 address. The above example specifies a 24-bit netmask, so it matches all 256
8619 addresses in the 10.11.42.0 network. An item such as
8620 .code
8621 192.168.23.236/31
8622 .endd
8623 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8624 32 for an IPv4 address is the same as no mask at all; just a single address
8625 matches.
8626
8627 Here is another example which shows an IPv4 and an IPv6 network:
8628 .code
8629 recipient_unqualified_hosts = 192.168.0.0/16: \
8630                               3ffe::ffff::836f::::/48
8631 .endd
8632 The doubling of list separator characters applies only when these items
8633 appear inline in a host list. It is not required when indirecting via a file.
8634 For example:
8635 .code
8636 recipient_unqualified_hosts = /opt/exim/unqualnets
8637 .endd
8638 could make use of a file containing
8639 .code
8640 172.16.0.0/12
8641 3ffe:ffff:836f::/48
8642 .endd
8643 to have exactly the same effect as the previous example. When listing IPv6
8644 addresses inline, it is usually more convenient to use the facility for
8645 changing separator characters. This list contains the same two networks:
8646 .code
8647 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8648                                  3ffe:ffff:836f::/48
8649 .endd
8650 The separator is changed to semicolon by the leading &"<;"& at the start of the
8651 list.
8652 .endlist
8653
8654
8655
8656 .section "Host list patterns for single-key lookups by host address" &&&
8657          "SECThoslispatsikey"
8658 .cindex "host list" "lookup of IP address"
8659 When a host is to be identified by a single-key lookup of its complete IP
8660 address, the pattern takes this form:
8661 .display
8662 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8663 .endd
8664 For example:
8665 .code
8666 hosts_lookup = net-cdb;/hosts-by-ip.db
8667 .endd
8668 The text form of the IP address of the subject host is used as the lookup key.
8669 IPv6 addresses are converted to an unabbreviated form, using lower case
8670 letters, with dots as separators because colon is the key terminator in
8671 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8672 quoting the keys, but this is a facility that was added later.] The data
8673 returned by the lookup is not used.
8674
8675 .cindex "IP address" "masking"
8676 .cindex "host list" "masked IP address"
8677 Single-key lookups can also be performed using masked IP addresses, using
8678 patterns of this form:
8679 .display
8680 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8681 .endd
8682 For example:
8683 .code
8684 net24-dbm;/networks.db
8685 .endd
8686 The IP address of the subject host is masked using <&'number'&> as the mask
8687 length. A textual string is constructed from the masked value, followed by the
8688 mask, and this is used as the lookup key. For example, if the host's IP address
8689 is 192.168.34.6, the key that is looked up for the above example is
8690 &"192.168.34.0/24"&.
8691
8692 When an IPv6 address is converted to a string, dots are normally used instead
8693 of colons, so that keys in &(lsearch)& files need not contain colons (which
8694 terminate &(lsearch)& keys). This was implemented some time before the ability
8695 to quote keys was made available in &(lsearch)& files. However, the more
8696 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8697 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8698 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8699 converted using colons and not dots.
8700 .new
8701 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8702 addresses are always used.
8703 The latter are converted to IPv4 addresses, in dotted-quad form.
8704 .wen
8705
8706 Ideally, it would be nice to tidy up this anomalous situation by changing to
8707 colons in all cases, given that quoting is now available for &(lsearch)&.
8708 However, this would be an incompatible change that might break some existing
8709 configurations.
8710
8711 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8712 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8713 the former case the key strings include the mask value, whereas in the latter
8714 case the IP address is used on its own.
8715
8716
8717
8718 .section "Host list patterns that match by host name" "SECThoslispatnam"
8719 .cindex "host" "lookup failures"
8720 .cindex "unknown host name"
8721 .cindex "host list" "matching host name"
8722 There are several types of pattern that require Exim to know the name of the
8723 remote host. These are either wildcard patterns or lookups by name. (If a
8724 complete hostname is given without any wildcarding, it is used to find an IP
8725 address to match against, as described in section &<<SECThoslispatip>>&
8726 above.)
8727
8728 If the remote host name is not already known when Exim encounters one of these
8729 patterns, it has to be found from the IP address.
8730 Although many sites on the Internet are conscientious about maintaining reverse
8731 DNS data for their hosts, there are also many that do not do this.
8732 Consequently, a name cannot always be found, and this may lead to unwanted
8733 effects. Take care when configuring host lists with wildcarded name patterns.
8734 Consider what will happen if a name cannot be found.
8735
8736 Because of the problems of determining host names from IP addresses, matching
8737 against host names is not as common as matching against IP addresses.
8738
8739 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8740 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8741 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8742 are done can be changed by setting the &%host_lookup_order%& option. For
8743 security, once Exim has found one or more names, it looks up the IP addresses
8744 for these names and compares them with the IP address that it started with.
8745 Only those names whose IP addresses match are accepted. Any other names are
8746 discarded. If no names are left, Exim behaves as if the host name cannot be
8747 found. In the most common case there is only one name and one IP address.
8748
8749 There are some options that control what happens if a host name cannot be
8750 found. These are described in section &<<SECTbehipnot>>& below.
8751
8752 .cindex "host" "alias for"
8753 .cindex "alias for host"
8754 As a result of aliasing, hosts may have more than one name. When processing any
8755 of the following types of pattern, all the host's names are checked:
8756
8757 .ilist
8758 .cindex "asterisk" "in host list"
8759 If a pattern starts with &"*"& the remainder of the item must match the end of
8760 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8761 &'.b.c'&. This special simple form is provided because this is a very common
8762 requirement. Other kinds of wildcarding require the use of a regular
8763 expression.
8764 .next
8765 .cindex "regular expressions" "in host list"
8766 .cindex "host list" "regular expression in"
8767 If the item starts with &"^"& it is taken to be a regular expression which is
8768 matched against the host name. Host names are case-independent, so this regular
8769 expression match is by default case-independent, but you can make it
8770 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8771 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8772 example,
8773 .code
8774 ^(a|b)\.c\.d$
8775 .endd
8776 is a regular expression that matches either of the two hosts &'a.c.d'& or
8777 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8778 that backslash and dollar characters are not misinterpreted as part of the
8779 string expansion. The simplest way to do this is to use &`\N`& to mark that
8780 part of the string as non-expandable. For example:
8781 .code
8782 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8783 .endd
8784 &*Warning*&: If you want to match a complete host name, you must include the
8785 &`$`& terminating metacharacter in the regular expression, as in the above
8786 example. Without it, a match at the start of the host name is all that is
8787 required.
8788 .endlist
8789
8790
8791
8792
8793 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8794 .cindex "host" "lookup failures, permanent"
8795 While processing a host list, Exim may need to look up an IP address from a
8796 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8797 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8798 behaviour when it fails to find the information it is seeking is the same.
8799
8800 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8801 apply to temporary DNS errors, whose handling is described in the next section.
8802
8803 .cindex "&`+include_unknown`&"
8804 .cindex "&`+ignore_unknown`&"
8805 Exim parses a host list from left to right. If it encounters a permanent
8806 lookup failure in any item in the host list before it has found a match,
8807 Exim treats it as a failure and the default behavior is as if the host
8808 does not match the list. This may not always be what you want to happen.
8809 To change Exim's behaviour, the special items &`+include_unknown`& or
8810 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8811 not recognized in an indirected file).
8812
8813 .ilist
8814 If any item that follows &`+include_unknown`& requires information that
8815 cannot found, Exim behaves as if the host does match the list. For example,
8816 .code
8817 host_reject_connection = +include_unknown:*.enemy.ex
8818 .endd
8819 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8820 any hosts whose name it cannot find.
8821
8822 .next
8823 If any item that follows &`+ignore_unknown`& requires information that cannot
8824 be found, Exim ignores that item and proceeds to the rest of the list. For
8825 example:
8826 .code
8827 accept hosts = +ignore_unknown : friend.example : \
8828                192.168.4.5
8829 .endd
8830 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8831 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8832 name can be found for 192.168.4.5, it is rejected.
8833 .endlist
8834
8835 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8836 list. The effect of each one lasts until the next, or until the end of the
8837 list.
8838
8839 .section "Mixing wildcarded host names and addresses in host lists" &&&
8840          "SECTmixwilhos"
8841 .cindex "host list" "mixing names and addresses in"
8842
8843 This section explains the host/ip processing logic with the same concepts
8844 as the previous section, but specifically addresses what happens when a
8845 wildcarded hostname is one of the items in the hostlist.
8846
8847 .ilist
8848 If you have name lookups or wildcarded host names and
8849 IP addresses in the same host list, you should normally put the IP
8850 addresses first. For example, in an ACL you could have:
8851 .code
8852 accept hosts = 10.9.8.7 : *.friend.example
8853 .endd
8854 The reason you normally would order it this way lies in the
8855 left-to-right way that Exim processes lists.  It can test IP addresses
8856 without doing any DNS lookups, but when it reaches an item that requires
8857 a host name, it fails if it cannot find a host name to compare with the
8858 pattern. If the above list is given in the opposite order, the
8859 &%accept%& statement fails for a host whose name cannot be found, even
8860 if its IP address is 10.9.8.7.
8861
8862 .next
8863 If you really do want to do the name check first, and still recognize the IP
8864 address, you can rewrite the ACL like this:
8865 .code
8866 accept hosts = *.friend.example
8867 accept hosts = 10.9.8.7
8868 .endd
8869 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8870 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8871 &`+ignore_unknown`&, which was discussed in depth in the first example in
8872 this section.
8873 .endlist
8874
8875
8876 .section "Temporary DNS errors when looking up host information" &&&
8877          "SECTtemdnserr"
8878 .cindex "host" "lookup failures, temporary"
8879 .cindex "&`+include_defer`&"
8880 .cindex "&`+ignore_defer`&"
8881 A temporary DNS lookup failure normally causes a defer action (except when
8882 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8883 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8884 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8885 section. These options should be used with care, probably only in non-critical
8886 host lists such as whitelists.
8887
8888
8889
8890 .section "Host list patterns for single-key lookups by host name" &&&
8891          "SECThoslispatnamsk"
8892 .cindex "unknown host name"
8893 .cindex "host list" "matching host name"
8894 If a pattern is of the form
8895 .display
8896 <&'single-key-search-type'&>;<&'search-data'&>
8897 .endd
8898 for example
8899 .code
8900 dbm;/host/accept/list
8901 .endd
8902 a single-key lookup is performed, using the host name as its key. If the
8903 lookup succeeds, the host matches the item. The actual data that is looked up
8904 is not used.
8905
8906 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8907 keys in the file, not IP addresses. If you want to do lookups based on IP
8908 addresses, you must precede the search type with &"net-"& (see section
8909 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8910 two items in the same list, one doing an address lookup and one doing a name
8911 lookup, both using the same file.
8912
8913
8914
8915 .section "Host list patterns for query-style lookups" "SECID81"
8916 If a pattern is of the form
8917 .display
8918 <&'query-style-search-type'&>;<&'query'&>
8919 .endd
8920 the query is obeyed, and if it succeeds, the host matches the item. The actual
8921 data that is looked up is not used. The variables &$sender_host_address$& and
8922 &$sender_host_name$& can be used in the query. For example:
8923 .code
8924 hosts_lookup = pgsql;\
8925   select ip from hostlist where ip='$sender_host_address'
8926 .endd
8927 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8928 can use the &%sg%& expansion item to change this if you need to. If you want to
8929 use masked IP addresses in database queries, you can use the &%mask%& expansion
8930 operator.
8931
8932 If the query contains a reference to &$sender_host_name$&, Exim automatically
8933 looks up the host name if it has not already done so. (See section
8934 &<<SECThoslispatnam>>& for comments on finding host names.)
8935
8936 Historical note: prior to release 4.30, Exim would always attempt to find a
8937 host name before running the query, unless the search type was preceded by
8938 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8939 still recognized for query-style lookups, but its presence or absence has no
8940 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8941 See section &<<SECThoslispatsikey>>&.)
8942
8943
8944
8945
8946
8947 .section "Address lists" "SECTaddresslist"
8948 .cindex "list" "address list"
8949 .cindex "address list" "empty item"
8950 .cindex "address list" "patterns"
8951 Address lists contain patterns that are matched against mail addresses. There
8952 is one special case to be considered: the sender address of a bounce message is
8953 always empty. You can test for this by providing an empty item in an address
8954 list. For example, you can set up a router to process bounce messages by
8955 using this option setting:
8956 .code
8957 senders = :
8958 .endd
8959 The presence of the colon creates an empty item. If you do not provide any
8960 data, the list is empty and matches nothing. The empty sender can also be
8961 detected by a regular expression that matches an empty string,
8962 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8963
8964 Non-empty items in an address list can be straightforward email addresses. For
8965 example:
8966 .code
8967 senders = jbc@askone.example : hs@anacreon.example
8968 .endd
8969 A certain amount of wildcarding is permitted. If a pattern contains an @
8970 character, but is not a regular expression and does not begin with a
8971 semicolon-terminated lookup type (described below), the local part of the
8972 subject address is compared with the local part of the pattern, which may start
8973 with an asterisk. If the local parts match, the domain is checked in exactly
8974 the same way as for a pattern in a domain list. For example, the domain can be
8975 wildcarded, refer to a named list, or be a lookup:
8976 .code
8977 deny senders = *@*.spamming.site:\
8978                *@+hostile_domains:\
8979                bozo@partial-lsearch;/list/of/dodgy/sites:\
8980                *@dbm;/bad/domains.db
8981 .endd
8982 .cindex "local part" "starting with !"
8983 .cindex "address list" "local part starting with !"
8984 If a local part that begins with an exclamation mark is required, it has to be
8985 specified using a regular expression, because otherwise the exclamation mark is
8986 treated as a sign of negation, as is standard in lists.
8987
8988 If a non-empty pattern that is not a regular expression or a lookup does not
8989 contain an @ character, it is matched against the domain part of the subject
8990 address. The only two formats that are recognized this way are a literal
8991 domain, or a domain pattern that starts with *. In both these cases, the effect
8992 is the same as if &`*@`& preceded the pattern. For example:
8993 .code
8994 deny senders = enemy.domain : *.enemy.domain
8995 .endd
8996
8997 The following kinds of more complicated address list pattern can match any
8998 address, including the empty address that is characteristic of bounce message
8999 senders:
9000
9001 .ilist
9002 .cindex "regular expressions" "in address list"
9003 .cindex "address list" "regular expression in"
9004 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9005 done against the complete address, with the pattern as the regular expression.
9006 You must take care that backslash and dollar characters are not misinterpreted
9007 as part of the string expansion. The simplest way to do this is to use &`\N`&
9008 to mark that part of the string as non-expandable. For example:
9009 .code
9010 deny senders = \N^.*this.*@example\.com$\N : \
9011                \N^\d{8}.+@spamhaus.example$\N : ...
9012 .endd
9013 The &`\N`& sequences are removed by the expansion, so these items do indeed
9014 start with &"^"& by the time they are being interpreted as address patterns.
9015
9016 .next
9017 .cindex "address list" "lookup for complete address"
9018 Complete addresses can be looked up by using a pattern that starts with a
9019 lookup type terminated by a semicolon, followed by the data for the lookup. For
9020 example:
9021 .code
9022 deny senders = cdb;/etc/blocked.senders : \
9023   mysql;select address from blocked where \
9024   address='${quote_mysql:$sender_address}'
9025 .endd
9026 Both query-style and single-key lookup types can be used. For a single-key
9027 lookup type, Exim uses the complete address as the key. However, empty keys are
9028 not supported for single-key lookups, so a match against the empty address
9029 always fails. This restriction does not apply to query-style lookups.
9030
9031 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9032 cannot be used, and is ignored if specified, with an entry being written to the
9033 panic log.
9034 .cindex "*@ with single-key lookup"
9035 However, you can configure lookup defaults, as described in section
9036 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9037 default. For example, with this lookup:
9038 .code
9039 accept senders = lsearch*@;/some/file
9040 .endd
9041 the file could contains lines like this:
9042 .code
9043 user1@domain1.example
9044 *@domain2.example
9045 .endd
9046 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9047 that are tried is:
9048 .code
9049 nimrod@jaeger.example
9050 *@jaeger.example
9051 *
9052 .endd
9053 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9054 would mean that every address matches, thus rendering the test useless.
9055
9056 &*Warning 2*&: Do not confuse these two kinds of item:
9057 .code
9058 deny recipients = dbm*@;/some/file
9059 deny recipients = *@dbm;/some/file
9060 .endd
9061 The first does a whole address lookup, with defaulting, as just described,
9062 because it starts with a lookup type. The second matches the local part and
9063 domain independently, as described in a bullet point below.
9064 .endlist
9065
9066
9067 The following kinds of address list pattern can match only non-empty addresses.
9068 If the subject address is empty, a match against any of these pattern types
9069 always fails.
9070
9071
9072 .ilist
9073 .cindex "@@ with single-key lookup"
9074 .cindex "address list" "@@ lookup type"
9075 .cindex "address list" "split local part and domain"
9076 If a pattern starts with &"@@"& followed by a single-key lookup item
9077 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9078 split into a local part and a domain. The domain is looked up in the file. If
9079 it is not found, there is no match. If it is found, the data that is looked up
9080 from the file is treated as a colon-separated list of local part patterns, each
9081 of which is matched against the subject local part in turn.
9082
9083 .cindex "asterisk" "in address list"
9084 The lookup may be a partial one, and/or one involving a search for a default
9085 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9086 patterns that are looked up can be regular expressions or begin with &"*"&, or
9087 even be further lookups. They may also be independently negated. For example,
9088 with
9089 .code
9090 deny senders = @@dbm;/etc/reject-by-domain
9091 .endd
9092 the data from which the DBM file is built could contain lines like
9093 .code
9094 baddomain.com:  !postmaster : *
9095 .endd
9096 to reject all senders except &%postmaster%& from that domain.
9097
9098 .cindex "local part" "starting with !"
9099 If a local part that actually begins with an exclamation mark is required, it
9100 has to be specified using a regular expression. In &(lsearch)& files, an entry
9101 may be split over several lines by indenting the second and subsequent lines,
9102 but the separating colon must still be included at line breaks. White space
9103 surrounding the colons is ignored. For example:
9104 .code
9105 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9106   spammer3 : spammer4
9107 .endd
9108 As in all colon-separated lists in Exim, a colon can be included in an item by
9109 doubling.
9110
9111 If the last item in the list starts with a right angle-bracket, the remainder
9112 of the item is taken as a new key to look up in order to obtain a continuation
9113 list of local parts. The new key can be any sequence of characters. Thus one
9114 might have entries like
9115 .code
9116 aol.com: spammer1 : spammer 2 : >*
9117 xyz.com: spammer3 : >*
9118 *:       ^\d{8}$
9119 .endd
9120 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9121 local parts for all domains, in addition to the specific local parts listed for
9122 each domain. Of course, using this feature costs another lookup each time a
9123 chain is followed, but the effort needed to maintain the data is reduced.
9124
9125 .cindex "loop" "in lookups"
9126 It is possible to construct loops using this facility, and in order to catch
9127 them, the chains may be no more than fifty items long.
9128
9129 .next
9130 The @@<&'lookup'&> style of item can also be used with a query-style
9131 lookup, but in this case, the chaining facility is not available. The lookup
9132 can only return a single list of local parts.
9133 .endlist
9134
9135 &*Warning*&: There is an important difference between the address list items
9136 in these two examples:
9137 .code
9138 senders = +my_list
9139 senders = *@+my_list
9140 .endd
9141 In the first one, &`my_list`& is a named address list, whereas in the second
9142 example it is a named domain list.
9143
9144
9145
9146
9147 .section "Case of letters in address lists" "SECTcasletadd"
9148 .cindex "case of local parts"
9149 .cindex "address list" "case forcing"
9150 .cindex "case forcing in address lists"
9151 Domains in email addresses are always handled caselessly, but for local parts
9152 case may be significant on some systems (see &%caseful_local_part%& for how
9153 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9154 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9155 blocking lists should be done in a case-independent manner. Since most address
9156 lists in Exim are used for this kind of control, Exim attempts to do this by
9157 default.
9158
9159 The domain portion of an address is always lowercased before matching it to an
9160 address list. The local part is lowercased by default, and any string
9161 comparisons that take place are done caselessly. This means that the data in
9162 the address list itself, in files included as plain filenames, and in any file
9163 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9164 keys in files that are looked up by a search type other than &(lsearch)& (which
9165 works caselessly) must be in lower case, because these lookups are not
9166 case-independent.
9167
9168 .cindex "&`+caseful`&"
9169 To allow for the possibility of caseful address list matching, if an item in
9170 an address list is the string &"+caseful"&, the original case of the local
9171 part is restored for any comparisons that follow, and string comparisons are no
9172 longer case-independent. This does not affect the domain, which remains in
9173 lower case. However, although independent matches on the domain alone are still
9174 performed caselessly, regular expressions that match against an entire address
9175 become case-sensitive after &"+caseful"& has been seen.
9176
9177
9178
9179 .section "Local part lists" "SECTlocparlis"
9180 .cindex "list" "local part list"
9181 .cindex "local part" "list"
9182 Case-sensitivity in local part lists is handled in the same way as for address
9183 lists, as just described. The &"+caseful"& item can be used if required. In a
9184 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9185 set false, the subject is lowercased and the matching is initially
9186 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9187 matching in the local part list, but not elsewhere in the router. If
9188 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9189 option is case-sensitive from the start.
9190
9191 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9192 comments are handled in the same way as address lists &-- they are recognized
9193 only if the # is preceded by white space or the start of the line.
9194 Otherwise, local part lists are matched in the same way as domain lists, except
9195 that the special items that refer to the local host (&`@`&, &`@[]`&,
9196 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9197 Refer to section &<<SECTdomainlist>>& for details of the other available item
9198 types.
9199 .ecindex IIDdohoadli
9200
9201
9202
9203
9204 . ////////////////////////////////////////////////////////////////////////////
9205 . ////////////////////////////////////////////////////////////////////////////
9206
9207 .chapter "String expansions" "CHAPexpand"
9208 .scindex IIDstrexp "expansion" "of strings"
9209 Many strings in Exim's runtime configuration are expanded before use. Some of
9210 them are expanded every time they are used; others are expanded only once.
9211
9212 When a string is being expanded it is copied verbatim from left to right except
9213 .cindex expansion "string concatenation"
9214 when a dollar or backslash character is encountered. A dollar specifies the
9215 start of a portion of the string that is interpreted and replaced as described
9216 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9217 escape character, as described in the following section.
9218
9219 Whether a string is expanded depends upon the context.  Usually this is solely
9220 dependent upon the option for which a value is sought; in this documentation,
9221 options for which string expansion is performed are marked with &dagger; after
9222 the data type.  ACL rules always expand strings.  A couple of expansion
9223 conditions do not expand some of the brace-delimited branches, for security
9224 reasons,
9225 .new
9226 .cindex "tainted data" expansion
9227 .cindex expansion "tainted data"
9228 and expansion of data deriving from the sender (&"tainted data"&)
9229 is not permitted.
9230 .wen
9231
9232
9233
9234 .section "Literal text in expanded strings" "SECTlittext"
9235 .cindex "expansion" "including literal text"
9236 An uninterpreted dollar can be included in an expanded string by putting a
9237 backslash in front of it. A backslash can be used to prevent any special
9238 character being treated specially in an expansion, including backslash itself.
9239 If the string appears in quotes in the configuration file, two backslashes are
9240 required because the quotes themselves cause interpretation of backslashes when
9241 the string is read in (see section &<<SECTstrings>>&).
9242
9243 .cindex "expansion" "non-expandable substrings"
9244 A portion of the string can specified as non-expandable by placing it between
9245 two occurrences of &`\N`&. This is particularly useful for protecting regular
9246 expressions, which often contain backslashes and dollar signs. For example:
9247 .code
9248 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9249 .endd
9250 On encountering the first &`\N`&, the expander copies subsequent characters
9251 without interpretation until it reaches the next &`\N`& or the end of the
9252 string.
9253
9254
9255
9256 .section "Character escape sequences in expanded strings" "SECID82"
9257 .cindex "expansion" "escape sequences"
9258 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9259 expanded string is recognized as an escape sequence for the character newline,
9260 carriage return, or tab, respectively. A backslash followed by up to three
9261 octal digits is recognized as an octal encoding for a single character, and a
9262 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9263 encoding.
9264
9265 These escape sequences are also recognized in quoted strings when they are read
9266 in. Their interpretation in expansions as well is useful for unquoted strings,
9267 and for other cases such as looked-up strings that are then expanded.
9268
9269
9270 .section "Testing string expansions" "SECID83"
9271 .cindex "expansion" "testing"
9272 .cindex "testing" "string expansion"
9273 .oindex "&%-be%&"
9274 Many expansions can be tested by calling Exim with the &%-be%& option. This
9275 takes the command arguments, or lines from the standard input if there are no
9276 arguments, runs them through the string expansion code, and writes the results
9277 to the standard output. Variables based on configuration values are set up, but
9278 since no message is being processed, variables such as &$local_part$& have no
9279 value. Nevertheless the &%-be%& option can be useful for checking out file and
9280 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9281 and &%nhash%&.
9282
9283 Exim gives up its root privilege when it is called with the &%-be%& option, and
9284 instead runs under the uid and gid it was called with, to prevent users from
9285 using &%-be%& for reading files to which they do not have access.
9286
9287 .oindex "&%-bem%&"
9288 If you want to test expansions that include variables whose values are taken
9289 from a message, there are two other options that can be used. The &%-bem%&
9290 option is like &%-be%& except that it is followed by a filename. The file is
9291 read as a message before doing the test expansions. For example:
9292 .code
9293 exim -bem /tmp/test.message '$h_subject:'
9294 .endd
9295 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9296 Exim message identifier. For example:
9297 .code
9298 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9299 .endd
9300 This loads the message from Exim's spool before doing the test expansions, and
9301 is therefore restricted to admin users.
9302
9303
9304 .section "Forced expansion failure" "SECTforexpfai"
9305 .cindex "expansion" "forced failure"
9306 A number of expansions that are described in the following section have
9307 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9308 (which are sometimes called &"curly brackets"&). Which of the two strings is
9309 used depends on some condition that is evaluated as part of the expansion. If,
9310 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9311 the entire string expansion fails in a way that can be detected by the code
9312 that requested the expansion. This is called &"forced expansion failure"&, and
9313 its consequences depend on the circumstances. In some cases it is no different
9314 from any other expansion failure, but in others a different action may be
9315 taken. Such variations are mentioned in the documentation of the option that is
9316 being expanded.
9317
9318
9319
9320
9321 .section "Expansion items" "SECTexpansionitems"
9322 The following items are recognized in expanded strings. White space may be used
9323 between sub-items that are keywords or substrings enclosed in braces inside an
9324 outer set of braces, to improve readability. &*Warning*&: Within braces,
9325 white space is significant.
9326
9327 .vlist
9328 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9329 .cindex "expansion" "variables"
9330 Substitute the contents of the named variable, for example:
9331 .code
9332 $local_part
9333 ${domain}
9334 .endd
9335 The second form can be used to separate the name from subsequent alphanumeric
9336 characters. This form (using braces) is available only for variables; it does
9337 &'not'& apply to message headers. The names of the variables are given in
9338 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9339 given, the expansion fails.
9340
9341 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9342 .cindex "expansion" "operators"
9343 The string is first itself expanded, and then the operation specified by
9344 <&'op'&> is applied to it. For example:
9345 .code
9346 ${lc:$local_part}
9347 .endd
9348 The string starts with the first character after the colon, which may be
9349 leading white space. A list of operators is given in section &<<SECTexpop>>&
9350 below. The operator notation is used for simple expansion items that have just
9351 one argument, because it reduces the number of braces and therefore makes the
9352 string easier to understand.
9353
9354 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9355 This item inserts &"basic"& header lines. It is described with the &%header%&
9356 expansion item below.
9357
9358
9359 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9360 .cindex "expansion" "calling an acl"
9361 .cindex "&%acl%&" "call from expansion"
9362 The name and zero to nine argument strings are first expanded separately.  The expanded
9363 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9364 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9365 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9366 and may use the variables; if another acl expansion is used the values
9367 are restored after it returns.  If the ACL sets
9368 a value using a "message =" modifier and returns accept or deny, the value becomes
9369 the result of the expansion.
9370 If no message is set and the ACL returns accept or deny
9371 the expansion result is an empty string.
9372 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9373
9374
9375 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9376 .cindex authentication "results header"
9377 .cindex headers "authentication-results:"
9378 .cindex authentication "expansion item"
9379 This item returns a string suitable for insertion as an
9380 &'Authentication-Results:'&
9381 header line.
9382 The given <&'authserv-id'&> is included in the result; typically this
9383 will be a domain name identifying the system performing the authentications.
9384 Methods that might be present in the result include:
9385 .code
9386 none
9387 iprev
9388 auth
9389 spf
9390 dkim
9391 .endd
9392
9393 Example use (as an ACL modifier):
9394 .code
9395       add_header = :at_start:${authresults {$primary_hostname}}
9396 .endd
9397 This is safe even if no authentication results are available.
9398
9399
9400 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9401        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9402 .cindex "expansion" "extracting certificate fields"
9403 .cindex "&%certextract%&" "certificate fields"
9404 .cindex "certificate" "extracting fields"
9405 The <&'certificate'&> must be a variable of type certificate.
9406 The field name is expanded and used to retrieve the relevant field from
9407 the certificate.  Supported fields are:
9408 .display
9409 &`version        `&
9410 &`serial_number  `&
9411 &`subject        `& RFC4514 DN
9412 &`issuer         `& RFC4514 DN
9413 &`notbefore      `& time
9414 &`notafter       `& time
9415 &`sig_algorithm  `&
9416 &`signature      `&
9417 &`subj_altname   `& tagged list
9418 &`ocsp_uri       `& list
9419 &`crl_uri        `& list
9420 .endd
9421 If the field is found,
9422 <&'string2'&> is expanded, and replaces the whole item;
9423 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9424 variable &$value$& contains the value that has been extracted. Afterwards, it
9425 is restored to any previous value it might have had.
9426
9427 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9428 key is not found. If {<&'string2'&>} is also omitted, the value that was
9429 extracted is used.
9430
9431 Some field names take optional modifiers, appended and separated by commas.
9432
9433 The field selectors marked as "RFC4514" above
9434 output a Distinguished Name string which is
9435 not quite
9436 parseable by Exim as a comma-separated tagged list
9437 (the exceptions being elements containing commas).
9438 RDN elements of a single type may be selected by
9439 a modifier of the type label; if so the expansion
9440 result is a list (newline-separated by default).
9441 The separator may be changed by another modifier of
9442 a right angle-bracket followed immediately by the new separator.
9443 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9444
9445 The field selectors marked as "time" above
9446 take an optional modifier of "int"
9447 for which the result is the number of seconds since epoch.
9448 Otherwise the result is a human-readable string
9449 in the timezone selected by the main "timezone" option.
9450
9451 The field selectors marked as "list" above return a list,
9452 newline-separated by default,
9453 (embedded separator characters in elements are doubled).
9454 The separator may be changed by a modifier of
9455 a right angle-bracket followed immediately by the new separator.
9456
9457 The field selectors marked as "tagged" above
9458 prefix each list element with a type string and an equals sign.
9459 Elements of only one type may be selected by a modifier
9460 which is one of "dns", "uri" or "mail";
9461 if so the element tags are omitted.
9462
9463 If not otherwise noted field values are presented in human-readable form.
9464
9465 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9466        {*&<&'arg'&>&*}...}*&"
9467 .cindex &%dlfunc%&
9468 This expansion dynamically loads and then calls a locally-written C function.
9469 This functionality is available only if Exim is compiled with
9470 .code
9471 EXPAND_DLFUNC=yes
9472 .endd
9473 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9474 object so that it doesn't reload the same object file in the same Exim process
9475 (but of course Exim does start new processes frequently).
9476
9477 There may be from zero to eight arguments to the function. When compiling
9478 a local function that is to be called in this way, &_local_scan.h_& should be
9479 included. The Exim variables and functions that are defined by that API
9480 are also available for dynamically loaded functions. The function itself
9481 must have the following type:
9482 .code
9483 int dlfunction(uschar **yield, int argc, uschar *argv[])
9484 .endd
9485 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9486 function should return one of the following values:
9487
9488 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9489 into the expanded string that is being built.
9490
9491 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9492 from &'yield'&, if it is set.
9493
9494 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9495 taken from &'yield'& if it is set.
9496
9497 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9498
9499 When compiling a function that is to be used in this way with gcc,
9500 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9501 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9502
9503
9504 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9505 .cindex "expansion" "extracting value from environment"
9506 .cindex "environment" "values from"
9507 The key is first expanded separately, and leading and trailing white space
9508 removed.
9509 This is then searched for as a name in the environment.
9510 If a variable is found then its value is placed in &$value$&
9511 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9512
9513 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9514 appear, for example:
9515 .code
9516 ${env{USER}{$value} fail }
9517 .endd
9518 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9519 {<&'string1'&>} must be present for &"fail"& to be recognized.
9520
9521 If {<&'string2'&>} is omitted an empty string is substituted on
9522 search failure.
9523 If {<&'string1'&>} is omitted the search result is substituted on
9524 search success.
9525
9526 The environment is adjusted by the &%keep_environment%& and
9527 &%add_environment%& main section options.
9528
9529
9530 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9531        {*&<&'string3'&>&*}}*&"
9532 .cindex "expansion" "extracting substrings by key"
9533 .cindex "&%extract%&" "substrings by key"
9534 The key and <&'string1'&> are first expanded separately. Leading and trailing
9535 white space is removed from the key (but not from any of the strings). The key
9536 must not be empty and must not consist entirely of digits.
9537 The expanded <&'string1'&> must be of the form:
9538 .display
9539 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9540 .endd
9541 .vindex "&$value$&"
9542 where the equals signs and spaces (but not both) are optional. If any of the
9543 values contain white space, they must be enclosed in double quotes, and any
9544 values that are enclosed in double quotes are subject to escape processing as
9545 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9546 for the value that corresponds to the key. The search is case-insensitive. If
9547 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9548 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9549 variable &$value$& contains the value that has been extracted. Afterwards, it
9550 is restored to any previous value it might have had.
9551
9552 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9553 key is not found. If {<&'string2'&>} is also omitted, the value that was
9554 extracted is used. Thus, for example, these two expansions are identical, and
9555 yield &"2001"&:
9556 .code
9557 ${extract{gid}{uid=1984 gid=2001}}
9558 ${extract{gid}{uid=1984 gid=2001}{$value}}
9559 .endd
9560 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9561 appear, for example:
9562 .code
9563 ${extract{Z}{A=... B=...}{$value} fail }
9564 .endd
9565 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9566 {<&'string2'&>} must be present for &"fail"& to be recognized.
9567
9568 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9569        {*&<&'string3'&>&*}}*&" &&&
9570        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9571        {*&<&'string3'&>&*}}*&"
9572 .cindex "expansion" "extracting from JSON object"
9573 .cindex JSON expansions
9574 The key and <&'string1'&> are first expanded separately. Leading and trailing
9575 white space is removed from the key (but not from any of the strings). The key
9576 must not be empty and must not consist entirely of digits.
9577 The expanded <&'string1'&> must be of the form:
9578 .display
9579 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9580 .endd
9581 .vindex "&$value$&"
9582 The braces, commas and colons, and the quoting of the member name are required;
9583 the spaces are optional.
9584 Matching of the key against the member names is done case-sensitively.
9585 For the &"json"& variant,
9586 if a returned value is a JSON string, it retains its leading and
9587 trailing quotes.
9588 .new
9589 For the &"jsons"& variant, which is intended for use with JSON strings, the
9590 leading and trailing quotes are removed from the returned value.
9591 .wen
9592 . XXX should be a UTF-8 compare
9593
9594 The results of matching are handled as above.
9595
9596
9597 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9598         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9599 .cindex "expansion" "extracting substrings by number"
9600 .cindex "&%extract%&" "substrings by number"
9601 The <&'number'&> argument must consist entirely of decimal digits,
9602 apart from leading and trailing white space, which is ignored.
9603 This is what distinguishes this form of &%extract%& from the previous kind. It
9604 behaves in the same way, except that, instead of extracting a named field, it
9605 extracts from <&'string1'&> the field whose number is given as the first
9606 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9607 <&'string3'&> as before.
9608
9609 The fields in the string are separated by any one of the characters in the
9610 separator string. These may include space or tab characters.
9611 The first field is numbered one. If the number is negative, the fields are
9612 counted from the end of the string, with the rightmost one numbered -1. If the
9613 number given is zero, the entire string is returned. If the modulus of the
9614 number is greater than the number of fields in the string, the result is the
9615 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9616 provided. For example:
9617 .code
9618 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9619 .endd
9620 yields &"42"&, and
9621 .code
9622 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9623 .endd
9624 yields &"99"&. Two successive separators mean that the field between them is
9625 empty (for example, the fifth field above).
9626
9627
9628 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9629         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9630        "&*${extract jsons{*&<&'number'&>&*}}&&&
9631         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9632 .cindex "expansion" "extracting from JSON array"
9633 .cindex JSON expansions
9634 The <&'number'&> argument must consist entirely of decimal digits,
9635 apart from leading and trailing white space, which is ignored.
9636
9637 Field selection and result handling is as above;
9638 there is no choice of field separator.
9639 For the &"json"& variant,
9640 if a returned value is a JSON string, it retains its leading and
9641 trailing quotes.
9642 .new
9643 For the &"jsons"& variant, which is intended for use with JSON strings, the
9644 leading and trailing quotes are removed from the returned value.
9645 .wen
9646
9647
9648 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9649 .cindex "list" "selecting by condition"
9650 .cindex "expansion" "selecting from list by condition"
9651 .vindex "&$item$&"
9652 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9653 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9654 For each item
9655 in this list, its value is place in &$item$&, and then the condition is
9656 evaluated. If the condition is true, &$item$& is added to the output as an
9657 item in a new list; if the condition is false, the item is discarded. The
9658 separator used for the output list is the same as the one used for the
9659 input, but a separator setting is not included in the output. For example:
9660 .code
9661 ${filter{a:b:c}{!eq{$item}{b}}}
9662 .endd
9663 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9664 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9665
9666
9667 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9668 .cindex "hash function" "textual"
9669 .cindex "expansion" "textual hash"
9670 This is a textual hashing function, and was the first to be implemented in
9671 early versions of Exim. In current releases, there are other hashing functions
9672 (numeric, MD5, and SHA-1), which are described below.
9673
9674 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9675 <&'n'&>. If you are using fixed values for these numbers, that is, if
9676 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9677 use the simpler operator notation that avoids some of the braces:
9678 .code
9679 ${hash_<n>_<m>:<string>}
9680 .endd
9681 The second number is optional (in both notations). If <&'n'&> is greater than
9682 or equal to the length of the string, the expansion item returns the string.
9683 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9684 function to the string. The new string consists of characters taken from the
9685 first <&'m'&> characters of the string
9686 .code
9687 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9688 .endd
9689 If <&'m'&> is not present the value 26 is used, so that only lower case
9690 letters appear. For example:
9691 .display
9692 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9693 &`$hash{5}{monty}}           `&   yields  &`monty`&
9694 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9695 .endd
9696
9697 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9698         &*$h_*&<&'header&~name'&>&*:*&" &&&
9699        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9700         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9701        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9702         &*$lh_*&<&'header&~name'&>&*:*&"
9703        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9704         &*$rh_*&<&'header&~name'&>&*:*&"
9705 .cindex "expansion" "header insertion"
9706 .vindex "&$header_$&"
9707 .vindex "&$bheader_$&"
9708 .vindex "&$lheader_$&"
9709 .vindex "&$rheader_$&"
9710 .cindex "header lines" "in expansion strings"
9711 .cindex "header lines" "character sets"
9712 .cindex "header lines" "decoding"
9713 Substitute the contents of the named message header line, for example
9714 .code
9715 $header_reply-to:
9716 .endd
9717 The newline that terminates a header line is not included in the expansion, but
9718 internal newlines (caused by splitting the header line over several physical
9719 lines) may be present.
9720
9721 The difference between the four pairs of expansions is in the way
9722 the data in the header line is interpreted.
9723
9724 .ilist
9725 .cindex "white space" "in header lines"
9726 &%rheader%& gives the original &"raw"& content of the header line, with no
9727 processing at all, and without the removal of leading and trailing white space.
9728
9729 .next
9730 .cindex "list" "of header lines"
9731 &%lheader%& gives a colon-separated list, one element per header when there
9732 are multiple headers with a given name.
9733 Any embedded colon characters within an element are doubled, so normal Exim
9734 list-processing facilities can be used.
9735 The terminating newline of each element is removed; in other respects
9736 the content is &"raw"&.
9737
9738 .next
9739 .cindex "base64 encoding" "in header lines"
9740 &%bheader%& removes leading and trailing white space, and then decodes base64
9741 or quoted-printable MIME &"words"& within the header text, but does no
9742 character set translation. If decoding of what looks superficially like a MIME
9743 &"word"& fails, the raw string is returned. If decoding
9744 .cindex "binary zero" "in header line"
9745 produces a binary zero character, it is replaced by a question mark &-- this is
9746 what Exim does for binary zeros that are actually received in header lines.
9747
9748 .next
9749 &%header%& tries to translate the string as decoded by &%bheader%& to a
9750 standard character set. This is an attempt to produce the same string as would
9751 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9752 returned. Translation is attempted only on operating systems that support the
9753 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9754 a system Makefile or in &_Local/Makefile_&.
9755 .endlist ilist
9756
9757 In a filter file, the target character set for &%header%& can be specified by a
9758 command of the following form:
9759 .code
9760 headers charset "UTF-8"
9761 .endd
9762 This command affects all references to &$h_$& (or &$header_$&) expansions in
9763 subsequently obeyed filter commands. In the absence of this command, the target
9764 character set in a filter is taken from the setting of the &%headers_charset%&
9765 option in the runtime configuration. The value of this option defaults to the
9766 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9767 ISO-8859-1.
9768
9769 Header names follow the syntax of RFC 2822, which states that they may contain
9770 any printing characters except space and colon. Consequently, curly brackets
9771 &'do not'& terminate header names, and should not be used to enclose them as
9772 if they were variables. Attempting to do so causes a syntax error.
9773
9774 Only header lines that are common to all copies of a message are visible to
9775 this mechanism. These are the original header lines that are received with the
9776 message, and any that are added by an ACL statement or by a system
9777 filter. Header lines that are added to a particular copy of a message by a
9778 router or transport are not accessible.
9779
9780 For incoming SMTP messages, no header lines are visible in
9781 ACLs that are obeyed before the data phase completes,
9782 because the header structure is not set up until the message is received.
9783 They are visible in DKIM, PRDR and DATA ACLs.
9784 Header lines that are added in a RCPT ACL (for example)
9785 are saved until the message's incoming header lines are available, at which
9786 point they are added.
9787 When any of the above ACLs ar
9788 running, however, header lines added by earlier ACLs are visible.
9789
9790 Upper case and lower case letters are synonymous in header names. If the
9791 following character is white space, the terminating colon may be omitted, but
9792 this is not recommended, because you may then forget it when it is needed. When
9793 white space terminates the header name, this white space is included in the
9794 expanded string.  If the message does not contain the given header, the
9795 expansion item is replaced by an empty string. (See the &%def%& condition in
9796 section &<<SECTexpcond>>& for a means of testing for the existence of a
9797 header.)
9798
9799 If there is more than one header with the same name, they are all concatenated
9800 to form the substitution string, up to a maximum length of 64K. Unless
9801 &%rheader%& is being used, leading and trailing white space is removed from
9802 each header before concatenation, and a completely empty header is ignored. A
9803 newline character is then inserted between non-empty headers, but there is no
9804 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9805 those headers that contain lists of addresses, a comma is also inserted at the
9806 junctions between headers. This does not happen for the &%rheader%& expansion.
9807
9808
9809 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9810 .cindex "expansion" "hmac hashing"
9811 .cindex &%hmac%&
9812 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9813 shared secret and some text into a message authentication code, as specified in
9814 RFC 2104. This differs from &`${md5:secret_text...}`& or
9815 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9816 cryptographic hash, allowing for authentication that is not possible with MD5
9817 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9818 present. For example:
9819 .code
9820 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9821 .endd
9822 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9823 produces:
9824 .code
9825 dd97e3ba5d1a61b5006108f8c8252953
9826 .endd
9827 As an example of how this might be used, you might put in the main part of
9828 an Exim configuration:
9829 .code
9830 SPAMSCAN_SECRET=cohgheeLei2thahw
9831 .endd
9832 In a router or a transport you could then have:
9833 .code
9834 headers_add = \
9835   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9836   ${hmac{md5}{SPAMSCAN_SECRET}\
9837   {${primary_hostname},${message_exim_id},$h_message-id:}}
9838 .endd
9839 Then given a message, you can check where it was scanned by looking at the
9840 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9841 this header line is authentic by recomputing the authentication code from the
9842 host name, message ID and the &'Message-id:'& header line. This can be done
9843 using Exim's &%-be%& option, or by other means, for example, by using the
9844 &'hmac_md5_hex()'& function in Perl.
9845
9846
9847 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9848 .cindex "expansion" "conditional"
9849 .cindex "&%if%&, expansion item"
9850 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9851 item; otherwise <&'string2'&> is used. The available conditions are described
9852 in section &<<SECTexpcond>>& below. For example:
9853 .code
9854 ${if eq {$local_part}{postmaster} {yes}{no} }
9855 .endd
9856 The second string need not be present; if it is not and the condition is not
9857 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9858 be present instead of the second string (without any curly brackets). In this
9859 case, the expansion is forced to fail if the condition is not true (see section
9860 &<<SECTforexpfai>>&).
9861
9862 If both strings are omitted, the result is the string &`true`& if the condition
9863 is true, and the empty string if the condition is false. This makes it less
9864 cumbersome to write custom ACL and router conditions. For example, instead of
9865 .code
9866 condition = ${if >{$acl_m4}{3}{true}{false}}
9867 .endd
9868 you can use
9869 .code
9870 condition = ${if >{$acl_m4}{3}}
9871 .endd
9872
9873
9874
9875 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9876 .cindex expansion "imap folder"
9877 .cindex "&%imapfolder%& expansion item"
9878 This item converts a (possibly multilevel, or with non-ASCII characters)
9879 folder specification to a Maildir name for filesystem use.
9880 For information on internationalisation support see &<<SECTi18nMDA>>&.
9881
9882
9883
9884 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9885 .cindex "expansion" "string truncation"
9886 .cindex "&%length%& expansion item"
9887 The &%length%& item is used to extract the initial portion of a string. Both
9888 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9889 you are using a fixed value for the number, that is, if <&'string1'&> does not
9890 change when expanded, you can use the simpler operator notation that avoids
9891 some of the braces:
9892 .code
9893 ${length_<n>:<string>}
9894 .endd
9895 The result of this item is either the first <&'n'&> bytes or the whole
9896 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9897 &%strlen%&, which gives the length of a string.
9898 All measurement is done in bytes and is not UTF-8 aware.
9899
9900
9901 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9902         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9903 .cindex "expansion" "extracting list elements by number"
9904 .cindex "&%listextract%&" "extract list elements by number"
9905 .cindex "list" "extracting elements by number"
9906 The <&'number'&> argument must consist entirely of decimal digits,
9907 apart from an optional leading minus,
9908 and leading and trailing white space (which is ignored).
9909
9910 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9911 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9912
9913 The first field of the list is numbered one.
9914 If the number is negative, the fields are
9915 counted from the end of the list, with the rightmost one numbered -1.
9916 The numbered element of the list is extracted and placed in &$value$&,
9917 then <&'string2'&> is expanded as the result.
9918
9919 If the modulus of the
9920 number is zero or greater than the number of fields in the string,
9921 the result is the expansion of <&'string3'&>.
9922
9923 For example:
9924 .code
9925 ${listextract{2}{x:42:99}}
9926 .endd
9927 yields &"42"&, and
9928 .code
9929 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9930 .endd
9931 yields &"result: 42"&.
9932
9933 If {<&'string3'&>} is omitted, an empty string is used for string3.
9934 If {<&'string2'&>} is also omitted, the value that was
9935 extracted is used.
9936 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9937
9938
9939 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9940         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9941 This is the first of one of two different types of lookup item, which are both
9942 described in the next item.
9943
9944 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9945         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9946 .cindex "expansion" "lookup in"
9947 .cindex "file" "lookups"
9948 .cindex "lookup" "in expanded string"
9949 The two forms of lookup item specify data lookups in files and databases, as
9950 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9951 lookups, and the second is used for query-style lookups. The <&'key'&>,
9952 <&'file'&>, and <&'query'&> strings are expanded before use.
9953
9954 If there is any white space in a lookup item which is part of a filter command,
9955 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9956 other place where white space is significant, the lookup item must be enclosed
9957 in double quotes. The use of data lookups in users' filter files may be locked
9958 out by the system administrator.
9959
9960 .vindex "&$value$&"
9961 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9962 During its expansion, the variable &$value$& contains the data returned by the
9963 lookup. Afterwards it reverts to the value it had previously (at the outer
9964 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9965 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9966 string on failure. If <&'string2'&> is provided, it can itself be a nested
9967 lookup, thus providing a mechanism for looking up a default value when the
9968 original lookup fails.
9969
9970 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9971 data for the outer lookup while the parameters of the second lookup are
9972 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9973 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9974 appear, and in this case, if the lookup fails, the entire expansion is forced
9975 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9976 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9977 successful lookup, and nothing in the case of failure.
9978
9979 For single-key lookups, the string &"partial"& is permitted to precede the
9980 search type in order to do partial matching, and * or *@ may follow a search
9981 type to request default lookups if the key does not match (see sections
9982 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9983
9984 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9985 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9986 and non-wild parts of the key during the expansion of the replacement text.
9987 They return to their previous values at the end of the lookup item.
9988
9989 This example looks up the postmaster alias in the conventional alias file:
9990 .code
9991 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9992 .endd
9993 This example uses NIS+ to look up the full name of the user corresponding to
9994 the local part of an address, forcing the expansion to fail if it is not found:
9995 .code
9996 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9997   {$value}fail}
9998 .endd
9999
10000
10001 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10002 .cindex "expansion" "list creation"
10003 .vindex "&$item$&"
10004 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10005 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10006 For each item
10007 in this list, its value is place in &$item$&, and then <&'string2'&> is
10008 expanded and added to the output as an item in a new list. The separator used
10009 for the output list is the same as the one used for the input, but a separator
10010 setting is not included in the output. For example:
10011 .code
10012 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10013 .endd
10014 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10015 value of &$item$& is restored to what it was before. See also the &%filter%&
10016 and &%reduce%& expansion items.
10017
10018 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10019 .cindex "expansion" "numeric hash"
10020 .cindex "hash function" "numeric"
10021 The three strings are expanded; the first two must yield numbers. Call them
10022 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10023 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10024 can use the simpler operator notation that avoids some of the braces:
10025 .code
10026 ${nhash_<n>_<m>:<string>}
10027 .endd
10028 The second number is optional (in both notations). If there is only one number,
10029 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10030 processed by a div/mod hash function that returns two numbers, separated by a
10031 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10032 example,
10033 .code
10034 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10035 .endd
10036 returns the string &"6/33"&.
10037
10038
10039
10040 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10041 .cindex "Perl" "use in expanded string"
10042 .cindex "expansion" "calling Perl from"
10043 This item is available only if Exim has been built to include an embedded Perl
10044 interpreter. The subroutine name and the arguments are first separately
10045 expanded, and then the Perl subroutine is called with those arguments. No
10046 additional arguments need be given; the maximum number permitted, including the
10047 name of the subroutine, is nine.
10048
10049 The return value of the subroutine is inserted into the expanded string, unless
10050 the return value is &%undef%&. In that case, the expansion fails in the same
10051 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10052 Whatever you return is evaluated in a scalar context. For example, if you
10053 return the name of a Perl vector, the return value is the size of the vector,
10054 not its contents.
10055
10056 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10057 with the error message that was passed to &%die%&. More details of the embedded
10058 Perl facility are given in chapter &<<CHAPperl>>&.
10059
10060 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10061 out the use of this expansion item in filter files.
10062
10063
10064 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10065 .cindex "&%prvs%& expansion item"
10066 The first argument is a complete email address and the second is secret
10067 keystring. The third argument, specifying a key number, is optional. If absent,
10068 it defaults to 0. The result of the expansion is a prvs-signed email address,
10069 to be typically used with the &%return_path%& option on an &(smtp)& transport
10070 as part of a bounce address tag validation (BATV) scheme. For more discussion
10071 and an example, see section &<<SECTverifyPRVS>>&.
10072
10073 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10074         {*&<&'string'&>&*}}*&"
10075 .cindex "&%prvscheck%& expansion item"
10076 This expansion item is the complement of the &%prvs%& item. It is used for
10077 checking prvs-signed addresses. If the expansion of the first argument does not
10078 yield a syntactically valid prvs-signed address, the whole item expands to the
10079 empty string. When the first argument does expand to a syntactically valid
10080 prvs-signed address, the second argument is expanded, with the prvs-decoded
10081 version of the address and the key number extracted from the address in the
10082 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10083
10084 These two variables can be used in the expansion of the second argument to
10085 retrieve the secret. The validity of the prvs-signed address is then checked
10086 against the secret. The result is stored in the variable &$prvscheck_result$&,
10087 which is empty for failure or &"1"& for success.
10088
10089 The third argument is optional; if it is missing, it defaults to an empty
10090 string. This argument is now expanded. If the result is an empty string, the
10091 result of the expansion is the decoded version of the address. This is the case
10092 whether or not the signature was valid. Otherwise, the result of the expansion
10093 is the expansion of the third argument.
10094
10095 All three variables can be used in the expansion of the third argument.
10096 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10097 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10098
10099 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10100 .cindex "expansion" "inserting an entire file"
10101 .cindex "file" "inserting into expansion"
10102 .cindex "&%readfile%& expansion item"
10103 The filename and end-of-line string are first expanded separately. The file is
10104 then read, and its contents replace the entire item. All newline characters in
10105 the file are replaced by the end-of-line string if it is present. Otherwise,
10106 newlines are left in the string.
10107 String expansion is not applied to the contents of the file. If you want this,
10108 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10109 the string expansion fails.
10110
10111 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10112 locks out the use of this expansion item in filter files.
10113
10114
10115
10116 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10117         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10118 .cindex "expansion" "inserting from a socket"
10119 .cindex "socket, use of in expansion"
10120 .cindex "&%readsocket%& expansion item"
10121 This item inserts data from a Unix domain or TCP socket into the expanded
10122 string. The minimal way of using it uses just two arguments, as in these
10123 examples:
10124 .code
10125 ${readsocket{/socket/name}{request string}}
10126 ${readsocket{inet:some.host:1234}{request string}}
10127 .endd
10128 For a Unix domain socket, the first substring must be the path to the socket.
10129 For an Internet socket, the first substring must contain &`inet:`& followed by
10130 a host name or IP address, followed by a colon and a port, which can be a
10131 number or the name of a TCP port in &_/etc/services_&. An IP address may
10132 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10133 example:
10134 .code
10135 ${readsocket{inet:[::1]:1234}{request string}}
10136 .endd
10137 Only a single host name may be given, but if looking it up yields more than
10138 one IP address, they are each tried in turn until a connection is made. For
10139 both kinds of socket, Exim makes a connection, writes the request string
10140 unless it is an empty string; and no terminating NUL is ever sent)
10141 and reads from the socket until an end-of-file
10142 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10143 extend what can be done. Firstly, you can vary the timeout. For example:
10144 .code
10145 ${readsocket{/socket/name}{request string}{3s}}
10146 .endd
10147
10148 The third argument is a list of options, of which the first element is the timeout
10149 and must be present if the argument is given.
10150 Further elements are options of form &'name=value'&.
10151 Two option types is currently recognised: shutdown and tls.
10152 The first defines whether (the default)
10153 or not a shutdown is done on the connection after sending the request.
10154 Example, to not do so (preferred, eg. by some webservers):
10155 .code
10156 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10157 .endd
10158 The second, tls, controls the use of TLS on the connection.  Example:
10159 .code
10160 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10161 .endd
10162 The default is to not use TLS.
10163 If it is enabled, a shutdown as descripbed above is never done.
10164
10165 A fourth argument allows you to change any newlines that are in the data
10166 that is read, in the same way as for &%readfile%& (see above). This example
10167 turns them into spaces:
10168 .code
10169 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10170 .endd
10171 As with all expansions, the substrings are expanded before the processing
10172 happens. Errors in these sub-expansions cause the expansion to fail. In
10173 addition, the following errors can occur:
10174
10175 .ilist
10176 Failure to create a socket file descriptor;
10177 .next
10178 Failure to connect the socket;
10179 .next
10180 Failure to write the request string;
10181 .next
10182 Timeout on reading from the socket.
10183 .endlist
10184
10185 By default, any of these errors causes the expansion to fail. However, if
10186 you supply a fifth substring, it is expanded and used when any of the above
10187 errors occurs. For example:
10188 .code
10189 ${readsocket{/socket/name}{request string}{3s}{\n}\
10190   {socket failure}}
10191 .endd
10192 You can test for the existence of a Unix domain socket by wrapping this
10193 expansion in &`${if exists`&, but there is a race condition between that test
10194 and the actual opening of the socket, so it is safer to use the fifth argument
10195 if you want to be absolutely sure of avoiding an expansion error for a
10196 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10197
10198 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10199 locks out the use of this expansion item in filter files.
10200
10201
10202 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10203 .cindex "expansion" "reducing a list to a scalar"
10204 .cindex "list" "reducing to a scalar"
10205 .vindex "&$value$&"
10206 .vindex "&$item$&"
10207 This operation reduces a list to a single, scalar string. After expansion,
10208 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10209 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10210 Then <&'string2'&> is expanded and
10211 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10212 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10213 them. The result of that expansion is assigned to &$value$& before the next
10214 iteration. When the end of the list is reached, the final value of &$value$& is
10215 added to the expansion output. The &%reduce%& expansion item can be used in a
10216 number of ways. For example, to add up a list of numbers:
10217 .code
10218 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10219 .endd
10220 The result of that expansion would be &`6`&. The maximum of a list of numbers
10221 can be found:
10222 .code
10223 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10224 .endd
10225 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10226 restored to what they were before. See also the &%filter%& and &%map%&
10227 expansion items.
10228
10229 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10230 This item inserts &"raw"& header lines. It is described with the &%header%&
10231 expansion item in section &<<SECTexpansionitems>>& above.
10232
10233 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10234         {*&<&'string2'&>&*}}*&"
10235 .cindex "expansion" "running a command"
10236 .cindex "&%run%& expansion item"
10237 The command and its arguments are first expanded as one string. The string is
10238 split apart into individual arguments by spaces, and then the command is run
10239 in a separate process, but under the same uid and gid.  As in other command
10240 executions from Exim, a shell is not used by default. If the command requires
10241 a shell, you must explicitly code it.
10242
10243 Since the arguments are split by spaces, when there is a variable expansion
10244 which has an empty result, it will cause the situation that the argument will
10245 simply be omitted when the program is actually executed by Exim. If the
10246 script/program requires a specific number of arguments and the expanded
10247 variable could possibly result in this empty expansion, the variable must be
10248 quoted. This is more difficult if the expanded variable itself could result
10249 in a string containing quotes, because it would interfere with the quotes
10250 around the command arguments. A possible guard against this is to wrap the
10251 variable in the &%sg%& operator to change any quote marks to some other
10252 character.
10253
10254 The standard input for the command exists, but is empty. The standard output
10255 and standard error are set to the same file descriptor.
10256 .cindex "return code" "from &%run%& expansion"
10257 .vindex "&$value$&"
10258 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10259 and replaces the entire item; during this expansion, the standard output/error
10260 from the command is in the variable &$value$&. If the command fails,
10261 <&'string2'&>, if present, is expanded and used. Once again, during the
10262 expansion, the standard output/error from the command is in the variable
10263 &$value$&.
10264
10265 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10266 can be the word &"fail"& (not in braces) to force expansion failure if the
10267 command does not succeed. If both strings are omitted, the result is contents
10268 of the standard output/error on success, and nothing on failure.
10269
10270 .vindex "&$run_in_acl$&"
10271 The standard output/error of the command is put in the variable &$value$&.
10272 In this ACL example, the output of a command is logged for the admin to
10273 troubleshoot:
10274 .code
10275 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10276       log_message  = Output of id: $value
10277 .endd
10278 If the command requires shell idioms, such as the > redirect operator, the
10279 shell must be invoked directly, such as with:
10280 .code
10281 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10282 .endd
10283
10284 .vindex "&$runrc$&"
10285 The return code from the command is put in the variable &$runrc$&, and this
10286 remains set afterwards, so in a filter file you can do things like this:
10287 .code
10288 if "${run{x y z}{}}$runrc" is 1 then ...
10289   elif $runrc is 2 then ...
10290   ...
10291 endif
10292 .endd
10293 If execution of the command fails (for example, the command does not exist),
10294 the return code is 127 &-- the same code that shells use for non-existent
10295 commands.
10296
10297 &*Warning*&: In a router or transport, you cannot assume the order in which
10298 option values are expanded, except for those preconditions whose order of
10299 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10300 by the expansion of one option, and use it in another.
10301
10302 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10303 out the use of this expansion item in filter files.
10304
10305
10306 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10307 .cindex "expansion" "string substitution"
10308 .cindex "&%sg%& expansion item"
10309 This item works like Perl's substitution operator (s) with the global (/g)
10310 option; hence its name. However, unlike the Perl equivalent, Exim does not
10311 modify the subject string; instead it returns the modified string for insertion
10312 into the overall expansion. The item takes three arguments: the subject string,
10313 a regular expression, and a substitution string. For example:
10314 .code
10315 ${sg{abcdefabcdef}{abc}{xyz}}
10316 .endd
10317 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10318 if any $, } or \ characters are required in the regular expression or in the
10319 substitution string, they have to be escaped. For example:
10320 .code
10321 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10322 .endd
10323 yields &"defabc"&, and
10324 .code
10325 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10326 .endd
10327 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10328 the regular expression from string expansion.
10329
10330 The regular expression is compiled in 8-bit mode, working against bytes
10331 rather than any Unicode-aware character handling.
10332
10333
10334 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10335 .cindex sorting "a list"
10336 .cindex list sorting
10337 .cindex expansion "list sorting"
10338 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10339 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10340 The <&'comparator'&> argument is interpreted as the operator
10341 of a two-argument expansion condition.
10342 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10343 The comparison should return true when applied to two values
10344 if the first value should sort before the second value.
10345 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10346 the element being placed in &$item$&,
10347 to give values for comparison.
10348
10349 The item result is a sorted list,
10350 with the original list separator,
10351 of the list elements (in full) of the original.
10352
10353 Examples:
10354 .code
10355 ${sort{3:2:1:4}{<}{$item}}
10356 .endd
10357 sorts a list of numbers, and
10358 .code
10359 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10360 .endd
10361 will sort an MX lookup into priority order.
10362
10363
10364 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10365 .cindex "&%substr%& expansion item"
10366 .cindex "substring extraction"
10367 .cindex "expansion" "substring extraction"
10368 The three strings are expanded; the first two must yield numbers. Call them
10369 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10370 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10371 can use the simpler operator notation that avoids some of the braces:
10372 .code
10373 ${substr_<n>_<m>:<string>}
10374 .endd
10375 The second number is optional (in both notations).
10376 If it is absent in the simpler format, the preceding underscore must also be
10377 omitted.
10378
10379 The &%substr%& item can be used to extract more general substrings than
10380 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10381 length required. For example
10382 .code
10383 ${substr{3}{2}{$local_part}}
10384 .endd
10385 If the starting offset is greater than the string length the result is the
10386 null string; if the length plus starting offset is greater than the string
10387 length, the result is the right-hand part of the string, starting from the
10388 given offset. The first byte (character) in the string has offset zero.
10389
10390 The &%substr%& expansion item can take negative offset values to count
10391 from the right-hand end of its operand. The last byte (character) is offset -1,
10392 the second-last is offset -2, and so on. Thus, for example,
10393 .code
10394 ${substr{-5}{2}{1234567}}
10395 .endd
10396 yields &"34"&. If the absolute value of a negative offset is greater than the
10397 length of the string, the substring starts at the beginning of the string, and
10398 the length is reduced by the amount of overshoot. Thus, for example,
10399 .code
10400 ${substr{-5}{2}{12}}
10401 .endd
10402 yields an empty string, but
10403 .code
10404 ${substr{-3}{2}{12}}
10405 .endd
10406 yields &"1"&.
10407
10408 When the second number is omitted from &%substr%&, the remainder of the string
10409 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10410 string preceding the offset point are taken. For example, an offset of -1 and
10411 no length, as in these semantically identical examples:
10412 .code
10413 ${substr_-1:abcde}
10414 ${substr{-1}{abcde}}
10415 .endd
10416 yields all but the last character of the string, that is, &"abcd"&.
10417
10418 All measurement is done in bytes and is not UTF-8 aware.
10419
10420
10421
10422 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10423         {*&<&'replacements'&>&*}}*&"
10424 .cindex "expansion" "character translation"
10425 .cindex "&%tr%& expansion item"
10426 This item does single-character (in bytes) translation on its subject string. The second
10427 argument is a list of characters to be translated in the subject string. Each
10428 matching character is replaced by the corresponding character from the
10429 replacement list. For example
10430 .code
10431 ${tr{abcdea}{ac}{13}}
10432 .endd
10433 yields &`1b3de1`&. If there are duplicates in the second character string, the
10434 last occurrence is used. If the third string is shorter than the second, its
10435 last character is replicated. However, if it is empty, no translation takes
10436 place.
10437
10438 All character handling is done in bytes and is not UTF-8 aware.
10439
10440 .endlist
10441
10442
10443
10444 .section "Expansion operators" "SECTexpop"
10445 .cindex "expansion" "operators"
10446 For expansion items that perform transformations on a single argument string,
10447 the &"operator"& notation is used because it is simpler and uses fewer braces.
10448 The substring is first expanded before the operation is applied to it. The
10449 following operations can be performed:
10450
10451 .vlist
10452 .vitem &*${address:*&<&'string'&>&*}*&
10453 .cindex "expansion" "RFC 2822 address handling"
10454 .cindex "&%address%& expansion item"
10455 The string is interpreted as an RFC 2822 address, as it might appear in a
10456 header line, and the effective address is extracted from it. If the string does
10457 not parse successfully, the result is empty.
10458
10459 The parsing correctly handles SMTPUTF8 Unicode in the string.
10460
10461
10462 .vitem &*${addresses:*&<&'string'&>&*}*&
10463 .cindex "expansion" "RFC 2822 address handling"
10464 .cindex "&%addresses%& expansion item"
10465 The string (after expansion) is interpreted as a list of addresses in RFC
10466 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10467 operative address (&'local-part@domain'&) is extracted from each item, and the
10468 result of the expansion is a colon-separated list, with appropriate
10469 doubling of colons should any happen to be present in the email addresses.
10470 Syntactically invalid RFC2822 address items are omitted from the output.
10471
10472 It is possible to specify a character other than colon for the output
10473 separator by starting the string with > followed by the new separator
10474 character. For example:
10475 .code
10476 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10477 .endd
10478 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10479 first, so if the expanded string starts with >, it may change the output
10480 separator unintentionally. This can be avoided by setting the output
10481 separator explicitly:
10482 .code
10483 ${addresses:>:$h_from:}
10484 .endd
10485
10486 Compare the &%address%& (singular)
10487 expansion item, which extracts the working address from a single RFC2822
10488 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10489 processing lists.
10490
10491 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10492 a strict interpretation of header line formatting.  Exim parses the bare,
10493 unquoted portion of an email address and if it finds a comma, treats it as an
10494 email address separator. For the example header line:
10495 .code
10496 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10497 .endd
10498 The first example below demonstrates that Q-encoded email addresses are parsed
10499 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10500 It does not see the comma because it's still encoded as "=2C".  The second
10501 example below is passed the contents of &`$header_from:`&, meaning it gets
10502 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10503 The third example shows that the presence of a comma is skipped when it is
10504 quoted.  The fourth example shows SMTPUTF8 handling.
10505 .code
10506 # exim -be '${addresses:From: \
10507 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10508 user@example.com
10509 # exim -be '${addresses:From: Last, First <user@example.com>}'
10510 Last:user@example.com
10511 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10512 user@example.com
10513 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10514 フィリップ@example.jp
10515 .endd
10516
10517 .vitem &*${base32:*&<&'digits'&>&*}*&
10518 .cindex "&%base32%& expansion item"
10519 .cindex "expansion" "conversion to base 32"
10520 The string must consist entirely of decimal digits. The number is converted to
10521 base 32 and output as a (empty, for zero) string of characters.
10522 Only lowercase letters are used.
10523
10524 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10525 .cindex "&%base32d%& expansion item"
10526 .cindex "expansion" "conversion to base 32"
10527 The string must consist entirely of base-32 digits.
10528 The number is converted to decimal and output as a string.
10529
10530 .vitem &*${base62:*&<&'digits'&>&*}*&
10531 .cindex "&%base62%& expansion item"
10532 .cindex "expansion" "conversion to base 62"
10533 The string must consist entirely of decimal digits. The number is converted to
10534 base 62 and output as a string of six characters, including leading zeros. In
10535 the few operating environments where Exim uses base 36 instead of base 62 for
10536 its message identifiers (because those systems do not have case-sensitive
10537 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10538 to be absolutely clear: this is &'not'& base64 encoding.
10539
10540 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10541 .cindex "&%base62d%& expansion item"
10542 .cindex "expansion" "conversion to base 62"
10543 The string must consist entirely of base-62 digits, or, in operating
10544 environments where Exim uses base 36 instead of base 62 for its message
10545 identifiers, base-36 digits. The number is converted to decimal and output as a
10546 string.
10547
10548 .vitem &*${base64:*&<&'string'&>&*}*&
10549 .cindex "expansion" "base64 encoding"
10550 .cindex "base64 encoding" "in string expansion"
10551 .cindex "&%base64%& expansion item"
10552 .cindex certificate "base64 of DER"
10553 This operator converts a string into one that is base64 encoded.
10554
10555 If the string is a single variable of type certificate,
10556 returns the base64 encoding of the DER form of the certificate.
10557
10558
10559 .vitem &*${base64d:*&<&'string'&>&*}*&
10560 .cindex "expansion" "base64 decoding"
10561 .cindex "base64 decoding" "in string expansion"
10562 .cindex "&%base64d%& expansion item"
10563 This operator converts a base64-encoded string into the un-coded form.
10564
10565
10566 .vitem &*${domain:*&<&'string'&>&*}*&
10567 .cindex "domain" "extraction"
10568 .cindex "expansion" "domain extraction"
10569 The string is interpreted as an RFC 2822 address and the domain is extracted
10570 from it. If the string does not parse successfully, the result is empty.
10571
10572
10573 .vitem &*${escape:*&<&'string'&>&*}*&
10574 .cindex "expansion" "escaping non-printing characters"
10575 .cindex "&%escape%& expansion item"
10576 If the string contains any non-printing characters, they are converted to
10577 escape sequences starting with a backslash. Whether characters with the most
10578 significant bit set (so-called &"8-bit characters"&) count as printing or not
10579 is controlled by the &%print_topbitchars%& option.
10580
10581 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10582 .cindex "expansion" "escaping 8-bit characters"
10583 .cindex "&%escape8bit%& expansion item"
10584 If the string contains and characters with the most significant bit set,
10585 they are converted to escape sequences starting with a backslash.
10586 Backslashes and DEL characters are also converted.
10587
10588
10589 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10590 .cindex "expansion" "expression evaluation"
10591 .cindex "expansion" "arithmetic expression"
10592 .cindex "&%eval%& expansion item"
10593 These items supports simple arithmetic and bitwise logical operations in
10594 expansion strings. The string (after expansion) must be a conventional
10595 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10596 logical operators, and parentheses. All operations are carried out using
10597 integer arithmetic. The operator priorities are as follows (the same as in the
10598 C programming language):
10599 .table2 70pt 300pt
10600 .irow &'highest:'& "not (~), negate (-)"
10601 .irow ""   "multiply (*), divide (/), remainder (%)"
10602 .irow ""   "plus (+), minus (-)"
10603 .irow ""   "shift-left (<<), shift-right (>>)"
10604 .irow ""   "and (&&)"
10605 .irow ""   "xor (^)"
10606 .irow &'lowest:'&  "or (|)"
10607 .endtable
10608 Binary operators with the same priority are evaluated from left to right. White
10609 space is permitted before or after operators.
10610
10611 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10612 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10613 decimal, even if they start with a leading zero; hexadecimal numbers are not
10614 permitted. This can be useful when processing numbers extracted from dates or
10615 times, which often do have leading zeros.
10616
10617 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10618 or 1024*1024*1024,
10619 respectively. Negative numbers are supported. The result of the computation is
10620 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10621
10622 .display
10623 &`${eval:1+1}            `&  yields 2
10624 &`${eval:1+2*3}          `&  yields 7
10625 &`${eval:(1+2)*3}        `&  yields 9
10626 &`${eval:2+42%5}         `&  yields 4
10627 &`${eval:0xc&amp;5}          `&  yields 4
10628 &`${eval:0xc|5}          `&  yields 13
10629 &`${eval:0xc^5}          `&  yields 9
10630 &`${eval:0xc>>1}         `&  yields 6
10631 &`${eval:0xc<<1}         `&  yields 24
10632 &`${eval:~255&amp;0x1234}    `&  yields 4608
10633 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10634 .endd
10635
10636 As a more realistic example, in an ACL you might have
10637 .code
10638 deny   message = Too many bad recipients
10639        condition =                    \
10640          ${if and {                   \
10641            {>{$rcpt_count}{10}}       \
10642            {                          \
10643            <                          \
10644              {$recipients_count}      \
10645              {${eval:$rcpt_count/2}}  \
10646            }                          \
10647          }{yes}{no}}
10648 .endd
10649 The condition is true if there have been more than 10 RCPT commands and
10650 fewer than half of them have resulted in a valid recipient.
10651
10652
10653 .vitem &*${expand:*&<&'string'&>&*}*&
10654 .cindex "expansion" "re-expansion of substring"
10655 The &%expand%& operator causes a string to be expanded for a second time. For
10656 example,
10657 .code
10658 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10659 .endd
10660 first looks up a string in a file while expanding the operand for &%expand%&,
10661 and then re-expands what it has found.
10662
10663
10664 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10665 .cindex "Unicode"
10666 .cindex "UTF-8" "conversion from"
10667 .cindex "expansion" "UTF-8 conversion"
10668 .cindex "&%from_utf8%& expansion item"
10669 The world is slowly moving towards Unicode, although there are no standards for
10670 email yet. However, other applications (including some databases) are starting
10671 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10672 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10673 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10674 the result is an undefined sequence of bytes.
10675
10676 Unicode code points with values less than 256 are compatible with ASCII and
10677 ISO-8859-1 (also known as Latin-1).
10678 For example, character 169 is the copyright symbol in both cases, though the
10679 way it is encoded is different. In UTF-8, more than one byte is needed for
10680 characters with code values greater than 127, whereas ISO-8859-1 is a
10681 single-byte encoding (but thereby limited to 256 characters). This makes
10682 translation from UTF-8 to ISO-8859-1 straightforward.
10683
10684
10685 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10686 .cindex "hash function" "textual"
10687 .cindex "expansion" "textual hash"
10688 The &%hash%& operator is a simpler interface to the hashing function that can
10689 be used when the two parameters are fixed numbers (as opposed to strings that
10690 change when expanded). The effect is the same as
10691 .code
10692 ${hash{<n>}{<m>}{<string>}}
10693 .endd
10694 See the description of the general &%hash%& item above for details. The
10695 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10696
10697
10698
10699 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10700 .cindex "base64 encoding" "conversion from hex"
10701 .cindex "expansion" "hex to base64"
10702 .cindex "&%hex2b64%& expansion item"
10703 This operator converts a hex string into one that is base64 encoded. This can
10704 be useful for processing the output of the various hashing functions.
10705
10706
10707
10708 .vitem &*${hexquote:*&<&'string'&>&*}*&
10709 .cindex "quoting" "hex-encoded unprintable characters"
10710 .cindex "&%hexquote%& expansion item"
10711 This operator converts non-printable characters in a string into a hex
10712 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10713 as is, and other byte values are converted to &`\xNN`&, for example, a
10714 byte value 127 is converted to &`\x7f`&.
10715
10716
10717 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10718 .cindex "&%ipv6denorm%& expansion item"
10719 .cindex "IP address" normalisation
10720 This expands an IPv6 address to a full eight-element colon-separated set
10721 of hex digits including leading zeroes.
10722 A trailing ipv4-style dotted-decimal set is converted to hex.
10723 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10724
10725 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10726 .cindex "&%ipv6norm%& expansion item"
10727 .cindex "IP address" normalisation
10728 .cindex "IP address" "canonical form"
10729 This converts an IPv6 address to canonical form.
10730 Leading zeroes of groups are omitted, and the longest
10731 set of zero-valued groups is replaced with a double colon.
10732 A trailing ipv4-style dotted-decimal set is converted to hex.
10733 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10734
10735
10736 .vitem &*${lc:*&<&'string'&>&*}*&
10737 .cindex "case forcing in strings"
10738 .cindex "string" "case forcing"
10739 .cindex "lower casing"
10740 .cindex "expansion" "case forcing"
10741 .cindex "&%lc%& expansion item"
10742 This forces the letters in the string into lower-case, for example:
10743 .code
10744 ${lc:$local_part}
10745 .endd
10746 Case is defined per the system C locale.
10747
10748 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10749 .cindex "expansion" "string truncation"
10750 .cindex "&%length%& expansion item"
10751 The &%length%& operator is a simpler interface to the &%length%& function that
10752 can be used when the parameter is a fixed number (as opposed to a string that
10753 changes when expanded). The effect is the same as
10754 .code
10755 ${length{<number>}{<string>}}
10756 .endd
10757 See the description of the general &%length%& item above for details. Note that
10758 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10759 when &%length%& is used as an operator.
10760 All measurement is done in bytes and is not UTF-8 aware.
10761
10762
10763 .vitem &*${listcount:*&<&'string'&>&*}*&
10764 .cindex "expansion" "list item count"
10765 .cindex "list" "item count"
10766 .cindex "list" "count of items"
10767 .cindex "&%listcount%& expansion item"
10768 The string is interpreted as a list and the number of items is returned.
10769
10770
10771 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10772 .cindex "expansion" "named list"
10773 .cindex "&%listnamed%& expansion item"
10774 The name is interpreted as a named list and the content of the list is returned,
10775 expanding any referenced lists, re-quoting as needed for colon-separation.
10776 If the optional type is given it must be one of "a", "d", "h" or "l"
10777 and selects address-, domain-, host- or localpart- lists to search among respectively.
10778 Otherwise all types are searched in an undefined order and the first
10779 matching list is returned.
10780
10781
10782 .vitem &*${local_part:*&<&'string'&>&*}*&
10783 .cindex "expansion" "local part extraction"
10784 .cindex "&%local_part%& expansion item"
10785 The string is interpreted as an RFC 2822 address and the local part is
10786 extracted from it. If the string does not parse successfully, the result is
10787 empty.
10788 The parsing correctly handles SMTPUTF8 Unicode in the string.
10789
10790
10791 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10792 .cindex "masked IP address"
10793 .cindex "IP address" "masking"
10794 .cindex "CIDR notation"
10795 .cindex "expansion" "IP address masking"
10796 .cindex "&%mask%& expansion item"
10797 If the form of the string to be operated on is not an IP address followed by a
10798 slash and an integer (that is, a network address in CIDR notation), the
10799 expansion fails. Otherwise, this operator converts the IP address to binary,
10800 masks off the least significant bits according to the bit count, and converts
10801 the result back to text, with mask appended. For example,
10802 .code
10803 ${mask:10.111.131.206/28}
10804 .endd
10805 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10806 be mostly used for looking up masked addresses in files, the result for an IPv6
10807 address uses dots to separate components instead of colons, because colon
10808 terminates a key string in lsearch files. So, for example,
10809 .code
10810 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10811 .endd
10812 returns the string
10813 .code
10814 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10815 .endd
10816 Letters in IPv6 addresses are always output in lower case.
10817
10818
10819 .vitem &*${md5:*&<&'string'&>&*}*&
10820 .cindex "MD5 hash"
10821 .cindex "expansion" "MD5 hash"
10822 .cindex certificate fingerprint
10823 .cindex "&%md5%& expansion item"
10824 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10825 as a 32-digit hexadecimal number, in which any letters are in lower case.
10826
10827 If the string is a single variable of type certificate,
10828 returns the MD5 hash fingerprint of the certificate.
10829
10830
10831 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10832 .cindex "expansion" "numeric hash"
10833 .cindex "hash function" "numeric"
10834 The &%nhash%& operator is a simpler interface to the numeric hashing function
10835 that can be used when the two parameters are fixed numbers (as opposed to
10836 strings that change when expanded). The effect is the same as
10837 .code
10838 ${nhash{<n>}{<m>}{<string>}}
10839 .endd
10840 See the description of the general &%nhash%& item above for details.
10841
10842
10843 .vitem &*${quote:*&<&'string'&>&*}*&
10844 .cindex "quoting" "in string expansions"
10845 .cindex "expansion" "quoting"
10846 .cindex "&%quote%& expansion item"
10847 The &%quote%& operator puts its argument into double quotes if it
10848 is an empty string or
10849 contains anything other than letters, digits, underscores, dots, and hyphens.
10850 Any occurrences of double quotes and backslashes are escaped with a backslash.
10851 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10852 respectively For example,
10853 .code
10854 ${quote:ab"*"cd}
10855 .endd
10856 becomes
10857 .code
10858 "ab\"*\"cd"
10859 .endd
10860 The place where this is useful is when the argument is a substitution from a
10861 variable or a message header.
10862
10863 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10864 .cindex "&%quote_local_part%& expansion item"
10865 This operator is like &%quote%&, except that it quotes the string only if
10866 required to do so by the rules of RFC 2822 for quoting local parts. For
10867 example, a plus sign would not cause quoting (but it would for &%quote%&).
10868 If you are creating a new email address from the contents of &$local_part$&
10869 (or any other unknown data), you should always use this operator.
10870
10871 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10872 will likely use the quoting form.
10873 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10874
10875
10876 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10877 .cindex "quoting" "lookup-specific"
10878 This operator applies lookup-specific quoting rules to the string. Each
10879 query-style lookup type has its own quoting rules which are described with
10880 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10881 .code
10882 ${quote_ldap:two * two}
10883 .endd
10884 returns
10885 .code
10886 two%20%5C2A%20two
10887 .endd
10888 For single-key lookup types, no quoting is ever necessary and this operator
10889 yields an unchanged string.
10890
10891
10892 .vitem &*${randint:*&<&'n'&>&*}*&
10893 .cindex "random number"
10894 This operator returns a somewhat random number which is less than the
10895 supplied number and is at least 0.  The quality of this randomness depends
10896 on how Exim was built; the values are not suitable for keying material.
10897 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10898 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10899 for versions of GnuTLS with that function.
10900 Otherwise, the implementation may be arc4random(), random() seeded by
10901 srandomdev() or srandom(), or a custom implementation even weaker than
10902 random().
10903
10904
10905 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10906 .cindex "expansion" "IP address"
10907 This operator reverses an IP address; for IPv4 addresses, the result is in
10908 dotted-quad decimal form, while for IPv6 addresses the result is in
10909 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10910 for DNS.  For example,
10911 .code
10912 ${reverse_ip:192.0.2.4}
10913 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10914 .endd
10915 returns
10916 .code
10917 4.2.0.192
10918 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
10919 .endd
10920
10921
10922 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10923 .cindex "expansion" "RFC 2047"
10924 .cindex "RFC 2047" "expansion operator"
10925 .cindex "&%rfc2047%& expansion item"
10926 This operator encodes text according to the rules of RFC 2047. This is an
10927 encoding that is used in header lines to encode non-ASCII characters. It is
10928 assumed that the input string is in the encoding specified by the
10929 &%headers_charset%& option, which gets its default at build time. If the string
10930 contains only characters in the range 33&--126, and no instances of the
10931 characters
10932 .code
10933 ? = ( ) < > @ , ; : \ " . [ ] _
10934 .endd
10935 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10936 string, using as many &"encoded words"& as necessary to encode all the
10937 characters.
10938
10939
10940 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10941 .cindex "expansion" "RFC 2047"
10942 .cindex "RFC 2047" "decoding"
10943 .cindex "&%rfc2047d%& expansion item"
10944 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10945 bytes are replaced by question marks. Characters are converted into the
10946 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10947 not recognized unless &%check_rfc2047_length%& is set false.
10948
10949 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10950 access a header line, RFC 2047 decoding is done automatically. You do not need
10951 to use this operator as well.
10952
10953
10954
10955 .vitem &*${rxquote:*&<&'string'&>&*}*&
10956 .cindex "quoting" "in regular expressions"
10957 .cindex "regular expressions" "quoting"
10958 .cindex "&%rxquote%& expansion item"
10959 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10960 characters in its argument. This is useful when substituting the values of
10961 variables or headers inside regular expressions.
10962
10963
10964 .vitem &*${sha1:*&<&'string'&>&*}*&
10965 .cindex "SHA-1 hash"
10966 .cindex "expansion" "SHA-1 hashing"
10967 .cindex certificate fingerprint
10968 .cindex "&%sha1%& expansion item"
10969 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10970 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10971
10972 If the string is a single variable of type certificate,
10973 returns the SHA-1 hash fingerprint of the certificate.
10974
10975
10976 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
10977        &*${sha2:*&<&'string'&>&*}*& &&&
10978        &*${sha2_<n>:*&<&'string'&>&*}*&
10979 .cindex "SHA-256 hash"
10980 .cindex "SHA-2 hash"
10981 .cindex certificate fingerprint
10982 .cindex "expansion" "SHA-256 hashing"
10983 .cindex "&%sha256%& expansion item"
10984 .cindex "&%sha2%& expansion item"
10985 The &%sha256%& operator computes the SHA-256 hash value of the string
10986 and returns
10987 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10988
10989 If the string is a single variable of type certificate,
10990 returns the SHA-256 hash fingerprint of the certificate.
10991
10992 .new
10993 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
10994 (except for certificates, which are not supported).
10995 Finally, if an underbar
10996 and a number is appended it specifies the output length, selecting a
10997 member of the SHA-2 family of hash functions.
10998 Values of 256, 384 and 512 are accepted, with 256 being the default.
10999 .wen
11000
11001
11002 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11003        &*${sha3_<n>:*&<&'string'&>&*}*&
11004 .cindex "SHA3 hash"
11005 .cindex "expansion" "SHA3 hashing"
11006 .cindex "&%sha3%& expansion item"
11007 The &%sha3%& operator computes the SHA3-256 hash value of the string
11008 and returns
11009 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11010
11011 If a number is appended, separated by an underbar, it specifies
11012 the output length.  Values of 224, 256, 384 and 512 are accepted;
11013 with 256 being the default.
11014
11015 The &%sha3%& expansion item is only supported if Exim has been
11016 compiled with GnuTLS 3.5.0 or later,
11017 or OpenSSL 1.1.1 or later.
11018 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11019
11020
11021 .vitem &*${stat:*&<&'string'&>&*}*&
11022 .cindex "expansion" "statting a file"
11023 .cindex "file" "extracting characteristics"
11024 .cindex "&%stat%& expansion item"
11025 The string, after expansion, must be a file path. A call to the &[stat()]&
11026 function is made for this path. If &[stat()]& fails, an error occurs and the
11027 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11028 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11029 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11030 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11031 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11032 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11033 can extract individual fields using the &%extract%& expansion item.
11034
11035 The use of the &%stat%& expansion in users' filter files can be locked out by
11036 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11037 systems for files larger than 2GB.
11038
11039 .vitem &*${str2b64:*&<&'string'&>&*}*&
11040 .cindex "&%str2b64%& expansion item"
11041 Now deprecated, a synonym for the &%base64%& expansion operator.
11042
11043
11044
11045 .vitem &*${strlen:*&<&'string'&>&*}*&
11046 .cindex "expansion" "string length"
11047 .cindex "string" "length in expansion"
11048 .cindex "&%strlen%& expansion item"
11049 The item is replace by the length of the expanded string, expressed as a
11050 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11051 All measurement is done in bytes and is not UTF-8 aware.
11052
11053
11054 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11055 .cindex "&%substr%& expansion item"
11056 .cindex "substring extraction"
11057 .cindex "expansion" "substring expansion"
11058 The &%substr%& operator is a simpler interface to the &%substr%& function that
11059 can be used when the two parameters are fixed numbers (as opposed to strings
11060 that change when expanded). The effect is the same as
11061 .code
11062 ${substr{<start>}{<length>}{<string>}}
11063 .endd
11064 See the description of the general &%substr%& item above for details. The
11065 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11066 All measurement is done in bytes and is not UTF-8 aware.
11067
11068 .vitem &*${time_eval:*&<&'string'&>&*}*&
11069 .cindex "&%time_eval%& expansion item"
11070 .cindex "time interval" "decoding"
11071 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11072 seconds.
11073
11074 .vitem &*${time_interval:*&<&'string'&>&*}*&
11075 .cindex "&%time_interval%& expansion item"
11076 .cindex "time interval" "formatting"
11077 The argument (after sub-expansion) must be a sequence of decimal digits that
11078 represents an interval of time as a number of seconds. It is converted into a
11079 number of larger units and output in Exim's normal time format, for example,
11080 &`1w3d4h2m6s`&.
11081
11082 .vitem &*${uc:*&<&'string'&>&*}*&
11083 .cindex "case forcing in strings"
11084 .cindex "string" "case forcing"
11085 .cindex "upper casing"
11086 .cindex "expansion" "case forcing"
11087 .cindex "&%uc%& expansion item"
11088 This forces the letters in the string into upper-case.
11089 Case is defined per the system C locale.
11090
11091 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11092 .cindex "correction of invalid utf-8 sequences in strings"
11093 .cindex "utf-8" "utf-8 sequences"
11094 .cindex "incorrect utf-8"
11095 .cindex "expansion" "utf-8 forcing"
11096 .cindex "&%utf8clean%& expansion item"
11097 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11098 In versions of Exim before 4.92, this did not correctly do so for a truncated
11099 final codepoint's encoding, and the character would be silently dropped.
11100 If you must handle detection of this scenario across both sets of Exim behavior,
11101 the complexity will depend upon the task.
11102 For instance, to detect if the first character is multibyte and a 1-byte
11103 extraction can be successfully used as a path component (as is common for
11104 dividing up delivery folders), you might use:
11105 .code
11106 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11107 .endd
11108 (which will false-positive if the first character of the local part is a
11109 literal question mark).
11110
11111 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11112        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11113        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11114        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11115 .cindex expansion UTF-8
11116 .cindex UTF-8 expansion
11117 .cindex EAI
11118 .cindex internationalisation
11119 .cindex "&%utf8_domain_to_alabel%& expansion item"
11120 .cindex "&%utf8_domain_from_alabel%& expansion item"
11121 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11122 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11123 These convert EAI mail name components between UTF-8 and a-label forms.
11124 For information on internationalisation support see &<<SECTi18nMTA>>&.
11125 .endlist
11126
11127
11128
11129
11130
11131
11132 .section "Expansion conditions" "SECTexpcond"
11133 .scindex IIDexpcond "expansion" "conditions"
11134 The following conditions are available for testing by the &%${if%& construct
11135 while expanding strings:
11136
11137 .vlist
11138 .vitem &*!*&<&'condition'&>
11139 .cindex "expansion" "negating a condition"
11140 .cindex "negation" "in expansion condition"
11141 Preceding any condition with an exclamation mark negates the result of the
11142 condition.
11143
11144 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11145 .cindex "numeric comparison"
11146 .cindex "expansion" "numeric comparison"
11147 There are a number of symbolic operators for doing numeric comparisons. They
11148 are:
11149 .display
11150 &`=   `&   equal
11151 &`==  `&   equal
11152 &`>   `&   greater
11153 &`>=  `&   greater or equal
11154 &`<   `&   less
11155 &`<=  `&   less or equal
11156 .endd
11157 For example:
11158 .code
11159 ${if >{$message_size}{10M} ...
11160 .endd
11161 Note that the general negation operator provides for inequality testing. The
11162 two strings must take the form of optionally signed decimal integers,
11163 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11164 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11165 As a special case, the numerical value of an empty string is taken as
11166 zero.
11167
11168 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11169 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11170 10M, not if 10M is larger than &$message_size$&.
11171
11172
11173 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11174         {*&<&'arg2'&>&*}...}*&
11175 .cindex "expansion" "calling an acl"
11176 .cindex "&%acl%&" "expansion condition"
11177 The name and zero to nine argument strings are first expanded separately.  The expanded
11178 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11179 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11180 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11181 and may use the variables; if another acl expansion is used the values
11182 are restored after it returns.  If the ACL sets
11183 a value using a "message =" modifier the variable $value becomes
11184 the result of the expansion, otherwise it is empty.
11185 If the ACL returns accept the condition is true; if deny, false.
11186 If the ACL returns defer the result is a forced-fail.
11187
11188 .vitem &*bool&~{*&<&'string'&>&*}*&
11189 .cindex "expansion" "boolean parsing"
11190 .cindex "&%bool%& expansion condition"
11191 This condition turns a string holding a true or false representation into
11192 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11193 (case-insensitively); also integer numbers map to true if non-zero,
11194 false if zero.
11195 An empty string is treated as false.
11196 Leading and trailing whitespace is ignored;
11197 thus a string consisting only of whitespace is false.
11198 All other string values will result in expansion failure.
11199
11200 When combined with ACL variables, this expansion condition will let you
11201 make decisions in one place and act on those decisions in another place.
11202 For example:
11203 .code
11204 ${if bool{$acl_m_privileged_sender} ...
11205 .endd
11206
11207
11208 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11209 .cindex "expansion" "boolean parsing"
11210 .cindex "&%bool_lax%& expansion condition"
11211 Like &%bool%&, this condition turns a string into a boolean state.  But
11212 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11213 loose definition that the Router &%condition%& option uses.  The empty string
11214 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11215 true.  Leading and trailing whitespace is ignored.
11216
11217 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11218
11219 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11220 .cindex "expansion" "encrypted comparison"
11221 .cindex "encrypted strings, comparing"
11222 .cindex "&%crypteq%& expansion condition"
11223 This condition is included in the Exim binary if it is built to support any
11224 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11225 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11226 included in the binary.
11227
11228 The &%crypteq%& condition has two arguments. The first is encrypted and
11229 compared against the second, which is already encrypted. The second string may
11230 be in the LDAP form for storing encrypted strings, which starts with the
11231 encryption type in curly brackets, followed by the data. If the second string
11232 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11233 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11234 Typically this will be a field from a password file. An example of an encrypted
11235 string in LDAP form is:
11236 .code
11237 {md5}CY9rzUYh03PK3k6DJie09g==
11238 .endd
11239 If such a string appears directly in an expansion, the curly brackets have to
11240 be quoted, because they are part of the expansion syntax. For example:
11241 .code
11242 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11243 .endd
11244 The following encryption types (whose names are matched case-independently) are
11245 supported:
11246
11247 .ilist
11248 .cindex "MD5 hash"
11249 .cindex "base64 encoding" "in encrypted password"
11250 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11251 printable characters to compare with the remainder of the second string. If the
11252 length of the comparison string is 24, Exim assumes that it is base64 encoded
11253 (as in the above example). If the length is 32, Exim assumes that it is a
11254 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11255 comparison fails.
11256
11257 .next
11258 .cindex "SHA-1 hash"
11259 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11260 printable characters to compare with the remainder of the second string. If the
11261 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11262 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11263 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11264
11265 .next
11266 .cindex "&[crypt()]&"
11267 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11268 only the first eight characters of the password. However, in modern operating
11269 systems this is no longer true, and in many cases the entire password is used,
11270 whatever its length.
11271
11272 .next
11273 .cindex "&[crypt16()]&"
11274 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11275 use up to 16 characters of the password in some operating systems. Again, in
11276 modern operating systems, more characters may be used.
11277 .endlist
11278 Exim has its own version of &[crypt16()]&, which is just a double call to
11279 &[crypt()]&. For operating systems that have their own version, setting
11280 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11281 operating system version instead of its own. This option is set by default in
11282 the OS-dependent &_Makefile_& for those operating systems that are known to
11283 support &[crypt16()]&.
11284
11285 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11286 it was not using the same algorithm as some operating systems' versions. It
11287 turns out that as well as &[crypt16()]& there is a function called
11288 &[bigcrypt()]& in some operating systems. This may or may not use the same
11289 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11290
11291 However, since there is now a move away from the traditional &[crypt()]&
11292 functions towards using SHA1 and other algorithms, tidying up this area of
11293 Exim is seen as very low priority.
11294
11295 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11296 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11297 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11298 default is &`{crypt}`&. Whatever the default, you can always use either
11299 function by specifying it explicitly in curly brackets.
11300
11301 .vitem &*def:*&<&'variable&~name'&>
11302 .cindex "expansion" "checking for empty variable"
11303 .cindex "&%def%& expansion condition"
11304 The &%def%& condition must be followed by the name of one of the expansion
11305 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11306 variable does not contain the empty string. For example:
11307 .code
11308 ${if def:sender_ident {from $sender_ident}}
11309 .endd
11310 Note that the variable name is given without a leading &%$%& character. If the
11311 variable does not exist, the expansion fails.
11312
11313 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11314         &~&*def:h_*&<&'header&~name'&>&*:*&"
11315 .cindex "expansion" "checking header line existence"
11316 This condition is true if a message is being processed and the named header
11317 exists in the message. For example,
11318 .code
11319 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11320 .endd
11321 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11322 the header name must be terminated by a colon if white space does not follow.
11323
11324 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11325        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11326 .cindex "string" "comparison"
11327 .cindex "expansion" "string comparison"
11328 .cindex "&%eq%& expansion condition"
11329 .cindex "&%eqi%& expansion condition"
11330 The two substrings are first expanded. The condition is true if the two
11331 resulting strings are identical. For &%eq%& the comparison includes the case of
11332 letters, whereas for &%eqi%& the comparison is case-independent, where
11333 case is defined per the system C locale.
11334
11335 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11336 .cindex "expansion" "file existence test"
11337 .cindex "file" "existence test"
11338 .cindex "&%exists%&, expansion condition"
11339 The substring is first expanded and then interpreted as an absolute path. The
11340 condition is true if the named file (or directory) exists. The existence test
11341 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11342 users' filter files may be locked out by the system administrator.
11343
11344 .vitem &*first_delivery*&
11345 .cindex "delivery" "first"
11346 .cindex "first delivery"
11347 .cindex "expansion" "first delivery test"
11348 .cindex "&%first_delivery%& expansion condition"
11349 This condition, which has no data, is true during a message's first delivery
11350 attempt. It is false during any subsequent delivery attempts.
11351
11352
11353 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11354        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11355 .cindex "list" "iterative conditions"
11356 .cindex "expansion" "&*forall*& condition"
11357 .cindex "expansion" "&*forany*& condition"
11358 .vindex "&$item$&"
11359 These conditions iterate over a list. The first argument is expanded to form
11360 the list. By default, the list separator is a colon, but it can be changed by
11361 the normal method (&<<SECTlistsepchange>>&).
11362 The second argument is interpreted as a condition that is to
11363 be applied to each item in the list in turn. During the interpretation of the
11364 condition, the current list item is placed in a variable called &$item$&.
11365 .ilist
11366 For &*forany*&, interpretation stops if the condition is true for any item, and
11367 the result of the whole condition is true. If the condition is false for all
11368 items in the list, the overall condition is false.
11369 .next
11370 For &*forall*&, interpretation stops if the condition is false for any item,
11371 and the result of the whole condition is false. If the condition is true for
11372 all items in the list, the overall condition is true.
11373 .endlist
11374 Note that negation of &*forany*& means that the condition must be false for all
11375 items for the overall condition to succeed, and negation of &*forall*& means
11376 that the condition must be false for at least one item. In this example, the
11377 list separator is changed to a comma:
11378 .code
11379 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11380 .endd
11381 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11382 being processed, to enable these expansion items to be nested.
11383
11384 To scan a named list, expand it with the &*listnamed*& operator.
11385
11386 .new
11387 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11388        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11389        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11390        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11391 .cindex JSON "iterative conditions"
11392 .cindex JSON expansions
11393 .cindex expansion "&*forall_json*& condition"
11394 .cindex expansion "&*forany_json*& condition"
11395 .cindex expansion "&*forall_jsons*& condition"
11396 .cindex expansion "&*forany_jsons*& condition"
11397 As for the above, except that the first argument must, after expansion,
11398 be a JSON array.
11399 The array separator is not changeable.
11400 For the &"jsons"& variants the elements are expected to be JSON strings
11401 and have their quotes removed before the evaluation of the condition.
11402 .wen
11403
11404
11405
11406 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11407        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11408 .cindex "string" "comparison"
11409 .cindex "expansion" "string comparison"
11410 .cindex "&%ge%& expansion condition"
11411 .cindex "&%gei%& expansion condition"
11412 The two substrings are first expanded. The condition is true if the first
11413 string is lexically greater than or equal to the second string. For &%ge%& the
11414 comparison includes the case of letters, whereas for &%gei%& the comparison is
11415 case-independent.
11416 Case and collation order are defined per the system C locale.
11417
11418 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11419        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11420 .cindex "string" "comparison"
11421 .cindex "expansion" "string comparison"
11422 .cindex "&%gt%& expansion condition"
11423 .cindex "&%gti%& expansion condition"
11424 The two substrings are first expanded. The condition is true if the first
11425 string is lexically greater than the second string. For &%gt%& the comparison
11426 includes the case of letters, whereas for &%gti%& the comparison is
11427 case-independent.
11428 Case and collation order are defined per the system C locale.
11429
11430 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11431        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11432 .cindex "string" "comparison"
11433 .cindex "list" "iterative conditions"
11434 Both strings are expanded; the second string is treated as a list of simple
11435 strings; if the first string is a member of the second, then the condition
11436 is true.
11437 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11438
11439 These are simpler to use versions of the more powerful &*forany*& condition.
11440 Examples, and the &*forany*& equivalents:
11441 .code
11442 ${if inlist{needle}{foo:needle:bar}}
11443   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11444 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11445   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11446 .endd
11447
11448 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11449        &*isip4&~{*&<&'string'&>&*}*& &&&
11450        &*isip6&~{*&<&'string'&>&*}*&
11451 .cindex "IP address" "testing string format"
11452 .cindex "string" "testing for IP address"
11453 .cindex "&%isip%& expansion condition"
11454 .cindex "&%isip4%& expansion condition"
11455 .cindex "&%isip6%& expansion condition"
11456 The substring is first expanded, and then tested to see if it has the form of
11457 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11458 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11459
11460 For an IPv4 address, the test is for four dot-separated components, each of
11461 which consists of from one to three digits. For an IPv6 address, up to eight
11462 colon-separated components are permitted, each containing from one to four
11463 hexadecimal digits. There may be fewer than eight components if an empty
11464 component (adjacent colons) is present. Only one empty component is permitted.
11465
11466 &*Note*&: The checks used to be just on the form of the address; actual numerical
11467 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11468 check.
11469 This is no longer the case.
11470
11471 The main use of these tests is to distinguish between IP addresses and
11472 host names, or between IPv4 and IPv6 addresses. For example, you could use
11473 .code
11474 ${if isip4{$sender_host_address}...
11475 .endd
11476 to test which IP version an incoming SMTP connection is using.
11477
11478 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11479 .cindex "LDAP" "use for authentication"
11480 .cindex "expansion" "LDAP authentication test"
11481 .cindex "&%ldapauth%& expansion condition"
11482 This condition supports user authentication using LDAP. See section
11483 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11484 queries. For this use, the query must contain a user name and password. The
11485 query itself is not used, and can be empty. The condition is true if the
11486 password is not empty, and the user name and password are accepted by the LDAP
11487 server. An empty password is rejected without calling LDAP because LDAP binds
11488 with an empty password are considered anonymous regardless of the username, and
11489 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11490 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11491 this can be used.
11492
11493
11494 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11495        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11496 .cindex "string" "comparison"
11497 .cindex "expansion" "string comparison"
11498 .cindex "&%le%& expansion condition"
11499 .cindex "&%lei%& expansion condition"
11500 The two substrings are first expanded. The condition is true if the first
11501 string is lexically less than or equal to the second string. For &%le%& the
11502 comparison includes the case of letters, whereas for &%lei%& the comparison is
11503 case-independent.
11504 Case and collation order are defined per the system C locale.
11505
11506 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11507        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11508 .cindex "string" "comparison"
11509 .cindex "expansion" "string comparison"
11510 .cindex "&%lt%& expansion condition"
11511 .cindex "&%lti%& expansion condition"
11512 The two substrings are first expanded. The condition is true if the first
11513 string is lexically less than the second string. For &%lt%& the comparison
11514 includes the case of letters, whereas for &%lti%& the comparison is
11515 case-independent.
11516 Case and collation order are defined per the system C locale.
11517
11518
11519 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11520 .cindex "expansion" "regular expression comparison"
11521 .cindex "regular expressions" "match in expanded string"
11522 .cindex "&%match%& expansion condition"
11523 The two substrings are first expanded. The second is then treated as a regular
11524 expression and applied to the first. Because of the pre-expansion, if the
11525 regular expression contains dollar, or backslash characters, they must be
11526 escaped. Care must also be taken if the regular expression contains braces
11527 (curly brackets). A closing brace must be escaped so that it is not taken as a
11528 premature termination of <&'string2'&>. The easiest approach is to use the
11529 &`\N`& feature to disable expansion of the regular expression.
11530 For example,
11531 .code
11532 ${if match {$local_part}{\N^\d{3}\N} ...
11533 .endd
11534 If the whole expansion string is in double quotes, further escaping of
11535 backslashes is also required.
11536
11537 The condition is true if the regular expression match succeeds.
11538 The regular expression is not required to begin with a circumflex
11539 metacharacter, but if there is no circumflex, the expression is not anchored,
11540 and it may match anywhere in the subject, not just at the start. If you want
11541 the pattern to match at the end of the subject, you must include the &`$`&
11542 metacharacter at an appropriate point.
11543 All character handling is done in bytes and is not UTF-8 aware,
11544 but we might change this in a future Exim release.
11545
11546 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11547 At the start of an &%if%& expansion the values of the numeric variable
11548 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11549 succeeds causes them to be reset to the substrings of that condition and they
11550 will have these values during the expansion of the success string. At the end
11551 of the &%if%& expansion, the previous values are restored. After testing a
11552 combination of conditions using &%or%&, the subsequent values of the numeric
11553 variables are those of the condition that succeeded.
11554
11555 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11556 .cindex "&%match_address%& expansion condition"
11557 See &*match_local_part*&.
11558
11559 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11560 .cindex "&%match_domain%& expansion condition"
11561 See &*match_local_part*&.
11562
11563 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11564 .cindex "&%match_ip%& expansion condition"
11565 This condition matches an IP address to a list of IP address patterns. It must
11566 be followed by two argument strings. The first (after expansion) must be an IP
11567 address or an empty string. The second (not expanded) is a restricted host
11568 list that can match only an IP address, not a host name. For example:
11569 .code
11570 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11571 .endd
11572 The specific types of host list item that are permitted in the list are:
11573
11574 .ilist
11575 An IP address, optionally with a CIDR mask.
11576 .next
11577 A single asterisk, which matches any IP address.
11578 .next
11579 An empty item, which matches only if the IP address is empty. This could be
11580 useful for testing for a locally submitted message or one from specific hosts
11581 in a single test such as
11582 . ==== As this is a nested list, any displays it contains must be indented
11583 . ==== as otherwise they are too far to the left. This comment applies to
11584 . ==== the use of xmlto plus fop. There's no problem when formatting with
11585 . ==== sdop, with or without the extra indent.
11586 .code
11587   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11588 .endd
11589 where the first item in the list is the empty string.
11590 .next
11591 The item @[] matches any of the local host's interface addresses.
11592 .next
11593 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11594 even if &`net-`& is not specified. There is never any attempt to turn the IP
11595 address into a host name. The most common type of linear search for
11596 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11597 masks. For example:
11598 .code
11599   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11600 .endd
11601 It is of course possible to use other kinds of lookup, and in such a case, you
11602 do need to specify the &`net-`& prefix if you want to specify a specific
11603 address mask, for example:
11604 .code
11605   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11606 .endd
11607 However, unless you are combining a &%match_ip%& condition with others, it is
11608 just as easy to use the fact that a lookup is itself a condition, and write:
11609 .code
11610   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11611 .endd
11612 .endlist ilist
11613
11614 Note that <&'string2'&> is not itself subject to string expansion, unless
11615 Exim was built with the EXPAND_LISTMATCH_RHS option.
11616
11617 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11618
11619 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11620 .cindex "domain list" "in expansion condition"
11621 .cindex "address list" "in expansion condition"
11622 .cindex "local part" "list, in expansion condition"
11623 .cindex "&%match_local_part%& expansion condition"
11624 This condition, together with &%match_address%& and &%match_domain%&, make it
11625 possible to test domain, address, and local part lists within expansions. Each
11626 condition requires two arguments: an item and a list to match. A trivial
11627 example is:
11628 .code
11629 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11630 .endd
11631 In each case, the second argument may contain any of the allowable items for a
11632 list of the appropriate type. Also, because the second argument
11633 is a standard form of list, it is possible to refer to a named list.
11634 Thus, you can use conditions like this:
11635 .code
11636 ${if match_domain{$domain}{+local_domains}{...
11637 .endd
11638 .cindex "&`+caseful`&"
11639 For address lists, the matching starts off caselessly, but the &`+caseful`&
11640 item can be used, as in all address lists, to cause subsequent items to
11641 have their local parts matched casefully. Domains are always matched
11642 caselessly.
11643
11644 Note that <&'string2'&> is not itself subject to string expansion, unless
11645 Exim was built with the EXPAND_LISTMATCH_RHS option.
11646
11647 &*Note*&: Host lists are &'not'& supported in this way. This is because
11648 hosts have two identities: a name and an IP address, and it is not clear
11649 how to specify cleanly how such a test would work. However, IP addresses can be
11650 matched using &%match_ip%&.
11651
11652 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11653 .cindex "PAM authentication"
11654 .cindex "AUTH" "with PAM"
11655 .cindex "Solaris" "PAM support"
11656 .cindex "expansion" "PAM authentication test"
11657 .cindex "&%pam%& expansion condition"
11658 &'Pluggable Authentication Modules'&
11659 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11660 available in the latest releases of Solaris and in some GNU/Linux
11661 distributions. The Exim support, which is intended for use in conjunction with
11662 the SMTP AUTH command, is available only if Exim is compiled with
11663 .code
11664 SUPPORT_PAM=yes
11665 .endd
11666 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11667 in some releases of GNU/Linux &%-ldl%& is also needed.
11668
11669 The argument string is first expanded, and the result must be a
11670 colon-separated list of strings. Leading and trailing white space is ignored.
11671 The PAM module is initialized with the service name &"exim"& and the user name
11672 taken from the first item in the colon-separated data string (<&'string1'&>).
11673 The remaining items in the data string are passed over in response to requests
11674 from the authentication function. In the simple case there will only be one
11675 request, for a password, so the data consists of just two strings.
11676
11677 There can be problems if any of the strings are permitted to contain colon
11678 characters. In the usual way, these have to be doubled to avoid being taken as
11679 separators. If the data is being inserted from a variable, the &%sg%& expansion
11680 item can be used to double any existing colons. For example, the configuration
11681 of a LOGIN authenticator might contain this setting:
11682 .code
11683 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11684 .endd
11685 For a PLAIN authenticator you could use:
11686 .code
11687 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11688 .endd
11689 In some operating systems, PAM authentication can be done only from a process
11690 running as root. Since Exim is running as the Exim user when receiving
11691 messages, this means that PAM cannot be used directly in those systems.
11692 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11693
11694
11695 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11696 .cindex "&'pwcheck'& daemon"
11697 .cindex "Cyrus"
11698 .cindex "expansion" "&'pwcheck'& authentication test"
11699 .cindex "&%pwcheck%& expansion condition"
11700 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11701 This is one way of making it possible for passwords to be checked by a process
11702 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11703 deprecated. Its replacement is &'saslauthd'& (see below).
11704
11705 The pwcheck support is not included in Exim by default. You need to specify
11706 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11707 building Exim. For example:
11708 .code
11709 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11710 .endd
11711 You do not need to install the full Cyrus software suite in order to use
11712 the pwcheck daemon. You can compile and install just the daemon alone
11713 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11714 access to the &_/var/pwcheck_& directory.
11715
11716 The &%pwcheck%& condition takes one argument, which must be the user name and
11717 password, separated by a colon. For example, in a LOGIN authenticator
11718 configuration, you might have this:
11719 .code
11720 server_condition = ${if pwcheck{$auth1:$auth2}}
11721 .endd
11722 Again, for a PLAIN authenticator configuration, this would be:
11723 .code
11724 server_condition = ${if pwcheck{$auth2:$auth3}}
11725 .endd
11726 .vitem &*queue_running*&
11727 .cindex "queue runner" "detecting when delivering from"
11728 .cindex "expansion" "queue runner test"
11729 .cindex "&%queue_running%& expansion condition"
11730 This condition, which has no data, is true during delivery attempts that are
11731 initiated by queue runner processes, and false otherwise.
11732
11733
11734 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11735 .cindex "Radius"
11736 .cindex "expansion" "Radius authentication"
11737 .cindex "&%radius%& expansion condition"
11738 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11739 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11740 the Radius client configuration file in order to build Exim with Radius
11741 support.
11742
11743 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11744 library, using the original API. If you are using release 0.4.0 or later of
11745 this library, you need to set
11746 .code
11747 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11748 .endd
11749 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11750 &%libradius%& library that comes with FreeBSD. To do this, set
11751 .code
11752 RADIUS_LIB_TYPE=RADLIB
11753 .endd
11754 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11755 You may also have to supply a suitable setting in EXTRALIBS so that the
11756 Radius library can be found when Exim is linked.
11757
11758 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11759 Radius client library, which calls the Radius server. The condition is true if
11760 the authentication is successful. For example:
11761 .code
11762 server_condition = ${if radius{<arguments>}}
11763 .endd
11764
11765
11766 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11767         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11768 .cindex "&'saslauthd'& daemon"
11769 .cindex "Cyrus"
11770 .cindex "expansion" "&'saslauthd'& authentication test"
11771 .cindex "&%saslauthd%& expansion condition"
11772 This condition supports user authentication using the Cyrus &'saslauthd'&
11773 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11774 Using this daemon is one way of making it possible for passwords to be checked
11775 by a process that is not running as root.
11776
11777 The saslauthd support is not included in Exim by default. You need to specify
11778 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11779 building Exim. For example:
11780 .code
11781 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11782 .endd
11783 You do not need to install the full Cyrus software suite in order to use
11784 the saslauthd daemon. You can compile and install just the daemon alone
11785 from the Cyrus SASL library.
11786
11787 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11788 two are mandatory. For example:
11789 .code
11790 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11791 .endd
11792 The service and the realm are optional (which is why the arguments are enclosed
11793 in their own set of braces). For details of the meaning of the service and
11794 realm, and how to run the daemon, consult the Cyrus documentation.
11795 .endlist vlist
11796
11797
11798
11799 .section "Combining expansion conditions" "SECID84"
11800 .cindex "expansion" "combining conditions"
11801 Several conditions can be tested at once by combining them using the &%and%&
11802 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11803 conditions on their own, and precede their lists of sub-conditions. Each
11804 sub-condition must be enclosed in braces within the overall braces that contain
11805 the list. No repetition of &%if%& is used.
11806
11807
11808 .vlist
11809 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11810 .cindex "&""or""& expansion condition"
11811 .cindex "expansion" "&""or""& of conditions"
11812 The sub-conditions are evaluated from left to right. The condition is true if
11813 any one of the sub-conditions is true.
11814 For example,
11815 .code
11816 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11817 .endd
11818 When a true sub-condition is found, the following ones are parsed but not
11819 evaluated. If there are several &"match"& sub-conditions the values of the
11820 numeric variables afterwards are taken from the first one that succeeds.
11821
11822 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11823 .cindex "&""and""& expansion condition"
11824 .cindex "expansion" "&""and""& of conditions"
11825 The sub-conditions are evaluated from left to right. The condition is true if
11826 all of the sub-conditions are true. If there are several &"match"&
11827 sub-conditions, the values of the numeric variables afterwards are taken from
11828 the last one. When a false sub-condition is found, the following ones are
11829 parsed but not evaluated.
11830 .endlist
11831 .ecindex IIDexpcond
11832
11833
11834
11835
11836 .section "Expansion variables" "SECTexpvar"
11837 .cindex "expansion" "variables, list of"
11838 This section contains an alphabetical list of all the expansion variables. Some
11839 of them are available only when Exim is compiled with specific options such as
11840 support for TLS or the content scanning extension.
11841
11842 .vlist
11843 .vitem "&$0$&, &$1$&, etc"
11844 .cindex "numerical variables (&$1$& &$2$& etc)"
11845 When a &%match%& expansion condition succeeds, these variables contain the
11846 captured substrings identified by the regular expression during subsequent
11847 processing of the success string of the containing &%if%& expansion item.
11848 In the expansion condition case
11849 they do not retain their values afterwards; in fact, their previous
11850 values are restored at the end of processing an &%if%& item. The numerical
11851 variables may also be set externally by some other matching process which
11852 precedes the expansion of the string. For example, the commands available in
11853 Exim filter files include an &%if%& command with its own regular expression
11854 matching condition.
11855
11856 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11857 Within an acl condition, expansion condition or expansion item
11858 any arguments are copied to these variables,
11859 any unused variables being made empty.
11860
11861 .vitem "&$acl_c...$&"
11862 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11863 can be given any name that starts with &$acl_c$& and is at least six characters
11864 long, but the sixth character must be either a digit or an underscore. For
11865 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11866 variables persist throughout the lifetime of an SMTP connection. They can be
11867 used to pass information between ACLs and between different invocations of the
11868 same ACL. When a message is received, the values of these variables are saved
11869 with the message, and can be accessed by filters, routers, and transports
11870 during subsequent delivery.
11871
11872 .vitem "&$acl_m...$&"
11873 These variables are like the &$acl_c...$& variables, except that their values
11874 are reset after a message has been received. Thus, if several messages are
11875 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11876 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11877 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11878 message is received, the values of these variables are saved with the message,
11879 and can be accessed by filters, routers, and transports during subsequent
11880 delivery.
11881
11882 .vitem &$acl_narg$&
11883 Within an acl condition, expansion condition or expansion item
11884 this variable has the number of arguments.
11885
11886 .vitem &$acl_verify_message$&
11887 .vindex "&$acl_verify_message$&"
11888 After an address verification has failed, this variable contains the failure
11889 message. It retains its value for use in subsequent modifiers. The message can
11890 be preserved by coding like this:
11891 .code
11892 warn !verify = sender
11893      set acl_m0 = $acl_verify_message
11894 .endd
11895 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11896 &%log_message%& modifiers, to include information about the verification
11897 failure.
11898
11899 .vitem &$address_data$&
11900 .vindex "&$address_data$&"
11901 This variable is set by means of the &%address_data%& option in routers. The
11902 value then remains with the address while it is processed by subsequent routers
11903 and eventually a transport. If the transport is handling multiple addresses,
11904 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11905 for more details. &*Note*&: The contents of &$address_data$& are visible in
11906 user filter files.
11907
11908 If &$address_data$& is set when the routers are called from an ACL to verify
11909 a recipient address, the final value is still in the variable for subsequent
11910 conditions and modifiers of the ACL statement. If routing the address caused it
11911 to be redirected to just one address, the child address is also routed as part
11912 of the verification, and in this case the final value of &$address_data$& is
11913 from the child's routing.
11914
11915 If &$address_data$& is set when the routers are called from an ACL to verify a
11916 sender address, the final value is also preserved, but this time in
11917 &$sender_address_data$&, to distinguish it from data from a recipient
11918 address.
11919
11920 In both cases (recipient and sender verification), the value does not persist
11921 after the end of the current ACL statement. If you want to preserve
11922 these values for longer, you can save them in ACL variables.
11923
11924 .vitem &$address_file$&
11925 .vindex "&$address_file$&"
11926 When, as a result of aliasing, forwarding, or filtering, a message is directed
11927 to a specific file, this variable holds the name of the file when the transport
11928 is running. At other times, the variable is empty. For example, using the
11929 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11930 .code
11931 /home/r2d2/savemail
11932 .endd
11933 then when the &(address_file)& transport is running, &$address_file$&
11934 contains the text string &`/home/r2d2/savemail`&.
11935 .cindex "Sieve filter" "value of &$address_file$&"
11936 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11937 then up to the transport configuration to generate an appropriate absolute path
11938 to the relevant file.
11939
11940 .vitem &$address_pipe$&
11941 .vindex "&$address_pipe$&"
11942 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11943 this variable holds the pipe command when the transport is running.
11944
11945 .vitem "&$auth1$& &-- &$auth3$&"
11946 .vindex "&$auth1$&, &$auth2$&, etc"
11947 These variables are used in SMTP authenticators (see chapters
11948 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11949
11950 .vitem &$authenticated_id$&
11951 .cindex "authentication" "id"
11952 .vindex "&$authenticated_id$&"
11953 When a server successfully authenticates a client it may be configured to
11954 preserve some of the authentication information in the variable
11955 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11956 user/password authenticator configuration might preserve the user name for use
11957 in the routers. Note that this is not the same information that is saved in
11958 &$sender_host_authenticated$&.
11959
11960 When a message is submitted locally (that is, not over a TCP connection)
11961 the value of &$authenticated_id$& is normally the login name of the calling
11962 process. However, a trusted user can override this by means of the &%-oMai%&
11963 command line option.
11964 This second case also sets up information used by the
11965 &$authresults$& expansion item.
11966
11967 .vitem &$authenticated_fail_id$&
11968 .cindex "authentication" "fail" "id"
11969 .vindex "&$authenticated_fail_id$&"
11970 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11971 will contain the failed authentication id. If more than one authentication
11972 id is attempted, it will contain only the last one. The variable is
11973 available for processing in the ACL's, generally the quit or notquit ACL.
11974 A message to a local recipient could still be accepted without requiring
11975 authentication, which means this variable could also be visible in all of
11976 the ACL's as well.
11977
11978
11979 .vitem &$authenticated_sender$&
11980 .cindex "sender" "authenticated"
11981 .cindex "authentication" "sender"
11982 .cindex "AUTH" "on MAIL command"
11983 .vindex "&$authenticated_sender$&"
11984 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11985 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11986 described in section &<<SECTauthparamail>>&. Unless the data is the string
11987 &"<>"&, it is set as the authenticated sender of the message, and the value is
11988 available during delivery in the &$authenticated_sender$& variable. If the
11989 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11990
11991 .vindex "&$qualify_domain$&"
11992 When a message is submitted locally (that is, not over a TCP connection), the
11993 value of &$authenticated_sender$& is an address constructed from the login
11994 name of the calling process and &$qualify_domain$&, except that a trusted user
11995 can override this by means of the &%-oMas%& command line option.
11996
11997
11998 .vitem &$authentication_failed$&
11999 .cindex "authentication" "failure"
12000 .vindex "&$authentication_failed$&"
12001 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12002 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12003 possible to distinguish between &"did not try to authenticate"&
12004 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12005 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12006 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12007 negative response to an AUTH command, including (for example) an attempt to use
12008 an undefined mechanism.
12009
12010 .vitem &$av_failed$&
12011 .cindex "content scanning" "AV scanner failure"
12012 This variable is available when Exim is compiled with the content-scanning
12013 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12014 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12015 the ACL malware condition.
12016
12017 .vitem &$body_linecount$&
12018 .cindex "message body" "line count"
12019 .cindex "body of message" "line count"
12020 .vindex "&$body_linecount$&"
12021 When a message is being received or delivered, this variable contains the
12022 number of lines in the message's body. See also &$message_linecount$&.
12023
12024 .vitem &$body_zerocount$&
12025 .cindex "message body" "binary zero count"
12026 .cindex "body of message" "binary zero count"
12027 .cindex "binary zero" "in message body"
12028 .vindex "&$body_zerocount$&"
12029 When a message is being received or delivered, this variable contains the
12030 number of binary zero bytes (ASCII NULs) in the message's body.
12031
12032 .vitem &$bounce_recipient$&
12033 .vindex "&$bounce_recipient$&"
12034 This is set to the recipient address of a bounce message while Exim is creating
12035 it. It is useful if a customized bounce message text file is in use (see
12036 chapter &<<CHAPemsgcust>>&).
12037
12038 .vitem &$bounce_return_size_limit$&
12039 .vindex "&$bounce_return_size_limit$&"
12040 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12041 up to a multiple of 1000. It is useful when a customized error message text
12042 file is in use (see chapter &<<CHAPemsgcust>>&).
12043
12044 .vitem &$caller_gid$&
12045 .cindex "gid (group id)" "caller"
12046 .vindex "&$caller_gid$&"
12047 The real group id under which the process that called Exim was running. This is
12048 not the same as the group id of the originator of a message (see
12049 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12050 incarnation normally contains the Exim gid.
12051
12052 .vitem &$caller_uid$&
12053 .cindex "uid (user id)" "caller"
12054 .vindex "&$caller_uid$&"
12055 The real user id under which the process that called Exim was running. This is
12056 not the same as the user id of the originator of a message (see
12057 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12058 incarnation normally contains the Exim uid.
12059
12060 .vitem &$callout_address$&
12061 .vindex "&$callout_address$&"
12062 After a callout for verification, spamd or malware daemon service, the
12063 address that was connected to.
12064
12065 .vitem &$compile_number$&
12066 .vindex "&$compile_number$&"
12067 The building process for Exim keeps a count of the number
12068 of times it has been compiled. This serves to distinguish different
12069 compilations of the same version of Exim.
12070
12071 .vitem &$config_dir$&
12072 .vindex "&$config_dir$&"
12073 The directory name of the main configuration file. That is, the content of
12074 &$config_file$& with the last component stripped. The value does not
12075 contain the trailing slash. If &$config_file$& does not contain a slash,
12076 &$config_dir$& is ".".
12077
12078 .vitem &$config_file$&
12079 .vindex "&$config_file$&"
12080 The name of the main configuration file Exim is using.
12081
12082 .new
12083 .vitem &$dmarc_domain_policy$& &&&
12084        &$dmarc_status$& &&&
12085        &$dmarc_status_text$& &&&
12086        &$dmarc_used_domains$&
12087 Results of DMARC verification.
12088 For details see section &<<SECDMARC>>&.
12089 .wen
12090
12091 .vitem &$dkim_verify_status$&
12092 Results of DKIM verification.
12093 For details see section &<<SECDKIMVFY>>&.
12094
12095 .vitem &$dkim_cur_signer$& &&&
12096        &$dkim_verify_reason$& &&&
12097        &$dkim_domain$& &&&
12098        &$dkim_identity$& &&&
12099        &$dkim_selector$& &&&
12100        &$dkim_algo$& &&&
12101        &$dkim_canon_body$& &&&
12102        &$dkim_canon_headers$& &&&
12103        &$dkim_copiedheaders$& &&&
12104        &$dkim_bodylength$& &&&
12105        &$dkim_created$& &&&
12106        &$dkim_expires$& &&&
12107        &$dkim_headernames$& &&&
12108        &$dkim_key_testing$& &&&
12109        &$dkim_key_nosubdomains$& &&&
12110        &$dkim_key_srvtype$& &&&
12111        &$dkim_key_granularity$& &&&
12112        &$dkim_key_notes$& &&&
12113        &$dkim_key_length$&
12114 These variables are only available within the DKIM ACL.
12115 For details see section &<<SECDKIMVFY>>&.
12116
12117 .vitem &$dkim_signers$&
12118 .vindex &$dkim_signers$&
12119 When a message has been received this variable contains
12120 a colon-separated list of signer domains and identities for the message.
12121 For details see section &<<SECDKIMVFY>>&.
12122
12123 .vitem &$dnslist_domain$& &&&
12124        &$dnslist_matched$& &&&
12125        &$dnslist_text$& &&&
12126        &$dnslist_value$&
12127 .vindex "&$dnslist_domain$&"
12128 .vindex "&$dnslist_matched$&"
12129 .vindex "&$dnslist_text$&"
12130 .vindex "&$dnslist_value$&"
12131 .cindex "black list (DNS)"
12132 When a DNS (black) list lookup succeeds, these variables are set to contain
12133 the following data from the lookup: the list's domain name, the key that was
12134 looked up, the contents of any associated TXT record, and the value from the
12135 main A record. See section &<<SECID204>>& for more details.
12136
12137 .vitem &$domain$&
12138 .vindex "&$domain$&"
12139 When an address is being routed, or delivered on its own, this variable
12140 contains the domain. Uppercase letters in the domain are converted into lower
12141 case for &$domain$&.
12142
12143 Global address rewriting happens when a message is received, so the value of
12144 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12145 is set during user filtering, but not during system filtering, because a
12146 message may have many recipients and the system filter is called just once.
12147
12148 When more than one address is being delivered at once (for example, several
12149 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12150 have the same domain. Transports can be restricted to handling only one domain
12151 at a time if the value of &$domain$& is required at transport time &-- this is
12152 the default for local transports. For further details of the environment in
12153 which local transports are run, see chapter &<<CHAPenvironment>>&.
12154
12155 .oindex "&%delay_warning_condition%&"
12156 At the end of a delivery, if all deferred addresses have the same domain, it is
12157 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12158
12159 The &$domain$& variable is also used in some other circumstances:
12160
12161 .ilist
12162 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12163 the recipient address. The domain of the &'sender'& address is in
12164 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12165 normally set during the running of the MAIL ACL. However, if the sender address
12166 is verified with a callout during the MAIL ACL, the sender domain is placed in
12167 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12168 the &(smtp)& transport.
12169
12170 .next
12171 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12172 &$domain$& contains the domain portion of the address that is being rewritten;
12173 it can be used in the expansion of the replacement address, for example, to
12174 rewrite domains by file lookup.
12175
12176 .next
12177 With one important exception, whenever a domain list is being scanned,
12178 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12179 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12180 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12181 that, in a RCPT ACL, the sender domain list can be dependent on the
12182 recipient domain (which is what is in &$domain$& at this time).
12183
12184 .next
12185 .cindex "ETRN" "value of &$domain$&"
12186 .oindex "&%smtp_etrn_command%&"
12187 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12188 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12189 .endlist
12190
12191
12192 .vitem &$domain_data$&
12193 .vindex "&$domain_data$&"
12194 When the &%domains%& option on a router matches a domain by
12195 means of a lookup, the data read by the lookup is available during the running
12196 of the router as &$domain_data$&. In addition, if the driver routes the
12197 address to a transport, the value is available in that transport. If the
12198 transport is handling multiple addresses, the value from the first address is
12199 used.
12200
12201 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12202 domain by means of a lookup. The data read by the lookup is available during
12203 the rest of the ACL statement. In all other situations, this variable expands
12204 to nothing.
12205
12206 .vitem &$exim_gid$&
12207 .vindex "&$exim_gid$&"
12208 This variable contains the numerical value of the Exim group id.
12209
12210 .vitem &$exim_path$&
12211 .vindex "&$exim_path$&"
12212 This variable contains the path to the Exim binary.
12213
12214 .vitem &$exim_uid$&
12215 .vindex "&$exim_uid$&"
12216 This variable contains the numerical value of the Exim user id.
12217
12218 .vitem &$exim_version$&
12219 .vindex "&$exim_version$&"
12220 This variable contains the version string of the Exim build.
12221 The first character is a major version number, currently 4.
12222 Then after a dot, the next group of digits is a minor version number.
12223 There may be other characters following the minor version.
12224 This value may be overridden by the &%exim_version%& main config option.
12225
12226 .vitem &$header_$&<&'name'&>
12227 This is not strictly an expansion variable. It is expansion syntax for
12228 inserting the message header line with the given name. Note that the name must
12229 be terminated by colon or white space, because it may contain a wide variety of
12230 characters. Note also that braces must &'not'& be used.
12231 See the full description in section &<<SECTexpansionitems>>& above.
12232
12233 .vitem &$headers_added$&
12234 .vindex "&$headers_added$&"
12235 Within an ACL this variable contains the headers added so far by
12236 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12237 The headers are a newline-separated list.
12238
12239 .vitem &$home$&
12240 .vindex "&$home$&"
12241 When the &%check_local_user%& option is set for a router, the user's home
12242 directory is placed in &$home$& when the check succeeds. In particular, this
12243 means it is set during the running of users' filter files. A router may also
12244 explicitly set a home directory for use by a transport; this can be overridden
12245 by a setting on the transport itself.
12246
12247 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12248 of the environment variable HOME, which is subject to the
12249 &%keep_environment%& and &%add_environment%& main config options.
12250
12251 .vitem &$host$&
12252 .vindex "&$host$&"
12253 If a router assigns an address to a transport (any transport), and passes a
12254 list of hosts with the address, the value of &$host$& when the transport starts
12255 to run is the name of the first host on the list. Note that this applies both
12256 to local and remote transports.
12257
12258 .cindex "transport" "filter"
12259 .cindex "filter" "transport filter"
12260 For the &(smtp)& transport, if there is more than one host, the value of
12261 &$host$& changes as the transport works its way through the list. In
12262 particular, when the &(smtp)& transport is expanding its options for encryption
12263 using TLS, or for specifying a transport filter (see chapter
12264 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12265 is connected.
12266
12267 When used in the client part of an authenticator configuration (see chapter
12268 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12269 client is connected.
12270
12271
12272 .vitem &$host_address$&
12273 .vindex "&$host_address$&"
12274 This variable is set to the remote host's IP address whenever &$host$& is set
12275 for a remote connection. It is also set to the IP address that is being checked
12276 when the &%ignore_target_hosts%& option is being processed.
12277
12278 .vitem &$host_data$&
12279 .vindex "&$host_data$&"
12280 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12281 result of the lookup is made available in the &$host_data$& variable. This
12282 allows you, for example, to do things like this:
12283 .code
12284 deny  hosts = net-lsearch;/some/file
12285 message = $host_data
12286 .endd
12287 .vitem &$host_lookup_deferred$&
12288 .cindex "host name" "lookup, failure of"
12289 .vindex "&$host_lookup_deferred$&"
12290 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12291 message comes from a remote host and there is an attempt to look up the host's
12292 name from its IP address, and the attempt is not successful, one of these
12293 variables is set to &"1"&.
12294
12295 .ilist
12296 If the lookup receives a definite negative response (for example, a DNS lookup
12297 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12298
12299 .next
12300 If there is any kind of problem during the lookup, such that Exim cannot
12301 tell whether or not the host name is defined (for example, a timeout for a DNS
12302 lookup), &$host_lookup_deferred$& is set to &"1"&.
12303 .endlist ilist
12304
12305 Looking up a host's name from its IP address consists of more than just a
12306 single reverse lookup. Exim checks that a forward lookup of at least one of the
12307 names it receives from a reverse lookup yields the original IP address. If this
12308 is not the case, Exim does not accept the looked up name(s), and
12309 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12310 IP address (for example, the existence of a PTR record in the DNS) is not
12311 sufficient on its own for the success of a host name lookup. If the reverse
12312 lookup succeeds, but there is a lookup problem such as a timeout when checking
12313 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12314 &"1"&. See also &$sender_host_name$&.
12315
12316 .cindex authentication "expansion item"
12317 Performing these checks sets up information used by the
12318 &%authresults%& expansion item.
12319
12320
12321 .vitem &$host_lookup_failed$&
12322 .vindex "&$host_lookup_failed$&"
12323 See &$host_lookup_deferred$&.
12324
12325 .vitem &$host_port$&
12326 .vindex "&$host_port$&"
12327 This variable is set to the remote host's TCP port whenever &$host$& is set
12328 for an outbound connection.
12329
12330 .vitem &$initial_cwd$&
12331 .vindex "&$initial_cwd$&
12332 This variable contains the full path name of the initial working
12333 directory of the current Exim process. This may differ from the current
12334 working directory, as Exim changes this to "/" during early startup, and
12335 to &$spool_directory$& later.
12336
12337 .vitem &$inode$&
12338 .vindex "&$inode$&"
12339 The only time this variable is set is while expanding the &%directory_file%&
12340 option in the &(appendfile)& transport. The variable contains the inode number
12341 of the temporary file which is about to be renamed. It can be used to construct
12342 a unique name for the file.
12343
12344 .vitem &$interface_address$&
12345 .vindex "&$interface_address$&"
12346 This is an obsolete name for &$received_ip_address$&.
12347
12348 .vitem &$interface_port$&
12349 .vindex "&$interface_port$&"
12350 This is an obsolete name for &$received_port$&.
12351
12352 .vitem &$item$&
12353 .vindex "&$item$&"
12354 This variable is used during the expansion of &*forall*& and &*forany*&
12355 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12356 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12357 empty.
12358
12359 .vitem &$ldap_dn$&
12360 .vindex "&$ldap_dn$&"
12361 This variable, which is available only when Exim is compiled with LDAP support,
12362 contains the DN from the last entry in the most recently successful LDAP
12363 lookup.
12364
12365 .vitem &$load_average$&
12366 .vindex "&$load_average$&"
12367 This variable contains the system load average, multiplied by 1000 so that it
12368 is an integer. For example, if the load average is 0.21, the value of the
12369 variable is 210. The value is recomputed every time the variable is referenced.
12370
12371 .vitem &$local_part$&
12372 .vindex "&$local_part$&"
12373 When an address is being routed, or delivered on its own, this
12374 variable contains the local part. When a number of addresses are being
12375 delivered together (for example, multiple RCPT commands in an SMTP
12376 session), &$local_part$& is not set.
12377
12378 Global address rewriting happens when a message is received, so the value of
12379 &$local_part$& during routing and delivery is the value after rewriting.
12380 &$local_part$& is set during user filtering, but not during system filtering,
12381 because a message may have many recipients and the system filter is called just
12382 once.
12383
12384 .vindex "&$local_part_prefix$&"
12385 .vindex "&$local_part_suffix$&"
12386 .cindex affix variables
12387 If a local part prefix or suffix has been recognized, it is not included in the
12388 value of &$local_part$& during routing and subsequent delivery. The values of
12389 any prefix or suffix are in &$local_part_prefix$& and
12390 &$local_part_suffix$&, respectively.
12391
12392 When a message is being delivered to a file, pipe, or autoreply transport as a
12393 result of aliasing or forwarding, &$local_part$& is set to the local part of
12394 the parent address, not to the filename or command (see &$address_file$& and
12395 &$address_pipe$&).
12396
12397 When an ACL is running for a RCPT command, &$local_part$& contains the
12398 local part of the recipient address.
12399
12400 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12401 &$local_part$& contains the local part of the address that is being rewritten;
12402 it can be used in the expansion of the replacement address, for example.
12403
12404 In all cases, all quoting is removed from the local part. For example, for both
12405 the addresses
12406 .code
12407 "abc:xyz"@test.example
12408 abc\:xyz@test.example
12409 .endd
12410 the value of &$local_part$& is
12411 .code
12412 abc:xyz
12413 .endd
12414 If you use &$local_part$& to create another address, you should always wrap it
12415 inside a quoting operator. For example, in a &(redirect)& router you could
12416 have:
12417 .code
12418 data = ${quote_local_part:$local_part}@new.domain.example
12419 .endd
12420 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12421 to process local parts in a case-dependent manner in a router, you can set the
12422 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12423
12424 .vitem &$local_part_data$&
12425 .vindex "&$local_part_data$&"
12426 When the &%local_parts%& option on a router matches a local part by means of a
12427 lookup, the data read by the lookup is available during the running of the
12428 router as &$local_part_data$&. In addition, if the driver routes the address
12429 to a transport, the value is available in that transport. If the transport is
12430 handling multiple addresses, the value from the first address is used.
12431
12432 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12433 matches a local part by means of a lookup. The data read by the lookup is
12434 available during the rest of the ACL statement. In all other situations, this
12435 variable expands to nothing.
12436
12437 .vitem &$local_part_prefix$&
12438 .vindex "&$local_part_prefix$&"
12439 .cindex affix variables
12440 When an address is being routed or delivered, and a
12441 specific prefix for the local part was recognized, it is available in this
12442 variable, having been removed from &$local_part$&.
12443
12444 .vitem &$local_part_suffix$&
12445 .vindex "&$local_part_suffix$&"
12446 When an address is being routed or delivered, and a
12447 specific suffix for the local part was recognized, it is available in this
12448 variable, having been removed from &$local_part$&.
12449
12450 .vitem &$local_scan_data$&
12451 .vindex "&$local_scan_data$&"
12452 This variable contains the text returned by the &[local_scan()]& function when
12453 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12454
12455 .vitem &$local_user_gid$&
12456 .vindex "&$local_user_gid$&"
12457 See &$local_user_uid$&.
12458
12459 .vitem &$local_user_uid$&
12460 .vindex "&$local_user_uid$&"
12461 This variable and &$local_user_gid$& are set to the uid and gid after the
12462 &%check_local_user%& router precondition succeeds. This means that their values
12463 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12464 and &%condition%&), for the &%address_data%& expansion, and for any
12465 router-specific expansions. At all other times, the values in these variables
12466 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12467
12468 .vitem &$localhost_number$&
12469 .vindex "&$localhost_number$&"
12470 This contains the expanded value of the
12471 &%localhost_number%& option. The expansion happens after the main options have
12472 been read.
12473
12474 .vitem &$log_inodes$&
12475 .vindex "&$log_inodes$&"
12476 The number of free inodes in the disk partition where Exim's
12477 log files are being written. The value is recalculated whenever the variable is
12478 referenced. If the relevant file system does not have the concept of inodes,
12479 the value of is -1. See also the &%check_log_inodes%& option.
12480
12481 .vitem &$log_space$&
12482 .vindex "&$log_space$&"
12483 The amount of free space (as a number of kilobytes) in the disk
12484 partition where Exim's log files are being written. The value is recalculated
12485 whenever the variable is referenced. If the operating system does not have the
12486 ability to find the amount of free space (only true for experimental systems),
12487 the space value is -1. See also the &%check_log_space%& option.
12488
12489
12490 .vitem &$lookup_dnssec_authenticated$&
12491 .vindex "&$lookup_dnssec_authenticated$&"
12492 This variable is set after a DNS lookup done by
12493 a dnsdb lookup expansion, dnslookup router or smtp transport.
12494 .cindex "DNS" "DNSSEC"
12495 It will be empty if &(DNSSEC)& was not requested,
12496 &"no"& if the result was not labelled as authenticated data
12497 and &"yes"& if it was.
12498 Results that are labelled as authoritative answer that match
12499 the &%dns_trust_aa%& configuration variable count also
12500 as authenticated data.
12501
12502 .vitem &$mailstore_basename$&
12503 .vindex "&$mailstore_basename$&"
12504 This variable is set only when doing deliveries in &"mailstore"& format in the
12505 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12506 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12507 contains the basename of the files that are being written, that is, the name
12508 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12509 variable is empty.
12510
12511 .vitem &$malware_name$&
12512 .vindex "&$malware_name$&"
12513 This variable is available when Exim is compiled with the
12514 content-scanning extension. It is set to the name of the virus that was found
12515 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12516
12517 .vitem &$max_received_linelength$&
12518 .vindex "&$max_received_linelength$&"
12519 .cindex "maximum" "line length"
12520 .cindex "line length" "maximum"
12521 This variable contains the number of bytes in the longest line that was
12522 received as part of the message, not counting the line termination
12523 character(s).
12524 It is not valid if the &%spool_files_wireformat%& option is used.
12525
12526 .vitem &$message_age$&
12527 .cindex "message" "age of"
12528 .vindex "&$message_age$&"
12529 This variable is set at the start of a delivery attempt to contain the number
12530 of seconds since the message was received. It does not change during a single
12531 delivery attempt.
12532
12533 .vitem &$message_body$&
12534 .cindex "body of message" "expansion variable"
12535 .cindex "message body" "in expansion"
12536 .cindex "binary zero" "in message body"
12537 .vindex "&$message_body$&"
12538 .oindex "&%message_body_visible%&"
12539 This variable contains the initial portion of a message's body while it is
12540 being delivered, and is intended mainly for use in filter files. The maximum
12541 number of characters of the body that are put into the variable is set by the
12542 &%message_body_visible%& configuration option; the default is 500.
12543
12544 .oindex "&%message_body_newlines%&"
12545 By default, newlines are converted into spaces in &$message_body$&, to make it
12546 easier to search for phrases that might be split over a line break. However,
12547 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12548 zeros are always converted into spaces.
12549
12550 .vitem &$message_body_end$&
12551 .cindex "body of message" "expansion variable"
12552 .cindex "message body" "in expansion"
12553 .vindex "&$message_body_end$&"
12554 This variable contains the final portion of a message's
12555 body while it is being delivered. The format and maximum size are as for
12556 &$message_body$&.
12557
12558 .vitem &$message_body_size$&
12559 .cindex "body of message" "size"
12560 .cindex "message body" "size"
12561 .vindex "&$message_body_size$&"
12562 When a message is being delivered, this variable contains the size of the body
12563 in bytes. The count starts from the character after the blank line that
12564 separates the body from the header. Newlines are included in the count. See
12565 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12566
12567 If the spool file is wireformat
12568 (see the &%spool_files_wireformat%& main option)
12569 the CRLF line-terminators are included in the count.
12570
12571 .vitem &$message_exim_id$&
12572 .vindex "&$message_exim_id$&"
12573 When a message is being received or delivered, this variable contains the
12574 unique message id that is generated and used by Exim to identify the message.
12575 An id is not created for a message until after its header has been successfully
12576 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12577 line; it is the local id that Exim assigns to the message, for example:
12578 &`1BXTIK-0001yO-VA`&.
12579
12580 .vitem &$message_headers$&
12581 .vindex &$message_headers$&
12582 This variable contains a concatenation of all the header lines when a message
12583 is being processed, except for lines added by routers or transports. The header
12584 lines are separated by newline characters. Their contents are decoded in the
12585 same way as a header line that is inserted by &%bheader%&.
12586
12587 .vitem &$message_headers_raw$&
12588 .vindex &$message_headers_raw$&
12589 This variable is like &$message_headers$& except that no processing of the
12590 contents of header lines is done.
12591
12592 .vitem &$message_id$&
12593 This is an old name for &$message_exim_id$&. It is now deprecated.
12594
12595 .vitem &$message_linecount$&
12596 .vindex "&$message_linecount$&"
12597 This variable contains the total number of lines in the header and body of the
12598 message. Compare &$body_linecount$&, which is the count for the body only.
12599 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12600 number of lines received. Before delivery happens (that is, before filters,
12601 routers, and transports run) the count is increased to include the
12602 &'Received:'& header line that Exim standardly adds, and also any other header
12603 lines that are added by ACLs. The blank line that separates the message header
12604 from the body is not counted.
12605
12606 As with the special case of &$message_size$&, during the expansion of the
12607 appendfile transport's maildir_tag option in maildir format, the value of
12608 &$message_linecount$& is the precise size of the number of newlines in the
12609 file that has been written (minus one for the blank line between the
12610 header and the body).
12611
12612 Here is an example of the use of this variable in a DATA ACL:
12613 .code
12614 deny message   = Too many lines in message header
12615      condition = \
12616       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12617 .endd
12618 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12619 message has not yet been received.
12620
12621 This variable is not valid if the &%spool_files_wireformat%& option is used.
12622
12623 .vitem &$message_size$&
12624 .cindex "size" "of message"
12625 .cindex "message" "size"
12626 .vindex "&$message_size$&"
12627 When a message is being processed, this variable contains its size in bytes. In
12628 most cases, the size includes those headers that were received with the
12629 message, but not those (such as &'Envelope-to:'&) that are added to individual
12630 deliveries as they are written. However, there is one special case: during the
12631 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12632 doing a delivery in maildir format, the value of &$message_size$& is the
12633 precise size of the file that has been written. See also
12634 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12635
12636 .cindex "RCPT" "value of &$message_size$&"
12637 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12638 contains the size supplied on the MAIL command, or -1 if no size was given. The
12639 value may not, of course, be truthful.
12640
12641 .vitem &$mime_$&&'xxx'&
12642 A number of variables whose names start with &$mime$& are
12643 available when Exim is compiled with the content-scanning extension. For
12644 details, see section &<<SECTscanmimepart>>&.
12645
12646 .vitem "&$n0$& &-- &$n9$&"
12647 These variables are counters that can be incremented by means
12648 of the &%add%& command in filter files.
12649
12650 .vitem &$original_domain$&
12651 .vindex "&$domain$&"
12652 .vindex "&$original_domain$&"
12653 When a top-level address is being processed for delivery, this contains the
12654 same value as &$domain$&. However, if a &"child"& address (for example,
12655 generated by an alias, forward, or filter file) is being processed, this
12656 variable contains the domain of the original address (lower cased). This
12657 differs from &$parent_domain$& only when there is more than one level of
12658 aliasing or forwarding. When more than one address is being delivered in a
12659 single transport run, &$original_domain$& is not set.
12660
12661 If a new address is created by means of a &%deliver%& command in a system
12662 filter, it is set up with an artificial &"parent"& address. This has the local
12663 part &'system-filter'& and the default qualify domain.
12664
12665 .vitem &$original_local_part$&
12666 .vindex "&$local_part$&"
12667 .vindex "&$original_local_part$&"
12668 When a top-level address is being processed for delivery, this contains the
12669 same value as &$local_part$&, unless a prefix or suffix was removed from the
12670 local part, because &$original_local_part$& always contains the full local
12671 part. When a &"child"& address (for example, generated by an alias, forward, or
12672 filter file) is being processed, this variable contains the full local part of
12673 the original address.
12674
12675 If the router that did the redirection processed the local part
12676 case-insensitively, the value in &$original_local_part$& is in lower case.
12677 This variable differs from &$parent_local_part$& only when there is more than
12678 one level of aliasing or forwarding. When more than one address is being
12679 delivered in a single transport run, &$original_local_part$& is not set.
12680
12681 If a new address is created by means of a &%deliver%& command in a system
12682 filter, it is set up with an artificial &"parent"& address. This has the local
12683 part &'system-filter'& and the default qualify domain.
12684
12685 .vitem &$originator_gid$&
12686 .cindex "gid (group id)" "of originating user"
12687 .cindex "sender" "gid"
12688 .vindex "&$caller_gid$&"
12689 .vindex "&$originator_gid$&"
12690 This variable contains the value of &$caller_gid$& that was set when the
12691 message was received. For messages received via the command line, this is the
12692 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12693 normally the gid of the Exim user.
12694
12695 .vitem &$originator_uid$&
12696 .cindex "uid (user id)" "of originating user"
12697 .cindex "sender" "uid"
12698 .vindex "&$caller_uid$&"
12699 .vindex "&$originator_uid$&"
12700 The value of &$caller_uid$& that was set when the message was received. For
12701 messages received via the command line, this is the uid of the sending user.
12702 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12703 user.
12704
12705 .vitem &$parent_domain$&
12706 .vindex "&$parent_domain$&"
12707 This variable is similar to &$original_domain$& (see
12708 above), except that it refers to the immediately preceding parent address.
12709
12710 .vitem &$parent_local_part$&
12711 .vindex "&$parent_local_part$&"
12712 This variable is similar to &$original_local_part$&
12713 (see above), except that it refers to the immediately preceding parent address.
12714
12715 .vitem &$pid$&
12716 .cindex "pid (process id)" "of current process"
12717 .vindex "&$pid$&"
12718 This variable contains the current process id.
12719
12720 .vitem &$pipe_addresses$&
12721 .cindex "filter" "transport filter"
12722 .cindex "transport" "filter"
12723 .vindex "&$pipe_addresses$&"
12724 This is not an expansion variable, but is mentioned here because the string
12725 &`$pipe_addresses`& is handled specially in the command specification for the
12726 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12727 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12728 It cannot be used in general expansion strings, and provokes an &"unknown
12729 variable"& error if encountered.
12730
12731 .vitem &$primary_hostname$&
12732 .vindex "&$primary_hostname$&"
12733 This variable contains the value set by &%primary_hostname%& in the
12734 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12735 a single-component name, Exim calls &[gethostbyname()]& (or
12736 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12737 qualified host name. See also &$smtp_active_hostname$&.
12738
12739
12740 .vitem &$proxy_external_address$& &&&
12741        &$proxy_external_port$& &&&
12742        &$proxy_local_address$& &&&
12743        &$proxy_local_port$& &&&
12744        &$proxy_session$&
12745 These variables are only available when built with Proxy Protocol
12746 or SOCKS5 support.
12747 For details see chapter &<<SECTproxyInbound>>&.
12748
12749 .vitem &$prdr_requested$&
12750 .cindex "PRDR" "variable for"
12751 This variable is set to &"yes"& if PRDR was requested by the client for the
12752 current message, otherwise &"no"&.
12753
12754 .vitem &$prvscheck_address$&
12755 This variable is used in conjunction with the &%prvscheck%& expansion item,
12756 which is described in sections &<<SECTexpansionitems>>& and
12757 &<<SECTverifyPRVS>>&.
12758
12759 .vitem &$prvscheck_keynum$&
12760 This variable is used in conjunction with the &%prvscheck%& expansion item,
12761 which is described in sections &<<SECTexpansionitems>>& and
12762 &<<SECTverifyPRVS>>&.
12763
12764 .vitem &$prvscheck_result$&
12765 This variable is used in conjunction with the &%prvscheck%& expansion item,
12766 which is described in sections &<<SECTexpansionitems>>& and
12767 &<<SECTverifyPRVS>>&.
12768
12769 .vitem &$qualify_domain$&
12770 .vindex "&$qualify_domain$&"
12771 The value set for the &%qualify_domain%& option in the configuration file.
12772
12773 .vitem &$qualify_recipient$&
12774 .vindex "&$qualify_recipient$&"
12775 The value set for the &%qualify_recipient%& option in the configuration file,
12776 or if not set, the value of &$qualify_domain$&.
12777
12778 .vitem &$queue_name$&
12779 .vindex &$queue_name$&
12780 .cindex "named queues"
12781 .cindex queues named
12782 The name of the spool queue in use; empty for the default queue.
12783
12784 .new
12785 .vitem &$r_...$&
12786 .vindex &$r_...$&
12787 .cindex router variables
12788 Values can be placed in these variables by the &%set%& option of a router.
12789 They can be given any name that starts with &$r_$&.
12790 The values persist for the address being handled through subsequent routers
12791 and the eventual transport.
12792 .wen
12793
12794 .vitem &$rcpt_count$&
12795 .vindex "&$rcpt_count$&"
12796 When a message is being received by SMTP, this variable contains the number of
12797 RCPT commands received for the current message. If this variable is used in a
12798 RCPT ACL, its value includes the current command.
12799
12800 .vitem &$rcpt_defer_count$&
12801 .vindex "&$rcpt_defer_count$&"
12802 .cindex "4&'xx'& responses" "count of"
12803 When a message is being received by SMTP, this variable contains the number of
12804 RCPT commands in the current message that have previously been rejected with a
12805 temporary (4&'xx'&) response.
12806
12807 .vitem &$rcpt_fail_count$&
12808 .vindex "&$rcpt_fail_count$&"
12809 When a message is being received by SMTP, this variable contains the number of
12810 RCPT commands in the current message that have previously been rejected with a
12811 permanent (5&'xx'&) response.
12812
12813 .vitem &$received_count$&
12814 .vindex "&$received_count$&"
12815 This variable contains the number of &'Received:'& header lines in the message,
12816 including the one added by Exim (so its value is always greater than zero). It
12817 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12818 delivering.
12819
12820 .vitem &$received_for$&
12821 .vindex "&$received_for$&"
12822 If there is only a single recipient address in an incoming message, this
12823 variable contains that address when the &'Received:'& header line is being
12824 built. The value is copied after recipient rewriting has happened, but before
12825 the &[local_scan()]& function is run.
12826
12827 .vitem &$received_ip_address$&
12828 .vindex "&$received_ip_address$&"
12829 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12830 variable is set to the address of the local IP interface, and &$received_port$&
12831 is set to the local port number. (The remote IP address and port are in
12832 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12833 the port value is -1 unless it has been set using the &%-oMi%& command line
12834 option.
12835
12836 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12837 could be used, for example, to make the filename for a TLS certificate depend
12838 on which interface and/or port is being used for the incoming connection. The
12839 values of &$received_ip_address$& and &$received_port$& are saved with any
12840 messages that are received, thus making these variables available at delivery
12841 time.
12842 For outbound connections see &$sending_ip_address$&.
12843
12844 .vitem &$received_port$&
12845 .vindex "&$received_port$&"
12846 See &$received_ip_address$&.
12847
12848 .vitem &$received_protocol$&
12849 .vindex "&$received_protocol$&"
12850 When a message is being processed, this variable contains the name of the
12851 protocol by which it was received. Most of the names used by Exim are defined
12852 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12853 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12854 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12855 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12856 connection and the client was successfully authenticated.
12857
12858 Exim uses the protocol name &"smtps"& for the case when encryption is
12859 automatically set up on connection without the use of STARTTLS (see
12860 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12861 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12862 where the client initially uses EHLO, sets up an encrypted connection using
12863 STARTTLS, and then uses HELO afterwards.
12864
12865 The &%-oMr%& option provides a way of specifying a custom protocol name for
12866 messages that are injected locally by trusted callers. This is commonly used to
12867 identify messages that are being re-injected after some kind of scanning.
12868
12869 .vitem &$received_time$&
12870 .vindex "&$received_time$&"
12871 This variable contains the date and time when the current message was received,
12872 as a number of seconds since the start of the Unix epoch.
12873
12874 .vitem &$recipient_data$&
12875 .vindex "&$recipient_data$&"
12876 This variable is set after an indexing lookup success in an ACL &%recipients%&
12877 condition. It contains the data from the lookup, and the value remains set
12878 until the next &%recipients%& test. Thus, you can do things like this:
12879 .display
12880 &`require recipients  = cdb*@;/some/file`&
12881 &`deny    `&&'some further test involving'& &`$recipient_data`&
12882 .endd
12883 &*Warning*&: This variable is set only when a lookup is used as an indexing
12884 method in the address list, using the semicolon syntax as in the example above.
12885 The variable is not set for a lookup that is used as part of the string
12886 expansion that all such lists undergo before being interpreted.
12887
12888 .vitem &$recipient_verify_failure$&
12889 .vindex "&$recipient_verify_failure$&"
12890 In an ACL, when a recipient verification fails, this variable contains
12891 information about the failure. It is set to one of the following words:
12892
12893 .ilist
12894 &"qualify"&: The address was unqualified (no domain), and the message
12895 was neither local nor came from an exempted host.
12896
12897 .next
12898 &"route"&: Routing failed.
12899
12900 .next
12901 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12902 or before the MAIL command (that is, on initial connection, HELO, or
12903 MAIL).
12904
12905 .next
12906 &"recipient"&: The RCPT command in a callout was rejected.
12907 .next
12908
12909 &"postmaster"&: The postmaster check in a callout was rejected.
12910 .endlist
12911
12912 The main use of this variable is expected to be to distinguish between
12913 rejections of MAIL and rejections of RCPT.
12914
12915 .vitem &$recipients$&
12916 .vindex "&$recipients$&"
12917 This variable contains a list of envelope recipients for a message. A comma and
12918 a space separate the addresses in the replacement text. However, the variable
12919 is not generally available, to prevent exposure of Bcc recipients in
12920 unprivileged users' filter files. You can use &$recipients$& only in these
12921 cases:
12922
12923 .olist
12924 In a system filter file.
12925 .next
12926 In the ACLs associated with the DATA command and with non-SMTP messages, that
12927 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12928 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12929 &%acl_not_smtp_mime%&.
12930 .next
12931 From within a &[local_scan()]& function.
12932 .endlist
12933
12934
12935 .vitem &$recipients_count$&
12936 .vindex "&$recipients_count$&"
12937 When a message is being processed, this variable contains the number of
12938 envelope recipients that came with the message. Duplicates are not excluded
12939 from the count. While a message is being received over SMTP, the number
12940 increases for each accepted recipient. It can be referenced in an ACL.
12941
12942
12943 .vitem &$regex_match_string$&
12944 .vindex "&$regex_match_string$&"
12945 This variable is set to contain the matching regular expression after a
12946 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12947
12948 .vitem "&$regex1$&, &$regex2$&, etc"
12949 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12950 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12951 these variables contain the
12952 captured substrings identified by the regular expression.
12953
12954
12955 .vitem &$reply_address$&
12956 .vindex "&$reply_address$&"
12957 When a message is being processed, this variable contains the contents of the
12958 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12959 contents of the &'From:'& header line. Apart from the removal of leading
12960 white space, the value is not processed in any way. In particular, no RFC 2047
12961 decoding or character code translation takes place.
12962
12963 .vitem &$return_path$&
12964 .vindex "&$return_path$&"
12965 When a message is being delivered, this variable contains the return path &--
12966 the sender field that will be sent as part of the envelope. It is not enclosed
12967 in <> characters. At the start of routing an address, &$return_path$& has the
12968 same value as &$sender_address$&, but if, for example, an incoming message to a
12969 mailing list has been expanded by a router which specifies a different address
12970 for bounce messages, &$return_path$& subsequently contains the new bounce
12971 address, whereas &$sender_address$& always contains the original sender address
12972 that was received with the message. In other words, &$sender_address$& contains
12973 the incoming envelope sender, and &$return_path$& contains the outgoing
12974 envelope sender.
12975
12976 .vitem &$return_size_limit$&
12977 .vindex "&$return_size_limit$&"
12978 This is an obsolete name for &$bounce_return_size_limit$&.
12979
12980 .vitem &$router_name$&
12981 .cindex "router" "name"
12982 .cindex "name" "of router"
12983 .vindex "&$router_name$&"
12984 During the running of a router this variable contains its name.
12985
12986 .vitem &$runrc$&
12987 .cindex "return code" "from &%run%& expansion"
12988 .vindex "&$runrc$&"
12989 This variable contains the return code from a command that is run by the
12990 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12991 assume the order in which option values are expanded, except for those
12992 preconditions whose order of testing is documented. Therefore, you cannot
12993 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12994 another.
12995
12996 .vitem &$self_hostname$&
12997 .oindex "&%self%&" "value of host name"
12998 .vindex "&$self_hostname$&"
12999 When an address is routed to a supposedly remote host that turns out to be the
13000 local host, what happens is controlled by the &%self%& generic router option.
13001 One of its values causes the address to be passed to another router. When this
13002 happens, &$self_hostname$& is set to the name of the local host that the
13003 original router encountered. In other circumstances its contents are null.
13004
13005 .vitem &$sender_address$&
13006 .vindex "&$sender_address$&"
13007 When a message is being processed, this variable contains the sender's address
13008 that was received in the message's envelope. The case of letters in the address
13009 is retained, in both the local part and the domain. For bounce messages, the
13010 value of this variable is the empty string. See also &$return_path$&.
13011
13012 .vitem &$sender_address_data$&
13013 .vindex "&$address_data$&"
13014 .vindex "&$sender_address_data$&"
13015 If &$address_data$& is set when the routers are called from an ACL to verify a
13016 sender address, the final value is preserved in &$sender_address_data$&, to
13017 distinguish it from data from a recipient address. The value does not persist
13018 after the end of the current ACL statement. If you want to preserve it for
13019 longer, you can save it in an ACL variable.
13020
13021 .vitem &$sender_address_domain$&
13022 .vindex "&$sender_address_domain$&"
13023 The domain portion of &$sender_address$&.
13024
13025 .vitem &$sender_address_local_part$&
13026 .vindex "&$sender_address_local_part$&"
13027 The local part portion of &$sender_address$&.
13028
13029 .vitem &$sender_data$&
13030 .vindex "&$sender_data$&"
13031 This variable is set after a lookup success in an ACL &%senders%& condition or
13032 in a router &%senders%& option. It contains the data from the lookup, and the
13033 value remains set until the next &%senders%& test. Thus, you can do things like
13034 this:
13035 .display
13036 &`require senders      = cdb*@;/some/file`&
13037 &`deny    `&&'some further test involving'& &`$sender_data`&
13038 .endd
13039 &*Warning*&: This variable is set only when a lookup is used as an indexing
13040 method in the address list, using the semicolon syntax as in the example above.
13041 The variable is not set for a lookup that is used as part of the string
13042 expansion that all such lists undergo before being interpreted.
13043
13044 .vitem &$sender_fullhost$&
13045 .vindex "&$sender_fullhost$&"
13046 When a message is received from a remote host, this variable contains the host
13047 name and IP address in a single string. It ends with the IP address in square
13048 brackets, followed by a colon and a port number if the logging of ports is
13049 enabled. The format of the rest of the string depends on whether the host
13050 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13051 looking up its IP address. (Looking up the IP address can be forced by the
13052 &%host_lookup%& option, independent of verification.) A plain host name at the
13053 start of the string is a verified host name; if this is not present,
13054 verification either failed or was not requested. A host name in parentheses is
13055 the argument of a HELO or EHLO command. This is omitted if it is identical to
13056 the verified host name or to the host's IP address in square brackets.
13057
13058 .vitem &$sender_helo_dnssec$&
13059 .vindex "&$sender_helo_dnssec$&"
13060 This boolean variable is true if a successful HELO verification was
13061 .cindex "DNS" "DNSSEC"
13062 done using DNS information the resolver library stated was authenticated data.
13063
13064 .vitem &$sender_helo_name$&
13065 .vindex "&$sender_helo_name$&"
13066 When a message is received from a remote host that has issued a HELO or EHLO
13067 command, the argument of that command is placed in this variable. It is also
13068 set if HELO or EHLO is used when a message is received using SMTP locally via
13069 the &%-bs%& or &%-bS%& options.
13070
13071 .vitem &$sender_host_address$&
13072 .vindex "&$sender_host_address$&"
13073 When a message is received from a remote host using SMTP,
13074 this variable contains that
13075 host's IP address. For locally non-SMTP submitted messages, it is empty.
13076
13077 .vitem &$sender_host_authenticated$&
13078 .vindex "&$sender_host_authenticated$&"
13079 This variable contains the name (not the public name) of the authenticator
13080 driver that successfully authenticated the client from which the message was
13081 received. It is empty if there was no successful authentication. See also
13082 &$authenticated_id$&.
13083
13084 .vitem &$sender_host_dnssec$&
13085 .vindex "&$sender_host_dnssec$&"
13086 If an attempt to populate &$sender_host_name$& has been made
13087 (by reference, &%hosts_lookup%& or
13088 otherwise) then this boolean will have been set true if, and only if, the
13089 resolver library states that both
13090 the reverse and forward DNS were authenticated data.  At all
13091 other times, this variable is false.
13092
13093 .cindex "DNS" "DNSSEC"
13094 It is likely that you will need to coerce DNSSEC support on in the resolver
13095 library, by setting:
13096 .code
13097 dns_dnssec_ok = 1
13098 .endd
13099
13100 Exim does not perform DNSSEC validation itself, instead leaving that to a
13101 validating resolver (e.g. unbound, or bind with suitable configuration).
13102
13103 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13104 mechanism in the list, then this variable will be false.
13105
13106 This requires that your system resolver library support EDNS0 (and that
13107 DNSSEC flags exist in the system headers).  If the resolver silently drops
13108 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13109 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13110
13111
13112 .vitem &$sender_host_name$&
13113 .vindex "&$sender_host_name$&"
13114 When a message is received from a remote host, this variable contains the
13115 host's name as obtained by looking up its IP address. For messages received by
13116 other means, this variable is empty.
13117
13118 .vindex "&$host_lookup_failed$&"
13119 If the host name has not previously been looked up, a reference to
13120 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13121 A looked up name is accepted only if it leads back to the original IP address
13122 via a forward lookup. If either the reverse or the forward lookup fails to find
13123 any data, or if the forward lookup does not yield the original IP address,
13124 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13125
13126 .vindex "&$host_lookup_deferred$&"
13127 However, if either of the lookups cannot be completed (for example, there is a
13128 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13129 &$host_lookup_failed$& remains set to &"0"&.
13130
13131 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13132 host name again if there is a subsequent reference to &$sender_host_name$&
13133 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13134 is set to &"1"&.
13135
13136 Exim does not automatically look up every calling host's name. If you want
13137 maximum efficiency, you should arrange your configuration so that it avoids
13138 these lookups altogether. The lookup happens only if one or more of the
13139 following are true:
13140
13141 .ilist
13142 A string containing &$sender_host_name$& is expanded.
13143 .next
13144 The calling host matches the list in &%host_lookup%&. In the default
13145 configuration, this option is set to *, so it must be changed if lookups are
13146 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13147 .next
13148 Exim needs the host name in order to test an item in a host list. The items
13149 that require this are described in sections &<<SECThoslispatnam>>& and
13150 &<<SECThoslispatnamsk>>&.
13151 .next
13152 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13153 In this case, the host name is required to compare with the name quoted in any
13154 EHLO or HELO commands that the client issues.
13155 .next
13156 The remote host issues a EHLO or HELO command that quotes one of the
13157 domains in &%helo_lookup_domains%&. The default value of this option is
13158 . ==== As this is a nested list, any displays it contains must be indented
13159 . ==== as otherwise they are too far to the left.
13160 .code
13161   helo_lookup_domains = @ : @[]
13162 .endd
13163 which causes a lookup if a remote host (incorrectly) gives the server's name or
13164 IP address in an EHLO or HELO command.
13165 .endlist
13166
13167
13168 .vitem &$sender_host_port$&
13169 .vindex "&$sender_host_port$&"
13170 When a message is received from a remote host, this variable contains the port
13171 number that was used on the remote host.
13172
13173 .vitem &$sender_ident$&
13174 .vindex "&$sender_ident$&"
13175 When a message is received from a remote host, this variable contains the
13176 identification received in response to an RFC 1413 request. When a message has
13177 been received locally, this variable contains the login name of the user that
13178 called Exim.
13179
13180 .vitem &$sender_rate_$&&'xxx'&
13181 A number of variables whose names begin &$sender_rate_$& are set as part of the
13182 &%ratelimit%& ACL condition. Details are given in section
13183 &<<SECTratelimiting>>&.
13184
13185 .vitem &$sender_rcvhost$&
13186 .cindex "DNS" "reverse lookup"
13187 .cindex "reverse DNS lookup"
13188 .vindex "&$sender_rcvhost$&"
13189 This is provided specifically for use in &'Received:'& headers. It starts with
13190 either the verified host name (as obtained from a reverse DNS lookup) or, if
13191 there is no verified host name, the IP address in square brackets. After that
13192 there may be text in parentheses. When the first item is a verified host name,
13193 the first thing in the parentheses is the IP address in square brackets,
13194 followed by a colon and a port number if port logging is enabled. When the
13195 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13196 the parentheses.
13197
13198 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13199 was used and its argument was not identical to the real host name or IP
13200 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13201 all three items are present in the parentheses, a newline and tab are inserted
13202 into the string, to improve the formatting of the &'Received:'& header.
13203
13204 .vitem &$sender_verify_failure$&
13205 .vindex "&$sender_verify_failure$&"
13206 In an ACL, when a sender verification fails, this variable contains information
13207 about the failure. The details are the same as for
13208 &$recipient_verify_failure$&.
13209
13210 .vitem &$sending_ip_address$&
13211 .vindex "&$sending_ip_address$&"
13212 This variable is set whenever an outgoing SMTP connection to another host has
13213 been set up. It contains the IP address of the local interface that is being
13214 used. This is useful if a host that has more than one IP address wants to take
13215 on different personalities depending on which one is being used. For incoming
13216 connections, see &$received_ip_address$&.
13217
13218 .vitem &$sending_port$&
13219 .vindex "&$sending_port$&"
13220 This variable is set whenever an outgoing SMTP connection to another host has
13221 been set up. It contains the local port that is being used. For incoming
13222 connections, see &$received_port$&.
13223
13224 .vitem &$smtp_active_hostname$&
13225 .vindex "&$smtp_active_hostname$&"
13226 During an incoming SMTP session, this variable contains the value of the active
13227 host name, as specified by the &%smtp_active_hostname%& option. The value of
13228 &$smtp_active_hostname$& is saved with any message that is received, so its
13229 value can be consulted during routing and delivery.
13230
13231 .vitem &$smtp_command$&
13232 .vindex "&$smtp_command$&"
13233 During the processing of an incoming SMTP command, this variable contains the
13234 entire command. This makes it possible to distinguish between HELO and EHLO in
13235 the HELO ACL, and also to distinguish between commands such as these:
13236 .code
13237 MAIL FROM:<>
13238 MAIL FROM: <>
13239 .endd
13240 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13241 command, the address in &$smtp_command$& is the original address before any
13242 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13243 the address after SMTP-time rewriting.
13244
13245 .vitem &$smtp_command_argument$&
13246 .cindex "SMTP" "command, argument for"
13247 .vindex "&$smtp_command_argument$&"
13248 While an ACL is running to check an SMTP command, this variable contains the
13249 argument, that is, the text that follows the command name, with leading white
13250 space removed. Following the introduction of &$smtp_command$&, this variable is
13251 somewhat redundant, but is retained for backwards compatibility.
13252
13253 .vitem &$smtp_command_history$&
13254 .cindex SMTP "command history"
13255 .vindex "&$smtp_command_history$&"
13256 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13257 received, in time-order left to right.  Only a limited number of commands
13258 are remembered.
13259
13260 .vitem &$smtp_count_at_connection_start$&
13261 .vindex "&$smtp_count_at_connection_start$&"
13262 This variable is set greater than zero only in processes spawned by the Exim
13263 daemon for handling incoming SMTP connections. The name is deliberately long,
13264 in order to emphasize what the contents are. When the daemon accepts a new
13265 connection, it increments this variable. A copy of the variable is passed to
13266 the child process that handles the connection, but its value is fixed, and
13267 never changes. It is only an approximation of how many incoming connections
13268 there actually are, because many other connections may come and go while a
13269 single connection is being processed. When a child process terminates, the
13270 daemon decrements its copy of the variable.
13271
13272 .vitem "&$sn0$& &-- &$sn9$&"
13273 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13274 that were current at the end of the system filter file. This allows a system
13275 filter file to set values that can be tested in users' filter files. For
13276 example, a system filter could set a value indicating how likely it is that a
13277 message is junk mail.
13278
13279 .vitem &$spam_$&&'xxx'&
13280 A number of variables whose names start with &$spam$& are available when Exim
13281 is compiled with the content-scanning extension. For details, see section
13282 &<<SECTscanspamass>>&.
13283
13284 .vitem &$spf_header_comment$& &&&
13285        &$spf_received$& &&&
13286        &$spf_result$& &&&
13287        &$spf_result_guessed$& &&&
13288        &$spf_smtp_comment$&
13289 These variables are only available if Exim is built with SPF support.
13290 For details see section &<<SECSPF>>&.
13291
13292 .vitem &$spool_directory$&
13293 .vindex "&$spool_directory$&"
13294 The name of Exim's spool directory.
13295
13296 .vitem &$spool_inodes$&
13297 .vindex "&$spool_inodes$&"
13298 The number of free inodes in the disk partition where Exim's spool files are
13299 being written. The value is recalculated whenever the variable is referenced.
13300 If the relevant file system does not have the concept of inodes, the value of
13301 is -1. See also the &%check_spool_inodes%& option.
13302
13303 .vitem &$spool_space$&
13304 .vindex "&$spool_space$&"
13305 The amount of free space (as a number of kilobytes) in the disk partition where
13306 Exim's spool files are being written. The value is recalculated whenever the
13307 variable is referenced. If the operating system does not have the ability to
13308 find the amount of free space (only true for experimental systems), the space
13309 value is -1. For example, to check in an ACL that there is at least 50
13310 megabytes free on the spool, you could write:
13311 .code
13312 condition = ${if > {$spool_space}{50000}}
13313 .endd
13314 See also the &%check_spool_space%& option.
13315
13316
13317 .vitem &$thisaddress$&
13318 .vindex "&$thisaddress$&"
13319 This variable is set only during the processing of the &%foranyaddress%&
13320 command in a filter file. Its use is explained in the description of that
13321 command, which can be found in the separate document entitled &'Exim's
13322 interfaces to mail filtering'&.
13323
13324 .vitem &$tls_in_bits$&
13325 .vindex "&$tls_in_bits$&"
13326 Contains an approximation of the TLS cipher's bit-strength
13327 on the inbound connection; the meaning of
13328 this depends upon the TLS implementation used.
13329 If TLS has not been negotiated, the value will be 0.
13330 The value of this is automatically fed into the Cyrus SASL authenticator
13331 when acting as a server, to specify the "external SSF" (a SASL term).
13332
13333 The deprecated &$tls_bits$& variable refers to the inbound side
13334 except when used in the context of an outbound SMTP delivery, when it refers to
13335 the outbound.
13336
13337 .vitem &$tls_out_bits$&
13338 .vindex "&$tls_out_bits$&"
13339 Contains an approximation of the TLS cipher's bit-strength
13340 on an outbound SMTP connection; the meaning of
13341 this depends upon the TLS implementation used.
13342 If TLS has not been negotiated, the value will be 0.
13343
13344 .vitem &$tls_in_ourcert$&
13345 .vindex "&$tls_in_ourcert$&"
13346 .cindex certificate variables
13347 This variable refers to the certificate presented to the peer of an
13348 inbound connection when the message was received.
13349 It is only useful as the argument of a
13350 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13351 or a &%def%& condition.
13352
13353 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13354 when a list of more than one
13355 file is used for &%tls_certificate%&, this variable is not reliable.
13356
13357 .vitem &$tls_in_peercert$&
13358 .vindex "&$tls_in_peercert$&"
13359 This variable refers to the certificate presented by the peer of an
13360 inbound connection when the message was received.
13361 It is only useful as the argument of a
13362 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13363 or a &%def%& condition.
13364 If certificate verification fails it may refer to a failing chain element
13365 which is not the leaf.
13366
13367 .vitem &$tls_out_ourcert$&
13368 .vindex "&$tls_out_ourcert$&"
13369 This variable refers to the certificate presented to the peer of an
13370 outbound connection.  It is only useful as the argument of a
13371 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13372 or a &%def%& condition.
13373
13374 .vitem &$tls_out_peercert$&
13375 .vindex "&$tls_out_peercert$&"
13376 This variable refers to the certificate presented by the peer of an
13377 outbound connection.  It is only useful as the argument of a
13378 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13379 or a &%def%& condition.
13380 If certificate verification fails it may refer to a failing chain element
13381 which is not the leaf.
13382
13383 .vitem &$tls_in_certificate_verified$&
13384 .vindex "&$tls_in_certificate_verified$&"
13385 This variable is set to &"1"& if a TLS certificate was verified when the
13386 message was received, and &"0"& otherwise.
13387
13388 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13389 except when used in the context of an outbound SMTP delivery, when it refers to
13390 the outbound.
13391
13392 .vitem &$tls_out_certificate_verified$&
13393 .vindex "&$tls_out_certificate_verified$&"
13394 This variable is set to &"1"& if a TLS certificate was verified when an
13395 outbound SMTP connection was made,
13396 and &"0"& otherwise.
13397
13398 .vitem &$tls_in_cipher$&
13399 .vindex "&$tls_in_cipher$&"
13400 .vindex "&$tls_cipher$&"
13401 When a message is received from a remote host over an encrypted SMTP
13402 connection, this variable is set to the cipher suite that was negotiated, for
13403 example DES-CBC3-SHA. In other circumstances, in particular, for message
13404 received over unencrypted connections, the variable is empty. Testing
13405 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13406 non-encrypted connections during ACL processing.
13407
13408 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13409 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13410 becomes the same as &$tls_out_cipher$&.
13411
13412 .new
13413 .vitem &$tls_in_cipher_std$&
13414 .vindex "&$tls_in_cipher_std$&"
13415 As above, but returning the RFC standard name for the cipher suite.
13416 .wen
13417
13418 .vitem &$tls_out_cipher$&
13419 .vindex "&$tls_out_cipher$&"
13420 This variable is
13421 cleared before any outgoing SMTP connection is made,
13422 and then set to the outgoing cipher suite if one is negotiated. See chapter
13423 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13424 details of the &(smtp)& transport.
13425
13426 ,new
13427 .vitem &$tls_out_cipher_std$&
13428 .vindex "&$tls_out_cipher_std$&"
13429 As above, but returning the RFC standard name for the cipher suite.
13430 .wen
13431
13432 .vitem &$tls_out_dane$&
13433 .vindex &$tls_out_dane$&
13434 DANE active status.  See section &<<SECDANE>>&.
13435
13436 .vitem &$tls_in_ocsp$&
13437 .vindex "&$tls_in_ocsp$&"
13438 When a message is received from a remote client connection
13439 the result of any OCSP request from the client is encoded in this variable:
13440 .code
13441 0 OCSP proof was not requested (default value)
13442 1 No response to request
13443 2 Response not verified
13444 3 Verification failed
13445 4 Verification succeeded
13446 .endd
13447
13448 .vitem &$tls_out_ocsp$&
13449 .vindex "&$tls_out_ocsp$&"
13450 When a message is sent to a remote host connection
13451 the result of any OCSP request made is encoded in this variable.
13452 See &$tls_in_ocsp$& for values.
13453
13454 .vitem &$tls_in_peerdn$&
13455 .vindex "&$tls_in_peerdn$&"
13456 .vindex "&$tls_peerdn$&"
13457 .cindex certificate "extracting fields"
13458 When a message is received from a remote host over an encrypted SMTP
13459 connection, and Exim is configured to request a certificate from the client,
13460 the value of the Distinguished Name of the certificate is made available in the
13461 &$tls_in_peerdn$& during subsequent processing.
13462 If certificate verification fails it may refer to a failing chain element
13463 which is not the leaf.
13464
13465 The deprecated &$tls_peerdn$& variable refers to the inbound side
13466 except when used in the context of an outbound SMTP delivery, when it refers to
13467 the outbound.
13468
13469 .vitem &$tls_out_peerdn$&
13470 .vindex "&$tls_out_peerdn$&"
13471 When a message is being delivered to a remote host over an encrypted SMTP
13472 connection, and Exim is configured to request a certificate from the server,
13473 the value of the Distinguished Name of the certificate is made available in the
13474 &$tls_out_peerdn$& during subsequent processing.
13475 If certificate verification fails it may refer to a failing chain element
13476 which is not the leaf.
13477
13478 .vitem &$tls_in_sni$&
13479 .vindex "&$tls_in_sni$&"
13480 .vindex "&$tls_sni$&"
13481 .cindex "TLS" "Server Name Indication"
13482 When a TLS session is being established, if the client sends the Server
13483 Name Indication extension, the value will be placed in this variable.
13484 If the variable appears in &%tls_certificate%& then this option and
13485 some others, described in &<<SECTtlssni>>&,
13486 will be re-expanded early in the TLS session, to permit
13487 a different certificate to be presented (and optionally a different key to be
13488 used) to the client, based upon the value of the SNI extension.
13489
13490 The deprecated &$tls_sni$& variable refers to the inbound side
13491 except when used in the context of an outbound SMTP delivery, when it refers to
13492 the outbound.
13493
13494 .vitem &$tls_out_sni$&
13495 .vindex "&$tls_out_sni$&"
13496 .cindex "TLS" "Server Name Indication"
13497 During outbound
13498 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13499 the transport.
13500
13501 .vitem &$tls_out_tlsa_usage$&
13502 .vindex &$tls_out_tlsa_usage$&
13503 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13504
13505 .vitem &$tod_bsdinbox$&
13506 .vindex "&$tod_bsdinbox$&"
13507 The time of day and the date, in the format required for BSD-style mailbox
13508 files, for example: Thu Oct 17 17:14:09 1995.
13509
13510 .vitem &$tod_epoch$&
13511 .vindex "&$tod_epoch$&"
13512 The time and date as a number of seconds since the start of the Unix epoch.
13513
13514 .vitem &$tod_epoch_l$&
13515 .vindex "&$tod_epoch_l$&"
13516 The time and date as a number of microseconds since the start of the Unix epoch.
13517
13518 .vitem &$tod_full$&
13519 .vindex "&$tod_full$&"
13520 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13521 +0100. The timezone is always given as a numerical offset from UTC, with
13522 positive values used for timezones that are ahead (east) of UTC, and negative
13523 values for those that are behind (west).
13524
13525 .vitem &$tod_log$&
13526 .vindex "&$tod_log$&"
13527 The time and date in the format used for writing Exim's log files, for example:
13528 1995-10-12 15:32:29, but without a timezone.
13529
13530 .vitem &$tod_logfile$&
13531 .vindex "&$tod_logfile$&"
13532 This variable contains the date in the format yyyymmdd. This is the format that
13533 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13534 flag.
13535
13536 .vitem &$tod_zone$&
13537 .vindex "&$tod_zone$&"
13538 This variable contains the numerical value of the local timezone, for example:
13539 -0500.
13540
13541 .vitem &$tod_zulu$&
13542 .vindex "&$tod_zulu$&"
13543 This variable contains the UTC date and time in &"Zulu"& format, as specified
13544 by ISO 8601, for example: 20030221154023Z.
13545
13546 .vitem &$transport_name$&
13547 .cindex "transport" "name"
13548 .cindex "name" "of transport"
13549 .vindex "&$transport_name$&"
13550 During the running of a transport, this variable contains its name.
13551
13552 .vitem &$value$&
13553 .vindex "&$value$&"
13554 This variable contains the result of an expansion lookup, extraction operation,
13555 or external command, as described above. It is also used during a
13556 &*reduce*& expansion.
13557
13558 .vitem &$verify_mode$&
13559 .vindex "&$verify_mode$&"
13560 While a router or transport is being run in verify mode or for cutthrough delivery,
13561 contains "S" for sender-verification or "R" for recipient-verification.
13562 Otherwise, empty.
13563
13564 .vitem &$version_number$&
13565 .vindex "&$version_number$&"
13566 The version number of Exim. Same as &$exim_version$&, may be overridden
13567 by the &%exim_version%& main config option.
13568
13569 .vitem &$warn_message_delay$&
13570 .vindex "&$warn_message_delay$&"
13571 This variable is set only during the creation of a message warning about a
13572 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13573
13574 .vitem &$warn_message_recipients$&
13575 .vindex "&$warn_message_recipients$&"
13576 This variable is set only during the creation of a message warning about a
13577 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13578 .endlist
13579 .ecindex IIDstrexp
13580
13581
13582
13583 . ////////////////////////////////////////////////////////////////////////////
13584 . ////////////////////////////////////////////////////////////////////////////
13585
13586 .chapter "Embedded Perl" "CHAPperl"
13587 .scindex IIDperl "Perl" "calling from Exim"
13588 Exim can be built to include an embedded Perl interpreter. When this is done,
13589 Perl subroutines can be called as part of the string expansion process. To make
13590 use of the Perl support, you need version 5.004 or later of Perl installed on
13591 your system. To include the embedded interpreter in the Exim binary, include
13592 the line
13593 .code
13594 EXIM_PERL = perl.o
13595 .endd
13596 in your &_Local/Makefile_& and then build Exim in the normal way.
13597
13598
13599 .section "Setting up so Perl can be used" "SECID85"
13600 .oindex "&%perl_startup%&"
13601 Access to Perl subroutines is via a global configuration option called
13602 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13603 no &%perl_startup%& option in the Exim configuration file then no Perl
13604 interpreter is started and there is almost no overhead for Exim (since none of
13605 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13606 option then the associated value is taken to be Perl code which is executed in
13607 a newly created Perl interpreter.
13608
13609 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13610 need backslashes before any characters to escape special meanings. The option
13611 should usually be something like
13612 .code
13613 perl_startup = do '/etc/exim.pl'
13614 .endd
13615 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13616 use from Exim. Exim can be configured either to start up a Perl interpreter as
13617 soon as it is entered, or to wait until the first time it is needed. Starting
13618 the interpreter at the beginning ensures that it is done while Exim still has
13619 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13620 fact used in a particular run. Also, note that this does not mean that Exim is
13621 necessarily running as root when Perl is called at a later time. By default,
13622 the interpreter is started only when it is needed, but this can be changed in
13623 two ways:
13624
13625 .ilist
13626 .oindex "&%perl_at_start%&"
13627 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13628 a startup when Exim is entered.
13629 .next
13630 The command line option &%-ps%& also requests a startup when Exim is entered,
13631 overriding the setting of &%perl_at_start%&.
13632 .endlist
13633
13634 There is also a command line option &%-pd%& (for delay) which suppresses the
13635 initial startup, even if &%perl_at_start%& is set.
13636
13637 .ilist
13638 .oindex "&%perl_taintmode%&"
13639 .cindex "Perl" "taintmode"
13640 To provide more security executing Perl code via the embedded Perl
13641 interpreter, the &%perl_taintmode%& option can be set. This enables the
13642 taint mode of the Perl interpreter. You are encouraged to set this
13643 option to a true value. To avoid breaking existing installations, it
13644 defaults to false.
13645
13646
13647 .section "Calling Perl subroutines" "SECID86"
13648 When the configuration file includes a &%perl_startup%& option you can make use
13649 of the string expansion item to call the Perl subroutines that are defined
13650 by the &%perl_startup%& code. The operator is used in any of the following
13651 forms:
13652 .code
13653 ${perl{foo}}
13654 ${perl{foo}{argument}}
13655 ${perl{foo}{argument1}{argument2} ... }
13656 .endd
13657 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13658 arguments may be passed. Passing more than this results in an expansion failure
13659 with an error message of the form
13660 .code
13661 Too many arguments passed to Perl subroutine "foo" (max is 8)
13662 .endd
13663 The return value of the Perl subroutine is evaluated in a scalar context before
13664 it is passed back to Exim to be inserted into the expanded string. If the
13665 return value is &'undef'&, the expansion is forced to fail in the same way as
13666 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13667 by obeying Perl's &%die%& function, the expansion fails with the error message
13668 that was passed to &%die%&.
13669
13670
13671 .section "Calling Exim functions from Perl" "SECID87"
13672 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13673 is available to call back into Exim's string expansion function. For example,
13674 the Perl code
13675 .code
13676 my $lp = Exim::expand_string('$local_part');
13677 .endd
13678 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13679 Note those are single quotes and not double quotes to protect against
13680 &$local_part$& being interpolated as a Perl variable.
13681
13682 If the string expansion is forced to fail by a &"fail"& item, the result of
13683 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13684 expansion string, the Perl call from the original expansion string fails with
13685 an appropriate error message, in the same way as if &%die%& were used.
13686
13687 .cindex "debugging" "from embedded Perl"
13688 .cindex "log" "writing from embedded Perl"
13689 Two other Exim functions are available for use from within Perl code.
13690 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13691 debugging is enabled. If you want a newline at the end, you must supply it.
13692 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13693 timestamp. In this case, you should not supply a terminating newline.
13694
13695
13696 .section "Use of standard output and error by Perl" "SECID88"
13697 .cindex "Perl" "standard output and error"
13698 You should not write to the standard error or output streams from within your
13699 Perl code, as it is not defined how these are set up. In versions of Exim
13700 before 4.50, it is possible for the standard output or error to refer to the
13701 SMTP connection during message reception via the daemon. Writing to this stream
13702 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13703 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13704 avoided, but the output is lost.
13705
13706 .cindex "Perl" "use of &%warn%&"
13707 The Perl &%warn%& statement writes to the standard error stream by default.
13708 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13709 you have no control. When Exim starts up the Perl interpreter, it arranges for
13710 output from the &%warn%& statement to be written to the Exim main log. You can
13711 change this by including appropriate Perl magic somewhere in your Perl code.
13712 For example, to discard &%warn%& output completely, you need this:
13713 .code
13714 $SIG{__WARN__} = sub { };
13715 .endd
13716 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13717 example, the code for the subroutine is empty, so it does nothing, but you can
13718 include any Perl code that you like. The text of the &%warn%& message is passed
13719 as the first subroutine argument.
13720 .ecindex IIDperl
13721
13722
13723 . ////////////////////////////////////////////////////////////////////////////
13724 . ////////////////////////////////////////////////////////////////////////////
13725
13726 .chapter "Starting the daemon and the use of network interfaces" &&&
13727          "CHAPinterfaces" &&&
13728          "Starting the daemon"
13729 .cindex "daemon" "starting"
13730 .cindex "interface" "listening"
13731 .cindex "network interface"
13732 .cindex "interface" "network"
13733 .cindex "IP address" "for listening"
13734 .cindex "daemon" "listening IP addresses"
13735 .cindex "TCP/IP" "setting listening interfaces"
13736 .cindex "TCP/IP" "setting listening ports"
13737 A host that is connected to a TCP/IP network may have one or more physical
13738 hardware network interfaces. Each of these interfaces may be configured as one
13739 or more &"logical"& interfaces, which are the entities that a program actually
13740 works with. Each of these logical interfaces is associated with an IP address.
13741 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13742 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13743 knowledge about the host's interfaces for use in three different circumstances:
13744
13745 .olist
13746 When a listening daemon is started, Exim needs to know which interfaces
13747 and ports to listen on.
13748 .next
13749 When Exim is routing an address, it needs to know which IP addresses
13750 are associated with local interfaces. This is required for the correct
13751 processing of MX lists by removing the local host and others with the
13752 same or higher priority values. Also, Exim needs to detect cases
13753 when an address is routed to an IP address that in fact belongs to the
13754 local host. Unless the &%self%& router option or the &%allow_localhost%&
13755 option of the smtp transport is set (as appropriate), this is treated
13756 as an error situation.
13757 .next
13758 When Exim connects to a remote host, it may need to know which interface to use
13759 for the outgoing connection.
13760 .endlist
13761
13762
13763 Exim's default behaviour is likely to be appropriate in the vast majority
13764 of cases. If your host has only one interface, and you want all its IP
13765 addresses to be treated in the same way, and you are using only the
13766 standard SMTP port, you should not need to take any special action. The
13767 rest of this chapter does not apply to you.
13768
13769 In a more complicated situation you may want to listen only on certain
13770 interfaces, or on different ports, and for this reason there are a number of
13771 options that can be used to influence Exim's behaviour. The rest of this
13772 chapter describes how they operate.
13773
13774 When a message is received over TCP/IP, the interface and port that were
13775 actually used are set in &$received_ip_address$& and &$received_port$&.
13776
13777
13778
13779 .section "Starting a listening daemon" "SECID89"
13780 When a listening daemon is started (by means of the &%-bd%& command line
13781 option), the interfaces and ports on which it listens are controlled by the
13782 following options:
13783
13784 .ilist
13785 &%daemon_smtp_ports%& contains a list of default ports
13786 or service names.
13787 (For backward compatibility, this option can also be specified in the singular.)
13788 .next
13789 &%local_interfaces%& contains list of interface IP addresses on which to
13790 listen. Each item may optionally also specify a port.
13791 .endlist
13792
13793 The default list separator in both cases is a colon, but this can be changed as
13794 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13795 it is usually best to change the separator to avoid having to double all the
13796 colons. For example:
13797 .code
13798 local_interfaces = <; 127.0.0.1 ; \
13799                       192.168.23.65 ; \
13800                       ::1 ; \
13801                       3ffe:ffff:836f::fe86:a061
13802 .endd
13803 There are two different formats for specifying a port along with an IP address
13804 in &%local_interfaces%&:
13805
13806 .olist
13807 The port is added onto the address with a dot separator. For example, to listen
13808 on port 1234 on two different IP addresses:
13809 .code
13810 local_interfaces = <; 192.168.23.65.1234 ; \
13811                       3ffe:ffff:836f::fe86:a061.1234
13812 .endd
13813 .next
13814 The IP address is enclosed in square brackets, and the port is added
13815 with a colon separator, for example:
13816 .code
13817 local_interfaces = <; [192.168.23.65]:1234 ; \
13818                       [3ffe:ffff:836f::fe86:a061]:1234
13819 .endd
13820 .endlist
13821
13822 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13823 default setting contains just one port:
13824 .code
13825 daemon_smtp_ports = smtp
13826 .endd
13827 If more than one port is listed, each interface that does not have its own port
13828 specified listens on all of them. Ports that are listed in
13829 &%daemon_smtp_ports%& can be identified either by name (defined in
13830 &_/etc/services_&) or by number. However, when ports are given with individual
13831 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13832
13833
13834
13835 .section "Special IP listening addresses" "SECID90"
13836 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13837 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13838 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13839 instead of setting up separate listening sockets for each interface. The
13840 default value of &%local_interfaces%& is
13841 .code
13842 local_interfaces = 0.0.0.0
13843 .endd
13844 when Exim is built without IPv6 support; otherwise it is:
13845 .code
13846 local_interfaces = <; ::0 ; 0.0.0.0
13847 .endd
13848 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13849
13850
13851
13852 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13853 The &%-oX%& command line option can be used to override the values of
13854 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13855 instance. Another way of doing this would be to use macros and the &%-D%&
13856 option. However, &%-oX%& can be used by any admin user, whereas modification of
13857 the runtime configuration by &%-D%& is allowed only when the caller is root or
13858 exim.
13859
13860 The value of &%-oX%& is a list of items. The default colon separator can be
13861 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13862 If there are any items that do not
13863 contain dots or colons (that is, are not IP addresses), the value of
13864 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13865 items that do contain dots or colons, the value of &%local_interfaces%& is
13866 replaced by those items. Thus, for example,
13867 .code
13868 -oX 1225
13869 .endd
13870 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13871 whereas
13872 .code
13873 -oX 192.168.34.5.1125
13874 .endd
13875 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13876 (However, since &%local_interfaces%& now contains no items without ports, the
13877 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13878
13879
13880
13881 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13882 .cindex "submissions protocol"
13883 .cindex "ssmtp protocol"
13884 .cindex "smtps protocol"
13885 .cindex "SMTP" "ssmtp protocol"
13886 .cindex "SMTP" "smtps protocol"
13887 Exim supports the use of TLS-on-connect, used by mail clients in the
13888 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13889 For some years, IETF Standards Track documents only blessed the
13890 STARTTLS-based Submission service (port 587) while common practice was to support
13891 the same feature set on port 465, but using TLS-on-connect.
13892 If your installation needs to provide service to mail clients
13893 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13894 the 465 TCP ports.
13895
13896 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13897 service names, connections to those ports must first establish TLS, before
13898 proceeding to the application layer use of the SMTP protocol.
13899
13900 The common use of this option is expected to be
13901 .code
13902 tls_on_connect_ports = 465
13903 .endd
13904 per RFC 8314.
13905 There is also a command line option &%-tls-on-connect%&, which forces all ports
13906 to behave in this way when a daemon is started.
13907
13908 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13909 daemon to listen on those ports. You must still specify them in
13910 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13911 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13912 connections via the daemon.)
13913
13914
13915
13916
13917 .section "IPv6 address scopes" "SECID92"
13918 .cindex "IPv6" "address scopes"
13919 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13920 can, in principle, have the same link-local IPv6 address on different
13921 interfaces. Thus, additional information is needed, over and above the IP
13922 address, to distinguish individual interfaces. A convention of using a
13923 percent sign followed by something (often the interface name) has been
13924 adopted in some cases, leading to addresses like this:
13925 .code
13926 fe80::202:b3ff:fe03:45c1%eth0
13927 .endd
13928 To accommodate this usage, a percent sign followed by an arbitrary string is
13929 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13930 to convert a textual IPv6 address for actual use. This function recognizes the
13931 percent convention in operating systems that support it, and it processes the
13932 address appropriately. Unfortunately, some older libraries have problems with
13933 &[getaddrinfo()]&. If
13934 .code
13935 IPV6_USE_INET_PTON=yes
13936 .endd
13937 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13938 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13939 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13940 function.) Of course, this means that the additional functionality of
13941 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13942
13943 .section "Disabling IPv6" "SECID93"
13944 .cindex "IPv6" "disabling"
13945 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13946 run on a host whose kernel does not support IPv6. The binary will fall back to
13947 using IPv4, but it may waste resources looking up AAAA records, and trying to
13948 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13949 .oindex "&%disable_ipv6%&"
13950 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13951 activities take place. AAAA records are never looked up, and any IPv6 addresses
13952 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13953 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13954 to handle IPv6 literal addresses.
13955
13956 On the other hand, when IPv6 is in use, there may be times when you want to
13957 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13958 option to globally suppress the lookup of AAAA records for specified domains,
13959 and you can use the &%ignore_target_hosts%& generic router option to ignore
13960 IPv6 addresses in an individual router.
13961
13962
13963
13964 .section "Examples of starting a listening daemon" "SECID94"
13965 The default case in an IPv6 environment is
13966 .code
13967 daemon_smtp_ports = smtp
13968 local_interfaces = <; ::0 ; 0.0.0.0
13969 .endd
13970 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13971 Either one or two sockets may be used, depending on the characteristics of
13972 the TCP/IP stack. (This is complicated and messy; for more information,
13973 read the comments in the &_daemon.c_& source file.)
13974
13975 To specify listening on ports 25 and 26 on all interfaces:
13976 .code
13977 daemon_smtp_ports = 25 : 26
13978 .endd
13979 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13980 .code
13981 local_interfaces = <; ::0.25     ; ::0.26 \
13982                       0.0.0.0.25 ; 0.0.0.0.26
13983 .endd
13984 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13985 IPv4 loopback address only:
13986 .code
13987 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13988 .endd
13989 To specify listening on the default port on specific interfaces only:
13990 .code
13991 local_interfaces = 10.0.0.67 : 192.168.34.67
13992 .endd
13993 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13994
13995
13996
13997 .section "Recognizing the local host" "SECTreclocipadd"
13998 The &%local_interfaces%& option is also used when Exim needs to determine
13999 whether or not an IP address refers to the local host. That is, the IP
14000 addresses of all the interfaces on which a daemon is listening are always
14001 treated as local.
14002
14003 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14004 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14005 available interfaces from the operating system, and extracts the relevant
14006 (that is, IPv4 or IPv6) addresses to use for checking.
14007
14008 Some systems set up large numbers of virtual interfaces in order to provide
14009 many virtual web servers. In this situation, you may want to listen for
14010 email on only a few of the available interfaces, but nevertheless treat all
14011 interfaces as local when routing. You can do this by setting
14012 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14013 &"all"& wildcard values. These addresses are recognized as local, but are not
14014 used for listening. Consider this example:
14015 .code
14016 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14017                       192.168.53.235 ; \
14018                       3ffe:2101:12:1:a00:20ff:fe86:a061
14019
14020 extra_local_interfaces = <; ::0 ; 0.0.0.0
14021 .endd
14022 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14023 address, but all available interface addresses are treated as local when
14024 Exim is routing.
14025
14026 In some environments the local host name may be in an MX list, but with an IP
14027 address that is not assigned to any local interface. In other cases it may be
14028 desirable to treat other host names as if they referred to the local host. Both
14029 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14030 This contains host names rather than IP addresses. When a host is referenced
14031 during routing, either via an MX record or directly, it is treated as the local
14032 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14033 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14034
14035
14036
14037 .section "Delivering to a remote host" "SECID95"
14038 Delivery to a remote host is handled by the smtp transport. By default, it
14039 allows the system's TCP/IP functions to choose which interface to use (if
14040 there is more than one) when connecting to a remote host. However, the
14041 &%interface%& option can be set to specify which interface is used. See the
14042 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14043 details.
14044
14045
14046
14047
14048 . ////////////////////////////////////////////////////////////////////////////
14049 . ////////////////////////////////////////////////////////////////////////////
14050
14051 .chapter "Main configuration" "CHAPmainconfig"
14052 .scindex IIDconfima "configuration file" "main section"
14053 .scindex IIDmaiconf "main configuration"
14054 The first part of the runtime configuration file contains three types of item:
14055
14056 .ilist
14057 Macro definitions: These lines start with an upper case letter. See section
14058 &<<SECTmacrodefs>>& for details of macro processing.
14059 .next
14060 Named list definitions: These lines start with one of the words &"domainlist"&,
14061 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14062 section &<<SECTnamedlists>>&.
14063 .next
14064 Main configuration settings: Each setting occupies one line of the file
14065 (with possible continuations). If any setting is preceded by the word
14066 &"hide"&, the &%-bP%& command line option displays its value to admin users
14067 only. See section &<<SECTcos>>& for a description of the syntax of these option
14068 settings.
14069 .endlist
14070
14071 This chapter specifies all the main configuration options, along with their
14072 types and default values. For ease of finding a particular option, they appear
14073 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14074 are now so many options, they are first listed briefly in functional groups, as
14075 an aid to finding the name of the option you are looking for. Some options are
14076 listed in more than one group.
14077
14078 .section "Miscellaneous" "SECID96"
14079 .table2
14080 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14081 .row &%debug_store%&                 "do extra internal checks"
14082 .row &%disable_ipv6%&                "do no IPv6 processing"
14083 .row &%keep_malformed%&              "for broken files &-- should not happen"
14084 .row &%localhost_number%&            "for unique message ids in clusters"
14085 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14086 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14087 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14088 .row &%print_topbitchars%&           "top-bit characters are printing"
14089 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14090 .row &%timezone%&                    "force time zone"
14091 .endtable
14092
14093
14094 .section "Exim parameters" "SECID97"
14095 .table2
14096 .row &%exim_group%&                  "override compiled-in value"
14097 .row &%exim_path%&                   "override compiled-in value"
14098 .row &%exim_user%&                   "override compiled-in value"
14099 .row &%primary_hostname%&            "default from &[uname()]&"
14100 .row &%split_spool_directory%&       "use multiple directories"
14101 .row &%spool_directory%&             "override compiled-in value"
14102 .endtable
14103
14104
14105
14106 .section "Privilege controls" "SECID98"
14107 .table2
14108 .row &%admin_groups%&                "groups that are Exim admin users"
14109 .row &%commandline_checks_require_admin%& "require admin for various checks"
14110 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14111 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14112 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14113 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14114 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14115 .row &%never_users%&                 "do not run deliveries as these"
14116 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14117 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14118 .row &%trusted_groups%&              "groups that are trusted"
14119 .row &%trusted_users%&               "users that are trusted"
14120 .endtable
14121
14122
14123
14124 .section "Logging" "SECID99"
14125 .table2
14126 .row &%event_action%&                "custom logging"
14127 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14128 .row &%log_file_path%&               "override compiled-in value"
14129 .row &%log_selector%&                "set/unset optional logging"
14130 .row &%log_timezone%&                "add timezone to log lines"
14131 .row &%message_logs%&                "create per-message logs"
14132 .row &%preserve_message_logs%&       "after message completion"
14133 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14134 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14135 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14136 .row &%syslog_facility%&             "set syslog &""facility""& field"
14137 .row &%syslog_pid%&                  "pid in syslog lines"
14138 .row &%syslog_processname%&          "set syslog &""ident""& field"
14139 .row &%syslog_timestamp%&            "timestamp syslog lines"
14140 .row &%write_rejectlog%&             "control use of message log"
14141 .endtable
14142
14143
14144
14145 .section "Frozen messages" "SECID100"
14146 .table2
14147 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14148 .row &%freeze_tell%&                 "send message when freezing"
14149 .row &%move_frozen_messages%&        "to another directory"
14150 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14151 .endtable
14152
14153
14154
14155 .section "Data lookups" "SECID101"
14156 .table2
14157 .row &%ibase_servers%&               "InterBase servers"
14158 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14159 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14160 .row &%ldap_cert_file%&              "client cert file for LDAP"
14161 .row &%ldap_cert_key%&               "client key file for LDAP"
14162 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14163 .row &%ldap_default_servers%&        "used if no server in query"
14164 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14165 .row &%ldap_start_tls%&              "require TLS within LDAP"
14166 .row &%ldap_version%&                "set protocol version"
14167 .row &%lookup_open_max%&             "lookup files held open"
14168 .row &%mysql_servers%&               "default MySQL servers"
14169 .row &%oracle_servers%&              "Oracle servers"
14170 .row &%pgsql_servers%&               "default PostgreSQL servers"
14171 .row &%sqlite_lock_timeout%&         "as it says"
14172 .endtable
14173
14174
14175
14176 .section "Message ids" "SECID102"
14177 .table2
14178 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14179 .row &%message_id_header_text%&      "ditto"
14180 .endtable
14181
14182
14183
14184 .section "Embedded Perl Startup" "SECID103"
14185 .table2
14186 .row &%perl_at_start%&               "always start the interpreter"
14187 .row &%perl_startup%&                "code to obey when starting Perl"
14188 .row &%perl_taintmode%&              "enable taint mode in Perl"
14189 .endtable
14190
14191
14192
14193 .section "Daemon" "SECID104"
14194 .table2
14195 .row &%daemon_smtp_ports%&           "default ports"
14196 .row &%daemon_startup_retries%&      "number of times to retry"
14197 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14198 .row &%extra_local_interfaces%&      "not necessarily listened on"
14199 .row &%local_interfaces%&            "on which to listen, with optional ports"
14200 .row &%pid_file_path%&               "override compiled-in value"
14201 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14202 .endtable
14203
14204
14205
14206 .section "Resource control" "SECID105"
14207 .table2
14208 .row &%check_log_inodes%&            "before accepting a message"
14209 .row &%check_log_space%&             "before accepting a message"
14210 .row &%check_spool_inodes%&          "before accepting a message"
14211 .row &%check_spool_space%&           "before accepting a message"
14212 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14213 .row &%queue_only_load%&             "queue incoming if load high"
14214 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14215 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14216 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14217 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14218 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14219 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14220 .row &%smtp_accept_max_per_connection%& "messages per connection"
14221 .row &%smtp_accept_max_per_host%&    "connections from one host"
14222 .row &%smtp_accept_queue%&           "queue mail if more connections"
14223 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14224                                            connection"
14225 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14226 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14227 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14228 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14229 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14230 .endtable
14231
14232
14233
14234 .section "Policy controls" "SECID106"
14235 .table2
14236 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14237 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14238 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14239 .row &%acl_smtp_auth%&               "ACL for AUTH"
14240 .row &%acl_smtp_connect%&            "ACL for connection"
14241 .row &%acl_smtp_data%&               "ACL for DATA"
14242 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14243 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14244 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14245 .row &%acl_smtp_expn%&               "ACL for EXPN"
14246 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14247 .row &%acl_smtp_mail%&               "ACL for MAIL"
14248 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14249 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14250 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14251 .row &%acl_smtp_predata%&            "ACL for start of data"
14252 .row &%acl_smtp_quit%&               "ACL for QUIT"
14253 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14254 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14255 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14256 .row &%av_scanner%&                  "specify virus scanner"
14257 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14258                                       words""&"
14259 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14260 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14261 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14262 .row &%header_maxsize%&              "total size of message header"
14263 .row &%header_line_maxsize%&         "individual header line limit"
14264 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14265 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14266 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14267 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14268 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14269 .row &%host_lookup%&                 "host name looked up for these hosts"
14270 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14271 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14272 .row &%host_reject_connection%&      "reject connection from these hosts"
14273 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14274 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14275 .row &%message_size_limit%&          "for all messages"
14276 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14277 .row &%spamd_address%&               "set interface to SpamAssassin"
14278 .row &%strict_acl_vars%&             "object to unset ACL variables"
14279 .endtable
14280
14281
14282
14283 .section "Callout cache" "SECID107"
14284 .table2
14285 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14286                                          item"
14287 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14288                                          item"
14289 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14290 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14291 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14292 .endtable
14293
14294
14295
14296 .section "TLS" "SECID108"
14297 .table2
14298 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14299 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14300 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14301 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14302 .row &%tls_certificate%&             "location of server certificate"
14303 .row &%tls_crl%&                     "certificate revocation list"
14304 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14305 .row &%tls_dhparam%&                 "DH parameters for server"
14306 .row &%tls_eccurve%&                 "EC curve selection for server"
14307 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14308 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14309 .row &%tls_privatekey%&              "location of server private key"
14310 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14311 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14312 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14313 .row &%tls_verify_certificates%&     "expected client certificates"
14314 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14315 .endtable
14316
14317
14318
14319 .section "Local user handling" "SECID109"
14320 .table2
14321 .row &%finduser_retries%&            "useful in NIS environments"
14322 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14323 .row &%gecos_pattern%&               "ditto"
14324 .row &%max_username_length%&         "for systems that truncate"
14325 .row &%unknown_login%&               "used when no login name found"
14326 .row &%unknown_username%&            "ditto"
14327 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14328 .row &%uucp_from_sender%&            "ditto"
14329 .endtable
14330
14331
14332
14333 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14334 .table2
14335 .row &%header_maxsize%&              "total size of message header"
14336 .row &%header_line_maxsize%&         "individual header line limit"
14337 .row &%message_size_limit%&          "applies to all messages"
14338 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14339 .row &%received_header_text%&        "expanded to make &'Received:'&"
14340 .row &%received_headers_max%&        "for mail loop detection"
14341 .row &%recipients_max%&              "limit per message"
14342 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14343 .endtable
14344
14345
14346
14347
14348 .section "Non-SMTP incoming messages" "SECID111"
14349 .table2
14350 .row &%receive_timeout%&             "for non-SMTP messages"
14351 .endtable
14352
14353
14354
14355
14356
14357 .section "Incoming SMTP messages" "SECID112"
14358 See also the &'Policy controls'& section above.
14359
14360 .table2
14361 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14362 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14363 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14364 .row &%host_lookup%&                 "host name looked up for these hosts"
14365 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14366 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14367 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14368 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14369 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14370 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14371 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14372 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14373 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14374 .row &%smtp_accept_max_per_connection%& "messages per connection"
14375 .row &%smtp_accept_max_per_host%&    "connections from one host"
14376 .row &%smtp_accept_queue%&           "queue mail if more connections"
14377 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14378                                            connection"
14379 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14380 .row &%smtp_active_hostname%&        "host name to use in messages"
14381 .row &%smtp_banner%&                 "text for welcome banner"
14382 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14383 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14384 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14385 .row &%smtp_etrn_command%&           "what to run for ETRN"
14386 .row &%smtp_etrn_serialize%&         "only one at once"
14387 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14388 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14389 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14390 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14391 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14392 .row &%smtp_receive_timeout%&        "per command or data line"
14393 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14394 .row &%smtp_return_error_details%&   "give detail on rejections"
14395 .endtable
14396
14397
14398
14399 .section "SMTP extensions" "SECID113"
14400 .table2
14401 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14402 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14403 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14404 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14405 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14406 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14407 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14408 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14409 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14410 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14411 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14412 .endtable
14413
14414
14415
14416 .section "Processing messages" "SECID114"
14417 .table2
14418 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14419 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14420 .row &%allow_utf8_domains%&          "in addresses"
14421 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14422                                       words""&"
14423 .row &%delivery_date_remove%&        "from incoming messages"
14424 .row &%envelope_to_remove%&          "from incoming messages"
14425 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14426 .row &%headers_charset%&             "default for translations"
14427 .row &%qualify_domain%&              "default for senders"
14428 .row &%qualify_recipient%&           "default for recipients"
14429 .row &%return_path_remove%&          "from incoming messages"
14430 .row &%strip_excess_angle_brackets%& "in addresses"
14431 .row &%strip_trailing_dot%&          "at end of addresses"
14432 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14433 .endtable
14434
14435
14436
14437 .section "System filter" "SECID115"
14438 .table2
14439 .row &%system_filter%&               "locate system filter"
14440 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14441                                             directory"
14442 .row &%system_filter_file_transport%& "transport for delivery to a file"
14443 .row &%system_filter_group%&         "group for filter running"
14444 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14445 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14446 .row &%system_filter_user%&          "user for filter running"
14447 .endtable
14448
14449
14450
14451 .section "Routing and delivery" "SECID116"
14452 .table2
14453 .row &%disable_ipv6%&                "do no IPv6 processing"
14454 .row &%dns_again_means_nonexist%&    "for broken domains"
14455 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14456 .row &%dns_dnssec_ok%&               "parameter for resolver"
14457 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14458 .row &%dns_retrans%&                 "parameter for resolver"
14459 .row &%dns_retry%&                   "parameter for resolver"
14460 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14461 .row &%dns_use_edns0%&               "parameter for resolver"
14462 .row &%hold_domains%&                "hold delivery for these domains"
14463 .row &%local_interfaces%&            "for routing checks"
14464 .row &%queue_domains%&               "no immediate delivery for these"
14465 .row &%queue_only%&                  "no immediate delivery at all"
14466 .row &%queue_only_file%&             "no immediate delivery if file exists"
14467 .row &%queue_only_load%&             "no immediate delivery if load is high"
14468 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14469 .row &%queue_only_override%&         "allow command line to override"
14470 .row &%queue_run_in_order%&          "order of arrival"
14471 .row &%queue_run_max%&               "of simultaneous queue runners"
14472 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14473 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14474 .row &%remote_sort_domains%&         "order of remote deliveries"
14475 .row &%retry_data_expire%&           "timeout for retry data"
14476 .row &%retry_interval_max%&          "safety net for retry rules"
14477 .endtable
14478
14479
14480
14481 .section "Bounce and warning messages" "SECID117"
14482 .table2
14483 .row &%bounce_message_file%&         "content of bounce"
14484 .row &%bounce_message_text%&         "content of bounce"
14485 .row &%bounce_return_body%&          "include body if returning message"
14486 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14487 .row &%bounce_return_message%&       "include original message in bounce"
14488 .row &%bounce_return_size_limit%&    "limit on returned message"
14489 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14490 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14491 .row &%errors_copy%&                 "copy bounce messages"
14492 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14493 .row &%delay_warning%&               "time schedule"
14494 .row &%delay_warning_condition%&     "condition for warning messages"
14495 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14496 .row &%smtp_return_error_details%&   "give detail on rejections"
14497 .row &%warn_message_file%&           "content of warning message"
14498 .endtable
14499
14500
14501
14502 .section "Alphabetical list of main options" "SECTalomo"
14503 Those options that undergo string expansion before use are marked with
14504 &dagger;.
14505
14506 .option accept_8bitmime main boolean true
14507 .cindex "8BITMIME"
14508 .cindex "8-bit characters"
14509 .cindex "log" "selectors"
14510 .cindex "log" "8BITMIME"
14511 This option causes Exim to send 8BITMIME in its response to an SMTP
14512 EHLO command, and to accept the BODY= parameter on MAIL commands.
14513 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14514 takes no steps to do anything special with messages received by this route.
14515
14516 Historically Exim kept this option off by default, but the maintainers
14517 feel that in today's Internet, this causes more problems than it solves.
14518 It now defaults to true.
14519 A more detailed analysis of the issues is provided by Dan Bernstein:
14520 .display
14521 &url(https://cr.yp.to/smtp/8bitmime.html)
14522 .endd
14523
14524 To log received 8BITMIME status use
14525 .code
14526 log_selector = +8bitmime
14527 .endd
14528
14529 .option acl_not_smtp main string&!! unset
14530 .cindex "&ACL;" "for non-SMTP messages"
14531 .cindex "non-SMTP messages" "ACLs for"
14532 This option defines the ACL that is run when a non-SMTP message has been
14533 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14534 further details.
14535
14536 .option acl_not_smtp_mime main string&!! unset
14537 This option defines the ACL that is run for individual MIME parts of non-SMTP
14538 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14539 SMTP messages.
14540
14541 .option acl_not_smtp_start main string&!! unset
14542 .cindex "&ACL;" "at start of non-SMTP message"
14543 .cindex "non-SMTP messages" "ACLs for"
14544 This option defines the ACL that is run before Exim starts reading a
14545 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14546
14547 .option acl_smtp_auth main string&!! unset
14548 .cindex "&ACL;" "setting up for SMTP commands"
14549 .cindex "AUTH" "ACL for"
14550 This option defines the ACL that is run when an SMTP AUTH command is
14551 received. See chapter &<<CHAPACL>>& for further details.
14552
14553 .option acl_smtp_connect main string&!! unset
14554 .cindex "&ACL;" "on SMTP connection"
14555 This option defines the ACL that is run when an SMTP connection is received.
14556 See chapter &<<CHAPACL>>& for further details.
14557
14558 .option acl_smtp_data main string&!! unset
14559 .cindex "DATA" "ACL for"
14560 This option defines the ACL that is run after an SMTP DATA command has been
14561 processed and the message itself has been received, but before the final
14562 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14563
14564 .option acl_smtp_data_prdr main string&!! accept
14565 .cindex "PRDR" "ACL for"
14566 .cindex "DATA" "PRDR ACL for"
14567 .cindex "&ACL;" "PRDR-related"
14568 .cindex "&ACL;" "per-user data processing"
14569 This option defines the ACL that,
14570 if the PRDR feature has been negotiated,
14571 is run for each recipient after an SMTP DATA command has been
14572 processed and the message itself has been received, but before the
14573 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14574
14575 .option acl_smtp_dkim main string&!! unset
14576 .cindex DKIM "ACL for"
14577 This option defines the ACL that is run for each DKIM signature
14578 (by default, or as specified in the dkim_verify_signers option)
14579 of a received message.
14580 See section &<<SECDKIMVFY>>& for further details.
14581
14582 .option acl_smtp_etrn main string&!! unset
14583 .cindex "ETRN" "ACL for"
14584 This option defines the ACL that is run when an SMTP ETRN command is
14585 received. See chapter &<<CHAPACL>>& for further details.
14586
14587 .option acl_smtp_expn main string&!! unset
14588 .cindex "EXPN" "ACL for"
14589 This option defines the ACL that is run when an SMTP EXPN command is
14590 received. See chapter &<<CHAPACL>>& for further details.
14591
14592 .option acl_smtp_helo main string&!! unset
14593 .cindex "EHLO" "ACL for"
14594 .cindex "HELO" "ACL for"
14595 This option defines the ACL that is run when an SMTP EHLO or HELO
14596 command is received. See chapter &<<CHAPACL>>& for further details.
14597
14598
14599 .option acl_smtp_mail main string&!! unset
14600 .cindex "MAIL" "ACL for"
14601 This option defines the ACL that is run when an SMTP MAIL command is
14602 received. See chapter &<<CHAPACL>>& for further details.
14603
14604 .option acl_smtp_mailauth main string&!! unset
14605 .cindex "AUTH" "on MAIL command"
14606 This option defines the ACL that is run when there is an AUTH parameter on
14607 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14608 &<<CHAPSMTPAUTH>>& for details of authentication.
14609
14610 .option acl_smtp_mime main string&!! unset
14611 .cindex "MIME content scanning" "ACL for"
14612 This option is available when Exim is built with the content-scanning
14613 extension. It defines the ACL that is run for each MIME part in a message. See
14614 section &<<SECTscanmimepart>>& for details.
14615
14616 .option acl_smtp_notquit main string&!! unset
14617 .cindex "not-QUIT, ACL for"
14618 This option defines the ACL that is run when an SMTP session
14619 ends without a QUIT command being received.
14620 See chapter &<<CHAPACL>>& for further details.
14621
14622 .option acl_smtp_predata main string&!! unset
14623 This option defines the ACL that is run when an SMTP DATA command is
14624 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14625 further details.
14626
14627 .option acl_smtp_quit main string&!! unset
14628 .cindex "QUIT, ACL for"
14629 This option defines the ACL that is run when an SMTP QUIT command is
14630 received. See chapter &<<CHAPACL>>& for further details.
14631
14632 .option acl_smtp_rcpt main string&!! unset
14633 .cindex "RCPT" "ACL for"
14634 This option defines the ACL that is run when an SMTP RCPT command is
14635 received. See chapter &<<CHAPACL>>& for further details.
14636
14637 .option acl_smtp_starttls main string&!! unset
14638 .cindex "STARTTLS, ACL for"
14639 This option defines the ACL that is run when an SMTP STARTTLS command is
14640 received. See chapter &<<CHAPACL>>& for further details.
14641
14642 .option acl_smtp_vrfy main string&!! unset
14643 .cindex "VRFY" "ACL for"
14644 This option defines the ACL that is run when an SMTP VRFY command is
14645 received. See chapter &<<CHAPACL>>& for further details.
14646
14647 .option add_environment main "string list" empty
14648 .cindex "environment" "set values"
14649 This option allows to set individual environment variables that the
14650 currently linked libraries and programs in child processes use.
14651 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14652
14653 .option admin_groups main "string list&!!" unset
14654 .cindex "admin user"
14655 This option is expanded just once, at the start of Exim's processing. If the
14656 current group or any of the supplementary groups of an Exim caller is in this
14657 colon-separated list, the caller has admin privileges. If all your system
14658 programmers are in a specific group, for example, you can give them all Exim
14659 admin privileges by putting that group in &%admin_groups%&. However, this does
14660 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14661 To permit this, you have to add individuals to the Exim group.
14662
14663 .option allow_domain_literals main boolean false
14664 .cindex "domain literal"
14665 If this option is set, the RFC 2822 domain literal format is permitted in
14666 email addresses. The option is not set by default, because the domain literal
14667 format is not normally required these days, and few people know about it. It
14668 has, however, been exploited by mail abusers.
14669
14670 Unfortunately, it seems that some DNS black list maintainers are using this
14671 format to report black listing to postmasters. If you want to accept messages
14672 addressed to your hosts by IP address, you need to set
14673 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14674 domains (defined in the named domain list &%local_domains%& in the default
14675 configuration). This &"magic string"& matches the domain literal form of all
14676 the local host's IP addresses.
14677
14678
14679 .option allow_mx_to_ip main boolean false
14680 .cindex "MX record" "pointing to IP address"
14681 It appears that more and more DNS zone administrators are breaking the rules
14682 and putting domain names that look like IP addresses on the right hand side of
14683 MX records. Exim follows the rules and rejects this, giving an error message
14684 that explains the misconfiguration. However, some other MTAs support this
14685 practice, so to avoid &"Why can't Exim do this?"& complaints,
14686 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14687 recommended, except when you have no other choice.
14688
14689 .option allow_utf8_domains main boolean false
14690 .cindex "domain" "UTF-8 characters in"
14691 .cindex "UTF-8" "in domain name"
14692 Lots of discussion is going on about internationalized domain names. One
14693 camp is strongly in favour of just using UTF-8 characters, and it seems
14694 that at least two other MTAs permit this.
14695 This option allows Exim users to experiment if they wish.
14696
14697 If it is set true, Exim's domain parsing function allows valid
14698 UTF-8 multicharacters to appear in domain name components, in addition to
14699 letters, digits, and hyphens.
14700
14701 .new
14702 If Exim is built with internationalization support
14703 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14704 this option can be left as default.
14705 .wen
14706 Without that,
14707 if you want to look up such domain names in the DNS, you must also
14708 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14709 suitable setting is:
14710 .code
14711 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14712   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14713 .endd
14714 Alternatively, you can just disable this feature by setting
14715 .code
14716 dns_check_names_pattern =
14717 .endd
14718 That is, set the option to an empty string so that no check is done.
14719
14720
14721 .option auth_advertise_hosts main "host list&!!" *
14722 .cindex "authentication" "advertising"
14723 .cindex "AUTH" "advertising"
14724 If any server authentication mechanisms are configured, Exim advertises them in
14725 response to an EHLO command only if the calling host matches this list.
14726 Otherwise, Exim does not advertise AUTH.
14727 Exim does not accept AUTH commands from clients to which it has not
14728 advertised the availability of AUTH. The advertising of individual
14729 authentication mechanisms can be controlled by the use of the
14730 &%server_advertise_condition%& generic authenticator option on the individual
14731 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14732
14733 Certain mail clients (for example, Netscape) require the user to provide a name
14734 and password for authentication if AUTH is advertised, even though it may
14735 not be needed (the host may accept messages from hosts on its local LAN without
14736 authentication, for example). The &%auth_advertise_hosts%& option can be used
14737 to make these clients more friendly by excluding them from the set of hosts to
14738 which Exim advertises AUTH.
14739
14740 .cindex "AUTH" "advertising when encrypted"
14741 If you want to advertise the availability of AUTH only when the connection
14742 is encrypted using TLS, you can make use of the fact that the value of this
14743 option is expanded, with a setting like this:
14744 .code
14745 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14746 .endd
14747 .vindex "&$tls_in_cipher$&"
14748 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14749 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14750 expansion is *, which matches all hosts.
14751
14752
14753 .option auto_thaw main time 0s
14754 .cindex "thawing messages"
14755 .cindex "unfreezing messages"
14756 If this option is set to a time greater than zero, a queue runner will try a
14757 new delivery attempt on any frozen message, other than a bounce message, if
14758 this much time has passed since it was frozen. This may result in the message
14759 being re-frozen if nothing has changed since the last attempt. It is a way of
14760 saying &"keep on trying, even though there are big problems"&.
14761
14762 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14763 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14764 thought to be very useful any more, and its use should probably be avoided.
14765
14766
14767 .option av_scanner main string "see below"
14768 This option is available if Exim is built with the content-scanning extension.
14769 It specifies which anti-virus scanner to use. The default value is:
14770 .code
14771 sophie:/var/run/sophie
14772 .endd
14773 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14774 before use. See section &<<SECTscanvirus>>& for further details.
14775
14776
14777 .option bi_command main string unset
14778 .oindex "&%-bi%&"
14779 This option supplies the name of a command that is run when Exim is called with
14780 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14781 just the command name, it is not a complete command line. If an argument is
14782 required, it must come from the &%-oA%& command line option.
14783
14784
14785 .option bounce_message_file main string unset
14786 .cindex "bounce message" "customizing"
14787 .cindex "customizing" "bounce message"
14788 This option defines a template file containing paragraphs of text to be used
14789 for constructing bounce messages.  Details of the file's contents are given in
14790 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14791
14792
14793 .option bounce_message_text main string unset
14794 When this option is set, its contents are included in the default bounce
14795 message immediately after &"This message was created automatically by mail
14796 delivery software."& It is not used if &%bounce_message_file%& is set.
14797
14798 .option bounce_return_body main boolean true
14799 .cindex "bounce message" "including body"
14800 This option controls whether the body of an incoming message is included in a
14801 bounce message when &%bounce_return_message%& is true. The default setting
14802 causes the entire message, both header and body, to be returned (subject to the
14803 value of &%bounce_return_size_limit%&). If this option is false, only the
14804 message header is included. In the case of a non-SMTP message containing an
14805 error that is detected during reception, only those header lines preceding the
14806 point at which the error was detected are returned.
14807 .cindex "bounce message" "including original"
14808
14809 .option bounce_return_linesize_limit main integer 998
14810 .cindex "size" "of bounce lines, limit"
14811 .cindex "bounce message" "line length limit"
14812 .cindex "limit" "bounce message line length"
14813 This option sets a limit in bytes on the line length of messages
14814 that are returned to senders due to delivery problems,
14815 when &%bounce_return_message%& is true.
14816 The default value corresponds to RFC limits.
14817 If the message being returned has lines longer than this value it is
14818 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14819
14820 The option also applies to bounces returned when an error is detected
14821 during reception of a message.
14822 In this case lines from the original are truncated.
14823
14824 The option does not apply to messages generated by an &(autoreply)& transport.
14825
14826
14827 .option bounce_return_message main boolean true
14828 If this option is set false, none of the original message is included in
14829 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14830 &%bounce_return_body%&.
14831
14832
14833 .option bounce_return_size_limit main integer 100K
14834 .cindex "size" "of bounce, limit"
14835 .cindex "bounce message" "size limit"
14836 .cindex "limit" "bounce message size"
14837 This option sets a limit in bytes on the size of messages that are returned to
14838 senders as part of bounce messages when &%bounce_return_message%& is true. The
14839 limit should be less than the value of the global &%message_size_limit%& and of
14840 any &%message_size_limit%& settings on transports, to allow for the bounce text
14841 that Exim generates. If this option is set to zero there is no limit.
14842
14843 When the body of any message that is to be included in a bounce message is
14844 greater than the limit, it is truncated, and a comment pointing this out is
14845 added at the top. The actual cutoff may be greater than the value given, owing
14846 to the use of buffering for transferring the message in chunks (typically 8K in
14847 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14848 messages.
14849
14850 .option bounce_sender_authentication main string unset
14851 .cindex "bounce message" "sender authentication"
14852 .cindex "authentication" "bounce message"
14853 .cindex "AUTH" "on bounce message"
14854 This option provides an authenticated sender address that is sent with any
14855 bounce messages generated by Exim that are sent over an authenticated SMTP
14856 connection. A typical setting might be:
14857 .code
14858 bounce_sender_authentication = mailer-daemon@my.domain.example
14859 .endd
14860 which would cause bounce messages to be sent using the SMTP command:
14861 .code
14862 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14863 .endd
14864 The value of &%bounce_sender_authentication%& must always be a complete email
14865 address.
14866
14867 .option callout_domain_negative_expire main time 3h
14868 .cindex "caching" "callout timeouts"
14869 .cindex "callout" "caching timeouts"
14870 This option specifies the expiry time for negative callout cache data for a
14871 domain. See section &<<SECTcallver>>& for details of callout verification, and
14872 section &<<SECTcallvercache>>& for details of the caching.
14873
14874
14875 .option callout_domain_positive_expire main time 7d
14876 This option specifies the expiry time for positive callout cache data for a
14877 domain. See section &<<SECTcallver>>& for details of callout verification, and
14878 section &<<SECTcallvercache>>& for details of the caching.
14879
14880
14881 .option callout_negative_expire main time 2h
14882 This option specifies the expiry time for negative callout cache data for an
14883 address. See section &<<SECTcallver>>& for details of callout verification, and
14884 section &<<SECTcallvercache>>& for details of the caching.
14885
14886
14887 .option callout_positive_expire main time 24h
14888 This option specifies the expiry time for positive callout cache data for an
14889 address. See section &<<SECTcallver>>& for details of callout verification, and
14890 section &<<SECTcallvercache>>& for details of the caching.
14891
14892
14893 .option callout_random_local_part main string&!! "see below"
14894 This option defines the &"random"& local part that can be used as part of
14895 callout verification. The default value is
14896 .code
14897 $primary_hostname-$tod_epoch-testing
14898 .endd
14899 See section &<<CALLaddparcall>>& for details of how this value is used.
14900
14901
14902 .option check_log_inodes main integer 100
14903 See &%check_spool_space%& below.
14904
14905
14906 .option check_log_space main integer 10M
14907 See &%check_spool_space%& below.
14908
14909 .oindex "&%check_rfc2047_length%&"
14910 .cindex "RFC 2047" "disabling length check"
14911 .option check_rfc2047_length main boolean true
14912 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14913 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14914 word; strings to be encoded that exceed this length are supposed to use
14915 multiple encoded words. By default, Exim does not recognize encoded words that
14916 exceed the maximum length. However, it seems that some software, in violation
14917 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14918 set false, Exim recognizes encoded words of any length.
14919
14920
14921 .option check_spool_inodes main integer 100
14922 See &%check_spool_space%& below.
14923
14924
14925 .option check_spool_space main integer 10M
14926 .cindex "checking disk space"
14927 .cindex "disk space, checking"
14928 .cindex "spool directory" "checking space"
14929 The four &%check_...%& options allow for checking of disk resources before a
14930 message is accepted.
14931
14932 .vindex "&$log_inodes$&"
14933 .vindex "&$log_space$&"
14934 .vindex "&$spool_inodes$&"
14935 .vindex "&$spool_space$&"
14936 When any of these options are nonzero, they apply to all incoming messages. If you
14937 want to apply different checks to different kinds of message, you can do so by
14938 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14939 &$spool_space$& in an ACL with appropriate additional conditions.
14940
14941
14942 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14943 either value is greater than zero, for example:
14944 .code
14945 check_spool_space = 100M
14946 check_spool_inodes = 100
14947 .endd
14948 The spool partition is the one that contains the directory defined by
14949 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14950 transit.
14951
14952 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14953 files are written if either is greater than zero. These should be set only if
14954 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14955
14956 If there is less space or fewer inodes than requested, Exim refuses to accept
14957 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14958 error response to the MAIL command. If ESMTP is in use and there was a
14959 SIZE parameter on the MAIL command, its value is added to the
14960 &%check_spool_space%& value, and the check is performed even if
14961 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14962
14963 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14964 number of kilobytes (though specified in bytes).
14965 If a non-multiple of 1024 is specified, it is rounded up.
14966
14967 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14968 failure a message is written to stderr and Exim exits with a non-zero code, as
14969 it obviously cannot send an error message of any kind.
14970
14971 There is a slight performance penalty for these checks.
14972 Versions of Exim preceding 4.88 had these disabled by default;
14973 high-rate installations confident they will never run out of resources
14974 may wish to deliberately disable them.
14975
14976 .option chunking_advertise_hosts main "host list&!!" *
14977 .cindex CHUNKING advertisement
14978 .cindex "RFC 3030" "CHUNKING"
14979 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14980 these hosts.
14981 Hosts may use the BDAT command as an alternate to DATA.
14982
14983 .option commandline_checks_require_admin main boolean &`false`&
14984 .cindex "restricting access to features"
14985 This option restricts various basic checking features to require an
14986 administrative user.
14987 This affects most of the &%-b*%& options, such as &%-be%&.
14988
14989 .option debug_store main boolean &`false`&
14990 .cindex debugging "memory corruption"
14991 .cindex memory debugging
14992 This option, when true, enables extra checking in Exim's internal memory
14993 management.  For use when a memory corruption issue is being investigated,
14994 it should normally be left as default.
14995
14996 .option daemon_smtp_ports main string &`smtp`&
14997 .cindex "port" "for daemon"
14998 .cindex "TCP/IP" "setting listening ports"
14999 This option specifies one or more default SMTP ports on which the Exim daemon
15000 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15001 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15002
15003 .option daemon_startup_retries main integer 9
15004 .cindex "daemon startup, retrying"
15005 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15006 the daemon at startup when it cannot immediately bind a listening socket
15007 (typically because the socket is already in use): &%daemon_startup_retries%&
15008 defines the number of retries after the first failure, and
15009 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15010
15011 .option daemon_startup_sleep main time 30s
15012 See &%daemon_startup_retries%&.
15013
15014 .option delay_warning main "time list" 24h
15015 .cindex "warning of delay"
15016 .cindex "delay warning, specifying"
15017 .cindex "queue" "delay warning"
15018 When a message is delayed, Exim sends a warning message to the sender at
15019 intervals specified by this option. The data is a colon-separated list of times
15020 after which to send warning messages. If the value of the option is an empty
15021 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15022 message has been in the queue for longer than the last time, the last interval
15023 between the times is used to compute subsequent warning times. For example,
15024 with
15025 .code
15026 delay_warning = 4h:8h:24h
15027 .endd
15028 the first message is sent after 4 hours, the second after 8 hours, and
15029 the third one after 24 hours. After that, messages are sent every 16 hours,
15030 because that is the interval between the last two times on the list. If you set
15031 just one time, it specifies the repeat interval. For example, with:
15032 .code
15033 delay_warning = 6h
15034 .endd
15035 messages are repeated every six hours. To stop warnings after a given time, set
15036 a very large time at the end of the list. For example:
15037 .code
15038 delay_warning = 2h:12h:99d
15039 .endd
15040 Note that the option is only evaluated at the time a delivery attempt fails,
15041 which depends on retry and queue-runner configuration.
15042 Typically retries will be configured more frequently than warning messages.
15043
15044 .option delay_warning_condition main string&!! "see below"
15045 .vindex "&$domain$&"
15046 The string is expanded at the time a warning message might be sent. If all the
15047 deferred addresses have the same domain, it is set in &$domain$& during the
15048 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15049 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15050 &"false"& (the comparison being done caselessly) then the warning message is
15051 not sent. The default is:
15052 .code
15053 delay_warning_condition = ${if or {\
15054   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15055   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15056   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15057   } {no}{yes}}
15058 .endd
15059 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15060 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15061 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15062 &"auto-replied"& in an &'Auto-Submitted:'& header.
15063
15064 .option deliver_drop_privilege main boolean false
15065 .cindex "unprivileged delivery"
15066 .cindex "delivery" "unprivileged"
15067 If this option is set true, Exim drops its root privilege at the start of a
15068 delivery process, and runs as the Exim user throughout. This severely restricts
15069 the kinds of local delivery that are possible, but is viable in certain types
15070 of configuration. There is a discussion about the use of root privilege in
15071 chapter &<<CHAPsecurity>>&.
15072
15073 .option deliver_queue_load_max main fixed-point unset
15074 .cindex "load average"
15075 .cindex "queue runner" "abandoning"
15076 When this option is set, a queue run is abandoned if the system load average
15077 becomes greater than the value of the option. The option has no effect on
15078 ancient operating systems on which Exim cannot determine the load average.
15079 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15080
15081
15082 .option delivery_date_remove main boolean true
15083 .cindex "&'Delivery-date:'& header line"
15084 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15085 message when it is delivered, in exactly the same way as &'Return-path:'& is
15086 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15087 should not be present in incoming messages, and this option causes them to be
15088 removed at the time the message is received, to avoid any problems that might
15089 occur when a delivered message is subsequently sent on to some other recipient.
15090
15091 .option disable_fsync main boolean false
15092 .cindex "&[fsync()]&, disabling"
15093 This option is available only if Exim was built with the compile-time option
15094 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15095 a runtime configuration generates an &"unknown option"& error. You should not
15096 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15097 really, really, really understand what you are doing. &'No pre-compiled
15098 distributions of Exim should ever make this option available.'&
15099
15100 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15101 updated files' data to be written to disc before continuing. Unexpected events
15102 such as crashes and power outages may cause data to be lost or scrambled.
15103 Here be Dragons. &*Beware.*&
15104
15105
15106 .option disable_ipv6 main boolean false
15107 .cindex "IPv6" "disabling"
15108 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15109 activities take place. AAAA records are never looked up, and any IPv6 addresses
15110 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15111 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15112 to handle IPv6 literal addresses.
15113
15114
15115 .new
15116 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15117 .cindex DKIM "selecting signature algorithms"
15118 This option gives a list of hash types which are acceptable in signatures,
15119 and an order of processing.
15120 Signatures with algorithms not in the list will be ignored.
15121
15122 Acceptable values include:
15123 .code
15124 sha1
15125 sha256
15126 sha512
15127 .endd
15128
15129 Note that the acceptance of sha1 violates RFC 8301.
15130
15131 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15132 This option gives a list of key types which are acceptable in signatures,
15133 and an order of processing.
15134 Signatures with algorithms not in the list will be ignored.
15135
15136 .option dkim_verify_minimal main boolean false
15137 If set to true, verification of signatures will terminate after the
15138 first success.
15139 .wen
15140
15141 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15142 .cindex DKIM "controlling calls to the ACL"
15143 This option gives a list of DKIM domains for which the DKIM ACL is run.
15144 It is expanded after the message is received; by default it runs
15145 the ACL once for each signature in the message.
15146 See section &<<SECDKIMVFY>>&.
15147
15148
15149 .option dns_again_means_nonexist main "domain list&!!" unset
15150 .cindex "DNS" "&""try again""& response; overriding"
15151 DNS lookups give a &"try again"& response for the DNS errors
15152 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15153 keep trying to deliver a message, or to give repeated temporary errors to
15154 incoming mail. Sometimes the effect is caused by a badly set up name server and
15155 may persist for a long time. If a domain which exhibits this problem matches
15156 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15157 This option should be used with care. You can make it apply to reverse lookups
15158 by a setting such as this:
15159 .code
15160 dns_again_means_nonexist = *.in-addr.arpa
15161 .endd
15162 This option applies to all DNS lookups that Exim does. It also applies when the
15163 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15164 since these are most likely to be caused by DNS lookup problems. The
15165 &(dnslookup)& router has some options of its own for controlling what happens
15166 when lookups for MX or SRV records give temporary errors. These more specific
15167 options are applied after this global option.
15168
15169 .option dns_check_names_pattern main string "see below"
15170 .cindex "DNS" "pre-check of name syntax"
15171 When this option is set to a non-empty string, it causes Exim to check domain
15172 names for characters that are not allowed in host names before handing them to
15173 the DNS resolver, because some resolvers give temporary errors for names that
15174 contain unusual characters. If a domain name contains any unwanted characters,
15175 a &"not found"& result is forced, and the resolver is not called. The check is
15176 done by matching the domain name against a regular expression, which is the
15177 value of this option. The default pattern is
15178 .code
15179 dns_check_names_pattern = \
15180   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15181 .endd
15182 which permits only letters, digits, slashes, and hyphens in components, but
15183 they must start and end with a letter or digit. Slashes are not, in fact,
15184 permitted in host names, but they are found in certain NS records (which can be
15185 accessed in Exim by using a &%dnsdb%& lookup). If you set
15186 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15187 empty string.
15188
15189 .option dns_csa_search_limit main integer 5
15190 This option controls the depth of parental searching for CSA SRV records in the
15191 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15192
15193 .option dns_csa_use_reverse main boolean true
15194 This option controls whether or not an IP address, given as a CSA domain, is
15195 reversed and looked up in the reverse DNS, as described in more detail in
15196 section &<<SECTverifyCSA>>&.
15197
15198 .option dns_cname_loops main integer 1
15199 .cindex DNS "CNAME following"
15200 This option controls the following of CNAME chains, needed if the resolver does
15201 not do it internally.
15202 As of 2018 most should, and the default can be left.
15203 If you have an ancient one, a value of 10 is likely needed.
15204
15205 The default value of one CNAME-follow is needed
15206 thanks to the observed return for an MX request,
15207 given no MX presence but a CNAME to an A, of the CNAME.
15208
15209
15210 .option dns_dnssec_ok main integer -1
15211 .cindex "DNS" "resolver options"
15212 .cindex "DNS" "DNSSEC"
15213 If this option is set to a non-negative number then Exim will initialise the
15214 DNS resolver library to either use or not use DNSSEC, overriding the system
15215 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15216
15217 If the resolver library does not support DNSSEC then this option has no effect.
15218
15219
15220 .option dns_ipv4_lookup main "domain list&!!" unset
15221 .cindex "IPv6" "DNS lookup for AAAA records"
15222 .cindex "DNS" "IPv6 lookup for AAAA records"
15223 .cindex DNS "IPv6 disabling"
15224 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15225 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15226 (A records) when trying to find IP addresses for hosts, unless the host's
15227 domain matches this list.
15228
15229 This is a fudge to help with name servers that give big delays or otherwise do
15230 not work for the AAAA record type. In due course, when the world's name
15231 servers have all been upgraded, there should be no need for this option.
15232 .new
15233 Note that all lookups, including those done for verification, are affected;
15234 this will result in verify failure for IPv6 connections or ones using names
15235 only valid for IPv6 addresses.
15236 .wen
15237
15238
15239 .option dns_retrans main time 0s
15240 .cindex "DNS" "resolver options"
15241 .cindex timeout "dns lookup"
15242 .cindex "DNS" timeout
15243 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15244 retransmission and retry parameters for DNS lookups. Values of zero (the
15245 defaults) leave the system default settings unchanged. The first value is the
15246 time between retries, and the second is the number of retries. It isn't
15247 totally clear exactly how these settings affect the total time a DNS lookup may
15248 take. I haven't found any documentation about timeouts on DNS lookups; these
15249 parameter values are available in the external resolver interface structure,
15250 but nowhere does it seem to describe how they are used or what you might want
15251 to set in them.
15252 See also the &%slow_lookup_log%& option.
15253
15254
15255 .option dns_retry main integer 0
15256 See &%dns_retrans%& above.
15257
15258
15259 .option dns_trust_aa main "domain list&!!" unset
15260 .cindex "DNS" "resolver options"
15261 .cindex "DNS" "DNSSEC"
15262 If this option is set then lookup results marked with the AA bit
15263 (Authoritative Answer) are trusted the same way as if they were
15264 DNSSEC-verified. The authority section's name of the answer must
15265 match with this expanded domain list.
15266
15267 Use this option only if you talk directly to a resolver that is
15268 authoritative for some zones and does not set the AD (Authentic Data)
15269 bit in the answer. Some DNS servers may have an configuration option to
15270 mark the answers from their own zones as verified (they set the AD bit).
15271 Others do not have this option. It is considered as poor practice using
15272 a resolver that is an authoritative server for some zones.
15273
15274 Use this option only if you really have to (e.g. if you want
15275 to use DANE for remote delivery to a server that is listed in the DNS
15276 zones that your resolver is authoritative for).
15277
15278 If the DNS answer packet has the AA bit set and contains resource record
15279 in the answer section, the name of the first NS record appearing in the
15280 authority section is compared against the list. If the answer packet is
15281 authoritative but the answer section is empty, the name of the first SOA
15282 record in the authoritative section is used instead.
15283
15284 .cindex "DNS" "resolver options"
15285 .option dns_use_edns0 main integer -1
15286 .cindex "DNS" "resolver options"
15287 .cindex "DNS" "EDNS0"
15288 .cindex "DNS" "OpenBSD
15289 If this option is set to a non-negative number then Exim will initialise the
15290 DNS resolver library to either use or not use EDNS0 extensions, overriding
15291 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15292 on.
15293
15294 If the resolver library does not support EDNS0 then this option has no effect.
15295
15296 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15297 means that DNSSEC will not work with Exim on that platform either, unless Exim
15298 is linked against an alternative DNS client library.
15299
15300
15301 .option drop_cr main boolean false
15302 This is an obsolete option that is now a no-op. It used to affect the way Exim
15303 handled CR and LF characters in incoming messages. What happens now is
15304 described in section &<<SECTlineendings>>&.
15305
15306 .option dsn_advertise_hosts main "host list&!!" unset
15307 .cindex "bounce messages" "success"
15308 .cindex "DSN" "success"
15309 .cindex "Delivery Status Notification" "success"
15310 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15311 and accepted from, these hosts.
15312 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15313 and RET and ORCPT options on MAIL FROM commands.
15314 A NOTIFY=SUCCESS option requests success-DSN messages.
15315 A NOTIFY= option with no argument requests that no delay or failure DSNs
15316 are sent.
15317
15318 .option dsn_from main "string&!!" "see below"
15319 .cindex "&'From:'& header line" "in bounces"
15320 .cindex "bounce messages" "&'From:'& line, specifying"
15321 This option can be used to vary the contents of &'From:'& header lines in
15322 bounces and other automatically generated messages (&"Delivery Status
15323 Notifications"& &-- hence the name of the option). The default setting is:
15324 .code
15325 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15326 .endd
15327 The value is expanded every time it is needed. If the expansion fails, a
15328 panic is logged, and the default value is used.
15329
15330 .option envelope_to_remove main boolean true
15331 .cindex "&'Envelope-to:'& header line"
15332 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15333 message when it is delivered, in exactly the same way as &'Return-path:'& is
15334 handled. &'Envelope-to:'& records the original recipient address from the
15335 message's envelope that caused the delivery to happen. Such headers should not
15336 be present in incoming messages, and this option causes them to be removed at
15337 the time the message is received, to avoid any problems that might occur when a
15338 delivered message is subsequently sent on to some other recipient.
15339
15340
15341 .option errors_copy main "string list&!!" unset
15342 .cindex "bounce message" "copy to other address"
15343 .cindex "copy of bounce message"
15344 Setting this option causes Exim to send bcc copies of bounce messages that it
15345 generates to other addresses. &*Note*&: This does not apply to bounce messages
15346 coming from elsewhere. The value of the option is a colon-separated list of
15347 items. Each item consists of a pattern, terminated by white space, followed by
15348 a comma-separated list of email addresses. If a pattern contains spaces, it
15349 must be enclosed in double quotes.
15350
15351 Each pattern is processed in the same way as a single item in an address list
15352 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15353 the bounce message, the message is copied to the addresses on the list. The
15354 items are scanned in order, and once a matching one is found, no further items
15355 are examined. For example:
15356 .code
15357 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15358               rqps@mydomain   hostmaster@mydomain.example,\
15359                               postmaster@mydomain.example
15360 .endd
15361 .vindex "&$domain$&"
15362 .vindex "&$local_part$&"
15363 The address list is expanded before use. The expansion variables &$local_part$&
15364 and &$domain$& are set from the original recipient of the error message, and if
15365 there was any wildcard matching in the pattern, the expansion
15366 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15367 variables &$0$&, &$1$&, etc. are set in the normal way.
15368
15369
15370 .option errors_reply_to main string unset
15371 .cindex "bounce message" "&'Reply-to:'& in"
15372 By default, Exim's bounce and delivery warning messages contain the header line
15373 .display
15374 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15375 .endd
15376 .oindex &%quota_warn_message%&
15377 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15378 A warning message that is generated by the &%quota_warn_message%& option in an
15379 &(appendfile)& transport may contain its own &'From:'& header line that
15380 overrides the default.
15381
15382 Experience shows that people reply to bounce messages. If the
15383 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15384 and warning messages. For example:
15385 .code
15386 errors_reply_to = postmaster@my.domain.example
15387 .endd
15388 The value of the option is not expanded. It must specify a valid RFC 2822
15389 address. However, if a warning message that is generated by the
15390 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15391 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15392 not used.
15393
15394
15395 .option event_action main string&!! unset
15396 .cindex events
15397 This option declares a string to be expanded for Exim's events mechanism.
15398 For details see chapter &<<CHAPevents>>&.
15399
15400
15401 .option exim_group main string "compile-time configured"
15402 .cindex "gid (group id)" "Exim's own"
15403 .cindex "Exim group"
15404 This option changes the gid under which Exim runs when it gives up root
15405 privilege. The default value is compiled into the binary. The value of this
15406 option is used only when &%exim_user%& is also set. Unless it consists entirely
15407 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15408 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15409 security issues.
15410
15411
15412 .option exim_path main string "see below"
15413 .cindex "Exim binary, path name"
15414 This option specifies the path name of the Exim binary, which is used when Exim
15415 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15416 the directory configured at compile time by the BIN_DIRECTORY setting. It
15417 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15418 other place.
15419 &*Warning*&: Do not use a macro to define the value of this option, because
15420 you will break those Exim utilities that scan the configuration file to find
15421 where the binary is. (They then use the &%-bP%& option to extract option
15422 settings such as the value of &%spool_directory%&.)
15423
15424
15425 .option exim_user main string "compile-time configured"
15426 .cindex "uid (user id)" "Exim's own"
15427 .cindex "Exim user"
15428 This option changes the uid under which Exim runs when it gives up root
15429 privilege. The default value is compiled into the binary. Ownership of the run
15430 time configuration file and the use of the &%-C%& and &%-D%& command line
15431 options is checked against the values in the binary, not what is set here.
15432
15433 Unless it consists entirely of digits, the string is looked up using
15434 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15435 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15436 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15437
15438
15439 .option exim_version main string "current version"
15440 .cindex "Exim version"
15441 .cindex customizing "version number"
15442 .cindex "version number of Exim" override
15443 This option allows to override the &$version_number$&/&$exim_version$& Exim reports in
15444 various places.  Use with care, this may fool stupid security scanners.
15445
15446
15447 .option extra_local_interfaces main "string list" unset
15448 This option defines network interfaces that are to be considered local when
15449 routing, but which are not used for listening by the daemon. See section
15450 &<<SECTreclocipadd>>& for details.
15451
15452
15453 . Allow this long option name to split; give it unsplit as a fifth argument
15454 . for the automatic .oindex that is generated by .option.
15455
15456 .option "extract_addresses_remove_arguments" main boolean true &&&
15457          extract_addresses_remove_arguments
15458 .oindex "&%-t%&"
15459 .cindex "command line" "addresses with &%-t%&"
15460 .cindex "Sendmail compatibility" "&%-t%& option"
15461 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15462 are present on the command line when the &%-t%& option is used to build an
15463 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15464 line addresses are removed from the recipients list. This is also how Smail
15465 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15466 command line addresses are added to those obtained from the header lines. When
15467 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15468 argument headers. If it is set false, Exim adds rather than removes argument
15469 addresses.
15470
15471
15472 .option finduser_retries main integer 0
15473 .cindex "NIS, retrying user lookups"
15474 On systems running NIS or other schemes in which user and group information is
15475 distributed from a remote system, there can be times when &[getpwnam()]& and
15476 related functions fail, even when given valid data, because things time out.
15477 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15478 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15479 many extra times to find a user or a group, waiting for one second between
15480 retries.
15481
15482 .cindex "&_/etc/passwd_&" "multiple reading of"
15483 You should not set this option greater than zero if your user information is in
15484 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15485 search the file multiple times for non-existent users, and also cause delay.
15486
15487
15488
15489 .option freeze_tell main "string list, comma separated" unset
15490 .cindex "freezing messages" "sending a message when freezing"
15491 On encountering certain errors, or when configured to do so in a system filter,
15492 ACL, or special router, Exim freezes a message. This means that no further
15493 delivery attempts take place until an administrator thaws the message, or the
15494 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15495 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15496 warning message whenever it freezes something, unless the message it is
15497 freezing is a locally-generated bounce message. (Without this exception there
15498 is the possibility of looping.) The warning message is sent to the addresses
15499 supplied as the comma-separated value of this option. If several of the
15500 message's addresses cause freezing, only a single message is sent. If the
15501 freezing was automatic, the reason(s) for freezing can be found in the message
15502 log. If you configure freezing in a filter or ACL, you must arrange for any
15503 logging that you require.
15504
15505
15506 .option gecos_name main string&!! unset
15507 .cindex "HP-UX"
15508 .cindex "&""gecos""& field, parsing"
15509 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15510 password file to hold other information in addition to users' real names. Exim
15511 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15512 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15513 of the field are used unchanged, except that, if an ampersand is encountered,
15514 it is replaced by the user's login name with the first character forced to
15515 upper case, since this is a convention that is observed on many systems.
15516
15517 When these options are set, &%gecos_pattern%& is treated as a regular
15518 expression that is to be applied to the field (again with && replaced by the
15519 login name), and if it matches, &%gecos_name%& is expanded and used as the
15520 user's name.
15521
15522 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15523 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15524 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15525 name terminates at the first comma, the following can be used:
15526 .code
15527 gecos_pattern = ([^,]*)
15528 gecos_name = $1
15529 .endd
15530
15531 .option gecos_pattern main string unset
15532 See &%gecos_name%& above.
15533
15534
15535 .option gnutls_compat_mode main boolean unset
15536 This option controls whether GnuTLS is used in compatibility mode in an Exim
15537 server. This reduces security slightly, but improves interworking with older
15538 implementations of TLS.
15539
15540
15541 .option gnutls_allow_auto_pkcs11 main boolean unset
15542 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15543 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15544
15545 See
15546 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15547 for documentation.
15548
15549
15550
15551 .option headers_charset main string "see below"
15552 This option sets a default character set for translating from encoded MIME
15553 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15554 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15555 ultimate default is ISO-8859-1. For more details see the description of header
15556 insertions in section &<<SECTexpansionitems>>&.
15557
15558
15559
15560 .option header_maxsize main integer "see below"
15561 .cindex "header section" "maximum size of"
15562 .cindex "limit" "size of message header section"
15563 This option controls the overall maximum size of a message's header
15564 section. The default is the value of HEADER_MAXSIZE in
15565 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15566 sections are rejected.
15567
15568
15569 .option header_line_maxsize main integer 0
15570 .cindex "header lines" "maximum size of"
15571 .cindex "limit" "size of one header line"
15572 This option limits the length of any individual header line in a message, after
15573 all the continuations have been joined together. Messages with individual
15574 header lines that are longer than the limit are rejected. The default value of
15575 zero means &"no limit"&.
15576
15577
15578
15579
15580 .option helo_accept_junk_hosts main "host list&!!" unset
15581 .cindex "HELO" "accepting junk data"
15582 .cindex "EHLO" "accepting junk data"
15583 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15584 mail, and gives an error response for invalid data. Unfortunately, there are
15585 some SMTP clients that send syntactic junk. They can be accommodated by setting
15586 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15587 if you want to do semantic checking.
15588 See also &%helo_allow_chars%& for a way of extending the permitted character
15589 set.
15590
15591
15592 .option helo_allow_chars main string unset
15593 .cindex "HELO" "underscores in"
15594 .cindex "EHLO" "underscores in"
15595 .cindex "underscore in EHLO/HELO"
15596 This option can be set to a string of rogue characters that are permitted in
15597 all EHLO and HELO names in addition to the standard letters, digits,
15598 hyphens, and dots. If you really must allow underscores, you can set
15599 .code
15600 helo_allow_chars = _
15601 .endd
15602 Note that the value is one string, not a list.
15603
15604
15605 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15606 .cindex "HELO" "forcing reverse lookup"
15607 .cindex "EHLO" "forcing reverse lookup"
15608 If the domain given by a client in a HELO or EHLO command matches this
15609 list, a reverse lookup is done in order to establish the host's true name. The
15610 default forces a lookup if the client host gives the server's name or any of
15611 its IP addresses (in brackets), something that broken clients have been seen to
15612 do.
15613
15614
15615 .option helo_try_verify_hosts main "host list&!!" unset
15616 .cindex "HELO verifying" "optional"
15617 .cindex "EHLO" "verifying, optional"
15618 By default, Exim just checks the syntax of HELO and EHLO commands (see
15619 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15620 to do more extensive checking of the data supplied by these commands. The ACL
15621 condition &`verify = helo`& is provided to make this possible.
15622 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15623 to force the check to occur. From release 4.53 onwards, this is no longer
15624 necessary. If the check has not been done before &`verify = helo`& is
15625 encountered, it is done at that time. Consequently, this option is obsolete.
15626 Its specification is retained here for backwards compatibility.
15627
15628 When an EHLO or HELO command is received, if the calling host matches
15629 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15630 EHLO command either:
15631
15632 .ilist
15633 is an IP literal matching the calling address of the host, or
15634 .next
15635 .cindex "DNS" "reverse lookup"
15636 .cindex "reverse DNS lookup"
15637 matches the host name that Exim obtains by doing a reverse lookup of the
15638 calling host address, or
15639 .next
15640 when looked up in DNS yields the calling host address.
15641 .endlist
15642
15643 However, the EHLO or HELO command is not rejected if any of the checks
15644 fail. Processing continues, but the result of the check is remembered, and can
15645 be detected later in an ACL by the &`verify = helo`& condition.
15646
15647 If DNS was used for successful verification, the variable
15648 .cindex "DNS" "DNSSEC"
15649 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15650
15651 .option helo_verify_hosts main "host list&!!" unset
15652 .cindex "HELO verifying" "mandatory"
15653 .cindex "EHLO" "verifying, mandatory"
15654 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15655 backwards compatibility. For hosts that match this option, Exim checks the host
15656 name given in the HELO or EHLO in the same way as for
15657 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15658 rejected with a 550 error, and entries are written to the main and reject logs.
15659 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15660 error.
15661
15662 .option hold_domains main "domain list&!!" unset
15663 .cindex "domain" "delaying delivery"
15664 .cindex "delivery" "delaying certain domains"
15665 This option allows mail for particular domains to be held in the queue
15666 manually. The option is overridden if a message delivery is forced with the
15667 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15668 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15669 item in &%hold_domains%&, no routing or delivery for that address is done, and
15670 it is deferred every time the message is looked at.
15671
15672 This option is intended as a temporary operational measure for delaying the
15673 delivery of mail while some problem is being sorted out, or some new
15674 configuration tested. If you just want to delay the processing of some
15675 domains until a queue run occurs, you should use &%queue_domains%& or
15676 &%queue_smtp_domains%&, not &%hold_domains%&.
15677
15678 A setting of &%hold_domains%& does not override Exim's code for removing
15679 messages from the queue if they have been there longer than the longest retry
15680 time in any retry rule. If you want to hold messages for longer than the normal
15681 retry times, insert a dummy retry rule with a long retry time.
15682
15683
15684 .option host_lookup main "host list&!!" unset
15685 .cindex "host name" "lookup, forcing"
15686 Exim does not look up the name of a calling host from its IP address unless it
15687 is required to compare against some host list, or the host matches
15688 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15689 option (which normally contains IP addresses rather than host names). The
15690 default configuration file contains
15691 .code
15692 host_lookup = *
15693 .endd
15694 which causes a lookup to happen for all hosts. If the expense of these lookups
15695 is felt to be too great, the setting can be changed or removed.
15696
15697 After a successful reverse lookup, Exim does a forward lookup on the name it
15698 has obtained, to verify that it yields the IP address that it started with. If
15699 this check fails, Exim behaves as if the name lookup failed.
15700
15701 .vindex "&$host_lookup_failed$&"
15702 .vindex "&$sender_host_name$&"
15703 After any kind of failure, the host name (in &$sender_host_name$&) remains
15704 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15705 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15706 &`verify = reverse_host_lookup`& in ACLs.
15707
15708
15709 .option host_lookup_order main "string list" &`bydns:byaddr`&
15710 This option specifies the order of different lookup methods when Exim is trying
15711 to find a host name from an IP address. The default is to do a DNS lookup
15712 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15713 if that fails. You can change the order of these lookups, or omit one entirely,
15714 if you want.
15715
15716 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15717 multiple PTR records in the DNS and the IP address is not listed in
15718 &_/etc/hosts_&. Different operating systems give different results in this
15719 case. That is why the default tries a DNS lookup first.
15720
15721
15722
15723 .option host_reject_connection main "host list&!!" unset
15724 .cindex "host" "rejecting connections from"
15725 If this option is set, incoming SMTP calls from the hosts listed are rejected
15726 as soon as the connection is made.
15727 This option is obsolete, and retained only for backward compatibility, because
15728 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15729 connections immediately.
15730
15731 The ability to give an immediate rejection (either by this option or using an
15732 ACL) is provided for use in unusual cases. Many hosts will just try again,
15733 sometimes without much delay. Normally, it is better to use an ACL to reject
15734 incoming messages at a later stage, such as after RCPT commands. See
15735 chapter &<<CHAPACL>>&.
15736
15737
15738 .option hosts_connection_nolog main "host list&!!" unset
15739 .cindex "host" "not logging connections from"
15740 This option defines a list of hosts for which connection logging does not
15741 happen, even though the &%smtp_connection%& log selector is set. For example,
15742 you might want not to log SMTP connections from local processes, or from
15743 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15744 the daemon; you should therefore strive to restrict its value to a short inline
15745 list of IP addresses and networks. To disable logging SMTP connections from
15746 local processes, you must create a host list with an empty item. For example:
15747 .code
15748 hosts_connection_nolog = :
15749 .endd
15750 If the &%smtp_connection%& log selector is not set, this option has no effect.
15751
15752
15753
15754 .option hosts_proxy main "host list&!!" unset
15755 .cindex proxy "proxy protocol"
15756 This option enables use of Proxy Protocol proxies for incoming
15757 connections.  For details see section &<<SECTproxyInbound>>&.
15758
15759
15760 .option hosts_treat_as_local main "domain list&!!" unset
15761 .cindex "local host" "domains treated as"
15762 .cindex "host" "treated as local"
15763 If this option is set, any host names that match the domain list are treated as
15764 if they were the local host when Exim is scanning host lists obtained from MX
15765 records
15766 or other sources. Note that the value of this option is a domain list, not a
15767 host list, because it is always used to check host names, not IP addresses.
15768
15769 This option also applies when Exim is matching the special items
15770 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15771 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15772 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15773 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15774 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15775 interfaces and recognizing the local host.
15776
15777
15778 .option ibase_servers main "string list" unset
15779 .cindex "InterBase" "server list"
15780 This option provides a list of InterBase servers and associated connection data,
15781 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15782 The option is available only if Exim has been built with InterBase support.
15783
15784
15785
15786 .option ignore_bounce_errors_after main time 10w
15787 .cindex "bounce message" "discarding"
15788 .cindex "discarding bounce message"
15789 This option affects the processing of bounce messages that cannot be delivered,
15790 that is, those that suffer a permanent delivery failure. (Bounce messages that
15791 suffer temporary delivery failures are of course retried in the usual way.)
15792
15793 After a permanent delivery failure, bounce messages are frozen,
15794 because there is no sender to whom they can be returned. When a frozen bounce
15795 message has been in the queue for more than the given time, it is unfrozen at
15796 the next queue run, and a further delivery is attempted. If delivery fails
15797 again, the bounce message is discarded. This makes it possible to keep failed
15798 bounce messages around for a shorter time than the normal maximum retry time
15799 for frozen messages. For example,
15800 .code
15801 ignore_bounce_errors_after = 12h
15802 .endd
15803 retries failed bounce message deliveries after 12 hours, discarding any further
15804 failures. If the value of this option is set to a zero time period, bounce
15805 failures are discarded immediately. Setting a very long time (as in the default
15806 value) has the effect of disabling this option. For ways of automatically
15807 dealing with other kinds of frozen message, see &%auto_thaw%& and
15808 &%timeout_frozen_after%&.
15809
15810
15811 .option ignore_fromline_hosts main "host list&!!" unset
15812 .cindex "&""From""& line"
15813 .cindex "UUCP" "&""From""& line"
15814 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15815 the headers of a message. By default this is treated as the start of the
15816 message's body, which means that any following headers are not recognized as
15817 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15818 match those hosts that insist on sending it. If the sender is actually a local
15819 process rather than a remote host, and is using &%-bs%& to inject the messages,
15820 &%ignore_fromline_local%& must be set to achieve this effect.
15821
15822
15823 .option ignore_fromline_local main boolean false
15824 See &%ignore_fromline_hosts%& above.
15825
15826 .option keep_environment main "string list" unset
15827 .cindex "environment" "values from"
15828 This option contains a string list of environment variables to keep.
15829 You have to trust these variables or you have to be sure that
15830 these variables do not impose any security risk. Keep in mind that
15831 during the startup phase Exim is running with an effective UID 0 in most
15832 installations. As the default value is an empty list, the default
15833 environment for using libraries, running embedded Perl code, or running
15834 external binaries is empty, and does not not even contain PATH or HOME.
15835
15836 Actually the list is interpreted as a list of patterns
15837 (&<<SECTlistexpand>>&), except that it is not expanded first.
15838
15839 WARNING: Macro substitution is still done first, so having a macro
15840 FOO and having FOO_HOME in your &%keep_environment%& option may have
15841 unexpected results. You may work around this using a regular expression
15842 that does not match the macro name: ^[F]OO_HOME$.
15843
15844 Current versions of Exim issue a warning during startup if you do not mention
15845 &%keep_environment%& in your runtime configuration file and if your
15846 current environment is not empty. Future versions may not issue that warning
15847 anymore.
15848
15849 See the &%add_environment%& main config option for a way to set
15850 environment variables to a fixed value.  The environment for &(pipe)&
15851 transports is handled separately, see section &<<SECTpipeenv>>& for
15852 details.
15853
15854
15855 .option keep_malformed main time 4d
15856 This option specifies the length of time to keep messages whose spool files
15857 have been corrupted in some way. This should, of course, never happen. At the
15858 next attempt to deliver such a message, it gets removed. The incident is
15859 logged.
15860
15861
15862 .option ldap_ca_cert_dir main string unset
15863 .cindex "LDAP", "TLS CA certificate directory"
15864 .cindex certificate "directory for LDAP"
15865 This option indicates which directory contains CA certificates for verifying
15866 a TLS certificate presented by an LDAP server.
15867 While Exim does not provide a default value, your SSL library may.
15868 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15869 and constrained to be a directory.
15870
15871
15872 .option ldap_ca_cert_file main string unset
15873 .cindex "LDAP", "TLS CA certificate file"
15874 .cindex certificate "file for LDAP"
15875 This option indicates which file contains CA certificates for verifying
15876 a TLS certificate presented by an LDAP server.
15877 While Exim does not provide a default value, your SSL library may.
15878 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15879 and constrained to be a file.
15880
15881
15882 .option ldap_cert_file main string unset
15883 .cindex "LDAP" "TLS client certificate file"
15884 .cindex certificate "file for LDAP"
15885 This option indicates which file contains an TLS client certificate which
15886 Exim should present to the LDAP server during TLS negotiation.
15887 Should be used together with &%ldap_cert_key%&.
15888
15889
15890 .option ldap_cert_key main string unset
15891 .cindex "LDAP" "TLS client key file"
15892 .cindex certificate "key for LDAP"
15893 This option indicates which file contains the secret/private key to use
15894 to prove identity to the LDAP server during TLS negotiation.
15895 Should be used together with &%ldap_cert_file%&, which contains the
15896 identity to be proven.
15897
15898
15899 .option ldap_cipher_suite main string unset
15900 .cindex "LDAP" "TLS cipher suite"
15901 This controls the TLS cipher-suite negotiation during TLS negotiation with
15902 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15903 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15904
15905
15906 .option ldap_default_servers main "string list" unset
15907 .cindex "LDAP" "default servers"
15908 This option provides a list of LDAP servers which are tried in turn when an
15909 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15910 details of LDAP queries. This option is available only when Exim has been built
15911 with LDAP support.
15912
15913
15914 .option ldap_require_cert main string unset.
15915 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15916 This should be one of the values "hard", "demand", "allow", "try" or "never".
15917 A value other than one of these is interpreted as "never".
15918 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15919 Although Exim does not set a default, the LDAP library probably defaults
15920 to hard/demand.
15921
15922
15923 .option ldap_start_tls main boolean false
15924 .cindex "LDAP" "whether or not to negotiate TLS"
15925 If set, Exim will attempt to negotiate TLS with the LDAP server when
15926 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15927 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15928 of SSL-on-connect.
15929 In the event of failure to negotiate TLS, the action taken is controlled
15930 by &%ldap_require_cert%&.
15931 This option is ignored for &`ldapi`& connections.
15932
15933
15934 .option ldap_version main integer unset
15935 .cindex "LDAP" "protocol version, forcing"
15936 This option can be used to force Exim to set a specific protocol version for
15937 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15938 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15939 the LDAP headers; otherwise it is 2. This option is available only when Exim
15940 has been built with LDAP support.
15941
15942
15943
15944 .option local_from_check main boolean true
15945 .cindex "&'Sender:'& header line" "disabling addition of"
15946 .cindex "&'From:'& header line" "disabling checking of"
15947 When a message is submitted locally (that is, not over a TCP/IP connection) by
15948 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15949 checks that the &'From:'& header line matches the login of the calling user and
15950 the domain specified by &%qualify_domain%&.
15951
15952 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15953 locally submitted message is automatically qualified by Exim, unless the
15954 &%-bnq%& command line option is used.
15955
15956 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15957 on the local part. If the &'From:'& header line does not match, Exim adds a
15958 &'Sender:'& header with an address constructed from the calling user's login
15959 and the default qualify domain.
15960
15961 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15962 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15963 &'Sender:'& header lines supplied by untrusted users, you must also set
15964 &%local_sender_retain%& to be true.
15965
15966 .cindex "envelope from"
15967 .cindex "envelope sender"
15968 These options affect only the header lines in the message. The envelope sender
15969 is still forced to be the login id at the qualify domain unless
15970 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15971
15972 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15973 request similar header line checking. See section &<<SECTthesenhea>>&, which
15974 has more details about &'Sender:'& processing.
15975
15976
15977
15978
15979 .option local_from_prefix main string unset
15980 When Exim checks the &'From:'& header line of locally submitted messages for
15981 matching the login id (see &%local_from_check%& above), it can be configured to
15982 ignore certain prefixes and suffixes in the local part of the address. This is
15983 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15984 appropriate lists, in the same form as the &%local_part_prefix%& and
15985 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15986 example, if
15987 .code
15988 local_from_prefix = *-
15989 .endd
15990 is set, a &'From:'& line containing
15991 .code
15992 From: anything-user@your.domain.example
15993 .endd
15994 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15995 matches the actual sender address that is constructed from the login name and
15996 qualify domain.
15997
15998
15999 .option local_from_suffix main string unset
16000 See &%local_from_prefix%& above.
16001
16002
16003 .option local_interfaces main "string list" "see below"
16004 This option controls which network interfaces are used by the daemon for
16005 listening; they are also used to identify the local host when routing. Chapter
16006 &<<CHAPinterfaces>>& contains a full description of this option and the related
16007 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16008 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16009 &%local_interfaces%& is
16010 .code
16011 local_interfaces = 0.0.0.0
16012 .endd
16013 when Exim is built without IPv6 support; otherwise it is
16014 .code
16015 local_interfaces = <; ::0 ; 0.0.0.0
16016 .endd
16017
16018 .option local_scan_timeout main time 5m
16019 .cindex "timeout" "for &[local_scan()]& function"
16020 .cindex "&[local_scan()]& function" "timeout"
16021 This timeout applies to the &[local_scan()]& function (see chapter
16022 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16023 the incoming message is rejected with a temporary error if it is an SMTP
16024 message. For a non-SMTP message, the message is dropped and Exim ends with a
16025 non-zero code. The incident is logged on the main and reject logs.
16026
16027
16028
16029 .option local_sender_retain main boolean false
16030 .cindex "&'Sender:'& header line" "retaining from local submission"
16031 When a message is submitted locally (that is, not over a TCP/IP connection) by
16032 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16033 do not want this to happen, you must set &%local_sender_retain%&, and you must
16034 also set &%local_from_check%& to be false (Exim will complain if you do not).
16035 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16036 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16037
16038
16039
16040
16041 .option localhost_number main string&!! unset
16042 .cindex "host" "locally unique number for"
16043 .cindex "message ids" "with multiple hosts"
16044 .vindex "&$localhost_number$&"
16045 Exim's message ids are normally unique only within the local host. If
16046 uniqueness among a set of hosts is required, each host must set a different
16047 value for the &%localhost_number%& option. The string is expanded immediately
16048 after reading the configuration file (so that a number can be computed from the
16049 host name, for example) and the result of the expansion must be a number in the
16050 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16051 systems). This is available in subsequent string expansions via the variable
16052 &$localhost_number$&. When &%localhost_number is set%&, the final two
16053 characters of the message id, instead of just being a fractional part of the
16054 time, are computed from the time and the local host number as described in
16055 section &<<SECTmessiden>>&.
16056
16057
16058
16059 .option log_file_path main "string list&!!" "set at compile time"
16060 .cindex "log" "file path for"
16061 This option sets the path which is used to determine the names of Exim's log
16062 files, or indicates that logging is to be to syslog, or both. It is expanded
16063 when Exim is entered, so it can, for example, contain a reference to the host
16064 name. If no specific path is set for the log files at compile or runtime,
16065 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16066 they are written in a sub-directory called &_log_& in Exim's spool directory.
16067 .new
16068 A path must start with a slash.
16069 To send to syslog, use the word &"syslog"&.
16070 .wen
16071 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16072 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16073 used. If this string is fixed at your installation (contains no expansion
16074 variables) it is recommended that you do not set this option in the
16075 configuration file, but instead supply the path using LOG_FILE_PATH in
16076 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16077 early on &-- in particular, failure to read the configuration file.
16078
16079
16080 .option log_selector main string unset
16081 .cindex "log" "selectors"
16082 This option can be used to reduce or increase the number of things that Exim
16083 writes to its log files. Its argument is made up of names preceded by plus or
16084 minus characters. For example:
16085 .code
16086 log_selector = +arguments -retry_defer
16087 .endd
16088 A list of possible names and what they control is given in the chapter on
16089 logging, in section &<<SECTlogselector>>&.
16090
16091
16092 .option log_timezone main boolean false
16093 .cindex "log" "timezone for entries"
16094 .vindex "&$tod_log$&"
16095 .vindex "&$tod_zone$&"
16096 By default, the timestamps on log lines are in local time without the
16097 timezone. This means that if your timezone changes twice a year, the timestamps
16098 in log lines are ambiguous for an hour when the clocks go back. One way of
16099 avoiding this problem is to set the timezone to UTC. An alternative is to set
16100 &%log_timezone%& true. This turns on the addition of the timezone offset to
16101 timestamps in log lines. Turning on this option can add quite a lot to the size
16102 of log files because each line is extended by 6 characters. Note that the
16103 &$tod_log$& variable contains the log timestamp without the zone, but there is
16104 another variable called &$tod_zone$& that contains just the timezone offset.
16105
16106
16107 .option lookup_open_max main integer 25
16108 .cindex "too many open files"
16109 .cindex "open files, too many"
16110 .cindex "file" "too many open"
16111 .cindex "lookup" "maximum open files"
16112 .cindex "limit" "open files for lookups"
16113 This option limits the number of simultaneously open files for single-key
16114 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16115 Exim normally keeps these files open during routing, because often the same
16116 file is required several times. If the limit is reached, Exim closes the least
16117 recently used file. Note that if you are using the &'ndbm'& library, it
16118 actually opens two files for each logical DBM database, though it still counts
16119 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16120 open files"& errors with NDBM, you need to reduce the value of
16121 &%lookup_open_max%&.
16122
16123
16124 .option max_username_length main integer 0
16125 .cindex "length of login name"
16126 .cindex "user name" "maximum length"
16127 .cindex "limit" "user name length"
16128 Some operating systems are broken in that they truncate long arguments to
16129 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16130 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16131 an argument that is longer behaves as if &[getpwnam()]& failed.
16132
16133
16134 .option message_body_newlines main bool false
16135 .cindex "message body" "newlines in variables"
16136 .cindex "newline" "in message body variables"
16137 .vindex "&$message_body$&"
16138 .vindex "&$message_body_end$&"
16139 By default, newlines in the message body are replaced by spaces when setting
16140 the &$message_body$& and &$message_body_end$& expansion variables. If this
16141 option is set true, this no longer happens.
16142
16143
16144 .option message_body_visible main integer 500
16145 .cindex "body of message" "visible size"
16146 .cindex "message body" "visible size"
16147 .vindex "&$message_body$&"
16148 .vindex "&$message_body_end$&"
16149 This option specifies how much of a message's body is to be included in the
16150 &$message_body$& and &$message_body_end$& expansion variables.
16151
16152
16153 .option message_id_header_domain main string&!! unset
16154 .cindex "&'Message-ID:'& header line"
16155 If this option is set, the string is expanded and used as the right hand side
16156 (domain) of the &'Message-ID:'& header that Exim creates if a
16157 locally-originated incoming message does not have one. &"Locally-originated"&
16158 means &"not received over TCP/IP."&
16159 Otherwise, the primary host name is used.
16160 Only letters, digits, dot and hyphen are accepted; any other characters are
16161 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16162 empty string, the option is ignored.
16163
16164
16165 .option message_id_header_text main string&!! unset
16166 If this variable is set, the string is expanded and used to augment the text of
16167 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16168 message does not have one. The text of this header is required by RFC 2822 to
16169 take the form of an address. By default, Exim uses its internal message id as
16170 the local part, and the primary host name as the domain. If this option is set,
16171 it is expanded, and provided the expansion is not forced to fail, and does not
16172 yield an empty string, the result is inserted into the header immediately
16173 before the @, separated from the internal message id by a dot. Any characters
16174 that are illegal in an address are automatically converted into hyphens. This
16175 means that variables such as &$tod_log$& can be used, because the spaces and
16176 colons will become hyphens.
16177
16178
16179 .option message_logs main boolean true
16180 .cindex "message logs" "disabling"
16181 .cindex "log" "message log; disabling"
16182 If this option is turned off, per-message log files are not created in the
16183 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16184 Exim, by reducing the number of files involved in handling a message from a
16185 minimum of four (header spool file, body spool file, delivery journal, and
16186 per-message log) to three. The other major I/O activity is Exim's main log,
16187 which is not affected by this option.
16188
16189
16190 .option message_size_limit main string&!! 50M
16191 .cindex "message" "size limit"
16192 .cindex "limit" "message size"
16193 .cindex "size" "of message, limit"
16194 This option limits the maximum size of message that Exim will process. The
16195 value is expanded for each incoming connection so, for example, it can be made
16196 to depend on the IP address of the remote host for messages arriving via
16197 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16198 optionally followed by K or M.
16199
16200 &*Note*&: This limit cannot be made to depend on a message's sender or any
16201 other properties of an individual message, because it has to be advertised in
16202 the server's response to EHLO. String expansion failure causes a temporary
16203 error. A value of zero means no limit, but its use is not recommended. See also
16204 &%bounce_return_size_limit%&.
16205
16206 Incoming SMTP messages are failed with a 552 error if the limit is
16207 exceeded; locally-generated messages either get a stderr message or a delivery
16208 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16209 an oversized message is logged in both the main and the reject logs. See also
16210 the generic transport option &%message_size_limit%&, which limits the size of
16211 message that an individual transport can process.
16212
16213 If you use a virus-scanner and set this option to to a value larger than the
16214 maximum size that your virus-scanner is configured to support, you may get
16215 failures triggered by large mails.  The right size to configure for the
16216 virus-scanner depends upon what data is passed and the options in use but it's
16217 probably safest to just set it to a little larger than this value.  E.g., with a
16218 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16219 some problems may result.
16220
16221 A value of 0 will disable size limit checking; Exim will still advertise the
16222 SIZE extension in an EHLO response, but without a limit, so as to permit
16223 SMTP clients to still indicate the message size along with the MAIL verb.
16224
16225
16226 .option move_frozen_messages main boolean false
16227 .cindex "frozen messages" "moving"
16228 This option, which is available only if Exim has been built with the setting
16229 .code
16230 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16231 .endd
16232 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16233 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16234 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16235 standard utilities for handling such moved messages, and they do not show up in
16236 lists generated by &%-bp%& or by the Exim monitor.
16237
16238
16239 .option mua_wrapper main boolean false
16240 Setting this option true causes Exim to run in a very restrictive mode in which
16241 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16242 contains a full description of this facility.
16243
16244
16245
16246 .option mysql_servers main "string list" unset
16247 .cindex "MySQL" "server list"
16248 This option provides a list of MySQL servers and associated connection data, to
16249 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16250 option is available only if Exim has been built with MySQL support.
16251
16252
16253 .option never_users main "string list&!!" unset
16254 This option is expanded just once, at the start of Exim's processing. Local
16255 message deliveries are normally run in processes that are setuid to the
16256 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16257 It is usually desirable to prevent any deliveries from running as root, as a
16258 safety precaution.
16259
16260 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16261 list of users that must not be used for local deliveries. This list is fixed in
16262 the binary and cannot be overridden by the configuration file. By default, it
16263 contains just the single user name &"root"&. The &%never_users%& runtime option
16264 can be used to add more users to the fixed list.
16265
16266 If a message is to be delivered as one of the users on the fixed list or the
16267 &%never_users%& list, an error occurs, and delivery is deferred. A common
16268 example is
16269 .code
16270 never_users = root:daemon:bin
16271 .endd
16272 Including root is redundant if it is also on the fixed list, but it does no
16273 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16274 transport driver.
16275
16276
16277 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket"
16278 .cindex "OpenSSL "compatibility options"
16279 This option allows an administrator to adjust the SSL options applied
16280 by OpenSSL to connections.  It is given as a space-separated list of items,
16281 each one to be +added or -subtracted from the current value.
16282
16283 This option is only available if Exim is built against OpenSSL.  The values
16284 available for this option vary according to the age of your OpenSSL install.
16285 The &"all"& value controls a subset of flags which are available, typically
16286 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16287 list the values known on your system and Exim should support all the
16288 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16289 names lose the leading &"SSL_OP_"& and are lower-cased.
16290
16291 Note that adjusting the options can have severe impact upon the security of
16292 SSL as used by Exim.  It is possible to disable safety checks and shoot
16293 yourself in the foot in various unpleasant ways.  This option should not be
16294 adjusted lightly.  An unrecognised item will be detected at startup, by
16295 invoking Exim with the &%-bV%& flag.
16296
16297 The option affects Exim operating both as a server and as a client.
16298
16299 Historical note: prior to release 4.80, Exim defaulted this value to
16300 "+dont_insert_empty_fragments", which may still be needed for compatibility
16301 with some clients, but which lowers security by increasing exposure to
16302 some now infamous attacks.
16303
16304 Examples:
16305 .code
16306 # Make both old MS and old Eudora happy:
16307 openssl_options = -all +microsoft_big_sslv3_buffer \
16308                        +dont_insert_empty_fragments
16309
16310 # Disable older protocol versions:
16311 openssl_options = +no_sslv2 +no_sslv3
16312 .endd
16313
16314 Possible options may include:
16315 .ilist
16316 &`all`&
16317 .next
16318 &`allow_unsafe_legacy_renegotiation`&
16319 .next
16320 &`cipher_server_preference`&
16321 .next
16322 &`dont_insert_empty_fragments`&
16323 .next
16324 &`ephemeral_rsa`&
16325 .next
16326 &`legacy_server_connect`&
16327 .next
16328 &`microsoft_big_sslv3_buffer`&
16329 .next
16330 &`microsoft_sess_id_bug`&
16331 .next
16332 &`msie_sslv2_rsa_padding`&
16333 .next
16334 &`netscape_challenge_bug`&
16335 .next
16336 &`netscape_reuse_cipher_change_bug`&
16337 .next
16338 &`no_compression`&
16339 .next
16340 &`no_session_resumption_on_renegotiation`&
16341 .next
16342 &`no_sslv2`&
16343 .next
16344 &`no_sslv3`&
16345 .next
16346 &`no_ticket`&
16347 .next
16348 &`no_tlsv1`&
16349 .next
16350 &`no_tlsv1_1`&
16351 .next
16352 &`no_tlsv1_2`&
16353 .next
16354 &`safari_ecdhe_ecdsa_bug`&
16355 .next
16356 &`single_dh_use`&
16357 .next
16358 &`single_ecdh_use`&
16359 .next
16360 &`ssleay_080_client_dh_bug`&
16361 .next
16362 &`sslref2_reuse_cert_type_bug`&
16363 .next
16364 &`tls_block_padding_bug`&
16365 .next
16366 &`tls_d5_bug`&
16367 .next
16368 &`tls_rollback_bug`&
16369 .endlist
16370
16371 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16372 all clients connecting using the MacOS SecureTransport TLS facility prior
16373 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16374 to negotiate TLS then this option value might help, provided that your OpenSSL
16375 release is new enough to contain this work-around.  This may be a situation
16376 where you have to upgrade OpenSSL to get buggy clients working.
16377
16378
16379 .option oracle_servers main "string list" unset
16380 .cindex "Oracle" "server list"
16381 This option provides a list of Oracle servers and associated connection data,
16382 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16383 The option is available only if Exim has been built with Oracle support.
16384
16385
16386 .option percent_hack_domains main "domain list&!!" unset
16387 .cindex "&""percent hack""&"
16388 .cindex "source routing" "in email address"
16389 .cindex "address" "source-routed"
16390 The &"percent hack"& is the convention whereby a local part containing a
16391 percent sign is re-interpreted as a new email address, with the percent
16392 replaced by @. This is sometimes called &"source routing"&, though that term is
16393 also applied to RFC 2822 addresses that begin with an @ character. If this
16394 option is set, Exim implements the percent facility for those domains listed,
16395 but no others. This happens before an incoming SMTP address is tested against
16396 an ACL.
16397
16398 &*Warning*&: The &"percent hack"& has often been abused by people who are
16399 trying to get round relaying restrictions. For this reason, it is best avoided
16400 if at all possible. Unfortunately, a number of less security-conscious MTAs
16401 implement it unconditionally. If you are running Exim on a gateway host, and
16402 routing mail through to internal MTAs without processing the local parts, it is
16403 a good idea to reject recipient addresses with percent characters in their
16404 local parts. Exim's default configuration does this.
16405
16406
16407 .option perl_at_start main boolean false
16408 .cindex "Perl"
16409 This option is available only when Exim is built with an embedded Perl
16410 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16411
16412
16413 .option perl_startup main string unset
16414 .cindex "Perl"
16415 This option is available only when Exim is built with an embedded Perl
16416 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16417
16418 .option perl_startup main boolean false
16419 .cindex "Perl"
16420 This Option enables the taint mode of the embedded Perl interpreter.
16421
16422
16423 .option pgsql_servers main "string list" unset
16424 .cindex "PostgreSQL lookup type" "server list"
16425 This option provides a list of PostgreSQL servers and associated connection
16426 data, to be used in conjunction with &(pgsql)& lookups (see section
16427 &<<SECID72>>&). The option is available only if Exim has been built with
16428 PostgreSQL support.
16429
16430
16431 .option pid_file_path main string&!! "set at compile time"
16432 .cindex "daemon" "pid file path"
16433 .cindex "pid file, path for"
16434 This option sets the name of the file to which the Exim daemon writes its
16435 process id. The string is expanded, so it can contain, for example, references
16436 to the host name:
16437 .code
16438 pid_file_path = /var/log/$primary_hostname/exim.pid
16439 .endd
16440 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16441 spool directory.
16442 The value set by the option can be overridden by the &%-oP%& command line
16443 option. A pid file is not written if a &"non-standard"& daemon is run by means
16444 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16445
16446
16447 .option pipelining_advertise_hosts main "host list&!!" *
16448 .cindex "PIPELINING" "suppressing advertising"
16449 This option can be used to suppress the advertisement of the SMTP
16450 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16451 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16452 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16453 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16454 that clients will use it; &"out of order"& commands that are &"expected"& do
16455 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16456
16457 .new
16458 .option pipelining_connect_advertise_hosts main "host list&!!" *
16459 .cindex "pipelining" "early connection"
16460 .cindex "pipelining" PIPE_CONNECT
16461 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16462 this option controls which hosts the facility is advertised to
16463 and from which pipeline early-connection (before MAIL) SMTP
16464 commands are acceptable.
16465 When used, the pipelining saves on roundtrip times.
16466
16467 Currently the option name &"X_PIPE_CONNECT"& is used.
16468 .wen
16469
16470
16471 .option prdr_enable main boolean false
16472 .cindex "PRDR" "enabling on server"
16473 This option can be used to enable the Per-Recipient Data Response extension
16474 to SMTP, defined by Eric Hall.
16475 If the option is set, PRDR is advertised by Exim when operating as a server.
16476 If the client requests PRDR, and more than one recipient, for a message
16477 an additional ACL is called for each recipient after the message content
16478 is received.  See section &<<SECTPRDRACL>>&.
16479
16480 .option preserve_message_logs main boolean false
16481 .cindex "message logs" "preserving"
16482 If this option is set, message log files are not deleted when messages are
16483 completed. Instead, they are moved to a sub-directory of the spool directory
16484 called &_msglog.OLD_&, where they remain available for statistical or debugging
16485 purposes. This is a dangerous option to set on systems with any appreciable
16486 volume of mail. Use with care!
16487
16488
16489 .option primary_hostname main string "see below"
16490 .cindex "name" "of local host"
16491 .cindex "host" "name of local"
16492 .cindex "local host" "name of"
16493 .vindex "&$primary_hostname$&"
16494 This specifies the name of the current host. It is used in the default EHLO or
16495 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16496 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16497 The value is also used by default in some SMTP response messages from an Exim
16498 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16499
16500 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16501 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16502 contains only one component, Exim passes it to &[gethostbyname()]& (or
16503 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16504 version. The variable &$primary_hostname$& contains the host name, whether set
16505 explicitly by this option, or defaulted.
16506
16507
16508 .option print_topbitchars main boolean false
16509 .cindex "printing characters"
16510 .cindex "8-bit characters"
16511 By default, Exim considers only those characters whose codes lie in the range
16512 32&--126 to be printing characters. In a number of circumstances (for example,
16513 when writing log entries) non-printing characters are converted into escape
16514 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16515 is set, code values of 128 and above are also considered to be printing
16516 characters.
16517
16518 This option also affects the header syntax checks performed by the
16519 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16520 the user's full name when constructing From: and Sender: addresses (as
16521 described in section &<<SECTconstr>>&). Setting this option can cause
16522 Exim to generate eight bit message headers that do not conform to the
16523 standards.
16524
16525
16526 .option process_log_path main string unset
16527 .cindex "process log path"
16528 .cindex "log" "process log"
16529 .cindex "&'exiwhat'&"
16530 This option sets the name of the file to which an Exim process writes its
16531 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16532 utility script. If this option is unset, the file called &_exim-process.info_&
16533 in Exim's spool directory is used. The ability to specify the name explicitly
16534 can be useful in environments where two different Exims are running, using
16535 different spool directories.
16536
16537
16538 .option prod_requires_admin main boolean true
16539 .cindex "restricting access to features"
16540 .oindex "&%-M%&"
16541 .oindex "&%-R%&"
16542 .oindex "&%-q%&"
16543 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16544 admin user unless &%prod_requires_admin%& is set false. See also
16545 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16546
16547
16548 .option qualify_domain main string "see below"
16549 .cindex "domain" "for qualifying addresses"
16550 .cindex "address" "qualification"
16551 This option specifies the domain name that is added to any envelope sender
16552 addresses that do not have a domain qualification. It also applies to
16553 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16554 are accepted by default only for locally-generated messages. Qualification is
16555 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16556 locally-generated messages, unless the &%-bnq%& command line option is used.
16557
16558 Messages from external sources must always contain fully qualified addresses,
16559 unless the sending host matches &%sender_unqualified_hosts%& or
16560 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16561 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16562 necessary. Internally, Exim always works with fully qualified envelope
16563 addresses. If &%qualify_domain%& is not set, it defaults to the
16564 &%primary_hostname%& value.
16565
16566
16567 .option qualify_recipient main string "see below"
16568 This option allows you to specify a different domain for qualifying recipient
16569 addresses to the one that is used for senders. See &%qualify_domain%& above.
16570
16571
16572
16573 .option queue_domains main "domain list&!!" unset
16574 .cindex "domain" "specifying non-immediate delivery"
16575 .cindex "queueing incoming messages"
16576 .cindex "message" "queueing certain domains"
16577 This option lists domains for which immediate delivery is not required.
16578 A delivery process is started whenever a message is received, but only those
16579 domains that do not match are processed. All other deliveries wait until the
16580 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16581
16582
16583 .option queue_list_requires_admin main boolean true
16584 .cindex "restricting access to features"
16585 .oindex "&%-bp%&"
16586 The &%-bp%& command-line option, which lists the messages that are on the
16587 queue, requires the caller to be an admin user unless
16588 &%queue_list_requires_admin%& is set false.
16589 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16590
16591
16592 .option queue_only main boolean false
16593 .cindex "queueing incoming messages"
16594 .cindex "message" "queueing unconditionally"
16595 If &%queue_only%& is set, a delivery process is not automatically started
16596 whenever a message is received. Instead, the message waits in the queue for the
16597 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16598 delivered immediately when certain conditions (such as heavy load) occur.
16599
16600 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16601 and &%-odi%& command line options override &%queue_only%& unless
16602 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16603 &%queue_only_load%&, and &%smtp_accept_queue%&.
16604
16605
16606 .option queue_only_file main string unset
16607 .cindex "queueing incoming messages"
16608 .cindex "message" "queueing by file existence"
16609 This option can be set to a colon-separated list of absolute path names, each
16610 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16611 it tests for the existence of each listed path using a call to &[stat()]&. For
16612 each path that exists, the corresponding queueing option is set.
16613 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16614 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16615 .code
16616 queue_only_file = smtp/some/file
16617 .endd
16618 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16619 &_/some/file_& exists.
16620
16621
16622 .option queue_only_load main fixed-point unset
16623 .cindex "load average"
16624 .cindex "queueing incoming messages"
16625 .cindex "message" "queueing by load"
16626 If the system load average is higher than this value, incoming messages from
16627 all sources are queued, and no automatic deliveries are started. If this
16628 happens during local or remote SMTP input, all subsequent messages received on
16629 the same SMTP connection are queued by default, whatever happens to the load in
16630 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16631 false.
16632
16633 Deliveries will subsequently be performed by queue runner processes. This
16634 option has no effect on ancient operating systems on which Exim cannot
16635 determine the load average. See also &%deliver_queue_load_max%& and
16636 &%smtp_load_reserve%&.
16637
16638
16639 .option queue_only_load_latch main boolean true
16640 .cindex "load average" "re-evaluating per message"
16641 When this option is true (the default), once one message has been queued
16642 because the load average is higher than the value set by &%queue_only_load%&,
16643 all subsequent messages received on the same SMTP connection are also queued.
16644 This is a deliberate choice; even though the load average may fall below the
16645 threshold, it doesn't seem right to deliver later messages on the same
16646 connection when not delivering earlier ones. However, there are special
16647 circumstances such as very long-lived connections from scanning appliances
16648 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16649 should be set false. This causes the value of the load average to be
16650 re-evaluated for each message.
16651
16652
16653 .option queue_only_override main boolean true
16654 .cindex "queueing incoming messages"
16655 When this option is true, the &%-od%&&'x'& command line options override the
16656 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16657 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16658 to override; they are accepted, but ignored.
16659
16660
16661 .option queue_run_in_order main boolean false
16662 .cindex "queue runner" "processing messages in order"
16663 If this option is set, queue runs happen in order of message arrival instead of
16664 in an arbitrary order. For this to happen, a complete list of the entire queue
16665 must be set up before the deliveries start. When the queue is all held in a
16666 single directory (the default), a single list is created for both the ordered
16667 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16668 single list is not created when &%queue_run_in_order%& is false. In this case,
16669 the sub-directories are processed one at a time (in a random order), and this
16670 avoids setting up one huge list for the whole queue. Thus, setting
16671 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16672 when the queue is large, because of the extra work in setting up the single,
16673 large list. In most situations, &%queue_run_in_order%& should not be set.
16674
16675
16676
16677 .option queue_run_max main integer&!! 5
16678 .cindex "queue runner" "maximum number of"
16679 This controls the maximum number of queue runner processes that an Exim daemon
16680 can run simultaneously. This does not mean that it starts them all at once,
16681 but rather that if the maximum number are still running when the time comes to
16682 start another one, it refrains from starting another one. This can happen with
16683 very large queues and/or very sluggish deliveries. This option does not,
16684 however, interlock with other processes, so additional queue runners can be
16685 started by other means, or by killing and restarting the daemon.
16686
16687 Setting this option to zero does not suppress queue runs; rather, it disables
16688 the limit, allowing any number of simultaneous queue runner processes to be
16689 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16690 the daemon's command line.
16691
16692 .cindex queues named
16693 .cindex "named queues"
16694 To set limits for different named queues use
16695 an expansion depending on the &$queue_name$& variable.
16696
16697 .option queue_smtp_domains main "domain list&!!" unset
16698 .cindex "queueing incoming messages"
16699 .cindex "message" "queueing remote deliveries"
16700 When this option is set, a delivery process is started whenever a message is
16701 received, routing is performed, and local deliveries take place.
16702 However, if any SMTP deliveries are required for domains that match
16703 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16704 message waits in the queue for the next queue run. Since routing of the message
16705 has taken place, Exim knows to which remote hosts it must be delivered, and so
16706 when the queue run happens, multiple messages for the same host are delivered
16707 over a single SMTP connection. The &%-odqs%& command line option causes all
16708 SMTP deliveries to be queued in this way, and is equivalent to setting
16709 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16710 &%queue_domains%&.
16711
16712
16713 .option receive_timeout main time 0s
16714 .cindex "timeout" "for non-SMTP input"
16715 This option sets the timeout for accepting a non-SMTP message, that is, the
16716 maximum time that Exim waits when reading a message on the standard input. If
16717 the value is zero, it will wait forever. This setting is overridden by the
16718 &%-or%& command line option. The timeout for incoming SMTP messages is
16719 controlled by &%smtp_receive_timeout%&.
16720
16721 .option received_header_text main string&!! "see below"
16722 .cindex "customizing" "&'Received:'& header"
16723 .cindex "&'Received:'& header line" "customizing"
16724 This string defines the contents of the &'Received:'& message header that is
16725 added to each message, except for the timestamp, which is automatically added
16726 on at the end (preceded by a semicolon). The string is expanded each time it is
16727 used. If the expansion yields an empty string, no &'Received:'& header line is
16728 added to the message. Otherwise, the string should start with the text
16729 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16730 header lines.
16731 .new
16732 The default setting is:
16733
16734 .code
16735 received_header_text = Received: \
16736   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16737     {${if def:sender_ident \
16738       {from ${quote_local_part:$sender_ident} }}\
16739         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16740   by $primary_hostname \
16741   ${if def:received_protocol {with $received_protocol }}\
16742   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16743   (Exim $version_number)\n\t\
16744   ${if def:sender_address \
16745   {(envelope-from <$sender_address>)\n\t}}\
16746   id $message_exim_id\
16747   ${if def:received_for {\n\tfor $received_for}}
16748 .endd
16749 .wen
16750
16751 The reference to the TLS cipher is omitted when Exim is built without TLS
16752 support. The use of conditional expansions ensures that this works for both
16753 locally generated messages and messages received from remote hosts, giving
16754 header lines such as the following:
16755 .code
16756 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16757 by marley.carol.example with esmtp (Exim 4.00)
16758 (envelope-from <bob@carol.example>)
16759 id 16IOWa-00019l-00
16760 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16761 Received: by scrooge.carol.example with local (Exim 4.00)
16762 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16763 .endd
16764 Until the body of the message has been received, the timestamp is the time when
16765 the message started to be received. Once the body has arrived, and all policy
16766 checks have taken place, the timestamp is updated to the time at which the
16767 message was accepted.
16768
16769
16770 .option received_headers_max main integer 30
16771 .cindex "loop" "prevention"
16772 .cindex "mail loop prevention"
16773 .cindex "&'Received:'& header line" "counting"
16774 When a message is to be delivered, the number of &'Received:'& headers is
16775 counted, and if it is greater than this parameter, a mail loop is assumed to
16776 have occurred, the delivery is abandoned, and an error message is generated.
16777 This applies to both local and remote deliveries.
16778
16779
16780 .option recipient_unqualified_hosts main "host list&!!" unset
16781 .cindex "unqualified addresses"
16782 .cindex "host" "unqualified addresses from"
16783 This option lists those hosts from which Exim is prepared to accept unqualified
16784 recipient addresses in message envelopes. The addresses are made fully
16785 qualified by the addition of the &%qualify_recipient%& value. This option also
16786 affects message header lines. Exim does not reject unqualified recipient
16787 addresses in headers, but it qualifies them only if the message came from a
16788 host that matches &%recipient_unqualified_hosts%&,
16789 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16790 option was not set.
16791
16792
16793 .option recipients_max main integer 0
16794 .cindex "limit" "number of recipients"
16795 .cindex "recipient" "maximum number"
16796 If this option is set greater than zero, it specifies the maximum number of
16797 original recipients for any message. Additional recipients that are generated
16798 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16799 all recipients over the limit; earlier recipients are delivered as normal.
16800 Non-SMTP messages with too many recipients are failed, and no deliveries are
16801 done.
16802
16803 .cindex "RCPT" "maximum number of incoming"
16804 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16805 RCPT commands in a single message.
16806
16807
16808 .option recipients_max_reject main boolean false
16809 If this option is set true, Exim rejects SMTP messages containing too many
16810 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16811 error to the eventual DATA command. Otherwise (the default) it gives a 452
16812 error to the surplus RCPT commands and accepts the message on behalf of the
16813 initial set of recipients. The remote server should then re-send the message
16814 for the remaining recipients at a later time.
16815
16816
16817 .option remote_max_parallel main integer 2
16818 .cindex "delivery" "parallelism for remote"
16819 This option controls parallel delivery of one message to a number of remote
16820 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16821 does all the remote deliveries for a message one by one. Otherwise, if a single
16822 message has to be delivered to more than one remote host, or if several copies
16823 have to be sent to the same remote host, up to &%remote_max_parallel%&
16824 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16825 deliveries are required, the maximum number of processes are started, and as
16826 each one finishes, another is begun. The order of starting processes is the
16827 same as if sequential delivery were being done, and can be controlled by the
16828 &%remote_sort_domains%& option. If parallel delivery takes place while running
16829 with debugging turned on, the debugging output from each delivery process is
16830 tagged with its process id.
16831
16832 This option controls only the maximum number of parallel deliveries for one
16833 message in one Exim delivery process. Because Exim has no central queue
16834 manager, there is no way of controlling the total number of simultaneous
16835 deliveries if the configuration allows a delivery attempt as soon as a message
16836 is received.
16837
16838 .cindex "number of deliveries"
16839 .cindex "delivery" "maximum number of"
16840 If you want to control the total number of deliveries on the system, you
16841 need to set the &%queue_only%& option. This ensures that all incoming messages
16842 are added to the queue without starting a delivery process. Then set up an Exim
16843 daemon to start queue runner processes at appropriate intervals (probably
16844 fairly often, for example, every minute), and limit the total number of queue
16845 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16846 delivers only one message at a time, the maximum number of deliveries that can
16847 then take place at once is &%queue_run_max%& multiplied by
16848 &%remote_max_parallel%&.
16849
16850 If it is purely remote deliveries you want to control, use
16851 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16852 doing the SMTP routing before queueing, so that several messages for the same
16853 host will eventually get delivered down the same connection.
16854
16855
16856 .option remote_sort_domains main "domain list&!!" unset
16857 .cindex "sorting remote deliveries"
16858 .cindex "delivery" "sorting remote"
16859 When there are a number of remote deliveries for a message, they are sorted by
16860 domain into the order given by this list. For example,
16861 .code
16862 remote_sort_domains = *.cam.ac.uk:*.uk
16863 .endd
16864 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16865 then to those in the &%uk%& domain, then to any others.
16866
16867
16868 .option retry_data_expire main time 7d
16869 .cindex "hints database" "data expiry"
16870 This option sets a &"use before"& time on retry information in Exim's hints
16871 database. Any older retry data is ignored. This means that, for example, once a
16872 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16873 past failures.
16874
16875
16876 .option retry_interval_max main time 24h
16877 .cindex "retry" "limit on interval"
16878 .cindex "limit" "on retry interval"
16879 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16880 intervals between delivery attempts for messages that cannot be delivered
16881 straight away. This option sets an overall limit to the length of time between
16882 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16883 the default value.
16884
16885
16886 .option return_path_remove main boolean true
16887 .cindex "&'Return-path:'& header line" "removing"
16888 RFC 2821, section 4.4, states that an SMTP server must insert a
16889 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16890 The &'Return-path:'& header preserves the sender address as received in the
16891 MAIL command. This description implies that this header should not be present
16892 in an incoming message. If &%return_path_remove%& is true, any existing
16893 &'Return-path:'& headers are removed from messages at the time they are
16894 received. Exim's transports have options for adding &'Return-path:'& headers at
16895 the time of delivery. They are normally used only for final local deliveries.
16896
16897
16898 .option return_size_limit main integer 100K
16899 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16900
16901
16902 .option rfc1413_hosts main "host list&!!" @[]
16903 .cindex "RFC 1413"
16904 .cindex "host" "for RFC 1413 calls"
16905 RFC 1413 identification calls are made to any client host which matches
16906 an item in the list.
16907 The default value specifies just this host, being any local interface
16908 for the system.
16909
16910 .option rfc1413_query_timeout main time 0s
16911 .cindex "RFC 1413" "query timeout"
16912 .cindex "timeout" "for RFC 1413 call"
16913 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16914 no RFC 1413 calls are ever made.
16915
16916
16917 .option sender_unqualified_hosts main "host list&!!" unset
16918 .cindex "unqualified addresses"
16919 .cindex "host" "unqualified addresses from"
16920 This option lists those hosts from which Exim is prepared to accept unqualified
16921 sender addresses. The addresses are made fully qualified by the addition of
16922 &%qualify_domain%&. This option also affects message header lines. Exim does
16923 not reject unqualified addresses in headers that contain sender addresses, but
16924 it qualifies them only if the message came from a host that matches
16925 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16926 using TCP/IP), and the &%-bnq%& option was not set.
16927
16928 .option add_environment main "string list" empty
16929 .cindex "environment"
16930 This option allows to add individual environment variables that the
16931 currently linked libraries and programs in child processes use. The
16932 default list is empty.
16933
16934
16935 .option slow_lookup_log main integer 0
16936 .cindex "logging" "slow lookups"
16937 .cindex "dns" "logging slow lookups"
16938 This option controls logging of slow lookups.
16939 If the value is nonzero it is taken as a number of milliseconds
16940 and lookups taking longer than this are logged.
16941 Currently this applies only to DNS lookups.
16942
16943
16944
16945 .option smtp_accept_keepalive main boolean true
16946 .cindex "keepalive" "on incoming connection"
16947 This option controls the setting of the SO_KEEPALIVE option on incoming
16948 TCP/IP socket connections. When set, it causes the kernel to probe idle
16949 connections periodically, by sending packets with &"old"& sequence numbers. The
16950 other end of the connection should send an acknowledgment if the connection is
16951 still okay or a reset if the connection has been aborted. The reason for doing
16952 this is that it has the beneficial effect of freeing up certain types of
16953 connection that can get stuck when the remote host is disconnected without
16954 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16955 hours to detect unreachable hosts.
16956
16957
16958
16959 .option smtp_accept_max main integer 20
16960 .cindex "limit" "incoming SMTP connections"
16961 .cindex "SMTP" "incoming connection count"
16962 .cindex "inetd"
16963 This option specifies the maximum number of simultaneous incoming SMTP calls
16964 that Exim will accept. It applies only to the listening daemon; there is no
16965 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16966 value is set to zero, no limit is applied. However, it is required to be
16967 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16968 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16969
16970 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16971 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16972 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16973 and &%smtp_load_reserve%& are then checked before accepting the connection.
16974
16975
16976 .option smtp_accept_max_nonmail main integer 10
16977 .cindex "limit" "non-mail SMTP commands"
16978 .cindex "SMTP" "limiting non-mail commands"
16979 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16980 the connection if there are too many. This option defines &"too many"&. The
16981 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16982 client looping sending EHLO, for example. The check is applied only if the
16983 client host matches &%smtp_accept_max_nonmail_hosts%&.
16984
16985 When a new message is expected, one occurrence of RSET is not counted. This
16986 allows a client to send one RSET between messages (this is not necessary,
16987 but some clients do it). Exim also allows one uncounted occurrence of HELO
16988 or EHLO, and one occurrence of STARTTLS between messages. After
16989 starting up a TLS session, another EHLO is expected, and so it too is not
16990 counted. The first occurrence of AUTH in a connection, or immediately
16991 following STARTTLS is not counted. Otherwise, all commands other than
16992 MAIL, RCPT, DATA, and QUIT are counted.
16993
16994
16995 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16996 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16997 check by setting this option. The default value makes it apply to all hosts. By
16998 changing the value, you can exclude any badly-behaved hosts that you have to
16999 live with.
17000
17001
17002 . Allow this long option name to split; give it unsplit as a fifth argument
17003 . for the automatic .oindex that is generated by .option.
17004 . We insert " &~&~" which is both pretty nasty visually and results in
17005 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17006 . zero-width-space, which would be nicer visually and results in (at least)
17007 . html that Firefox will split on when it's forced to reflow (rather than
17008 . inserting a horizontal scrollbar).  However, the text is still not
17009 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17010 . the option name to split.
17011
17012 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17013          smtp_accept_max_per_connection
17014 .cindex "SMTP" "limiting incoming message count"
17015 .cindex "limit" "messages per SMTP connection"
17016 The value of this option limits the number of MAIL commands that Exim is
17017 prepared to accept over a single SMTP connection, whether or not each command
17018 results in the transfer of a message. After the limit is reached, a 421
17019 response is given to subsequent MAIL commands. This limit is a safety
17020 precaution against a client that goes mad (incidents of this type have been
17021 seen).
17022
17023
17024 .option smtp_accept_max_per_host main string&!! unset
17025 .cindex "limit" "SMTP connections from one host"
17026 .cindex "host" "limiting SMTP connections from"
17027 This option restricts the number of simultaneous IP connections from a single
17028 host (strictly, from a single IP address) to the Exim daemon. The option is
17029 expanded, to enable different limits to be applied to different hosts by
17030 reference to &$sender_host_address$&. Once the limit is reached, additional
17031 connection attempts from the same host are rejected with error code 421. This
17032 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17033 of zero imposes no limit. If this option is set greater than zero, it is
17034 required that &%smtp_accept_max%& be non-zero.
17035
17036 &*Warning*&: When setting this option you should not use any expansion
17037 constructions that take an appreciable amount of time. The expansion and test
17038 happen in the main daemon loop, in order to reject additional connections
17039 without forking additional processes (otherwise a denial-of-service attack
17040 could cause a vast number or processes to be created). While the daemon is
17041 doing this processing, it cannot accept any other incoming connections.
17042
17043
17044
17045 .option smtp_accept_queue main integer 0
17046 .cindex "SMTP" "incoming connection count"
17047 .cindex "queueing incoming messages"
17048 .cindex "message" "queueing by SMTP connection count"
17049 If the number of simultaneous incoming SMTP connections being handled via the
17050 listening daemon exceeds this value, messages received by SMTP are just placed
17051 in the queue; no delivery processes are started automatically. The count is
17052 fixed at the start of an SMTP connection. It cannot be updated in the
17053 subprocess that receives messages, and so the queueing or not queueing applies
17054 to all messages received in the same connection.
17055
17056 A value of zero implies no limit, and clearly any non-zero value is useful only
17057 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17058 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17059 various &%-od%&&'x'& command line options.
17060
17061
17062 . See the comment on smtp_accept_max_per_connection
17063
17064 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17065          smtp_accept_queue_per_connection
17066 .cindex "queueing incoming messages"
17067 .cindex "message" "queueing by message count"
17068 This option limits the number of delivery processes that Exim starts
17069 automatically when receiving messages via SMTP, whether via the daemon or by
17070 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17071 and the number of messages received in a single SMTP session exceeds this
17072 number, subsequent messages are placed in the queue, but no delivery processes
17073 are started. This helps to limit the number of Exim processes when a server
17074 restarts after downtime and there is a lot of mail waiting for it on other
17075 systems. On large systems, the default should probably be increased, and on
17076 dial-in client systems it should probably be set to zero (that is, disabled).
17077
17078
17079 .option smtp_accept_reserve main integer 0
17080 .cindex "SMTP" "incoming call count"
17081 .cindex "host" "reserved"
17082 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17083 number of SMTP connections that are reserved for connections from the hosts
17084 that are specified in &%smtp_reserve_hosts%&. The value set in
17085 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17086 restricted to this number of connections; the option specifies a minimum number
17087 of connection slots for them, not a maximum. It is a guarantee that this group
17088 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17089 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17090 individual host.
17091
17092 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17093 set to 5, once there are 45 active connections (from any hosts), new
17094 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17095 provided the other criteria for acceptance are met.
17096
17097
17098 .option smtp_active_hostname main string&!! unset
17099 .cindex "host" "name in SMTP responses"
17100 .cindex "SMTP" "host name in responses"
17101 .vindex "&$primary_hostname$&"
17102 This option is provided for multi-homed servers that want to masquerade as
17103 several different hosts. At the start of an incoming SMTP connection, its value
17104 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17105 responses. For example, it is used as domain name in the response to an
17106 incoming HELO or EHLO command.
17107
17108 .vindex "&$smtp_active_hostname$&"
17109 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17110 is saved with any messages that are received. It is therefore available for use
17111 in routers and transports when the message is later delivered.
17112
17113 If this option is unset, or if its expansion is forced to fail, or if the
17114 expansion results in an empty string, the value of &$primary_hostname$& is
17115 used. Other expansion failures cause a message to be written to the main and
17116 panic logs, and the SMTP command receives a temporary error. Typically, the
17117 value of &%smtp_active_hostname%& depends on the incoming interface address.
17118 For example:
17119 .code
17120 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17121   {cox.mydomain}{box.mydomain}}
17122 .endd
17123
17124 Although &$smtp_active_hostname$& is primarily concerned with incoming
17125 messages, it is also used as the default for HELO commands in callout
17126 verification if there is no remote transport from which to obtain a
17127 &%helo_data%& value.
17128
17129 .option smtp_banner main string&!! "see below"
17130 .cindex "SMTP" "welcome banner"
17131 .cindex "banner for SMTP"
17132 .cindex "welcome banner for SMTP"
17133 .cindex "customizing" "SMTP banner"
17134 This string, which is expanded every time it is used, is output as the initial
17135 positive response to an SMTP connection. The default setting is:
17136 .code
17137 smtp_banner = $smtp_active_hostname ESMTP Exim \
17138   $version_number $tod_full
17139 .endd
17140 Failure to expand the string causes a panic error. If you want to create a
17141 multiline response to the initial SMTP connection, use &"\n"& in the string at
17142 appropriate points, but not at the end. Note that the 220 code is not included
17143 in this string. Exim adds it automatically (several times in the case of a
17144 multiline response).
17145
17146
17147 .option smtp_check_spool_space main boolean true
17148 .cindex "checking disk space"
17149 .cindex "disk space, checking"
17150 .cindex "spool directory" "checking space"
17151 When this option is set, if an incoming SMTP session encounters the SIZE
17152 option on a MAIL command, it checks that there is enough space in the
17153 spool directory's partition to accept a message of that size, while still
17154 leaving free the amount specified by &%check_spool_space%& (even if that value
17155 is zero). If there isn't enough space, a temporary error code is returned.
17156
17157
17158 .option smtp_connect_backlog main integer 20
17159 .cindex "connection backlog"
17160 .cindex "SMTP" "connection backlog"
17161 .cindex "backlog of connections"
17162 This option specifies a maximum number of waiting SMTP connections. Exim passes
17163 this value to the TCP/IP system when it sets up its listener. Once this number
17164 of connections are waiting for the daemon's attention, subsequent connection
17165 attempts are refused at the TCP/IP level. At least, that is what the manuals
17166 say; in some circumstances such connection attempts have been observed to time
17167 out instead. For large systems it is probably a good idea to increase the
17168 value (to 50, say). It also gives some protection against denial-of-service
17169 attacks by SYN flooding.
17170
17171
17172 .option smtp_enforce_sync main boolean true
17173 .cindex "SMTP" "synchronization checking"
17174 .cindex "synchronization checking in SMTP"
17175 The SMTP protocol specification requires the client to wait for a response from
17176 the server at certain points in the dialogue. Without PIPELINING these
17177 synchronization points are after every command; with PIPELINING they are
17178 fewer, but they still exist.
17179
17180 Some spamming sites send out a complete set of SMTP commands without waiting
17181 for any response. Exim protects against this by rejecting a message if the
17182 client has sent further input when it should not have. The error response &"554
17183 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17184 for this error cannot be perfect because of transmission delays (unexpected
17185 input may be on its way but not yet received when Exim checks). However, it
17186 does detect many instances.
17187
17188 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17189 If you want to disable the check selectively (for example, only for certain
17190 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17191 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17192
17193
17194
17195 .option smtp_etrn_command main string&!! unset
17196 .cindex "ETRN" "command to be run"
17197 .vindex "&$domain$&"
17198 If this option is set, the given command is run whenever an SMTP ETRN
17199 command is received from a host that is permitted to issue such commands (see
17200 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17201 are independently expanded. The expansion variable &$domain$& is set to the
17202 argument of the ETRN command, and no syntax checking is done on it. For
17203 example:
17204 .code
17205 smtp_etrn_command = /etc/etrn_command $domain \
17206                     $sender_host_address
17207 .endd
17208 A new process is created to run the command, but Exim does not wait for it to
17209 complete. Consequently, its status cannot be checked. If the command cannot be
17210 run, a line is written to the panic log, but the ETRN caller still receives
17211 a 250 success response. Exim is normally running under its own uid when
17212 receiving SMTP, so it is not possible for it to change the uid before running
17213 the command.
17214
17215
17216 .option smtp_etrn_serialize main boolean true
17217 .cindex "ETRN" "serializing"
17218 When this option is set, it prevents the simultaneous execution of more than
17219 one identical command as a result of ETRN in an SMTP connection. See
17220 section &<<SECTETRN>>& for details.
17221
17222
17223 .option smtp_load_reserve main fixed-point unset
17224 .cindex "load average"
17225 If the system load average ever gets higher than this, incoming SMTP calls are
17226 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17227 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17228 the load is over the limit. The option has no effect on ancient operating
17229 systems on which Exim cannot determine the load average. See also
17230 &%deliver_queue_load_max%& and &%queue_only_load%&.
17231
17232
17233
17234 .option smtp_max_synprot_errors main integer 3
17235 .cindex "SMTP" "limiting syntax and protocol errors"
17236 .cindex "limit" "SMTP syntax and protocol errors"
17237 Exim rejects SMTP commands that contain syntax or protocol errors. In
17238 particular, a syntactically invalid email address, as in this command:
17239 .code
17240 RCPT TO:<abc xyz@a.b.c>
17241 .endd
17242 causes immediate rejection of the command, before any other tests are done.
17243 (The ACL cannot be run if there is no valid address to set up for it.) An
17244 example of a protocol error is receiving RCPT before MAIL. If there are
17245 too many syntax or protocol errors in one SMTP session, the connection is
17246 dropped. The limit is set by this option.
17247
17248 .cindex "PIPELINING" "expected errors"
17249 When the PIPELINING extension to SMTP is in use, some protocol errors are
17250 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17251 Exim assumes that PIPELINING will be used if it advertises it (see
17252 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17253 not count towards the limit.
17254
17255
17256
17257 .option smtp_max_unknown_commands main integer 3
17258 .cindex "SMTP" "limiting unknown commands"
17259 .cindex "limit" "unknown SMTP commands"
17260 If there are too many unrecognized commands in an incoming SMTP session, an
17261 Exim server drops the connection. This is a defence against some kinds of abuse
17262 that subvert web
17263 clients
17264 into making connections to SMTP ports; in these circumstances, a number of
17265 non-SMTP command lines are sent first.
17266
17267
17268
17269 .option smtp_ratelimit_hosts main "host list&!!" unset
17270 .cindex "SMTP" "rate limiting"
17271 .cindex "limit" "rate of message arrival"
17272 .cindex "RCPT" "rate limiting"
17273 Some sites find it helpful to be able to limit the rate at which certain hosts
17274 can send them messages, and the rate at which an individual message can specify
17275 recipients.
17276
17277 Exim has two rate-limiting facilities. This section describes the older
17278 facility, which can limit rates within a single connection. The newer
17279 &%ratelimit%& ACL condition can limit rates across all connections. See section
17280 &<<SECTratelimiting>>& for details of the newer facility.
17281
17282 When a host matches &%smtp_ratelimit_hosts%&, the values of
17283 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17284 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17285 respectively. Each option, if set, must contain a set of four comma-separated
17286 values:
17287
17288 .ilist
17289 A threshold, before which there is no rate limiting.
17290 .next
17291 An initial time delay. Unlike other times in Exim, numbers with decimal
17292 fractional parts are allowed here.
17293 .next
17294 A factor by which to increase the delay each time.
17295 .next
17296 A maximum value for the delay. This should normally be less than 5 minutes,
17297 because after that time, the client is liable to timeout the SMTP command.
17298 .endlist
17299
17300 For example, these settings have been used successfully at the site which
17301 first suggested this feature, for controlling mail from their customers:
17302 .code
17303 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17304 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17305 .endd
17306 The first setting specifies delays that are applied to MAIL commands after
17307 two have been received over a single connection. The initial delay is 0.5
17308 seconds, increasing by a factor of 1.05 each time. The second setting applies
17309 delays to RCPT commands when more than four occur in a single message.
17310
17311
17312 .option smtp_ratelimit_mail main string unset
17313 See &%smtp_ratelimit_hosts%& above.
17314
17315
17316 .option smtp_ratelimit_rcpt main string unset
17317 See &%smtp_ratelimit_hosts%& above.
17318
17319
17320 .option smtp_receive_timeout main time&!! 5m
17321 .cindex "timeout" "for SMTP input"
17322 .cindex "SMTP" "input timeout"
17323 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17324 input, including batch SMTP. If a line of input (either an SMTP command or a
17325 data line) is not received within this time, the SMTP connection is dropped and
17326 the message is abandoned.
17327 A line is written to the log containing one of the following messages:
17328 .code
17329 SMTP command timeout on connection from...
17330 SMTP data timeout on connection from...
17331 .endd
17332 The former means that Exim was expecting to read an SMTP command; the latter
17333 means that it was in the DATA phase, reading the contents of a message.
17334
17335 If the first character of the option is a &"$"& the option is
17336 expanded before use and may depend on
17337 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17338
17339
17340 .oindex "&%-os%&"
17341 The value set by this option can be overridden by the
17342 &%-os%& command-line option. A setting of zero time disables the timeout, but
17343 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17344 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17345 timeout is controlled by &%receive_timeout%& and &%-or%&.
17346
17347
17348 .option smtp_reserve_hosts main "host list&!!" unset
17349 This option defines hosts for which SMTP connections are reserved; see
17350 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17351
17352
17353 .option smtp_return_error_details main boolean false
17354 .cindex "SMTP" "details policy failures"
17355 .cindex "policy control" "rejection, returning details"
17356 In the default state, Exim uses bland messages such as
17357 &"Administrative prohibition"& when it rejects SMTP commands for policy
17358 reasons. Many sysadmins like this because it gives away little information
17359 to spammers. However, some other sysadmins who are applying strict checking
17360 policies want to give out much fuller information about failures. Setting
17361 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17362 example, instead of &"Administrative prohibition"&, it might give:
17363 .code
17364 550-Rejected after DATA: '>' missing at end of address:
17365 550 failing address in "From" header is: <user@dom.ain
17366 .endd
17367
17368
17369 .option smtputf8_advertise_hosts main "host list&!!" *
17370 .cindex "SMTPUTF8" "advertising"
17371 When Exim is built with support for internationalised mail names,
17372 the availability thereof is advertised in
17373 response to EHLO only to those client hosts that match this option. See
17374 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17375
17376
17377 .option spamd_address main string "127.0.0.1 783"
17378 This option is available when Exim is compiled with the content-scanning
17379 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17380 See section &<<SECTscanspamass>>& for more details.
17381
17382
17383
17384 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17385 This option is available when Exim is compiled with SPF support.
17386 See section &<<SECSPF>>& for more details.
17387
17388
17389
17390 .option split_spool_directory main boolean false
17391 .cindex "multiple spool directories"
17392 .cindex "spool directory" "split"
17393 .cindex "directories, multiple"
17394 If this option is set, it causes Exim to split its input directory into 62
17395 subdirectories, each with a single alphanumeric character as its name. The
17396 sixth character of the message id is used to allocate messages to
17397 subdirectories; this is the least significant base-62 digit of the time of
17398 arrival of the message.
17399
17400 Splitting up the spool in this way may provide better performance on systems
17401 where there are long mail queues, by reducing the number of files in any one
17402 directory. The msglog directory is also split up in a similar way to the input
17403 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17404 are still placed in the single directory &_msglog.OLD_&.
17405
17406 It is not necessary to take any special action for existing messages when
17407 changing &%split_spool_directory%&. Exim notices messages that are in the
17408 &"wrong"& place, and continues to process them. If the option is turned off
17409 after a period of being on, the subdirectories will eventually empty and be
17410 automatically deleted.
17411
17412 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17413 changes. Instead of creating a list of all messages in the queue, and then
17414 trying to deliver each one, in turn, it constructs a list of those in one
17415 sub-directory and tries to deliver them, before moving on to the next
17416 sub-directory. The sub-directories are processed in a random order. This
17417 spreads out the scanning of the input directories, and uses less memory. It is
17418 particularly beneficial when there are lots of messages in the queue. However,
17419 if &%queue_run_in_order%& is set, none of this new processing happens. The
17420 entire queue has to be scanned and sorted before any deliveries can start.
17421
17422
17423 .option spool_directory main string&!! "set at compile time"
17424 .cindex "spool directory" "path to"
17425 This defines the directory in which Exim keeps its spool, that is, the messages
17426 it is waiting to deliver. The default value is taken from the compile-time
17427 configuration setting, if there is one. If not, this option must be set. The
17428 string is expanded, so it can contain, for example, a reference to
17429 &$primary_hostname$&.
17430
17431 If the spool directory name is fixed on your installation, it is recommended
17432 that you set it at build time rather than from this option, particularly if the
17433 log files are being written to the spool directory (see &%log_file_path%&).
17434 Otherwise log files cannot be used for errors that are detected early on, such
17435 as failures in the configuration file.
17436
17437 By using this option to override the compiled-in path, it is possible to run
17438 tests of Exim without using the standard spool.
17439
17440 .option spool_wireformat main boolean false
17441 .cindex "spool directory" "file formats"
17442 If this option is set, Exim may for some messages use an alternative format
17443 for data-files in the spool which matches the wire format.
17444 Doing this permits more efficient message reception and transmission.
17445 Currently it is only done for messages received using the ESMTP CHUNKING
17446 option.
17447
17448 The following variables will not have useful values:
17449 .code
17450 $max_received_linelength
17451 $body_linecount
17452 $body_zerocount
17453 .endd
17454
17455 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17456 and any external programs which are passed a reference to a message data file
17457 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17458 will need to be aware of the different formats potentially available.
17459
17460 Using any of the ACL conditions noted will negate the reception benefit
17461 (as a Unix-mbox-format file is constructed for them).
17462 The transmission benefit is maintained.
17463
17464 .option sqlite_lock_timeout main time 5s
17465 .cindex "sqlite lookup type" "lock timeout"
17466 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17467 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17468
17469 .option strict_acl_vars main boolean false
17470 .cindex "&ACL;" "variables, handling unset"
17471 This option controls what happens if a syntactically valid but undefined ACL
17472 variable is referenced. If it is false (the default), an empty string
17473 is substituted; if it is true, an error is generated. See section
17474 &<<SECTaclvariables>>& for details of ACL variables.
17475
17476 .option strip_excess_angle_brackets main boolean false
17477 .cindex "angle brackets, excess"
17478 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17479 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17480 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17481 passed on to another MTA, the excess angle brackets are not passed on. If this
17482 option is not set, multiple pairs of angle brackets cause a syntax error.
17483
17484
17485 .option strip_trailing_dot main boolean false
17486 .cindex "trailing dot on domain"
17487 .cindex "dot" "trailing on domain"
17488 If this option is set, a trailing dot at the end of a domain in an address is
17489 ignored. If this is in the envelope and the message is passed on to another
17490 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17491 domain causes a syntax error.
17492 However, addresses in header lines are checked only when an ACL requests header
17493 syntax checking.
17494
17495
17496 .option syslog_duplication main boolean true
17497 .cindex "syslog" "duplicate log lines; suppressing"
17498 When Exim is logging to syslog, it writes the log lines for its three
17499 separate logs at different syslog priorities so that they can in principle
17500 be separated on the logging hosts. Some installations do not require this
17501 separation, and in those cases, the duplication of certain log lines is a
17502 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17503 particular log line is written to syslog. For lines that normally go to
17504 both the main log and the reject log, the reject log version (possibly
17505 containing message header lines) is written, at LOG_NOTICE priority.
17506 Lines that normally go to both the main and the panic log are written at
17507 the LOG_ALERT priority.
17508
17509
17510 .option syslog_facility main string unset
17511 .cindex "syslog" "facility; setting"
17512 This option sets the syslog &"facility"& name, used when Exim is logging to
17513 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17514 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17515 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17516 details of Exim's logging.
17517
17518
17519 .option syslog_pid main boolean true
17520 .cindex "syslog" "pid"
17521 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17522 omitted when these lines are sent to syslog. (Syslog normally prefixes
17523 the log lines with the PID of the logging process automatically.) You need
17524 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17525 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17526
17527
17528
17529 .option syslog_processname main string &`exim`&
17530 .cindex "syslog" "process name; setting"
17531 This option sets the syslog &"ident"& name, used when Exim is logging to
17532 syslog. The value must be no longer than 32 characters. See chapter
17533 &<<CHAPlog>>& for details of Exim's logging.
17534
17535
17536
17537 .option syslog_timestamp main boolean true
17538 .cindex "syslog" "timestamps"
17539 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17540 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17541 details of Exim's logging.
17542
17543
17544 .option system_filter main string&!! unset
17545 .cindex "filter" "system filter"
17546 .cindex "system filter" "specifying"
17547 .cindex "Sieve filter" "not available for system filter"
17548 This option specifies an Exim filter file that is applied to all messages at
17549 the start of each delivery attempt, before any routing is done. System filters
17550 must be Exim filters; they cannot be Sieve filters. If the system filter
17551 generates any deliveries to files or pipes, or any new mail messages, the
17552 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17553 which transports are to be used. Details of this facility are given in chapter
17554 &<<CHAPsystemfilter>>&.
17555 A forced expansion failure results in no filter operation.
17556
17557
17558 .option system_filter_directory_transport main string&!! unset
17559 .vindex "&$address_file$&"
17560 This sets the name of the transport driver that is to be used when the
17561 &%save%& command in a system message filter specifies a path ending in &"/"&,
17562 implying delivery of each message into a separate file in some directory.
17563 During the delivery, the variable &$address_file$& contains the path name.
17564
17565
17566 .option system_filter_file_transport main string&!! unset
17567 .cindex "file" "transport for system filter"
17568 This sets the name of the transport driver that is to be used when the &%save%&
17569 command in a system message filter specifies a path not ending in &"/"&. During
17570 the delivery, the variable &$address_file$& contains the path name.
17571
17572 .option system_filter_group main string unset
17573 .cindex "gid (group id)" "system filter"
17574 This option is used only when &%system_filter_user%& is also set. It sets the
17575 gid under which the system filter is run, overriding any gid that is associated
17576 with the user. The value may be numerical or symbolic.
17577
17578 .option system_filter_pipe_transport main string&!! unset
17579 .cindex "&(pipe)& transport" "for system filter"
17580 .vindex "&$address_pipe$&"
17581 This specifies the transport driver that is to be used when a &%pipe%& command
17582 is used in a system filter. During the delivery, the variable &$address_pipe$&
17583 contains the pipe command.
17584
17585
17586 .option system_filter_reply_transport main string&!! unset
17587 .cindex "&(autoreply)& transport" "for system filter"
17588 This specifies the transport driver that is to be used when a &%mail%& command
17589 is used in a system filter.
17590
17591
17592 .option system_filter_user main string unset
17593 .cindex "uid (user id)" "system filter"
17594 If this option is set to root, the system filter is run in the main Exim
17595 delivery process, as root.  Otherwise, the system filter runs in a separate
17596 process, as the given user, defaulting to the Exim run-time user.
17597 Unless the string consists entirely of digits, it
17598 is looked up in the password data. Failure to find the named user causes a
17599 configuration error. The gid is either taken from the password data, or
17600 specified by &%system_filter_group%&. When the uid is specified numerically,
17601 &%system_filter_group%& is required to be set.
17602
17603 If the system filter generates any pipe, file, or reply deliveries, the uid
17604 under which the filter is run is used when transporting them, unless a
17605 transport option overrides.
17606
17607
17608 .option tcp_nodelay main boolean true
17609 .cindex "daemon" "TCP_NODELAY on sockets"
17610 .cindex "Nagle algorithm"
17611 .cindex "TCP_NODELAY on listening sockets"
17612 If this option is set false, it stops the Exim daemon setting the
17613 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17614 turns off the &"Nagle algorithm"&, which is a way of improving network
17615 performance in interactive (character-by-character) situations. Turning it off
17616 should improve Exim's performance a bit, so that is what happens by default.
17617 However, it appears that some broken clients cannot cope, and time out. Hence
17618 this option. It affects only those sockets that are set up for listening by the
17619 daemon. Sockets created by the smtp transport for delivering mail always set
17620 TCP_NODELAY.
17621
17622
17623 .option timeout_frozen_after main time 0s
17624 .cindex "frozen messages" "timing out"
17625 .cindex "timeout" "frozen messages"
17626 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17627 message of any kind that has been in the queue for longer than the given time
17628 is automatically cancelled at the next queue run. If the frozen message is a
17629 bounce message, it is just discarded; otherwise, a bounce is sent to the
17630 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17631 If you want to timeout frozen bounce messages earlier than other kinds of
17632 frozen message, see &%ignore_bounce_errors_after%&.
17633
17634 &*Note:*& the default value of zero means no timeouts; with this setting,
17635 frozen messages remain in the queue forever (except for any frozen bounce
17636 messages that are released by &%ignore_bounce_errors_after%&).
17637
17638
17639 .option timezone main string unset
17640 .cindex "timezone, setting"
17641 .cindex "environment" "values from"
17642 The value of &%timezone%& is used to set the environment variable TZ while
17643 running Exim (if it is different on entry). This ensures that all timestamps
17644 created by Exim are in the required timezone. If you want all your timestamps
17645 to be in UTC (aka GMT) you should set
17646 .code
17647 timezone = UTC
17648 .endd
17649 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17650 or, if that is not set, from the value of the TZ environment variable when Exim
17651 is built. If &%timezone%& is set to the empty string, either at build or run
17652 time, any existing TZ variable is removed from the environment when Exim
17653 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17654 unfortunately not all, operating systems.
17655
17656
17657 .option tls_advertise_hosts main "host list&!!" *
17658 .cindex "TLS" "advertising"
17659 .cindex "encryption" "on SMTP connection"
17660 .cindex "SMTP" "encrypted connection"
17661 When Exim is built with support for TLS encrypted connections, the availability
17662 of the STARTTLS command to set up an encrypted session is advertised in
17663 response to EHLO only to those client hosts that match this option. See
17664 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17665 Note that the default value requires that a certificate be supplied
17666 using the &%tls_certificate%& option.  If TLS support for incoming connections
17667 is not required the &%tls_advertise_hosts%& option should be set empty.
17668
17669
17670 .option tls_certificate main string list&!! unset
17671 .cindex "TLS" "server certificate; location of"
17672 .cindex "certificate" "server, location of"
17673 The value of this option is expanded, and must then be a list of absolute paths to
17674 files which contain the server's certificates (in PEM format).
17675 Commonly only one file is needed.
17676 The server's private key is also
17677 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17678 &<<CHAPTLS>>& for further details.
17679
17680 &*Note*&: The certificates defined by this option are used only when Exim is
17681 receiving incoming messages as a server. If you want to supply certificates for
17682 use when sending messages as a client, you must set the &%tls_certificate%&
17683 option in the relevant &(smtp)& transport.
17684
17685 &*Note*&: If you use filenames based on IP addresses, change the list
17686 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17687
17688 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17689 when a list of more than one
17690 file is used, the &$tls_in_ourcert$& variable is unreliable.
17691
17692 &*Note*&: OCSP stapling is not usable under OpenSSL
17693 when a list of more than one file is used.
17694
17695 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17696 if the OpenSSL build supports TLS extensions and the TLS client sends the
17697 Server Name Indication extension, then this option and others documented in
17698 &<<SECTtlssni>>& will be re-expanded.
17699
17700 If this option is unset or empty a fresh self-signed certificate will be
17701 generated for every connection.
17702
17703 .option tls_crl main string&!! unset
17704 .cindex "TLS" "server certificate revocation list"
17705 .cindex "certificate" "revocation list for server"
17706 This option specifies a certificate revocation list. The expanded value must
17707 be the name of a file that contains CRLs in PEM format.
17708
17709 Under OpenSSL the option can specify a directory with CRL files.
17710
17711 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17712 for each signing element of the certificate chain (i.e. all but the leaf).
17713 For the file variant this can be multiple PEM blocks in the one file.
17714
17715 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17716
17717
17718 .option tls_dh_max_bits main integer 2236
17719 .cindex "TLS" "D-H bit count"
17720 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17721 the chosen TLS library.  That value might prove to be too high for
17722 interoperability.  This option provides a maximum clamp on the value
17723 suggested, trading off security for interoperability.
17724
17725 The value must be at least 1024.
17726
17727 The value 2236 was chosen because, at time of adding the option, it was the
17728 hard-coded maximum value supported by the NSS cryptographic library, as used
17729 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17730
17731 If you prefer more security and are willing to break some clients, raise this
17732 number.
17733
17734 Note that the value passed to GnuTLS for *generating* a new prime may be a
17735 little less than this figure, because GnuTLS is inexact and may produce a
17736 larger prime than requested.
17737
17738
17739 .option tls_dhparam main string&!! unset
17740 .cindex "TLS" "D-H parameters for server"
17741 The value of this option is expanded and indicates the source of DH parameters
17742 to be used by Exim.
17743
17744 .new
17745 This option is ignored for GnuTLS version 3.6.0 and later.
17746 The library manages parameter negotiation internally.
17747 .wen
17748
17749 &*Note: The Exim Maintainers strongly recommend,
17750 for other TLS library versions,
17751 using a filename with site-generated
17752 local DH parameters*&, which has been supported across all versions of Exim.  The
17753 other specific constants available are a fallback so that even when
17754 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17755
17756 If &%tls_dhparam%& is a filename starting with a &`/`&,
17757 then it names a file from which DH
17758 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17759 PKCS#3 representation of the DH prime.  If the file does not exist, for
17760 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17761 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17762 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17763 and treated as though the &%tls_dhparam%& were set to "none".
17764
17765 If this option expands to the string "none", then no DH parameters will be
17766 loaded by Exim.
17767
17768 If this option expands to the string "historic" and Exim is using GnuTLS, then
17769 Exim will attempt to load a file from inside the spool directory.  If the file
17770 does not exist, Exim will attempt to create it.
17771 See section &<<SECTgnutlsparam>>& for further details.
17772
17773 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17774 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17775
17776 In older versions of Exim the default was the 2048 bit prime described in section
17777 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17778 in IKE is assigned number 23.
17779
17780 Otherwise, the option must expand to the name used by Exim for any of a number
17781 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17782 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17783 the number used by IKE, or "default" which corresponds to
17784 &`exim.dev.20160529.3`&.
17785
17786 The available standard primes are:
17787 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17788 &`ike1`&, &`ike2`&, &`ike5`&,
17789 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17790 &`ike22`&, &`ike23`& and &`ike24`&.
17791
17792 The available additional primes are:
17793 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17794
17795 Some of these will be too small to be accepted by clients.
17796 Some may be too large to be accepted by clients.
17797 The open cryptographic community has suspicions about the integrity of some
17798 of the later IKE values, which led into RFC7919 providing new fixed constants
17799 (the "ffdhe" identifiers).
17800
17801 At this point, all of the "ike" values should be considered obsolete;
17802 they're still in Exim to avoid breaking unusual configurations, but are
17803 candidates for removal the next time we have backwards-incompatible changes.
17804
17805 The TLS protocol does not negotiate an acceptable size for this; clients tend
17806 to hard-drop connections if what is offered by the server is unacceptable,
17807 whether too large or too small, and there's no provision for the client to
17808 tell the server what these constraints are.  Thus, as a server operator, you
17809 need to make an educated guess as to what is most likely to work for your
17810 userbase.
17811
17812 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17813 is most likely to maximise interoperability.  The upper bound comes from
17814 applications using the Mozilla Network Security Services (NSS) library, which
17815 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17816 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17817 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17818 acceptable bound from 1024 to 2048.
17819
17820
17821 .option tls_eccurve main string&!! &`auto`&
17822 .cindex TLS "EC cryptography"
17823 This option selects a EC curve for use by Exim when used with OpenSSL.
17824 It has no effect when Exim is used with GnuTLS.
17825
17826 After expansion it must contain a valid EC curve parameter, such as
17827 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17828 for valid selections.
17829
17830 For OpenSSL versions before (and not including) 1.0.2, the string
17831 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17832 &`auto`& tells the library to choose.
17833
17834 If the option expands to an empty string, no EC curves will be enabled.
17835
17836
17837 .option tls_ocsp_file main string&!! unset
17838 .cindex TLS "certificate status"
17839 .cindex TLS "OCSP proof file"
17840 This option
17841 must if set expand to the absolute path to a file which contains a current
17842 status proof for the server's certificate, as obtained from the
17843 Certificate Authority.
17844
17845 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17846
17847 .new
17848 For OpenSSL 1.1.0 or later, and
17849 .wen
17850 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17851 of files, to match a list given for the &%tls_certificate%& option.
17852 The ordering of the two lists must match.
17853
17854 .new
17855 The file(s) should be in DER format,
17856 except for GnuTLS 3.6.3 or later when an optional filetype prefix
17857 can be used.  The prefix must be one of "DER" or "PEM", followed by
17858 a single space.  If one is used it sets the format for subsequent
17859 files in the list; the initial format is DER.
17860 When a PEM format file is used it may contain multiple proofs,
17861 for multiple certificate chain element proofs under TLS1.3.
17862 .wen
17863
17864 .option tls_on_connect_ports main "string list" unset
17865 .cindex SSMTP
17866 .cindex SMTPS
17867 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17868 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17869 set up without waiting for the client to issue a STARTTLS command. For
17870 further details, see section &<<SECTsupobssmt>>&.
17871
17872
17873
17874 .option tls_privatekey main string list&!! unset
17875 .cindex "TLS" "server private key; location of"
17876 The value of this option is expanded, and must then be a list of absolute paths to
17877 files which contains the server's private keys.
17878 If this option is unset, or if
17879 the expansion is forced to fail, or the result is an empty string, the private
17880 key is assumed to be in the same file as the server's certificates. See chapter
17881 &<<CHAPTLS>>& for further details.
17882
17883 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17884
17885
17886 .option tls_remember_esmtp main boolean false
17887 .cindex "TLS" "esmtp state; remembering"
17888 .cindex "TLS" "broken clients"
17889 If this option is set true, Exim violates the RFCs by remembering that it is in
17890 &"esmtp"& state after successfully negotiating a TLS session. This provides
17891 support for broken clients that fail to send a new EHLO after starting a
17892 TLS session.
17893
17894
17895 .option tls_require_ciphers main string&!! unset
17896 .cindex "TLS" "requiring specific ciphers"
17897 .cindex "cipher" "requiring specific"
17898 This option controls which ciphers can be used for incoming TLS connections.
17899 The &(smtp)& transport has an option of the same name for controlling outgoing
17900 connections. This option is expanded for each connection, so can be varied for
17901 different clients if required. The value of this option must be a list of
17902 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17903 in somewhat different ways. If GnuTLS is being used, the client controls the
17904 preference order of the available ciphers. Details are given in sections
17905 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17906
17907
17908 .option tls_try_verify_hosts main "host list&!!" unset
17909 .cindex "TLS" "client certificate verification"
17910 .cindex "certificate" "verification of client"
17911 See &%tls_verify_hosts%& below.
17912
17913
17914 .option tls_verify_certificates main string&!! system
17915 .cindex "TLS" "client certificate verification"
17916 .cindex "certificate" "verification of client"
17917 The value of this option is expanded, and must then be either the
17918 word "system"
17919 or the absolute path to
17920 a file or directory containing permitted certificates for clients that
17921 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17922
17923 The "system" value for the option will use a
17924 system default location compiled into the SSL library.
17925 This is not available for GnuTLS versions preceding 3.0.20,
17926 and will be taken as empty; an explicit location
17927 must be specified.
17928
17929 The use of a directory for the option value is not available for GnuTLS versions
17930 preceding 3.3.6 and a single file must be used.
17931
17932 With OpenSSL the certificates specified
17933 explicitly
17934 either by file or directory
17935 are added to those given by the system default location.
17936
17937 These certificates should be for the certificate authorities trusted, rather
17938 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17939 the value is a file then the certificates are sent by Exim as a server to
17940 connecting clients, defining the list of accepted certificate authorities.
17941 Thus the values defined should be considered public data.  To avoid this,
17942 use the explicit directory version.
17943
17944 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17945
17946 A forced expansion failure or setting to an empty string is equivalent to
17947 being unset.
17948
17949
17950 .option tls_verify_hosts main "host list&!!" unset
17951 .cindex "TLS" "client certificate verification"
17952 .cindex "certificate" "verification of client"
17953 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17954 certificates from clients. The expected certificates are defined by
17955 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17956 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17957 &%tls_verify_certificates%& is not set.
17958
17959 Any client that matches &%tls_verify_hosts%& is constrained by
17960 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17961 present one of the listed certificates. If it does not, the connection is
17962 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17963 the host to use TLS. It can still send SMTP commands through unencrypted
17964 connections. Forcing a client to use TLS has to be done separately using an
17965 ACL to reject inappropriate commands when the connection is not encrypted.
17966
17967 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17968 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17969 certificate and checks it against &%tls_verify_certificates%&, but does not
17970 abort the connection if there is no certificate or if it does not match. This
17971 state can be detected in an ACL, which makes it possible to implement policies
17972 such as &"accept for relay only if a verified certificate has been received,
17973 but accept for local delivery if encrypted, even without a verified
17974 certificate"&.
17975
17976 Client hosts that match neither of these lists are not asked to present
17977 certificates.
17978
17979
17980 .option trusted_groups main "string list&!!" unset
17981 .cindex "trusted groups"
17982 .cindex "groups" "trusted"
17983 This option is expanded just once, at the start of Exim's processing. If this
17984 option is set, any process that is running in one of the listed groups, or
17985 which has one of them as a supplementary group, is trusted. The groups can be
17986 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17987 details of what trusted callers are permitted to do. If neither
17988 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17989 are trusted.
17990
17991 .option trusted_users main "string list&!!" unset
17992 .cindex "trusted users"
17993 .cindex "user" "trusted"
17994 This option is expanded just once, at the start of Exim's processing. If this
17995 option is set, any process that is running as one of the listed users is
17996 trusted. The users can be specified numerically or by name. See section
17997 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17998 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17999 Exim user are trusted.
18000
18001 .option unknown_login main string&!! unset
18002 .cindex "uid (user id)" "unknown caller"
18003 .vindex "&$caller_uid$&"
18004 This is a specialized feature for use in unusual configurations. By default, if
18005 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18006 gives up. The &%unknown_login%& option can be used to set a login name to be
18007 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18008 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18009 is used for the user's real name (gecos field), unless this has been set by the
18010 &%-F%& option.
18011
18012 .option unknown_username main string unset
18013 See &%unknown_login%&.
18014
18015 .option untrusted_set_sender main "address list&!!" unset
18016 .cindex "trusted users"
18017 .cindex "sender" "setting by untrusted user"
18018 .cindex "untrusted user setting sender"
18019 .cindex "user" "untrusted setting sender"
18020 .cindex "envelope from"
18021 .cindex "envelope sender"
18022 When an untrusted user submits a message to Exim using the standard input, Exim
18023 normally creates an envelope sender address from the user's login and the
18024 default qualification domain. Data from the &%-f%& option (for setting envelope
18025 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18026 is used) is ignored.
18027
18028 However, untrusted users are permitted to set an empty envelope sender address,
18029 to declare that a message should never generate any bounces. For example:
18030 .code
18031 exim -f '<>' user@domain.example
18032 .endd
18033 .vindex "&$sender_ident$&"
18034 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18035 other envelope sender addresses in a controlled way. When it is set, untrusted
18036 users are allowed to set envelope sender addresses that match any of the
18037 patterns in the list. Like all address lists, the string is expanded. The
18038 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18039 users to setting senders that start with their login ids
18040 followed by a hyphen
18041 by a setting like this:
18042 .code
18043 untrusted_set_sender = ^$sender_ident-
18044 .endd
18045 If you want to allow untrusted users to set envelope sender addresses without
18046 restriction, you can use
18047 .code
18048 untrusted_set_sender = *
18049 .endd
18050 The &%untrusted_set_sender%& option applies to all forms of local input, but
18051 only to the setting of the envelope sender. It does not permit untrusted users
18052 to use the other options which trusted user can use to override message
18053 parameters. Furthermore, it does not stop Exim from removing an existing
18054 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18055 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18056 overriding these actions. The handling of the &'Sender:'& header is also
18057 described in section &<<SECTthesenhea>>&.
18058
18059 The log line for a message's arrival shows the envelope sender following
18060 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18061 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18062 envelope sender address, the user's login is shown in parentheses after the
18063 sender address.
18064
18065
18066 .option uucp_from_pattern main string "see below"
18067 .cindex "&""From""& line"
18068 .cindex "UUCP" "&""From""& line"
18069 Some applications that pass messages to an MTA via a command line interface use
18070 an initial line starting with &"From&~"& to pass the envelope sender. In
18071 particular, this is used by UUCP software. Exim recognizes such a line by means
18072 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18073 matches, the sender address is constructed by expanding the contents of
18074 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18075 default pattern recognizes lines in the following two forms:
18076 .code
18077 From ph10 Fri Jan  5 12:35 GMT 1996
18078 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18079 .endd
18080 The pattern can be seen by running
18081 .code
18082 exim -bP uucp_from_pattern
18083 .endd
18084 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18085 year in the second case. The first word after &"From&~"& is matched in the
18086 regular expression by a parenthesized subpattern. The default value for
18087 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18088 (&"ph10"& in the example above) as the message's sender. See also
18089 &%ignore_fromline_hosts%&.
18090
18091
18092 .option uucp_from_sender main string&!! &`$1`&
18093 See &%uucp_from_pattern%& above.
18094
18095
18096 .option warn_message_file main string unset
18097 .cindex "warning of delay" "customizing the message"
18098 .cindex "customizing" "warning message"
18099 This option defines a template file containing paragraphs of text to be used
18100 for constructing the warning message which is sent by Exim when a message has
18101 been in the queue for a specified amount of time, as specified by
18102 &%delay_warning%&. Details of the file's contents are given in chapter
18103 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18104
18105
18106 .option write_rejectlog main boolean true
18107 .cindex "reject log" "disabling"
18108 If this option is set false, Exim no longer writes anything to the reject log.
18109 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18110 .ecindex IIDconfima
18111 .ecindex IIDmaiconf
18112
18113
18114
18115
18116 . ////////////////////////////////////////////////////////////////////////////
18117 . ////////////////////////////////////////////////////////////////////////////
18118
18119 .chapter "Generic options for routers" "CHAProutergeneric"
18120 .scindex IIDgenoprou1 "options" "generic; for routers"
18121 .scindex IIDgenoprou2 "generic options" "router"
18122 This chapter describes the generic options that apply to all routers.
18123 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18124
18125 For a general description of how a router operates, see sections
18126 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18127 which the preconditions are tested. The order of expansion of the options that
18128 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18129 &%headers_remove%&, &%transport%&.
18130
18131
18132
18133 .option address_data routers string&!! unset
18134 .cindex "router" "data attached to address"
18135 The string is expanded just before the router is run, that is, after all the
18136 precondition tests have succeeded. If the expansion is forced to fail, the
18137 router declines, the value of &%address_data%& remains unchanged, and the
18138 &%more%& option controls what happens next. Other expansion failures cause
18139 delivery of the address to be deferred.
18140
18141 .vindex "&$address_data$&"
18142 When the expansion succeeds, the value is retained with the address, and can be
18143 accessed using the variable &$address_data$& in the current router, subsequent
18144 routers, and the eventual transport.
18145
18146 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18147 that runs a user's filter file, the contents of &$address_data$& are accessible
18148 in the filter. This is not normally a problem, because such data is usually
18149 either not confidential or it &"belongs"& to the current user, but if you do
18150 put confidential data into &$address_data$& you need to remember this point.
18151
18152 Even if the router declines or passes, the value of &$address_data$& remains
18153 with the address, though it can be changed by another &%address_data%& setting
18154 on a subsequent router. If a router generates child addresses, the value of
18155 &$address_data$& propagates to them. This also applies to the special kind of
18156 &"child"& that is generated by a router with the &%unseen%& option.
18157
18158 The idea of &%address_data%& is that you can use it to look up a lot of data
18159 for the address once, and then pick out parts of the data later. For example,
18160 you could use a single LDAP lookup to return a string of the form
18161 .code
18162 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18163 .endd
18164 In the transport you could pick out the mailbox by a setting such as
18165 .code
18166 file = ${extract{mailbox}{$address_data}}
18167 .endd
18168 This makes the configuration file less messy, and also reduces the number of
18169 lookups (though Exim does cache lookups).
18170
18171 .new
18172 See also the &%set%& option below.
18173 .wen
18174
18175 .vindex "&$sender_address_data$&"
18176 .vindex "&$address_data$&"
18177 The &%address_data%& facility is also useful as a means of passing information
18178 from one router to another, and from a router to a transport. In addition, if
18179 &$address_data$& is set by a router when verifying a recipient address from an
18180 ACL, it remains available for use in the rest of the ACL statement. After
18181 verifying a sender, the value is transferred to &$sender_address_data$&.
18182
18183
18184
18185 .option address_test routers&!? boolean true
18186 .oindex "&%-bt%&"
18187 .cindex "router" "skipping when address testing"
18188 If this option is set false, the router is skipped when routing is being tested
18189 by means of the &%-bt%& command line option. This can be a convenience when
18190 your first router sends messages to an external scanner, because it saves you
18191 having to set the &"already scanned"& indicator when testing real address
18192 routing.
18193
18194
18195
18196 .option cannot_route_message routers string&!! unset
18197 .cindex "router" "customizing &""cannot route""& message"
18198 .cindex "customizing" "&""cannot route""& message"
18199 This option specifies a text message that is used when an address cannot be
18200 routed because Exim has run out of routers. The default message is
18201 &"Unrouteable address"&. This option is useful only on routers that have
18202 &%more%& set false, or on the very last router in a configuration, because the
18203 value that is used is taken from the last router that is considered. This
18204 includes a router that is skipped because its preconditions are not met, as
18205 well as a router that declines. For example, using the default configuration,
18206 you could put:
18207 .code
18208 cannot_route_message = Remote domain not found in DNS
18209 .endd
18210 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18211 and
18212 .code
18213 cannot_route_message = Unknown local user
18214 .endd
18215 on the final router that checks for local users. If string expansion fails for
18216 this option, the default message is used. Unless the expansion failure was
18217 explicitly forced, a message about the failure is written to the main and panic
18218 logs, in addition to the normal message about the routing failure.
18219
18220
18221 .option caseful_local_part routers boolean false
18222 .cindex "case of local parts"
18223 .cindex "router" "case of local parts"
18224 By default, routers handle the local parts of addresses in a case-insensitive
18225 manner, though the actual case is preserved for transmission with the message.
18226 If you want the case of letters to be significant in a router, you must set
18227 this option true. For individual router options that contain address or local
18228 part lists (for example, &%local_parts%&), case-sensitive matching can be
18229 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18230 more details.
18231
18232 .vindex "&$local_part$&"
18233 .vindex "&$original_local_part$&"
18234 .vindex "&$parent_local_part$&"
18235 The value of the &$local_part$& variable is forced to lower case while a
18236 router is running unless &%caseful_local_part%& is set. When a router assigns
18237 an address to a transport, the value of &$local_part$& when the transport runs
18238 is the same as it was in the router. Similarly, when a router generates child
18239 addresses by aliasing or forwarding, the values of &$original_local_part$&
18240 and &$parent_local_part$& are those that were used by the redirecting router.
18241
18242 This option applies to the processing of an address by a router. When a
18243 recipient address is being processed in an ACL, there is a separate &%control%&
18244 modifier that can be used to specify case-sensitive processing within the ACL
18245 (see section &<<SECTcontrols>>&).
18246
18247
18248
18249 .option check_local_user routers&!? boolean false
18250 .cindex "local user, checking in router"
18251 .cindex "router" "checking for local user"
18252 .cindex "&_/etc/passwd_&"
18253 .vindex "&$home$&"
18254 When this option is true, Exim checks that the local part of the recipient
18255 address (with affixes removed if relevant) is the name of an account on the
18256 local system. The check is done by calling the &[getpwnam()]& function rather
18257 than trying to read &_/etc/passwd_& directly. This means that other methods of
18258 holding password data (such as NIS) are supported. If the local part is a local
18259 user, &$home$& is set from the password data, and can be tested in other
18260 preconditions that are evaluated after this one (the order of evaluation is
18261 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18262 overridden by &%router_home_directory%&. If the local part is not a local user,
18263 the router is skipped.
18264
18265 If you want to check that the local part is either the name of a local user
18266 or matches something else, you cannot combine &%check_local_user%& with a
18267 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18268 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18269 setting to achieve this. For example:
18270 .code
18271 local_parts = passwd;$local_part : lsearch;/etc/other/users
18272 .endd
18273 Note, however, that the side effects of &%check_local_user%& (such as setting
18274 up a home directory) do not occur when a &(passwd)& lookup is used in a
18275 &%local_parts%& (or any other) precondition.
18276
18277
18278
18279 .option condition routers&!? string&!! unset
18280 .cindex "router" "customized precondition"
18281 This option specifies a general precondition test that has to succeed for the
18282 router to be called. The &%condition%& option is the last precondition to be
18283 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18284 result is a forced failure, or an empty string, or one of the strings &"0"& or
18285 &"no"& or &"false"& (checked without regard to the case of the letters), the
18286 router is skipped, and the address is offered to the next one.
18287
18288 If the result is any other value, the router is run (as this is the last
18289 precondition to be evaluated, all the other preconditions must be true).
18290
18291 This option is unusual in that multiple &%condition%& options may be present.
18292 All &%condition%& options must succeed.
18293
18294 The &%condition%& option provides a means of applying custom conditions to the
18295 running of routers. Note that in the case of a simple conditional expansion,
18296 the default expansion values are exactly what is wanted. For example:
18297 .code
18298 condition = ${if >{$message_age}{600}}
18299 .endd
18300 Because of the default behaviour of the string expansion, this is equivalent to
18301 .code
18302 condition = ${if >{$message_age}{600}{true}{}}
18303 .endd
18304
18305 A multiple condition example, which succeeds:
18306 .code
18307 condition = ${if >{$message_age}{600}}
18308 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18309 condition = foobar
18310 .endd
18311
18312 If the expansion fails (other than forced failure) delivery is deferred. Some
18313 of the other precondition options are common special cases that could in fact
18314 be specified using &%condition%&.
18315
18316 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18317 are far older, and use one set of semantics.  ACLs are newer and when
18318 they were created, the ACL &%condition%& process was given far stricter
18319 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18320 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18321 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18322 Router rules processing behavior.
18323
18324 This is best illustrated in an example:
18325 .code
18326 # If used in an ACL condition will fail with a syntax error, but
18327 # in a router condition any extra characters are treated as a string
18328
18329 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18330 true {yes} {no}}
18331
18332 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18333  {yes} {no}}
18334 .endd
18335 In each example above, the &%if%& statement actually ends after
18336 &"{google.com}}"&.  Since no true or false braces were defined, the
18337 default &%if%& behavior is to return a boolean true or a null answer
18338 (which evaluates to false). The rest of the line is then treated as a
18339 string. So the first example resulted in the boolean answer &"true"&
18340 with the string &" {yes} {no}}"& appended to it. The second example
18341 resulted in the null output (indicating false) with the string
18342 &" {yes} {no}}"& appended to it.
18343
18344 In fact you can put excess forward braces in too.  In the router
18345 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18346 mean something, like after a &"$"& or when required as part of a
18347 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18348 string characters.
18349
18350 Thus, in a Router, the above expansion strings will both always evaluate
18351 true, as the result of expansion is a non-empty string which doesn't
18352 match an explicit false value.  This can be tricky to debug.  By
18353 contrast, in an ACL either of those strings will always result in an
18354 expansion error because the result doesn't look sufficiently boolean.
18355
18356
18357 .option debug_print routers string&!! unset
18358 .cindex "testing" "variables in drivers"
18359 If this option is set and debugging is enabled (see the &%-d%& command line
18360 option) or in address-testing mode (see the &%-bt%& command line option),
18361 the string is expanded and included in the debugging output.
18362 If expansion of the string fails, the error message is written to the debugging
18363 output, and Exim carries on processing.
18364 This option is provided to help with checking out the values of variables and
18365 so on when debugging router configurations. For example, if a &%condition%&
18366 option appears not to be working, &%debug_print%& can be used to output the
18367 variables it references. The output happens after checks for &%domains%&,
18368 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18369 are tested. A newline is added to the text if it does not end with one.
18370 The variable &$router_name$& contains the name of the router.
18371
18372
18373
18374 .option disable_logging routers boolean false
18375 If this option is set true, nothing is logged for any routing errors
18376 or for any deliveries caused by this router. You should not set this option
18377 unless you really, really know what you are doing. See also the generic
18378 transport option of the same name.
18379
18380 .option dnssec_request_domains routers "domain list&!!" unset
18381 .cindex "MX record" "security"
18382 .cindex "DNSSEC" "MX lookup"
18383 .cindex "security" "MX lookup"
18384 .cindex "DNS" "DNSSEC"
18385 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18386 the dnssec request bit set.
18387 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18388
18389 .option dnssec_require_domains routers "domain list&!!" unset
18390 .cindex "MX record" "security"
18391 .cindex "DNSSEC" "MX lookup"
18392 .cindex "security" "MX lookup"
18393 .cindex "DNS" "DNSSEC"
18394 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18395 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18396 (AD bit) set will be ignored and logged as a host-lookup failure.
18397 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18398
18399
18400 .option domains routers&!? "domain list&!!" unset
18401 .cindex "router" "restricting to specific domains"
18402 .vindex "&$domain_data$&"
18403 If this option is set, the router is skipped unless the current domain matches
18404 the list. If the match is achieved by means of a file lookup, the data that the
18405 lookup returned for the domain is placed in &$domain_data$& for use in string
18406 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18407 a list of the order in which preconditions are evaluated.
18408
18409
18410
18411 .option driver routers string unset
18412 This option must always be set. It specifies which of the available routers is
18413 to be used.
18414
18415
18416 .option dsn_lasthop routers boolean false
18417 .cindex "DSN" "success"
18418 .cindex "Delivery Status Notification" "success"
18419 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18420 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18421 instead send a success DSN as if the next hop does not support DSN.
18422 Not effective on redirect routers.
18423
18424
18425
18426 .option errors_to routers string&!! unset
18427 .cindex "envelope from"
18428 .cindex "envelope sender"
18429 .cindex "router" "changing address for errors"
18430 If a router successfully handles an address, it may assign the address to a
18431 transport for delivery or it may generate child addresses. In both cases, if
18432 there is a delivery problem during later processing, the resulting bounce
18433 message is sent to the address that results from expanding this string,
18434 provided that the address verifies successfully. The &%errors_to%& option is
18435 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18436
18437 The &%errors_to%& setting associated with an address can be overridden if it
18438 subsequently passes through other routers that have their own &%errors_to%&
18439 settings, or if the message is delivered by a transport with a &%return_path%&
18440 setting.
18441
18442 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18443 the expansion fails to verify, the errors address associated with the incoming
18444 address is used. At top level, this is the envelope sender. A non-forced
18445 expansion failure causes delivery to be deferred.
18446
18447 If an address for which &%errors_to%& has been set ends up being delivered over
18448 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18449 any bounces that are generated by other MTAs on the delivery route are also
18450 sent there. You can set &%errors_to%& to the empty string by either of these
18451 settings:
18452 .code
18453 errors_to =
18454 errors_to = ""
18455 .endd
18456 An expansion item that yields an empty string has the same effect. If you do
18457 this, a locally detected delivery error for addresses processed by this router
18458 no longer gives rise to a bounce message; the error is discarded. If the
18459 address is delivered to a remote host, the return path is set to &`<>`&, unless
18460 overridden by the &%return_path%& option on the transport.
18461
18462 .vindex "&$address_data$&"
18463 If for some reason you want to discard local errors, but use a non-empty
18464 MAIL command for remote delivery, you can preserve the original return
18465 path in &$address_data$& in the router, and reinstate it in the transport by
18466 setting &%return_path%&.
18467
18468 The most common use of &%errors_to%& is to direct mailing list bounces to the
18469 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18470 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18471
18472
18473
18474 .option expn routers&!? boolean true
18475 .cindex "address" "testing"
18476 .cindex "testing" "addresses"
18477 .cindex "EXPN" "router skipping"
18478 .cindex "router" "skipping for EXPN"
18479 If this option is turned off, the router is skipped when testing an address
18480 as a result of processing an SMTP EXPN command. You might, for example,
18481 want to turn it off on a router for users' &_.forward_& files, while leaving it
18482 on for the system alias file.
18483 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18484 are evaluated.
18485
18486 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18487 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18488 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18489
18490
18491
18492 .option fail_verify routers boolean false
18493 .cindex "router" "forcing verification failure"
18494 Setting this option has the effect of setting both &%fail_verify_sender%& and
18495 &%fail_verify_recipient%& to the same value.
18496
18497
18498
18499 .option fail_verify_recipient routers boolean false
18500 If this option is true and an address is accepted by this router when
18501 verifying a recipient, verification fails.
18502
18503
18504
18505 .option fail_verify_sender routers boolean false
18506 If this option is true and an address is accepted by this router when
18507 verifying a sender, verification fails.
18508
18509
18510
18511 .option fallback_hosts routers "string list" unset
18512 .cindex "router" "fallback hosts"
18513 .cindex "fallback" "hosts specified on router"
18514 String expansion is not applied to this option. The argument must be a
18515 colon-separated list of host names or IP addresses. The list separator can be
18516 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18517 each name or address. In fact, the format of each item is exactly the same as
18518 defined for the list of hosts in a &(manualroute)& router (see section
18519 &<<SECTformatonehostitem>>&).
18520
18521 If a router queues an address for a remote transport, this host list is
18522 associated with the address, and used instead of the transport's fallback host
18523 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18524 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18525 transport for further details.
18526
18527
18528 .option group routers string&!! "see below"
18529 .cindex "gid (group id)" "local delivery"
18530 .cindex "local transports" "uid and gid"
18531 .cindex "transport" "local"
18532 .cindex "router" "setting group"
18533 When a router queues an address for a transport, and the transport does not
18534 specify a group, the group given here is used when running the delivery
18535 process.
18536 The group may be specified numerically or by name. If expansion fails, the
18537 error is logged and delivery is deferred.
18538 The default is unset, unless &%check_local_user%& is set, when the default
18539 is taken from the password information. See also &%initgroups%& and &%user%&
18540 and the discussion in chapter &<<CHAPenvironment>>&.
18541
18542
18543
18544 .option headers_add routers list&!! unset
18545 .cindex "header lines" "adding"
18546 .cindex "router" "adding header lines"
18547 This option specifies a list of text headers,
18548 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18549 that is associated with any addresses that are accepted by the router.
18550 Each item is separately expanded, at routing time.  However, this
18551 option has no effect when an address is just being verified. The way in which
18552 the text is used to add header lines at transport time is described in section
18553 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18554 message is in the process of being transported. This means that references to
18555 header lines in string expansions in the transport's configuration do not
18556 &"see"& the added header lines.
18557
18558 The &%headers_add%& option is expanded after &%errors_to%&, but before
18559 &%headers_remove%& and &%transport%&. If an item is empty, or if
18560 an item expansion is forced to fail, the item has no effect. Other expansion
18561 failures are treated as configuration errors.
18562
18563 Unlike most options, &%headers_add%& can be specified multiple times
18564 for a router; all listed headers are added.
18565
18566 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18567 router that has the &%one_time%& option set.
18568
18569 .cindex "duplicate addresses"
18570 .oindex "&%unseen%&"
18571 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18572 additions are deleted when the address is passed on to subsequent routers.
18573 For a &%redirect%& router, if a generated address is the same as the incoming
18574 address, this can lead to duplicate addresses with different header
18575 modifications. Exim does not do duplicate deliveries (except, in certain
18576 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18577 which of the duplicates is discarded, so this ambiguous situation should be
18578 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18579
18580
18581
18582 .option headers_remove routers list&!! unset
18583 .cindex "header lines" "removing"
18584 .cindex "router" "removing header lines"
18585 This option specifies a list of text headers,
18586 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18587 that is associated with any addresses that are accepted by the router.
18588 Each item is separately expanded, at routing time.  However, this
18589 option has no effect when an address is just being verified. The way in which
18590 the text is used to remove header lines at transport time is described in
18591 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18592 the message is in the process of being transported. This means that references
18593 to header lines in string expansions in the transport's configuration still
18594 &"see"& the original header lines.
18595
18596 The &%headers_remove%& option is expanded after &%errors_to%& and
18597 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18598 the item has no effect. Other expansion failures are treated as configuration
18599 errors.
18600
18601 Unlike most options, &%headers_remove%& can be specified multiple times
18602 for a router; all listed headers are removed.
18603
18604 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18605 router that has the &%one_time%& option set.
18606
18607 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18608 removal requests are deleted when the address is passed on to subsequent
18609 routers, and this can lead to problems with duplicates -- see the similar
18610 warning for &%headers_add%& above.
18611
18612 &*Warning 3*&: Because of the separate expansion of the list items,
18613 items that contain a list separator must have it doubled.
18614 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18615
18616
18617
18618 .option ignore_target_hosts routers "host list&!!" unset
18619 .cindex "IP address" "discarding"
18620 .cindex "router" "discarding IP addresses"
18621 Although this option is a host list, it should normally contain IP address
18622 entries rather than names. If any host that is looked up by the router has an
18623 IP address that matches an item in this list, Exim behaves as if that IP
18624 address did not exist. This option allows you to cope with rogue DNS entries
18625 like
18626 .code
18627 remote.domain.example.  A  127.0.0.1
18628 .endd
18629 by setting
18630 .code
18631 ignore_target_hosts = 127.0.0.1
18632 .endd
18633 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18634 discarded in this way, the router declines. In a conventional configuration, an
18635 attempt to mail to such a domain would normally provoke the &"unrouteable
18636 domain"& error, and an attempt to verify an address in the domain would fail.
18637 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18638 router declines if presented with one of the listed addresses.
18639
18640 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18641 means of the first or the second of the following settings, respectively:
18642 .code
18643 ignore_target_hosts = 0.0.0.0/0
18644 ignore_target_hosts = <; 0::0/0
18645 .endd
18646 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18647 in the second line matches all IPv6 addresses.
18648
18649 This option may also be useful for ignoring link-local and site-local IPv6
18650 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18651 is expanded before use as a list, it is possible to make it dependent on the
18652 domain that is being routed.
18653
18654 .vindex "&$host_address$&"
18655 During its expansion, &$host_address$& is set to the IP address that is being
18656 checked.
18657
18658 .option initgroups routers boolean false
18659 .cindex "additional groups"
18660 .cindex "groups" "additional"
18661 .cindex "local transports" "uid and gid"
18662 .cindex "transport" "local"
18663 If the router queues an address for a transport, and this option is true, and
18664 the uid supplied by the router is not overridden by the transport, the
18665 &[initgroups()]& function is called when running the transport to ensure that
18666 any additional groups associated with the uid are set up. See also &%group%&
18667 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18668
18669
18670
18671 .option local_part_prefix routers&!? "string list" unset
18672 .cindex affix "router precondition"
18673 .cindex "router" "prefix for local part"
18674 .cindex "prefix" "for local part, used in router"
18675 If this option is set, the router is skipped unless the local part starts with
18676 one of the given strings, or &%local_part_prefix_optional%& is true. See
18677 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18678 evaluated.
18679
18680 The list is scanned from left to right, and the first prefix that matches is
18681 used. A limited form of wildcard is available; if the prefix begins with an
18682 asterisk, it matches the longest possible sequence of arbitrary characters at
18683 the start of the local part. An asterisk should therefore always be followed by
18684 some character that does not occur in normal local parts.
18685 .cindex "multiple mailboxes"
18686 .cindex "mailbox" "multiple"
18687 Wildcarding can be used to set up multiple user mailboxes, as described in
18688 section &<<SECTmulbox>>&.
18689
18690 .vindex "&$local_part$&"
18691 .vindex "&$local_part_prefix$&"
18692 During the testing of the &%local_parts%& option, and while the router is
18693 running, the prefix is removed from the local part, and is available in the
18694 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18695 the router accepts the address, this remains true during subsequent delivery by
18696 a transport. In particular, the local part that is transmitted in the RCPT
18697 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18698 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18699 the relevant transport.
18700
18701 When an address is being verified, &%local_part_prefix%& affects only the
18702 behaviour of the router. If the callout feature of verification is in use, this
18703 means that the full address, including the prefix, will be used during the
18704 callout.
18705
18706 The prefix facility is commonly used to handle local parts of the form
18707 &%owner-something%&. Another common use is to support local parts of the form
18708 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18709 to tell a user their forwarding is broken &-- by placing a router like this one
18710 immediately before the router that handles &_.forward_& files:
18711 .code
18712 real_localuser:
18713   driver = accept
18714   local_part_prefix = real-
18715   check_local_user
18716   transport = local_delivery
18717 .endd
18718 For security, it would probably be a good idea to restrict the use of this
18719 router to locally-generated messages, using a condition such as this:
18720 .code
18721   condition = ${if match {$sender_host_address}\
18722                          {\N^(|127\.0\.0\.1)$\N}}
18723 .endd
18724
18725 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18726 both conditions must be met if not optional. Care must be taken if wildcards
18727 are used in both a prefix and a suffix on the same router. Different
18728 separator characters must be used to avoid ambiguity.
18729
18730
18731 .option local_part_prefix_optional routers boolean false
18732 See &%local_part_prefix%& above.
18733
18734
18735
18736 .option local_part_suffix routers&!? "string list" unset
18737 .cindex "router" "suffix for local part"
18738 .cindex "suffix for local part" "used in router"
18739 This option operates in the same way as &%local_part_prefix%&, except that the
18740 local part must end (rather than start) with the given string, the
18741 &%local_part_suffix_optional%& option determines whether the suffix is
18742 mandatory, and the wildcard * character, if present, must be the last
18743 character of the suffix. This option facility is commonly used to handle local
18744 parts of the form &%something-request%& and multiple user mailboxes of the form
18745 &%username-foo%&.
18746
18747
18748 .option local_part_suffix_optional routers boolean false
18749 See &%local_part_suffix%& above.
18750
18751
18752
18753 .option local_parts routers&!? "local part list&!!" unset
18754 .cindex "router" "restricting to specific local parts"
18755 .cindex "local part" "checking in router"
18756 The router is run only if the local part of the address matches the list.
18757 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18758 are evaluated, and
18759 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18760 string is expanded, it is possible to make it depend on the domain, for
18761 example:
18762 .code
18763 local_parts = dbm;/usr/local/specials/$domain
18764 .endd
18765 .vindex "&$local_part_data$&"
18766 If the match is achieved by a lookup, the data that the lookup returned
18767 for the local part is placed in the variable &$local_part_data$& for use in
18768 expansions of the router's private options. You might use this option, for
18769 example, if you have a large number of local virtual domains, and you want to
18770 send all postmaster mail to the same place without having to set up an alias in
18771 each virtual domain:
18772 .code
18773 postmaster:
18774   driver = redirect
18775   local_parts = postmaster
18776   data = postmaster@real.domain.example
18777 .endd
18778
18779
18780 .option log_as_local routers boolean "see below"
18781 .cindex "log" "delivery line"
18782 .cindex "delivery" "log line format"
18783 Exim has two logging styles for delivery, the idea being to make local
18784 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18785 recipient address is given just as the local part, without a domain. The use of
18786 this style is controlled by this option. It defaults to true for the &(accept)&
18787 router, and false for all the others. This option applies only when a
18788 router assigns an address to a transport. It has no effect on routers that
18789 redirect addresses.
18790
18791
18792
18793 .option more routers boolean&!! true
18794 The result of string expansion for this option must be a valid boolean value,
18795 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18796 result causes an error, and delivery is deferred. If the expansion is forced to
18797 fail, the default value for the option (true) is used. Other failures cause
18798 delivery to be deferred.
18799
18800 If this option is set false, and the router declines to handle the address, no
18801 further routers are tried, routing fails, and the address is bounced.
18802 .oindex "&%self%&"
18803 However, if the router explicitly passes an address to the following router by
18804 means of the setting
18805 .code
18806 self = pass
18807 .endd
18808 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18809 does not affect the behaviour if one of the precondition tests fails. In that
18810 case, the address is always passed to the next router.
18811
18812 Note that &%address_data%& is not considered to be a precondition. If its
18813 expansion is forced to fail, the router declines, and the value of &%more%&
18814 controls what happens next.
18815
18816
18817 .option pass_on_timeout routers boolean false
18818 .cindex "timeout" "of router"
18819 .cindex "router" "timeout"
18820 If a router times out during a host lookup, it normally causes deferral of the
18821 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18822 router, overriding &%no_more%&. This may be helpful for systems that are
18823 intermittently connected to the Internet, or those that want to pass to a smart
18824 host any messages that cannot immediately be delivered.
18825
18826 There are occasional other temporary errors that can occur while doing DNS
18827 lookups. They are treated in the same way as a timeout, and this option
18828 applies to all of them.
18829
18830
18831
18832 .option pass_router routers string unset
18833 .cindex "router" "go to after &""pass""&"
18834 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18835 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18836 routing to continue, and overriding a false setting of &%more%&. When one of
18837 these routers returns &"pass"&, the address is normally handed on to the next
18838 router in sequence. This can be changed by setting &%pass_router%& to the name
18839 of another router. However (unlike &%redirect_router%&) the named router must
18840 be below the current router, to avoid loops. Note that this option applies only
18841 to the special case of &"pass"&. It does not apply when a router returns
18842 &"decline"& because it cannot handle an address.
18843
18844
18845
18846 .option redirect_router routers string unset
18847 .cindex "router" "start at after redirection"
18848 Sometimes an administrator knows that it is pointless to reprocess addresses
18849 generated from alias or forward files with the same router again. For
18850 example, if an alias file translates real names into login ids there is no
18851 point searching the alias file a second time, especially if it is a large file.
18852
18853 The &%redirect_router%& option can be set to the name of any router instance.
18854 It causes the routing of any generated addresses to start at the named router
18855 instead of at the first router. This option has no effect if the router in
18856 which it is set does not generate new addresses.
18857
18858
18859
18860 .option require_files routers&!? "string list&!!" unset
18861 .cindex "file" "requiring for router"
18862 .cindex "router" "requiring file existence"
18863 This option provides a general mechanism for predicating the running of a
18864 router on the existence or non-existence of certain files or directories.
18865 Before running a router, as one of its precondition tests, Exim works its way
18866 through the &%require_files%& list, expanding each item separately.
18867
18868 Because the list is split before expansion, any colons in expansion items must
18869 be doubled, or the facility for using a different list separator must be used
18870 (&<<SECTlistsepchange>>&).
18871 If any expansion is forced to fail, the item is ignored. Other expansion
18872 failures cause routing of the address to be deferred.
18873
18874 If any expanded string is empty, it is ignored. Otherwise, except as described
18875 below, each string must be a fully qualified file path, optionally preceded by
18876 &"!"&. The paths are passed to the &[stat()]& function to test for the
18877 existence of the files or directories. The router is skipped if any paths not
18878 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18879
18880 .cindex "NFS"
18881 If &[stat()]& cannot determine whether a file exists or not, delivery of
18882 the message is deferred. This can happen when NFS-mounted filesystems are
18883 unavailable.
18884
18885 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18886 options, so you cannot use it to check for the existence of a file in which to
18887 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18888 full list of the order in which preconditions are evaluated.) However, as
18889 these options are all expanded, you can use the &%exists%& expansion condition
18890 to make such tests. The &%require_files%& option is intended for checking files
18891 that the router may be going to use internally, or which are needed by a
18892 transport (e.g., &_.procmailrc_&).
18893
18894 During delivery, the &[stat()]& function is run as root, but there is a
18895 facility for some checking of the accessibility of a file by another user.
18896 This is not a proper permissions check, but just a &"rough"& check that
18897 operates as follows:
18898
18899 If an item in a &%require_files%& list does not contain any forward slash
18900 characters, it is taken to be the user (and optional group, separated by a
18901 comma) to be checked for subsequent files in the list. If no group is specified
18902 but the user is specified symbolically, the gid associated with the uid is
18903 used. For example:
18904 .code
18905 require_files = mail:/some/file
18906 require_files = $local_part:$home/.procmailrc
18907 .endd
18908 If a user or group name in a &%require_files%& list does not exist, the
18909 &%require_files%& condition fails.
18910
18911 Exim performs the check by scanning along the components of the file path, and
18912 checking the access for the given uid and gid. It checks for &"x"& access on
18913 directories, and &"r"& access on the final file. Note that this means that file
18914 access control lists, if the operating system has them, are ignored.
18915
18916 &*Warning 1*&: When the router is being run to verify addresses for an
18917 incoming SMTP message, Exim is not running as root, but under its own uid. This
18918 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18919 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18920 user is not permitted to read one of the directories on the file's path.
18921
18922 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18923 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18924 without root access. In this case, if a check for access by a particular user
18925 is requested, Exim creates a subprocess that runs as that user, and tries the
18926 check again in that process.
18927
18928 The default action for handling an unresolved EACCES is to consider it to
18929 be caused by a configuration error, and routing is deferred because the
18930 existence or non-existence of the file cannot be determined. However, in some
18931 circumstances it may be desirable to treat this condition as if the file did
18932 not exist. If the filename (or the exclamation mark that precedes the filename
18933 for non-existence) is preceded by a plus sign, the EACCES error is treated
18934 as if the file did not exist. For example:
18935 .code
18936 require_files = +/some/file
18937 .endd
18938 If the router is not an essential part of verification (for example, it
18939 handles users' &_.forward_& files), another solution is to set the &%verify%&
18940 option false so that the router is skipped when verifying.
18941
18942
18943
18944 .option retry_use_local_part routers boolean "see below"
18945 .cindex "hints database" "retry keys"
18946 .cindex "local part" "in retry keys"
18947 When a delivery suffers a temporary routing failure, a retry record is created
18948 in Exim's hints database. For addresses whose routing depends only on the
18949 domain, the key for the retry record should not involve the local part, but for
18950 other addresses, both the domain and the local part should be included.
18951 Usually, remote routing is of the former kind, and local routing is of the
18952 latter kind.
18953
18954 This option controls whether the local part is used to form the key for retry
18955 hints for addresses that suffer temporary errors while being handled by this
18956 .new
18957 router. The default value is true for any router that has any of
18958 &%check_local_user%&,
18959 &%local_parts%&,
18960 &%condition%&,
18961 &%local_part_prefix%&,
18962 &%local_part_suffix%&,
18963 &%senders%& or
18964 &%require_files%&
18965 .wen
18966 set, and false otherwise. Note that this option does not apply to hints keys
18967 for transport delays; they are controlled by a generic transport option of the
18968 same name.
18969
18970 Failing to set this option when it is needed
18971 (because a remote router handles only some of the local-parts for a domain)
18972 can result in incorrect error messages being generated.
18973
18974 The setting of &%retry_use_local_part%& applies only to the router on which it
18975 appears. If the router generates child addresses, they are routed
18976 independently; this setting does not become attached to them.
18977
18978
18979
18980 .option router_home_directory routers string&!! unset
18981 .cindex "router" "home directory for"
18982 .cindex "home directory" "for router"
18983 .vindex "&$home$&"
18984 This option sets a home directory for use while the router is running. (Compare
18985 &%transport_home_directory%&, which sets a home directory for later
18986 transporting.) In particular, if used on a &(redirect)& router, this option
18987 sets a value for &$home$& while a filter is running. The value is expanded;
18988 forced expansion failure causes the option to be ignored &-- other failures
18989 cause the router to defer.
18990
18991 Expansion of &%router_home_directory%& happens immediately after the
18992 &%check_local_user%& test (if configured), before any further expansions take
18993 place.
18994 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18995 are evaluated.)
18996 While the router is running, &%router_home_directory%& overrides the value of
18997 &$home$& that came from &%check_local_user%&.
18998
18999 When a router accepts an address and assigns it to a local transport (including
19000 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19001 delivery), the home directory setting for the transport is taken from the first
19002 of these values that is set:
19003
19004 .ilist
19005 The &%home_directory%& option on the transport;
19006 .next
19007 The &%transport_home_directory%& option on the router;
19008 .next
19009 The password data if &%check_local_user%& is set on the router;
19010 .next
19011 The &%router_home_directory%& option on the router.
19012 .endlist
19013
19014 In other words, &%router_home_directory%& overrides the password data for the
19015 router, but not for the transport.
19016
19017
19018
19019 .option self routers string freeze
19020 .cindex "MX record" "pointing to local host"
19021 .cindex "local host" "MX pointing to"
19022 This option applies to those routers that use a recipient address to find a
19023 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19024 and &(manualroute)& routers.
19025 Certain configurations of the &(queryprogram)& router can also specify a list
19026 of remote hosts.
19027 Usually such routers are configured to send the message to a remote host via an
19028 &(smtp)& transport. The &%self%& option specifies what happens when the first
19029 host on the list turns out to be the local host.
19030 The way in which Exim checks for the local host is described in section
19031 &<<SECTreclocipadd>>&.
19032
19033 Normally this situation indicates either an error in Exim's configuration (for
19034 example, the router should be configured not to process this domain), or an
19035 error in the DNS (for example, the MX should not point to this host). For this
19036 reason, the default action is to log the incident, defer the address, and
19037 freeze the message. The following alternatives are provided for use in special
19038 cases:
19039
19040 .vlist
19041 .vitem &%defer%&
19042 Delivery of the message is tried again later, but the message is not frozen.
19043
19044 .vitem "&%reroute%&: <&'domain'&>"
19045 The domain is changed to the given domain, and the address is passed back to
19046 be reprocessed by the routers. No rewriting of headers takes place. This
19047 behaviour is essentially a redirection.
19048
19049 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19050 The domain is changed to the given domain, and the address is passed back to be
19051 reprocessed by the routers. Any headers that contain the original domain are
19052 rewritten.
19053
19054 .vitem &%pass%&
19055 .oindex "&%more%&"
19056 .vindex "&$self_hostname$&"
19057 The router passes the address to the next router, or to the router named in the
19058 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19059 subsequent routing and delivery, the variable &$self_hostname$& contains the
19060 name of the local host that the router encountered. This can be used to
19061 distinguish between different cases for hosts with multiple names. The
19062 combination
19063 .code
19064 self = pass
19065 no_more
19066 .endd
19067 ensures that only those addresses that routed to the local host are passed on.
19068 Without &%no_more%&, addresses that were declined for other reasons would also
19069 be passed to the next router.
19070
19071 .vitem &%fail%&
19072 Delivery fails and an error report is generated.
19073
19074 .vitem &%send%&
19075 .cindex "local host" "sending to"
19076 The anomaly is ignored and the address is queued for the transport. This
19077 setting should be used with extreme caution. For an &(smtp)& transport, it
19078 makes sense only in cases where the program that is listening on the SMTP port
19079 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19080 different configuration file that handles the domain in another way.
19081 .endlist
19082
19083
19084
19085 .option senders routers&!? "address list&!!" unset
19086 .cindex "router" "checking senders"
19087 If this option is set, the router is skipped unless the message's sender
19088 address matches something on the list.
19089 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19090 are evaluated.
19091
19092 There are issues concerning verification when the running of routers is
19093 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19094 setting, it sets the sender to the null string. When using the &%-bt%& option
19095 to check a configuration file, it is necessary also to use the &%-f%& option to
19096 set an appropriate sender. For incoming mail, the sender is unset when
19097 verifying the sender, but is available when verifying any recipients. If the
19098 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19099 matters.
19100
19101
19102 .new
19103 .option set routers "string list" unset
19104 .cindex router variables
19105 This option may be used multiple times on a router;
19106 because of this the list aspect is mostly irrelevant.
19107 The list separator is a semicolon but can be changed in the
19108 usual way.
19109
19110 Each list-element given must be of the form $"name = value"$
19111 and the names used must start with the string &"r_"&.
19112 Values containing a list-separator should have them doubled.
19113 When a router runs, the strings are evaluated in order,
19114 to create variables which are added to the set associated with
19115 the address.
19116 The variable is set with the expansion of the value.
19117 The variables can be used by the router options
19118 (not including any preconditions)
19119 and by the transport.
19120 Later definitions of a given named variable will override former ones.
19121 Varible use is via the usual &$r_...$& syntax.
19122
19123 This is similar to the &%address_data%& option, except that
19124 many independent variables can be used, with choice of naming.
19125 .wen
19126
19127
19128 .option translate_ip_address routers string&!! unset
19129 .cindex "IP address" "translating"
19130 .cindex "packet radio"
19131 .cindex "router" "IP address translation"
19132 There exist some rare networking situations (for example, packet radio) where
19133 it is helpful to be able to translate IP addresses generated by normal routing
19134 mechanisms into other IP addresses, thus performing a kind of manual IP
19135 routing. This should be done only if the normal IP routing of the TCP/IP stack
19136 is inadequate or broken. Because this is an extremely uncommon requirement, the
19137 code to support this option is not included in the Exim binary unless
19138 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19139
19140 .vindex "&$host_address$&"
19141 The &%translate_ip_address%& string is expanded for every IP address generated
19142 by the router, with the generated address set in &$host_address$&. If the
19143 expansion is forced to fail, no action is taken.
19144 For any other expansion error, delivery of the message is deferred.
19145 If the result of the expansion is an IP address, that replaces the original
19146 address; otherwise the result is assumed to be a host name &-- this is looked
19147 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19148 produce one or more replacement IP addresses. For example, to subvert all IP
19149 addresses in some specific networks, this could be added to a router:
19150 .code
19151 translate_ip_address = \
19152   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19153     {$value}fail}}
19154 .endd
19155 The file would contain lines like
19156 .code
19157 10.2.3.128/26    some.host
19158 10.8.4.34/26     10.44.8.15
19159 .endd
19160 You should not make use of this facility unless you really understand what you
19161 are doing.
19162
19163
19164
19165 .option transport routers string&!! unset
19166 This option specifies the transport to be used when a router accepts an address
19167 and sets it up for delivery. A transport is never needed if a router is used
19168 only for verification. The value of the option is expanded at routing time,
19169 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19170 and result must be the name of one of the configured transports. If it is not,
19171 delivery is deferred.
19172
19173 The &%transport%& option is not used by the &(redirect)& router, but it does
19174 have some private options that set up transports for pipe and file deliveries
19175 (see chapter &<<CHAPredirect>>&).
19176
19177
19178
19179 .option transport_current_directory routers string&!! unset
19180 .cindex "current directory for local transport"
19181 This option associates a current directory with any address that is routed
19182 to a local transport. This can happen either because a transport is
19183 explicitly configured for the router, or because it generates a delivery to a
19184 file or a pipe. During the delivery process (that is, at transport time), this
19185 option string is expanded and is set as the current directory, unless
19186 overridden by a setting on the transport.
19187 If the expansion fails for any reason, including forced failure, an error is
19188 logged, and delivery is deferred.
19189 See chapter &<<CHAPenvironment>>& for details of the local delivery
19190 environment.
19191
19192
19193
19194
19195 .option transport_home_directory routers string&!! "see below"
19196 .cindex "home directory" "for local transport"
19197 This option associates a home directory with any address that is routed to a
19198 local transport. This can happen either because a transport is explicitly
19199 configured for the router, or because it generates a delivery to a file or a
19200 pipe. During the delivery process (that is, at transport time), the option
19201 string is expanded and is set as the home directory, unless overridden by a
19202 setting of &%home_directory%& on the transport.
19203 If the expansion fails for any reason, including forced failure, an error is
19204 logged, and delivery is deferred.
19205
19206 If the transport does not specify a home directory, and
19207 &%transport_home_directory%& is not set for the router, the home directory for
19208 the transport is taken from the password data if &%check_local_user%& is set for
19209 the router. Otherwise it is taken from &%router_home_directory%& if that option
19210 is set; if not, no home directory is set for the transport.
19211
19212 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19213 environment.
19214
19215
19216
19217
19218 .option unseen routers boolean&!! false
19219 .cindex "router" "carrying on after success"
19220 The result of string expansion for this option must be a valid boolean value,
19221 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19222 result causes an error, and delivery is deferred. If the expansion is forced to
19223 fail, the default value for the option (false) is used. Other failures cause
19224 delivery to be deferred.
19225
19226 When this option is set true, routing does not cease if the router accepts the
19227 address. Instead, a copy of the incoming address is passed to the next router,
19228 overriding a false setting of &%more%&. There is little point in setting
19229 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19230 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19231 sometimes true and sometimes false).
19232
19233 .cindex "copy of message (&%unseen%& option)"
19234 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19235 qualifier in filter files. It can be used to cause copies of messages to be
19236 delivered to some other destination, while also carrying out a normal delivery.
19237 In effect, the current address is made into a &"parent"& that has two children
19238 &-- one that is delivered as specified by this router, and a clone that goes on
19239 to be routed further. For this reason, &%unseen%& may not be combined with the
19240 &%one_time%& option in a &(redirect)& router.
19241
19242 &*Warning*&: Header lines added to the address (or specified for removal) by
19243 this router or by previous routers affect the &"unseen"& copy of the message
19244 only. The clone that continues to be processed by further routers starts with
19245 no added headers and none specified for removal. For a &%redirect%& router, if
19246 a generated address is the same as the incoming address, this can lead to
19247 duplicate addresses with different header modifications. Exim does not do
19248 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19249 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19250 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19251 &%redirect%& router may be of help.
19252
19253 Unlike the handling of header modifications, any data that was set by the
19254 &%address_data%& option in the current or previous routers &'is'& passed on to
19255 subsequent routers.
19256
19257
19258 .option user routers string&!! "see below"
19259 .cindex "uid (user id)" "local delivery"
19260 .cindex "local transports" "uid and gid"
19261 .cindex "transport" "local"
19262 .cindex "router" "user for filter processing"
19263 .cindex "filter" "user for processing"
19264 When a router queues an address for a transport, and the transport does not
19265 specify a user, the user given here is used when running the delivery process.
19266 The user may be specified numerically or by name. If expansion fails, the
19267 error is logged and delivery is deferred.
19268 This user is also used by the &(redirect)& router when running a filter file.
19269 The default is unset, except when &%check_local_user%& is set. In this case,
19270 the default is taken from the password information. If the user is specified as
19271 a name, and &%group%& is not set, the group associated with the user is used.
19272 See also &%initgroups%& and &%group%& and the discussion in chapter
19273 &<<CHAPenvironment>>&.
19274
19275
19276
19277 .option verify routers&!? boolean true
19278 Setting this option has the effect of setting &%verify_sender%& and
19279 &%verify_recipient%& to the same value.
19280
19281
19282 .option verify_only routers&!? boolean false
19283 .cindex "EXPN" "with &%verify_only%&"
19284 .oindex "&%-bv%&"
19285 .cindex "router" "used only when verifying"
19286 If this option is set, the router is used only when verifying an address,
19287 delivering in cutthrough mode or
19288 testing with the &%-bv%& option, not when actually doing a delivery, testing
19289 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19290 restricted to verifying only senders or recipients by means of
19291 &%verify_sender%& and &%verify_recipient%&.
19292
19293 &*Warning*&: When the router is being run to verify addresses for an incoming
19294 SMTP message, Exim is not running as root, but under its own uid. If the router
19295 accesses any files, you need to make sure that they are accessible to the Exim
19296 user or group.
19297
19298
19299 .option verify_recipient routers&!? boolean true
19300 If this option is false, the router is skipped when verifying recipient
19301 addresses,
19302 delivering in cutthrough mode
19303 or testing recipient verification using &%-bv%&.
19304 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19305 are evaluated.
19306 See also the &$verify_mode$& variable.
19307
19308
19309 .option verify_sender routers&!? boolean true
19310 If this option is false, the router is skipped when verifying sender addresses
19311 or testing sender verification using &%-bvs%&.
19312 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19313 are evaluated.
19314 See also the &$verify_mode$& variable.
19315 .ecindex IIDgenoprou1
19316 .ecindex IIDgenoprou2
19317
19318
19319
19320
19321
19322
19323 . ////////////////////////////////////////////////////////////////////////////
19324 . ////////////////////////////////////////////////////////////////////////////
19325
19326 .chapter "The accept router" "CHID4"
19327 .cindex "&(accept)& router"
19328 .cindex "routers" "&(accept)&"
19329 The &(accept)& router has no private options of its own. Unless it is being
19330 used purely for verification (see &%verify_only%&) a transport is required to
19331 be defined by the generic &%transport%& option. If the preconditions that are
19332 specified by generic options are met, the router accepts the address and queues
19333 it for the given transport. The most common use of this router is for setting
19334 up deliveries to local mailboxes. For example:
19335 .code
19336 localusers:
19337   driver = accept
19338   domains = mydomain.example
19339   check_local_user
19340   transport = local_delivery
19341 .endd
19342 The &%domains%& condition in this example checks the domain of the address, and
19343 &%check_local_user%& checks that the local part is the login of a local user.
19344 When both preconditions are met, the &(accept)& router runs, and queues the
19345 address for the &(local_delivery)& transport.
19346
19347
19348
19349
19350
19351
19352 . ////////////////////////////////////////////////////////////////////////////
19353 . ////////////////////////////////////////////////////////////////////////////
19354
19355 .chapter "The dnslookup router" "CHAPdnslookup"
19356 .scindex IIDdnsrou1 "&(dnslookup)& router"
19357 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19358 The &(dnslookup)& router looks up the hosts that handle mail for the
19359 recipient's domain in the DNS. A transport must always be set for this router,
19360 unless &%verify_only%& is set.
19361
19362 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19363 SRV records. If none are found, or if SRV support is not configured,
19364 MX records are looked up. If no MX records exist, address records are sought.
19365 However, &%mx_domains%& can be set to disable the direct use of address
19366 records.
19367
19368 MX records of equal priority are sorted by Exim into a random order. Exim then
19369 looks for address records for the host names obtained from MX or SRV records.
19370 When a host has more than one IP address, they are sorted into a random order,
19371 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19372 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19373 generic option, the router declines.
19374
19375 Unless they have the highest priority (lowest MX value), MX records that point
19376 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19377 are discarded, together with any other MX records of equal or lower priority.
19378
19379 .cindex "MX record" "pointing to local host"
19380 .cindex "local host" "MX pointing to"
19381 .oindex "&%self%&" "in &(dnslookup)& router"
19382 If the host pointed to by the highest priority MX record, or looked up as an
19383 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19384 happens is controlled by the generic &%self%& option.
19385
19386
19387 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19388 There have been problems with DNS servers when SRV records are looked up.
19389 Some misbehaving servers return a DNS error or timeout when a non-existent
19390 SRV record is sought. Similar problems have in the past been reported for
19391 MX records. The global &%dns_again_means_nonexist%& option can help with this
19392 problem, but it is heavy-handed because it is a global option.
19393
19394 For this reason, there are two options, &%srv_fail_domains%& and
19395 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19396 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19397 an attempt to look up an SRV or MX record causes one of these results, and the
19398 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19399 such record"&. In the case of an SRV lookup, this means that the router
19400 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19401 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19402 case routing fails.
19403
19404
19405 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19406 .cindex "&(dnslookup)& router" "declines"
19407 There are a few cases where a &(dnslookup)& router will decline to accept
19408 an address; if such a router is expected to handle "all remaining non-local
19409 domains", then it is important to set &%no_more%&.
19410
19411 The router will defer rather than decline if the domain
19412 is found in the &%fail_defer_domains%& router option.
19413
19414 Reasons for a &(dnslookup)& router to decline currently include:
19415 .ilist
19416 The domain does not exist in DNS
19417 .next
19418 The domain exists but the MX record's host part is just "."; this is a common
19419 convention (borrowed from SRV) used to indicate that there is no such service
19420 for this domain and to not fall back to trying A/AAAA records.
19421 .next
19422 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19423 .next
19424 MX record points to a non-existent host.
19425 .next
19426 MX record points to an IP address and the main section option
19427 &%allow_mx_to_ip%& is not set.
19428 .next
19429 MX records exist and point to valid hosts, but all hosts resolve only to
19430 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19431 .next
19432 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19433 &%dns_check_names_pattern%& for handling one variant of this)
19434 .next
19435 &%check_secondary_mx%& is set on this router but the local host can
19436 not be found in the MX records (see below)
19437 .endlist
19438
19439
19440
19441
19442 .section "Private options for dnslookup" "SECID118"
19443 .cindex "options" "&(dnslookup)& router"
19444 The private options for the &(dnslookup)& router are as follows:
19445
19446 .option check_secondary_mx dnslookup boolean false
19447 .cindex "MX record" "checking for secondary"
19448 If this option is set, the router declines unless the local host is found in
19449 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19450 process domains for which the local host is a secondary mail exchanger
19451 differently to other domains. The way in which Exim decides whether a host is
19452 the local host is described in section &<<SECTreclocipadd>>&.
19453
19454
19455 .option check_srv dnslookup string&!! unset
19456 .cindex "SRV record" "enabling use of"
19457 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19458 addition to MX and address records. The support is disabled by default. To
19459 enable SRV support, set the &%check_srv%& option to the name of the service
19460 required. For example,
19461 .code
19462 check_srv = smtp
19463 .endd
19464 looks for SRV records that refer to the normal smtp service. The option is
19465 expanded, so the service name can vary from message to message or address
19466 to address. This might be helpful if SRV records are being used for a
19467 submission service. If the expansion is forced to fail, the &%check_srv%&
19468 option is ignored, and the router proceeds to look for MX records in the
19469 normal way.
19470
19471 When the expansion succeeds, the router searches first for SRV records for
19472 the given service (it assumes TCP protocol). A single SRV record with a
19473 host name that consists of just a single dot indicates &"no such service for
19474 this domain"&; if this is encountered, the router declines. If other kinds of
19475 SRV record are found, they are used to construct a host list for delivery
19476 according to the rules of RFC 2782. MX records are not sought in this case.
19477
19478 When no SRV records are found, MX records (and address records) are sought in
19479 the traditional way. In other words, SRV records take precedence over MX
19480 records, just as MX records take precedence over address records. Note that
19481 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19482 defined it. It is apparently believed that MX records are sufficient for email
19483 and that SRV records should not be used for this purpose. However, SRV records
19484 have an additional &"weight"& feature which some people might find useful when
19485 trying to split an SMTP load between hosts of different power.
19486
19487 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19488 when there is a DNS lookup error.
19489
19490
19491
19492
19493 .option fail_defer_domains dnslookup "domain list&!!" unset
19494 .cindex "MX record" "not found"
19495 DNS lookups for domains matching &%fail_defer_domains%&
19496 which find no matching record will cause the router to defer
19497 rather than the default behaviour of decline.
19498 This maybe be useful for queueing messages for a newly created
19499 domain while the DNS configuration is not ready.
19500 However, it will result in any message with mistyped domains
19501 also being queued.
19502
19503
19504 .option ipv4_only "string&!!" unset
19505 .cindex IPv6 disabling
19506 .cindex DNS "IPv6 disabling"
19507 The string is expanded, and if the result is anything but a forced failure,
19508 or an empty string, or one of the strings “0” or “no” or “false”
19509 (checked without regard to the case of the letters),
19510 only A records are used.
19511
19512 .option ipv4_prefer "string&!!" unset
19513 .cindex IPv4 preference
19514 .cindex DNS "IPv4 preference"
19515 The string is expanded, and if the result is anything but a forced failure,
19516 or an empty string, or one of the strings “0” or “no” or “false”
19517 (checked without regard to the case of the letters),
19518 A records are sorted before AAAA records (inverting the default).
19519
19520 .option mx_domains dnslookup "domain list&!!" unset
19521 .cindex "MX record" "required to exist"
19522 .cindex "SRV record" "required to exist"
19523 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19524 record in order to be recognized. (The name of this option could be improved.)
19525 For example, if all the mail hosts in &'fict.example'& are known to have MX
19526 records, except for those in &'discworld.fict.example'&, you could use this
19527 setting:
19528 .code
19529 mx_domains = ! *.discworld.fict.example : *.fict.example
19530 .endd
19531 This specifies that messages addressed to a domain that matches the list but
19532 has no MX record should be bounced immediately instead of being routed using
19533 the address record.
19534
19535
19536 .option mx_fail_domains dnslookup "domain list&!!" unset
19537 If the DNS lookup for MX records for one of the domains in this list causes a
19538 DNS lookup error, Exim behaves as if no MX records were found. See section
19539 &<<SECTprowitdnsloo>>& for more discussion.
19540
19541
19542
19543
19544 .option qualify_single dnslookup boolean true
19545 .cindex "DNS" "resolver options"
19546 .cindex "DNS" "qualifying single-component names"
19547 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19548 lookups. Typically, but not standardly, this causes the resolver to qualify
19549 single-component names with the default domain. For example, on a machine
19550 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19551 &'thesaurus.ref.example'& inside the resolver. For details of what your
19552 resolver actually does, consult your man pages for &'resolver'& and
19553 &'resolv.conf'&.
19554
19555
19556
19557 .option rewrite_headers dnslookup boolean true
19558 .cindex "rewriting" "header lines"
19559 .cindex "header lines" "rewriting"
19560 If the domain name in the address that is being processed is not fully
19561 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19562 an address is specified as &'dormouse@teaparty'&, the domain might be
19563 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19564 occur as a result of setting the &%widen_domains%& option. If
19565 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19566 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19567 header lines of the message are rewritten with the full domain name.
19568
19569 This option should be turned off only when it is known that no message is
19570 ever going to be sent outside an environment where the abbreviation makes
19571 sense.
19572
19573 When an MX record is looked up in the DNS and matches a wildcard record, name
19574 servers normally return a record containing the name that has been looked up,
19575 making it impossible to detect whether a wildcard was present or not. However,
19576 some name servers have recently been seen to return the wildcard entry. If the
19577 name returned by a DNS lookup begins with an asterisk, it is not used for
19578 header rewriting.
19579
19580
19581 .option same_domain_copy_routing dnslookup boolean false
19582 .cindex "address" "copying routing"
19583 Addresses with the same domain are normally routed by the &(dnslookup)& router
19584 to the same list of hosts. However, this cannot be presumed, because the router
19585 options and preconditions may refer to the local part of the address. By
19586 default, therefore, Exim routes each address in a message independently. DNS
19587 servers run caches, so repeated DNS lookups are not normally expensive, and in
19588 any case, personal messages rarely have more than a few recipients.
19589
19590 If you are running mailing lists with large numbers of subscribers at the same
19591 domain, and you are using a &(dnslookup)& router which is independent of the
19592 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19593 lookups for identical domains in one message. In this case, when &(dnslookup)&
19594 routes an address to a remote transport, any other unrouted addresses in the
19595 message that have the same domain are automatically given the same routing
19596 without processing them independently,
19597 provided the following conditions are met:
19598
19599 .ilist
19600 No router that processed the address specified &%headers_add%& or
19601 &%headers_remove%&.
19602 .next
19603 The router did not change the address in any way, for example, by &"widening"&
19604 the domain.
19605 .endlist
19606
19607
19608
19609
19610 .option search_parents dnslookup boolean false
19611 .cindex "DNS" "resolver options"
19612 When this option is true, the resolver option RES_DNSRCH is set for DNS
19613 lookups. This is different from the &%qualify_single%& option in that it
19614 applies to domains containing dots. Typically, but not standardly, it causes
19615 the resolver to search for the name in the current domain and in parent
19616 domains. For example, on a machine in the &'fict.example'& domain, if looking
19617 up &'teaparty.wonderland'& failed, the resolver would try
19618 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19619 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19620
19621 Setting this option true can cause problems in domains that have a wildcard MX
19622 record, because any domain that does not have its own MX record matches the
19623 local wildcard.
19624
19625
19626
19627 .option srv_fail_domains dnslookup "domain list&!!" unset
19628 If the DNS lookup for SRV records for one of the domains in this list causes a
19629 DNS lookup error, Exim behaves as if no SRV records were found. See section
19630 &<<SECTprowitdnsloo>>& for more discussion.
19631
19632
19633
19634
19635 .option widen_domains dnslookup "string list" unset
19636 .cindex "domain" "partial; widening"
19637 If a DNS lookup fails and this option is set, each of its strings in turn is
19638 added onto the end of the domain, and the lookup is tried again. For example,
19639 if
19640 .code
19641 widen_domains = fict.example:ref.example
19642 .endd
19643 is set and a lookup of &'klingon.dictionary'& fails,
19644 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19645 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19646 and &%search_parents%& options can cause some widening to be undertaken inside
19647 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19648 when verifying, unless &%rewrite_headers%& is false (not the default).
19649
19650
19651 .section "Effect of qualify_single and search_parents" "SECID119"
19652 When a domain from an envelope recipient is changed by the resolver as a result
19653 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19654 corresponding address in the message's header lines unless &%rewrite_headers%&
19655 is set false. Exim then re-routes the address, using the full domain.
19656
19657 These two options affect only the DNS lookup that takes place inside the router
19658 for the domain of the address that is being routed. They do not affect lookups
19659 such as that implied by
19660 .code
19661 domains = @mx_any
19662 .endd
19663 that may happen while processing a router precondition before the router is
19664 entered. No widening ever takes place for these lookups.
19665 .ecindex IIDdnsrou1
19666 .ecindex IIDdnsrou2
19667
19668
19669
19670
19671
19672
19673
19674
19675
19676 . ////////////////////////////////////////////////////////////////////////////
19677 . ////////////////////////////////////////////////////////////////////////////
19678
19679 .chapter "The ipliteral router" "CHID5"
19680 .cindex "&(ipliteral)& router"
19681 .cindex "domain literal" "routing"
19682 .cindex "routers" "&(ipliteral)&"
19683 This router has no private options. Unless it is being used purely for
19684 verification (see &%verify_only%&) a transport is required to be defined by the
19685 generic &%transport%& option. The router accepts the address if its domain part
19686 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19687 router handles the address
19688 .code
19689 root@[192.168.1.1]
19690 .endd
19691 by setting up delivery to the host with that IP address. IPv4 domain literals
19692 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19693 are similar, but the address is preceded by &`ipv6:`&. For example:
19694 .code
19695 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19696 .endd
19697 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19698 grounds that sooner or later somebody will try it.
19699
19700 .oindex "&%self%&" "in &(ipliteral)& router"
19701 If the IP address matches something in &%ignore_target_hosts%&, the router
19702 declines. If an IP literal turns out to refer to the local host, the generic
19703 &%self%& option determines what happens.
19704
19705 The RFCs require support for domain literals; however, their use is
19706 controversial in today's Internet. If you want to use this router, you must
19707 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19708 Exim will not recognize the domain literal syntax in addresses.
19709
19710
19711
19712 . ////////////////////////////////////////////////////////////////////////////
19713 . ////////////////////////////////////////////////////////////////////////////
19714
19715 .chapter "The iplookup router" "CHID6"
19716 .cindex "&(iplookup)& router"
19717 .cindex "routers" "&(iplookup)&"
19718 The &(iplookup)& router was written to fulfil a specific requirement in
19719 Cambridge University (which in fact no longer exists). For this reason, it is
19720 not included in the binary of Exim by default. If you want to include it, you
19721 must set
19722 .code
19723 ROUTER_IPLOOKUP=yes
19724 .endd
19725 in your &_Local/Makefile_& configuration file.
19726
19727 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19728 connection to one or more specific hosts. The host can then return the same or
19729 a different address &-- in effect rewriting the recipient address in the
19730 message's envelope. The new address is then passed on to subsequent routers. If
19731 this process fails, the address can be passed on to other routers, or delivery
19732 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19733 must not be specified for it.
19734
19735 .cindex "options" "&(iplookup)& router"
19736 .option hosts iplookup string unset
19737 This option must be supplied. Its value is a colon-separated list of host
19738 names. The hosts are looked up using &[gethostbyname()]&
19739 (or &[getipnodebyname()]& when available)
19740 and are tried in order until one responds to the query. If none respond, what
19741 happens is controlled by &%optional%&.
19742
19743
19744 .option optional iplookup boolean false
19745 If &%optional%& is true, if no response is obtained from any host, the address
19746 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19747 delivery to the address is deferred.
19748
19749
19750 .option port iplookup integer 0
19751 .cindex "port" "&(iplookup)& router"
19752 This option must be supplied. It specifies the port number for the TCP or UDP
19753 call.
19754
19755
19756 .option protocol iplookup string udp
19757 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19758 protocols is to be used.
19759
19760
19761 .option query iplookup string&!! "see below"
19762 This defines the content of the query that is sent to the remote hosts. The
19763 default value is:
19764 .code
19765 $local_part@$domain $local_part@$domain
19766 .endd
19767 The repetition serves as a way of checking that a response is to the correct
19768 query in the default case (see &%response_pattern%& below).
19769
19770
19771 .option reroute iplookup string&!! unset
19772 If this option is not set, the rerouted address is precisely the byte string
19773 returned by the remote host, up to the first white space, if any. If set, the
19774 string is expanded to form the rerouted address. It can include parts matched
19775 in the response by &%response_pattern%& by means of numeric variables such as
19776 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19777 whether or not a pattern is in use. In all cases, the rerouted address must end
19778 up in the form &'local_part@domain'&.
19779
19780
19781 .option response_pattern iplookup string unset
19782 This option can be set to a regular expression that is applied to the string
19783 returned from the remote host. If the pattern does not match the response, the
19784 router declines. If &%response_pattern%& is not set, no checking of the
19785 response is done, unless the query was defaulted, in which case there is a
19786 check that the text returned after the first white space is the original
19787 address. This checks that the answer that has been received is in response to
19788 the correct question. For example, if the response is just a new domain, the
19789 following could be used:
19790 .code
19791 response_pattern = ^([^@]+)$
19792 reroute = $local_part@$1
19793 .endd
19794
19795 .option timeout iplookup time 5s
19796 This specifies the amount of time to wait for a response from the remote
19797 machine. The same timeout is used for the &[connect()]& function for a TCP
19798 call. It does not apply to UDP.
19799
19800
19801
19802
19803 . ////////////////////////////////////////////////////////////////////////////
19804 . ////////////////////////////////////////////////////////////////////////////
19805
19806 .chapter "The manualroute router" "CHID7"
19807 .scindex IIDmanrou1 "&(manualroute)& router"
19808 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19809 .cindex "domain" "manually routing"
19810 The &(manualroute)& router is so-called because it provides a way of manually
19811 routing an address according to its domain. It is mainly used when you want to
19812 route addresses to remote hosts according to your own rules, bypassing the
19813 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19814 route to local transports, a facility that may be useful if you want to save
19815 messages for dial-in hosts in local files.
19816
19817 The &(manualroute)& router compares a list of domain patterns with the domain
19818 it is trying to route. If there is no match, the router declines. Each pattern
19819 has associated with it a list of hosts and some other optional data, which may
19820 include a transport. The combination of a pattern and its data is called a
19821 &"routing rule"&. For patterns that do not have an associated transport, the
19822 generic &%transport%& option must specify a transport, unless the router is
19823 being used purely for verification (see &%verify_only%&).
19824
19825 .vindex "&$host$&"
19826 In the case of verification, matching the domain pattern is sufficient for the
19827 router to accept the address. When actually routing an address for delivery,
19828 an address that matches a domain pattern is queued for the associated
19829 transport. If the transport is not a local one, a host list must be associated
19830 with the pattern; IP addresses are looked up for the hosts, and these are
19831 passed to the transport along with the mail address. For local transports, a
19832 host list is optional. If it is present, it is passed in &$host$& as a single
19833 text string.
19834
19835 The list of routing rules can be provided as an inline string in
19836 &%route_list%&, or the data can be obtained by looking up the domain in a file
19837 or database by setting &%route_data%&. Only one of these settings may appear in
19838 any one instance of &(manualroute)&. The format of routing rules is described
19839 below, following the list of private options.
19840
19841
19842 .section "Private options for manualroute" "SECTprioptman"
19843
19844 .cindex "options" "&(manualroute)& router"
19845 The private options for the &(manualroute)& router are as follows:
19846
19847 .option host_all_ignored manualroute string defer
19848 See &%host_find_failed%&.
19849
19850 .option host_find_failed manualroute string freeze
19851 This option controls what happens when &(manualroute)& tries to find an IP
19852 address for a host, and the host does not exist. The option can be set to one
19853 of the following values:
19854 .code
19855 decline
19856 defer
19857 fail
19858 freeze
19859 ignore
19860 pass
19861 .endd
19862 The default (&"freeze"&) assumes that this state is a serious configuration
19863 error. The difference between &"pass"& and &"decline"& is that the former
19864 forces the address to be passed to the next router (or the router defined by
19865 &%pass_router%&),
19866 .oindex "&%more%&"
19867 overriding &%no_more%&, whereas the latter passes the address to the next
19868 router only if &%more%& is true.
19869
19870 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19871 cannot be found. If all the hosts in the list are ignored, the behaviour is
19872 controlled by the &%host_all_ignored%& option. This takes the same values
19873 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19874
19875 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19876 state; if a host lookup gets a temporary error, delivery is deferred unless the
19877 generic &%pass_on_timeout%& option is set.
19878
19879
19880 .option hosts_randomize manualroute boolean false
19881 .cindex "randomized host list"
19882 .cindex "host" "list of; randomized"
19883 If this option is set, the order of the items in a host list in a routing rule
19884 is randomized each time the list is used, unless an option in the routing rule
19885 overrides (see below). Randomizing the order of a host list can be used to do
19886 crude load sharing. However, if more than one mail address is routed by the
19887 same router to the same host list, the host lists are considered to be the same
19888 (even though they may be randomized into different orders) for the purpose of
19889 deciding whether to batch the deliveries into a single SMTP transaction.
19890
19891 When &%hosts_randomize%& is true, a host list may be split
19892 into groups whose order is separately randomized. This makes it possible to
19893 set up MX-like behaviour. The boundaries between groups are indicated by an
19894 item that is just &`+`& in the host list. For example:
19895 .code
19896 route_list = * host1:host2:host3:+:host4:host5
19897 .endd
19898 The order of the first three hosts and the order of the last two hosts is
19899 randomized for each use, but the first three always end up before the last two.
19900 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19901 randomized host list is passed to an &(smtp)& transport that also has
19902 &%hosts_randomize set%&, the list is not re-randomized.
19903
19904
19905 .option route_data manualroute string&!! unset
19906 If this option is set, it must expand to yield the data part of a routing rule.
19907 Typically, the expansion string includes a lookup based on the domain. For
19908 example:
19909 .code
19910 route_data = ${lookup{$domain}dbm{/etc/routes}}
19911 .endd
19912 If the expansion is forced to fail, or the result is an empty string, the
19913 router declines. Other kinds of expansion failure cause delivery to be
19914 deferred.
19915
19916
19917 .option route_list manualroute "string list" unset
19918 This string is a list of routing rules, in the form defined below. Note that,
19919 unlike most string lists, the items are separated by semicolons. This is so
19920 that they may contain colon-separated host lists.
19921
19922
19923 .option same_domain_copy_routing manualroute boolean false
19924 .cindex "address" "copying routing"
19925 Addresses with the same domain are normally routed by the &(manualroute)&
19926 router to the same list of hosts. However, this cannot be presumed, because the
19927 router options and preconditions may refer to the local part of the address. By
19928 default, therefore, Exim routes each address in a message independently. DNS
19929 servers run caches, so repeated DNS lookups are not normally expensive, and in
19930 any case, personal messages rarely have more than a few recipients.
19931
19932 If you are running mailing lists with large numbers of subscribers at the same
19933 domain, and you are using a &(manualroute)& router which is independent of the
19934 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19935 lookups for identical domains in one message. In this case, when
19936 &(manualroute)& routes an address to a remote transport, any other unrouted
19937 addresses in the message that have the same domain are automatically given the
19938 same routing without processing them independently. However, this is only done
19939 if &%headers_add%& and &%headers_remove%& are unset.
19940
19941
19942
19943
19944 .section "Routing rules in route_list" "SECID120"
19945 The value of &%route_list%& is a string consisting of a sequence of routing
19946 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19947 entered as two semicolons. Alternatively, the list separator can be changed as
19948 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19949 Empty rules are ignored. The format of each rule is
19950 .display
19951 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19952 .endd
19953 The following example contains two rules, each with a simple domain pattern and
19954 no options:
19955 .code
19956 route_list = \
19957   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19958   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19959 .endd
19960 The three parts of a rule are separated by white space. The pattern and the
19961 list of hosts can be enclosed in quotes if necessary, and if they are, the
19962 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19963 single domain pattern, which is the only mandatory item in the rule. The
19964 pattern is in the same format as one item in a domain list (see section
19965 &<<SECTdomainlist>>&),
19966 except that it may not be the name of an interpolated file.
19967 That is, it may be wildcarded, or a regular expression, or a file or database
19968 lookup (with semicolons doubled, because of the use of semicolon as a separator
19969 in a &%route_list%&).
19970
19971 The rules in &%route_list%& are searched in order until one of the patterns
19972 matches the domain that is being routed. The list of hosts and then options are
19973 then used as described below. If there is no match, the router declines. When
19974 &%route_list%& is set, &%route_data%& must not be set.
19975
19976
19977
19978 .section "Routing rules in route_data" "SECID121"
19979 The use of &%route_list%& is convenient when there are only a small number of
19980 routing rules. For larger numbers, it is easier to use a file or database to
19981 hold the routing information, and use the &%route_data%& option instead.
19982 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19983 Most commonly, &%route_data%& is set as a string that contains an
19984 expansion lookup. For example, suppose we place two routing rules in a file
19985 like this:
19986 .code
19987 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19988 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19989 .endd
19990 This data can be accessed by setting
19991 .code
19992 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19993 .endd
19994 Failure of the lookup results in an empty string, causing the router to
19995 decline. However, you do not have to use a lookup in &%route_data%&. The only
19996 requirement is that the result of expanding the string is a list of hosts,
19997 possibly followed by options, separated by white space. The list of hosts must
19998 be enclosed in quotes if it contains white space.
19999
20000
20001
20002
20003 .section "Format of the list of hosts" "SECID122"
20004 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20005 always separately expanded before use. If the expansion fails, the router
20006 declines. The result of the expansion must be a colon-separated list of names
20007 and/or IP addresses, optionally also including ports.
20008 If the list is written with spaces, it must be protected with quotes.
20009 The format of each item
20010 in the list is described in the next section. The list separator can be changed
20011 as described in section &<<SECTlistsepchange>>&.
20012
20013 If the list of hosts was obtained from a &%route_list%& item, the following
20014 variables are set during its expansion:
20015
20016 .ilist
20017 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20018 If the domain was matched against a regular expression, the numeric variables
20019 &$1$&, &$2$&, etc. may be set. For example:
20020 .code
20021 route_list = ^domain(\d+)   host-$1.text.example
20022 .endd
20023 .next
20024 &$0$& is always set to the entire domain.
20025 .next
20026 &$1$& is also set when partial matching is done in a file lookup.
20027
20028 .next
20029 .vindex "&$value$&"
20030 If the pattern that matched the domain was a lookup item, the data that was
20031 looked up is available in the expansion variable &$value$&. For example:
20032 .code
20033 route_list = lsearch;;/some/file.routes  $value
20034 .endd
20035 .endlist
20036
20037 Note the doubling of the semicolon in the pattern that is necessary because
20038 semicolon is the default route list separator.
20039
20040
20041
20042 .section "Format of one host item" "SECTformatonehostitem"
20043 Each item in the list of hosts is either a host name or an IP address,
20044 optionally with an attached port number. When no port is given, an IP address
20045 is not enclosed in brackets. When a port is specified, it overrides the port
20046 specification on the transport. The port is separated from the name or address
20047 by a colon. This leads to some complications:
20048
20049 .ilist
20050 Because colon is the default separator for the list of hosts, either
20051 the colon that specifies a port must be doubled, or the list separator must
20052 be changed. The following two examples have the same effect:
20053 .code
20054 route_list = * "host1.tld::1225 : host2.tld::1226"
20055 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20056 .endd
20057 .next
20058 When IPv6 addresses are involved, it gets worse, because they contain
20059 colons of their own. To make this case easier, it is permitted to
20060 enclose an IP address (either v4 or v6) in square brackets if a port
20061 number follows. For example:
20062 .code
20063 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20064 .endd
20065 .endlist
20066
20067 .section "How the list of hosts is used" "SECThostshowused"
20068 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20069 the hosts is tried, in the order specified, when carrying out the SMTP
20070 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20071 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20072 transport.
20073
20074 Hosts may be listed by name or by IP address. An unadorned name in the list of
20075 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20076 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20077 records in the DNS. For example:
20078 .code
20079 route_list = *  x.y.z:p.q.r/MX:e.f.g
20080 .endd
20081 If this feature is used with a port specifier, the port must come last. For
20082 example:
20083 .code
20084 route_list = *  dom1.tld/mx::1225
20085 .endd
20086 If the &%hosts_randomize%& option is set, the order of the items in the list is
20087 randomized before any lookups are done. Exim then scans the list; for any name
20088 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20089 be an interface on the local host and the item is not the first in the list,
20090 Exim discards it and any subsequent items. If it is the first item, what
20091 happens is controlled by the
20092 .oindex "&%self%&" "in &(manualroute)& router"
20093 &%self%& option of the router.
20094
20095 A name on the list that is followed by &`/MX`& is replaced with the list of
20096 hosts obtained by looking up MX records for the name. This is always a DNS
20097 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20098 below) are not relevant here. The order of these hosts is determined by the
20099 preference values in the MX records, according to the usual rules. Because
20100 randomizing happens before the MX lookup, it does not affect the order that is
20101 defined by MX preferences.
20102
20103 If the local host is present in the sublist obtained from MX records, but is
20104 not the most preferred host in that list, it and any equally or less
20105 preferred hosts are removed before the sublist is inserted into the main list.
20106
20107 If the local host is the most preferred host in the MX list, what happens
20108 depends on where in the original list of hosts the &`/MX`& item appears. If it
20109 is not the first item (that is, there are previous hosts in the main list),
20110 Exim discards this name and any subsequent items in the main list.
20111
20112 If the MX item is first in the list of hosts, and the local host is the
20113 most preferred host, what happens is controlled by the &%self%& option of the
20114 router.
20115
20116 DNS failures when lookup up the MX records are treated in the same way as DNS
20117 failures when looking up IP addresses: &%pass_on_timeout%& and
20118 &%host_find_failed%& are used when relevant.
20119
20120 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20121 whether obtained from an MX lookup or not.
20122
20123
20124
20125 .section "How the options are used" "SECThowoptused"
20126 The options are a sequence of words, space-separated.
20127 One of the words can be the name of a transport; this overrides the
20128 &%transport%& option on the router for this particular routing rule only. The
20129 other words (if present) control randomization of the list of hosts on a
20130 per-rule basis, and how the IP addresses of the hosts are to be found when
20131 routing to a remote transport. These options are as follows:
20132
20133 .ilist
20134 &%randomize%&: randomize the order of the hosts in this list, overriding the
20135 setting of &%hosts_randomize%& for this routing rule only.
20136 .next
20137 &%no_randomize%&: do not randomize the order of the hosts in this list,
20138 overriding the setting of &%hosts_randomize%& for this routing rule only.
20139 .next
20140 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20141 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20142 also look in &_/etc/hosts_& or other sources of information.
20143 .next
20144 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20145 no address records are found. If there is a temporary DNS error (such as a
20146 timeout), delivery is deferred.
20147 .next
20148 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20149 .next
20150 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20151 .endlist
20152
20153 For example:
20154 .code
20155 route_list = domain1  host1:host2:host3  randomize bydns;\
20156              domain2  host4:host5
20157 .endd
20158 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20159 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20160 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20161 or &[gethostbyname()]&, and the result of the lookup is the result of that
20162 call.
20163
20164 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20165 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20166 instead of TRY_AGAIN. That is why the default action is to try a DNS
20167 lookup first. Only if that gives a definite &"no such host"& is the local
20168 function called.
20169
20170 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20171 inadvertent constraint that a transport name as an option had to be the last
20172 option specified.
20173
20174
20175
20176 If no IP address for a host can be found, what happens is controlled by the
20177 &%host_find_failed%& option.
20178
20179 .vindex "&$host$&"
20180 When an address is routed to a local transport, IP addresses are not looked up.
20181 The host list is passed to the transport in the &$host$& variable.
20182
20183
20184
20185 .section "Manualroute examples" "SECID123"
20186 In some of the examples that follow, the presence of the &%remote_smtp%&
20187 transport, as defined in the default configuration file, is assumed:
20188
20189 .ilist
20190 .cindex "smart host" "example router"
20191 The &(manualroute)& router can be used to forward all external mail to a
20192 &'smart host'&. If you have set up, in the main part of the configuration, a
20193 named domain list that contains your local domains, for example:
20194 .code
20195 domainlist local_domains = my.domain.example
20196 .endd
20197 You can arrange for all other domains to be routed to a smart host by making
20198 your first router something like this:
20199 .code
20200 smart_route:
20201   driver = manualroute
20202   domains = !+local_domains
20203   transport = remote_smtp
20204   route_list = * smarthost.ref.example
20205 .endd
20206 This causes all non-local addresses to be sent to the single host
20207 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20208 they are tried in order
20209 (but you can use &%hosts_randomize%& to vary the order each time).
20210 Another way of configuring the same thing is this:
20211 .code
20212 smart_route:
20213   driver = manualroute
20214   transport = remote_smtp
20215   route_list = !+local_domains  smarthost.ref.example
20216 .endd
20217 There is no difference in behaviour between these two routers as they stand.
20218 However, they behave differently if &%no_more%& is added to them. In the first
20219 example, the router is skipped if the domain does not match the &%domains%&
20220 precondition; the following router is always tried. If the router runs, it
20221 always matches the domain and so can never decline. Therefore, &%no_more%&
20222 would have no effect. In the second case, the router is never skipped; it
20223 always runs. However, if it doesn't match the domain, it declines. In this case
20224 &%no_more%& would prevent subsequent routers from running.
20225
20226 .next
20227 .cindex "mail hub example"
20228 A &'mail hub'& is a host which receives mail for a number of domains via MX
20229 records in the DNS and delivers it via its own private routing mechanism. Often
20230 the final destinations are behind a firewall, with the mail hub being the one
20231 machine that can connect to machines both inside and outside the firewall. The
20232 &(manualroute)& router is usually used on a mail hub to route incoming messages
20233 to the correct hosts. For a small number of domains, the routing can be inline,
20234 using the &%route_list%& option, but for a larger number a file or database
20235 lookup is easier to manage.
20236
20237 If the domain names are in fact the names of the machines to which the mail is
20238 to be sent by the mail hub, the configuration can be quite simple. For
20239 example:
20240 .code
20241 hub_route:
20242   driver = manualroute
20243   transport = remote_smtp
20244   route_list = *.rhodes.tvs.example  $domain
20245 .endd
20246 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20247 whose names are the same as the mail domains. A similar approach can be taken
20248 if the host name can be obtained from the domain name by a string manipulation
20249 that the expansion facilities can handle. Otherwise, a lookup based on the
20250 domain can be used to find the host:
20251 .code
20252 through_firewall:
20253   driver = manualroute
20254   transport = remote_smtp
20255   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20256 .endd
20257 The result of the lookup must be the name or IP address of the host (or
20258 hosts) to which the address is to be routed. If the lookup fails, the route
20259 data is empty, causing the router to decline. The address then passes to the
20260 next router.
20261
20262 .next
20263 .cindex "batched SMTP output example"
20264 .cindex "SMTP" "batched outgoing; example"
20265 You can use &(manualroute)& to deliver messages to pipes or files in batched
20266 SMTP format for onward transportation by some other means. This is one way of
20267 storing mail for a dial-up host when it is not connected. The route list entry
20268 can be as simple as a single domain name in a configuration like this:
20269 .code
20270 save_in_file:
20271   driver = manualroute
20272   transport = batchsmtp_appendfile
20273   route_list = saved.domain.example
20274 .endd
20275 though often a pattern is used to pick up more than one domain. If there are
20276 several domains or groups of domains with different transport requirements,
20277 different transports can be listed in the routing information:
20278 .code
20279 save_in_file:
20280   driver = manualroute
20281   route_list = \
20282     *.saved.domain1.example  $domain  batch_appendfile; \
20283     *.saved.domain2.example  \
20284       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20285       batch_pipe
20286 .endd
20287 .vindex "&$domain$&"
20288 .vindex "&$host$&"
20289 The first of these just passes the domain in the &$host$& variable, which
20290 doesn't achieve much (since it is also in &$domain$&), but the second does a
20291 file lookup to find a value to pass, causing the router to decline to handle
20292 the address if the lookup fails.
20293
20294 .next
20295 .cindex "UUCP" "example of router for"
20296 Routing mail directly to UUCP software is a specific case of the use of
20297 &(manualroute)& in a gateway to another mail environment. This is an example of
20298 one way it can be done:
20299 .code
20300 # Transport
20301 uucp:
20302   driver = pipe
20303   user = nobody
20304   command = /usr/local/bin/uux -r - \
20305     ${substr_-5:$host}!rmail ${local_part}
20306   return_fail_output = true
20307
20308 # Router
20309 uucphost:
20310   transport = uucp
20311   driver = manualroute
20312   route_data = \
20313     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20314 .endd
20315 The file &_/usr/local/exim/uucphosts_& contains entries like
20316 .code
20317 darksite.ethereal.example:           darksite.UUCP
20318 .endd
20319 It can be set up more simply without adding and removing &".UUCP"& but this way
20320 makes clear the distinction between the domain name
20321 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20322 .endlist
20323 .ecindex IIDmanrou1
20324 .ecindex IIDmanrou2
20325
20326
20327
20328
20329
20330
20331
20332
20333 . ////////////////////////////////////////////////////////////////////////////
20334 . ////////////////////////////////////////////////////////////////////////////
20335
20336 .chapter "The queryprogram router" "CHAPdriverlast"
20337 .scindex IIDquerou1 "&(queryprogram)& router"
20338 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20339 .cindex "routing" "by external program"
20340 The &(queryprogram)& router routes an address by running an external command
20341 and acting on its output. This is an expensive way to route, and is intended
20342 mainly for use in lightly-loaded systems, or for performing experiments.
20343 However, if it is possible to use the precondition options (&%domains%&,
20344 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20345 be used in special cases, even on a busy host. There are the following private
20346 options:
20347 .cindex "options" "&(queryprogram)& router"
20348
20349 .option command queryprogram string&!! unset
20350 This option must be set. It specifies the command that is to be run. The
20351 command is split up into a command name and arguments, and then each is
20352 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20353 &<<CHAPpipetransport>>&).
20354
20355
20356 .option command_group queryprogram string unset
20357 .cindex "gid (group id)" "in &(queryprogram)& router"
20358 This option specifies a gid to be set when running the command while routing an
20359 address for deliver. It must be set if &%command_user%& specifies a numerical
20360 uid. If it begins with a digit, it is interpreted as the numerical value of the
20361 gid. Otherwise it is looked up using &[getgrnam()]&.
20362
20363
20364 .option command_user queryprogram string unset
20365 .cindex "uid (user id)" "for &(queryprogram)&"
20366 This option must be set. It specifies the uid which is set when running the
20367 command while routing an address for delivery. If the value begins with a digit,
20368 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20369 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20370 not set, a value for the gid also.
20371
20372 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20373 root, which it does during a normal delivery in a conventional configuration.
20374 However, when an address is being verified during message reception, Exim is
20375 usually running as the Exim user, not as root. If the &(queryprogram)& router
20376 is called from a non-root process, Exim cannot change uid or gid before running
20377 the command. In this circumstance the command runs under the current uid and
20378 gid.
20379
20380
20381 .option current_directory queryprogram string /
20382 This option specifies an absolute path which is made the current directory
20383 before running the command.
20384
20385
20386 .option timeout queryprogram time 1h
20387 If the command does not complete within the timeout period, its process group
20388 is killed and the message is frozen. A value of zero time specifies no
20389 timeout.
20390
20391
20392 The standard output of the command is connected to a pipe, which is read when
20393 the command terminates. It should consist of a single line of output,
20394 containing up to five fields, separated by white space. The maximum length of
20395 the line is 1023 characters. Longer lines are silently truncated. The first
20396 field is one of the following words (case-insensitive):
20397
20398 .ilist
20399 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20400 below).
20401 .next
20402 &'Decline'&: the router declines; pass the address to the next router, unless
20403 &%no_more%& is set.
20404 .next
20405 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20406 subsequent text on the line is an error message. If the router is run as part
20407 of address verification during an incoming SMTP message, the message is
20408 included in the SMTP response.
20409 .next
20410 &'Defer'&: routing could not be completed at this time; try again later. Any
20411 subsequent text on the line is an error message which is logged. It is not
20412 included in any SMTP response.
20413 .next
20414 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20415 .next
20416 &'Pass'&: pass the address to the next router (or the router specified by
20417 &%pass_router%&), overriding &%no_more%&.
20418 .next
20419 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20420 new addresses, which are routed independently, starting with the first router,
20421 or the router specified by &%redirect_router%&, if set.
20422 .endlist
20423
20424 When the first word is &'accept'&, the remainder of the line consists of a
20425 number of keyed data values, as follows (split into two lines here, to fit on
20426 the page):
20427 .code
20428 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20429 LOOKUP=byname|bydns DATA=<text>
20430 .endd
20431 The data items can be given in any order, and all are optional. If no transport
20432 is included, the transport specified by the generic &%transport%& option is
20433 used. The list of hosts and the lookup type are needed only if the transport is
20434 an &(smtp)& transport that does not itself supply a list of hosts.
20435
20436 The format of the list of hosts is the same as for the &(manualroute)& router.
20437 As well as host names and IP addresses with optional port numbers, as described
20438 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20439 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20440 (see section &<<SECThostshowused>>&).
20441
20442 If the lookup type is not specified, Exim behaves as follows when trying to
20443 find an IP address for each host: First, a DNS lookup is done. If this yields
20444 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20445 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20446 result of the lookup is the result of that call.
20447
20448 .vindex "&$address_data$&"
20449 If the DATA field is set, its value is placed in the &$address_data$&
20450 variable. For example, this return line
20451 .code
20452 accept hosts=x1.y.example:x2.y.example data="rule1"
20453 .endd
20454 routes the address to the default transport, passing a list of two hosts. When
20455 the transport runs, the string &"rule1"& is in &$address_data$&.
20456 .ecindex IIDquerou1
20457 .ecindex IIDquerou2
20458
20459
20460
20461
20462 . ////////////////////////////////////////////////////////////////////////////
20463 . ////////////////////////////////////////////////////////////////////////////
20464
20465 .chapter "The redirect router" "CHAPredirect"
20466 .scindex IIDredrou1 "&(redirect)& router"
20467 .scindex IIDredrou2 "routers" "&(redirect)&"
20468 .cindex "alias file" "in a &(redirect)& router"
20469 .cindex "address redirection" "&(redirect)& router"
20470 The &(redirect)& router handles several kinds of address redirection. Its most
20471 common uses are for resolving local part aliases from a central alias file
20472 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20473 files, but it has many other potential uses. The incoming address can be
20474 redirected in several different ways:
20475
20476 .ilist
20477 It can be replaced by one or more new addresses which are themselves routed
20478 independently.
20479 .next
20480 It can be routed to be delivered to a given file or directory.
20481 .next
20482 It can be routed to be delivered to a specified pipe command.
20483 .next
20484 It can cause an automatic reply to be generated.
20485 .next
20486 It can be forced to fail, optionally with a custom error message.
20487 .next
20488 It can be temporarily deferred, optionally with a custom message.
20489 .next
20490 It can be discarded.
20491 .endlist
20492
20493 The generic &%transport%& option must not be set for &(redirect)& routers.
20494 However, there are some private options which define transports for delivery to
20495 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20496 &%pipe_transport%& and &%reply_transport%& descriptions below.
20497
20498 If success DSNs have been requested
20499 .cindex "DSN" "success"
20500 .cindex "Delivery Status Notification" "success"
20501 redirection triggers one and the DSN options are not passed any further.
20502
20503
20504
20505 .section "Redirection data" "SECID124"
20506 The router operates by interpreting a text string which it obtains either by
20507 expanding the contents of the &%data%& option, or by reading the entire
20508 contents of a file whose name is given in the &%file%& option. These two
20509 options are mutually exclusive. The first is commonly used for handling system
20510 aliases, in a configuration like this:
20511 .code
20512 system_aliases:
20513   driver = redirect
20514   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20515 .endd
20516 If the lookup fails, the expanded string in this example is empty. When the
20517 expansion of &%data%& results in an empty string, the router declines. A forced
20518 expansion failure also causes the router to decline; other expansion failures
20519 cause delivery to be deferred.
20520
20521 A configuration using &%file%& is commonly used for handling users'
20522 &_.forward_& files, like this:
20523 .code
20524 userforward:
20525   driver = redirect
20526   check_local_user
20527   file = $home/.forward
20528   no_verify
20529 .endd
20530 If the file does not exist, or causes no action to be taken (for example, it is
20531 empty or consists only of comments), the router declines. &*Warning*&: This
20532 is not the case when the file contains syntactically valid items that happen to
20533 yield empty addresses, for example, items containing only RFC 2822 address
20534 comments.
20535
20536
20537
20538 .section "Forward files and address verification" "SECID125"
20539 .cindex "address redirection" "while verifying"
20540 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20541 &_.forward_& files, as in the example above. There are two reasons for this:
20542
20543 .ilist
20544 When Exim is receiving an incoming SMTP message from a remote host, it is
20545 running under the Exim uid, not as root. Exim is unable to change uid to read
20546 the file as the user, and it may not be able to read it as the Exim user. So in
20547 practice the router may not be able to operate.
20548 .next
20549 However, even when the router can operate, the existence of a &_.forward_& file
20550 is unimportant when verifying an address. What should be checked is whether the
20551 local part is a valid user name or not. Cutting out the redirection processing
20552 saves some resources.
20553 .endlist
20554
20555
20556
20557
20558
20559
20560 .section "Interpreting redirection data" "SECID126"
20561 .cindex "Sieve filter" "specifying in redirection data"
20562 .cindex "filter" "specifying in redirection data"
20563 The contents of the data string, whether obtained from &%data%& or &%file%&,
20564 can be interpreted in two different ways:
20565
20566 .ilist
20567 If the &%allow_filter%& option is set true, and the data begins with the text
20568 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20569 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20570 respectively. Details of the syntax and semantics of filter files are described
20571 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20572 document is intended for use by end users.
20573 .next
20574 Otherwise, the data must be a comma-separated list of redirection items, as
20575 described in the next section.
20576 .endlist
20577
20578 When a message is redirected to a file (a &"mail folder"&), the filename given
20579 in a non-filter redirection list must always be an absolute path. A filter may
20580 generate a relative path &-- how this is handled depends on the transport's
20581 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20582 for the &(appendfile)& transport.
20583
20584
20585
20586 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20587 .cindex "address redirection" "non-filter list items"
20588 When the redirection data is not an Exim or Sieve filter, for example, if it
20589 comes from a conventional alias or forward file, it consists of a list of
20590 addresses, filenames, pipe commands, or certain special items (see section
20591 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20592 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20593 depending on their default values. The items in the list are separated by
20594 commas or newlines.
20595 If a comma is required in an item, the entire item must be enclosed in double
20596 quotes.
20597
20598 Lines starting with a # character are comments, and are ignored, and # may
20599 also appear following a comma, in which case everything between the # and the
20600 next newline character is ignored.
20601
20602 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20603 double quotes are retained because some forms of mail address require their use
20604 (but never to enclose the entire address). In the following description,
20605 &"item"& refers to what remains after any surrounding double quotes have been
20606 removed.
20607
20608 .vindex "&$local_part$&"
20609 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20610 and the expansion contains a reference to &$local_part$&, you should make use
20611 of the &%quote_local_part%& expansion operator, in case the local part contains
20612 special characters. For example, to redirect all mail for the domain
20613 &'obsolete.example'&, retaining the existing local part, you could use this
20614 setting:
20615 .code
20616 data = ${quote_local_part:$local_part}@newdomain.example
20617 .endd
20618
20619
20620 .section "Redirecting to a local mailbox" "SECTredlocmai"
20621 .cindex "routing" "loops in"
20622 .cindex "loop" "while routing, avoidance of"
20623 .cindex "address redirection" "to local mailbox"
20624 A redirection item may safely be the same as the address currently under
20625 consideration. This does not cause a routing loop, because a router is
20626 automatically skipped if any ancestor of the address that is being processed
20627 is the same as the current address and was processed by the current router.
20628 Such an address is therefore passed to the following routers, so it is handled
20629 as if there were no redirection. When making this loop-avoidance test, the
20630 complete local part, including any prefix or suffix, is used.
20631
20632 .cindex "address redirection" "local part without domain"
20633 Specifying the same local part without a domain is a common usage in personal
20634 filter files when the user wants to have messages delivered to the local
20635 mailbox and also forwarded elsewhere. For example, the user whose login is
20636 &'cleo'& might have a &_.forward_& file containing this:
20637 .code
20638 cleo, cleopatra@egypt.example
20639 .endd
20640 .cindex "backslash in alias file"
20641 .cindex "alias file" "backslash in"
20642 For compatibility with other MTAs, such unqualified local parts may be
20643 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20644 it does make a difference if more than one domain is being handled
20645 synonymously.
20646
20647 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20648 2822 address that does not include a domain, the item is qualified using the
20649 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20650 addresses are qualified using the value in &%qualify_recipient%&, but you can
20651 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20652
20653 Care must be taken if there are alias names for local users.
20654 Consider an MTA handling a single local domain where the system alias file
20655 contains:
20656 .code
20657 Sam.Reman: spqr
20658 .endd
20659 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20660 messages in the local mailbox, and also forward copies elsewhere. He creates
20661 this forward file:
20662 .code
20663 Sam.Reman, spqr@reme.elsewhere.example
20664 .endd
20665 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20666 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20667 second time round, because it has previously routed it,
20668 and the following routers presumably cannot handle the alias. The forward file
20669 should really contain
20670 .code
20671 spqr, spqr@reme.elsewhere.example
20672 .endd
20673 but because this is such a common error, the &%check_ancestor%& option (see
20674 below) exists to provide a way to get round it. This is normally set on a
20675 &(redirect)& router that is handling users' &_.forward_& files.
20676
20677
20678
20679 .section "Special items in redirection lists" "SECTspecitredli"
20680 In addition to addresses, the following types of item may appear in redirection
20681 lists (that is, in non-filter redirection data):
20682
20683 .ilist
20684 .cindex "pipe" "in redirection list"
20685 .cindex "address redirection" "to pipe"
20686 An item is treated as a pipe command if it begins with &"|"& and does not parse
20687 as a valid RFC 2822 address that includes a domain. A transport for running the
20688 command must be specified by the &%pipe_transport%& option.
20689 Normally, either the router or the transport specifies a user and a group under
20690 which to run the delivery. The default is to use the Exim user and group.
20691
20692 Single or double quotes can be used for enclosing the individual arguments of
20693 the pipe command; no interpretation of escapes is done for single quotes. If
20694 the command contains a comma character, it is necessary to put the whole item
20695 in double quotes, for example:
20696 .code
20697 "|/some/command ready,steady,go"
20698 .endd
20699 since items in redirection lists are terminated by commas. Do not, however,
20700 quote just the command. An item such as
20701 .code
20702 |"/some/command ready,steady,go"
20703 .endd
20704 is interpreted as a pipe with a rather strange command name, and no arguments.
20705
20706 Note that the above example assumes that the text comes from a lookup source
20707 of some sort, so that the quotes are part of the data.  If composing a
20708 redirect router with a &%data%& option directly specifying this command, the
20709 quotes will be used by the configuration parser to define the extent of one
20710 string, but will not be passed down into the redirect router itself.  There
20711 are two main approaches to get around this: escape quotes to be part of the
20712 data itself, or avoid using this mechanism and instead create a custom
20713 transport with the &%command%& option set and reference that transport from
20714 an &%accept%& router.
20715
20716 .next
20717 .cindex "file" "in redirection list"
20718 .cindex "address redirection" "to file"
20719 An item is interpreted as a path name if it begins with &"/"& and does not
20720 parse as a valid RFC 2822 address that includes a domain. For example,
20721 .code
20722 /home/world/minbari
20723 .endd
20724 is treated as a filename, but
20725 .code
20726 /s=molari/o=babylon/@x400gate.way
20727 .endd
20728 is treated as an address. For a filename, a transport must be specified using
20729 the &%file_transport%& option. However, if the generated path name ends with a
20730 forward slash character, it is interpreted as a directory name rather than a
20731 filename, and &%directory_transport%& is used instead.
20732
20733 Normally, either the router or the transport specifies a user and a group under
20734 which to run the delivery. The default is to use the Exim user and group.
20735
20736 .cindex "&_/dev/null_&"
20737 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20738 bypassed at a high level, and the log entry shows &"**bypassed**"&
20739 instead of a transport name. In this case the user and group are not used.
20740
20741 .next
20742 .cindex "included address list"
20743 .cindex "address redirection" "included external list"
20744 If an item is of the form
20745 .code
20746 :include:<path name>
20747 .endd
20748 a list of further items is taken from the given file and included at that
20749 point. &*Note*&: Such a file can not be a filter file; it is just an
20750 out-of-line addition to the list. The items in the included list are separated
20751 by commas or newlines and are not subject to expansion. If this is the first
20752 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20753 the alias name. This example is incorrect:
20754 .code
20755 list1    :include:/opt/lists/list1
20756 .endd
20757 It must be given as
20758 .code
20759 list1:   :include:/opt/lists/list1
20760 .endd
20761 .next
20762 .cindex "address redirection" "to black hole"
20763 .cindex "delivery" "discard"
20764 .cindex "delivery" "blackhole"
20765 .cindex "black hole"
20766 .cindex "abandoning mail"
20767 Sometimes you want to throw away mail to a particular local part.  Making the
20768 &%data%& option expand to an empty string does not work, because that causes
20769 the router to decline. Instead, the alias item
20770 .code
20771 :blackhole:
20772 .endd
20773 can be used. It does what its name implies. No delivery is
20774 done, and no error message is generated. This has the same effect as specifying
20775 &_/dev/null_& as a destination, but it can be independently disabled.
20776
20777 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20778 delivery is done for the original local part, even if other redirection items
20779 are present. If you are generating a multi-item list (for example, by reading a
20780 database) and need the ability to provide a no-op item, you must use
20781 &_/dev/null_&.
20782
20783 .next
20784 .cindex "delivery" "forcing failure"
20785 .cindex "delivery" "forcing deferral"
20786 .cindex "failing delivery" "forcing"
20787 .cindex "deferred delivery, forcing"
20788 .cindex "customizing" "failure message"
20789 An attempt to deliver a particular address can be deferred or forced to fail by
20790 redirection items of the form
20791 .code
20792 :defer:
20793 :fail:
20794 .endd
20795 respectively. When a redirection list contains such an item, it applies
20796 to the entire redirection; any other items in the list are ignored. Any
20797 text following &':fail:'& or &':defer:'& is placed in the error text
20798 associated with the failure. For example, an alias file might contain:
20799 .code
20800 X.Employee:  :fail: Gone away, no forwarding address
20801 .endd
20802 In the case of an address that is being verified from an ACL or as the subject
20803 of a
20804 .cindex "VRFY" "error text, display of"
20805 VRFY command, the text is included in the SMTP error response by
20806 default.
20807 .cindex "EXPN" "error text, display of"
20808 The text is not included in the response to an EXPN command. In non-SMTP cases
20809 the text is included in the error message that Exim generates.
20810
20811 .cindex "SMTP" "error codes"
20812 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20813 &':fail:'&. However, if the message starts with three digits followed by a
20814 space, optionally followed by an extended code of the form &'n.n.n'&, also
20815 followed by a space, and the very first digit is the same as the default error
20816 code, the code from the message is used instead. If the very first digit is
20817 incorrect, a panic error is logged, and the default code is used. You can
20818 suppress the use of the supplied code in a redirect router by setting the
20819 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20820 ignored.
20821
20822 .vindex "&$acl_verify_message$&"
20823 In an ACL, an explicitly provided message overrides the default, but the
20824 default message is available in the variable &$acl_verify_message$& and can
20825 therefore be included in a custom message if this is desired.
20826
20827 Normally the error text is the rest of the redirection list &-- a comma does
20828 not terminate it &-- but a newline does act as a terminator. Newlines are not
20829 normally present in alias expansions. In &(lsearch)& lookups they are removed
20830 as part of the continuation process, but they may exist in other kinds of
20831 lookup and in &':include:'& files.
20832
20833 During routing for message delivery (as opposed to verification), a redirection
20834 containing &':fail:'& causes an immediate failure of the incoming address,
20835 whereas &':defer:'& causes the message to remain in the queue so that a
20836 subsequent delivery attempt can happen at a later time. If an address is
20837 deferred for too long, it will ultimately fail, because the normal retry
20838 rules still apply.
20839
20840 .next
20841 .cindex "alias file" "exception to default"
20842 Sometimes it is useful to use a single-key search type with a default (see
20843 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20844 for exceptions to the default. These can be handled by aliasing them to
20845 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20846 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20847 results in an empty redirection list has the same effect.
20848 .endlist
20849
20850
20851 .section "Duplicate addresses" "SECTdupaddr"
20852 .cindex "duplicate addresses"
20853 .cindex "address duplicate, discarding"
20854 .cindex "pipe" "duplicated"
20855 Exim removes duplicate addresses from the list to which it is delivering, so as
20856 to deliver just one copy to each address. This does not apply to deliveries
20857 routed to pipes by different immediate parent addresses, but an indirect
20858 aliasing scheme of the type
20859 .code
20860 pipe:       |/some/command $local_part
20861 localpart1: pipe
20862 localpart2: pipe
20863 .endd
20864 does not work with a message that is addressed to both local parts, because
20865 when the second is aliased to the intermediate local part &"pipe"& it gets
20866 discarded as being the same as a previously handled address. However, a scheme
20867 such as
20868 .code
20869 localpart1: |/some/command $local_part
20870 localpart2: |/some/command $local_part
20871 .endd
20872 does result in two different pipe deliveries, because the immediate parents of
20873 the pipes are distinct.
20874
20875
20876
20877 .section "Repeated redirection expansion" "SECID128"
20878 .cindex "repeated redirection expansion"
20879 .cindex "address redirection" "repeated for each delivery attempt"
20880 When a message cannot be delivered to all of its recipients immediately,
20881 leading to two or more delivery attempts, redirection expansion is carried out
20882 afresh each time for those addresses whose children were not all previously
20883 delivered. If redirection is being used as a mailing list, this can lead to new
20884 members of the list receiving copies of old messages. The &%one_time%& option
20885 can be used to avoid this.
20886
20887
20888 .section "Errors in redirection lists" "SECID129"
20889 .cindex "address redirection" "errors"
20890 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20891 error is skipped, and an entry is written to the main log. This may be useful
20892 for mailing lists that are automatically managed. Otherwise, if an error is
20893 detected while generating the list of new addresses, the original address is
20894 deferred. See also &%syntax_errors_to%&.
20895
20896
20897
20898 .section "Private options for the redirect router" "SECID130"
20899
20900 .cindex "options" "&(redirect)& router"
20901 The private options for the &(redirect)& router are as follows:
20902
20903
20904 .option allow_defer redirect boolean false
20905 Setting this option allows the use of &':defer:'& in non-filter redirection
20906 data, or the &%defer%& command in an Exim filter file.
20907
20908
20909 .option allow_fail redirect boolean false
20910 .cindex "failing delivery" "from filter"
20911 If this option is true, the &':fail:'& item can be used in a redirection list,
20912 and the &%fail%& command may be used in an Exim filter file.
20913
20914
20915 .option allow_filter redirect boolean false
20916 .cindex "filter" "enabling use of"
20917 .cindex "Sieve filter" "enabling use of"
20918 Setting this option allows Exim to interpret redirection data that starts with
20919 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20920 are some features of Exim filter files that some administrators may wish to
20921 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20922
20923 It is also possible to lock out Exim filters or Sieve filters while allowing
20924 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20925
20926
20927 The filter is run using the uid and gid set by the generic &%user%& and
20928 &%group%& options. These take their defaults from the password data if
20929 &%check_local_user%& is set, so in the normal case of users' personal filter
20930 files, the filter is run as the relevant user. When &%allow_filter%& is set
20931 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20932
20933
20934
20935 .option allow_freeze redirect boolean false
20936 .cindex "freezing messages" "allowing in filter"
20937 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20938 This command is more normally encountered in system filters, and is disabled by
20939 default for redirection filters because it isn't something you usually want to
20940 let ordinary users do.
20941
20942
20943
20944 .option check_ancestor redirect boolean false
20945 This option is concerned with handling generated addresses that are the same
20946 as some address in the list of redirection ancestors of the current address.
20947 Although it is turned off by default in the code, it is set in the default
20948 configuration file for handling users' &_.forward_& files. It is recommended
20949 for this use of the &(redirect)& router.
20950
20951 When &%check_ancestor%& is set, if a generated address (including the domain)
20952 is the same as any ancestor of the current address, it is replaced by a copy of
20953 the current address. This helps in the case where local part A is aliased to B,
20954 and B has a &_.forward_& file pointing back to A. For example, within a single
20955 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20956 &_&~jb/.forward_& contains:
20957 .code
20958 \Joe.Bloggs, <other item(s)>
20959 .endd
20960 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20961 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20962 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20963 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20964 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20965 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20966 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20967 original address. See also the &%repeat_use%& option below.
20968
20969
20970 .option check_group redirect boolean "see below"
20971 When the &%file%& option is used, the group owner of the file is checked only
20972 when this option is set. The permitted groups are those listed in the
20973 &%owngroups%& option, together with the user's default group if
20974 &%check_local_user%& is set. If the file has the wrong group, routing is
20975 deferred. The default setting for this option is true if &%check_local_user%&
20976 is set and the &%modemask%& option permits the group write bit, or if the
20977 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20978
20979
20980
20981 .option check_owner redirect boolean "see below"
20982 When the &%file%& option is used, the owner of the file is checked only when
20983 this option is set. If &%check_local_user%& is set, the local user is
20984 permitted; otherwise the owner must be one of those listed in the &%owners%&
20985 option. The default value for this option is true if &%check_local_user%& or
20986 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20987
20988
20989 .option data redirect string&!! unset
20990 This option is mutually exclusive with &%file%&. One or other of them must be
20991 set, but not both. The contents of &%data%& are expanded, and then used as the
20992 list of forwarding items, or as a set of filtering instructions. If the
20993 expansion is forced to fail, or the result is an empty string or a string that
20994 has no effect (consists entirely of comments), the router declines.
20995
20996 When filtering instructions are used, the string must begin with &"#Exim
20997 filter"&, and all comments in the string, including this initial one, must be
20998 terminated with newline characters. For example:
20999 .code
21000 data = #Exim filter\n\
21001        if $h_to: contains Exim then save $home/mail/exim endif
21002 .endd
21003 If you are reading the data from a database where newlines cannot be included,
21004 you can use the &${sg}$& expansion item to turn the escape string of your
21005 choice into a newline.
21006
21007
21008 .option directory_transport redirect string&!! unset
21009 A &(redirect)& router sets up a direct delivery to a directory when a path name
21010 ending with a slash is specified as a new &"address"&. The transport used is
21011 specified by this option, which, after expansion, must be the name of a
21012 configured transport. This should normally be an &(appendfile)& transport.
21013
21014
21015 .option file redirect string&!! unset
21016 This option specifies the name of a file that contains the redirection data. It
21017 is mutually exclusive with the &%data%& option. The string is expanded before
21018 use; if the expansion is forced to fail, the router declines. Other expansion
21019 failures cause delivery to be deferred. The result of a successful expansion
21020 must be an absolute path. The entire file is read and used as the redirection
21021 data. If the data is an empty string or a string that has no effect (consists
21022 entirely of comments), the router declines.
21023
21024 .cindex "NFS" "checking for file existence"
21025 If the attempt to open the file fails with a &"does not exist"& error, Exim
21026 runs a check on the containing directory,
21027 unless &%ignore_enotdir%& is true (see below).
21028 If the directory does not appear to exist, delivery is deferred. This can
21029 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21030 is a mount problem. If the containing directory does exist, but the file does
21031 not, the router declines.
21032
21033
21034 .option file_transport redirect string&!! unset
21035 .vindex "&$address_file$&"
21036 A &(redirect)& router sets up a direct delivery to a file when a path name not
21037 ending in a slash is specified as a new &"address"&. The transport used is
21038 specified by this option, which, after expansion, must be the name of a
21039 configured transport. This should normally be an &(appendfile)& transport. When
21040 it is running, the filename is in &$address_file$&.
21041
21042
21043 .option filter_prepend_home redirect boolean true
21044 When this option is true, if a &(save)& command in an Exim filter specifies a
21045 relative path, and &$home$& is defined, it is automatically prepended to the
21046 relative path. If this option is set false, this action does not happen. The
21047 relative path is then passed to the transport unmodified.
21048
21049
21050 .option forbid_blackhole redirect boolean false
21051 .cindex "restricting access to features"
21052 .cindex "filter" "locking out certain features"
21053 If this option is true, the &':blackhole:'& item may not appear in a
21054 redirection list.
21055
21056
21057 .option forbid_exim_filter redirect boolean false
21058 .cindex "restricting access to features"
21059 .cindex "filter" "locking out certain features"
21060 If this option is set true, only Sieve filters are permitted when
21061 &%allow_filter%& is true.
21062
21063
21064
21065
21066 .option forbid_file redirect boolean false
21067 .cindex "restricting access to features"
21068 .cindex "delivery" "to file; forbidding"
21069 .cindex "filter" "locking out certain features"
21070 .cindex "Sieve filter" "forbidding delivery to a file"
21071 .cindex "Sieve filter" "&""keep""& facility; disabling"
21072 If this option is true, this router may not generate a new address that
21073 specifies delivery to a local file or directory, either from a filter or from a
21074 conventional forward file. This option is forced to be true if &%one_time%& is
21075 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21076 locks out the Sieve's &"keep"& facility.
21077
21078
21079 .option forbid_filter_dlfunc redirect boolean false
21080 .cindex "restricting access to features"
21081 .cindex "filter" "locking out certain features"
21082 If this option is true, string expansions in Exim filters are not allowed to
21083 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21084 functions.
21085
21086 .option forbid_filter_existstest redirect boolean false
21087 .cindex "restricting access to features"
21088 .cindex "filter" "locking out certain features"
21089 .cindex "expansion" "statting a file"
21090 If this option is true, string expansions in Exim filters are not allowed to
21091 make use of the &%exists%& condition or the &%stat%& expansion item.
21092
21093 .option forbid_filter_logwrite redirect boolean false
21094 .cindex "restricting access to features"
21095 .cindex "filter" "locking out certain features"
21096 If this option is true, use of the logging facility in Exim filters is not
21097 permitted. Logging is in any case available only if the filter is being run
21098 under some unprivileged uid (which is normally the case for ordinary users'
21099 &_.forward_& files).
21100
21101
21102 .option forbid_filter_lookup redirect boolean false
21103 .cindex "restricting access to features"
21104 .cindex "filter" "locking out certain features"
21105 If this option is true, string expansions in Exim filter files are not allowed
21106 to make use of &%lookup%& items.
21107
21108
21109 .option forbid_filter_perl redirect boolean false
21110 .cindex "restricting access to features"
21111 .cindex "filter" "locking out certain features"
21112 This option has an effect only if Exim is built with embedded Perl support. If
21113 it is true, string expansions in Exim filter files are not allowed to make use
21114 of the embedded Perl support.
21115
21116
21117 .option forbid_filter_readfile 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 &%readfile%& items.
21122
21123
21124 .option forbid_filter_readsocket redirect boolean false
21125 .cindex "restricting access to features"
21126 .cindex "filter" "locking out certain features"
21127 If this option is true, string expansions in Exim filter files are not allowed
21128 to make use of &%readsocket%& items.
21129
21130
21131 .option forbid_filter_reply redirect boolean false
21132 .cindex "restricting access to features"
21133 .cindex "filter" "locking out certain features"
21134 If this option is true, this router may not generate an automatic reply
21135 message. Automatic replies can be generated only from Exim or Sieve filter
21136 files, not from traditional forward files. This option is forced to be true if
21137 &%one_time%& is set.
21138
21139
21140 .option forbid_filter_run redirect boolean false
21141 .cindex "restricting access to features"
21142 .cindex "filter" "locking out certain features"
21143 If this option is true, string expansions in Exim filter files are not allowed
21144 to make use of &%run%& items.
21145
21146
21147 .option forbid_include redirect boolean false
21148 .cindex "restricting access to features"
21149 .cindex "filter" "locking out certain features"
21150 If this option is true, items of the form
21151 .code
21152 :include:<path name>
21153 .endd
21154 are not permitted in non-filter redirection lists.
21155
21156
21157 .option forbid_pipe redirect boolean false
21158 .cindex "restricting access to features"
21159 .cindex "filter" "locking out certain features"
21160 .cindex "delivery" "to pipe; forbidding"
21161 If this option is true, this router may not generate a new address which
21162 specifies delivery to a pipe, either from an Exim filter or from a conventional
21163 forward file. This option is forced to be true if &%one_time%& is set.
21164
21165
21166 .option forbid_sieve_filter redirect boolean false
21167 .cindex "restricting access to features"
21168 .cindex "filter" "locking out certain features"
21169 If this option is set true, only Exim filters are permitted when
21170 &%allow_filter%& is true.
21171
21172
21173 .cindex "SMTP" "error codes"
21174 .option forbid_smtp_code redirect boolean false
21175 If this option is set true, any SMTP error codes that are present at the start
21176 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21177 the default codes (451 and 550, respectively) are always used.
21178
21179
21180
21181
21182 .option hide_child_in_errmsg redirect boolean false
21183 .cindex "bounce message" "redirection details; suppressing"
21184 If this option is true, it prevents Exim from quoting a child address if it
21185 generates a bounce or delay message for it. Instead it says &"an address
21186 generated from <&'the top level address'&>"&. Of course, this applies only to
21187 bounces generated locally. If a message is forwarded to another host, &'its'&
21188 bounce may well quote the generated address.
21189
21190
21191 .option ignore_eacces redirect boolean false
21192 .cindex "EACCES"
21193 If this option is set and an attempt to open a redirection file yields the
21194 EACCES error (permission denied), the &(redirect)& router behaves as if the
21195 file did not exist.
21196
21197
21198 .option ignore_enotdir redirect boolean false
21199 .cindex "ENOTDIR"
21200 If this option is set and an attempt to open a redirection file yields the
21201 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21202 router behaves as if the file did not exist.
21203
21204 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21205 router that has the &%file%& option set discovers that the file does not exist
21206 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21207 against unmounted NFS directories. If the parent can not be statted, delivery
21208 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21209 is set, because that option tells Exim to ignore &"something on the path is not
21210 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21211 that some operating systems give ENOENT where others give ENOTDIR.
21212
21213
21214
21215 .option include_directory redirect string unset
21216 If this option is set, the path names of any &':include:'& items in a
21217 redirection list must start with this directory.
21218
21219
21220 .option modemask redirect "octal integer" 022
21221 This specifies mode bits which must not be set for a file specified by the
21222 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21223
21224
21225 .option one_time redirect boolean false
21226 .cindex "one-time aliasing/forwarding expansion"
21227 .cindex "alias file" "one-time expansion"
21228 .cindex "forward file" "one-time expansion"
21229 .cindex "mailing lists" "one-time expansion"
21230 .cindex "address redirection" "one-time expansion"
21231 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21232 files each time it tries to deliver a message causes a problem when one or more
21233 of the generated addresses fails be delivered at the first attempt. The problem
21234 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21235 but of what happens when the redirection list changes during the time that the
21236 message is on Exim's queue. This is particularly true in the case of mailing
21237 lists, where new subscribers might receive copies of messages that were posted
21238 before they subscribed.
21239
21240 If &%one_time%& is set and any addresses generated by the router fail to
21241 deliver at the first attempt, the failing addresses are added to the message as
21242 &"top level"& addresses, and the parent address that generated them is marked
21243 &"delivered"&. Thus, redirection does not happen again at the next delivery
21244 attempt.
21245
21246 &*Warning 1*&: Any header line addition or removal that is specified by this
21247 router would be lost if delivery did not succeed at the first attempt. For this
21248 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21249 permitted when &%one_time%& is set.
21250
21251 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21252 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21253 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21254
21255 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21256 &%one_time%&.
21257
21258 The original top-level address is remembered with each of the generated
21259 addresses, and is output in any log messages. However, any intermediate parent
21260 addresses are not recorded. This makes a difference to the log only if
21261 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21262 typically be used for mailing lists, where there is normally just one level of
21263 expansion.
21264
21265
21266 .option owners redirect "string list" unset
21267 .cindex "ownership" "alias file"
21268 .cindex "ownership" "forward file"
21269 .cindex "alias file" "ownership"
21270 .cindex "forward file" "ownership"
21271 This specifies a list of permitted owners for the file specified by &%file%&.
21272 This list is in addition to the local user when &%check_local_user%& is set.
21273 See &%check_owner%& above.
21274
21275
21276 .option owngroups redirect "string list" unset
21277 This specifies a list of permitted groups for the file specified by &%file%&.
21278 The list is in addition to the local user's primary group when
21279 &%check_local_user%& is set. See &%check_group%& above.
21280
21281
21282 .option pipe_transport redirect string&!! unset
21283 .vindex "&$address_pipe$&"
21284 A &(redirect)& router sets up a direct delivery to a pipe when a string
21285 starting with a vertical bar character is specified as a new &"address"&. The
21286 transport used is specified by this option, which, after expansion, must be the
21287 name of a configured transport. This should normally be a &(pipe)& transport.
21288 When the transport is run, the pipe command is in &$address_pipe$&.
21289
21290
21291 .option qualify_domain redirect string&!! unset
21292 .vindex "&$qualify_recipient$&"
21293 If this option is set, and an unqualified address (one without a domain) is
21294 generated, and that address would normally be qualified by the global setting
21295 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21296 expanding this string. If the expansion fails, the router declines. If you want
21297 to revert to the default, you can have the expansion generate
21298 &$qualify_recipient$&.
21299
21300 This option applies to all unqualified addresses generated by Exim filters,
21301 but for traditional &_.forward_& files, it applies only to addresses that are
21302 not preceded by a backslash. Sieve filters cannot generate unqualified
21303 addresses.
21304
21305 .option qualify_preserve_domain redirect boolean false
21306 .cindex "domain" "in redirection; preserving"
21307 .cindex "preserving domain in redirection"
21308 .cindex "address redirection" "domain; preserving"
21309 If this option is set, the router's local &%qualify_domain%& option must not be
21310 set (a configuration error occurs if it is). If an unqualified address (one
21311 without a domain) is generated, it is qualified with the domain of the parent
21312 address (the immediately preceding ancestor) instead of the global
21313 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21314 this applies whether or not the address is preceded by a backslash.
21315
21316
21317 .option repeat_use redirect boolean true
21318 If this option is set false, the router is skipped for a child address that has
21319 any ancestor that was routed by this router. This test happens before any of
21320 the other preconditions are tested. Exim's default anti-looping rules skip
21321 only when the ancestor is the same as the current address. See also
21322 &%check_ancestor%& above and the generic &%redirect_router%& option.
21323
21324
21325 .option reply_transport redirect string&!! unset
21326 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21327 &%vacation%& command is used in a filter file. The transport used is specified
21328 by this option, which, after expansion, must be the name of a configured
21329 transport. This should normally be an &(autoreply)& transport. Other transports
21330 are unlikely to do anything sensible or useful.
21331
21332
21333 .option rewrite redirect boolean true
21334 .cindex "address redirection" "disabling rewriting"
21335 If this option is set false, addresses generated by the router are not
21336 subject to address rewriting. Otherwise, they are treated like new addresses
21337 and are rewritten according to the global rewriting rules.
21338
21339
21340 .option sieve_subaddress redirect string&!! unset
21341 The value of this option is passed to a Sieve filter to specify the
21342 :subaddress part of an address.
21343
21344 .option sieve_useraddress redirect string&!! unset
21345 The value of this option is passed to a Sieve filter to specify the :user part
21346 of an address. However, if it is unset, the entire original local part
21347 (including any prefix or suffix) is used for :user.
21348
21349
21350 .option sieve_vacation_directory redirect string&!! unset
21351 .cindex "Sieve filter" "vacation directory"
21352 To enable the &"vacation"& extension for Sieve filters, you must set
21353 &%sieve_vacation_directory%& to the directory where vacation databases are held
21354 (do not put anything else in that directory), and ensure that the
21355 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21356 needs their own directory; Exim will create it if necessary.
21357
21358
21359
21360 .option skip_syntax_errors redirect boolean false
21361 .cindex "forward file" "broken"
21362 .cindex "address redirection" "broken files"
21363 .cindex "alias file" "broken"
21364 .cindex "broken alias or forward files"
21365 .cindex "ignoring faulty addresses"
21366 .cindex "skipping faulty addresses"
21367 .cindex "error" "skipping bad syntax"
21368 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21369 non-filter redirection data are skipped, and each failing address is logged. If
21370 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21371 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21372 are expanded and placed at the head of the error message generated by
21373 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21374 be the same address as the generic &%errors_to%& option. The
21375 &%skip_syntax_errors%& option is often used when handling mailing lists.
21376
21377 If all the addresses in a redirection list are skipped because of syntax
21378 errors, the router declines to handle the original address, and it is passed to
21379 the following routers.
21380
21381 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21382 error in the filter causes filtering to be abandoned without any action being
21383 taken. The incident is logged, and the router declines to handle the address,
21384 so it is passed to the following routers.
21385
21386 .cindex "Sieve filter" "syntax errors in"
21387 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21388 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21389 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21390
21391 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21392 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21393 option, used with an address that does not get redirected, can be used to
21394 notify users of these errors, by means of a router like this:
21395 .code
21396 userforward:
21397   driver = redirect
21398   allow_filter
21399   check_local_user
21400   file = $home/.forward
21401   file_transport = address_file
21402   pipe_transport = address_pipe
21403   reply_transport = address_reply
21404   no_verify
21405   skip_syntax_errors
21406   syntax_errors_to = real-$local_part@$domain
21407   syntax_errors_text = \
21408    This is an automatically generated message. An error has\n\
21409    been found in your .forward file. Details of the error are\n\
21410    reported below. While this error persists, you will receive\n\
21411    a copy of this message for every message that is addressed\n\
21412    to you. If your .forward file is a filter file, or if it is\n\
21413    a non-filter file containing no valid forwarding addresses,\n\
21414    a copy of each incoming message will be put in your normal\n\
21415    mailbox. If a non-filter file contains at least one valid\n\
21416    forwarding address, forwarding to the valid addresses will\n\
21417    happen, and those will be the only deliveries that occur.
21418 .endd
21419 You also need a router to ensure that local addresses that are prefixed by
21420 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21421 put this immediately before the &(userforward)& router:
21422 .code
21423 real_localuser:
21424   driver = accept
21425   check_local_user
21426   local_part_prefix = real-
21427   transport = local_delivery
21428 .endd
21429 For security, it would probably be a good idea to restrict the use of this
21430 router to locally-generated messages, using a condition such as this:
21431 .code
21432   condition = ${if match {$sender_host_address}\
21433                          {\N^(|127\.0\.0\.1)$\N}}
21434 .endd
21435
21436
21437 .option syntax_errors_text redirect string&!! unset
21438 See &%skip_syntax_errors%& above.
21439
21440
21441 .option syntax_errors_to redirect string unset
21442 See &%skip_syntax_errors%& above.
21443 .ecindex IIDredrou1
21444 .ecindex IIDredrou2
21445
21446
21447
21448
21449
21450
21451 . ////////////////////////////////////////////////////////////////////////////
21452 . ////////////////////////////////////////////////////////////////////////////
21453
21454 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21455          "Environment for local transports"
21456 .scindex IIDenvlotra1 "local transports" "environment for"
21457 .scindex IIDenvlotra2 "environment" "local transports"
21458 .scindex IIDenvlotra3 "transport" "local; environment for"
21459 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21460 transport can be thought of as similar to a pipe.) Exim always runs transports
21461 in subprocesses, under specified uids and gids. Typical deliveries to local
21462 mailboxes run under the uid and gid of the local user.
21463
21464 Exim also sets a specific current directory while running the transport; for
21465 some transports a home directory setting is also relevant. The &(pipe)&
21466 transport is the only one that sets up environment variables; see section
21467 &<<SECTpipeenv>>& for details.
21468
21469 The values used for the uid, gid, and the directories may come from several
21470 different places. In many cases, the router that handles the address associates
21471 settings with that address as a result of its &%check_local_user%&, &%group%&,
21472 or &%user%& options. However, values may also be given in the transport's own
21473 configuration, and these override anything that comes from the router.
21474
21475
21476
21477 .section "Concurrent deliveries" "SECID131"
21478 .cindex "concurrent deliveries"
21479 .cindex "simultaneous deliveries"
21480 If two different messages for the same local recipient arrive more or less
21481 simultaneously, the two delivery processes are likely to run concurrently. When
21482 the &(appendfile)& transport is used to write to a file, Exim applies locking
21483 rules to stop concurrent processes from writing to the same file at the same
21484 time.
21485
21486 However, when you use a &(pipe)& transport, it is up to you to arrange any
21487 locking that is needed. Here is a silly example:
21488 .code
21489 my_transport:
21490   driver = pipe
21491   command = /bin/sh -c 'cat >>/some/file'
21492 .endd
21493 This is supposed to write the message at the end of the file. However, if two
21494 messages arrive at the same time, the file will be scrambled. You can use the
21495 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21496 file using the same algorithm that Exim itself uses.
21497
21498
21499
21500
21501 .section "Uids and gids" "SECTenvuidgid"
21502 .cindex "local transports" "uid and gid"
21503 .cindex "transport" "local; uid and gid"
21504 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21505 overrides any group that the router set in the address, even if &%user%& is not
21506 set for the transport. This makes it possible, for example, to run local mail
21507 delivery under the uid of the recipient (set by the router), but in a special
21508 group (set by the transport). For example:
21509 .code
21510 # Routers ...
21511 # User/group are set by check_local_user in this router
21512 local_users:
21513   driver = accept
21514   check_local_user
21515   transport = group_delivery
21516
21517 # Transports ...
21518 # This transport overrides the group
21519 group_delivery:
21520   driver = appendfile
21521   file = /var/spool/mail/$local_part
21522   group = mail
21523 .endd
21524 If &%user%& is set for a transport, its value overrides what is set in the
21525 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21526 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21527 set.
21528
21529 .oindex "&%initgroups%&"
21530 When the uid is taken from the transport's configuration, the &[initgroups()]&
21531 function is called for the groups associated with that uid if the
21532 &%initgroups%& option is set for the transport. When the uid is not specified
21533 by the transport, but is associated with the address by a router, the option
21534 for calling &[initgroups()]& is taken from the router configuration.
21535
21536 .cindex "&(pipe)& transport" "uid for"
21537 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21538 is set and &%user%& is not set, the uid of the process that called Exim to
21539 receive the message is used, and if &%group%& is not set, the corresponding
21540 original gid is also used.
21541
21542 This is the detailed preference order for obtaining a gid; the first of the
21543 following that is set is used:
21544
21545 .ilist
21546 A &%group%& setting of the transport;
21547 .next
21548 A &%group%& setting of the router;
21549 .next
21550 A gid associated with a user setting of the router, either as a result of
21551 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21552 .next
21553 The group associated with a non-numeric &%user%& setting of the transport;
21554 .next
21555 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21556 the uid is the creator's uid;
21557 .next
21558 The Exim gid if the Exim uid is being used as a default.
21559 .endlist
21560
21561 If, for example, the user is specified numerically on the router and there are
21562 no group settings, no gid is available. In this situation, an error occurs.
21563 This is different for the uid, for which there always is an ultimate default.
21564 The first of the following that is set is used:
21565
21566 .ilist
21567 A &%user%& setting of the transport;
21568 .next
21569 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21570 .next
21571 A &%user%& setting of the router;
21572 .next
21573 A &%check_local_user%& setting of the router;
21574 .next
21575 The Exim uid.
21576 .endlist
21577
21578 Of course, an error will still occur if the uid that is chosen is on the
21579 &%never_users%& list.
21580
21581
21582
21583
21584
21585 .section "Current and home directories" "SECID132"
21586 .cindex "current directory for local transport"
21587 .cindex "home directory" "for local transport"
21588 .cindex "transport" "local; home directory for"
21589 .cindex "transport" "local; current directory for"
21590 Routers may set current and home directories for local transports by means of
21591 the &%transport_current_directory%& and &%transport_home_directory%& options.
21592 However, if the transport's &%current_directory%& or &%home_directory%& options
21593 are set, they override the router's values. In detail, the home directory
21594 for a local transport is taken from the first of these values that is set:
21595
21596 .ilist
21597 The &%home_directory%& option on the transport;
21598 .next
21599 The &%transport_home_directory%& option on the router;
21600 .next
21601 The password data if &%check_local_user%& is set on the router;
21602 .next
21603 The &%router_home_directory%& option on the router.
21604 .endlist
21605
21606 The current directory is taken from the first of these values that is set:
21607
21608 .ilist
21609 The &%current_directory%& option on the transport;
21610 .next
21611 The &%transport_current_directory%& option on the router.
21612 .endlist
21613
21614
21615 If neither the router nor the transport sets a current directory, Exim uses the
21616 value of the home directory, if it is set. Otherwise it sets the current
21617 directory to &_/_& before running a local transport.
21618
21619
21620
21621 .section "Expansion variables derived from the address" "SECID133"
21622 .vindex "&$domain$&"
21623 .vindex "&$local_part$&"
21624 .vindex "&$original_domain$&"
21625 Normally a local delivery is handling a single address, and in that case the
21626 variables such as &$domain$& and &$local_part$& are set during local
21627 deliveries. However, in some circumstances more than one address may be handled
21628 at once (for example, while writing batch SMTP for onward transmission by some
21629 other means). In this case, the variables associated with the local part are
21630 never set, &$domain$& is set only if all the addresses have the same domain,
21631 and &$original_domain$& is never set.
21632 .ecindex IIDenvlotra1
21633 .ecindex IIDenvlotra2
21634 .ecindex IIDenvlotra3
21635
21636
21637
21638
21639
21640
21641
21642 . ////////////////////////////////////////////////////////////////////////////
21643 . ////////////////////////////////////////////////////////////////////////////
21644
21645 .chapter "Generic options for transports" "CHAPtransportgeneric"
21646 .scindex IIDgenoptra1 "generic options" "transport"
21647 .scindex IIDgenoptra2 "options" "generic; for transports"
21648 .scindex IIDgenoptra3 "transport" "generic options for"
21649 The following generic options apply to all transports:
21650
21651
21652 .option body_only transports boolean false
21653 .cindex "transport" "body only"
21654 .cindex "message" "transporting body only"
21655 .cindex "body of message" "transporting"
21656 If this option is set, the message's headers are not transported. It is
21657 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21658 or &(pipe)& transports, the settings of &%message_prefix%& and
21659 &%message_suffix%& should be checked, because this option does not
21660 automatically suppress them.
21661
21662
21663 .option current_directory transports string&!! unset
21664 .cindex "transport" "current directory for"
21665 This specifies the current directory that is to be set while running the
21666 transport, overriding any value that may have been set by the router.
21667 If the expansion fails for any reason, including forced failure, an error is
21668 logged, and delivery is deferred.
21669
21670
21671 .option disable_logging transports boolean false
21672 If this option is set true, nothing is logged for any
21673 deliveries by the transport or for any
21674 transport errors. You should not set this option unless you really, really know
21675 what you are doing.
21676
21677
21678 .option debug_print transports string&!! unset
21679 .cindex "testing" "variables in drivers"
21680 If this option is set and debugging is enabled (see the &%-d%& command line
21681 option), the string is expanded and included in the debugging output when the
21682 transport is run.
21683 If expansion of the string fails, the error message is written to the debugging
21684 output, and Exim carries on processing.
21685 This facility is provided to help with checking out the values of variables and
21686 so on when debugging driver configurations. For example, if a &%headers_add%&
21687 option is not working properly, &%debug_print%& could be used to output the
21688 variables it references. A newline is added to the text if it does not end with
21689 one.
21690 The variables &$transport_name$& and &$router_name$& contain the name of the
21691 transport and the router that called it.
21692
21693 .option delivery_date_add transports boolean false
21694 .cindex "&'Delivery-date:'& header line"
21695 If this option is true, a &'Delivery-date:'& header is added to the message.
21696 This gives the actual time the delivery was made. As this is not a standard
21697 header, Exim has a configuration option (&%delivery_date_remove%&) which
21698 requests its removal from incoming messages, so that delivered messages can
21699 safely be resent to other recipients.
21700
21701
21702 .option driver transports string unset
21703 This specifies which of the available transport drivers is to be used.
21704 There is no default, and this option must be set for every transport.
21705
21706
21707 .option envelope_to_add transports boolean false
21708 .cindex "&'Envelope-to:'& header line"
21709 If this option is true, an &'Envelope-to:'& header is added to the message.
21710 This gives the original address(es) in the incoming envelope that caused this
21711 delivery to happen. More than one address may be present if the transport is
21712 configured to handle several addresses at once, or if more than one original
21713 address was redirected to the same final address. As this is not a standard
21714 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21715 its removal from incoming messages, so that delivered messages can safely be
21716 resent to other recipients.
21717
21718
21719 .option event_action transports string&!! unset
21720 .cindex events
21721 This option declares a string to be expanded for Exim's events mechanism.
21722 For details see chapter &<<CHAPevents>>&.
21723
21724
21725 .option group transports string&!! "Exim group"
21726 .cindex "transport" "group; specifying"
21727 This option specifies a gid for running the transport process, overriding any
21728 value that the router supplies, and also overriding any value associated with
21729 &%user%& (see below).
21730
21731
21732 .option headers_add transports list&!! unset
21733 .cindex "header lines" "adding in transport"
21734 .cindex "transport" "header lines; adding"
21735 This option specifies a list of text headers,
21736 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21737 which are (separately) expanded and added to the header
21738 portion of a message as it is transported, as described in section
21739 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21740 routers. If the result of the expansion is an empty string, or if the expansion
21741 is forced to fail, no action is taken. Other expansion failures are treated as
21742 errors and cause the delivery to be deferred.
21743
21744 Unlike most options, &%headers_add%& can be specified multiple times
21745 for a transport; all listed headers are added.
21746
21747
21748 .option headers_only transports boolean false
21749 .cindex "transport" "header lines only"
21750 .cindex "message" "transporting headers only"
21751 .cindex "header lines" "transporting"
21752 If this option is set, the message's body is not transported. It is mutually
21753 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21754 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21755 checked, since this option does not automatically suppress them.
21756
21757
21758 .option headers_remove transports list&!! unset
21759 .cindex "header lines" "removing"
21760 .cindex "transport" "header lines; removing"
21761 This option specifies a list of header names,
21762 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21763 these headers are omitted from the message as it is transported, as described
21764 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21765 routers.
21766 Each list item is separately expanded.
21767 If the result of the expansion is an empty string, or if the expansion
21768 is forced to fail, no action is taken. Other expansion failures are treated as
21769 errors and cause the delivery to be deferred.
21770
21771 Unlike most options, &%headers_remove%& can be specified multiple times
21772 for a transport; all listed headers are removed.
21773
21774 &*Warning*&: Because of the separate expansion of the list items,
21775 items that contain a list separator must have it doubled.
21776 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21777
21778
21779
21780 .option headers_rewrite transports string unset
21781 .cindex "transport" "header lines; rewriting"
21782 .cindex "rewriting" "at transport time"
21783 This option allows addresses in header lines to be rewritten at transport time,
21784 that is, as the message is being copied to its destination. The contents of the
21785 option are a colon-separated list of rewriting rules. Each rule is in exactly
21786 the same form as one of the general rewriting rules that are applied when a
21787 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21788 example,
21789 .code
21790 headers_rewrite = a@b c@d f : \
21791                   x@y w@z
21792 .endd
21793 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21794 &'w@z'& in all address-bearing header lines. The rules are applied to the
21795 header lines just before they are written out at transport time, so they affect
21796 only those copies of the message that pass through the transport. However, only
21797 the message's original header lines, and any that were added by a system
21798 filter, are rewritten. If a router or transport adds header lines, they are not
21799 affected by this option. These rewriting rules are &'not'& applied to the
21800 envelope. You can change the return path using &%return_path%&, but you cannot
21801 change envelope recipients at this time.
21802
21803
21804 .option home_directory transports string&!! unset
21805 .cindex "transport" "home directory for"
21806 .vindex "&$home$&"
21807 This option specifies a home directory setting for a local transport,
21808 overriding any value that may be set by the router. The home directory is
21809 placed in &$home$& while expanding the transport's private options. It is also
21810 used as the current directory if no current directory is set by the
21811 &%current_directory%& option on the transport or the
21812 &%transport_current_directory%& option on the router. If the expansion fails
21813 for any reason, including forced failure, an error is logged, and delivery is
21814 deferred.
21815
21816
21817 .option initgroups transports boolean false
21818 .cindex "additional groups"
21819 .cindex "groups" "additional"
21820 .cindex "transport" "group; additional"
21821 If this option is true and the uid for the delivery process is provided by the
21822 transport, the &[initgroups()]& function is called when running the transport
21823 to ensure that any additional groups associated with the uid are set up.
21824
21825
21826 .option max_parallel transports integer&!! unset
21827 .cindex limit "transport parallelism"
21828 .cindex transport "parallel processes"
21829 .cindex transport "concurrency limit"
21830 .cindex "delivery" "parallelism for transport"
21831 If this option is set and expands to an integer greater than zero
21832 it limits the number of concurrent runs of the transport.
21833 The control does not apply to shadow transports.
21834
21835 .cindex "hints database" "transport concurrency control"
21836 Exim implements this control by means of a hints database in which a record is
21837 incremented whenever a transport process is being created. The record
21838 is decremented and possibly removed when the process terminates.
21839 Obviously there is scope for
21840 records to get left lying around if there is a system or program crash. To
21841 guard against this, Exim ignores any records that are more than six hours old.
21842
21843 If you use this option, you should also arrange to delete the
21844 relevant hints database whenever your system reboots. The names of the files
21845 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21846 may be one or two files, depending on the type of DBM in use. The same files
21847 are used for ETRN and smtp transport serialization.
21848
21849
21850 .option message_size_limit transports string&!! 0
21851 .cindex "limit" "message size per transport"
21852 .cindex "size" "of message, limit"
21853 .cindex "transport" "message size; limiting"
21854 This option controls the size of messages passed through the transport. It is
21855 expanded before use; the result of the expansion must be a sequence of decimal
21856 digits, optionally followed by K or M. If the expansion fails for any reason,
21857 including forced failure, or if the result is not of the required form,
21858 delivery is deferred. If the value is greater than zero and the size of a
21859 message exceeds this limit, the address is failed. If there is any chance that
21860 the resulting bounce message could be routed to the same transport, you should
21861 ensure that &%return_size_limit%& is less than the transport's
21862 &%message_size_limit%&, as otherwise the bounce message will fail to get
21863 delivered.
21864
21865
21866
21867 .option rcpt_include_affixes transports boolean false
21868 .cindex "prefix" "for local part, including in envelope"
21869 .cindex "suffix for local part" "including in envelope"
21870 .cindex "local part" "prefix"
21871 .cindex "local part" "suffix"
21872 When this option is false (the default), and an address that has had any
21873 affixes (prefixes or suffixes) removed from the local part is delivered by any
21874 form of SMTP or LMTP, the affixes are not included. For example, if a router
21875 that contains
21876 .code
21877 local_part_prefix = *-
21878 .endd
21879 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21880 is delivered with
21881 .code
21882 RCPT TO:<xyz@some.domain>
21883 .endd
21884 This is also the case when an ACL-time callout is being used to verify a
21885 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21886 whole local part is included in the RCPT command. This option applies to BSMTP
21887 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21888 &(lmtp)& and &(smtp)& transports.
21889
21890
21891 .option retry_use_local_part transports boolean "see below"
21892 .cindex "hints database" "retry keys"
21893 When a delivery suffers a temporary failure, a retry record is created
21894 in Exim's hints database. For remote deliveries, the key for the retry record
21895 is based on the name and/or IP address of the failing remote host. For local
21896 deliveries, the key is normally the entire address, including both the local
21897 part and the domain. This is suitable for most common cases of local delivery
21898 temporary failure &-- for example, exceeding a mailbox quota should delay only
21899 deliveries to that mailbox, not to the whole domain.
21900
21901 However, in some special cases you may want to treat a temporary local delivery
21902 as a failure associated with the domain, and not with a particular local part.
21903 (For example, if you are storing all mail for some domain in files.) You can do
21904 this by setting &%retry_use_local_part%& false.
21905
21906 For all the local transports, its default value is true. For remote transports,
21907 the default value is false for tidiness, but changing the value has no effect
21908 on a remote transport in the current implementation.
21909
21910
21911 .option return_path transports string&!! unset
21912 .cindex "envelope sender"
21913 .cindex "envelope from"
21914 .cindex "transport" "return path; changing"
21915 .cindex "return path" "changing in transport"
21916 If this option is set, the string is expanded at transport time and replaces
21917 the existing return path (envelope sender) value in the copy of the message
21918 that is being delivered. An empty return path is permitted. This feature is
21919 designed for remote deliveries, where the value of this option is used in the
21920 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21921 only effect is to change the address that is placed in the &'Return-path:'&
21922 header line, if one is added to the message (see the next option).
21923
21924 &*Note:*& A changed return path is not logged unless you add
21925 &%return_path_on_delivery%& to the log selector.
21926
21927 .vindex "&$return_path$&"
21928 The expansion can refer to the existing value via &$return_path$&. This is
21929 either the message's envelope sender, or an address set by the
21930 &%errors_to%& option on a router. If the expansion is forced to fail, no
21931 replacement occurs; if it fails for another reason, delivery is deferred. This
21932 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21933 section &<<SECTverp>>&.
21934
21935 &*Note*&: If a delivery error is detected locally, including the case when a
21936 remote server rejects a message at SMTP time, the bounce message is not sent to
21937 the value of this option. It is sent to the previously set errors address.
21938 This defaults to the incoming sender address, but can be changed by setting
21939 &%errors_to%& in a router.
21940
21941
21942
21943 .option return_path_add transports boolean false
21944 .cindex "&'Return-path:'& header line"
21945 If this option is true, a &'Return-path:'& header is added to the message.
21946 Although the return path is normally available in the prefix line of BSD
21947 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21948 have easy access to it.
21949
21950 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21951 the delivery SMTP server makes the final delivery"&. This implies that this
21952 header should not be present in incoming messages. Exim has a configuration
21953 option, &%return_path_remove%&, which requests removal of this header from
21954 incoming messages, so that delivered messages can safely be resent to other
21955 recipients.
21956
21957
21958 .option shadow_condition transports string&!! unset
21959 See &%shadow_transport%& below.
21960
21961
21962 .option shadow_transport transports string unset
21963 .cindex "shadow transport"
21964 .cindex "transport" "shadow"
21965 A local transport may set the &%shadow_transport%& option to the name of
21966 another local transport. Shadow remote transports are not supported.
21967
21968 Whenever a delivery to the main transport succeeds, and either
21969 &%shadow_condition%& is unset, or its expansion does not result in the empty
21970 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21971 passed to the shadow transport, with the same delivery address or addresses. If
21972 expansion fails, no action is taken except that non-forced expansion failures
21973 cause a log line to be written.
21974
21975 The result of the shadow transport is discarded and does not affect the
21976 subsequent processing of the message. Only a single level of shadowing is
21977 provided; the &%shadow_transport%& option is ignored on any transport when it
21978 is running as a shadow. Options concerned with output from pipes are also
21979 ignored. The log line for the successful delivery has an item added on the end,
21980 of the form
21981 .code
21982 ST=<shadow transport name>
21983 .endd
21984 If the shadow transport did not succeed, the error message is put in
21985 parentheses afterwards. Shadow transports can be used for a number of different
21986 purposes, including keeping more detailed log information than Exim normally
21987 provides, and implementing automatic acknowledgment policies based on message
21988 headers that some sites insist on.
21989
21990
21991 .option transport_filter transports string&!! unset
21992 .cindex "transport" "filter"
21993 .cindex "filter" "transport filter"
21994 This option sets up a filtering (in the Unix shell sense) process for messages
21995 at transport time. It should not be confused with mail filtering as set up by
21996 individual users or via a system filter.
21997 If unset, or expanding to an empty string, no filtering is done.
21998
21999 When the message is about to be written out, the command specified by
22000 &%transport_filter%& is started up in a separate, parallel process, and
22001 the entire message, including the header lines, is passed to it on its standard
22002 input (this in fact is done from a third process, to avoid deadlock). The
22003 command must be specified as an absolute path.
22004
22005 The lines of the message that are written to the transport filter are
22006 terminated by newline (&"\n"&). The message is passed to the filter before any
22007 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22008 lines beginning with a dot, and also before any processing implied by the
22009 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22010 &(pipe)& transports.
22011
22012 The standard error for the filter process is set to the same destination as its
22013 standard output; this is read and written to the message's ultimate
22014 destination. The process that writes the message to the filter, the
22015 filter itself, and the original process that reads the result and delivers it
22016 are all run in parallel, like a shell pipeline.
22017
22018 The filter can perform any transformations it likes, but of course should take
22019 care not to break RFC 2822 syntax. Exim does not check the result, except to
22020 test for a final newline when SMTP is in use. All messages transmitted over
22021 SMTP must end with a newline, so Exim supplies one if it is missing.
22022
22023 .cindex "content scanning" "per user"
22024 A transport filter can be used to provide content-scanning on a per-user basis
22025 at delivery time if the only required effect of the scan is to modify the
22026 message. For example, a content scan could insert a new header line containing
22027 a spam score. This could be interpreted by a filter in the user's MUA. It is
22028 not possible to discard a message at this stage.
22029
22030 .cindex "SMTP" "SIZE"
22031 A problem might arise if the filter increases the size of a message that is
22032 being sent down an SMTP connection. If the receiving SMTP server has indicated
22033 support for the SIZE parameter, Exim will have sent the size of the message
22034 at the start of the SMTP session. If what is actually sent is substantially
22035 more, the server might reject the message. This can be worked round by setting
22036 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22037 additions to the message, or to disable the use of SIZE altogether.
22038
22039 .vindex "&$pipe_addresses$&"
22040 The value of the &%transport_filter%& option is the command string for starting
22041 the filter, which is run directly from Exim, not under a shell. The string is
22042 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22043 Exim breaks it up into arguments and then expands each argument separately (see
22044 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22045 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22046 of arguments, one for each address that applies to this delivery. (This isn't
22047 an ideal name for this feature here, but as it was already implemented for the
22048 &(pipe)& transport, it seemed sensible not to change it.)
22049
22050 .vindex "&$host$&"
22051 .vindex "&$host_address$&"
22052 The expansion variables &$host$& and &$host_address$& are available when the
22053 transport is a remote one. They contain the name and IP address of the host to
22054 which the message is being sent. For example:
22055 .code
22056 transport_filter = /some/directory/transport-filter.pl \
22057   $host $host_address $sender_address $pipe_addresses
22058 .endd
22059
22060 Two problems arise if you want to use more complicated expansion items to
22061 generate transport filter commands, both of which due to the fact that the
22062 command is split up &'before'& expansion.
22063 .ilist
22064 If an expansion item contains white space, you must quote it, so that it is all
22065 part of the same command item. If the entire option setting is one such
22066 expansion item, you have to take care what kind of quoting you use. For
22067 example:
22068 .code
22069 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22070 .endd
22071 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22072 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22073 stripped by Exim when it read the option's value. When the value is used, if
22074 the single quotes were missing, the line would be split into two items,
22075 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22076 Exim tried to expand the first one.
22077 .next
22078 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22079 expansion cannot generate multiple arguments, or a command name followed by
22080 arguments. Consider this example:
22081 .code
22082 transport_filter = ${lookup{$host}lsearch{/a/file}\
22083                     {$value}{/bin/cat}}
22084 .endd
22085 The result of the lookup is interpreted as the name of the command, even
22086 if it contains white space. The simplest way round this is to use a shell:
22087 .code
22088 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22089                                {$value}{/bin/cat}}
22090 .endd
22091 .endlist
22092
22093 The filter process is run under the same uid and gid as the normal delivery.
22094 For remote deliveries this is the Exim uid/gid by default. The command should
22095 normally yield a zero return code. Transport filters are not supposed to fail.
22096 A non-zero code is taken to mean that the transport filter encountered some
22097 serious problem. Delivery of the message is deferred; the message remains on
22098 the queue and is tried again later. It is not possible to cause a message to be
22099 bounced from a transport filter.
22100
22101 If a transport filter is set on an autoreply transport, the original message is
22102 passed through the filter as it is being copied into the newly generated
22103 message, which happens if the &%return_message%& option is set.
22104
22105
22106 .option transport_filter_timeout transports time 5m
22107 .cindex "transport" "filter, timeout"
22108 When Exim is reading the output of a transport filter, it applies a timeout
22109 that can be set by this option. Exceeding the timeout is normally treated as a
22110 temporary delivery failure. However, if a transport filter is used with a
22111 &(pipe)& transport, a timeout in the transport filter is treated in the same
22112 way as a timeout in the pipe command itself. By default, a timeout is a hard
22113 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22114 becomes a temporary error.
22115
22116
22117 .option user transports string&!! "Exim user"
22118 .cindex "uid (user id)" "local delivery"
22119 .cindex "transport" "user, specifying"
22120 This option specifies the user under whose uid the delivery process is to be
22121 run, overriding any uid that may have been set by the router. If the user is
22122 given as a name, the uid is looked up from the password data, and the
22123 associated group is taken as the value of the gid to be used if the &%group%&
22124 option is not set.
22125
22126 For deliveries that use local transports, a user and group are normally
22127 specified explicitly or implicitly (for example, as a result of
22128 &%check_local_user%&) by the router or transport.
22129
22130 .cindex "hints database" "access by remote transport"
22131 For remote transports, you should leave this option unset unless you really are
22132 sure you know what you are doing. When a remote transport is running, it needs
22133 to be able to access Exim's hints databases, because each host may have its own
22134 retry data.
22135 .ecindex IIDgenoptra1
22136 .ecindex IIDgenoptra2
22137 .ecindex IIDgenoptra3
22138
22139
22140
22141
22142
22143
22144 . ////////////////////////////////////////////////////////////////////////////
22145 . ////////////////////////////////////////////////////////////////////////////
22146
22147 .chapter "Address batching in local transports" "CHAPbatching" &&&
22148          "Address batching"
22149 .cindex "transport" "local; address batching in"
22150 The only remote transport (&(smtp)&) is normally configured to handle more than
22151 one address at a time, so that when several addresses are routed to the same
22152 remote host, just one copy of the message is sent. Local transports, however,
22153 normally handle one address at a time. That is, a separate instance of the
22154 transport is run for each address that is routed to the transport. A separate
22155 copy of the message is delivered each time.
22156
22157 .cindex "batched local delivery"
22158 .oindex "&%batch_max%&"
22159 .oindex "&%batch_id%&"
22160 In special cases, it may be desirable to handle several addresses at once in a
22161 local transport, for example:
22162
22163 .ilist
22164 In an &(appendfile)& transport, when storing messages in files for later
22165 delivery by some other means, a single copy of the message with multiple
22166 recipients saves space.
22167 .next
22168 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22169 a single copy saves time, and is the normal way LMTP is expected to work.
22170 .next
22171 In a &(pipe)& transport, when passing the message
22172 to a scanner program or
22173 to some other delivery mechanism such as UUCP, multiple recipients may be
22174 acceptable.
22175 .endlist
22176
22177 These three local transports all have the same options for controlling multiple
22178 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22179 repeating the information for each transport, these options are described here.
22180
22181 The &%batch_max%& option specifies the maximum number of addresses that can be
22182 delivered together in a single run of the transport. Its default value is one
22183 (no batching). When more than one address is routed to a transport that has a
22184 &%batch_max%& value greater than one, the addresses are delivered in a batch
22185 (that is, in a single run of the transport with multiple recipients), subject
22186 to certain conditions:
22187
22188 .ilist
22189 .vindex "&$local_part$&"
22190 If any of the transport's options contain a reference to &$local_part$&, no
22191 batching is possible.
22192 .next
22193 .vindex "&$domain$&"
22194 If any of the transport's options contain a reference to &$domain$&, only
22195 addresses with the same domain are batched.
22196 .next
22197 .cindex "customizing" "batching condition"
22198 If &%batch_id%& is set, it is expanded for each address, and only those
22199 addresses with the same expanded value are batched. This allows you to specify
22200 customized batching conditions. Failure of the expansion for any reason,
22201 including forced failure, disables batching, but it does not stop the delivery
22202 from taking place.
22203 .next
22204 Batched addresses must also have the same errors address (where to send
22205 delivery errors), the same header additions and removals, the same user and
22206 group for the transport, and if a host list is present, the first host must
22207 be the same.
22208 .endlist
22209
22210 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22211 both when the file or pipe command is specified in the transport, and when it
22212 is specified by a &(redirect)& router, but all the batched addresses must of
22213 course be routed to the same file or pipe command. These two transports have an
22214 option called &%use_bsmtp%&, which causes them to deliver the message in
22215 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22216 &%check_string%& and &%escape_string%& options are forced to the values
22217 .code
22218 check_string = "."
22219 escape_string = ".."
22220 .endd
22221 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22222 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22223 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22224
22225 .cindex "&'Envelope-to:'& header line"
22226 If the generic &%envelope_to_add%& option is set for a batching transport, the
22227 &'Envelope-to:'& header that is added to the message contains all the addresses
22228 that are being processed together. If you are using a batching &(appendfile)&
22229 transport without &%use_bsmtp%&, the only way to preserve the recipient
22230 addresses is to set the &%envelope_to_add%& option.
22231
22232 .cindex "&(pipe)& transport" "with multiple addresses"
22233 .vindex "&$pipe_addresses$&"
22234 If you are using a &(pipe)& transport without BSMTP, and setting the
22235 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22236 the command. This is not a true variable; it is a bit of magic that causes each
22237 of the recipient addresses to be inserted into the command as a separate
22238 argument. This provides a way of accessing all the addresses that are being
22239 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22240 are specified by a &(redirect)& router.
22241
22242
22243
22244
22245 . ////////////////////////////////////////////////////////////////////////////
22246 . ////////////////////////////////////////////////////////////////////////////
22247
22248 .chapter "The appendfile transport" "CHAPappendfile"
22249 .scindex IIDapptra1 "&(appendfile)& transport"
22250 .scindex IIDapptra2 "transports" "&(appendfile)&"
22251 .cindex "directory creation"
22252 .cindex "creating directories"
22253 The &(appendfile)& transport delivers a message by appending it to an existing
22254 file, or by creating an entirely new file in a specified directory. Single
22255 files to which messages are appended can be in the traditional Unix mailbox
22256 format, or optionally in the MBX format supported by the Pine MUA and
22257 University of Washington IMAP daemon, &'inter alia'&. When each message is
22258 being delivered as a separate file, &"maildir"& format can optionally be used
22259 to give added protection against failures that happen part-way through the
22260 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22261 supported. For all file formats, Exim attempts to create as many levels of
22262 directory as necessary, provided that &%create_directory%& is set.
22263
22264 The code for the optional formats is not included in the Exim binary by
22265 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22266 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22267 included.
22268
22269 .cindex "quota" "system"
22270 Exim recognizes system quota errors, and generates an appropriate message. Exim
22271 also supports its own quota control within the transport, for use when the
22272 system facility is unavailable or cannot be used for some reason.
22273
22274 If there is an error while appending to a file (for example, quota exceeded or
22275 partition filled), Exim attempts to reset the file's length and last
22276 modification time back to what they were before. If there is an error while
22277 creating an entirely new file, the new file is removed.
22278
22279 Before appending to a file, a number of security checks are made, and the
22280 file is locked. A detailed description is given below, after the list of
22281 private options.
22282
22283 The &(appendfile)& transport is most commonly used for local deliveries to
22284 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22285 putting messages into files for remote delivery by some means other than Exim.
22286 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22287 option).
22288
22289
22290
22291 .section "The file and directory options" "SECTfildiropt"
22292 The &%file%& option specifies a single file, to which the message is appended;
22293 the &%directory%& option specifies a directory, in which a new file containing
22294 the message is created. Only one of these two options can be set, and for
22295 normal deliveries to mailboxes, one of them &'must'& be set.
22296
22297 .vindex "&$address_file$&"
22298 .vindex "&$local_part$&"
22299 However, &(appendfile)& is also used for delivering messages to files or
22300 directories whose names (or parts of names) are obtained from alias,
22301 forwarding, or filtering operations (for example, a &%save%& command in a
22302 user's Exim filter). When such a transport is running, &$local_part$& contains
22303 the local part that was aliased or forwarded, and &$address_file$& contains the
22304 name (or partial name) of the file or directory generated by the redirection
22305 operation. There are two cases:
22306
22307 .ilist
22308 If neither &%file%& nor &%directory%& is set, the redirection operation
22309 must specify an absolute path (one that begins with &`/`&). This is the most
22310 common case when users with local accounts use filtering to sort mail into
22311 different folders. See for example, the &(address_file)& transport in the
22312 default configuration. If the path ends with a slash, it is assumed to be the
22313 name of a directory. A delivery to a directory can also be forced by setting
22314 &%maildir_format%& or &%mailstore_format%&.
22315 .next
22316 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22317 used to determine the file or directory name for the delivery. Normally, the
22318 contents of &$address_file$& are used in some way in the string expansion.
22319 .endlist
22320
22321
22322 .cindex "Sieve filter" "configuring &(appendfile)&"
22323 .cindex "Sieve filter" "relative mailbox path handling"
22324 As an example of the second case, consider an environment where users do not
22325 have home directories. They may be permitted to use Exim filter commands of the
22326 form:
22327 .code
22328 save folder23
22329 .endd
22330 or Sieve filter commands of the form:
22331 .code
22332 require "fileinto";
22333 fileinto "folder23";
22334 .endd
22335 In this situation, the expansion of &%file%& or &%directory%& in the transport
22336 must transform the relative path into an appropriate absolute filename. In the
22337 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22338 is used as a result of a &"keep"& action in the filter. This example shows one
22339 way of handling this requirement:
22340 .code
22341 file = ${if eq{$address_file}{inbox} \
22342             {/var/mail/$local_part} \
22343             {${if eq{${substr_0_1:$address_file}}{/} \
22344                   {$address_file} \
22345                   {$home/mail/$address_file} \
22346             }} \
22347        }
22348 .endd
22349 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22350 location, absolute paths are used without change, and other folders are in the
22351 &_mail_& directory within the home directory.
22352
22353 &*Note 1*&: While processing an Exim filter, a relative path such as
22354 &_folder23_& is turned into an absolute path if a home directory is known to
22355 the router. In particular, this is the case if &%check_local_user%& is set. If
22356 you want to prevent this happening at routing time, you can set
22357 &%router_home_directory%& empty. This forces the router to pass the relative
22358 path to the transport.
22359
22360 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22361 the &%file%& or &%directory%& option is still used if it is set.
22362
22363
22364
22365
22366 .section "Private options for appendfile" "SECID134"
22367 .cindex "options" "&(appendfile)& transport"
22368
22369
22370
22371 .option allow_fifo appendfile boolean false
22372 .cindex "fifo (named pipe)"
22373 .cindex "named pipe (fifo)"
22374 .cindex "pipe" "named (fifo)"
22375 Setting this option permits delivery to named pipes (FIFOs) as well as to
22376 regular files. If no process is reading the named pipe at delivery time, the
22377 delivery is deferred.
22378
22379
22380 .option allow_symlink appendfile boolean false
22381 .cindex "symbolic link" "to mailbox"
22382 .cindex "mailbox" "symbolic link"
22383 By default, &(appendfile)& will not deliver if the path name for the file is
22384 that of a symbolic link. Setting this option relaxes that constraint, but there
22385 are security issues involved in the use of symbolic links. Be sure you know
22386 what you are doing if you set this. Details of exactly what this option affects
22387 are included in the discussion which follows this list of options.
22388
22389
22390 .option batch_id appendfile string&!! unset
22391 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22392 However, batching is automatically disabled for &(appendfile)& deliveries that
22393 happen as a result of forwarding or aliasing or other redirection directly to a
22394 file.
22395
22396
22397 .option batch_max appendfile integer 1
22398 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22399
22400
22401 .option check_group appendfile boolean false
22402 When this option is set, the group owner of the file defined by the &%file%&
22403 option is checked to see that it is the same as the group under which the
22404 delivery process is running. The default setting is false because the default
22405 file mode is 0600, which means that the group is irrelevant.
22406
22407
22408 .option check_owner appendfile boolean true
22409 When this option is set, the owner of the file defined by the &%file%& option
22410 is checked to ensure that it is the same as the user under which the delivery
22411 process is running.
22412
22413
22414 .option check_string appendfile string "see below"
22415 .cindex "&""From""& line"
22416 As &(appendfile)& writes the message, the start of each line is tested for
22417 matching &%check_string%&, and if it does, the initial matching characters are
22418 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22419 a literal string, not a regular expression, and the case of any letters it
22420 contains is significant.
22421
22422 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22423 are forced to &"."& and &".."& respectively, and any settings in the
22424 configuration are ignored. Otherwise, they default to &"From&~"& and
22425 &">From&~"& when the &%file%& option is set, and unset when any of the
22426 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22427
22428 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22429 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22430 &"From&~"& indicates the start of a new message. All four options need changing
22431 if another format is used. For example, to deliver to mailboxes in MMDF format:
22432 .cindex "MMDF format mailbox"
22433 .cindex "mailbox" "MMDF format"
22434 .code
22435 check_string = "\1\1\1\1\n"
22436 escape_string = "\1\1\1\1 \n"
22437 message_prefix = "\1\1\1\1\n"
22438 message_suffix = "\1\1\1\1\n"
22439 .endd
22440 .option create_directory appendfile boolean true
22441 .cindex "directory creation"
22442 When this option is true, Exim attempts to create any missing superior
22443 directories for the file that it is about to write. A created directory's mode
22444 is given by the &%directory_mode%& option.
22445
22446 The group ownership of a newly created directory is highly dependent on the
22447 operating system (and possibly the file system) that is being used. For
22448 example, in Solaris, if the parent directory has the setgid bit set, its group
22449 is propagated to the child; if not, the currently set group is used. However,
22450 in FreeBSD, the parent's group is always used.
22451
22452
22453
22454 .option create_file appendfile string anywhere
22455 This option constrains the location of files and directories that are created
22456 by this transport. It applies to files defined by the &%file%& option and
22457 directories defined by the &%directory%& option. In the case of maildir
22458 delivery, it applies to the top level directory, not the maildir directories
22459 beneath.
22460
22461 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22462 &"belowhome"&. In the second and third cases, a home directory must have been
22463 set for the transport. This option is not useful when an explicit filename is
22464 given for normal mailbox deliveries. It is intended for the case when filenames
22465 are generated from users' &_.forward_& files. These are usually handled
22466 by an &(appendfile)& transport called &%address_file%&. See also
22467 &%file_must_exist%&.
22468
22469
22470 .option directory appendfile string&!! unset
22471 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22472 or &%directory%& must be set, unless the delivery is the direct result of a
22473 redirection (see section &<<SECTfildiropt>>&).
22474
22475 When &%directory%& is set, the string is expanded, and the message is delivered
22476 into a new file or files in or below the given directory, instead of being
22477 appended to a single mailbox file. A number of different formats are provided
22478 (see &%maildir_format%& and &%mailstore_format%&), and see section
22479 &<<SECTopdir>>& for further details of this form of delivery.
22480
22481
22482 .option directory_file appendfile string&!! "see below"
22483 .cindex "base62"
22484 .vindex "&$inode$&"
22485 When &%directory%& is set, but neither &%maildir_format%& nor
22486 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22487 whose name is obtained by expanding this string. The default value is:
22488 .code
22489 q${base62:$tod_epoch}-$inode
22490 .endd
22491 This generates a unique name from the current time, in base 62 form, and the
22492 inode of the file. The variable &$inode$& is available only when expanding this
22493 option.
22494
22495
22496 .option directory_mode appendfile "octal integer" 0700
22497 If &(appendfile)& creates any directories as a result of the
22498 &%create_directory%& option, their mode is specified by this option.
22499
22500
22501 .option escape_string appendfile string "see description"
22502 See &%check_string%& above.
22503
22504
22505 .option file appendfile string&!! unset
22506 This option is mutually exclusive with the &%directory%& option, but one of
22507 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22508 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22509 specifies a single file, to which the message is appended. One or more of
22510 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22511 &%file%&.
22512
22513 .cindex "NFS" "lock file"
22514 .cindex "locking files"
22515 .cindex "lock files"
22516 If you are using more than one host to deliver over NFS into the same
22517 mailboxes, you should always use lock files.
22518
22519 The string value is expanded for each delivery, and must yield an absolute
22520 path. The most common settings of this option are variations on one of these
22521 examples:
22522 .code
22523 file = /var/spool/mail/$local_part
22524 file = /home/$local_part/inbox
22525 file = $home/inbox
22526 .endd
22527 .cindex "&""sticky""& bit"
22528 In the first example, all deliveries are done into the same directory. If Exim
22529 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22530 create a file in the directory, so the &"sticky"& bit must be turned on for
22531 deliveries to be possible, or alternatively the &%group%& option can be used to
22532 run the delivery under a group id which has write access to the directory.
22533
22534
22535
22536 .option file_format appendfile string unset
22537 .cindex "file" "mailbox; checking existing format"
22538 This option requests the transport to check the format of an existing file
22539 before adding to it. The check consists of matching a specific string at the
22540 start of the file. The value of the option consists of an even number of
22541 colon-separated strings. The first of each pair is the test string, and the
22542 second is the name of a transport. If the transport associated with a matched
22543 string is not the current transport, control is passed over to the other
22544 transport. For example, suppose the standard &(local_delivery)& transport has
22545 this added to it:
22546 .code
22547 file_format = "From       : local_delivery :\
22548                \1\1\1\1\n : local_mmdf_delivery"
22549 .endd
22550 Mailboxes that begin with &"From"& are still handled by this transport, but if
22551 a mailbox begins with four binary ones followed by a newline, control is passed
22552 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22553 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22554 is assumed to match the current transport. If the start of a mailbox doesn't
22555 match any string, or if the transport named for a given string is not defined,
22556 delivery is deferred.
22557
22558
22559 .option file_must_exist appendfile boolean false
22560 If this option is true, the file specified by the &%file%& option must exist.
22561 A temporary error occurs if it does not, causing delivery to be deferred.
22562 If this option is false, the file is created if it does not exist.
22563
22564
22565 .option lock_fcntl_timeout appendfile time 0s
22566 .cindex "timeout" "mailbox locking"
22567 .cindex "mailbox" "locking, blocking and non-blocking"
22568 .cindex "locking files"
22569 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22570 when locking an open mailbox file. If the call fails, the delivery process
22571 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22572 Non-blocking calls are used so that the file is not kept open during the wait
22573 for the lock; the reason for this is to make it as safe as possible for
22574 deliveries over NFS in the case when processes might be accessing an NFS
22575 mailbox without using a lock file. This should not be done, but
22576 misunderstandings and hence misconfigurations are not unknown.
22577
22578 On a busy system, however, the performance of a non-blocking lock approach is
22579 not as good as using a blocking lock with a timeout. In this case, the waiting
22580 is done inside the system call, and Exim's delivery process acquires the lock
22581 and can proceed as soon as the previous lock holder releases it.
22582
22583 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22584 timeout, are used. There may still be some retrying: the maximum number of
22585 retries is
22586 .code
22587 (lock_retries * lock_interval) / lock_fcntl_timeout
22588 .endd
22589 rounded up to the next whole number. In other words, the total time during
22590 which &(appendfile)& is trying to get a lock is roughly the same, unless
22591 &%lock_fcntl_timeout%& is set very large.
22592
22593 You should consider setting this option if you are getting a lot of delayed
22594 local deliveries because of errors of the form
22595 .code
22596 failed to lock mailbox /some/file (fcntl)
22597 .endd
22598
22599 .option lock_flock_timeout appendfile time 0s
22600 This timeout applies to file locking when using &[flock()]& (see
22601 &%use_flock%&); the timeout operates in a similar manner to
22602 &%lock_fcntl_timeout%&.
22603
22604
22605 .option lock_interval appendfile time 3s
22606 This specifies the time to wait between attempts to lock the file. See below
22607 for details of locking.
22608
22609
22610 .option lock_retries appendfile integer 10
22611 This specifies the maximum number of attempts to lock the file. A value of zero
22612 is treated as 1. See below for details of locking.
22613
22614
22615 .option lockfile_mode appendfile "octal integer" 0600
22616 This specifies the mode of the created lock file, when a lock file is being
22617 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22618
22619
22620 .option lockfile_timeout appendfile time 30m
22621 .cindex "timeout" "mailbox locking"
22622 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22623 exists and is older than this value, it is assumed to have been left behind by
22624 accident, and Exim attempts to remove it.
22625
22626
22627 .option mailbox_filecount appendfile string&!! unset
22628 .cindex "mailbox" "specifying size of"
22629 .cindex "size" "of mailbox"
22630 If this option is set, it is expanded, and the result is taken as the current
22631 number of files in the mailbox. It must be a decimal number, optionally
22632 followed by K or M. This provides a way of obtaining this information from an
22633 external source that maintains the data.
22634
22635
22636 .option mailbox_size appendfile string&!! unset
22637 .cindex "mailbox" "specifying size of"
22638 .cindex "size" "of mailbox"
22639 If this option is set, it is expanded, and the result is taken as the current
22640 size the mailbox. It must be a decimal number, optionally followed by K or M.
22641 This provides a way of obtaining this information from an external source that
22642 maintains the data. This is likely to be helpful for maildir deliveries where
22643 it is computationally expensive to compute the size of a mailbox.
22644
22645
22646
22647 .option maildir_format appendfile boolean false
22648 .cindex "maildir format" "specifying"
22649 If this option is set with the &%directory%& option, the delivery is into a new
22650 file, in the &"maildir"& format that is used by other mail software. When the
22651 transport is activated directly from a &(redirect)& router (for example, the
22652 &(address_file)& transport in the default configuration), setting
22653 &%maildir_format%& causes the path received from the router to be treated as a
22654 directory, whether or not it ends with &`/`&. This option is available only if
22655 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22656 &<<SECTmaildirdelivery>>& below for further details.
22657
22658
22659 .option maildir_quota_directory_regex appendfile string "See below"
22660 .cindex "maildir format" "quota; directories included in"
22661 .cindex "quota" "maildir; directories included in"
22662 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22663 a regular expression for specifying directories, relative to the quota
22664 directory (see &%quota_directory%&), that should be included in the quota
22665 calculation. The default value is:
22666 .code
22667 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22668 .endd
22669 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22670 (directories whose names begin with a dot). If you want to exclude the
22671 &_Trash_&
22672 folder from the count (as some sites do), you need to change this setting to
22673 .code
22674 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22675 .endd
22676 This uses a negative lookahead in the regular expression to exclude the
22677 directory whose name is &_.Trash_&. When a directory is excluded from quota
22678 calculations, quota processing is bypassed for any messages that are delivered
22679 directly into that directory.
22680
22681
22682 .option maildir_retries appendfile integer 10
22683 This option specifies the number of times to retry when writing a file in
22684 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22685
22686
22687 .option maildir_tag appendfile string&!! unset
22688 This option applies only to deliveries in maildir format, and is described in
22689 section &<<SECTmaildirdelivery>>& below.
22690
22691
22692 .option maildir_use_size_file appendfile&!! boolean false
22693 .cindex "maildir format" "&_maildirsize_& file"
22694 The result of string expansion for this option must be a valid boolean value.
22695 If it is true, it enables support for &_maildirsize_& files. Exim
22696 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22697 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22698 value is zero. See &%maildir_quota_directory_regex%& above and section
22699 &<<SECTmaildirdelivery>>& below for further details.
22700
22701 .option maildirfolder_create_regex appendfile string unset
22702 .cindex "maildir format" "&_maildirfolder_& file"
22703 .cindex "&_maildirfolder_&, creating"
22704 The value of this option is a regular expression. If it is unset, it has no
22705 effect. Otherwise, before a maildir delivery takes place, the pattern is
22706 matched against the name of the maildir directory, that is, the directory
22707 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22708 delivery. If there is a match, Exim checks for the existence of a file called
22709 &_maildirfolder_& in the directory, and creates it if it does not exist.
22710 See section &<<SECTmaildirdelivery>>& for more details.
22711
22712
22713 .option mailstore_format appendfile boolean false
22714 .cindex "mailstore format" "specifying"
22715 If this option is set with the &%directory%& option, the delivery is into two
22716 new files in  &"mailstore"& format. The option is available only if
22717 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22718 below for further details.
22719
22720
22721 .option mailstore_prefix appendfile string&!! unset
22722 This option applies only to deliveries in mailstore format, and is described in
22723 section &<<SECTopdir>>& below.
22724
22725
22726 .option mailstore_suffix appendfile string&!! unset
22727 This option applies only to deliveries in mailstore format, and is described in
22728 section &<<SECTopdir>>& below.
22729
22730
22731 .option mbx_format appendfile boolean false
22732 .cindex "locking files"
22733 .cindex "file" "locking"
22734 .cindex "file" "MBX format"
22735 .cindex "MBX format, specifying"
22736 This option is available only if Exim has been compiled with SUPPORT_MBX
22737 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22738 the message is appended to the mailbox file in MBX format instead of
22739 traditional Unix format. This format is supported by Pine4 and its associated
22740 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22741
22742 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22743 automatically changed by the use of &%mbx_format%&. They should normally be set
22744 empty when using MBX format, so this option almost always appears in this
22745 combination:
22746 .code
22747 mbx_format = true
22748 message_prefix =
22749 message_suffix =
22750 .endd
22751 If none of the locking options are mentioned in the configuration,
22752 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22753 is possible to specify the other kinds of locking with &%mbx_format%&, but
22754 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22755 interworks with &'c-client'&, providing for shared access to the mailbox. It
22756 should not be used if any program that does not use this form of locking is
22757 going to access the mailbox, nor should it be used if the mailbox file is NFS
22758 mounted, because it works only when the mailbox is accessed from a single host.
22759
22760 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22761 the standard version of &'c-client'&, because as long as it has a mailbox open
22762 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22763 append messages to it.
22764
22765
22766 .option message_prefix appendfile string&!! "see below"
22767 .cindex "&""From""& line"
22768 The string specified here is expanded and output at the start of every message.
22769 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22770 in which case it is:
22771 .code
22772 message_prefix = "From ${if def:return_path{$return_path}\
22773   {MAILER-DAEMON}} $tod_bsdinbox\n"
22774 .endd
22775 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22776 &`\n`& to &`\r\n`& in &%message_prefix%&.
22777
22778 .option message_suffix appendfile string&!! "see below"
22779 The string specified here is expanded and output at the end of every message.
22780 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22781 in which case it is a single newline character. The suffix can be suppressed by
22782 setting
22783 .code
22784 message_suffix =
22785 .endd
22786 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22787 &`\n`& to &`\r\n`& in &%message_suffix%&.
22788
22789 .option mode appendfile "octal integer" 0600
22790 If the output file is created, it is given this mode. If it already exists and
22791 has wider permissions, they are reduced to this mode. If it has narrower
22792 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22793 if the delivery is the result of a &%save%& command in a filter file specifying
22794 a particular mode, the mode of the output file is always forced to take that
22795 value, and this option is ignored.
22796
22797
22798 .option mode_fail_narrower appendfile boolean true
22799 This option applies in the case when an existing mailbox file has a narrower
22800 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22801 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22802 continues with the delivery attempt, using the existing mode of the file.
22803
22804
22805 .option notify_comsat appendfile boolean false
22806 If this option is true, the &'comsat'& daemon is notified after every
22807 successful delivery to a user mailbox. This is the daemon that notifies logged
22808 on users about incoming mail.
22809
22810
22811 .option quota appendfile string&!! unset
22812 .cindex "quota" "imposed by Exim"
22813 This option imposes a limit on the size of the file to which Exim is appending,
22814 or to the total space used in the directory tree when the &%directory%& option
22815 is set. In the latter case, computation of the space used is expensive, because
22816 all the files in the directory (and any sub-directories) have to be
22817 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22818 &%maildir_use_size_file%& for ways to avoid this in environments where users
22819 have no shell access to their mailboxes).
22820
22821 As there is no interlock against two simultaneous deliveries into a
22822 multi-file mailbox, it is possible for the quota to be overrun in this case.
22823 For single-file mailboxes, of course, an interlock is a necessity.
22824
22825 A file's size is taken as its &'used'& value. Because of blocking effects, this
22826 may be a lot less than the actual amount of disk space allocated to the file.
22827 If the sizes of a number of files are being added up, the rounding effect can
22828 become quite noticeable, especially on systems that have large block sizes.
22829 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22830 the obvious value which users understand most easily.
22831
22832 The value of the option is expanded, and must then be a numerical value
22833 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22834 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22835 and further option modifiers. If Exim is running on a system with
22836 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22837 be handled.
22838
22839 The option modifier &%no_check%& can be used to force delivery even if the over
22840 quota condition is met. The quota gets updated as usual.
22841
22842 &*Note*&: A value of zero is interpreted as &"no quota"&.
22843
22844 The expansion happens while Exim is running as root, before it changes uid for
22845 the delivery. This means that files that are inaccessible to the end user can
22846 be used to hold quota values that are looked up in the expansion. When delivery
22847 fails because this quota is exceeded, the handling of the error is as for
22848 system quota failures.
22849
22850 By default, Exim's quota checking mimics system quotas, and restricts the
22851 mailbox to the specified maximum size, though the value is not accurate to the
22852 last byte, owing to separator lines and additional headers that may get added
22853 during message delivery. When a mailbox is nearly full, large messages may get
22854 refused even though small ones are accepted, because the size of the current
22855 message is added to the quota when the check is made. This behaviour can be
22856 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22857 for exceeding the quota does not include the current message. Thus, deliveries
22858 continue until the quota has been exceeded; thereafter, no further messages are
22859 delivered. See also &%quota_warn_threshold%&.
22860
22861
22862 .option quota_directory appendfile string&!! unset
22863 This option defines the directory to check for quota purposes when delivering
22864 into individual files. The default is the delivery directory, or, if a file
22865 called &_maildirfolder_& exists in a maildir directory, the parent of the
22866 delivery directory.
22867
22868
22869 .option quota_filecount appendfile string&!! 0
22870 This option applies when the &%directory%& option is set. It limits the total
22871 number of files in the directory (compare the inode limit in system quotas). It
22872 can only be used if &%quota%& is also set. The value is expanded; an expansion
22873 failure causes delivery to be deferred. A value of zero is interpreted as
22874 &"no quota"&.
22875
22876 The option modifier &%no_check%& can be used to force delivery even if the over
22877 quota condition is met. The quota gets updated as usual.
22878
22879 .option quota_is_inclusive appendfile boolean true
22880 See &%quota%& above.
22881
22882
22883 .option quota_size_regex appendfile string unset
22884 This option applies when one of the delivery modes that writes a separate file
22885 for each message is being used. When Exim wants to find the size of one of
22886 these files in order to test the quota, it first checks &%quota_size_regex%&.
22887 If this is set to a regular expression that matches the filename, and it
22888 captures one string, that string is interpreted as a representation of the
22889 file's size. The value of &%quota_size_regex%& is not expanded.
22890
22891 This feature is useful only when users have no shell access to their mailboxes
22892 &-- otherwise they could defeat the quota simply by renaming the files. This
22893 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22894 the file length to the filename. For example:
22895 .code
22896 maildir_tag = ,S=$message_size
22897 quota_size_regex = ,S=(\d+)
22898 .endd
22899 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22900 number of lines in the message.
22901
22902 The regular expression should not assume that the length is at the end of the
22903 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22904 sometimes add other information onto the ends of message filenames.
22905
22906 Section &<<SECID136>>& contains further information.
22907
22908 .new
22909 This option should not be used when other message-handling software
22910 may duplicate messages by making hardlinks to the files.  When that is done Exim
22911 will count the message size once for each filename, in contrast with the actual
22912 disk usage.  When the option is not set, calculating total usage requires
22913 a system-call per file to get the size; the number of links is then available also
22914 as is used to adjust the effective size.
22915 .wen
22916
22917
22918 .option quota_warn_message appendfile string&!! "see below"
22919 See below for the use of this option. If it is not set when
22920 &%quota_warn_threshold%& is set, it defaults to
22921 .code
22922 quota_warn_message = "\
22923   To: $local_part@$domain\n\
22924   Subject: Your mailbox\n\n\
22925   This message is automatically created \
22926   by mail delivery software.\n\n\
22927   The size of your mailbox has exceeded \
22928   a warning threshold that is\n\
22929   set by the system administrator.\n"
22930 .endd
22931
22932
22933 .option quota_warn_threshold appendfile string&!! 0
22934 .cindex "quota" "warning threshold"
22935 .cindex "mailbox" "size warning"
22936 .cindex "size" "of mailbox"
22937 This option is expanded in the same way as &%quota%& (see above). If the
22938 resulting value is greater than zero, and delivery of the message causes the
22939 size of the file or total space in the directory tree to cross the given
22940 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22941 may be specified as a percentage of it by following the value with a percent
22942 sign. For example:
22943 .code
22944 quota = 10M
22945 quota_warn_threshold = 75%
22946 .endd
22947 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22948 percent sign is ignored.
22949
22950 The warning message itself is specified by the &%quota_warn_message%& option,
22951 and it must start with a &'To:'& header line containing the recipient(s) of the
22952 warning message. These do not necessarily have to include the recipient(s) of
22953 the original message. A &'Subject:'& line should also normally be supplied. You
22954 can include any other header lines that you want. If you do not include a
22955 &'From:'& line, the default is:
22956 .code
22957 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22958 .endd
22959 .oindex &%errors_reply_to%&
22960 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22961 option.
22962
22963 The &%quota%& option does not have to be set in order to use this option; they
22964 are independent of one another except when the threshold is specified as a
22965 percentage.
22966
22967
22968 .option use_bsmtp appendfile boolean false
22969 .cindex "envelope from"
22970 .cindex "envelope sender"
22971 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22972 format, with the envelope sender and recipient(s) included as SMTP commands. If
22973 you want to include a leading HELO command with such messages, you can do
22974 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22975 for details of batch SMTP.
22976
22977
22978 .option use_crlf appendfile boolean false
22979 .cindex "carriage return"
22980 .cindex "linefeed"
22981 This option causes lines to be terminated with the two-character CRLF sequence
22982 (carriage return, linefeed) instead of just a linefeed character. In the case
22983 of batched SMTP, the byte sequence written to the file is then an exact image
22984 of what would be sent down a real SMTP connection.
22985
22986 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22987 (which are used to supply the traditional &"From&~"& and blank line separators
22988 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22989 carriage return characters if these are needed. In cases where these options
22990 have non-empty defaults, the values end with a single linefeed, so they must be
22991 changed to end with &`\r\n`& if &%use_crlf%& is set.
22992
22993
22994 .option use_fcntl_lock appendfile boolean "see below"
22995 This option controls the use of the &[fcntl()]& function to lock a file for
22996 exclusive use when a message is being appended. It is set by default unless
22997 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22998 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22999 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23000
23001
23002 .option use_flock_lock appendfile boolean false
23003 This option is provided to support the use of &[flock()]& for file locking, for
23004 the few situations where it is needed. Most modern operating systems support
23005 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23006 each other. Exim uses &[fcntl()]& locking by default.
23007
23008 This option is required only if you are using an operating system where
23009 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23010 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23011 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23012
23013 .cindex "Solaris" "&[flock()]& support"
23014 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23015 have it (and some, I think, provide a not quite right version built on top of
23016 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23017 the ability to use it, and any attempt to do so will cause a configuration
23018 error.
23019
23020 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23021 is just being mapped onto &[fcntl()]& by the OS).
23022
23023
23024 .option use_lockfile appendfile boolean "see below"
23025 If this option is turned off, Exim does not attempt to create a lock file when
23026 appending to a mailbox file. In this situation, the only locking is by
23027 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23028 sure that every MUA that is ever going to look at your users' mailboxes uses
23029 &[fcntl()]& rather than a lock file, and even then only when you are not
23030 delivering over NFS from more than one host.
23031
23032 .cindex "NFS" "lock file"
23033 In order to append to an NFS file safely from more than one host, it is
23034 necessary to take out a lock &'before'& opening the file, and the lock file
23035 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23036 file corruption.
23037
23038 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23039 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23040 except when &%mbx_format%& is set.
23041
23042
23043 .option use_mbx_lock appendfile boolean "see below"
23044 This option is available only if Exim has been compiled with SUPPORT_MBX
23045 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23046 locking rules be used. It is set by default if &%mbx_format%& is set and none
23047 of the locking options are mentioned in the configuration. The locking rules
23048 are the same as are used by the &'c-client'& library that underlies Pine and
23049 the IMAP4 and POP daemons that come with it (see the discussion below). The
23050 rules allow for shared access to the mailbox. However, this kind of locking
23051 does not work when the mailbox is NFS mounted.
23052
23053 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23054 &%use_flock_lock%& to control what kind of locking is used in implementing the
23055 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23056 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23057
23058
23059
23060
23061 .section "Operational details for appending" "SECTopappend"
23062 .cindex "appending to a file"
23063 .cindex "file" "appending"
23064 Before appending to a file, the following preparations are made:
23065
23066 .ilist
23067 If the name of the file is &_/dev/null_&, no action is taken, and a success
23068 return is given.
23069
23070 .next
23071 .cindex "directory creation"
23072 If any directories on the file's path are missing, Exim creates them if the
23073 &%create_directory%& option is set. A created directory's mode is given by the
23074 &%directory_mode%& option.
23075
23076 .next
23077 If &%file_format%& is set, the format of an existing file is checked. If this
23078 indicates that a different transport should be used, control is passed to that
23079 transport.
23080
23081 .next
23082 .cindex "file" "locking"
23083 .cindex "locking files"
23084 .cindex "NFS" "lock file"
23085 If &%use_lockfile%& is set, a lock file is built in a way that will work
23086 reliably over NFS, as follows:
23087
23088 .olist
23089 Create a &"hitching post"& file whose name is that of the lock file with the
23090 current time, primary host name, and process id added, by opening for writing
23091 as a new file. If this fails with an access error, delivery is deferred.
23092 .next
23093 Close the hitching post file, and hard link it to the lock filename.
23094 .next
23095 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23096 Unlink the hitching post name.
23097 .next
23098 Otherwise, use &[stat()]& to get information about the hitching post file, and
23099 then unlink hitching post name. If the number of links is exactly two, creation
23100 of the lock file succeeded but something (for example, an NFS server crash and
23101 restart) caused this fact not to be communicated to the &[link()]& call.
23102 .next
23103 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23104 up to &%lock_retries%& times. However, since any program that writes to a
23105 mailbox should complete its task very quickly, it is reasonable to time out old
23106 lock files that are normally the result of user agent and system crashes. If an
23107 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23108 it before trying again.
23109 .endlist olist
23110
23111 .next
23112 A call is made to &[lstat()]& to discover whether the main file exists, and if
23113 so, what its characteristics are. If &[lstat()]& fails for any reason other
23114 than non-existence, delivery is deferred.
23115
23116 .next
23117 .cindex "symbolic link" "to mailbox"
23118 .cindex "mailbox" "symbolic link"
23119 If the file does exist and is a symbolic link, delivery is deferred, unless the
23120 &%allow_symlink%& option is set, in which case the ownership of the link is
23121 checked, and then &[stat()]& is called to find out about the real file, which
23122 is then subjected to the checks below. The check on the top-level link
23123 ownership prevents one user creating a link for another's mailbox in a sticky
23124 directory, though allowing symbolic links in this case is definitely not a good
23125 idea. If there is a chain of symbolic links, the intermediate ones are not
23126 checked.
23127
23128 .next
23129 If the file already exists but is not a regular file, or if the file's owner
23130 and group (if the group is being checked &-- see &%check_group%& above) are
23131 different from the user and group under which the delivery is running,
23132 delivery is deferred.
23133
23134 .next
23135 If the file's permissions are more generous than specified, they are reduced.
23136 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23137 is set false, in which case the delivery is tried using the existing
23138 permissions.
23139
23140 .next
23141 The file's inode number is saved, and the file is then opened for appending.
23142 If this fails because the file has vanished, &(appendfile)& behaves as if it
23143 hadn't existed (see below). For any other failures, delivery is deferred.
23144
23145 .next
23146 If the file is opened successfully, check that the inode number hasn't
23147 changed, that it is still a regular file, and that the owner and permissions
23148 have not changed. If anything is wrong, defer delivery and freeze the message.
23149
23150 .next
23151 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23152 option is set. Otherwise, check that the file is being created in a permitted
23153 directory if the &%create_file%& option is set (deferring on failure), and then
23154 open for writing as a new file, with the O_EXCL and O_CREAT options,
23155 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23156 set). In this case, which can happen if the link points to a non-existent file,
23157 the file is opened for writing using O_CREAT but not O_EXCL, because
23158 that prevents link following.
23159
23160 .next
23161 .cindex "loop" "while file testing"
23162 If opening fails because the file exists, obey the tests given above for
23163 existing files. However, to avoid looping in a situation where the file is
23164 being continuously created and destroyed, the exists/not-exists loop is broken
23165 after 10 repetitions, and the message is then frozen.
23166
23167 .next
23168 If opening fails with any other error, defer delivery.
23169
23170 .next
23171 .cindex "file" "locking"
23172 .cindex "locking files"
23173 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23174 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23175 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23176 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23177 file, and an exclusive lock on the file whose name is
23178 .code
23179 /tmp/.<device-number>.<inode-number>
23180 .endd
23181 using the device and inode numbers of the open mailbox file, in accordance with
23182 the MBX locking rules. This file is created with a mode that is specified by
23183 the &%lockfile_mode%& option.
23184
23185 If Exim fails to lock the file, there are two possible courses of action,
23186 depending on the value of the locking timeout. This is obtained from
23187 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23188
23189 If the timeout value is zero, the file is closed, Exim waits for
23190 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23191 to lock it again. This happens up to &%lock_retries%& times, after which the
23192 delivery is deferred.
23193
23194 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23195 &[flock()]& are used (with the given timeout), so there has already been some
23196 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23197 immediately. It retries up to
23198 .code
23199 (lock_retries * lock_interval) / <timeout>
23200 .endd
23201 times (rounded up).
23202 .endlist
23203
23204 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23205 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23206
23207
23208 .section "Operational details for delivery to a new file" "SECTopdir"
23209 .cindex "delivery" "to single file"
23210 .cindex "&""From""& line"
23211 When the &%directory%& option is set instead of &%file%&, each message is
23212 delivered into a newly-created file or set of files. When &(appendfile)& is
23213 activated directly from a &(redirect)& router, neither &%file%& nor
23214 &%directory%& is normally set, because the path for delivery is supplied by the
23215 router. (See for example, the &(address_file)& transport in the default
23216 configuration.) In this case, delivery is to a new file if either the path name
23217 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23218
23219 No locking is required while writing the message to a new file, so the various
23220 locking options of the transport are ignored. The &"From"& line that by default
23221 separates messages in a single file is not normally needed, nor is the escaping
23222 of message lines that start with &"From"&, and there is no need to ensure a
23223 newline at the end of each message. Consequently, the default values for
23224 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23225 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23226
23227 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23228 the files in the delivery directory by default. However, you can specify a
23229 different directory by setting &%quota_directory%&. Also, for maildir
23230 deliveries (see below) the &_maildirfolder_& convention is honoured.
23231
23232
23233 .cindex "maildir format"
23234 .cindex "mailstore format"
23235 There are three different ways in which delivery to individual files can be
23236 done, controlled by the settings of the &%maildir_format%& and
23237 &%mailstore_format%& options. Note that code to support maildir or mailstore
23238 formats is not included in the binary unless SUPPORT_MAILDIR or
23239 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23240
23241 .cindex "directory creation"
23242 In all three cases an attempt is made to create the directory and any necessary
23243 sub-directories if they do not exist, provided that the &%create_directory%&
23244 option is set (the default). The location of a created directory can be
23245 constrained by setting &%create_file%&. A created directory's mode is given by
23246 the &%directory_mode%& option. If creation fails, or if the
23247 &%create_directory%& option is not set when creation is required, delivery is
23248 deferred.
23249
23250
23251
23252 .section "Maildir delivery" "SECTmaildirdelivery"
23253 .cindex "maildir format" "description of"
23254 If the &%maildir_format%& option is true, Exim delivers each message by writing
23255 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23256 directory that is defined by the &%directory%& option (the &"delivery
23257 directory"&). If the delivery is successful, the file is renamed into the
23258 &_new_& subdirectory.
23259
23260 In the filename, <&'stime'&> is the current time of day in seconds, and
23261 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23262 Exim checks that the time-of-day clock has moved on by at least one microsecond
23263 before terminating the delivery process. This guarantees uniqueness for the
23264 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23265 opening it. If any response other than ENOENT (does not exist) is given,
23266 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23267
23268 Before Exim carries out a maildir delivery, it ensures that subdirectories
23269 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23270 do not exist, Exim tries to create them and any superior directories in their
23271 path, subject to the &%create_directory%& and &%create_file%& options. If the
23272 &%maildirfolder_create_regex%& option is set, and the regular expression it
23273 contains matches the delivery directory, Exim also ensures that a file called
23274 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23275 &_maildirfolder_& file cannot be created, delivery is deferred.
23276
23277 These features make it possible to use Exim to create all the necessary files
23278 and directories in a maildir mailbox, including subdirectories for maildir++
23279 folders. Consider this example:
23280 .code
23281 maildir_format = true
23282 directory = /var/mail/$local_part\
23283            ${if eq{$local_part_suffix}{}{}\
23284            {/.${substr_1:$local_part_suffix}}}
23285 maildirfolder_create_regex = /\.[^/]+$
23286 .endd
23287 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23288 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23289 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23290 not match this name, so Exim will not look for or create the file
23291 &_/var/mail/pimbo/maildirfolder_&, though it will create
23292 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23293
23294 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23295 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23296 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23297 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23298 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23299
23300 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23301 not inadvertently match the toplevel maildir directory, because a
23302 &_maildirfolder_& file at top level would completely break quota calculations.
23303
23304 .cindex "quota" "in maildir delivery"
23305 .cindex "maildir++"
23306 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23307 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23308 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23309 Exim assumes the directory is a maildir++ folder directory, which is one level
23310 down from the user's top level mailbox directory. This causes it to start at
23311 the parent directory instead of the current directory when calculating the
23312 amount of space used.
23313
23314 One problem with delivering into a multi-file mailbox is that it is
23315 computationally expensive to compute the size of the mailbox for quota
23316 checking. Various approaches have been taken to reduce the amount of work
23317 needed. The next two sections describe two of them. A third alternative is to
23318 use some external process for maintaining the size data, and use the expansion
23319 of the &%mailbox_size%& option as a way of importing it into Exim.
23320
23321
23322
23323
23324 .section "Using tags to record message sizes" "SECID135"
23325 If &%maildir_tag%& is set, the string is expanded for each delivery.
23326 When the maildir file is renamed into the &_new_& sub-directory, the
23327 tag is added to its name. However, if adding the tag takes the length of the
23328 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23329 the tag is dropped and the maildir file is created with no tag.
23330
23331
23332 .vindex "&$message_size$&"
23333 Tags can be used to encode the size of files in their names; see
23334 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23335 happens after the message has been written. The value of the &$message_size$&
23336 variable is set to the number of bytes actually written. If the expansion is
23337 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23338 be deferred. The expanded tag may contain any printing characters except &"/"&.
23339 Non-printing characters in the string are ignored; if the resulting string is
23340 empty, it is ignored. If it starts with an alphanumeric character, a leading
23341 colon is inserted; this default has not proven to be the path that popular
23342 maildir implementations have chosen (but changing it in Exim would break
23343 backwards compatibility).
23344
23345 For one common implementation, you might set:
23346 .code
23347 maildir_tag = ,S=${message_size}
23348 .endd
23349 but you should check the documentation of the other software to be sure.
23350
23351 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23352 as this allows Exim to extract the size from your tag, instead of having to
23353 &[stat()]& each message file.
23354
23355
23356 .section "Using a maildirsize file" "SECID136"
23357 .cindex "quota" "in maildir delivery"
23358 .cindex "maildir format" "&_maildirsize_& file"
23359 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23360 storing quota and message size information in a file called &_maildirsize_&
23361 within the toplevel maildir directory. If this file does not exist, Exim
23362 creates it, setting the quota from the &%quota%& option of the transport. If
23363 the maildir directory itself does not exist, it is created before any attempt
23364 to write a &_maildirsize_& file.
23365
23366 The &_maildirsize_& file is used to hold information about the sizes of
23367 messages in the maildir, thus speeding up quota calculations. The quota value
23368 in the file is just a cache; if the quota is changed in the transport, the new
23369 value overrides the cached value when the next message is delivered. The cache
23370 is maintained for the benefit of other programs that access the maildir and
23371 need to know the quota.
23372
23373 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23374 file is maintained (with a zero quota setting), but no quota is imposed.
23375
23376 A regular expression is available for controlling which directories in the
23377 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23378 See the description of the &%maildir_quota_directory_regex%& option above for
23379 details.
23380
23381
23382 .section "Mailstore delivery" "SECID137"
23383 .cindex "mailstore format" "description of"
23384 If the &%mailstore_format%& option is true, each message is written as two
23385 files in the given directory. A unique base name is constructed from the
23386 message id and the current delivery process, and the files that are written use
23387 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23388 contains the message's envelope, and the &_.msg_& file contains the message
23389 itself. The base name is placed in the variable &$mailstore_basename$&.
23390
23391 During delivery, the envelope is first written to a file with the suffix
23392 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23393 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23394 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23395 file before accessing either of them. An alternative approach is to wait for
23396 the absence of a &_.tmp_& file.
23397
23398 The envelope file starts with any text defined by the &%mailstore_prefix%&
23399 option, expanded and terminated by a newline if there isn't one. Then follows
23400 the sender address on one line, then all the recipient addresses, one per line.
23401 There can be more than one recipient only if the &%batch_max%& option is set
23402 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23403 appended to the file, followed by a newline if it does not end with one.
23404
23405 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23406 failure, it is ignored. Other expansion errors are treated as serious
23407 configuration errors, and delivery is deferred. The variable
23408 &$mailstore_basename$& is available for use during these expansions.
23409
23410
23411 .section "Non-special new file delivery" "SECID138"
23412 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23413 file is created directly in the named directory. For example, when delivering
23414 messages into files in batched SMTP format for later delivery to some host (see
23415 section &<<SECTbatchSMTP>>&), a setting such as
23416 .code
23417 directory = /var/bsmtp/$host
23418 .endd
23419 might be used. A message is written to a file with a temporary name, which is
23420 then renamed when the delivery is complete. The final name is obtained by
23421 expanding the contents of the &%directory_file%& option.
23422 .ecindex IIDapptra1
23423 .ecindex IIDapptra2
23424
23425
23426
23427
23428
23429
23430 . ////////////////////////////////////////////////////////////////////////////
23431 . ////////////////////////////////////////////////////////////////////////////
23432
23433 .chapter "The autoreply transport" "CHID8"
23434 .scindex IIDauttra1 "transports" "&(autoreply)&"
23435 .scindex IIDauttra2 "&(autoreply)& transport"
23436 The &(autoreply)& transport is not a true transport in that it does not cause
23437 the message to be transmitted. Instead, it generates a new mail message as an
23438 automatic reply to the incoming message. &'References:'& and
23439 &'Auto-Submitted:'& header lines are included. These are constructed according
23440 to the rules in RFCs 2822 and 3834, respectively.
23441
23442 If the router that passes the message to this transport does not have the
23443 &%unseen%& option set, the original message (for the current recipient) is not
23444 delivered anywhere. However, when the &%unseen%& option is set on the router
23445 that passes the message to this transport, routing of the address continues, so
23446 another router can set up a normal message delivery.
23447
23448
23449 The &(autoreply)& transport is usually run as the result of mail filtering, a
23450 &"vacation"& message being the standard example. However, it can also be run
23451 directly from a router like any other transport. To reduce the possibility of
23452 message cascades, messages created by the &(autoreply)& transport always have
23453 empty envelope sender addresses, like bounce messages.
23454
23455 The parameters of the message to be sent can be specified in the configuration
23456 by options described below. However, these are used only when the address
23457 passed to the transport does not contain its own reply information. When the
23458 transport is run as a consequence of a
23459 &%mail%&
23460 or &%vacation%& command in a filter file, the parameters of the message are
23461 supplied by the filter, and passed with the address. The transport's options
23462 that define the message are then ignored (so they are not usually set in this
23463 case). The message is specified entirely by the filter or by the transport; it
23464 is never built from a mixture of options. However, the &%file_optional%&,
23465 &%mode%&, and &%return_message%& options apply in all cases.
23466
23467 &(Autoreply)& is implemented as a local transport. When used as a result of a
23468 command in a user's filter file, &(autoreply)& normally runs under the uid and
23469 gid of the user, and with appropriate current and home directories (see chapter
23470 &<<CHAPenvironment>>&).
23471
23472 There is a subtle difference between routing a message to a &(pipe)& transport
23473 that generates some text to be returned to the sender, and routing it to an
23474 &(autoreply)& transport. This difference is noticeable only if more than one
23475 address from the same message is so handled. In the case of a pipe, the
23476 separate outputs from the different addresses are gathered up and returned to
23477 the sender in a single message, whereas if &(autoreply)& is used, a separate
23478 message is generated for each address that is passed to it.
23479
23480 Non-printing characters are not permitted in the header lines generated for the
23481 message that &(autoreply)& creates, with the exception of newlines that are
23482 immediately followed by white space. If any non-printing characters are found,
23483 the transport defers.
23484 Whether characters with the top bit set count as printing characters or not is
23485 controlled by the &%print_topbitchars%& global option.
23486
23487 If any of the generic options for manipulating headers (for example,
23488 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23489 of the original message that is included in the generated message when
23490 &%return_message%& is set. They do not apply to the generated message itself.
23491
23492 .vindex "&$sender_address$&"
23493 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23494 the message, indicating that there were no recipients, it does not treat this
23495 as an error. This means that autoreplies sent to &$sender_address$& when this
23496 is empty (because the incoming message is a bounce message) do not cause
23497 problems. They are just discarded.
23498
23499
23500
23501 .section "Private options for autoreply" "SECID139"
23502 .cindex "options" "&(autoreply)& transport"
23503
23504 .option bcc autoreply string&!! unset
23505 This specifies the addresses that are to receive &"blind carbon copies"& of the
23506 message when the message is specified by the transport.
23507
23508
23509 .option cc autoreply string&!! unset
23510 This specifies recipients of the message and the contents of the &'Cc:'& header
23511 when the message is specified by the transport.
23512
23513
23514 .option file autoreply string&!! unset
23515 The contents of the file are sent as the body of the message when the message
23516 is specified by the transport. If both &%file%& and &%text%& are set, the text
23517 string comes first.
23518
23519
23520 .option file_expand autoreply boolean false
23521 If this is set, the contents of the file named by the &%file%& option are
23522 subjected to string expansion as they are added to the message.
23523
23524
23525 .option file_optional autoreply boolean false
23526 If this option is true, no error is generated if the file named by the &%file%&
23527 option or passed with the address does not exist or cannot be read.
23528
23529
23530 .option from autoreply string&!! unset
23531 This specifies the contents of the &'From:'& header when the message is
23532 specified by the transport.
23533
23534
23535 .option headers autoreply string&!! unset
23536 This specifies additional RFC 2822 headers that are to be added to the message
23537 when the message is specified by the transport. Several can be given by using
23538 &"\n"& to separate them. There is no check on the format.
23539
23540
23541 .option log autoreply string&!! unset
23542 This option names a file in which a record of every message sent is logged when
23543 the message is specified by the transport.
23544
23545
23546 .option mode autoreply "octal integer" 0600
23547 If either the log file or the &"once"& file has to be created, this mode is
23548 used.
23549
23550
23551 .option never_mail autoreply "address list&!!" unset
23552 If any run of the transport creates a message with a recipient that matches any
23553 item in the list, that recipient is quietly discarded. If all recipients are
23554 discarded, no message is created. This applies both when the recipients are
23555 generated by a filter and when they are specified in the transport.
23556
23557
23558
23559 .option once autoreply string&!! unset
23560 This option names a file or DBM database in which a record of each &'To:'&
23561 recipient is kept when the message is specified by the transport. &*Note*&:
23562 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23563
23564 If &%once%& is unset, or is set to an empty string, the message is always sent.
23565 By default, if &%once%& is set to a non-empty filename, the message
23566 is not sent if a potential recipient is already listed in the database.
23567 However, if the &%once_repeat%& option specifies a time greater than zero, the
23568 message is sent if that much time has elapsed since a message was last sent to
23569 this recipient. A setting of zero time for &%once_repeat%& (the default)
23570 prevents a message from being sent a second time &-- in this case, zero means
23571 infinity.
23572
23573 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23574 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23575 greater than zero, it changes the way Exim implements the &%once%& option.
23576 Instead of using a DBM file to record every recipient it sends to, it uses a
23577 regular file, whose size will never get larger than the given value.
23578
23579 In the file, Exim keeps a linear list of recipient addresses and the times at
23580 which they were sent messages. If the file is full when a new address needs to
23581 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23582 means that a given recipient may receive multiple messages, but at
23583 unpredictable intervals that depend on the rate of turnover of addresses in the
23584 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23585
23586
23587 .option once_file_size autoreply integer 0
23588 See &%once%& above.
23589
23590
23591 .option once_repeat autoreply time&!! 0s
23592 See &%once%& above.
23593 After expansion, the value of this option must be a valid time value.
23594
23595
23596 .option reply_to autoreply string&!! unset
23597 This specifies the contents of the &'Reply-To:'& header when the message is
23598 specified by the transport.
23599
23600
23601 .option return_message autoreply boolean false
23602 If this is set, a copy of the original message is returned with the new
23603 message, subject to the maximum size set in the &%return_size_limit%& global
23604 configuration option.
23605
23606
23607 .option subject autoreply string&!! unset
23608 This specifies the contents of the &'Subject:'& header when the message is
23609 specified by the transport. It is tempting to quote the original subject in
23610 automatic responses. For example:
23611 .code
23612 subject = Re: $h_subject:
23613 .endd
23614 There is a danger in doing this, however. It may allow a third party to
23615 subscribe your users to an opt-in mailing list, provided that the list accepts
23616 bounce messages as subscription confirmations. Well-managed lists require a
23617 non-bounce message to confirm a subscription, so the danger is relatively
23618 small.
23619
23620
23621
23622 .option text autoreply string&!! unset
23623 This specifies a single string to be used as the body of the message when the
23624 message is specified by the transport. If both &%text%& and &%file%& are set,
23625 the text comes first.
23626
23627
23628 .option to autoreply string&!! unset
23629 This specifies recipients of the message and the contents of the &'To:'& header
23630 when the message is specified by the transport.
23631 .ecindex IIDauttra1
23632 .ecindex IIDauttra2
23633
23634
23635
23636
23637 . ////////////////////////////////////////////////////////////////////////////
23638 . ////////////////////////////////////////////////////////////////////////////
23639
23640 .chapter "The lmtp transport" "CHAPLMTP"
23641 .cindex "transports" "&(lmtp)&"
23642 .cindex "&(lmtp)& transport"
23643 .cindex "LMTP" "over a pipe"
23644 .cindex "LMTP" "over a socket"
23645 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23646 specified command
23647 or by interacting with a Unix domain socket.
23648 This transport is something of a cross between the &(pipe)& and &(smtp)&
23649 transports. Exim also has support for using LMTP over TCP/IP; this is
23650 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23651 to be of minority interest, the default build-time configure in &_src/EDITME_&
23652 has it commented out. You need to ensure that
23653 .code
23654 TRANSPORT_LMTP=yes
23655 .endd
23656 .cindex "options" "&(lmtp)& transport"
23657 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23658 included in the Exim binary. The private options of the &(lmtp)& transport are
23659 as follows:
23660
23661 .option batch_id lmtp string&!! unset
23662 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23663
23664
23665 .option batch_max lmtp integer 1
23666 This limits the number of addresses that can be handled in a single delivery.
23667 Most LMTP servers can handle several addresses at once, so it is normally a
23668 good idea to increase this value. See the description of local delivery
23669 batching in chapter &<<CHAPbatching>>&.
23670
23671
23672 .option command lmtp string&!! unset
23673 This option must be set if &%socket%& is not set. The string is a command which
23674 is run in a separate process. It is split up into a command name and list of
23675 arguments, each of which is separately expanded (so expansion cannot change the
23676 number of arguments). The command is run directly, not via a shell. The message
23677 is passed to the new process using the standard input and output to operate the
23678 LMTP protocol.
23679
23680 .option ignore_quota lmtp boolean false
23681 .cindex "LMTP" "ignoring quota errors"
23682 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23683 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23684 in its response to the LHLO command.
23685
23686 .option socket lmtp string&!! unset
23687 This option must be set if &%command%& is not set. The result of expansion must
23688 be the name of a Unix domain socket. The transport connects to the socket and
23689 delivers the message to it using the LMTP protocol.
23690
23691
23692 .option timeout lmtp time 5m
23693 The transport is aborted if the created process or Unix domain socket does not
23694 respond to LMTP commands or message input within this timeout. Delivery
23695 is deferred, and will be tried again later. Here is an example of a typical
23696 LMTP transport:
23697 .code
23698 lmtp:
23699   driver = lmtp
23700   command = /some/local/lmtp/delivery/program
23701   batch_max = 20
23702   user = exim
23703 .endd
23704 This delivers up to 20 addresses at a time, in a mixture of domains if
23705 necessary, running as the user &'exim'&.
23706
23707
23708
23709 . ////////////////////////////////////////////////////////////////////////////
23710 . ////////////////////////////////////////////////////////////////////////////
23711
23712 .chapter "The pipe transport" "CHAPpipetransport"
23713 .scindex IIDpiptra1 "transports" "&(pipe)&"
23714 .scindex IIDpiptra2 "&(pipe)& transport"
23715 The &(pipe)& transport is used to deliver messages via a pipe to a command
23716 running in another process. One example is the use of &(pipe)& as a
23717 pseudo-remote transport for passing messages to some other delivery mechanism
23718 (such as UUCP). Another is the use by individual users to automatically process
23719 their incoming messages. The &(pipe)& transport can be used in one of the
23720 following ways:
23721
23722 .ilist
23723 .vindex "&$local_part$&"
23724 A router routes one address to a transport in the normal way, and the
23725 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23726 contains the local part of the address (as usual), and the command that is run
23727 is specified by the &%command%& option on the transport.
23728 .next
23729 .vindex "&$pipe_addresses$&"
23730 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23731 transport can handle more than one address in a single run. In this case, when
23732 more than one address is routed to the transport, &$local_part$& is not set
23733 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23734 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23735 that are routed to the transport.
23736 .next
23737 .vindex "&$address_pipe$&"
23738 A router redirects an address directly to a pipe command (for example, from an
23739 alias or forward file). In this case, &$address_pipe$& contains the text of the
23740 pipe command, and the &%command%& option on the transport is ignored unless
23741 &%force_command%& is set. If only one address is being transported
23742 (&%batch_max%& is not greater than one, or only one address was redirected to
23743 this pipe command), &$local_part$& contains the local part that was redirected.
23744 .endlist
23745
23746
23747 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23748 deliver messages over pipes using the LMTP interactive protocol. This is
23749 implemented by the &(lmtp)& transport.
23750
23751 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23752 &_.forward_& file, the command runs under the uid and gid of that user. In
23753 other cases, the uid and gid have to be specified explicitly, either on the
23754 transport or on the router that handles the address. Current and &"home"&
23755 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23756 details of the local delivery environment and chapter &<<CHAPbatching>>&
23757 for a discussion of local delivery batching.
23758
23759
23760 .section "Concurrent delivery" "SECID140"
23761 If two messages arrive at almost the same time, and both are routed to a pipe
23762 delivery, the two pipe transports may be run concurrently. You must ensure that
23763 any pipe commands you set up are robust against this happening. If the commands
23764 write to a file, the &%exim_lock%& utility might be of use.
23765 Alternatively the &%max_parallel%& option could be used with a value
23766 of "1" to enforce serialization.
23767
23768
23769
23770
23771 .section "Returned status and data" "SECID141"
23772 .cindex "&(pipe)& transport" "returned data"
23773 If the command exits with a non-zero return code, the delivery is deemed to
23774 have failed, unless either the &%ignore_status%& option is set (in which case
23775 the return code is treated as zero), or the return code is one of those listed
23776 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23777 later"&. In this case, delivery is deferred. Details of a permanent failure are
23778 logged, but are not included in the bounce message, which merely contains
23779 &"local delivery failed"&.
23780
23781 If the command exits on a signal and the &%freeze_signal%& option is set then
23782 the message will be frozen in the queue. If that option is not set, a bounce
23783 will be sent as normal.
23784
23785 If the return code is greater than 128 and the command being run is a shell
23786 script, it normally means that the script was terminated by a signal whose
23787 value is the return code minus 128. The &%freeze_signal%& option does not
23788 apply in this case.
23789
23790 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23791 return code is set to 127. This is the value that a shell returns if it is
23792 asked to run a non-existent command. The wording for the log line suggests that
23793 a non-existent command may be the problem.
23794
23795 The &%return_output%& option can affect the result of a pipe delivery. If it is
23796 set and the command produces any output on its standard output or standard
23797 error streams, the command is considered to have failed, even if it gave a zero
23798 return code or if &%ignore_status%& is set. The output from the command is
23799 included as part of the bounce message. The &%return_fail_output%& option is
23800 similar, except that output is returned only when the command exits with a
23801 failure return code, that is, a value other than zero or a code that matches
23802 &%temp_errors%&.
23803
23804
23805
23806 .section "How the command is run" "SECThowcommandrun"
23807 .cindex "&(pipe)& transport" "path for command"
23808 The command line is (by default) broken down into a command name and arguments
23809 by the &(pipe)& transport itself. The &%allow_commands%& and
23810 &%restrict_to_path%& options can be used to restrict the commands that may be
23811 run.
23812
23813 .cindex "quoting" "in pipe command"
23814 Unquoted arguments are delimited by white space. If an argument appears in
23815 double quotes, backslash is interpreted as an escape character in the usual
23816 way. If an argument appears in single quotes, no escaping is done.
23817
23818 String expansion is applied to the command line except when it comes from a
23819 traditional &_.forward_& file (commands from a filter file are expanded). The
23820 expansion is applied to each argument in turn rather than to the whole line.
23821 For this reason, any string expansion item that contains white space must be
23822 quoted so as to be contained within a single argument. A setting such as
23823 .code
23824 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23825 .endd
23826 will not work, because the expansion item gets split between several
23827 arguments. You have to write
23828 .code
23829 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23830 .endd
23831 to ensure that it is all in one argument. The expansion is done in this way,
23832 argument by argument, so that the number of arguments cannot be changed as a
23833 result of expansion, and quotes or backslashes in inserted variables do not
23834 interact with external quoting. However, this leads to problems if you want to
23835 generate multiple arguments (or the command name plus arguments) from a single
23836 expansion. In this situation, the simplest solution is to use a shell. For
23837 example:
23838 .code
23839 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23840 .endd
23841
23842 .cindex "transport" "filter"
23843 .cindex "filter" "transport filter"
23844 .vindex "&$pipe_addresses$&"
23845 Special handling takes place when an argument consists of precisely the text
23846 &`$pipe_addresses`& (no quotes).
23847 This is not a general expansion variable; the only
23848 place this string is recognized is when it appears as an argument for a pipe or
23849 transport filter command. It causes each address that is being handled to be
23850 inserted in the argument list at that point &'as a separate argument'&. This
23851 avoids any problems with spaces or shell metacharacters, and is of use when a
23852 &(pipe)& transport is handling groups of addresses in a batch.
23853
23854 If &%force_command%& is enabled on the transport, special handling takes place
23855 for an argument that consists of precisely the text &`$address_pipe`&.  It
23856 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23857 argument is inserted in the argument list at that point
23858 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23859 the only item in the argument; in fact, if it were then &%force_command%&
23860 should behave as a no-op.  Rather, it should be used to adjust the command
23861 run while preserving the argument vector separation.
23862
23863 After splitting up into arguments and expansion, the resulting command is run
23864 in a subprocess directly from the transport, &'not'& under a shell. The
23865 message that is being delivered is supplied on the standard input, and the
23866 standard output and standard error are both connected to a single pipe that is
23867 read by Exim. The &%max_output%& option controls how much output the command
23868 may produce, and the &%return_output%& and &%return_fail_output%& options
23869 control what is done with it.
23870
23871 Not running the command under a shell (by default) lessens the security risks
23872 in cases when a command from a user's filter file is built out of data that was
23873 taken from an incoming message. If a shell is required, it can of course be
23874 explicitly specified as the command to be run. However, there are circumstances
23875 where existing commands (for example, in &_.forward_& files) expect to be run
23876 under a shell and cannot easily be modified. To allow for these cases, there is
23877 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23878 works. Instead of breaking up the command line as just described, it expands it
23879 as a single string and passes the result to &_/bin/sh_&. The
23880 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23881 with &%use_shell%&, and the whole mechanism is inherently less secure.
23882
23883
23884
23885 .section "Environment variables" "SECTpipeenv"
23886 .cindex "&(pipe)& transport" "environment for command"
23887 .cindex "environment" "&(pipe)& transport"
23888 The environment variables listed below are set up when the command is invoked.
23889 This list is a compromise for maximum compatibility with other MTAs. Note that
23890 the &%environment%& option can be used to add additional variables to this
23891 environment. The environment for the &(pipe)& transport is not subject
23892 to the &%add_environment%& and &%keep_environment%& main config options.
23893 .display
23894 &`DOMAIN            `&   the domain of the address
23895 &`HOME              `&   the home directory, if set
23896 &`HOST              `&   the host name when called from a router (see below)
23897 &`LOCAL_PART        `&   see below
23898 &`LOCAL_PART_PREFIX `&   see below
23899 &`LOCAL_PART_SUFFIX `&   see below
23900 &`LOGNAME           `&   see below
23901 &`MESSAGE_ID        `&   Exim's local ID for the message
23902 &`PATH              `&   as specified by the &%path%& option below
23903 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23904 &`RECIPIENT         `&   the complete recipient address
23905 &`SENDER            `&   the sender of the message (empty if a bounce)
23906 &`SHELL             `&   &`/bin/sh`&
23907 &`TZ                `&   the value of the &%timezone%& option, if set
23908 &`USER              `&   see below
23909 .endd
23910 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23911 router, LOCAL_PART is set to the local part of the address. When it is
23912 called as a result of a forward or alias expansion, LOCAL_PART is set to
23913 the local part of the address that was expanded. In both cases, any affixes are
23914 removed from the local part, and made available in LOCAL_PART_PREFIX and
23915 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23916 same value as LOCAL_PART for compatibility with other MTAs.
23917
23918 .cindex "HOST"
23919 HOST is set only when a &(pipe)& transport is called from a router that
23920 associates hosts with an address, typically when using &(pipe)& as a
23921 pseudo-remote transport. HOST is set to the first host name specified by
23922 the router.
23923
23924 .cindex "HOME"
23925 If the transport's generic &%home_directory%& option is set, its value is used
23926 for the HOME environment variable. Otherwise, a home directory may be set
23927 by the router's &%transport_home_directory%& option, which defaults to the
23928 user's home directory if &%check_local_user%& is set.
23929
23930
23931 .section "Private options for pipe" "SECID142"
23932 .cindex "options" "&(pipe)& transport"
23933
23934
23935
23936 .option allow_commands pipe "string list&!!" unset
23937 .cindex "&(pipe)& transport" "permitted commands"
23938 The string is expanded, and is then interpreted as a colon-separated list of
23939 permitted commands. If &%restrict_to_path%& is not set, the only commands
23940 permitted are those in the &%allow_commands%& list. They need not be absolute
23941 paths; the &%path%& option is still used for relative paths. If
23942 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23943 in the &%allow_commands%& list, or a name without any slashes that is found on
23944 the path. In other words, if neither &%allow_commands%& nor
23945 &%restrict_to_path%& is set, there is no restriction on the command, but
23946 otherwise only commands that are permitted by one or the other are allowed. For
23947 example, if
23948 .code
23949 allow_commands = /usr/bin/vacation
23950 .endd
23951 and &%restrict_to_path%& is not set, the only permitted command is
23952 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23953 &%use_shell%& is set.
23954
23955
23956 .option batch_id pipe string&!! unset
23957 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23958
23959
23960 .option batch_max pipe integer 1
23961 This limits the number of addresses that can be handled in a single delivery.
23962 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23963
23964
23965 .option check_string pipe string unset
23966 As &(pipe)& writes the message, the start of each line is tested for matching
23967 &%check_string%&, and if it does, the initial matching characters are replaced
23968 by the contents of &%escape_string%&, provided both are set. The value of
23969 &%check_string%& is a literal string, not a regular expression, and the case of
23970 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23971 of &%check_string%& and &%escape_string%& are forced to values that implement
23972 the SMTP escaping protocol. Any settings made in the configuration file are
23973 ignored.
23974
23975
23976 .option command pipe string&!! unset
23977 This option need not be set when &(pipe)& is being used to deliver to pipes
23978 obtained directly from address redirections. In other cases, the option must be
23979 set, to provide a command to be run. It need not yield an absolute path (see
23980 the &%path%& option below). The command is split up into separate arguments by
23981 Exim, and each argument is separately expanded, as described in section
23982 &<<SECThowcommandrun>>& above.
23983
23984
23985 .option environment pipe string&!! unset
23986 .cindex "&(pipe)& transport" "environment for command"
23987 .cindex "environment" "&(pipe)& transport"
23988 This option is used to add additional variables to the environment in which the
23989 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23990 a string which is expanded, and then interpreted as a colon-separated list of
23991 environment settings of the form <&'name'&>=<&'value'&>.
23992
23993
23994 .option escape_string pipe string unset
23995 See &%check_string%& above.
23996
23997
23998 .option freeze_exec_fail pipe boolean false
23999 .cindex "exec failure"
24000 .cindex "failure of exec"
24001 .cindex "&(pipe)& transport" "failure of exec"
24002 Failure to exec the command in a pipe transport is by default treated like
24003 any other failure while running the command. However, if &%freeze_exec_fail%&
24004 is set, failure to exec is treated specially, and causes the message to be
24005 frozen, whatever the setting of &%ignore_status%&.
24006
24007
24008 .option freeze_signal pipe boolean false
24009 .cindex "signal exit"
24010 .cindex "&(pipe)& transport", "signal exit"
24011 Normally if the process run by a command in a pipe transport exits on a signal,
24012 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24013 frozen in Exim's queue instead.
24014
24015
24016 .option force_command pipe boolean false
24017 .cindex "force command"
24018 .cindex "&(pipe)& transport", "force command"
24019 Normally when a router redirects an address directly to a pipe command
24020 the &%command%& option on the transport is ignored.  If &%force_command%&
24021 is set, the &%command%& option will used. This is especially
24022 useful for forcing a wrapper or additional argument to be added to the
24023 command. For example:
24024 .code
24025 command = /usr/bin/remote_exec myhost -- $address_pipe
24026 force_command
24027 .endd
24028
24029 Note that &$address_pipe$& is handled specially in &%command%& when
24030 &%force_command%& is set, expanding out to the original argument vector as
24031 separate items, similarly to a Unix shell &`"$@"`& construct.
24032
24033
24034 .option ignore_status pipe boolean false
24035 If this option is true, the status returned by the subprocess that is set up to
24036 run the command is ignored, and Exim behaves as if zero had been returned.
24037 Otherwise, a non-zero status or termination by signal causes an error return
24038 from the transport unless the status value is one of those listed in
24039 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24040
24041 &*Note*&: This option does not apply to timeouts, which do not return a status.
24042 See the &%timeout_defer%& option for how timeouts are handled.
24043
24044
24045 .option log_defer_output pipe boolean false
24046 .cindex "&(pipe)& transport" "logging output"
24047 If this option is set, and the status returned by the command is
24048 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24049 and any output was produced on stdout or stderr, the first line of it is
24050 written to the main log.
24051
24052
24053 .option log_fail_output pipe boolean false
24054 If this option is set, and the command returns any output on stdout or
24055 stderr, and also ends with a return code that is neither zero nor one of
24056 the return codes listed in &%temp_errors%& (that is, the delivery
24057 failed), the first line of output is written to the main log. This
24058 option and &%log_output%& are mutually exclusive.  Only one of them may
24059 be set.
24060
24061
24062 .option log_output pipe boolean false
24063 If this option is set and the command returns any output on stdout or
24064 stderr, the first line of output is written to the main log, whatever
24065 the return code. This option and &%log_fail_output%& are mutually
24066 exclusive. Only one of them may be set.
24067
24068
24069 .option max_output pipe integer 20K
24070 This specifies the maximum amount of output that the command may produce on its
24071 standard output and standard error file combined. If the limit is exceeded, the
24072 process running the command is killed. This is intended as a safety measure to
24073 catch runaway processes. The limit is applied independently of the settings of
24074 the options that control what is done with such output (for example,
24075 &%return_output%&). Because of buffering effects, the amount of output may
24076 exceed the limit by a small amount before Exim notices.
24077
24078
24079 .option message_prefix pipe string&!! "see below"
24080 The string specified here is expanded and output at the start of every message.
24081 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24082 .code
24083 message_prefix = \
24084   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24085   ${tod_bsdinbox}\n
24086 .endd
24087 .cindex "Cyrus"
24088 .cindex "&%tmail%&"
24089 .cindex "&""From""& line"
24090 This is required by the commonly used &_/usr/bin/vacation_& program.
24091 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24092 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24093 setting
24094 .code
24095 message_prefix =
24096 .endd
24097 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24098 &`\n`& to &`\r\n`& in &%message_prefix%&.
24099
24100
24101 .option message_suffix pipe string&!! "see below"
24102 The string specified here is expanded and output at the end of every message.
24103 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24104 The suffix can be suppressed by setting
24105 .code
24106 message_suffix =
24107 .endd
24108 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24109 &`\n`& to &`\r\n`& in &%message_suffix%&.
24110
24111
24112 .option path pipe string&!! "/bin:/usr/bin"
24113 This option is expanded and
24114 specifies the string that is set up in the PATH environment
24115 variable of the subprocess.
24116 If the &%command%& option does not yield an absolute path name, the command is
24117 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24118 apply to a command specified as a transport filter.
24119
24120
24121 .option permit_coredump pipe boolean false
24122 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24123 a core-dump of a pipe command, enable this command.  This enables core-dumps
24124 during delivery and affects both the Exim binary and the pipe command run.
24125 It is recommended that this option remain off unless and until you have a need
24126 for it and that this only be enabled when needed, as the risk of excessive
24127 resource consumption can be quite high.  Note also that Exim is typically
24128 installed as a setuid binary and most operating systems will inhibit coredumps
24129 of these by default, so further OS-specific action may be required.
24130
24131
24132 .option pipe_as_creator pipe boolean false
24133 .cindex "uid (user id)" "local delivery"
24134 If the generic &%user%& option is not set and this option is true, the delivery
24135 process is run under the uid that was in force when Exim was originally called
24136 to accept the message. If the group id is not otherwise set (via the generic
24137 &%group%& option), the gid that was in force when Exim was originally called to
24138 accept the message is used.
24139
24140
24141 .option restrict_to_path pipe boolean false
24142 When this option is set, any command name not listed in &%allow_commands%& must
24143 contain no slashes. The command is searched for only in the directories listed
24144 in the &%path%& option. This option is intended for use in the case when a pipe
24145 command has been generated from a user's &_.forward_& file. This is usually
24146 handled by a &(pipe)& transport called &%address_pipe%&.
24147
24148
24149 .option return_fail_output pipe boolean false
24150 If this option is true, and the command produced any output and ended with a
24151 return code other than zero or one of the codes listed in &%temp_errors%& (that
24152 is, the delivery failed), the output is returned in the bounce message.
24153 However, if the message has a null sender (that is, it is itself a bounce
24154 message), output from the command is discarded. This option and
24155 &%return_output%& are mutually exclusive. Only one of them may be set.
24156
24157
24158
24159 .option return_output pipe boolean false
24160 If this option is true, and the command produced any output, the delivery is
24161 deemed to have failed whatever the return code from the command, and the output
24162 is returned in the bounce message. Otherwise, the output is just discarded.
24163 However, if the message has a null sender (that is, it is a bounce message),
24164 output from the command is always discarded, whatever the setting of this
24165 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24166 of them may be set.
24167
24168
24169
24170 .option temp_errors pipe "string list" "see below"
24171 .cindex "&(pipe)& transport" "temporary failure"
24172 This option contains either a colon-separated list of numbers, or a single
24173 asterisk. If &%ignore_status%& is false
24174 and &%return_output%& is not set,
24175 and the command exits with a non-zero return code, the failure is treated as
24176 temporary and the delivery is deferred if the return code matches one of the
24177 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24178 codes are treated as permanent errors. The default setting contains the codes
24179 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24180 compiled on a system that does not define these macros, it assumes values of 75
24181 and 73, respectively.
24182
24183
24184 .option timeout pipe time 1h
24185 If the command fails to complete within this time, it is killed. This normally
24186 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24187 specifies no timeout. In order to ensure that any subprocesses created by the
24188 command are also killed, Exim makes the initial process a process group leader,
24189 and kills the whole process group on a timeout. However, this can be defeated
24190 if one of the processes starts a new process group.
24191
24192 .option timeout_defer pipe boolean false
24193 A timeout in a &(pipe)& transport, either in the command that the transport
24194 runs, or in a transport filter that is associated with it, is by default
24195 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24196 is set true, both kinds of timeout become temporary errors, causing the
24197 delivery to be deferred.
24198
24199 .option umask pipe "octal integer" 022
24200 This specifies the umask setting for the subprocess that runs the command.
24201
24202
24203 .option use_bsmtp pipe boolean false
24204 .cindex "envelope sender"
24205 If this option is set true, the &(pipe)& transport writes messages in &"batch
24206 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24207 commands. If you want to include a leading HELO command with such messages,
24208 you can do so by setting the &%message_prefix%& option. See section
24209 &<<SECTbatchSMTP>>& for details of batch SMTP.
24210
24211 .option use_classresources pipe boolean false
24212 .cindex "class resources (BSD)"
24213 This option is available only when Exim is running on FreeBSD, NetBSD, or
24214 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24215 resource limits when a &(pipe)& transport is run to perform a delivery. The
24216 limits for the uid under which the pipe is to run are obtained from the login
24217 class database.
24218
24219
24220 .option use_crlf pipe boolean false
24221 .cindex "carriage return"
24222 .cindex "linefeed"
24223 This option causes lines to be terminated with the two-character CRLF sequence
24224 (carriage return, linefeed) instead of just a linefeed character. In the case
24225 of batched SMTP, the byte sequence written to the pipe is then an exact image
24226 of what would be sent down a real SMTP connection.
24227
24228 The contents of the &%message_prefix%& and &%message_suffix%& options are
24229 written verbatim, so must contain their own carriage return characters if these
24230 are needed. When &%use_bsmtp%& is not set, the default values for both
24231 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24232 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24233
24234
24235 .option use_shell pipe boolean false
24236 .vindex "&$pipe_addresses$&"
24237 If this option is set, it causes the command to be passed to &_/bin/sh_&
24238 instead of being run directly from the transport, as described in section
24239 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24240 where the command is expected to be run under a shell and cannot easily be
24241 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24242 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24243 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24244 its &%-c%& option.
24245
24246
24247
24248 .section "Using an external local delivery agent" "SECID143"
24249 .cindex "local delivery" "using an external agent"
24250 .cindex "&'procmail'&"
24251 .cindex "external local delivery"
24252 .cindex "delivery" "&'procmail'&"
24253 .cindex "delivery" "by external agent"
24254 The &(pipe)& transport can be used to pass all messages that require local
24255 delivery to a separate local delivery agent such as &%procmail%&. When doing
24256 this, care must be taken to ensure that the pipe is run under an appropriate
24257 uid and gid. In some configurations one wants this to be a uid that is trusted
24258 by the delivery agent to supply the correct sender of the message. It may be
24259 necessary to recompile or reconfigure the delivery agent so that it trusts an
24260 appropriate user. The following is an example transport and router
24261 configuration for &%procmail%&:
24262 .code
24263 # transport
24264 procmail_pipe:
24265   driver = pipe
24266   command = /usr/local/bin/procmail -d $local_part
24267   return_path_add
24268   delivery_date_add
24269   envelope_to_add
24270   check_string = "From "
24271   escape_string = ">From "
24272   umask = 077
24273   user = $local_part
24274   group = mail
24275
24276 # router
24277 procmail:
24278   driver = accept
24279   check_local_user
24280   transport = procmail_pipe
24281 .endd
24282 In this example, the pipe is run as the local user, but with the group set to
24283 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24284 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24285 user to supply a correct sender address. If you do not specify either a
24286 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24287 home directory is the user's home directory by default.
24288
24289 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24290 .code
24291 IFS=" "
24292 .endd
24293 as shown in some &%procmail%& documentation, because Exim does not by default
24294 use a shell to run pipe commands.
24295
24296 .cindex "Cyrus"
24297 The next example shows a transport and a router for a system where local
24298 deliveries are handled by the Cyrus IMAP server.
24299 .code
24300 # transport
24301 local_delivery_cyrus:
24302   driver = pipe
24303   command = /usr/cyrus/bin/deliver \
24304             -m ${substr_1:$local_part_suffix} -- $local_part
24305   user = cyrus
24306   group = mail
24307   return_output
24308   log_output
24309   message_prefix =
24310   message_suffix =
24311
24312 # router
24313 local_user_cyrus:
24314   driver = accept
24315   check_local_user
24316   local_part_suffix = .*
24317   transport = local_delivery_cyrus
24318 .endd
24319 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24320 &%return_output%& to cause any text written by Cyrus to be returned to the
24321 sender.
24322 .ecindex IIDpiptra1
24323 .ecindex IIDpiptra2
24324
24325
24326 . ////////////////////////////////////////////////////////////////////////////
24327 . ////////////////////////////////////////////////////////////////////////////
24328
24329 .chapter "The smtp transport" "CHAPsmtptrans"
24330 .scindex IIDsmttra1 "transports" "&(smtp)&"
24331 .scindex IIDsmttra2 "&(smtp)& transport"
24332 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24333 or LMTP protocol. The list of hosts to try can either be taken from the address
24334 that is being processed (having been set up by the router), or specified
24335 explicitly for the transport. Timeout and retry processing (see chapter
24336 &<<CHAPretry>>&) is applied to each IP address independently.
24337
24338
24339 .section "Multiple messages on a single connection" "SECID144"
24340 The sending of multiple messages over a single TCP/IP connection can arise in
24341 two ways:
24342
24343 .ilist
24344 If a message contains more than &%max_rcpt%& (see below) addresses that are
24345 routed to the same host, more than one copy of the message has to be sent to
24346 that host. In this situation, multiple copies may be sent in a single run of
24347 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24348 does when it has too many addresses to send in one message also depends on the
24349 value of the global &%remote_max_parallel%& option. Details are given in
24350 section &<<SECToutSMTPTCP>>&.)
24351 .next
24352 .cindex "hints database" "remembering routing"
24353 When a message has been successfully delivered over a TCP/IP connection, Exim
24354 looks in its hints database to see if there are any other messages awaiting a
24355 connection to the same host. If there are, a new delivery process is started
24356 for one of them, and the current TCP/IP connection is passed on to it. The new
24357 process may in turn send multiple copies and possibly create yet another
24358 process.
24359 .endlist
24360
24361
24362 For each copy sent over the same TCP/IP connection, a sequence counter is
24363 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24364 no further messages are sent over that connection.
24365
24366
24367
24368 .section "Use of the $host and $host_address variables" "SECID145"
24369 .vindex "&$host$&"
24370 .vindex "&$host_address$&"
24371 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24372 &$host_address$& are the name and IP address of the first host on the host list
24373 passed by the router. However, when the transport is about to connect to a
24374 specific host, and while it is connected to that host, &$host$& and
24375 &$host_address$& are set to the values for that host. These are the values
24376 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24377 &%serialize_hosts%&, and the various TLS options are expanded.
24378
24379
24380 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24381 .vindex &$tls_bits$&
24382 .vindex &$tls_cipher$&
24383 .vindex &$tls_peerdn$&
24384 .vindex &$tls_sni$&
24385 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24386 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24387 are the values that were set when the message was received.
24388 These are the values that are used for options that are expanded before any
24389 SMTP connections are made. Just before each connection is made, these four
24390 variables are emptied. If TLS is subsequently started, they are set to the
24391 appropriate values for the outgoing connection, and these are the values that
24392 are in force when any authenticators are run and when the
24393 &%authenticated_sender%& option is expanded.
24394
24395 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24396 and will be removed in a future release.
24397
24398
24399 .section "Private options for smtp" "SECID146"
24400 .cindex "options" "&(smtp)& transport"
24401 The private options of the &(smtp)& transport are as follows:
24402
24403
24404 .option address_retry_include_sender smtp boolean true
24405 .cindex "4&'xx'& responses" "retrying after"
24406 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24407 is the combination of sender and recipient that is delayed in subsequent queue
24408 runs until the retry time is reached. You can delay the recipient without
24409 reference to the sender (which is what earlier versions of Exim did), by
24410 setting &%address_retry_include_sender%& false. However, this can lead to
24411 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24412
24413 .option allow_localhost smtp boolean false
24414 .cindex "local host" "sending to"
24415 .cindex "fallback" "hosts specified on transport"
24416 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24417 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24418 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24419 the delivery anyway. This should be used only in special cases when the
24420 configuration ensures that no looping will result (for example, a differently
24421 configured Exim is listening on the port to which the message is sent).
24422
24423
24424 .option authenticated_sender smtp string&!! unset
24425 .cindex "Cyrus"
24426 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24427 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24428 overriding any existing authenticated sender value. If the string expansion is
24429 forced to fail, the option is ignored. Other expansion failures cause delivery
24430 to be deferred. If the result of expansion is an empty string, that is also
24431 ignored.
24432
24433 The expansion happens after the outgoing connection has been made and TLS
24434 started, if required. This means that the &$host$&, &$host_address$&,
24435 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24436 particular connection.
24437
24438 If the SMTP session is not authenticated, the expansion of
24439 &%authenticated_sender%& still happens (and can cause the delivery to be
24440 deferred if it fails), but no AUTH= item is added to MAIL commands
24441 unless &%authenticated_sender_force%& is true.
24442
24443 This option allows you to use the &(smtp)& transport in LMTP mode to
24444 deliver mail to Cyrus IMAP and provide the proper local part as the
24445 &"authenticated sender"&, via a setting such as:
24446 .code
24447 authenticated_sender = $local_part
24448 .endd
24449 This removes the need for IMAP subfolders to be assigned special ACLs to
24450 allow direct delivery to those subfolders.
24451
24452 Because of expected uses such as that just described for Cyrus (when no
24453 domain is involved), there is no checking on the syntax of the provided
24454 value.
24455
24456
24457 .option authenticated_sender_force smtp boolean false
24458 If this option is set true, the &%authenticated_sender%& option's value
24459 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24460 authenticated as a client.
24461
24462
24463 .option command_timeout smtp time 5m
24464 This sets a timeout for receiving a response to an SMTP command that has been
24465 sent out. It is also used when waiting for the initial banner line from the
24466 remote host. Its value must not be zero.
24467
24468
24469 .option connect_timeout smtp time 5m
24470 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24471 to a remote host. A setting of zero allows the system timeout (typically
24472 several minutes) to act. To have any effect, the value of this option must be
24473 less than the system timeout. However, it has been observed that on some
24474 systems there is no system timeout, which is why the default value for this
24475 option is 5 minutes, a value recommended by RFC 1123.
24476
24477
24478 .option connection_max_messages smtp integer 500
24479 .cindex "SMTP" "passed connection"
24480 .cindex "SMTP" "multiple deliveries"
24481 .cindex "multiple SMTP deliveries"
24482 This controls the maximum number of separate message deliveries that are sent
24483 over a single TCP/IP connection. If the value is zero, there is no limit.
24484 For testing purposes, this value can be overridden by the &%-oB%& command line
24485 option.
24486
24487
24488 .option dane_require_tls_ciphers smtp string&!! unset
24489 .cindex "TLS" "requiring specific ciphers for DANE"
24490 .cindex "cipher" "requiring specific"
24491 .cindex DANE "TLS ciphers"
24492 This option may be used to override &%tls_require_ciphers%& for connections
24493 where DANE has been determined to be in effect.
24494 If not set, then &%tls_require_ciphers%& will be used.
24495 Normal SMTP delivery is not able to make strong demands of TLS cipher
24496 configuration, because delivery will fall back to plaintext.  Once DANE has
24497 been determined to be in effect, there is no plaintext fallback and making the
24498 TLS cipherlist configuration stronger will increase security, rather than
24499 counter-intuitively decreasing it.
24500 If the option expands to be empty or is forced to fail, then it will
24501 be treated as unset and &%tls_require_ciphers%& will be used instead.
24502
24503
24504 .option data_timeout smtp time 5m
24505 This sets a timeout for the transmission of each block in the data portion of
24506 the message. As a result, the overall timeout for a message depends on the size
24507 of the message. Its value must not be zero. See also &%final_timeout%&.
24508
24509
24510 .option dkim_canon smtp string&!! unset
24511 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24512 .option dkim_domain smtp string list&!! unset
24513 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24514 .option dkim_hash smtp string&!! sha256
24515 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24516 .option dkim_identity smtp string&!! unset
24517 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24518 .option dkim_private_key smtp string&!! unset
24519 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24520 .option dkim_selector smtp string&!! unset
24521 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24522 .option dkim_strict smtp string&!! unset
24523 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24524 .option dkim_sign_headers smtp string&!! "per RFC"
24525 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24526 .option dkim_timestamps smtp string&!! unset
24527 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24528
24529
24530 .option delay_after_cutoff smtp boolean true
24531 .cindex "final cutoff" "retries, controlling"
24532 .cindex retry "final cutoff"
24533 This option controls what happens when all remote IP addresses for a given
24534 domain have been inaccessible for so long that they have passed their retry
24535 cutoff times.
24536
24537 In the default state, if the next retry time has not been reached for any of
24538 them, the address is bounced without trying any deliveries. In other words,
24539 Exim delays retrying an IP address after the final cutoff time until a new
24540 retry time is reached, and can therefore bounce an address without ever trying
24541 a delivery, when machines have been down for a long time. Some people are
24542 unhappy at this prospect, so...
24543
24544 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24545 addresses are past their final cutoff time, Exim tries to deliver to those
24546 IP addresses that have not been tried since the message arrived. If there are
24547 none, of if they all fail, the address is bounced. In other words, it does not
24548 delay when a new message arrives, but immediately tries those expired IP
24549 addresses that haven't been tried since the message arrived. If there is a
24550 continuous stream of messages for the dead hosts, unsetting
24551 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24552 to them.
24553
24554
24555 .option dns_qualify_single smtp boolean true
24556 If the &%hosts%& or &%fallback_hosts%& option is being used,
24557 and the &%gethostbyname%& option is false,
24558 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24559 in chapter &<<CHAPdnslookup>>& for more details.
24560
24561
24562 .option dns_search_parents smtp boolean false
24563 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24564 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24565 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24566 details.
24567
24568
24569 .option dnssec_request_domains smtp "domain list&!!" unset
24570 .cindex "MX record" "security"
24571 .cindex "DNSSEC" "MX lookup"
24572 .cindex "security" "MX lookup"
24573 .cindex "DNS" "DNSSEC"
24574 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24575 the dnssec request bit set. Setting this transport option is only useful if the
24576 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24577 router option.
24578
24579
24580
24581 .option dnssec_require_domains smtp "domain list&!!" unset
24582 .cindex "MX record" "security"
24583 .cindex "DNSSEC" "MX lookup"
24584 .cindex "security" "MX lookup"
24585 .cindex "DNS" "DNSSEC"
24586 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24587 the dnssec request bit set.  Setting this transport option is only
24588 useful if the transport overrides or sets the host names. See the
24589 &%dnssec_require_domains%& router option.
24590
24591
24592
24593 .option dscp smtp string&!! unset
24594 .cindex "DCSP" "outbound"
24595 This option causes the DSCP value associated with a socket to be set to one
24596 of a number of fixed strings or to numeric value.
24597 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24598 Common values include &`throughput`&, &`mincost`&, and on newer systems
24599 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24600
24601 The outbound packets from Exim will be marked with this value in the header
24602 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24603 that these values will have any effect, not be stripped by networking
24604 equipment, or do much of anything without cooperation with your Network
24605 Engineer and those of all network operators between the source and destination.
24606
24607
24608 .option fallback_hosts smtp "string list" unset
24609 .cindex "fallback" "hosts specified on transport"
24610 String expansion is not applied to this option. The argument must be a
24611 colon-separated list of host names or IP addresses, optionally also including
24612 port numbers, though the separator can be changed, as described in section
24613 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24614 item in a &%route_list%& setting for the &(manualroute)& router, as described
24615 in section &<<SECTformatonehostitem>>&.
24616
24617 Fallback hosts can also be specified on routers, which associate them with the
24618 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24619 &%fallback_hosts%& specified on the transport is used only if the address does
24620 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24621 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24622 However, &%hosts_randomize%& does apply to fallback host lists.
24623
24624 If Exim is unable to deliver to any of the hosts for a particular address, and
24625 the errors are not permanent rejections, the address is put on a separate
24626 transport queue with its host list replaced by the fallback hosts, unless the
24627 address was routed via MX records and the current host was in the original MX
24628 list. In that situation, the fallback host list is not used.
24629
24630 Once normal deliveries are complete, the fallback queue is delivered by
24631 re-running the same transports with the new host lists. If several failing
24632 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24633 copy of the message is sent.
24634
24635 The resolution of the host names on the fallback list is controlled by the
24636 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24637 both to cases when the host list comes with the address and when it is taken
24638 from &%hosts%&. This option provides a &"use a smart host only if delivery
24639 fails"& facility.
24640
24641
24642 .option final_timeout smtp time 10m
24643 This is the timeout that applies while waiting for the response to the final
24644 line containing just &"."& that terminates a message. Its value must not be
24645 zero.
24646
24647 .option gethostbyname smtp boolean false
24648 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24649 being used, names are looked up using &[gethostbyname()]&
24650 (or &[getipnodebyname()]& when available)
24651 instead of using the DNS. Of course, that function may in fact use the DNS, but
24652 it may also consult other sources of information such as &_/etc/hosts_&.
24653
24654 .option gnutls_compat_mode smtp boolean unset
24655 This option controls whether GnuTLS is used in compatibility mode in an Exim
24656 server. This reduces security slightly, but improves interworking with older
24657 implementations of TLS.
24658
24659 .option helo_data smtp string&!! "see below"
24660 .cindex "HELO" "argument, setting"
24661 .cindex "EHLO" "argument, setting"
24662 .cindex "LHLO argument setting"
24663 The value of this option is expanded after a connection to a another host has
24664 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24665 command that starts the outgoing SMTP or LMTP session. The default value of the
24666 option is:
24667 .code
24668 $primary_hostname
24669 .endd
24670 During the expansion, the variables &$host$& and &$host_address$& are set to
24671 the identity of the remote host, and the variables &$sending_ip_address$& and
24672 &$sending_port$& are set to the local IP address and port number that are being
24673 used. These variables can be used to generate different values for different
24674 servers or different local IP addresses. For example, if you want the string
24675 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24676 interface address, you could use this:
24677 .code
24678 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24679   {$primary_hostname}}
24680 .endd
24681 The use of &%helo_data%& applies both to sending messages and when doing
24682 callouts.
24683
24684 .option hosts smtp "string list&!!" unset
24685 Hosts are associated with an address by a router such as &(dnslookup)&, which
24686 finds the hosts by looking up the address domain in the DNS, or by
24687 &(manualroute)&, which has lists of hosts in its configuration. However,
24688 email addresses can be passed to the &(smtp)& transport by any router, and not
24689 all of them can provide an associated list of hosts.
24690
24691 The &%hosts%& option specifies a list of hosts to be used if the address being
24692 processed does not have any hosts associated with it. The hosts specified by
24693 &%hosts%& are also used, whether or not the address has its own hosts, if
24694 &%hosts_override%& is set.
24695
24696 The string is first expanded, before being interpreted as a colon-separated
24697 list of host names or IP addresses, possibly including port numbers. The
24698 separator may be changed to something other than colon, as described in section
24699 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24700 item in a &%route_list%& setting for the &(manualroute)& router, as described
24701 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24702 of the &(manualroute)& router is not available here.
24703
24704 If the expansion fails, delivery is deferred. Unless the failure was caused by
24705 the inability to complete a lookup, the error is logged to the panic log as
24706 well as the main log. Host names are looked up either by searching directly for
24707 address records in the DNS or by calling &[gethostbyname()]& (or
24708 &[getipnodebyname()]& when available), depending on the setting of the
24709 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24710 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24711 address are used.
24712
24713 During delivery, the hosts are tried in order, subject to their retry status,
24714 unless &%hosts_randomize%& is set.
24715
24716
24717 .option hosts_avoid_esmtp smtp "host list&!!" unset
24718 .cindex "ESMTP, avoiding use of"
24719 .cindex "HELO" "forcing use of"
24720 .cindex "EHLO" "avoiding use of"
24721 .cindex "PIPELINING" "avoiding the use of"
24722 This option is for use with broken hosts that announce ESMTP facilities (for
24723 example, PIPELINING) and then fail to implement them properly. When a host
24724 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24725 start of the SMTP session. This means that it cannot use any of the ESMTP
24726 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24727
24728
24729 .option hosts_avoid_pipelining smtp "host list&!!" unset
24730 .cindex "PIPELINING" "avoiding the use of"
24731 Exim will not use the SMTP PIPELINING extension when delivering to any host
24732 that matches this list, even if the server host advertises PIPELINING support.
24733
24734 .new
24735 .option hosts_pipe_connect smtp "host list&!!" unset
24736 .cindex "pipelining" "early connection"
24737 .cindex "pipelining" PIPE_CONNECT
24738 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24739 this option controls which to hosts the facility watched for
24740 and recorded, and used for subsequent connections.
24741
24742 The retry hints database is used for the record,
24743 and records are subject to the &%retry_data_expire%& option.
24744 When used, the pipelining saves on roundtrip times.
24745 It also turns SMTP into a client-first protocol
24746 so combines well with TCP Fast Open.
24747
24748 Note:
24749 When the facility is used, the transport &%helo_data%& option
24750 will be expanded before the &$sending_ip_address$& variable
24751 is filled in.
24752 A check is made for the use of that variable, without the
24753 presence of a &"def:"& test on it, but suitably complex coding
24754 can avoid the check and produce unexpected results.
24755 You have been warned.
24756 .wen
24757
24758
24759 .option hosts_avoid_tls smtp "host list&!!" unset
24760 .cindex "TLS" "avoiding for certain hosts"
24761 Exim will not try to start a TLS session when delivering to any host that
24762 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24763
24764 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24765 .cindex "TLS" "avoiding for certain hosts"
24766 Exim will not try to start a TLS session for a verify callout,
24767 or when delivering in cutthrough mode,
24768 to any host that matches this list.
24769
24770
24771 .option hosts_max_try smtp integer 5
24772 .cindex "host" "maximum number to try"
24773 .cindex "limit" "number of hosts tried"
24774 .cindex "limit" "number of MX tried"
24775 .cindex "MX record" "maximum tried"
24776 This option limits the number of IP addresses that are tried for any one
24777 delivery in cases where there are temporary delivery errors. Section
24778 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24779
24780
24781 .option hosts_max_try_hardlimit smtp integer 50
24782 This is an additional check on the maximum number of IP addresses that Exim
24783 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24784 why it exists.
24785
24786
24787
24788 .option hosts_nopass_tls smtp "host list&!!" unset
24789 .cindex "TLS" "passing connection"
24790 .cindex "multiple SMTP deliveries"
24791 .cindex "TLS" "multiple message deliveries"
24792 For any host that matches this list, a connection on which a TLS session has
24793 been started will not be passed to a new delivery process for sending another
24794 message on the same connection. See section &<<SECTmulmessam>>& for an
24795 explanation of when this might be needed.
24796
24797 .new
24798 .option hosts_noproxy_tls smtp "host list&!!" unset
24799 .cindex "TLS" "passing connection"
24800 .cindex "multiple SMTP deliveries"
24801 .cindex "TLS" "multiple message deliveries"
24802 For any host that matches this list, a TLS session which has
24803 been started will not be passed to a new delivery process for sending another
24804 message on the same session.
24805 .wen
24806
24807 The traditional implementation closes down TLS and re-starts it in the new
24808 process, on the same open TCP connection, for each successive message
24809 sent.  If permitted by this option a pipe to to the new process is set up
24810 instead, and the original process maintains the TLS connection and proxies
24811 the SMTP connection from and to the new process and any subsequents.
24812 The new process has no access to TLS information, so cannot include it in
24813 logging.
24814
24815
24816
24817 .option hosts_override smtp boolean false
24818 If this option is set and the &%hosts%& option is also set, any hosts that are
24819 attached to the address are ignored, and instead the hosts specified by the
24820 &%hosts%& option are always used. This option does not apply to
24821 &%fallback_hosts%&.
24822
24823
24824 .option hosts_randomize smtp boolean false
24825 .cindex "randomized host list"
24826 .cindex "host" "list of; randomized"
24827 .cindex "fallback" "randomized hosts"
24828 If this option is set, and either the list of hosts is taken from the
24829 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24830 were not obtained from MX records (this includes fallback hosts from the
24831 router), and were not randomized by the router, the order of trying the hosts
24832 is randomized each time the transport runs. Randomizing the order of a host
24833 list can be used to do crude load sharing.
24834
24835 When &%hosts_randomize%& is true, a host list may be split into groups whose
24836 order is separately randomized. This makes it possible to set up MX-like
24837 behaviour. The boundaries between groups are indicated by an item that is just
24838 &`+`& in the host list. For example:
24839 .code
24840 hosts = host1:host2:host3:+:host4:host5
24841 .endd
24842 The order of the first three hosts and the order of the last two hosts is
24843 randomized for each use, but the first three always end up before the last two.
24844 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24845
24846 .option hosts_require_auth smtp "host list&!!" unset
24847 .cindex "authentication" "required by client"
24848 This option provides a list of servers for which authentication must succeed
24849 before Exim will try to transfer a message. If authentication fails for
24850 servers which are not in this list, Exim tries to send unauthenticated. If
24851 authentication fails for one of these servers, delivery is deferred. This
24852 temporary error is detectable in the retry rules, so it can be turned into a
24853 hard failure if required. See also &%hosts_try_auth%&, and chapter
24854 &<<CHAPSMTPAUTH>>& for details of authentication.
24855
24856
24857 .option hosts_request_ocsp smtp "host list&!!" *
24858 .cindex "TLS" "requiring for certain servers"
24859 Exim will request a Certificate Status on a
24860 TLS session for any host that matches this list.
24861 &%tls_verify_certificates%& should also be set for the transport.
24862
24863 .option hosts_require_dane smtp "host list&!!" unset
24864 .cindex DANE "transport options"
24865 .cindex DANE "requiring for certain servers"
24866 If built with DANE support, Exim  will require that a DNSSEC-validated
24867 TLSA record is present for any host matching the list,
24868 and that a DANE-verified TLS connection is made. See
24869 the &%dnssec_request_domains%& router and transport options.
24870 There will be no fallback to in-clear communication.
24871 See section &<<SECDANE>>&.
24872
24873 .option hosts_require_ocsp smtp "host list&!!" unset
24874 .cindex "TLS" "requiring for certain servers"
24875 Exim will request, and check for a valid Certificate Status being given, on a
24876 TLS session for any host that matches this list.
24877 &%tls_verify_certificates%& should also be set for the transport.
24878
24879 .option hosts_require_tls smtp "host list&!!" unset
24880 .cindex "TLS" "requiring for certain servers"
24881 Exim will insist on using a TLS session when delivering to any host that
24882 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24883 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24884 incoming messages, use an appropriate ACL.
24885
24886 .option hosts_try_auth smtp "host list&!!" unset
24887 .cindex "authentication" "optional in client"
24888 This option provides a list of servers to which, provided they announce
24889 authentication support, Exim will attempt to authenticate as a client when it
24890 connects. If authentication fails, Exim will try to transfer the message
24891 unauthenticated. See also &%hosts_require_auth%&, and chapter
24892 &<<CHAPSMTPAUTH>>& for details of authentication.
24893
24894 .option hosts_try_chunking smtp "host list&!!" *
24895 .cindex CHUNKING "enabling, in client"
24896 .cindex BDAT "SMTP command"
24897 .cindex "RFC 3030" "CHUNKING"
24898 This option provides a list of servers to which, provided they announce
24899 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24900 .new
24901 Unless DKIM signing is being done,
24902 .wen
24903 BDAT will not be used in conjunction with a transport filter.
24904
24905 .option hosts_try_dane smtp "host list&!!" *
24906 .cindex DANE "transport options"
24907 .cindex DANE "attempting for certain servers"
24908 If built with DANE support, Exim  will require that a DNSSEC-validated
24909 TLSA record is present for any host matching the list,
24910 and that a DANE-verified TLS connection is made. See
24911 the &%dnssec_request_domains%& router and transport options.
24912 There will be no fallback to in-clear communication.
24913 See section &<<SECDANE>>&.
24914
24915 .option hosts_try_fastopen smtp "host list&!!" *
24916 .cindex "fast open, TCP" "enabling, in client"
24917 .cindex "TCP Fast Open" "enabling, in client"
24918 .cindex "RFC 7413" "TCP Fast Open"
24919 This option provides a list of servers to which, provided
24920 the facility is supported by this system, Exim will attempt to
24921 perform a TCP Fast Open.
24922 No data is sent on the SYN segment but, if the remote server also
24923 supports the facility, it can send its SMTP banner immediately after
24924 the SYN,ACK segment.  This can save up to one round-trip time.
24925
24926 The facility is only active for previously-contacted servers,
24927 as the initiator must present a cookie in the SYN segment.
24928
24929 On (at least some) current Linux distributions the facility must be enabled
24930 in the kernel by the sysadmin before the support is usable.
24931 There is no option for control of the server side; if the system supports
24932 it it is always enabled.  Note that lengthy operations in the connect ACL,
24933 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24934
24935 .option hosts_try_prdr smtp "host list&!!" *
24936 .cindex "PRDR" "enabling, optional in client"
24937 This option provides a list of servers to which, provided they announce
24938 PRDR support, Exim will attempt to negotiate PRDR
24939 for multi-recipient messages.
24940 The option can usually be left as default.
24941
24942 .option interface smtp "string list&!!" unset
24943 .cindex "bind IP address"
24944 .cindex "IP address" "binding"
24945 .vindex "&$host$&"
24946 .vindex "&$host_address$&"
24947 This option specifies which interface to bind to when making an outgoing SMTP
24948 call. The value is an IP address, not an interface name such as
24949 &`eth0`&. Do not confuse this with the interface address that was used when a
24950 message was received, which is in &$received_ip_address$&, formerly known as
24951 &$interface_address$&. The name was changed to minimize confusion with the
24952 outgoing interface address. There is no variable that contains an outgoing
24953 interface address because, unless it is set by this option, its value is
24954 unknown.
24955
24956 During the expansion of the &%interface%& option the variables &$host$& and
24957 &$host_address$& refer to the host to which a connection is about to be made
24958 during the expansion of the string. Forced expansion failure, or an empty
24959 string result causes the option to be ignored. Otherwise, after expansion, the
24960 string must be a list of IP addresses, colon-separated by default, but the
24961 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
24962 For example:
24963 .code
24964 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24965 .endd
24966 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24967 connection. If none of them are the correct type, the option is ignored. If
24968 &%interface%& is not set, or is ignored, the system's IP functions choose which
24969 interface to use if the host has more than one.
24970
24971
24972 .option keepalive smtp boolean true
24973 .cindex "keepalive" "on outgoing connection"
24974 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24975 connections. When set, it causes the kernel to probe idle connections
24976 periodically, by sending packets with &"old"& sequence numbers. The other end
24977 of the connection should send a acknowledgment if the connection is still okay
24978 or a reset if the connection has been aborted. The reason for doing this is
24979 that it has the beneficial effect of freeing up certain types of connection
24980 that can get stuck when the remote host is disconnected without tidying up the
24981 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24982 unreachable hosts.
24983
24984
24985 .option lmtp_ignore_quota smtp boolean false
24986 .cindex "LMTP" "ignoring quota errors"
24987 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24988 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24989 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24990
24991 .option max_rcpt smtp integer 100
24992 .cindex "RCPT" "maximum number of outgoing"
24993 This option limits the number of RCPT commands that are sent in a single
24994 SMTP message transaction. Each set of addresses is treated independently, and
24995 so can cause parallel connections to the same host if &%remote_max_parallel%&
24996 permits this.
24997
24998
24999 .option multi_domain smtp boolean&!! true
25000 .vindex "&$domain$&"
25001 When this option is set, the &(smtp)& transport can handle a number of
25002 addresses containing a mixture of different domains provided they all resolve
25003 to the same list of hosts. Turning the option off restricts the transport to
25004 handling only one domain at a time. This is useful if you want to use
25005 &$domain$& in an expansion for the transport, because it is set only when there
25006 is a single domain involved in a remote delivery.
25007
25008 It is expanded per-address and can depend on any of
25009 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25010 &$host$&, &$host_address$& and &$host_port$&.
25011
25012 .option port smtp string&!! "see below"
25013 .cindex "port" "sending TCP/IP"
25014 .cindex "TCP/IP" "setting outgoing port"
25015 This option specifies the TCP/IP port on the server to which Exim connects.
25016 &*Note:*& Do not confuse this with the port that was used when a message was
25017 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25018 The name was changed to minimize confusion with the outgoing port. There is no
25019 variable that contains an outgoing port.
25020
25021 If the value of this option begins with a digit it is taken as a port number;
25022 otherwise it is looked up using &[getservbyname()]&. The default value is
25023 normally &"smtp"&,
25024 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25025 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25026 If the expansion fails, or if a port number cannot be found, delivery
25027 is deferred.
25028
25029 Note that at least one Linux distribution has been seen failing
25030 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25031
25032
25033
25034 .option protocol smtp string smtp
25035 .cindex "LMTP" "over TCP/IP"
25036 .cindex "ssmtp protocol" "outbound"
25037 .cindex "TLS" "SSL-on-connect outbound"
25038 .vindex "&$port$&"
25039 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25040 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25041 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25042 deliveries into closed message stores. Exim also has support for running LMTP
25043 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25044
25045 If this option is set to &"smtps"&, the default value for the &%port%& option
25046 changes to &"smtps"&, and the transport initiates TLS immediately after
25047 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25048 The Internet standards bodies used to strongly discourage use of this mode,
25049 but as of RFC 8314 it is perferred over STARTTLS for message submission
25050 (as distinct from MTA-MTA communication).
25051
25052
25053 .option retry_include_ip_address smtp boolean&!! true
25054 Exim normally includes both the host name and the IP address in the key it
25055 constructs for indexing retry data after a temporary delivery failure. This
25056 means that when one of several IP addresses for a host is failing, it gets
25057 tried periodically (controlled by the retry rules), but use of the other IP
25058 addresses is not affected.
25059
25060 However, in some dialup environments hosts are assigned a different IP address
25061 each time they connect. In this situation the use of the IP address as part of
25062 the retry key leads to undesirable behaviour. Setting this option false causes
25063 Exim to use only the host name.
25064 Since it is expanded it can be made to depend on the host or domain.
25065
25066
25067 .option serialize_hosts smtp "host list&!!" unset
25068 .cindex "serializing connections"
25069 .cindex "host" "serializing connections"
25070 Because Exim operates in a distributed manner, if several messages for the same
25071 host arrive at around the same time, more than one simultaneous connection to
25072 the remote host can occur. This is not usually a problem except when there is a
25073 slow link between the hosts. In that situation it may be helpful to restrict
25074 Exim to one connection at a time. This can be done by setting
25075 &%serialize_hosts%& to match the relevant hosts.
25076
25077 .cindex "hints database" "serializing deliveries to a host"
25078 Exim implements serialization by means of a hints database in which a record is
25079 written whenever a process connects to one of the restricted hosts. The record
25080 is deleted when the connection is completed. Obviously there is scope for
25081 records to get left lying around if there is a system or program crash. To
25082 guard against this, Exim ignores any records that are more than six hours old.
25083
25084 If you set up this kind of serialization, you should also arrange to delete the
25085 relevant hints database whenever your system reboots. The names of the files
25086 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25087 may be one or two files, depending on the type of DBM in use. The same files
25088 are used for ETRN serialization.
25089
25090 See also the &%max_parallel%& generic transport option.
25091
25092
25093 .option size_addition smtp integer 1024
25094 .cindex "SMTP" "SIZE"
25095 .cindex "message" "size issue for transport filter"
25096 .cindex "size" "of message"
25097 .cindex "transport" "filter"
25098 .cindex "filter" "transport filter"
25099 If a remote SMTP server indicates that it supports the SIZE option of the
25100 MAIL command, Exim uses this to pass over the message size at the start of
25101 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25102 sends, to allow for headers and other text that may be added during delivery by
25103 configuration options or in a transport filter. It may be necessary to increase
25104 this if a lot of text is added to messages.
25105
25106 Alternatively, if the value of &%size_addition%& is set negative, it disables
25107 the use of the SIZE option altogether.
25108
25109
25110 .option socks_proxy smtp string&!! unset
25111 .cindex proxy SOCKS
25112 This option enables use of SOCKS proxies for connections made by the
25113 transport.  For details see section &<<SECTproxySOCKS>>&.
25114
25115
25116 .option tls_certificate smtp string&!! unset
25117 .cindex "TLS" "client certificate, location of"
25118 .cindex "certificate" "client, location of"
25119 .vindex "&$host$&"
25120 .vindex "&$host_address$&"
25121 The value of this option must be the absolute path to a file which contains the
25122 client's certificate, for possible use when sending a message over an encrypted
25123 connection. The values of &$host$& and &$host_address$& are set to the name and
25124 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25125 details of TLS.
25126
25127 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25128 certificate when sending messages as a client. The global option of the same
25129 name specifies the certificate for Exim as a server; it is not automatically
25130 assumed that the same certificate should be used when Exim is operating as a
25131 client.
25132
25133
25134 .option tls_crl smtp string&!! unset
25135 .cindex "TLS" "client certificate revocation list"
25136 .cindex "certificate" "revocation list for client"
25137 This option specifies a certificate revocation list. The expanded value must
25138 be the name of a file that contains a CRL in PEM format.
25139
25140
25141 .option tls_dh_min_bits smtp integer 1024
25142 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25143 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25144 key agreement is negotiated, the server will provide a large prime number
25145 for use.  This option establishes the minimum acceptable size of that number.
25146 If the parameter offered by the server is too small, then the TLS handshake
25147 will fail.
25148
25149 Only supported when using GnuTLS.
25150
25151
25152 .option tls_privatekey smtp string&!! unset
25153 .cindex "TLS" "client private key, location of"
25154 .vindex "&$host$&"
25155 .vindex "&$host_address$&"
25156 The value of this option must be the absolute path to a file which contains the
25157 client's private key. This is used when sending a message over an encrypted
25158 connection using a client certificate. The values of &$host$& and
25159 &$host_address$& are set to the name and address of the server during the
25160 expansion. If this option is unset, or the expansion is forced to fail, or the
25161 result is an empty string, the private key is assumed to be in the same file as
25162 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25163
25164
25165 .option tls_require_ciphers smtp string&!! unset
25166 .cindex "TLS" "requiring specific ciphers"
25167 .cindex "cipher" "requiring specific"
25168 .vindex "&$host$&"
25169 .vindex "&$host_address$&"
25170 The value of this option must be a list of permitted cipher suites, for use
25171 when setting up an outgoing encrypted connection. (There is a global option of
25172 the same name for controlling incoming connections.) The values of &$host$& and
25173 &$host_address$& are set to the name and address of the server during the
25174 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25175 is used in different ways by OpenSSL and GnuTLS (see sections
25176 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25177 ciphers is a preference order.
25178
25179
25180
25181 .option tls_sni smtp string&!! unset
25182 .cindex "TLS" "Server Name Indication"
25183 .vindex "&$tls_sni$&"
25184 If this option is set then it sets the $tls_out_sni variable and causes any
25185 TLS session to pass this value as the Server Name Indication extension to
25186 the remote side, which can be used by the remote side to select an appropriate
25187 certificate and private key for the session.
25188
25189 See &<<SECTtlssni>>& for more information.
25190
25191 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25192 TLS extensions.
25193
25194
25195
25196
25197 .option tls_tempfail_tryclear smtp boolean true
25198 .cindex "4&'xx'& responses" "to STARTTLS"
25199 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25200 setting up a TLS session, this option determines whether or not Exim should try
25201 to deliver the message unencrypted. If it is set false, delivery to the
25202 current host is deferred; if there are other hosts, they are tried. If this
25203 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25204 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25205 TLS negotiation fails, Exim closes the current connection (because it is in an
25206 unknown state), opens a new one to the same host, and then tries the delivery
25207 in clear.
25208
25209
25210 .option tls_try_verify_hosts smtp "host list&!!" *
25211 .cindex "TLS" "server certificate verification"
25212 .cindex "certificate" "verification of server"
25213 This option gives a list of hosts for which, on encrypted connections,
25214 certificate verification will be tried but need not succeed.
25215 The &%tls_verify_certificates%& option must also be set.
25216 Note that unless the host is in this list
25217 TLS connections will be denied to hosts using self-signed certificates
25218 when &%tls_verify_certificates%& is matched.
25219 The &$tls_out_certificate_verified$& variable is set when
25220 certificate verification succeeds.
25221
25222
25223 .option tls_verify_cert_hostnames smtp "host list&!!" *
25224 .cindex "TLS" "server certificate hostname verification"
25225 .cindex "certificate" "verification of server"
25226 This option give a list of hosts for which,
25227 while verifying the server certificate,
25228 checks will be included on the host name
25229 (note that this will generally be the result of a DNS MX lookup)
25230 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25231 limited to being the initial component of a 3-or-more component FQDN.
25232
25233 There is no equivalent checking on client certificates.
25234
25235
25236 .option tls_verify_certificates smtp string&!! system
25237 .cindex "TLS" "server certificate verification"
25238 .cindex "certificate" "verification of server"
25239 .vindex "&$host$&"
25240 .vindex "&$host_address$&"
25241 The value of this option must be either the
25242 word "system"
25243 or the absolute path to
25244 a file or directory containing permitted certificates for servers,
25245 for use when setting up an encrypted connection.
25246
25247 The "system" value for the option will use a location compiled into the SSL library.
25248 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25249 is taken as empty and an explicit location
25250 must be specified.
25251
25252 The use of a directory for the option value is not available for GnuTLS versions
25253 preceding 3.3.6 and a single file must be used.
25254
25255 With OpenSSL the certificates specified
25256 explicitly
25257 either by file or directory
25258 are added to those given by the system default location.
25259
25260 The values of &$host$& and
25261 &$host_address$& are set to the name and address of the server during the
25262 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25263
25264 For back-compatibility,
25265 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25266 (a single-colon empty list counts as being set)
25267 and certificate verification fails the TLS connection is closed.
25268
25269
25270 .option tls_verify_hosts smtp "host list&!!" unset
25271 .cindex "TLS" "server certificate verification"
25272 .cindex "certificate" "verification of server"
25273 This option gives a list of hosts for which, on encrypted connections,
25274 certificate verification must succeed.
25275 The &%tls_verify_certificates%& option must also be set.
25276 If both this option and &%tls_try_verify_hosts%& are unset
25277 operation is as if this option selected all hosts.
25278
25279 .option utf8_downconvert smtp integer!! unset
25280 .cindex utf8 "address downconversion"
25281 .cindex i18n "utf8 address downconversion"
25282 If built with internationalization support,
25283 this option controls conversion of UTF-8 in message addresses
25284 to a-label form.
25285 For details see section &<<SECTi18nMTA>>&.
25286
25287
25288
25289
25290 .section "How the limits for the number of hosts to try are used" &&&
25291          "SECTvalhosmax"
25292 .cindex "host" "maximum number to try"
25293 .cindex "limit" "hosts; maximum number tried"
25294 There are two options that are concerned with the number of hosts that are
25295 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25296 &%hosts_max_try_hardlimit%&.
25297
25298
25299 The &%hosts_max_try%& option limits the number of hosts that are tried
25300 for a single delivery. However, despite the term &"host"& in its name, the
25301 option actually applies to each IP address independently. In other words, a
25302 multihomed host is treated as several independent hosts, just as it is for
25303 retrying.
25304
25305 Many of the larger ISPs have multiple MX records which often point to
25306 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25307 created as a result of routing one of these domains.
25308
25309 Trying every single IP address on such a long list does not seem sensible; if
25310 several at the top of the list fail, it is reasonable to assume there is some
25311 problem that is likely to affect all of them. Roughly speaking, the value of
25312 &%hosts_max_try%& is the maximum number that are tried before deferring the
25313 delivery. However, the logic cannot be quite that simple.
25314
25315 Firstly, IP addresses that are skipped because their retry times have not
25316 arrived do not count, and in addition, addresses that are past their retry
25317 limits are also not counted, even when they are tried. This means that when
25318 some IP addresses are past their retry limits, more than the value of
25319 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25320 that all IP addresses are considered before timing out an email address (but
25321 see below for an exception).
25322
25323 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25324 list to see if there is a subsequent host with a different (higher valued) MX.
25325 If there is, that host is considered next, and the current IP address is used
25326 but not counted. This behaviour helps in the case of a domain with a retry rule
25327 that hardly ever delays any hosts, as is now explained:
25328
25329 Consider the case of a long list of hosts with one MX value, and a few with a
25330 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25331 hosts at the top of the list are tried at first. With the default retry rule,
25332 which specifies increasing retry times, the higher MX hosts are eventually
25333 tried when those at the top of the list are skipped because they have not
25334 reached their retry times.
25335
25336 However, it is common practice to put a fixed short retry time on domains for
25337 large ISPs, on the grounds that their servers are rarely down for very long.
25338 Unfortunately, these are exactly the domains that tend to resolve to long lists
25339 of hosts. The short retry time means that the lowest MX hosts are tried every
25340 time. The attempts may be in a different order because of random sorting, but
25341 without the special MX check, the higher MX hosts would never be tried until
25342 all the lower MX hosts had timed out (which might be several days), because
25343 there are always some lower MX hosts that have reached their retry times. With
25344 the special check, Exim considers at least one IP address from each MX value at
25345 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25346 reached.
25347
25348 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25349 particular, Exim normally eventually tries all the IP addresses before timing
25350 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25351 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25352 been set up with hundreds of IP addresses for some domains. It can
25353 take a very long time indeed for an address to time out in these cases.
25354
25355 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25356 Exim never tries more than this number of IP addresses; if it hits this limit
25357 and they are all timed out, the email address is bounced, even though not all
25358 possible IP addresses have been tried.
25359 .ecindex IIDsmttra1
25360 .ecindex IIDsmttra2
25361
25362
25363
25364
25365
25366 . ////////////////////////////////////////////////////////////////////////////
25367 . ////////////////////////////////////////////////////////////////////////////
25368
25369 .chapter "Address rewriting" "CHAPrewrite"
25370 .scindex IIDaddrew "rewriting" "addresses"
25371 There are some circumstances in which Exim automatically rewrites domains in
25372 addresses. The two most common are when an address is given without a domain
25373 (referred to as an &"unqualified address"&) or when an address contains an
25374 abbreviated domain that is expanded by DNS lookup.
25375
25376 Unqualified envelope addresses are accepted only for locally submitted
25377 messages, or for messages that are received from hosts matching
25378 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25379 appropriate. Unqualified addresses in header lines are qualified if they are in
25380 locally submitted messages, or messages from hosts that are permitted to send
25381 unqualified envelope addresses. Otherwise, unqualified addresses in header
25382 lines are neither qualified nor rewritten.
25383
25384 One situation in which Exim does &'not'& automatically rewrite a domain is
25385 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25386 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25387 do this. The new RFCs do not contain this suggestion.
25388
25389
25390 .section "Explicitly configured address rewriting" "SECID147"
25391 This chapter describes the rewriting rules that can be used in the
25392 main rewrite section of the configuration file, and also in the generic
25393 &%headers_rewrite%& option that can be set on any transport.
25394
25395 Some people believe that configured address rewriting is a Mortal Sin.
25396 Others believe that life is not possible without it. Exim provides the
25397 facility; you do not have to use it.
25398
25399 The main rewriting rules that appear in the &"rewrite"& section of the
25400 configuration file are applied to addresses in incoming messages, both envelope
25401 addresses and addresses in header lines. Each rule specifies the types of
25402 address to which it applies.
25403
25404 Whether or not addresses in header lines are rewritten depends on the origin of
25405 the headers and the type of rewriting. Global rewriting, that is, rewriting
25406 rules from the rewrite section of the configuration file, is applied only to
25407 those headers that were received with the message. Header lines that are added
25408 by ACLs or by a system filter or by individual routers or transports (which
25409 are specific to individual recipient addresses) are not rewritten by the global
25410 rules.
25411
25412 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25413 applies all headers except those added by routers and transports. That is, as
25414 well as the headers that were received with the message, it also applies to
25415 headers that were added by an ACL or a system filter.
25416
25417
25418 In general, rewriting addresses from your own system or domain has some
25419 legitimacy. Rewriting other addresses should be done only with great care and
25420 in special circumstances. The author of Exim believes that rewriting should be
25421 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25422 Although it can sometimes be used as a routing tool, this is very strongly
25423 discouraged.
25424
25425 There are two commonly encountered circumstances where rewriting is used, as
25426 illustrated by these examples:
25427
25428 .ilist
25429 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25430 exchange mail with each other behind a firewall, but there is only a single
25431 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25432 &'hitch.fict.example'& when sending mail off-site.
25433 .next
25434 A host rewrites the local parts of its own users so that, for example,
25435 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25436 .endlist
25437
25438
25439
25440 .section "When does rewriting happen?" "SECID148"
25441 .cindex "rewriting" "timing of"
25442 .cindex "&ACL;" "rewriting addresses in"
25443 Configured address rewriting can take place at several different stages of a
25444 message's processing.
25445
25446 .vindex "&$sender_address$&"
25447 At the start of an ACL for MAIL, the sender address may have been rewritten
25448 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25449 ordinary rewrite rules have yet been applied. If, however, the sender address
25450 is verified in the ACL, it is rewritten before verification, and remains
25451 rewritten thereafter. The subsequent value of &$sender_address$& is the
25452 rewritten address. This also applies if sender verification happens in a
25453 RCPT ACL. Otherwise, when the sender address is not verified, it is
25454 rewritten as soon as a message's header lines have been received.
25455
25456 .vindex "&$domain$&"
25457 .vindex "&$local_part$&"
25458 Similarly, at the start of an ACL for RCPT, the current recipient's address
25459 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25460 rewrite rules have yet been applied to it. However, the behaviour is different
25461 from the sender address when a recipient is verified. The address is rewritten
25462 for the verification, but the rewriting is not remembered at this stage. The
25463 value of &$local_part$& and &$domain$& after verification are always the same
25464 as they were before (that is, they contain the unrewritten &-- except for
25465 SMTP-time rewriting &-- address).
25466
25467 As soon as a message's header lines have been received, all the envelope
25468 recipient addresses are permanently rewritten, and rewriting is also applied to
25469 the addresses in the header lines (if configured). This happens before adding
25470 any header lines that were specified in MAIL or RCPT ACLs, and
25471 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25472 before the DATA ACL and &[local_scan()]& functions are run.
25473
25474 When an address is being routed, either for delivery or for verification,
25475 rewriting is applied immediately to child addresses that are generated by
25476 redirection, unless &%no_rewrite%& is set on the router.
25477
25478 .cindex "envelope from"
25479 .cindex "envelope sender" "rewriting at transport time"
25480 .cindex "rewriting" "at transport time"
25481 .cindex "header lines" "rewriting at transport time"
25482 At transport time, additional rewriting of addresses in header lines can be
25483 specified by setting the generic &%headers_rewrite%& option on a transport.
25484 This option contains rules that are identical in form to those in the rewrite
25485 section of the configuration file. They are applied to the original message
25486 header lines and any that were added by ACLs or a system filter. They are not
25487 applied to header lines that are added by routers or the transport.
25488
25489 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25490 transport option. However, it is not possible to rewrite envelope recipients at
25491 transport time.
25492
25493
25494
25495
25496 .section "Testing the rewriting rules that apply on input" "SECID149"
25497 .cindex "rewriting" "testing"
25498 .cindex "testing" "rewriting"
25499 Exim's input rewriting configuration appears in a part of the runtime
25500 configuration file headed by &"begin rewrite"&. It can be tested by the
25501 &%-brw%& command line option. This takes an address (which can be a full RFC
25502 2822 address) as its argument. The output is a list of how the address would be
25503 transformed by the rewriting rules for each of the different places it might
25504 appear in an incoming message, that is, for each different header and for the
25505 envelope sender and recipient fields. For example,
25506 .code
25507 exim -brw ph10@exim.workshop.example
25508 .endd
25509 might produce the output
25510 .code
25511 sender: Philip.Hazel@exim.workshop.example
25512 from: Philip.Hazel@exim.workshop.example
25513 to: ph10@exim.workshop.example
25514 cc: ph10@exim.workshop.example
25515 bcc: ph10@exim.workshop.example
25516 reply-to: Philip.Hazel@exim.workshop.example
25517 env-from: Philip.Hazel@exim.workshop.example
25518 env-to: ph10@exim.workshop.example
25519 .endd
25520 which shows that rewriting has been set up for that address when used in any of
25521 the source fields, but not when it appears as a recipient address. At the
25522 present time, there is no equivalent way of testing rewriting rules that are
25523 set for a particular transport.
25524
25525
25526 .section "Rewriting rules" "SECID150"
25527 .cindex "rewriting" "rules"
25528 The rewrite section of the configuration file consists of lines of rewriting
25529 rules in the form
25530 .display
25531 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25532 .endd
25533 Rewriting rules that are specified for the &%headers_rewrite%& generic
25534 transport option are given as a colon-separated list. Each item in the list
25535 takes the same form as a line in the main rewriting configuration (except that
25536 any colons must be doubled, of course).
25537
25538 The formats of source patterns and replacement strings are described below.
25539 Each is terminated by white space, unless enclosed in double quotes, in which
25540 case normal quoting conventions apply inside the quotes. The flags are single
25541 characters which may appear in any order. Spaces and tabs between them are
25542 ignored.
25543
25544 For each address that could potentially be rewritten, the rules are scanned in
25545 order, and replacements for the address from earlier rules can themselves be
25546 replaced by later rules (but see the &"q"& and &"R"& flags).
25547
25548 The order in which addresses are rewritten is undefined, may change between
25549 releases, and must not be relied on, with one exception: when a message is
25550 received, the envelope sender is always rewritten first, before any header
25551 lines are rewritten. For example, the replacement string for a rewrite of an
25552 address in &'To:'& must not assume that the message's address in &'From:'& has
25553 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25554 that the envelope sender has already been rewritten.
25555
25556 .vindex "&$domain$&"
25557 .vindex "&$local_part$&"
25558 The variables &$local_part$& and &$domain$& can be used in the replacement
25559 string to refer to the address that is being rewritten. Note that lookup-driven
25560 rewriting can be done by a rule of the form
25561 .code
25562 *@*   ${lookup ...
25563 .endd
25564 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25565 refer to the address that is being rewritten.
25566
25567
25568 .section "Rewriting patterns" "SECID151"
25569 .cindex "rewriting" "patterns"
25570 .cindex "address list" "in a rewriting pattern"
25571 The source pattern in a rewriting rule is any item which may appear in an
25572 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25573 single-item address list, which means that it is expanded before being tested
25574 against the address. As always, if you use a regular expression as a pattern,
25575 you must take care to escape dollar and backslash characters, or use the &`\N`&
25576 facility to suppress string expansion within the regular expression.
25577
25578 Domains in patterns should be given in lower case. Local parts in patterns are
25579 case-sensitive. If you want to do case-insensitive matching of local parts, you
25580 can use a regular expression that starts with &`^(?i)`&.
25581
25582 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25583 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25584 depending on the type of match which occurred. These can be used in the
25585 replacement string to insert portions of the incoming address. &$0$& always
25586 refers to the complete incoming address. When a regular expression is used, the
25587 numerical variables are set from its capturing subexpressions. For other types
25588 of pattern they are set as follows:
25589
25590 .ilist
25591 If a local part or domain starts with an asterisk, the numerical variables
25592 refer to the character strings matched by asterisks, with &$1$& associated with
25593 the first asterisk, and &$2$& with the second, if present. For example, if the
25594 pattern
25595 .code
25596 *queen@*.fict.example
25597 .endd
25598 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25599 .code
25600 $0 = hearts-queen@wonderland.fict.example
25601 $1 = hearts-
25602 $2 = wonderland
25603 .endd
25604 Note that if the local part does not start with an asterisk, but the domain
25605 does, it is &$1$& that contains the wild part of the domain.
25606
25607 .next
25608 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25609 of the domain are placed in the next available numerical variables. Suppose,
25610 for example, that the address &'foo@bar.baz.example'& is processed by a
25611 rewriting rule of the form
25612 .display
25613 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25614 .endd
25615 and the key in the file that matches the domain is &`*.baz.example`&. Then
25616 .code
25617 $1 = foo
25618 $2 = bar
25619 $3 = baz.example
25620 .endd
25621 If the address &'foo@baz.example'& is looked up, this matches the same
25622 wildcard file entry, and in this case &$2$& is set to the empty string, but
25623 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25624 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25625 whole domain. For non-partial domain lookups, no numerical variables are set.
25626 .endlist
25627
25628
25629 .section "Rewriting replacements" "SECID152"
25630 .cindex "rewriting" "replacements"
25631 If the replacement string for a rule is a single asterisk, addresses that
25632 match the pattern and the flags are &'not'& rewritten, and no subsequent
25633 rewriting rules are scanned. For example,
25634 .code
25635 hatta@lookingglass.fict.example  *  f
25636 .endd
25637 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25638 &'From:'& headers.
25639
25640 .vindex "&$domain$&"
25641 .vindex "&$local_part$&"
25642 If the replacement string is not a single asterisk, it is expanded, and must
25643 yield a fully qualified address. Within the expansion, the variables
25644 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25645 Any letters they contain retain their original case &-- they are not lower
25646 cased. The numerical variables are set up according to the type of pattern that
25647 matched the address, as described above. If the expansion is forced to fail by
25648 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25649 current rule is abandoned, but subsequent rules may take effect. Any other
25650 expansion failure causes the entire rewriting operation to be abandoned, and an
25651 entry written to the panic log.
25652
25653
25654
25655 .section "Rewriting flags" "SECID153"
25656 There are three different kinds of flag that may appear on rewriting rules:
25657
25658 .ilist
25659 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25660 c, f, h, r, s, t.
25661 .next
25662 A flag that specifies rewriting at SMTP time: S.
25663 .next
25664 Flags that control the rewriting process: Q, q, R, w.
25665 .endlist
25666
25667 For rules that are part of the &%headers_rewrite%& generic transport option,
25668 E, F, T, and S are not permitted.
25669
25670
25671
25672 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25673          "SECID154"
25674 .cindex "rewriting" "flags"
25675 If none of the following flag letters, nor the &"S"& flag (see section
25676 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25677 and to both the sender and recipient fields of the envelope, whereas a
25678 transport-time rewriting rule just applies to all headers. Otherwise, the
25679 rewriting rule is skipped unless the relevant addresses are being processed.
25680 .display
25681 &`E`&       rewrite all envelope fields
25682 &`F`&       rewrite the envelope From field
25683 &`T`&       rewrite the envelope To field
25684 &`b`&       rewrite the &'Bcc:'& header
25685 &`c`&       rewrite the &'Cc:'& header
25686 &`f`&       rewrite the &'From:'& header
25687 &`h`&       rewrite all headers
25688 &`r`&       rewrite the &'Reply-To:'& header
25689 &`s`&       rewrite the &'Sender:'& header
25690 &`t`&       rewrite the &'To:'& header
25691 .endd
25692 "All headers" means all of the headers listed above that can be selected
25693 individually, plus their &'Resent-'& versions. It does not include
25694 other headers such as &'Subject:'& etc.
25695
25696 You should be particularly careful about rewriting &'Sender:'& headers, and
25697 restrict this to special known cases in your own domains.
25698
25699
25700 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25701 .cindex "SMTP" "rewriting malformed addresses"
25702 .cindex "RCPT" "rewriting argument of"
25703 .cindex "MAIL" "rewriting argument of"
25704 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25705 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25706 before any other processing; even before syntax checking. The pattern is
25707 required to be a regular expression, and it is matched against the whole of the
25708 data for the command, including any surrounding angle brackets.
25709
25710 .vindex "&$domain$&"
25711 .vindex "&$local_part$&"
25712 This form of rewrite rule allows for the handling of addresses that are not
25713 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25714 input). Because the input is not required to be a syntactically valid address,
25715 the variables &$local_part$& and &$domain$& are not available during the
25716 expansion of the replacement string. The result of rewriting replaces the
25717 original address in the MAIL or RCPT command.
25718
25719
25720 .section "Flags controlling the rewriting process" "SECID155"
25721 There are four flags which control the way the rewriting process works. These
25722 take effect only when a rule is invoked, that is, when the address is of the
25723 correct type (matches the flags) and matches the pattern:
25724
25725 .ilist
25726 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25727 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25728 absence of &"Q"& the rewritten address must always include a domain.
25729 .next
25730 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25731 even if no rewriting actually takes place because of a &"fail"& in the
25732 expansion. The &"q"& flag is not effective if the address is of the wrong type
25733 (does not match the flags) or does not match the pattern.
25734 .next
25735 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25736 address, up to ten times. It can be combined with the &"q"& flag, to stop
25737 rewriting once it fails to match (after at least one successful rewrite).
25738 .next
25739 .cindex "rewriting" "whole addresses"
25740 When an address in a header is rewritten, the rewriting normally applies only
25741 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25742 left unchanged. For example, rewriting might change
25743 .code
25744 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25745 .endd
25746 into
25747 .code
25748 From: Ford Prefect <prefectf@hitch.fict.example>
25749 .endd
25750 .cindex "RFC 2047"
25751 Sometimes there is a need to replace the whole address item, and this can be
25752 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25753 causes an address in a header line to be rewritten, the entire address is
25754 replaced, not just the working part. The replacement must be a complete RFC
25755 2822 address, including the angle brackets if necessary. If text outside angle
25756 brackets contains a character whose value is greater than 126 or less than 32
25757 (except for tab), the text is encoded according to RFC 2047. The character set
25758 is taken from &%headers_charset%&, which gets its default at build time.
25759
25760 When the &"w"& flag is set on a rule that causes an envelope address to be
25761 rewritten, all but the working part of the replacement address is discarded.
25762 .endlist
25763
25764
25765 .section "Rewriting examples" "SECID156"
25766 Here is an example of the two common rewriting paradigms:
25767 .code
25768 *@*.hitch.fict.example  $1@hitch.fict.example
25769 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25770                      {$value}fail}@hitch.fict.example bctfrF
25771 .endd
25772 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25773 the string expansion to fail if the lookup does not succeed. In this context it
25774 has the effect of leaving the original address unchanged, but Exim goes on to
25775 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25776 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25777 explicitly, which would cause the rewritten address to be the same as before,
25778 at the cost of a small bit of processing. Not supplying either of these is an
25779 error, since the rewritten address would then contain no local part.
25780
25781 The first example above replaces the domain with a superior, more general
25782 domain. This may not be desirable for certain local parts. If the rule
25783 .code
25784 root@*.hitch.fict.example  *
25785 .endd
25786 were inserted before the first rule, rewriting would be suppressed for the
25787 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25788
25789 Rewriting can be made conditional on a number of tests, by making use of
25790 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25791 messages that originate outside the local host:
25792 .code
25793 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25794                          {$1@hitch.fict.example}fail}"
25795 .endd
25796 The replacement string is quoted in this example because it contains white
25797 space.
25798
25799 .cindex "rewriting" "bang paths"
25800 .cindex "bang paths" "rewriting"
25801 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25802 an address it treats it as an unqualified local part which it qualifies with
25803 the local qualification domain (if the source of the message is local or if the
25804 remote host is permitted to send unqualified addresses). Rewriting can
25805 sometimes be used to handle simple bang paths with a fixed number of
25806 components. For example, the rule
25807 .code
25808 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25809 .endd
25810 rewrites a two-component bang path &'host.name!user'& as the domain address
25811 &'user@host.name'&. However, there is a security implication in using this as
25812 a global rewriting rule for envelope addresses. It can provide a backdoor
25813 method for using your system as a relay, because the incoming addresses appear
25814 to be local. If the bang path addresses are received via SMTP, it is safer to
25815 use the &"S"& flag to rewrite them as they are received, so that relay checking
25816 can be done on the rewritten addresses.
25817 .ecindex IIDaddrew
25818
25819
25820
25821
25822
25823 . ////////////////////////////////////////////////////////////////////////////
25824 . ////////////////////////////////////////////////////////////////////////////
25825
25826 .chapter "Retry configuration" "CHAPretry"
25827 .scindex IIDretconf1 "retry" "configuration, description of"
25828 .scindex IIDregconf2 "configuration file" "retry section"
25829 The &"retry"& section of the runtime configuration file contains a list of
25830 retry rules that control how often Exim tries to deliver messages that cannot
25831 be delivered at the first attempt. If there are no retry rules (the section is
25832 empty or not present), there are no retries. In this situation, temporary
25833 errors are treated as permanent. The default configuration contains a single,
25834 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25835 line option can be used to test which retry rule will be used for a given
25836 address, domain and error.
25837
25838 The most common cause of retries is temporary failure to deliver to a remote
25839 host because the host is down, or inaccessible because of a network problem.
25840 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25841 address) basis, not on a per-message basis. Thus, if one message has recently
25842 been delayed, delivery of a new message to the same host is not immediately
25843 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25844 log selector is set, the message
25845 .cindex "retry" "time not reached"
25846 &"retry time not reached"& is written to the main log whenever a delivery is
25847 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25848 the handling of errors during remote deliveries.
25849
25850 Retry processing applies to routing as well as to delivering, except as covered
25851 in the next paragraph. The retry rules do not distinguish between these
25852 actions. It is not possible, for example, to specify different behaviour for
25853 failures to route the domain &'snark.fict.example'& and failures to deliver to
25854 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25855 added complication, so did not implement it. However, although they share the
25856 same retry rule, the actual retry times for routing and transporting a given
25857 domain are maintained independently.
25858
25859 When a delivery is not part of a queue run (typically an immediate delivery on
25860 receipt of a message), the routers are always run, and local deliveries are
25861 always attempted, even if retry times are set for them. This makes for better
25862 behaviour if one particular message is causing problems (for example, causing
25863 quota overflow, or provoking an error in a filter file). If such a delivery
25864 suffers a temporary failure, the retry data is updated as normal, and
25865 subsequent delivery attempts from queue runs occur only when the retry time for
25866 the local address is reached.
25867
25868 .section "Changing retry rules" "SECID157"
25869 If you change the retry rules in your configuration, you should consider
25870 whether or not to delete the retry data that is stored in Exim's spool area in
25871 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25872 always safe; that is why they are called &"hints"&.
25873
25874 The hints retry data contains suggested retry times based on the previous
25875 rules. In the case of a long-running problem with a remote host, it might
25876 record the fact that the host has timed out. If your new rules increase the
25877 timeout time for such a host, you should definitely remove the old retry data
25878 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25879 messages that it should now be retaining.
25880
25881
25882
25883 .section "Format of retry rules" "SECID158"
25884 .cindex "retry" "rules"
25885 Each retry rule occupies one line and consists of three or four parts,
25886 separated by white space: a pattern, an error name, an optional list of sender
25887 addresses, and a list of retry parameters. The pattern and sender lists must be
25888 enclosed in double quotes if they contain white space. The rules are searched
25889 in order until one is found where the pattern, error name, and sender list (if
25890 present) match the failing host or address, the error that occurred, and the
25891 message's sender, respectively.
25892
25893
25894 The pattern is any single item that may appear in an address list (see section
25895 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25896 which means that it is expanded before being tested against the address that
25897 has been delayed. A negated address list item is permitted. Address
25898 list processing treats a plain domain name as if it were preceded by &"*@"&,
25899 which makes it possible for many retry rules to start with just a domain. For
25900 example,
25901 .code
25902 lookingglass.fict.example        *  F,24h,30m;
25903 .endd
25904 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25905 whereas
25906 .code
25907 alice@lookingglass.fict.example  *  F,24h,30m;
25908 .endd
25909 applies only to temporary failures involving the local part &%alice%&.
25910 In practice, almost all rules start with a domain name pattern without a local
25911 part.
25912
25913 .cindex "regular expressions" "in retry rules"
25914 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25915 must match a complete address, not just a domain, because that is how regular
25916 expressions work in address lists.
25917 .display
25918 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25919 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25920 .endd
25921
25922
25923 .section "Choosing which retry rule to use for address errors" "SECID159"
25924 When Exim is looking for a retry rule after a routing attempt has failed (for
25925 example, after a DNS timeout), each line in the retry configuration is tested
25926 against the complete address only if &%retry_use_local_part%& is set for the
25927 router. Otherwise, only the domain is used, except when matching against a
25928 regular expression, when the local part of the address is replaced with &"*"&.
25929 A domain on its own can match a domain pattern, or a pattern that starts with
25930 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25931 &%check_local_user%& is true, and false for other routers.
25932
25933 Similarly, when Exim is looking for a retry rule after a local delivery has
25934 failed (for example, after a mailbox full error), each line in the retry
25935 configuration is tested against the complete address only if
25936 &%retry_use_local_part%& is set for the transport (it defaults true for all
25937 local transports).
25938
25939 .cindex "4&'xx'& responses" "retry rules for"
25940 However, when Exim is looking for a retry rule after a remote delivery attempt
25941 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25942 whole address is always used as the key when searching the retry rules. The
25943 rule that is found is used to create a retry time for the combination of the
25944 failing address and the message's sender. It is the combination of sender and
25945 recipient that is delayed in subsequent queue runs until its retry time is
25946 reached. You can delay the recipient without regard to the sender by setting
25947 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25948 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25949 commands.
25950
25951
25952
25953 .section "Choosing which retry rule to use for host and message errors" &&&
25954          "SECID160"
25955 For a temporary error that is not related to an individual address (for
25956 example, a connection timeout), each line in the retry configuration is checked
25957 twice. First, the name of the remote host is used as a domain name (preceded by
25958 &"*@"& when matching a regular expression). If this does not match the line,
25959 the domain from the email address is tried in a similar fashion. For example,
25960 suppose the MX records for &'a.b.c.example'& are
25961 .code
25962 a.b.c.example  MX  5  x.y.z.example
25963                MX  6  p.q.r.example
25964                MX  7  m.n.o.example
25965 .endd
25966 and the retry rules are
25967 .code
25968 p.q.r.example    *      F,24h,30m;
25969 a.b.c.example    *      F,4d,45m;
25970 .endd
25971 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25972 first rule matches neither the host nor the domain, so Exim looks at the second
25973 rule. This does not match the host, but it does match the domain, so it is used
25974 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25975 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25976 first retry rule is used, because it matches the host.
25977
25978 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25979 first rule to determine retry times, but for all the other hosts for the domain
25980 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25981 routing to &'a.b.c.example'& suffers a temporary failure.
25982
25983 &*Note*&: The host name is used when matching the patterns, not its IP address.
25984 However, if a message is routed directly to an IP address without the use of a
25985 host name, for example, if a &(manualroute)& router contains a setting such as:
25986 .code
25987 route_list = *.a.example  192.168.34.23
25988 .endd
25989 then the &"host name"& that is used when searching for a retry rule is the
25990 textual form of the IP address.
25991
25992 .section "Retry rules for specific errors" "SECID161"
25993 .cindex "retry" "specific errors; specifying"
25994 The second field in a retry rule is the name of a particular error, or an
25995 asterisk, which matches any error. The errors that can be tested for are:
25996
25997 .vlist
25998 .vitem &%auth_failed%&
25999 Authentication failed when trying to send to a host in the
26000 &%hosts_require_auth%& list in an &(smtp)& transport.
26001
26002 .vitem &%data_4xx%&
26003 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26004 after the command, or after sending the message's data.
26005
26006 .vitem &%mail_4xx%&
26007 A 4&'xx'& error was received for an outgoing MAIL command.
26008
26009 .vitem &%rcpt_4xx%&
26010 A 4&'xx'& error was received for an outgoing RCPT command.
26011 .endlist
26012
26013 For the three 4&'xx'& errors, either the first or both of the x's can be given
26014 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26015 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26016 and have retries every ten minutes with a one-hour timeout, you could set up a
26017 retry rule of this form:
26018 .code
26019 the.domain.name  rcpt_452   F,1h,10m
26020 .endd
26021 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26022 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26023
26024 .vlist
26025 .vitem &%lost_connection%&
26026 A server unexpectedly closed the SMTP connection. There may, of course,
26027 legitimate reasons for this (host died, network died), but if it repeats a lot
26028 for the same host, it indicates something odd.
26029
26030 .vitem &%lookup%&
26031 A DNS lookup for a host failed.
26032 Note that a &%dnslookup%& router will need to have matched
26033 its &%fail_defer_domains%& option for this retry type to be usable.
26034 Also note that a &%manualroute%& router will probably need
26035 its &%host_find_failed%& option set to &%defer%&.
26036
26037 .vitem &%refused_MX%&
26038 A connection to a host obtained from an MX record was refused.
26039
26040 .vitem &%refused_A%&
26041 A connection to a host not obtained from an MX record was refused.
26042
26043 .vitem &%refused%&
26044 A connection was refused.
26045
26046 .vitem &%timeout_connect_MX%&
26047 A connection attempt to a host obtained from an MX record timed out.
26048
26049 .vitem &%timeout_connect_A%&
26050 A connection attempt to a host not obtained from an MX record timed out.
26051
26052 .vitem &%timeout_connect%&
26053 A connection attempt timed out.
26054
26055 .vitem &%timeout_MX%&
26056 There was a timeout while connecting or during an SMTP session with a host
26057 obtained from an MX record.
26058
26059 .vitem &%timeout_A%&
26060 There was a timeout while connecting or during an SMTP session with a host not
26061 obtained from an MX record.
26062
26063 .vitem &%timeout%&
26064 There was a timeout while connecting or during an SMTP session.
26065
26066 .vitem &%tls_required%&
26067 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26068 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26069 to STARTTLS, or there was a problem setting up the TLS connection.
26070
26071 .vitem &%quota%&
26072 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26073 transport.
26074
26075 .vitem &%quota_%&<&'time'&>
26076 .cindex "quota" "error testing in retry rule"
26077 .cindex "retry" "quota error testing"
26078 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26079 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26080 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26081 for four days.
26082 .endlist
26083
26084 .cindex "mailbox" "time of last read"
26085 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26086 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26087 it should be based on the last time that the user accessed the mailbox.
26088 However, it is not always possible to determine this. Exim uses the following
26089 heuristic rules:
26090
26091 .ilist
26092 If the mailbox is a single file, the time of last access (the &"atime"&) is
26093 used. As no new messages are being delivered (because the mailbox is over
26094 quota), Exim does not access the file, so this is the time of last user access.
26095 .next
26096 .cindex "maildir format" "time of last read"
26097 For a maildir delivery, the time of last modification of the &_new_&
26098 subdirectory is used. As the mailbox is over quota, no new files are created in
26099 the &_new_& subdirectory, because no new messages are being delivered. Any
26100 change to the &_new_& subdirectory is therefore assumed to be the result of an
26101 MUA moving a new message to the &_cur_& directory when it is first read. The
26102 time that is used is therefore the last time that the user read a new message.
26103 .next
26104 For other kinds of multi-file mailbox, the time of last access cannot be
26105 obtained, so a retry rule that uses this type of error field is never matched.
26106 .endlist
26107
26108 The quota errors apply both to system-enforced quotas and to Exim's own quota
26109 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26110 when a local delivery is deferred because a partition is full (the ENOSPC
26111 error).
26112
26113
26114
26115 .section "Retry rules for specified senders" "SECID162"
26116 .cindex "retry" "rules; sender-specific"
26117 You can specify retry rules that apply only when the failing message has a
26118 specific sender. In particular, this can be used to define retry rules that
26119 apply only to bounce messages. The third item in a retry rule can be of this
26120 form:
26121 .display
26122 &`senders=`&<&'address list'&>
26123 .endd
26124 The retry timings themselves are then the fourth item. For example:
26125 .code
26126 *   rcpt_4xx   senders=:   F,1h,30m
26127 .endd
26128 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26129 host. If the address list contains white space, it must be enclosed in quotes.
26130 For example:
26131 .code
26132 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26133 .endd
26134 &*Warning*&: This facility can be unhelpful if it is used for host errors
26135 (which do not depend on the recipient). The reason is that the sender is used
26136 only to match the retry rule. Once the rule has been found for a host error,
26137 its contents are used to set a retry time for the host, and this will apply to
26138 all messages, not just those with specific senders.
26139
26140 When testing retry rules using &%-brt%&, you can supply a sender using the
26141 &%-f%& command line option, like this:
26142 .code
26143 exim -f "" -brt user@dom.ain
26144 .endd
26145 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26146 list is never matched.
26147
26148
26149
26150
26151
26152 .section "Retry parameters" "SECID163"
26153 .cindex "retry" "parameters in rules"
26154 The third (or fourth, if a senders list is present) field in a retry rule is a
26155 sequence of retry parameter sets, separated by semicolons. Each set consists of
26156 .display
26157 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26158 .endd
26159 The letter identifies the algorithm for computing a new retry time; the cutoff
26160 time is the time beyond which this algorithm no longer applies, and the
26161 arguments vary the algorithm's action. The cutoff time is measured from the
26162 time that the first failure for the domain (combined with the local part if
26163 relevant) was detected, not from the time the message was received.
26164
26165 .cindex "retry" "algorithms"
26166 .cindex "retry" "fixed intervals"
26167 .cindex "retry" "increasing intervals"
26168 .cindex "retry" "random intervals"
26169 The available algorithms are:
26170
26171 .ilist
26172 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26173 the interval.
26174 .next
26175 &'G'&: retry at geometrically increasing intervals. The first argument
26176 specifies a starting value for the interval, and the second a multiplier, which
26177 is used to increase the size of the interval at each retry.
26178 .next
26179 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26180 retry, the previous interval is multiplied by the factor in order to get a
26181 maximum for the next interval. The minimum interval is the first argument of
26182 the parameter, and an actual interval is chosen randomly between them. Such a
26183 rule has been found to be helpful in cluster configurations when all the
26184 members of the cluster restart at once, and may therefore synchronize their
26185 queue processing times.
26186 .endlist
26187
26188 When computing the next retry time, the algorithm definitions are scanned in
26189 order until one whose cutoff time has not yet passed is reached. This is then
26190 used to compute a new retry time that is later than the current time. In the
26191 case of fixed interval retries, this simply means adding the interval to the
26192 current time. For geometrically increasing intervals, retry intervals are
26193 computed from the rule's parameters until one that is greater than the previous
26194 interval is found. The main configuration variable
26195 .cindex "limit" "retry interval"
26196 .cindex "retry" "interval, maximum"
26197 .oindex "&%retry_interval_max%&"
26198 &%retry_interval_max%& limits the maximum interval between retries. It
26199 cannot be set greater than &`24h`&, which is its default value.
26200
26201 A single remote domain may have a number of hosts associated with it, and each
26202 host may have more than one IP address. Retry algorithms are selected on the
26203 basis of the domain name, but are applied to each IP address independently. If,
26204 for example, a host has two IP addresses and one is unusable, Exim will
26205 generate retry times for it and will not try to use it until its next retry
26206 time comes. Thus the good IP address is likely to be tried first most of the
26207 time.
26208
26209 .cindex "hints database" "use for retrying"
26210 Retry times are hints rather than promises. Exim does not make any attempt to
26211 run deliveries exactly at the computed times. Instead, a queue runner process
26212 starts delivery processes for delayed messages periodically, and these attempt
26213 new deliveries only for those addresses that have passed their next retry time.
26214 If a new message arrives for a deferred address, an immediate delivery attempt
26215 occurs only if the address has passed its retry time. In the absence of new
26216 messages, the minimum time between retries is the interval between queue runner
26217 processes. There is not much point in setting retry times of five minutes if
26218 your queue runners happen only once an hour, unless there are a significant
26219 number of incoming messages (which might be the case on a system that is
26220 sending everything to a smart host, for example).
26221
26222 The data in the retry hints database can be inspected by using the
26223 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26224 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26225 &'exinext'& utility script can be used to find out what the next retry times
26226 are for the hosts associated with a particular mail domain, and also for local
26227 deliveries that have been deferred.
26228
26229
26230 .section "Retry rule examples" "SECID164"
26231 Here are some example retry rules:
26232 .code
26233 alice@wonderland.fict.example quota_5d  F,7d,3h
26234 wonderland.fict.example       quota_5d
26235 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26236 lookingglass.fict.example     *         F,24h,30m;
26237 *                 refused_A   F,2h,20m;
26238 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26239 .endd
26240 The first rule sets up special handling for mail to
26241 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26242 mailbox has not been read for at least 5 days. Retries continue every three
26243 hours for 7 days. The second rule handles over-quota errors for all other local
26244 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26245 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26246 fail are bounced immediately if the mailbox has not been read for at least 5
26247 days.
26248
26249 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26250 happen every 15 minutes for an hour, then with geometrically increasing
26251 intervals until two days have passed since a delivery first failed. After the
26252 first hour there is a delay of one hour, then two hours, then four hours, and
26253 so on (this is a rather extreme example).
26254
26255 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26256 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26257 all other domains, with special action for connection refusal from hosts that
26258 were not obtained from an MX record.
26259
26260 The final rule in a retry configuration should always have asterisks in the
26261 first two fields so as to provide a general catch-all for any addresses that do
26262 not have their own special handling. This example tries every 15 minutes for 2
26263 hours, then with intervals starting at one hour and increasing by a factor of
26264 1.5 up to 16 hours, then every 8 hours up to 5 days.
26265
26266
26267
26268 .section "Timeout of retry data" "SECID165"
26269 .cindex "timeout" "of retry data"
26270 .oindex "&%retry_data_expire%&"
26271 .cindex "hints database" "data expiry"
26272 .cindex "retry" "timeout of data"
26273 Exim timestamps the data that it writes to its retry hints database. When it
26274 consults the data during a delivery it ignores any that is older than the value
26275 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26276 been tried for 7 days, Exim will try to deliver to it immediately a message
26277 arrives, and if that fails, it will calculate a retry time as if it were
26278 failing for the first time.
26279
26280 This improves the behaviour for messages routed to rarely-used hosts such as MX
26281 backups. If such a host was down at one time, and happens to be down again when
26282 Exim tries a month later, using the old retry data would imply that it had been
26283 down all the time, which is not a justified assumption.
26284
26285 If a host really is permanently dead, this behaviour causes a burst of retries
26286 every now and again, but only if messages routed to it are rare. If there is a
26287 message at least once every 7 days the retry data never expires.
26288
26289
26290
26291
26292 .section "Long-term failures" "SECID166"
26293 .cindex "delivery failure, long-term"
26294 .cindex "retry" "after long-term failure"
26295 Special processing happens when an email address has been failing for so long
26296 that the cutoff time for the last algorithm is reached. For example, using the
26297 default retry rule:
26298 .code
26299 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26300 .endd
26301 the cutoff time is four days. Reaching the retry cutoff is independent of how
26302 long any specific message has been failing; it is the length of continuous
26303 failure for the recipient address that counts.
26304
26305 When the cutoff time is reached for a local delivery, or for all the IP
26306 addresses associated with a remote delivery, a subsequent delivery failure
26307 causes Exim to give up on the address, and a bounce message is generated.
26308 In order to cater for new messages that use the failing address, a next retry
26309 time is still computed from the final algorithm, and is used as follows:
26310
26311 For local deliveries, one delivery attempt is always made for any subsequent
26312 messages. If this delivery fails, the address fails immediately. The
26313 post-cutoff retry time is not used.
26314
26315 .cindex "final cutoff" "retries, controlling"
26316 .cindex retry "final cutoff"
26317 If the delivery is remote, there are two possibilities, controlled by the
26318 .oindex "&%delay_after_cutoff%&"
26319 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26320 default. Until the post-cutoff retry time for one of the IP addresses,
26321 as set by the &%retry_data_expire%& option, is
26322 reached, the failing email address is bounced immediately, without a delivery
26323 attempt taking place. After that time, one new delivery attempt is made to
26324 those IP addresses that are past their retry times, and if that still fails,
26325 the address is bounced and new retry times are computed.
26326
26327 In other words, when all the hosts for a given email address have been failing
26328 for a long time, Exim bounces rather then defers until one of the hosts' retry
26329 times is reached. Then it tries once, and bounces if that attempt fails. This
26330 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26331 to a broken destination, but if the host does recover, Exim will eventually
26332 notice.
26333
26334 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26335 addresses are past their final cutoff time, Exim tries to deliver to those IP
26336 addresses that have not been tried since the message arrived. If there are
26337 no suitable IP addresses, or if they all fail, the address is bounced. In other
26338 words, it does not delay when a new message arrives, but tries the expired
26339 addresses immediately, unless they have been tried since the message arrived.
26340 If there is a continuous stream of messages for the failing domains, setting
26341 &%delay_after_cutoff%& false means that there will be many more attempts to
26342 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26343 true.
26344
26345 .section "Deliveries that work intermittently" "SECID167"
26346 .cindex "retry" "intermittently working deliveries"
26347 Some additional logic is needed to cope with cases where a host is
26348 intermittently available, or when a message has some attribute that prevents
26349 its delivery when others to the same address get through. In this situation,
26350 because some messages are successfully delivered, the &"retry clock"& for the
26351 host or address keeps getting reset by the successful deliveries, and so
26352 failing messages remain in the queue for ever because the cutoff time is never
26353 reached.
26354
26355 Two exceptional actions are applied to prevent this happening. The first
26356 applies to errors that are related to a message rather than a remote host.
26357 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26358 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26359 commands, and quota failures. For this type of error, if a message's arrival
26360 time is earlier than the &"first failed"& time for the error, the earlier time
26361 is used when scanning the retry rules to decide when to try next and when to
26362 time out the address.
26363
26364 The exceptional second action applies in all cases. If a message has been on
26365 the queue for longer than the cutoff time of any applicable retry rule for a
26366 given address, a delivery is attempted for that address, even if it is not yet
26367 time, and if this delivery fails, the address is timed out. A new retry time is
26368 not computed in this case, so that other messages for the same address are
26369 considered immediately.
26370 .ecindex IIDretconf1
26371 .ecindex IIDregconf2
26372
26373
26374
26375
26376
26377
26378 . ////////////////////////////////////////////////////////////////////////////
26379 . ////////////////////////////////////////////////////////////////////////////
26380
26381 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26382 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26383 .scindex IIDauthconf2 "authentication"
26384 The &"authenticators"& section of Exim's runtime configuration is concerned
26385 with SMTP authentication. This facility is an extension to the SMTP protocol,
26386 described in RFC 2554, which allows a client SMTP host to authenticate itself
26387 to a server. This is a common way for a server to recognize clients that are
26388 permitted to use it as a relay. SMTP authentication is not of relevance to the
26389 transfer of mail between servers that have no managerial connection with each
26390 other.
26391
26392 .cindex "AUTH" "description of"
26393 Very briefly, the way SMTP authentication works is as follows:
26394
26395 .ilist
26396 The server advertises a number of authentication &'mechanisms'& in response to
26397 the client's EHLO command.
26398 .next
26399 The client issues an AUTH command, naming a specific mechanism. The command
26400 may, optionally, contain some authentication data.
26401 .next
26402 The server may issue one or more &'challenges'&, to which the client must send
26403 appropriate responses. In simple authentication mechanisms, the challenges are
26404 just prompts for user names and passwords. The server does not have to issue
26405 any challenges &-- in some mechanisms the relevant data may all be transmitted
26406 with the AUTH command.
26407 .next
26408 The server either accepts or denies authentication.
26409 .next
26410 If authentication succeeds, the client may optionally make use of the AUTH
26411 option on the MAIL command to pass an authenticated sender in subsequent
26412 mail transactions. Authentication lasts for the remainder of the SMTP
26413 connection.
26414 .next
26415 If authentication fails, the client may give up, or it may try a different
26416 authentication mechanism, or it may try transferring mail over the
26417 unauthenticated connection.
26418 .endlist
26419
26420 If you are setting up a client, and want to know which authentication
26421 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26422 SMTP port) on the server, and issue an EHLO command. The response to this
26423 includes the list of supported mechanisms. For example:
26424 .display
26425 &`$ `&&*&`telnet server.example 25`&*&
26426 &`Trying 192.168.34.25...`&
26427 &`Connected to server.example.`&
26428 &`Escape character is &#x0027;^]&#x0027;.`&
26429 &`220 server.example ESMTP Exim 4.20 ...`&
26430 &*&`ehlo client.example`&*&
26431 &`250-server.example Hello client.example [10.8.4.5]`&
26432 &`250-SIZE 52428800`&
26433 &`250-PIPELINING`&
26434 &`250-AUTH PLAIN`&
26435 &`250 HELP`&
26436 .endd
26437 The second-last line of this example output shows that the server supports
26438 authentication using the PLAIN mechanism. In Exim, the different authentication
26439 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26440 routers and transports, which authenticators are included in the binary is
26441 controlled by build-time definitions. The following are currently available,
26442 included by setting
26443 .code
26444 AUTH_CRAM_MD5=yes
26445 AUTH_CYRUS_SASL=yes
26446 AUTH_DOVECOT=yes
26447 AUTH_EXTERNAL=yes
26448 AUTH_GSASL=yes
26449 AUTH_HEIMDAL_GSSAPI=yes
26450 AUTH_PLAINTEXT=yes
26451 AUTH_SPA=yes
26452 AUTH_TLS=yes
26453 .endd
26454 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26455 authentication mechanism (RFC 2195), and the second provides an interface to
26456 the Cyrus SASL authentication library.
26457 The third is an interface to Dovecot's authentication system, delegating the
26458 work via a socket interface.
26459 .new
26460 The fourth provides for negotiation of authentication done via non-SMTP means,
26461 as defined by RFC 4422 Appendix A.
26462 .wen
26463 The fifth provides an interface to the GNU SASL authentication library, which
26464 provides mechanisms but typically not data sources.
26465 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26466 supporting setting a server keytab.
26467 The seventh can be configured to support
26468 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26469 not formally documented, but used by several MUAs.
26470 The eighth authenticator
26471 supports Microsoft's &'Secure Password Authentication'& mechanism.
26472 The last is an Exim authenticator but not an SMTP one;
26473 instead it can use information from a TLS negotiation.
26474
26475 The authenticators are configured using the same syntax as other drivers (see
26476 section &<<SECTfordricon>>&). If no authenticators are required, no
26477 authentication section need be present in the configuration file. Each
26478 authenticator can in principle have both server and client functions. When Exim
26479 is receiving SMTP mail, it is acting as a server; when it is sending out
26480 messages over SMTP, it is acting as a client. Authenticator configuration
26481 options are provided for use in both these circumstances.
26482
26483 To make it clear which options apply to which situation, the prefixes
26484 &%server_%& and &%client_%& are used on option names that are specific to
26485 either the server or the client function, respectively. Server and client
26486 functions are disabled if none of their options are set. If an authenticator is
26487 to be used for both server and client functions, a single definition, using
26488 both sets of options, is required. For example:
26489 .code
26490 cram:
26491   driver = cram_md5
26492   public_name = CRAM-MD5
26493   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26494   client_name = ph10
26495   client_secret = secret2
26496 .endd
26497 The &%server_%& option is used when Exim is acting as a server, and the
26498 &%client_%& options when it is acting as a client.
26499
26500 Descriptions of the individual authenticators are given in subsequent chapters.
26501 The remainder of this chapter covers the generic options for the
26502 authenticators, followed by general discussion of the way authentication works
26503 in Exim.
26504
26505 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26506 per-mechanism basis.  Please read carefully to determine which variables hold
26507 account labels such as usercodes and which hold passwords or other
26508 authenticating data.
26509
26510 Note that some mechanisms support two different identifiers for accounts: the
26511 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26512 and &'authz'& are commonly encountered.  The American spelling is standard here.
26513 Conceptually, authentication data such as passwords are tied to the identifier
26514 used to authenticate; servers may have rules to permit one user to act as a
26515 second user, so that after login the session is treated as though that second
26516 user had logged in.  That second user is the &'authorization id'&.  A robust
26517 configuration might confirm that the &'authz'& field is empty or matches the
26518 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26519 as verified data, the &'authz'& as an unverified request which the server might
26520 choose to honour.
26521
26522 A &'realm'& is a text string, typically a domain name, presented by a server
26523 to a client to help it select an account and credentials to use.  In some
26524 mechanisms, the client and server provably agree on the realm, but clients
26525 typically can not treat the realm as secure data to be blindly trusted.
26526
26527
26528
26529 .section "Generic options for authenticators" "SECID168"
26530 .cindex "authentication" "generic options"
26531 .cindex "options" "generic; for authenticators"
26532
26533 .option client_condition authenticators string&!! unset
26534 When Exim is authenticating as a client, it skips any authenticator whose
26535 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26536 used, for example, to skip plain text authenticators when the connection is not
26537 encrypted by a setting such as:
26538 .code
26539 client_condition = ${if !eq{$tls_out_cipher}{}}
26540 .endd
26541
26542
26543 .option client_set_id authenticators string&!! unset
26544 When client authentication succeeds, this condition is expanded; the
26545 result is used in the log lines for outbound messages.
26546 Typically it will be the user name used for authentication.
26547
26548
26549 .option driver authenticators string unset
26550 This option must always be set. It specifies which of the available
26551 authenticators is to be used.
26552
26553
26554 .option public_name authenticators string unset
26555 This option specifies the name of the authentication mechanism that the driver
26556 implements, and by which it is known to the outside world. These names should
26557 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26558 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26559 defaults to the driver's instance name.
26560
26561
26562 .option server_advertise_condition authenticators string&!! unset
26563 When a server is about to advertise an authentication mechanism, the condition
26564 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26565 mechanism is not advertised.
26566 If the expansion fails, the mechanism is not advertised. If the failure was not
26567 forced, and was not caused by a lookup defer, the incident is logged.
26568 See section &<<SECTauthexiser>>& below for further discussion.
26569
26570
26571 .option server_condition authenticators string&!! unset
26572 This option must be set for a &%plaintext%& server authenticator, where it
26573 is used directly to control authentication. See section &<<SECTplainserver>>&
26574 for details.
26575
26576 For the &(gsasl)& authenticator, this option is required for various
26577 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26578
26579 For the other authenticators, &%server_condition%& can be used as an additional
26580 authentication or authorization mechanism that is applied after the other
26581 authenticator conditions succeed. If it is set, it is expanded when the
26582 authenticator would otherwise return a success code. If the expansion is forced
26583 to fail, authentication fails. Any other expansion failure causes a temporary
26584 error code to be returned. If the result of a successful expansion is an empty
26585 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26586 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26587 other result, a temporary error code is returned, with the expanded string as
26588 the error text.
26589
26590
26591 .option server_debug_print authenticators string&!! unset
26592 If this option is set and authentication debugging is enabled (see the &%-d%&
26593 command line option), the string is expanded and included in the debugging
26594 output when the authenticator is run as a server. This can help with checking
26595 out the values of variables.
26596 If expansion of the string fails, the error message is written to the debugging
26597 output, and Exim carries on processing.
26598
26599
26600 .option server_set_id authenticators string&!! unset
26601 .vindex "&$authenticated_id$&"
26602 .vindex "&$authenticated_fail_id$&"
26603 When an Exim server successfully authenticates a client, this string is
26604 expanded using data from the authentication, and preserved for any incoming
26605 messages in the variable &$authenticated_id$&. It is also included in the log
26606 lines for incoming messages. For example, a user/password authenticator
26607 configuration might preserve the user name that was used to authenticate, and
26608 refer to it subsequently during delivery of the message.
26609 On a failing authentication the expansion result is instead saved in
26610 the &$authenticated_fail_id$& variable.
26611 If expansion fails, the option is ignored.
26612
26613
26614 .option server_mail_auth_condition authenticators string&!! unset
26615 This option allows a server to discard authenticated sender addresses supplied
26616 as part of MAIL commands in SMTP connections that are authenticated by the
26617 driver on which &%server_mail_auth_condition%& is set. The option is not used
26618 as part of the authentication process; instead its (unexpanded) value is
26619 remembered for later use.
26620 How it is used is described in the following section.
26621
26622
26623
26624
26625
26626 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26627 .cindex "authentication" "sender; authenticated"
26628 .cindex "AUTH" "on MAIL command"
26629 When a client supplied an AUTH= item on a MAIL command, Exim applies
26630 the following checks before accepting it as the authenticated sender of the
26631 message:
26632
26633 .ilist
26634 If the connection is not using extended SMTP (that is, HELO was used rather
26635 than EHLO), the use of AUTH= is a syntax error.
26636 .next
26637 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26638 .next
26639 .vindex "&$authenticated_sender$&"
26640 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26641 running, the value of &$authenticated_sender$& is set to the value obtained
26642 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26643 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26644 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26645 given for the MAIL command.
26646 .next
26647 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26648 is accepted and placed in &$authenticated_sender$& only if the client has
26649 authenticated.
26650 .next
26651 If the AUTH= value was accepted by either of the two previous rules, and
26652 the client has authenticated, and the authenticator has a setting for the
26653 &%server_mail_auth_condition%&, the condition is checked at this point. The
26654 valued that was saved from the authenticator is expanded. If the expansion
26655 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26656 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26657 the value of &$authenticated_sender$& is retained and passed on with the
26658 message.
26659 .endlist
26660
26661
26662 When &$authenticated_sender$& is set for a message, it is passed on to other
26663 hosts to which Exim authenticates as a client. Do not confuse this value with
26664 &$authenticated_id$&, which is a string obtained from the authentication
26665 process, and which is not usually a complete email address.
26666
26667 .vindex "&$sender_address$&"
26668 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26669 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26670 therefore make use of &$authenticated_sender$&. The converse is not true: the
26671 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26672 ACL is run.
26673
26674
26675
26676 .section "Authentication on an Exim server" "SECTauthexiser"
26677 .cindex "authentication" "on an Exim server"
26678 When Exim receives an EHLO command, it advertises the public names of those
26679 authenticators that are configured as servers, subject to the following
26680 conditions:
26681
26682 .ilist
26683 The client host must match &%auth_advertise_hosts%& (default *).
26684 .next
26685 It the &%server_advertise_condition%& option is set, its expansion must not
26686 yield the empty string, &"0"&, &"no"&, or &"false"&.
26687 .endlist
26688
26689 The order in which the authenticators are defined controls the order in which
26690 the mechanisms are advertised.
26691
26692 Some mail clients (for example, some versions of Netscape) require the user to
26693 provide a name and password for authentication whenever AUTH is advertised,
26694 even though authentication may not in fact be needed (for example, Exim may be
26695 set up to allow unconditional relaying from the client by an IP address check).
26696 You can make such clients more friendly by not advertising AUTH to them.
26697 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26698 that runs for RCPT) to relay without authentication, you should set
26699 .code
26700 auth_advertise_hosts = ! 10.9.8.0/24
26701 .endd
26702 so that no authentication mechanisms are advertised to them.
26703
26704 The &%server_advertise_condition%& controls the advertisement of individual
26705 authentication mechanisms. For example, it can be used to restrict the
26706 advertisement of a particular mechanism to encrypted connections, by a setting
26707 such as:
26708 .code
26709 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26710 .endd
26711 .vindex "&$tls_in_cipher$&"
26712 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26713 yields &"yes"&, which allows the advertisement to happen.
26714
26715 When an Exim server receives an AUTH command from a client, it rejects it
26716 immediately if AUTH was not advertised in response to an earlier EHLO
26717 command. This is the case if
26718
26719 .ilist
26720 The client host does not match &%auth_advertise_hosts%&; or
26721 .next
26722 No authenticators are configured with server options; or
26723 .next
26724 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26725 server authenticators.
26726 .endlist
26727
26728
26729 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26730 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26731 AUTH is accepted from any client host.
26732
26733 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26734 server authentication mechanism that was advertised in response to EHLO and
26735 that matches the one named in the AUTH command. If it finds one, it runs
26736 the appropriate authentication protocol, and authentication either succeeds or
26737 fails. If there is no matching advertised mechanism, the AUTH command is
26738 rejected with a 504 error.
26739
26740 .vindex "&$received_protocol$&"
26741 .vindex "&$sender_host_authenticated$&"
26742 When a message is received from an authenticated host, the value of
26743 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26744 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26745 public name) of the authenticator driver that successfully authenticated the
26746 client from which the message was received. This variable is empty if there was
26747 no successful authentication.
26748
26749 .cindex authentication "expansion item"
26750 Successful authentication sets up information used by the
26751 &%authresults%& expansion item.
26752
26753
26754
26755
26756 .section "Testing server authentication" "SECID169"
26757 .cindex "authentication" "testing a server"
26758 .cindex "AUTH" "testing a server"
26759 .cindex "base64 encoding" "creating authentication test data"
26760 Exim's &%-bh%& option can be useful for testing server authentication
26761 configurations. The data for the AUTH command has to be sent using base64
26762 encoding. A quick way to produce such data for testing is the following Perl
26763 script:
26764 .code
26765 use MIME::Base64;
26766 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26767 .endd
26768 .cindex "binary zero" "in authentication data"
26769 This interprets its argument as a Perl string, and then encodes it. The
26770 interpretation as a Perl string allows binary zeros, which are required for
26771 some kinds of authentication, to be included in the data. For example, a
26772 command line to run this script on such data might be
26773 .code
26774 encode '\0user\0password'
26775 .endd
26776 Note the use of single quotes to prevent the shell interpreting the
26777 backslashes, so that they can be interpreted by Perl to specify characters
26778 whose code value is zero.
26779
26780 &*Warning 1*&: If either of the user or password strings starts with an octal
26781 digit, you must use three zeros instead of one after the leading backslash. If
26782 you do not, the octal digit that starts your string will be incorrectly
26783 interpreted as part of the code for the first character.
26784
26785 &*Warning 2*&: If there are characters in the strings that Perl interprets
26786 specially, you must use a Perl escape to prevent them being misinterpreted. For
26787 example, a command such as
26788 .code
26789 encode '\0user@domain.com\0pas$$word'
26790 .endd
26791 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26792
26793 If you have the &%mimencode%& command installed, another way to do produce
26794 base64-encoded strings is to run the command
26795 .code
26796 echo -e -n `\0user\0password' | mimencode
26797 .endd
26798 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26799 in the argument, and the &%-n%& option specifies no newline at the end of its
26800 output. However, not all versions of &%echo%& recognize these options, so you
26801 should check your version before relying on this suggestion.
26802
26803
26804
26805 .section "Authentication by an Exim client" "SECID170"
26806 .cindex "authentication" "on an Exim client"
26807 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26808 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26809 announces support for authentication, and the host matches an entry in either
26810 of these options, Exim (as a client) tries to authenticate as follows:
26811
26812 .ilist
26813 For each authenticator that is configured as a client, in the order in which
26814 they are defined in the configuration, it searches the authentication
26815 mechanisms announced by the server for one whose name matches the public name
26816 of the authenticator.
26817 .next
26818 .vindex "&$host$&"
26819 .vindex "&$host_address$&"
26820 When it finds one that matches, it runs the authenticator's client code. The
26821 variables &$host$& and &$host_address$& are available for any string expansions
26822 that the client might do. They are set to the server's name and IP address. If
26823 any expansion is forced to fail, the authentication attempt is abandoned, and
26824 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26825 delivery to be deferred.
26826 .next
26827 If the result of the authentication attempt is a temporary error or a timeout,
26828 Exim abandons trying to send the message to the host for the moment. It will
26829 try again later. If there are any backup hosts available, they are tried in the
26830 usual way.
26831 .next
26832 If the response to authentication is a permanent error (5&'xx'& code), Exim
26833 carries on searching the list of authenticators and tries another one if
26834 possible. If all authentication attempts give permanent errors, or if there are
26835 no attempts because no mechanisms match (or option expansions force failure),
26836 what happens depends on whether the host matches &%hosts_require_auth%& or
26837 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26838 delivery is deferred. The error can be detected in the retry rules, and thereby
26839 turned into a permanent error if you wish. In the second case, Exim tries to
26840 deliver the message unauthenticated.
26841 .endlist
26842
26843 Note that the hostlist test for whether to do authentication can be
26844 confused if name-IP lookups change between the time the peer is decided
26845 upon and the time that the transport runs.  For example, with a manualroute
26846 router given a host name, and with DNS "round-robin" used by that name: if
26847 the local resolver cache times out between the router and the transport
26848 running, the transport may get an IP for the name for its authentication
26849 check which does not match the connection peer IP.
26850 No authentication will then be done, despite the names being identical.
26851
26852 For such cases use a separate transport which always authenticates.
26853
26854 .cindex "AUTH" "on MAIL command"
26855 When Exim has authenticated itself to a remote server, it adds the AUTH
26856 parameter to the MAIL commands it sends, if it has an authenticated sender for
26857 the message. If the message came from a remote host, the authenticated sender
26858 is the one that was receiving on an incoming MAIL command, provided that the
26859 incoming connection was authenticated and the &%server_mail_auth%& condition
26860 allowed the authenticated sender to be retained. If a local process calls Exim
26861 to send a message, the sender address that is built from the login name and
26862 &%qualify_domain%& is treated as authenticated. However, if the
26863 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26864 the authenticated sender that was received with the message.
26865 .ecindex IIDauthconf1
26866 .ecindex IIDauthconf2
26867
26868
26869
26870
26871
26872
26873 . ////////////////////////////////////////////////////////////////////////////
26874 . ////////////////////////////////////////////////////////////////////////////
26875
26876 .chapter "The plaintext authenticator" "CHAPplaintext"
26877 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26878 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26879 The &(plaintext)& authenticator can be configured to support the PLAIN and
26880 LOGIN authentication mechanisms, both of which transfer authentication data as
26881 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26882 security risk; you are strongly advised to insist on the use of SMTP encryption
26883 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26884 use unencrypted plain text, you should not use the same passwords for SMTP
26885 connections as you do for login accounts.
26886
26887 .section "Plaintext options" "SECID171"
26888 .cindex "options" "&(plaintext)& authenticator (server)"
26889 When configured as a server, &(plaintext)& uses the following options:
26890
26891 .option server_condition authenticators string&!! unset
26892 This is actually a global authentication option, but it must be set in order to
26893 configure the &(plaintext)& driver as a server. Its use is described below.
26894
26895 .option server_prompts plaintext string&!! unset
26896 The contents of this option, after expansion, must be a colon-separated list of
26897 prompt strings. If expansion fails, a temporary authentication rejection is
26898 given.
26899
26900 .section "Using plaintext in a server" "SECTplainserver"
26901 .cindex "AUTH" "in &(plaintext)& authenticator"
26902 .cindex "binary zero" "in &(plaintext)& authenticator"
26903 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26904         "in &(plaintext)& authenticator"
26905 .vindex "&$auth1$&, &$auth2$&, etc"
26906 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26907
26908 When running as a server, &(plaintext)& performs the authentication test by
26909 expanding a string. The data sent by the client with the AUTH command, or in
26910 response to subsequent prompts, is base64 encoded, and so may contain any byte
26911 values when decoded. If any data is supplied with the command, it is treated as
26912 a list of strings, separated by NULs (binary zeros), the first three of which
26913 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26914 (neither LOGIN nor PLAIN uses more than three strings).
26915
26916 For compatibility with previous releases of Exim, the values are also placed in
26917 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26918 variables for this purpose is now deprecated, as it can lead to confusion in
26919 string expansions that also use them for other things.
26920
26921 If there are more strings in &%server_prompts%& than the number of strings
26922 supplied with the AUTH command, the remaining prompts are used to obtain more
26923 data. Each response from the client may be a list of NUL-separated strings.
26924
26925 .vindex "&$authenticated_id$&"
26926 Once a sufficient number of data strings have been received,
26927 &%server_condition%& is expanded. If the expansion is forced to fail,
26928 authentication fails. Any other expansion failure causes a temporary error code
26929 to be returned. If the result of a successful expansion is an empty string,
26930 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26931 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26932 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26933 For any other result, a temporary error code is returned, with the expanded
26934 string as the error text.
26935
26936 &*Warning*&: If you use a lookup in the expansion to find the user's
26937 password, be sure to make the authentication fail if the user is unknown.
26938 There are good and bad examples at the end of the next section.
26939
26940
26941
26942 .section "The PLAIN authentication mechanism" "SECID172"
26943 .cindex "PLAIN authentication mechanism"
26944 .cindex "authentication" "PLAIN mechanism"
26945 .cindex "binary zero" "in &(plaintext)& authenticator"
26946 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26947 sent as one item of data (that is, one combined string containing two NUL
26948 separators). The data is sent either as part of the AUTH command, or
26949 subsequently in response to an empty prompt from the server.
26950
26951 The second and third strings are a user name and a corresponding password.
26952 Using a single fixed user name and password as an example, this could be
26953 configured as follows:
26954 .code
26955 fixed_plain:
26956   driver = plaintext
26957   public_name = PLAIN
26958   server_prompts = :
26959   server_condition = \
26960     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26961   server_set_id = $auth2
26962 .endd
26963 Note that the default result strings from &%if%& (&"true"& or an empty string)
26964 are exactly what we want here, so they need not be specified. Obviously, if the
26965 password contains expansion-significant characters such as dollar, backslash,
26966 or closing brace, they have to be escaped.
26967
26968 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26969 the end of a string list are ignored). If all the data comes as part of the
26970 AUTH command, as is commonly the case, the prompt is not used. This
26971 authenticator is advertised in the response to EHLO as
26972 .code
26973 250-AUTH PLAIN
26974 .endd
26975 and a client host can authenticate itself by sending the command
26976 .code
26977 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26978 .endd
26979 As this contains three strings (more than the number of prompts), no further
26980 data is required from the client. Alternatively, the client may just send
26981 .code
26982 AUTH PLAIN
26983 .endd
26984 to initiate authentication, in which case the server replies with an empty
26985 prompt. The client must respond with the combined data string.
26986
26987 The data string is base64 encoded, as required by the RFC. This example,
26988 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26989 represents a zero byte. This is split up into three strings, the first of which
26990 is empty. The &%server_condition%& option in the authenticator checks that the
26991 second two are &`username`& and &`mysecret`& respectively.
26992
26993 Having just one fixed user name and password, as in this example, is not very
26994 realistic, though for a small organization with only a handful of
26995 authenticating clients it could make sense.
26996
26997 A more sophisticated instance of this authenticator could use the user name in
26998 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26999 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27000 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27001 This is an incorrect example:
27002 .code
27003 server_condition = \
27004   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27005 .endd
27006 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27007 which it then compares to the supplied password (&$auth3$&). Why is this example
27008 incorrect? It works fine for existing users, but consider what happens if a
27009 non-existent user name is given. The lookup fails, but as no success/failure
27010 strings are given for the lookup, it yields an empty string. Thus, to defeat
27011 the authentication, all a client has to do is to supply a non-existent user
27012 name and an empty password. The correct way of writing this test is:
27013 .code
27014 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27015   {${if eq{$value}{$auth3}}} {false}}
27016 .endd
27017 In this case, if the lookup succeeds, the result is checked; if the lookup
27018 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27019 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27020 always fails if its second argument is empty. However, the second way of
27021 writing the test makes the logic clearer.
27022
27023
27024 .section "The LOGIN authentication mechanism" "SECID173"
27025 .cindex "LOGIN authentication mechanism"
27026 .cindex "authentication" "LOGIN mechanism"
27027 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27028 in a number of programs. No data is sent with the AUTH command. Instead, a
27029 user name and password are supplied separately, in response to prompts. The
27030 plaintext authenticator can be configured to support this as in this example:
27031 .code
27032 fixed_login:
27033   driver = plaintext
27034   public_name = LOGIN
27035   server_prompts = User Name : Password
27036   server_condition = \
27037     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27038   server_set_id = $auth1
27039 .endd
27040 Because of the way plaintext operates, this authenticator accepts data supplied
27041 with the AUTH command (in contravention of the specification of LOGIN), but
27042 if the client does not supply it (as is the case for LOGIN clients), the prompt
27043 strings are used to obtain two data items.
27044
27045 Some clients are very particular about the precise text of the prompts. For
27046 example, Outlook Express is reported to recognize only &"Username:"& and
27047 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27048 strings. It uses the &%ldapauth%& expansion condition to check the user
27049 name and password by binding to an LDAP server:
27050 .code
27051 login:
27052   driver = plaintext
27053   public_name = LOGIN
27054   server_prompts = Username:: : Password::
27055   server_condition = ${if and{{ \
27056     !eq{}{$auth1} }{ \
27057     ldapauth{\
27058       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27059       pass=${quote:$auth2} \
27060       ldap://ldap.example.org/} }} }
27061   server_set_id = uid=$auth1,ou=people,o=example.org
27062 .endd
27063 We have to check that the username is not empty before using it, because LDAP
27064 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27065 operator to correctly quote the DN for authentication. However, the basic
27066 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27067 correct one to use for the password, because quoting is needed only to make
27068 the password conform to the Exim syntax. At the LDAP level, the password is an
27069 uninterpreted string.
27070
27071
27072 .section "Support for different kinds of authentication" "SECID174"
27073 A number of string expansion features are provided for the purpose of
27074 interfacing to different ways of user authentication. These include checking
27075 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27076 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27077 &<<SECTexpcond>>&.
27078
27079
27080
27081
27082 .section "Using plaintext in a client" "SECID175"
27083 .cindex "options" "&(plaintext)& authenticator (client)"
27084 The &(plaintext)& authenticator has two client options:
27085
27086 .option client_ignore_invalid_base64 plaintext boolean false
27087 If the client receives a server prompt that is not a valid base64 string,
27088 authentication is abandoned by default. However, if this option is set true,
27089 the error in the challenge is ignored and the client sends the response as
27090 usual.
27091
27092 .option client_send plaintext string&!! unset
27093 The string is a colon-separated list of authentication data strings. Each
27094 string is independently expanded before being sent to the server. The first
27095 string is sent with the AUTH command; any more strings are sent in response
27096 to prompts from the server. Before each string is expanded, the value of the
27097 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27098 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27099 way. Thus, the prompt that is received in response to sending the first string
27100 (with the AUTH command) can be used in the expansion of the second string, and
27101 so on. If an invalid base64 string is received when
27102 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27103 &$auth$&<&'n'&> variable.
27104
27105 &*Note*&: You cannot use expansion to create multiple strings, because
27106 splitting takes priority and happens first.
27107
27108 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27109 the data, further processing is applied to each string before it is sent. If
27110 there are any single circumflex characters in the string, they are converted to
27111 NULs. Should an actual circumflex be required as data, it must be doubled in
27112 the string.
27113
27114 This is an example of a client configuration that implements the PLAIN
27115 authentication mechanism with a fixed user name and password:
27116 .code
27117 fixed_plain:
27118   driver = plaintext
27119   public_name = PLAIN
27120   client_send = ^username^mysecret
27121 .endd
27122 The lack of colons means that the entire text is sent with the AUTH
27123 command, with the circumflex characters converted to NULs. A similar example
27124 that uses the LOGIN mechanism is:
27125 .code
27126 fixed_login:
27127   driver = plaintext
27128   public_name = LOGIN
27129   client_send = : username : mysecret
27130 .endd
27131 The initial colon means that the first string is empty, so no data is sent with
27132 the AUTH command itself. The remaining strings are sent in response to
27133 prompts.
27134 .ecindex IIDplaiauth1
27135 .ecindex IIDplaiauth2
27136
27137
27138
27139
27140 . ////////////////////////////////////////////////////////////////////////////
27141 . ////////////////////////////////////////////////////////////////////////////
27142
27143 .chapter "The cram_md5 authenticator" "CHID9"
27144 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27145 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27146 .cindex "CRAM-MD5 authentication mechanism"
27147 .cindex "authentication" "CRAM-MD5 mechanism"
27148 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27149 sends a challenge string to the client, and the response consists of a user
27150 name and the CRAM-MD5 digest of the challenge string combined with a secret
27151 string (password) which is known to both server and client. Thus, the secret
27152 is not sent over the network as plain text, which makes this authenticator more
27153 secure than &(plaintext)&. However, the downside is that the secret has to be
27154 available in plain text at either end.
27155
27156
27157 .section "Using cram_md5 as a server" "SECID176"
27158 .cindex "options" "&(cram_md5)& authenticator (server)"
27159 This authenticator has one server option, which must be set to configure the
27160 authenticator as a server:
27161
27162 .option server_secret cram_md5 string&!! unset
27163 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27164 When the server receives the client's response, the user name is placed in
27165 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27166 obtain the password for that user. The server then computes the CRAM-MD5 digest
27167 that the client should have sent, and checks that it received the correct
27168 string. If the expansion of &%server_secret%& is forced to fail, authentication
27169 fails. If the expansion fails for some other reason, a temporary error code is
27170 returned to the client.
27171
27172 For compatibility with previous releases of Exim, the user name is also placed
27173 in &$1$&. However, the use of this variables for this purpose is now
27174 deprecated, as it can lead to confusion in string expansions that also use
27175 numeric variables for other things.
27176
27177 For example, the following authenticator checks that the user name given by the
27178 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27179 user name, authentication fails.
27180 .code
27181 fixed_cram:
27182   driver = cram_md5
27183   public_name = CRAM-MD5
27184   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27185   server_set_id = $auth1
27186 .endd
27187 .vindex "&$authenticated_id$&"
27188 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27189 name in &$authenticated_id$&. A more typical configuration might look up the
27190 secret string in a file, using the user name as the key. For example:
27191 .code
27192 lookup_cram:
27193   driver = cram_md5
27194   public_name = CRAM-MD5
27195   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27196                   {$value}fail}
27197   server_set_id = $auth1
27198 .endd
27199 Note that this expansion explicitly forces failure if the lookup fails
27200 because &$auth1$& contains an unknown user name.
27201
27202 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27203 using the relevant libraries, you need to know the realm to specify in the
27204 lookup and then ask for the &"userPassword"& attribute for that user in that
27205 realm, with:
27206 .code
27207 cyrusless_crammd5:
27208   driver = cram_md5
27209   public_name = CRAM-MD5
27210   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27211                   dbmjz{/etc/sasldb2}{$value}fail}
27212   server_set_id = $auth1
27213 .endd
27214
27215 .section "Using cram_md5 as a client" "SECID177"
27216 .cindex "options" "&(cram_md5)& authenticator (client)"
27217 When used as a client, the &(cram_md5)& authenticator has two options:
27218
27219
27220
27221 .option client_name cram_md5 string&!! "the primary host name"
27222 This string is expanded, and the result used as the user name data when
27223 computing the response to the server's challenge.
27224
27225
27226 .option client_secret cram_md5 string&!! unset
27227 This option must be set for the authenticator to work as a client. Its value is
27228 expanded and the result used as the secret string when computing the response.
27229
27230
27231 .vindex "&$host$&"
27232 .vindex "&$host_address$&"
27233 Different user names and secrets can be used for different servers by referring
27234 to &$host$& or &$host_address$& in the options. Forced failure of either
27235 expansion string is treated as an indication that this authenticator is not
27236 prepared to handle this case. Exim moves on to the next configured client
27237 authenticator. Any other expansion failure causes Exim to give up trying to
27238 send the message to the current server.
27239
27240 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27241 strings, is:
27242 .code
27243 fixed_cram:
27244   driver = cram_md5
27245   public_name = CRAM-MD5
27246   client_name = ph10
27247   client_secret = secret
27248 .endd
27249 .ecindex IIDcramauth1
27250 .ecindex IIDcramauth2
27251
27252
27253
27254 . ////////////////////////////////////////////////////////////////////////////
27255 . ////////////////////////////////////////////////////////////////////////////
27256
27257 .chapter "The cyrus_sasl authenticator" "CHID10"
27258 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27259 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27260 .cindex "Cyrus" "SASL library"
27261 .cindex "Kerberos"
27262 The code for this authenticator was provided by Matthew Byng-Maddick while
27263 at A L Digital Ltd.
27264
27265 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27266 library implementation of the RFC 2222 (&"Simple Authentication and Security
27267 Layer"&). This library supports a number of authentication mechanisms,
27268 including PLAIN and LOGIN, but also several others that Exim does not support
27269 directly. In particular, there is support for Kerberos authentication.
27270
27271 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27272 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27273 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27274 name of the driver to determine which mechanism to support.
27275
27276 Where access to some kind of secret file is required, for example, in GSSAPI
27277 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27278 user, and that the Cyrus SASL library has no way of escalating privileges
27279 by default. You may also find you need to set environment variables,
27280 depending on the driver you are using.
27281
27282 The application name provided by Exim is &"exim"&, so various SASL options may
27283 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27284 Kerberos, note that because of limitations in the GSSAPI interface,
27285 changing the server keytab might need to be communicated down to the Kerberos
27286 layer independently. The mechanism for doing so is dependent upon the Kerberos
27287 implementation.
27288
27289 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27290 may be set to point to an alternative keytab file. Exim will pass this
27291 variable through from its own inherited environment when started as root or the
27292 Exim user. The keytab file needs to be readable by the Exim user.
27293 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27294 environment variable.  In practice, for those releases, the Cyrus authenticator
27295 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27296 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27297
27298
27299 .section "Using cyrus_sasl as a server" "SECID178"
27300 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27301 (on a successful authentication) into &$auth1$&. For compatibility with
27302 previous releases of Exim, the username is also placed in &$1$&. However, the
27303 use of this variable for this purpose is now deprecated, as it can lead to
27304 confusion in string expansions that also use numeric variables for other
27305 things.
27306
27307
27308 .option server_hostname cyrus_sasl string&!! "see below"
27309 This option selects the hostname that is used when communicating with the
27310 library. The default value is &`$primary_hostname`&. It is up to the underlying
27311 SASL plug-in what it does with this data.
27312
27313
27314 .option server_mech cyrus_sasl string "see below"
27315 This option selects the authentication mechanism this driver should use. The
27316 default is the value of the generic &%public_name%& option. This option allows
27317 you to use a different underlying mechanism from the advertised name. For
27318 example:
27319 .code
27320 sasl:
27321   driver = cyrus_sasl
27322   public_name = X-ANYTHING
27323   server_mech = CRAM-MD5
27324   server_set_id = $auth1
27325 .endd
27326
27327 .option server_realm cyrus_sasl string&!! unset
27328 This specifies the SASL realm that the server claims to be in.
27329
27330
27331 .option server_service cyrus_sasl string &`smtp`&
27332 This is the SASL service that the server claims to implement.
27333
27334
27335 For straightforward cases, you do not need to set any of the authenticator's
27336 private options. All you need to do is to specify an appropriate mechanism as
27337 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27338 PLAIN, you could have two authenticators as follows:
27339 .code
27340 sasl_cram_md5:
27341   driver = cyrus_sasl
27342   public_name = CRAM-MD5
27343   server_set_id = $auth1
27344
27345 sasl_plain:
27346   driver = cyrus_sasl
27347   public_name = PLAIN
27348   server_set_id = $auth2
27349 .endd
27350 Cyrus SASL does implement the LOGIN authentication method, even though it is
27351 not a standard method. It is disabled by default in the source distribution,
27352 but it is present in many binary distributions.
27353 .ecindex IIDcyrauth1
27354 .ecindex IIDcyrauth2
27355
27356
27357
27358
27359 . ////////////////////////////////////////////////////////////////////////////
27360 . ////////////////////////////////////////////////////////////////////////////
27361 .chapter "The dovecot authenticator" "CHAPdovecot"
27362 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27363 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27364 This authenticator is an interface to the authentication facility of the
27365 Dovecot POP/IMAP server, which can support a number of authentication methods.
27366 Note that Dovecot must be configured to use auth-client not auth-userdb.
27367 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27368 to use the same mechanisms for SMTP authentication. This is a server
27369 authenticator only. There is only one option:
27370
27371 .option server_socket dovecot string unset
27372
27373 This option must specify the UNIX socket that is the interface to Dovecot
27374 authentication. The &%public_name%& option must specify an authentication
27375 mechanism that Dovecot is configured to support. You can have several
27376 authenticators for different mechanisms. For example:
27377 .code
27378 dovecot_plain:
27379   driver = dovecot
27380   public_name = PLAIN
27381   server_socket = /var/run/dovecot/auth-client
27382   server_set_id = $auth1
27383
27384 dovecot_ntlm:
27385   driver = dovecot
27386   public_name = NTLM
27387   server_socket = /var/run/dovecot/auth-client
27388   server_set_id = $auth1
27389 .endd
27390 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27391 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27392 option is passed in the Dovecot authentication command. If, for a TLS
27393 connection, a client certificate has been verified, the &"valid-client-cert"&
27394 option is passed. When authentication succeeds, the identity of the user
27395 who authenticated is placed in &$auth1$&.
27396 .ecindex IIDdcotauth1
27397 .ecindex IIDdcotauth2
27398
27399
27400 . ////////////////////////////////////////////////////////////////////////////
27401 . ////////////////////////////////////////////////////////////////////////////
27402 .chapter "The gsasl authenticator" "CHAPgsasl"
27403 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27404 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27405 .cindex "authentication" "GNU SASL"
27406 .cindex "authentication" "SASL"
27407 .cindex "authentication" "EXTERNAL"
27408 .cindex "authentication" "ANONYMOUS"
27409 .cindex "authentication" "PLAIN"
27410 .cindex "authentication" "LOGIN"
27411 .cindex "authentication" "DIGEST-MD5"
27412 .cindex "authentication" "CRAM-MD5"
27413 .cindex "authentication" "SCRAM-SHA-1"
27414 The &(gsasl)& authenticator provides server integration for the GNU SASL
27415 library and the mechanisms it provides.  This is new as of the 4.80 release
27416 and there are a few areas where the library does not let Exim smoothly
27417 scale to handle future authentication mechanisms, so no guarantee can be
27418 made that any particular new authentication mechanism will be supported
27419 without code changes in Exim.
27420
27421 Exim's &(gsasl)& authenticator does not have client-side support at this
27422 time; only the server-side support is implemented.  Patches welcome.
27423
27424
27425 .option server_channelbinding gsasl boolean false
27426 Do not set this true without consulting a cryptographic engineer.
27427
27428 Some authentication mechanisms are able to use external context at both ends
27429 of the session to bind the authentication to that context, and fail the
27430 authentication process if that context differs.  Specifically, some TLS
27431 ciphersuites can provide identifying information about the cryptographic
27432 context.
27433
27434 This should have meant that certificate identity and verification becomes a
27435 non-issue, as a man-in-the-middle attack will cause the correct client and
27436 server to see different identifiers and authentication will fail.
27437
27438 This is currently only supported when using the GnuTLS library.  This is
27439 only usable by mechanisms which support "channel binding"; at time of
27440 writing, that's the SCRAM family.
27441
27442 This defaults off to ensure smooth upgrade across Exim releases, in case
27443 this option causes some clients to start failing.  Some future release
27444 of Exim might have switched the default to be true.
27445
27446 However, Channel Binding in TLS has proven to be broken in current versions.
27447 Do not plan to rely upon this feature for security, ever, without consulting
27448 with a subject matter expert (a cryptographic engineer).
27449
27450
27451 .option server_hostname gsasl string&!! "see below"
27452 This option selects the hostname that is used when communicating with the
27453 library. The default value is &`$primary_hostname`&.
27454 Some mechanisms will use this data.
27455
27456
27457 .option server_mech gsasl string "see below"
27458 This option selects the authentication mechanism this driver should use. The
27459 default is the value of the generic &%public_name%& option. This option allows
27460 you to use a different underlying mechanism from the advertised name. For
27461 example:
27462 .code
27463 sasl:
27464   driver = gsasl
27465   public_name = X-ANYTHING
27466   server_mech = CRAM-MD5
27467   server_set_id = $auth1
27468 .endd
27469
27470
27471 .option server_password gsasl string&!! unset
27472 Various mechanisms need access to the cleartext password on the server, so
27473 that proof-of-possession can be demonstrated on the wire, without sending
27474 the password itself.
27475
27476 The data available for lookup varies per mechanism.
27477 In all cases, &$auth1$& is set to the &'authentication id'&.
27478 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27479 if available, else the empty string.
27480 The &$auth3$& variable will always be the &'realm'& if available,
27481 else the empty string.
27482
27483 A forced failure will cause authentication to defer.
27484
27485 If using this option, it may make sense to set the &%server_condition%&
27486 option to be simply "true".
27487
27488
27489 .option server_realm gsasl string&!! unset
27490 This specifies the SASL realm that the server claims to be in.
27491 Some mechanisms will use this data.
27492
27493
27494 .option server_scram_iter gsasl string&!! unset
27495 This option provides data for the SCRAM family of mechanisms.
27496 &$auth1$& is not available at evaluation time.
27497 (This may change, as we receive feedback on use)
27498
27499
27500 .option server_scram_salt gsasl string&!! unset
27501 This option provides data for the SCRAM family of mechanisms.
27502 &$auth1$& is not available at evaluation time.
27503 (This may change, as we receive feedback on use)
27504
27505
27506 .option server_service gsasl string &`smtp`&
27507 This is the SASL service that the server claims to implement.
27508 Some mechanisms will use this data.
27509
27510
27511 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27512 .vindex "&$auth1$&, &$auth2$&, etc"
27513 These may be set when evaluating specific options, as detailed above.
27514 They will also be set when evaluating &%server_condition%&.
27515
27516 Unless otherwise stated below, the &(gsasl)& integration will use the following
27517 meanings for these variables:
27518
27519 .ilist
27520 .vindex "&$auth1$&"
27521 &$auth1$&: the &'authentication id'&
27522 .next
27523 .vindex "&$auth2$&"
27524 &$auth2$&: the &'authorization id'&
27525 .next
27526 .vindex "&$auth3$&"
27527 &$auth3$&: the &'realm'&
27528 .endlist
27529
27530 On a per-mechanism basis:
27531
27532 .ilist
27533 .cindex "authentication" "EXTERNAL"
27534 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27535 the &%server_condition%& option must be present.
27536 .next
27537 .cindex "authentication" "ANONYMOUS"
27538 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27539 the &%server_condition%& option must be present.
27540 .next
27541 .cindex "authentication" "GSSAPI"
27542 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27543 &$auth2$& will be set to the &'authorization id'&,
27544 the &%server_condition%& option must be present.
27545 .endlist
27546
27547 An &'anonymous token'& is something passed along as an unauthenticated
27548 identifier; this is analogous to FTP anonymous authentication passing an
27549 email address, or software-identifier@, as the "password".
27550
27551
27552 An example showing the password having the realm specified in the callback
27553 and demonstrating a Cyrus SASL to GSASL migration approach is:
27554 .code
27555 gsasl_cyrusless_crammd5:
27556   driver = gsasl
27557   public_name = CRAM-MD5
27558   server_realm = imap.example.org
27559   server_password = ${lookup{$auth1:$auth3:userPassword}\
27560                     dbmjz{/etc/sasldb2}{$value}fail}
27561   server_set_id = ${quote:$auth1}
27562   server_condition = yes
27563 .endd
27564
27565
27566 . ////////////////////////////////////////////////////////////////////////////
27567 . ////////////////////////////////////////////////////////////////////////////
27568
27569 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27570 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27571 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27572 .cindex "authentication" "GSSAPI"
27573 .cindex "authentication" "Kerberos"
27574 The &(heimdal_gssapi)& authenticator provides server integration for the
27575 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27576 reliably.
27577
27578 .option server_hostname heimdal_gssapi string&!! "see below"
27579 This option selects the hostname that is used, with &%server_service%&,
27580 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27581 identifier.  The default value is &`$primary_hostname`&.
27582
27583 .option server_keytab heimdal_gssapi string&!! unset
27584 If set, then Heimdal will not use the system default keytab (typically
27585 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27586 The value should be a pathname, with no &"file:"& prefix.
27587
27588 .option server_service heimdal_gssapi string&!! "smtp"
27589 This option specifies the service identifier used, in conjunction with
27590 &%server_hostname%&, for building the identifier for finding credentials
27591 from the keytab.
27592
27593
27594 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27595 Beware that these variables will typically include a realm, thus will appear
27596 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27597 not verified, so a malicious client can set it to anything.
27598
27599 The &$auth1$& field should be safely trustable as a value from the Key
27600 Distribution Center.  Note that these are not quite email addresses.
27601 Each identifier is for a role, and so the left-hand-side may include a
27602 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27603
27604 .vindex "&$auth1$&, &$auth2$&, etc"
27605 .ilist
27606 .vindex "&$auth1$&"
27607 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27608 .next
27609 .vindex "&$auth2$&"
27610 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27611 authentication.  If that was empty, this will also be set to the
27612 GSS Display Name.
27613 .endlist
27614
27615
27616 . ////////////////////////////////////////////////////////////////////////////
27617 . ////////////////////////////////////////////////////////////////////////////
27618
27619 .chapter "The spa authenticator" "CHAPspa"
27620 .scindex IIDspaauth1 "&(spa)& authenticator"
27621 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27622 .cindex "authentication" "Microsoft Secure Password"
27623 .cindex "authentication" "NTLM"
27624 .cindex "Microsoft Secure Password Authentication"
27625 .cindex "NTLM authentication"
27626 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27627 Password Authentication'& mechanism,
27628 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27629 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27630 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27631 server side was subsequently contributed by Tom Kistner. The mechanism works as
27632 follows:
27633
27634 .ilist
27635 After the AUTH command has been accepted, the client sends an SPA
27636 authentication request based on the user name and optional domain.
27637 .next
27638 The server sends back a challenge.
27639 .next
27640 The client builds a challenge response which makes use of the user's password
27641 and sends it to the server, which then accepts or rejects it.
27642 .endlist
27643
27644 Encryption is used to protect the password in transit.
27645
27646
27647
27648 .section "Using spa as a server" "SECID179"
27649 .cindex "options" "&(spa)& authenticator (server)"
27650 The &(spa)& authenticator has just one server option:
27651
27652 .option server_password spa string&!! unset
27653 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27654 This option is expanded, and the result must be the cleartext password for the
27655 authenticating user, whose name is at this point in &$auth1$&. For
27656 compatibility with previous releases of Exim, the user name is also placed in
27657 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27658 it can lead to confusion in string expansions that also use numeric variables
27659 for other things. For example:
27660 .code
27661 spa:
27662   driver = spa
27663   public_name = NTLM
27664   server_password = \
27665     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27666 .endd
27667 If the expansion is forced to fail, authentication fails. Any other expansion
27668 failure causes a temporary error code to be returned.
27669
27670
27671
27672
27673
27674 .section "Using spa as a client" "SECID180"
27675 .cindex "options" "&(spa)& authenticator (client)"
27676 The &(spa)& authenticator has the following client options:
27677
27678
27679
27680 .option client_domain spa string&!! unset
27681 This option specifies an optional domain for the authentication.
27682
27683
27684 .option client_password spa string&!! unset
27685 This option specifies the user's password, and must be set.
27686
27687
27688 .option client_username spa string&!! unset
27689 This option specifies the user name, and must be set. Here is an example of a
27690 configuration of this authenticator for use with the mail servers at
27691 &'msn.com'&:
27692 .code
27693 msn:
27694   driver = spa
27695   public_name = MSN
27696   client_username = msn/msn_username
27697   client_password = msn_plaintext_password
27698   client_domain = DOMAIN_OR_UNSET
27699 .endd
27700 .ecindex IIDspaauth1
27701 .ecindex IIDspaauth2
27702
27703
27704
27705
27706
27707 . ////////////////////////////////////////////////////////////////////////////
27708 . ////////////////////////////////////////////////////////////////////////////
27709
27710 .chapter "The external authenticator" "CHAPexternauth"
27711 .scindex IIDexternauth1 "&(external)& authenticator"
27712 .scindex IIDexternauth2 "authenticators" "&(external)&"
27713 .cindex "authentication" "Client Certificate"
27714 .cindex "authentication" "X509"
27715 .cindex "Certificate-based authentication"
27716 The &(external)& authenticator provides support for
27717 authentication based on non-SMTP information.
27718 The specification is in RFC 4422 Appendix A
27719 (&url(https://tools.ietf.org/html/rfc4422)).
27720 It is only a transport and negotiation mechanism;
27721 the process of authentication is entirely controlled
27722 by the server configuration.
27723
27724 The client presents an identity in-clear.
27725 It is probably wise for a server to only advertise,
27726 and for clients to only attempt,
27727 this authentication method on a secure (eg. under TLS) connection.
27728
27729 One possible use, compatible with the
27730 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27731 is for using X509 client certificates.
27732
27733 It thus overlaps in function with the TLS authenticator
27734 (see &<<CHAPtlsauth>>&)
27735 but is a full SMTP SASL authenticator
27736 rather than being implicit for TLS-connection carried
27737 client certificates only.
27738
27739 The examples and discussion in this chapter assume that
27740 client-certificate authentication is being done.
27741
27742 The client must present a certificate,
27743 for which it must have been requested via the
27744 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27745 (see &<<CHAPTLS>>&).
27746 For authentication to be effective the certificate should be
27747 verifiable against a trust-anchor certificate known to the server.
27748
27749 .section "External options" "SECTexternsoptions"
27750 .cindex "options" "&(external)& authenticator (server)"
27751 The &(external)& authenticator has two server options:
27752
27753 .option server_param2 external string&!! unset
27754 .option server_param3 external string&!! unset
27755 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27756 These options are expanded before the &%server_condition%& option
27757 and the result are placed in &$auth2$& and &$auth3$& resectively.
27758 If the expansion is forced to fail, authentication fails. Any other expansion
27759 failure causes a temporary error code to be returned.
27760
27761 They can be used to clarify the coding of a complex &%server_condition%&.
27762
27763 .section "Using external in a server" "SECTexternserver"
27764 .cindex "AUTH" "in &(external)& authenticator"
27765 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27766         "in &(external)& authenticator"
27767 .vindex "&$auth1$&, &$auth2$&, etc"
27768 .cindex "base64 encoding" "in &(external)& authenticator"
27769
27770 When running as a server, &(external)& performs the authentication test by
27771 expanding a string. The data sent by the client with the AUTH command, or in
27772 response to subsequent prompts, is base64 encoded, and so may contain any byte
27773 values when decoded. The decoded value is treated as
27774 an identity for authentication and
27775 placed in the expansion variable &$auth1$&.
27776
27777 For compatibility with previous releases of Exim, the value is also placed in
27778 the expansion variable &$1$&. However, the use of this
27779 variable for this purpose is now deprecated, as it can lead to confusion in
27780 string expansions that also use them for other things.
27781
27782 .vindex "&$authenticated_id$&"
27783 Once an identity has been received,
27784 &%server_condition%& is expanded. If the expansion is forced to fail,
27785 authentication fails. Any other expansion failure causes a temporary error code
27786 to be returned. If the result of a successful expansion is an empty string,
27787 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27788 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27789 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27790 For any other result, a temporary error code is returned, with the expanded
27791 string as the error text.
27792
27793 Example:
27794 .code
27795 ext_ccert_san_mail:
27796   driver =            external
27797   public_name =       EXTERNAL
27798
27799   server_advertise_condition = $tls_in_certificate_verified
27800   server_param2 =     ${certextract {subj_altname,mail,>:} \
27801                                     {$tls_in_peercert}}
27802   server_condition =  ${if forany {$auth2} \
27803                             {eq {$item}{$auth1}}}
27804   server_set_id =     $auth1
27805 .endd
27806 This accepts a client certificate that is verifiable against any
27807 of your configured trust-anchors
27808 (which usually means the full set of public CAs)
27809 and which has a mail-SAN matching the claimed identity sent by the client.
27810
27811 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27812 The account name is therefore guessable by an opponent.
27813 TLS 1.3 protects both server and client certificates, and is not vulnerable
27814 in this way.
27815 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27816
27817
27818 .section "Using external in a client" "SECTexternclient"
27819 .cindex "options" "&(external)& authenticator (client)"
27820 The &(external)& authenticator has one client option:
27821
27822 .option client_send external string&!! unset
27823 This option is expanded and sent with the AUTH command as the
27824 identity being asserted.
27825
27826 Example:
27827 .code
27828 ext_ccert:
27829   driver =      external
27830   public_name = EXTERNAL
27831
27832   client_condition = ${if !eq{$tls_out_cipher}{}}
27833   client_send = myaccount@smarthost.example.net
27834 .endd
27835
27836
27837 .ecindex IIDexternauth1
27838 .ecindex IIDexternauth2
27839
27840
27841
27842
27843
27844 . ////////////////////////////////////////////////////////////////////////////
27845 . ////////////////////////////////////////////////////////////////////////////
27846
27847 .chapter "The tls authenticator" "CHAPtlsauth"
27848 .scindex IIDtlsauth1 "&(tls)& authenticator"
27849 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27850 .cindex "authentication" "Client Certificate"
27851 .cindex "authentication" "X509"
27852 .cindex "Certificate-based authentication"
27853 The &(tls)& authenticator provides server support for
27854 authentication based on client certificates.
27855
27856 It is not an SMTP authentication mechanism and is not
27857 advertised by the server as part of the SMTP EHLO response.
27858 It is an Exim authenticator in the sense that it affects
27859 the protocol element of the log line, can be tested for
27860 by the &%authenticated%& ACL condition, and can set
27861 the &$authenticated_id$& variable.
27862
27863 The client must present a verifiable certificate,
27864 for which it must have been requested via the
27865 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27866 (see &<<CHAPTLS>>&).
27867
27868 If an authenticator of this type is configured it is
27869 run before any SMTP-level communication is done,
27870 and can authenticate the connection.
27871 If it does, SMTP authentication is not offered.
27872
27873 A maximum of one authenticator of this type may be present.
27874
27875
27876 .cindex "options" "&(tls)& authenticator (server)"
27877 The &(tls)& authenticator has three server options:
27878
27879 .option server_param1 tls string&!! unset
27880 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27881 This option is expanded after the TLS negotiation and
27882 the result is placed in &$auth1$&.
27883 If the expansion is forced to fail, authentication fails. Any other expansion
27884 failure causes a temporary error code to be returned.
27885
27886 .option server_param2 tls string&!! unset
27887 .option server_param3 tls string&!! unset
27888 As above, for &$auth2$& and &$auth3$&.
27889
27890 &%server_param1%& may also be spelled &%server_param%&.
27891
27892
27893 Example:
27894 .code
27895 tls:
27896   driver = tls
27897   server_param1 =     ${certextract {subj_altname,mail,>:} \
27898                                     {$tls_in_peercert}}
27899   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
27900                                  {forany {$auth1} \
27901                             {!= {0} \
27902                                 {${lookup ldap{ldap:///\
27903                          mailname=${quote_ldap_dn:${lc:$item}},\
27904                          ou=users,LDAP_DC?mailid} {$value}{0} \
27905                        }    }  } }}}
27906   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27907 .endd
27908 This accepts a client certificate that is verifiable against any
27909 of your configured trust-anchors
27910 (which usually means the full set of public CAs)
27911 and which has a SAN with a good account name.
27912
27913 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27914 The account name is therefore guessable by an opponent.
27915 TLS 1.3 protects both server and client certificates, and is not vulnerable
27916 in this way.
27917 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27918
27919 . An alternative might use
27920 . .code
27921 .   server_param1 = ${sha256:$tls_in_peercert}
27922 . .endd
27923 . to require one of a set of specific certs that define a given account
27924 . (the verification is still required, but mostly irrelevant).
27925 . This would help for per-device use.
27926 .
27927 . However, for the future we really need support for checking a
27928 . user cert in LDAP - which probably wants a base-64 DER.
27929
27930 .ecindex IIDtlsauth1
27931 .ecindex IIDtlsauth2
27932
27933
27934 Note that because authentication is traditionally an SMTP operation,
27935 the &%authenticated%& ACL condition cannot be used in
27936 a connect- or helo-ACL.
27937
27938
27939
27940 . ////////////////////////////////////////////////////////////////////////////
27941 . ////////////////////////////////////////////////////////////////////////////
27942
27943 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27944          "Encrypted SMTP connections"
27945 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27946 .scindex IIDencsmtp2 "SMTP" "encryption"
27947 .cindex "TLS" "on SMTP connection"
27948 .cindex "OpenSSL"
27949 .cindex "GnuTLS"
27950 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27951 Sockets Layer), is implemented by making use of the OpenSSL library or the
27952 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27953 cryptographic code in the Exim distribution itself for implementing TLS. In
27954 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27955 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27956 You also need to understand the basic concepts of encryption at a managerial
27957 level, and in particular, the way that public keys, private keys, and
27958 certificates are used.
27959
27960 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27961 connection is established, the client issues a STARTTLS command. If the
27962 server accepts this, the client and the server negotiate an encryption
27963 mechanism. If the negotiation succeeds, the data that subsequently passes
27964 between them is encrypted.
27965
27966 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27967 and if so, what cipher suite is in use, whether the client supplied a
27968 certificate, and whether or not that certificate was verified. This makes it
27969 possible for an Exim server to deny or accept certain commands based on the
27970 encryption state.
27971
27972 &*Warning*&: Certain types of firewall and certain anti-virus products can
27973 disrupt TLS connections. You need to turn off SMTP scanning for these products
27974 in order to get TLS to work.
27975
27976
27977
27978 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27979          "SECID284"
27980 .cindex "submissions protocol"
27981 .cindex "ssmtp protocol"
27982 .cindex "smtps protocol"
27983 .cindex "SMTP" "submissions protocol"
27984 .cindex "SMTP" "ssmtp protocol"
27985 .cindex "SMTP" "smtps protocol"
27986 The history of port numbers for TLS in SMTP is a little messy and has been
27987 contentious.  As of RFC 8314, the common practice of using the historically
27988 allocated port 465 for "email submission but with TLS immediately upon connect
27989 instead of using STARTTLS" is officially blessed by the IETF, and recommended
27990 by them in preference to STARTTLS.
27991
27992 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
27993 clarity emerged over the dual roles of SMTP, for MX delivery and Email
27994 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
27995
27996 This approach was, for a while, officially abandoned when encrypted SMTP was
27997 standardized, but many clients kept using it, even as the TCP port number was
27998 reassigned for other use.
27999 Thus you may encounter guidance claiming that you shouldn't enable use of
28000 this port.
28001 In practice, a number of mail-clients have only ever supported submissions,
28002 not submission with STARTTLS upgrade.
28003 Ideally, offer both submission (587) and submissions (465) service.
28004
28005 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28006 global option. Its value must be a list of port numbers;
28007 the most common use is expected to be:
28008 .code
28009 tls_on_connect_ports = 465
28010 .endd
28011 The port numbers specified by this option apply to all SMTP connections, both
28012 via the daemon and via &'inetd'&. You still need to specify all the ports that
28013 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28014 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28015 an extra port &-- rather, it specifies different behaviour on a port that is
28016 defined elsewhere.
28017
28018 There is also a &%-tls-on-connect%& command line option. This overrides
28019 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28020
28021
28022
28023
28024
28025
28026 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28027 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28028 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
28029 followed later, when the first versions of GnuTLS were released. To build Exim
28030 to use GnuTLS, you need to set
28031 .code
28032 USE_GNUTLS=yes
28033 .endd
28034 in Local/Makefile, in addition to
28035 .code
28036 SUPPORT_TLS=yes
28037 .endd
28038 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28039 include files and libraries for GnuTLS can be found.
28040
28041 There are some differences in usage when using GnuTLS instead of OpenSSL:
28042
28043 .ilist
28044 The &%tls_verify_certificates%& option
28045 cannot be the path of a directory
28046 for GnuTLS versions before 3.3.6
28047 (for later versions, or OpenSSL, it can be either).
28048 .next
28049 The default value for &%tls_dhparam%& differs for historical reasons.
28050 .next
28051 .vindex "&$tls_in_peerdn$&"
28052 .vindex "&$tls_out_peerdn$&"
28053 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28054 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28055 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28056 .next
28057 OpenSSL identifies cipher suites using hyphens as separators, for example:
28058 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28059 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28060 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28061 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28062 to handle its own older variants) when processing lists of cipher suites in the
28063 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28064 option).
28065 .next
28066 The &%tls_require_ciphers%& options operate differently, as described in the
28067 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28068 .next
28069 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28070 When using OpenSSL, this option is ignored.
28071 (If an API is found to let OpenSSL be configured in this way,
28072 let the Exim Maintainers know and we'll likely use it).
28073 .next
28074 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28075 main option, it must be ordered to match the &%tls_certificate%& list.
28076 .next
28077 Some other recently added features may only be available in one or the other.
28078 This should be documented with the feature.  If the documentation does not
28079 explicitly state that the feature is infeasible in the other TLS
28080 implementation, then patches are welcome.
28081 .endlist
28082
28083
28084 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28085 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28086 an explicit path; if the latter, then the text about generation still applies,
28087 but not the chosen filename.
28088 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28089 See the documentation of &%tls_dhparam%& for more information.
28090
28091 GnuTLS uses D-H parameters that may take a substantial amount of time
28092 to compute. It is unreasonable to re-compute them for every TLS session.
28093 Therefore, Exim keeps this data in a file in its spool directory, called
28094 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28095 of bits requested.
28096 The file is owned by the Exim user and is readable only by
28097 its owner. Every Exim process that start up GnuTLS reads the D-H
28098 parameters from this file. If the file does not exist, the first Exim process
28099 that needs it computes the data and writes it to a temporary file which is
28100 renamed once it is complete. It does not matter if several Exim processes do
28101 this simultaneously (apart from wasting a few resources). Once a file is in
28102 place, new Exim processes immediately start using it.
28103
28104 For maximum security, the parameters that are stored in this file should be
28105 recalculated periodically, the frequency depending on your paranoia level.
28106 If you are avoiding using the fixed D-H primes published in RFCs, then you
28107 are concerned about some advanced attacks and will wish to do this; if you do
28108 not regenerate then you might as well stick to the standard primes.
28109
28110 Arranging this is easy in principle; just delete the file when you want new
28111 values to be computed. However, there may be a problem. The calculation of new
28112 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28113 If the system is not very active, &_/dev/random_& may delay returning data
28114 until enough randomness (entropy) is available. This may cause Exim to hang for
28115 a substantial amount of time, causing timeouts on incoming connections.
28116
28117 The solution is to generate the parameters externally to Exim. They are stored
28118 in &_gnutls-params-N_& in PEM format, which means that they can be
28119 generated externally using the &(certtool)& command that is part of GnuTLS.
28120
28121 To replace the parameters with new ones, instead of deleting the file
28122 and letting Exim re-create it, you can generate new parameters using
28123 &(certtool)& and, when this has been done, replace Exim's cache file by
28124 renaming. The relevant commands are something like this:
28125 .code
28126 # ls
28127 [ look for file; assume gnutls-params-2236 is the most recent ]
28128 # rm -f new-params
28129 # touch new-params
28130 # chown exim:exim new-params
28131 # chmod 0600 new-params
28132 # certtool --generate-dh-params --bits 2236 >>new-params
28133 # openssl dhparam -noout -text -in new-params | head
28134 [ check the first line, make sure it's not more than 2236;
28135   if it is, then go back to the start ("rm") and repeat
28136   until the size generated is at most the size requested ]
28137 # chmod 0400 new-params
28138 # mv new-params gnutls-params-2236
28139 .endd
28140 If Exim never has to generate the parameters itself, the possibility of
28141 stalling is removed.
28142
28143 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28144 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28145 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28146 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28147 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28148 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28149 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28150 which applies to all D-H usage, client or server.  If the value returned by
28151 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28152 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28153 limit, which is still much higher than Exim historically used.
28154
28155 The filename and bits used will change as the GnuTLS maintainers change the
28156 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28157 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28158 2432 bits, while NSS is limited to 2236 bits.
28159
28160 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28161 increase the chance of the generated prime actually being within acceptable
28162 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28163 procedure above.  There is no sane procedure available to Exim to double-check
28164 the size of the generated prime, so it might still be too large.
28165
28166
28167 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28168 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28169 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28170 There is a function in the OpenSSL library that can be passed a list of cipher
28171 suites before the cipher negotiation takes place. This specifies which ciphers
28172 are acceptable for TLS versions prior to 1.3.
28173 The list is colon separated and may contain names like
28174 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28175 directly to this function call.
28176 Many systems will install the OpenSSL manual-pages, so you may have
28177 &'ciphers(1)'& available to you.
28178 The following quotation from the OpenSSL
28179 documentation specifies what forms of item are allowed in the cipher string:
28180
28181 .ilist
28182 It can consist of a single cipher suite such as RC4-SHA.
28183 .next
28184 It can represent a list of cipher suites containing a certain algorithm,
28185 or cipher suites of a certain type. For example SHA1 represents all
28186 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28187 SSL v3 algorithms.
28188 .next
28189 Lists of cipher suites can be combined in a single cipher string using
28190 the + character. This is used as a logical and operation. For example
28191 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28192 algorithms.
28193 .endlist
28194
28195 Each cipher string can be optionally preceded by one of the characters &`!`&,
28196 &`-`& or &`+`&.
28197 .ilist
28198 If &`!`& is used, the ciphers are permanently deleted from the list. The
28199 ciphers deleted can never reappear in the list even if they are explicitly
28200 stated.
28201 .next
28202 If &`-`& is used, the ciphers are deleted from the list, but some or all
28203 of the ciphers can be added again by later options.
28204 .next
28205 If &`+`& is used, the ciphers are moved to the end of the list. This
28206 option does not add any new ciphers; it just moves matching existing ones.
28207 .endlist
28208
28209 If none of these characters is present, the string is interpreted as
28210 a list of ciphers to be appended to the current preference list. If the list
28211 includes any ciphers already present they will be ignored: that is, they will
28212 not be moved to the end of the list.
28213 .endlist
28214
28215 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28216 string:
28217 .code
28218 # note single-quotes to get ! past any shell history expansion
28219 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28220 .endd
28221
28222 This example will let the library defaults be permitted on the MX port, where
28223 there's probably no identity verification anyway, but ups the ante on the
28224 submission ports where the administrator might have some influence on the
28225 choice of clients used:
28226 .code
28227 # OpenSSL variant; see man ciphers(1)
28228 tls_require_ciphers = ${if =={$received_port}{25}\
28229                            {DEFAULT}\
28230                            {HIGH:!MD5:!SHA1}}
28231 .endd
28232
28233 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28234 .code
28235 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28236 .endd
28237
28238 For TLS version 1.3 the control available is less fine-grained
28239 and Exim does not provide access to it at present.
28240 The value of the &%tls_require_ciphers%& option is ignored when
28241 TLS version 1.3 is negotiated.
28242
28243 As of writing the library default cipher suite list for TLSv1.3 is
28244 .code
28245 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28246 .endd
28247
28248
28249 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28250          "SECTreqciphgnu"
28251 .cindex "GnuTLS" "specifying parameters for"
28252 .cindex "TLS" "specifying ciphers (GnuTLS)"
28253 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28254 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28255 .cindex "TLS" "specifying protocols (GnuTLS)"
28256 .cindex "TLS" "specifying priority string (GnuTLS)"
28257 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28258 The GnuTLS library allows the caller to provide a "priority string", documented
28259 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28260 ciphersuite specification in OpenSSL.
28261
28262 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28263 and controls both protocols and ciphers.
28264
28265 The &%tls_require_ciphers%& option is available both as an global option,
28266 controlling how Exim behaves as a server, and also as an option of the
28267 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28268 the value is string expanded.  The resulting string is not an Exim list and
28269 the string is given to the GnuTLS library, so that Exim does not need to be
28270 aware of future feature enhancements of GnuTLS.
28271
28272 Documentation of the strings accepted may be found in the GnuTLS manual, under
28273 "Priority strings".  This is online as
28274 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28275 but beware that this relates to GnuTLS 3, which may be newer than the version
28276 installed on your system.  If you are using GnuTLS 3,
28277 then the example code
28278 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28279 on that site can be used to test a given string.
28280
28281 For example:
28282 .code
28283 # Disable older versions of protocols
28284 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28285 .endd
28286
28287 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28288 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28289 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28290
28291 This example will let the library defaults be permitted on the MX port, where
28292 there's probably no identity verification anyway, and lowers security further
28293 by increasing compatibility; but this ups the ante on the submission ports
28294 where the administrator might have some influence on the choice of clients
28295 used:
28296 .code
28297 # GnuTLS variant
28298 tls_require_ciphers = ${if =={$received_port}{25}\
28299                            {NORMAL:%COMPAT}\
28300                            {SECURE128}}
28301 .endd
28302
28303
28304 .section "Configuring an Exim server to use TLS" "SECID182"
28305 .cindex "TLS" "configuring an Exim server"
28306 When Exim has been built with TLS support, it advertises the availability of
28307 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28308 but not to any others. The default value of this option is *, which means
28309 that STARTTLS is always advertised.  Set it to blank to never advertise;
28310 this is reasonable for systems that want to use TLS only as a client.
28311
28312 If STARTTLS is to be used you
28313 need to set some other options in order to make TLS available.
28314
28315 If a client issues a STARTTLS command and there is some configuration
28316 problem in the server, the command is rejected with a 454 error. If the client
28317 persists in trying to issue SMTP commands, all except QUIT are rejected
28318 with the error
28319 .code
28320 554 Security failure
28321 .endd
28322 If a STARTTLS command is issued within an existing TLS session, it is
28323 rejected with a 554 error code.
28324
28325 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28326 must be set to match some hosts. The default is * which matches all hosts.
28327
28328 If this is all you do, TLS encryption will be enabled but not authentication -
28329 meaning that the peer has no assurance it is actually you he is talking to.
28330 You gain protection from a passive sniffer listening on the wire but not
28331 from someone able to intercept the communication.
28332
28333 Further protection requires some further configuration at the server end.
28334
28335 To make TLS work you need to set, in the server,
28336 .code
28337 tls_certificate = /some/file/name
28338 tls_privatekey = /some/file/name
28339 .endd
28340 These options are, in fact, expanded strings, so you can make them depend on
28341 the identity of the client that is connected if you wish. The first file
28342 contains the server's X509 certificate, and the second contains the private key
28343 that goes with it. These files need to be
28344 PEM format and readable by the Exim user, and must
28345 always be given as full path names.
28346 The key must not be password-protected.
28347 They can be the same file if both the
28348 certificate and the key are contained within it. If &%tls_privatekey%& is not
28349 set, or if its expansion is forced to fail or results in an empty string, this
28350 is assumed to be the case. The certificate file may also contain intermediate
28351 certificates that need to be sent to the client to enable it to authenticate
28352 the server's certificate.
28353
28354 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28355 colon-separated lists of file paths.  Ciphers using given authentication
28356 algorithms require the presence of a suitable certificate to supply the
28357 public-key.  The server selects among the certificates to present to the
28358 client depending on the selected cipher, hence the priority ordering for
28359 ciphers will affect which certificate is used.
28360
28361 If you do not understand about certificates and keys, please try to find a
28362 source of this background information, which is not Exim-specific. (There are a
28363 few comments below in section &<<SECTcerandall>>&.)
28364
28365 &*Note*&: These options do not apply when Exim is operating as a client &--
28366 they apply only in the case of a server. If you need to use a certificate in an
28367 Exim client, you must set the options of the same names in an &(smtp)&
28368 transport.
28369
28370 With just these options, an Exim server will be able to use TLS. It does not
28371 require the client to have a certificate (but see below for how to insist on
28372 this). There is one other option that may be needed in other situations. If
28373 .code
28374 tls_dhparam = /some/file/name
28375 .endd
28376 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28377 with the parameters contained in the file.
28378 Set this to &`none`& to disable use of DH entirely, by making no prime
28379 available:
28380 .code
28381 tls_dhparam = none
28382 .endd
28383 This may also be set to a string identifying a standard prime to be used for
28384 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28385 used is &`ike23`&.  There are a few standard primes available, see the
28386 documentation for &%tls_dhparam%& for the complete list.
28387
28388 See the command
28389 .code
28390 openssl dhparam
28391 .endd
28392 for a way of generating file data.
28393
28394 The strings supplied for these three options are expanded every time a client
28395 host connects. It is therefore possible to use different certificates and keys
28396 for different hosts, if you so wish, by making use of the client's IP address
28397 in &$sender_host_address$& to control the expansion. If a string expansion is
28398 forced to fail, Exim behaves as if the option is not set.
28399
28400 .cindex "cipher" "logging"
28401 .cindex "log" "TLS cipher"
28402 .vindex "&$tls_in_cipher$&"
28403 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28404 an incoming TLS connection. It is included in the &'Received:'& header of an
28405 incoming message (by default &-- you can, of course, change this), and it is
28406 also included in the log line that records a message's arrival, keyed by
28407 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28408 condition can be used to test for specific cipher suites in ACLs.
28409
28410 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28411 can check the name of the cipher suite and vary their actions accordingly. The
28412 cipher suite names vary, depending on which TLS library is being used. For
28413 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28414 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28415 documentation for more details.
28416
28417 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28418 (again depending on the &%tls_cipher%& log selector).
28419
28420
28421 .section "Requesting and verifying client certificates" "SECID183"
28422 .cindex "certificate" "verification of client"
28423 .cindex "TLS" "client certificate verification"
28424 If you want an Exim server to request a certificate when negotiating a TLS
28425 session with a client, you must set either &%tls_verify_hosts%& or
28426 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28427 apply to all TLS connections. For any host that matches one of these options,
28428 Exim requests a certificate as part of the setup of the TLS session. The
28429 contents of the certificate are verified by comparing it with a list of
28430 expected trust-anchors or certificates.
28431 These may be the system default set (depending on library version),
28432 an explicit file or,
28433 depending on library version, a directory, identified by
28434 &%tls_verify_certificates%&.
28435
28436 A file can contain multiple certificates, concatenated end to end. If a
28437 directory is used
28438 (OpenSSL only),
28439 each certificate must be in a separate file, with a name (or a symbolic link)
28440 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28441 certificate. You can compute the relevant hash by running the command
28442 .code
28443 openssl x509 -hash -noout -in /cert/file
28444 .endd
28445 where &_/cert/file_& contains a single certificate.
28446
28447 There is no checking of names of the client against the certificate
28448 Subject Name or Subject Alternate Names.
28449
28450 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28451 what happens if the client does not supply a certificate, or if the certificate
28452 does not match any of the certificates in the collection named by
28453 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28454 attempt to set up a TLS session is aborted, and the incoming connection is
28455 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28456 session continues. ACLs that run for subsequent SMTP commands can detect the
28457 fact that no certificate was verified, and vary their actions accordingly. For
28458 example, you can insist on a certificate before accepting a message for
28459 relaying, but not when the message is destined for local delivery.
28460
28461 .vindex "&$tls_in_peerdn$&"
28462 When a client supplies a certificate (whether it verifies or not), the value of
28463 the Distinguished Name of the certificate is made available in the variable
28464 &$tls_in_peerdn$& during subsequent processing of the message.
28465
28466 .cindex "log" "distinguished name"
28467 Because it is often a long text string, it is not included in the log line or
28468 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28469 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28470 &%received_header_text%& to change the &'Received:'& header. When no
28471 certificate is supplied, &$tls_in_peerdn$& is empty.
28472
28473
28474 .section "Revoked certificates" "SECID184"
28475 .cindex "TLS" "revoked certificates"
28476 .cindex "revocation list"
28477 .cindex "certificate" "revocation list"
28478 .cindex "OCSP" "stapling"
28479 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28480 certificates are revoked. If you have such a list, you can pass it to an Exim
28481 server using the global option called &%tls_crl%& and to an Exim client using
28482 an identically named option for the &(smtp)& transport. In each case, the value
28483 of the option is expanded and must then be the name of a file that contains a
28484 CRL in PEM format.
28485 The downside is that clients have to periodically re-download a potentially huge
28486 file from every certificate authority they know of.
28487
28488 The way with most moving parts at query time is Online Certificate
28489 Status Protocol (OCSP), where the client verifies the certificate
28490 against an OCSP server run by the CA.  This lets the CA track all
28491 usage of the certs.  It requires running software with access to the
28492 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28493 is based on HTTP and can be proxied accordingly.
28494
28495 The only widespread OCSP server implementation (known to this writer)
28496 comes as part of OpenSSL and aborts on an invalid request, such as
28497 connecting to the port and then disconnecting.  This requires
28498 re-entering the passphrase each time some random client does this.
28499
28500 The third way is OCSP Stapling; in this, the server using a certificate
28501 issued by the CA periodically requests an OCSP proof of validity from
28502 the OCSP server, then serves it up inline as part of the TLS
28503 negotiation.   This approach adds no extra round trips, does not let the
28504 CA track users, scales well with number of certs issued by the CA and is
28505 resilient to temporary OCSP server failures, as long as the server
28506 starts retrying to fetch an OCSP proof some time before its current
28507 proof expires.  The downside is that it requires server support.
28508
28509 Unless Exim is built with the support disabled,
28510 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28511 support for OCSP stapling is included.
28512
28513 There is a global option called &%tls_ocsp_file%&.
28514 The file specified therein is expected to be in DER format, and contain
28515 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28516 option will be re-expanded for SNI, if the &%tls_certificate%& option
28517 contains &`tls_in_sni`&, as per other TLS options.
28518
28519 Exim does not at this time implement any support for fetching a new OCSP
28520 proof.  The burden is on the administrator to handle this, outside of
28521 Exim.  The file specified should be replaced atomically, so that the
28522 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28523 on each connection, so a new file will be handled transparently on the
28524 next connection.
28525
28526 When built with OpenSSL Exim will check for a valid next update timestamp
28527 in the OCSP proof; if not present, or if the proof has expired, it will be
28528 ignored.
28529
28530 For the client to be able to verify the stapled OCSP the server must
28531 also supply, in its stapled information, any intermediate
28532 certificates for the chain leading to the OCSP proof from the signer
28533 of the server certificate.  There may be zero or one such. These
28534 intermediate certificates should be added to the server OCSP stapling
28535 file named by &%tls_ocsp_file%&.
28536
28537 Note that the proof only covers the terminal server certificate,
28538 not any of the chain from CA to it.
28539
28540 There is no current way to staple a proof for a client certificate.
28541
28542 .code
28543   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28544   OCSP server is supplied.  The server URL may be included in the
28545   server certificate, if the CA is helpful.
28546
28547   One failure mode seen was the OCSP Signer cert expiring before the end
28548   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28549   noted this as invalid overall, but the re-fetch script did not.
28550 .endd
28551
28552
28553
28554
28555 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28556 .cindex "cipher" "logging"
28557 .cindex "log" "TLS cipher"
28558 .cindex "log" "distinguished name"
28559 .cindex "TLS" "configuring an Exim client"
28560 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28561 deliveries as well as to incoming, the latter one causing logging of the
28562 server certificate's DN. The remaining client configuration for TLS is all
28563 within the &(smtp)& transport.
28564
28565 It is not necessary to set any options to have TLS work in the &(smtp)&
28566 transport. If Exim is built with TLS support, and TLS is advertised by a
28567 server, the &(smtp)& transport always tries to start a TLS session. However,
28568 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28569 transport) to a list of server hosts for which TLS should not be used.
28570
28571 If you do not want Exim to attempt to send messages unencrypted when an attempt
28572 to set up an encrypted connection fails in any way, you can set
28573 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28574 those hosts, delivery is always deferred if an encrypted connection cannot be
28575 set up. If there are any other hosts for the address, they are tried in the
28576 usual way.
28577
28578 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28579 the message unencrypted. It always does this if the response to STARTTLS is
28580 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28581 session after a success response code, what happens is controlled by the
28582 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28583 delivery to this host is deferred, and other hosts (if available) are tried. If
28584 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28585 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28586 negotiation fails, Exim closes the current connection (because it is in an
28587 unknown state), opens a new one to the same host, and then tries the delivery
28588 unencrypted.
28589
28590 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28591 transport provide the client with a certificate, which is passed to the server
28592 if it requests it. If the server is Exim, it will request a certificate only if
28593 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28594
28595 .new
28596 Do not use a certificate which has the OCSP-must-staple extension,
28597 for client use (they are usable for server use).
28598 As TLS has no means for the client to staple before TLS 1.3 it will result
28599 in failed connections.
28600 .wen
28601
28602 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28603 specifies a collection of expected server certificates.
28604 These may be
28605 the system default set (depending on library version),
28606 a file,
28607 or (depending on library version) a directory.
28608 The client verifies the server's certificate
28609 against this collection, taking into account any revoked certificates that are
28610 in the list defined by &%tls_crl%&.
28611 Failure to verify fails the TLS connection unless either of the
28612 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28613
28614 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28615 certificate verification to the listed servers.  Verification either must
28616 or need not succeed respectively.
28617
28618 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28619 checks are made: that the host name (the one in the DNS A record)
28620 is valid for the certificate.
28621 The option defaults to always checking.
28622
28623 The &(smtp)& transport has two OCSP-related options:
28624 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28625 is requested and required for the connection to proceed.  The default
28626 value is empty.
28627 &%hosts_request_ocsp%&; a host-list for which (additionally)
28628 a Certificate Status is requested (but not necessarily verified).  The default
28629 value is "*" meaning that requests are made unless configured
28630 otherwise.
28631
28632 The host(s) should also be in &%hosts_require_tls%&, and
28633 &%tls_verify_certificates%& configured for the transport,
28634 for OCSP to be relevant.
28635
28636 If
28637 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28638 list of permitted cipher suites. If either of these checks fails, delivery to
28639 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28640 alternative hosts, if any.
28641
28642  &*Note*&:
28643 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28644 is operating as a client. Exim does not assume that a server certificate (set
28645 by the global options of the same name) should also be used when operating as a
28646 client.
28647
28648 .vindex "&$host$&"
28649 .vindex "&$host_address$&"
28650 All the TLS options in the &(smtp)& transport are expanded before use, with
28651 &$host$& and &$host_address$& containing the name and address of the server to
28652 which the client is connected. Forced failure of an expansion causes Exim to
28653 behave as if the relevant option were unset.
28654
28655 .vindex &$tls_out_bits$&
28656 .vindex &$tls_out_cipher$&
28657 .vindex &$tls_out_peerdn$&
28658 .vindex &$tls_out_sni$&
28659 Before an SMTP connection is established, the
28660 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28661 variables are emptied. (Until the first connection, they contain the values
28662 that were set when the message was received.) If STARTTLS is subsequently
28663 successfully obeyed, these variables are set to the relevant values for the
28664 outgoing connection.
28665
28666
28667
28668 .section "Use of TLS Server Name Indication" "SECTtlssni"
28669 .cindex "TLS" "Server Name Indication"
28670 .vindex "&$tls_in_sni$&"
28671 .oindex "&%tls_in_sni%&"
28672 With TLS1.0 or above, there is an extension mechanism by which extra
28673 information can be included at various points in the protocol.  One of these
28674 extensions, documented in RFC 6066 (and before that RFC 4366) is
28675 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28676 client in the initial handshake, so that the server can examine the servername
28677 within and possibly choose to use different certificates and keys (and more)
28678 for this session.
28679
28680 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28681 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28682 address.
28683
28684 With SMTP to MX, there are the same problems here as in choosing the identity
28685 against which to validate a certificate: you can't rely on insecure DNS to
28686 provide the identity which you then cryptographically verify.  So this will
28687 be of limited use in that environment.
28688
28689 With SMTP to Submission, there is a well-defined hostname which clients are
28690 connecting to and can validate certificates against.  Thus clients &*can*&
28691 choose to include this information in the TLS negotiation.  If this becomes
28692 wide-spread, then hosters can choose to present different certificates to
28693 different clients.  Or even negotiate different cipher suites.
28694
28695 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28696 if not empty, will be sent on a TLS session as part of the handshake.  There's
28697 nothing more to it.  Choosing a sensible value not derived insecurely is the
28698 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28699 for the lifetime of the client connection (including during authentication).
28700
28701 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28702 received from a client.
28703 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28704
28705 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28706 option (prior to expansion) then the following options will be re-expanded
28707 during TLS session handshake, to permit alternative values to be chosen:
28708
28709 .ilist
28710 &%tls_certificate%&
28711 .next
28712 &%tls_crl%&
28713 .next
28714 &%tls_privatekey%&
28715 .next
28716 &%tls_verify_certificates%&
28717 .next
28718 &%tls_ocsp_file%&
28719 .endlist
28720
28721 Great care should be taken to deal with matters of case, various injection
28722 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28723 can always be referenced; it is important to remember that &$tls_in_sni$& is
28724 arbitrary unverified data provided prior to authentication.
28725 Further, the initial certificate is loaded before SNI has arrived, so
28726 an expansion for &%tls_certificate%& must have a default which is used
28727 when &$tls_in_sni$& is empty.
28728
28729 The Exim developers are proceeding cautiously and so far no other TLS options
28730 are re-expanded.
28731
28732 When Exim is built against OpenSSL, OpenSSL must have been built with support
28733 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28734 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28735 see &`-servername`& in the output, then OpenSSL has support.
28736
28737 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28738 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28739 built, then you have SNI support).
28740
28741
28742
28743 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28744          "SECTmulmessam"
28745 .cindex "multiple SMTP deliveries with TLS"
28746 .cindex "TLS" "multiple message deliveries"
28747 Exim sends multiple messages down the same TCP/IP connection by starting up
28748 an entirely new delivery process for each message, passing the socket from
28749 one process to the next. This implementation does not fit well with the use
28750 of TLS, because there is quite a lot of state information associated with a TLS
28751 connection, not just a socket identification. Passing all the state information
28752 to a new process is not feasible. Consequently, for sending using TLS Exim
28753 starts an additional proxy process for handling the encryption, piping the
28754 unencrypted data stream from and to the delivery processes.
28755
28756 An older mode of operation can be enabled on a per-host basis by the
28757 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28758 this list the proxy process described above is not used; instead Exim
28759 shuts down an existing TLS session being run by the delivery process
28760 before passing the socket to a new process. The new process may then
28761 try to start a new TLS session, and if successful, may try to re-authenticate
28762 if AUTH is in use, before sending the next message.
28763
28764 The RFC is not clear as to whether or not an SMTP session continues in clear
28765 after TLS has been shut down, or whether TLS may be restarted again later, as
28766 just described. However, if the server is Exim, this shutdown and
28767 reinitialization works. It is not known which (if any) other servers operate
28768 successfully if the client closes a TLS session and continues with unencrypted
28769 SMTP, but there are certainly some that do not work. For such servers, Exim
28770 should not pass the socket to another process, because the failure of the
28771 subsequent attempt to use it would cause Exim to record a temporary host error,
28772 and delay other deliveries to that host.
28773
28774 To test for this case, Exim sends an EHLO command to the server after
28775 closing down the TLS session. If this fails in any way, the connection is
28776 closed instead of being passed to a new delivery process, but no retry
28777 information is recorded.
28778
28779 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28780 &(smtp)& transport to match those hosts for which Exim should not pass
28781 connections to new processes if TLS has been used.
28782
28783
28784
28785
28786 .section "Certificates and all that" "SECTcerandall"
28787 .cindex "certificate" "references to discussion"
28788 In order to understand fully how TLS works, you need to know about
28789 certificates, certificate signing, and certificate authorities.
28790 This is a large topic and an introductory guide is unsuitable for the Exim
28791 reference manual, so instead we provide pointers to existing documentation.
28792
28793 The Apache web-server was for a long time the canonical guide, so their
28794 documentation is a good place to start; their SSL module's Introduction
28795 document is currently at
28796 .display
28797 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28798 .endd
28799 and their FAQ is at
28800 .display
28801 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28802 .endd
28803
28804 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28805 0-201-61598-3) in 2001, contains both introductory and more in-depth
28806 descriptions.
28807 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28808 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28809 Ivan is the author of the popular TLS testing tools at
28810 &url(https://www.ssllabs.com/).
28811
28812
28813 .section "Certificate chains" "SECID186"
28814 The file named by &%tls_certificate%& may contain more than one
28815 certificate. This is useful in the case where the certificate that is being
28816 sent is validated by an intermediate certificate which the other end does
28817 not have. Multiple certificates must be in the correct order in the file.
28818 First the host's certificate itself, then the first intermediate
28819 certificate to validate the issuer of the host certificate, then the next
28820 intermediate certificate to validate the issuer of the first intermediate
28821 certificate, and so on, until finally (optionally) the root certificate.
28822 The root certificate must already be trusted by the recipient for
28823 validation to succeed, of course, but if it's not preinstalled, sending the
28824 root certificate along with the rest makes it available for the user to
28825 install if the receiving end is a client MUA that can interact with a user.
28826
28827 Note that certificates using MD5 are unlikely to work on today's Internet;
28828 even if your libraries allow loading them for use in Exim when acting as a
28829 server, increasingly clients will not accept such certificates.  The error
28830 diagnostics in such a case can be frustratingly vague.
28831
28832
28833
28834 .section "Self-signed certificates" "SECID187"
28835 .cindex "certificate" "self-signed"
28836 You can create a self-signed certificate using the &'req'& command provided
28837 with OpenSSL, like this:
28838 . ==== Do not shorten the duration here without reading and considering
28839 . ==== the text below.  Please leave it at 9999 days.
28840 .code
28841 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28842             -days 9999 -nodes
28843 .endd
28844 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28845 delimited and so can be identified independently. The &%-days%& option
28846 specifies a period for which the certificate is valid. The &%-nodes%& option is
28847 important: if you do not set it, the key is encrypted with a passphrase
28848 that you are prompted for, and any use that is made of the key causes more
28849 prompting for the passphrase. This is not helpful if you are going to use
28850 this certificate and key in an MTA, where prompting is not possible.
28851
28852 . ==== I expect to still be working 26 years from now.  The less technical
28853 . ==== debt I create, in terms of storing up trouble for my later years, the
28854 . ==== happier I will be then.  We really have reached the point where we
28855 . ==== should start, at the very least, provoking thought and making folks
28856 . ==== pause before proceeding, instead of leaving all the fixes until two
28857 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28858 . ==== -pdp, 2012
28859 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28860 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28861 the above command might produce a date in the past.  Think carefully about
28862 the lifetime of the systems you're deploying, and either reduce the duration
28863 of the certificate or reconsider your platform deployment.  (At time of
28864 writing, reducing the duration is the most likely choice, but the inexorable
28865 progression of time takes us steadily towards an era where this will not
28866 be a sensible resolution).
28867
28868 A self-signed certificate made in this way is sufficient for testing, and
28869 may be adequate for all your requirements if you are mainly interested in
28870 encrypting transfers, and not in secure identification.
28871
28872 However, many clients require that the certificate presented by the server be a
28873 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28874 certificate. In this situation, the self-signed certificate described above
28875 must be installed on the client host as a trusted root &'certification
28876 authority'& (CA), and the certificate used by Exim must be a user certificate
28877 signed with that self-signed certificate.
28878
28879 For information on creating self-signed CA certificates and using them to sign
28880 user certificates, see the &'General implementation overview'& chapter of the
28881 Open-source PKI book, available online at
28882 &url(https://sourceforge.net/projects/ospkibook/).
28883 .ecindex IIDencsmtp1
28884 .ecindex IIDencsmtp2
28885
28886
28887
28888 .section DANE "SECDANE"
28889 .cindex DANE
28890 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28891 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28892 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28893 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28894 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28895 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28896
28897 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28898 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28899 by (a) is thought to be smaller than that of the set of root CAs.
28900
28901 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28902 fail to pass on a server's STARTTLS.
28903
28904 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28905 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28906 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28907
28908 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28909 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28910 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28911 DNSSEC.
28912 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28913 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28914
28915 There are no changes to Exim specific to server-side operation of DANE.
28916 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28917 in &_Local/Makefile_&.
28918 If it has been included, the macro "_HAVE_DANE" will be defined.
28919
28920 A TLSA record consist of 4 fields, the "Certificate Usage", the
28921 "Selector", the "Matching type", and the "Certificate Association Data".
28922 For a detailed description of the TLSA record see
28923 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
28924
28925 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
28926 These are the "Trust Anchor" and "End Entity" variants.
28927 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28928 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28929 this is appropriate for a single system, using a self-signed certificate.
28930 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28931 well-known one.
28932 A private CA at simplest is just a self-signed certificate (with certain
28933 attributes) which is used to sign server certificates, but running one securely
28934 does require careful arrangement.
28935 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28936 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28937 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28938 all of which point to a single TLSA record.
28939 DANE-TA and DANE-EE can both be used together.
28940
28941 Our recommendation is to use DANE with a certificate from a public CA,
28942 because this enables a variety of strategies for remote clients to verify
28943 your certificate.
28944 You can then publish information both via DANE and another technology,
28945 "MTA-STS", described below.
28946
28947 When you use DANE-TA to publish trust anchor information, you ask entities
28948 outside your administrative control to trust the Certificate Authority for
28949 connections to you.
28950 If using a private CA then you should expect others to still apply the
28951 technical criteria they'd use for a public CA to your certificates.
28952 In particular, you should probably try to follow current best practices for CA
28953 operation around hash algorithms and key sizes.
28954 Do not expect other organizations to lower their security expectations just
28955 because a particular profile might be reasonable for your own internal use.
28956
28957 When this text was last updated, this in practice means to avoid use of SHA-1
28958 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28959 than 4096, for interoperability); to use keyUsage fields correctly; to use
28960 random serial numbers.
28961 The list of requirements is subject to change as best practices evolve.
28962 If you're not already using a private CA, or it doesn't meet these
28963 requirements, then we encourage you to avoid all these issues and use a public
28964 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28965
28966 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
28967 a "Matching Type" (3rd) field of SHA2-512(2).
28968
28969 For the "Certificate Authority Data" (4th) field, commands like
28970
28971 .code
28972   openssl x509 -pubkey -noout <certificate.pem \
28973   | openssl rsa -outform der -pubin 2>/dev/null \
28974   | openssl sha512 \
28975   | awk '{print $2}'
28976 .endd
28977
28978 are workable to create a hash of the certificate's public key.
28979
28980 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
28981
28982 .code
28983   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
28984 .endd
28985
28986 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28987 is useful for quickly generating TLSA records.
28988
28989
28990 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
28991
28992 The Certificate issued by the CA published in the DANE-TA model should be
28993 issued using a strong hash algorithm.
28994 Exim, and importantly various other MTAs sending to you, will not
28995 re-enable hash algorithms which have been disabled by default in TLS
28996 libraries.
28997 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
28998 interoperability (and probably the maximum too, in 2018).
28999
29000 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29001 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29002 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29003
29004 .code
29005   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29006                                  {= {4}{$tls_out_tlsa_usage}} } \
29007                          {*}{}}
29008 .endd
29009
29010 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29011 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29012 found. If the definition of &%hosts_request_ocsp%& includes the
29013 string "tls_out_tlsa_usage", they are re-expanded in time to
29014 control the OCSP request.
29015
29016 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29017 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29018
29019
29020 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29021 and &%dane_require_tls_ciphers%&.
29022 The require variant will result in failure if the target host is not
29023 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29024 the &%dnssec_request_domains%& router or transport option.
29025
29026 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29027
29028 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29029 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29030 will be required for the host.  If it does not, the host will not
29031 be used; there is no fallback to non-DANE or non-TLS.
29032
29033 If DANE is requested and usable, then the TLS cipher list configuration
29034 prefers to use the option &%dane_require_tls_ciphers%& and falls
29035 back to &%tls_require_ciphers%& only if that is unset.
29036 This lets you configure "decent crypto" for DANE and "better than nothing
29037 crypto" as the default.  Note though that while GnuTLS lets the string control
29038 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29039 limited to ciphersuite constraints.
29040
29041 If DANE is requested and useable (see above) the following transport options are ignored:
29042 .code
29043   hosts_require_tls
29044   tls_verify_hosts
29045   tls_try_verify_hosts
29046   tls_verify_certificates
29047   tls_crl
29048   tls_verify_cert_hostnames
29049 .endd
29050
29051 If DANE is not usable, whether requested or not, and CA-anchored
29052 verification evaluation is wanted, the above variables should be set appropriately.
29053
29054 Currently the (router or transport options) &%dnssec_request_domains%& must be active and &%dnssec_require_domains%& is ignored.
29055
29056 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29057
29058 There is a new variable &$tls_out_dane$& which will have "yes" if
29059 verification succeeded using DANE and "no" otherwise (only useful
29060 in combination with events; see &<<CHAPevents>>&),
29061 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29062
29063 .cindex DANE reporting
29064 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29065 to achieve DANE-verified connection, if one was either requested and offered, or
29066 required.  This is intended to support TLS-reporting as defined in
29067 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29068 The &$event_data$& will be one of the Result Types defined in
29069 Section 4.3 of that document.
29070
29071 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29072
29073 DANE is specified in published RFCs and decouples certificate authority trust
29074 selection from a "race to the bottom" of "you must trust everything for mail
29075 to get through".  There is an alternative technology called MTA-STS, which
29076 instead publishes MX trust anchor information on an HTTPS website.  At the
29077 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29078 Exim has no support for MTA-STS as a client, but Exim mail server operators
29079 can choose to publish information describing their TLS configuration using
29080 MTA-STS to let those clients who do use that protocol derive trust
29081 information.
29082
29083 The MTA-STS design requires a certificate from a public Certificate Authority
29084 which is recognized by clients sending to you.
29085 That selection of which CAs are trusted by others is outside your control.
29086
29087 The most interoperable course of action is probably to use
29088 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29089 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29090 records for DANE clients (such as Exim and Postfix) and to publish anchor
29091 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29092 domain itself (with caveats around occasionally broken MTA-STS because of
29093 incompatible specification changes prior to reaching RFC status).
29094
29095
29096
29097 . ////////////////////////////////////////////////////////////////////////////
29098 . ////////////////////////////////////////////////////////////////////////////
29099
29100 .chapter "Access control lists" "CHAPACL"
29101 .scindex IIDacl "&ACL;" "description"
29102 .cindex "control of incoming mail"
29103 .cindex "message" "controlling incoming"
29104 .cindex "policy control" "access control lists"
29105 Access Control Lists (ACLs) are defined in a separate section of the runtime
29106 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29107 name, terminated by a colon. Here is a complete ACL section that contains just
29108 one very small ACL:
29109 .code
29110 begin acl
29111 small_acl:
29112   accept   hosts = one.host.only
29113 .endd
29114 You can have as many lists as you like in the ACL section, and the order in
29115 which they appear does not matter. The lists are self-terminating.
29116
29117 The majority of ACLs are used to control Exim's behaviour when it receives
29118 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29119 when a local process submits a message using SMTP by specifying the &%-bs%&
29120 option. The most common use is for controlling which recipients are accepted
29121 in incoming messages. In addition, you can define an ACL that is used to check
29122 local non-SMTP messages. The default configuration file contains an example of
29123 a realistic ACL for checking RCPT commands. This is discussed in chapter
29124 &<<CHAPdefconfil>>&.
29125
29126
29127 .section "Testing ACLs" "SECID188"
29128 The &%-bh%& command line option provides a way of testing your ACL
29129 configuration locally by running a fake SMTP session with which you interact.
29130
29131
29132 .section "Specifying when ACLs are used" "SECID189"
29133 .cindex "&ACL;" "options for specifying"
29134 In order to cause an ACL to be used, you have to name it in one of the relevant
29135 options in the main part of the configuration. These options are:
29136 .cindex "AUTH" "ACL for"
29137 .cindex "DATA" "ACLs for"
29138 .cindex "ETRN" "ACL for"
29139 .cindex "EXPN" "ACL for"
29140 .cindex "HELO" "ACL for"
29141 .cindex "EHLO" "ACL for"
29142 .cindex "DKIM" "ACL for"
29143 .cindex "MAIL" "ACL for"
29144 .cindex "QUIT, ACL for"
29145 .cindex "RCPT" "ACL for"
29146 .cindex "STARTTLS, ACL for"
29147 .cindex "VRFY" "ACL for"
29148 .cindex "SMTP" "connection, ACL for"
29149 .cindex "non-SMTP messages" "ACLs for"
29150 .cindex "MIME content scanning" "ACL for"
29151 .cindex "PRDR" "ACL for"
29152
29153 .table2 140pt
29154 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29155 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29156 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29157 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29158 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29159 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29160 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29161 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29162 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29163 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29164 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29165 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29166 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29167 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29168 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29169 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29170 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29171 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29172 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29173 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29174 .endtable
29175
29176 For example, if you set
29177 .code
29178 acl_smtp_rcpt = small_acl
29179 .endd
29180 the little ACL defined above is used whenever Exim receives a RCPT command
29181 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29182 done when RCPT commands arrive. A rejection of RCPT should cause the
29183 sending MTA to give up on the recipient address contained in the RCPT
29184 command, whereas rejection at other times may cause the client MTA to keep on
29185 trying to deliver the message. It is therefore recommended that you do as much
29186 testing as possible at RCPT time.
29187
29188
29189 .section "The non-SMTP ACLs" "SECID190"
29190 .cindex "non-SMTP messages" "ACLs for"
29191 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29192 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29193 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29194 the state of the SMTP connection such as encryption and authentication) are not
29195 relevant and are forbidden in these ACLs. However, the sender and recipients
29196 are known, so the &%senders%& and &%sender_domains%& conditions and the
29197 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29198 &$authenticated_sender$& are also available. You can specify added header lines
29199 in any of these ACLs.
29200
29201 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29202 non-SMTP message, before any of the message has been read. (This is the
29203 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29204 batched SMTP input, it runs after the DATA command has been reached. The
29205 result of this ACL is ignored; it cannot be used to reject a message. If you
29206 really need to, you could set a value in an ACL variable here and reject based
29207 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29208 controls, and in particular, it can be used to set
29209 .code
29210 control = suppress_local_fixups
29211 .endd
29212 This cannot be used in the other non-SMTP ACLs because by the time they are
29213 run, it is too late.
29214
29215 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29216 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29217
29218 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29219 kind of rejection is treated as permanent, because there is no way of sending a
29220 temporary error for these kinds of message.
29221
29222
29223 .section "The SMTP connect ACL" "SECID191"
29224 .cindex "SMTP" "connection, ACL for"
29225 .oindex &%smtp_banner%&
29226 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29227 session, after the test specified by &%host_reject_connection%& (which is now
29228 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29229 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29230 the message override the banner message that is otherwise specified by the
29231 &%smtp_banner%& option.
29232
29233
29234 .section "The EHLO/HELO ACL" "SECID192"
29235 .cindex "EHLO" "ACL for"
29236 .cindex "HELO" "ACL for"
29237 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29238 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29239 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29240 Note that a client may issue more than one EHLO or HELO command in an SMTP
29241 session, and indeed is required to issue a new EHLO or HELO after successfully
29242 setting up encryption following a STARTTLS command.
29243
29244 Note also that a deny neither forces the client to go away nor means that
29245 mail will be refused on the connection.  Consider checking for
29246 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29247
29248 If the command is accepted by an &%accept%& verb that has a &%message%&
29249 modifier, the message may not contain more than one line (it will be truncated
29250 at the first newline and a panic logged if it does). Such a message cannot
29251 affect the EHLO options that are listed on the second and subsequent lines of
29252 an EHLO response.
29253
29254
29255 .section "The DATA ACLs" "SECID193"
29256 .cindex "DATA" "ACLs for"
29257 Two ACLs are associated with the DATA command, because it is two-stage
29258 command, with two responses being sent to the client.
29259 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29260 is obeyed. This gives you control after all the RCPT commands, but before
29261 the message itself is received. It offers the opportunity to give a negative
29262 response to the DATA command before the data is transmitted. Header lines
29263 added by MAIL or RCPT ACLs are not visible at this time, but any that
29264 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29265
29266 You cannot test the contents of the message, for example, to verify addresses
29267 in the headers, at RCPT time or when the DATA command is received. Such
29268 tests have to appear in the ACL that is run after the message itself has been
29269 received, before the final response to the DATA command is sent. This is
29270 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29271 associated with the DATA command.
29272
29273 .cindex CHUNKING "BDAT command"
29274 .cindex BDAT "SMTP command"
29275 .cindex "RFC 3030" CHUNKING
29276 If CHUNKING was advertised and a BDAT command sequence is received,
29277 the &%acl_smtp_predata%& ACL is not run.
29278 . XXX why not?  It should be possible, for the first BDAT.
29279 The &%acl_smtp_data%& is run after the last BDAT command and all of
29280 the data specified is received.
29281
29282 For both of these ACLs, it is not possible to reject individual recipients. An
29283 error response rejects the entire message. Unfortunately, it is known that some
29284 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29285 before or after the data) correctly &-- they keep the message on their queues
29286 and try again later, but that is their problem, though it does waste some of
29287 your resources.
29288
29289 The &%acl_smtp_data%& ACL is run after
29290 the &%acl_smtp_data_prdr%&,
29291 the &%acl_smtp_dkim%&
29292 and the &%acl_smtp_mime%& ACLs.
29293
29294 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29295 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29296 enabled (which is the default).
29297
29298 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29299 received, and is executed for each DKIM signature found in a message.  If not
29300 otherwise specified, the default action is to accept.
29301
29302 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29303
29304 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29305
29306
29307 .section "The SMTP MIME ACL" "SECID194"
29308 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29309 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29310
29311 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29312
29313
29314 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29315 .cindex "PRDR" "ACL for"
29316 .oindex "&%prdr_enable%&"
29317 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29318 with PRDR support enabled (which is the default).
29319 It becomes active only when the PRDR feature is negotiated between
29320 client and server for a message, and more than one recipient
29321 has been accepted.
29322
29323 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29324 has been received, and is executed once for each recipient of the message
29325 with &$local_part$& and &$domain$& valid.
29326 The test may accept, defer or deny for individual recipients.
29327 The &%acl_smtp_data%& will still be called after this ACL and
29328 can reject the message overall, even if this ACL has accepted it
29329 for some or all recipients.
29330
29331 PRDR may be used to support per-user content filtering.  Without it
29332 one must defer any recipient after the first that has a different
29333 content-filter configuration.  With PRDR, the RCPT-time check
29334 .cindex "PRDR" "variable for"
29335 for this can be disabled when the variable &$prdr_requested$&
29336 is &"yes"&.
29337 Any required difference in behaviour of the main DATA-time
29338 ACL should however depend on the PRDR-time ACL having run, as Exim
29339 will avoid doing so in some situations (e.g. single-recipient mails).
29340
29341 See also the &%prdr_enable%& global option
29342 and the &%hosts_try_prdr%& smtp transport option.
29343
29344 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29345 If the ACL is not defined, processing completes as if
29346 the feature was not requested by the client.
29347
29348 .section "The QUIT ACL" "SECTQUITACL"
29349 .cindex "QUIT, ACL for"
29350 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29351 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29352 does not in fact control any access.
29353 For this reason, it may only accept
29354 or warn as its final result.
29355
29356 This ACL can be used for tasks such as custom logging at the end of an SMTP
29357 session. For example, you can use ACL variables in other ACLs to count
29358 messages, recipients, etc., and log the totals at QUIT time using one or
29359 more &%logwrite%& modifiers on a &%warn%& verb.
29360
29361 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29362 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29363
29364 You do not need to have a final &%accept%&, but if you do, you can use a
29365 &%message%& modifier to specify custom text that is sent as part of the 221
29366 response to QUIT.
29367
29368 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29369 failure (for example, failure to open a log file, or when Exim is bombing out
29370 because it has detected an unrecoverable error), all SMTP commands from the
29371 client are given temporary error responses until QUIT is received or the
29372 connection is closed. In these special cases, the QUIT ACL does not run.
29373
29374
29375 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29376 .vindex &$acl_smtp_notquit$&
29377 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29378 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29379 trouble, such as being unable to write to its log files, this ACL is not run,
29380 because it might try to do things (such as write to log files) that make the
29381 situation even worse.
29382
29383 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29384 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29385 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29386 and &%warn%&.
29387
29388 .vindex &$smtp_notquit_reason$&
29389 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29390 to a string that indicates the reason for the termination of the SMTP
29391 connection. The possible values are:
29392 .table2
29393 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29394 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29395 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29396 .irow &`connection-lost`&          "The SMTP connection has been lost"
29397 .irow &`data-timeout`&             "Timeout while reading message data"
29398 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29399 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29400 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29401 .irow &`synchronization-error`&    "SMTP synchronization error"
29402 .irow &`tls-failed`&               "TLS failed to start"
29403 .endtable
29404 In most cases when an SMTP connection is closed without having received QUIT,
29405 Exim sends an SMTP response message before actually closing the connection.
29406 With the exception of the &`acl-drop`& case, the default message can be
29407 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29408 &%drop%& verb in another ACL, it is the message from the other ACL that is
29409 used.
29410
29411
29412 .section "Finding an ACL to use" "SECID195"
29413 .cindex "&ACL;" "finding which to use"
29414 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29415 you can use different ACLs in different circumstances. For example,
29416 .code
29417 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29418                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29419 .endd
29420 In the default configuration file there are some example settings for
29421 providing an RFC 4409 message &"submission"& service on port 587 and
29422 an RFC 8314 &"submissions"& service on port 465. You can use a string
29423 expansion like this to choose an ACL for MUAs on these ports which is
29424 more appropriate for this purpose than the default ACL on port 25.
29425
29426 The expanded string does not have to be the name of an ACL in the
29427 configuration file; there are other possibilities. Having expanded the
29428 string, Exim searches for an ACL as follows:
29429
29430 .ilist
29431 If the string begins with a slash, Exim uses it as a filename, and reads its
29432 contents as an ACL. The lines are processed in the same way as lines in the
29433 Exim configuration file. In particular, continuation lines are supported, blank
29434 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29435 If the file does not exist or cannot be read, an error occurs (typically
29436 causing a temporary failure of whatever caused the ACL to be run). For example:
29437 .code
29438 acl_smtp_data = /etc/acls/\
29439   ${lookup{$sender_host_address}lsearch\
29440   {/etc/acllist}{$value}{default}}
29441 .endd
29442 This looks up an ACL file to use on the basis of the host's IP address, falling
29443 back to a default if the lookup fails. If an ACL is successfully read from a
29444 file, it is retained in memory for the duration of the Exim process, so that it
29445 can be re-used without having to re-read the file.
29446 .next
29447 If the string does not start with a slash, and does not contain any spaces,
29448 Exim searches the ACL section of the configuration for an ACL whose name
29449 matches the string.
29450 .next
29451 If no named ACL is found, or if the string contains spaces, Exim parses
29452 the string as an inline ACL. This can save typing in cases where you just
29453 want to have something like
29454 .code
29455 acl_smtp_vrfy = accept
29456 .endd
29457 in order to allow free use of the VRFY command. Such a string may contain
29458 newlines; it is processed in the same way as an ACL that is read from a file.
29459 .endlist
29460
29461
29462
29463
29464 .section "ACL return codes" "SECID196"
29465 .cindex "&ACL;" "return codes"
29466 Except for the QUIT ACL, which does not affect the SMTP return code (see
29467 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29468 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29469 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29470 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29471 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29472 This also causes a 4&'xx'& return code.
29473
29474 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29475 &"deny"&, because there is no mechanism for passing temporary errors to the
29476 submitters of non-SMTP messages.
29477
29478
29479 ACLs that are relevant to message reception may also return &"discard"&. This
29480 has the effect of &"accept"&, but causes either the entire message or an
29481 individual recipient address to be discarded. In other words, it is a
29482 blackholing facility. Use it with care.
29483
29484 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29485 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29486 RCPT ACL is to discard just the one recipient address. If there are no
29487 recipients left when the message's data is received, the DATA ACL is not
29488 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29489 remaining recipients. The &"discard"& return is not permitted for the
29490 &%acl_smtp_predata%& ACL.
29491
29492 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29493 is done on the address and the result determines the SMTP response.
29494
29495
29496 .cindex "&[local_scan()]& function" "when all recipients discarded"
29497 The &[local_scan()]& function is always run, even if there are no remaining
29498 recipients; it may create new recipients.
29499
29500
29501
29502 .section "Unset ACL options" "SECID197"
29503 .cindex "&ACL;" "unset options"
29504 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29505 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29506 not defined at all. For any defined ACL, the default action when control
29507 reaches the end of the ACL statements is &"deny"&.
29508
29509 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29510 these two are ACLs that are used only for their side effects. They cannot be
29511 used to accept or reject anything.
29512
29513 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29514 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29515 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29516 when the ACL is not defined is &"accept"&.
29517
29518 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29519 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29520 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29521 messages over an SMTP connection. For an example, see the ACL in the default
29522 configuration file.
29523
29524
29525
29526
29527 .section "Data for message ACLs" "SECID198"
29528 .cindex "&ACL;" "data for message ACL"
29529 .vindex &$domain$&
29530 .vindex &$local_part$&
29531 .vindex &$sender_address$&
29532 .vindex &$sender_host_address$&
29533 .vindex &$smtp_command$&
29534 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29535 that contain information about the host and the message's sender (for example,
29536 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29537 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29538 &$local_part$& are set from the argument address. The entire SMTP command
29539 is available in &$smtp_command$&.
29540
29541 When an ACL for the AUTH parameter of MAIL is running, the variables that
29542 contain information about the host are set, but &$sender_address$& is not yet
29543 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29544 how it is used.
29545
29546 .vindex "&$message_size$&"
29547 The &$message_size$& variable is set to the value of the SIZE parameter on
29548 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29549 that parameter is not given. The value is updated to the true message size by
29550 the time the final DATA ACL is run (after the message data has been
29551 received).
29552
29553 .vindex "&$rcpt_count$&"
29554 .vindex "&$recipients_count$&"
29555 The &$rcpt_count$& variable increases by one for each RCPT command received.
29556 The &$recipients_count$& variable increases by one each time a RCPT command is
29557 accepted, so while an ACL for RCPT is being processed, it contains the number
29558 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29559 &$rcpt_count$& contains the total number of RCPT commands, and
29560 &$recipients_count$& contains the total number of accepted recipients.
29561
29562
29563
29564
29565
29566 .section "Data for non-message ACLs" "SECTdatfornon"
29567 .cindex "&ACL;" "data for non-message ACL"
29568 .vindex &$smtp_command_argument$&
29569 .vindex &$smtp_command$&
29570 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29571 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29572 and the entire SMTP command is available in &$smtp_command$&.
29573 These variables can be tested using a &%condition%& condition. For example,
29574 here is an ACL for use with AUTH, which insists that either the session is
29575 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29576 does not permit authentication methods that use cleartext passwords on
29577 unencrypted connections.
29578 .code
29579 acl_check_auth:
29580   accept encrypted = *
29581   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29582                      {CRAM-MD5}}
29583   deny   message   = TLS encryption or CRAM-MD5 required
29584 .endd
29585 (Another way of applying this restriction is to arrange for the authenticators
29586 that use cleartext passwords not to be advertised when the connection is not
29587 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29588 option to do this.)
29589
29590
29591
29592 .section "Format of an ACL" "SECID199"
29593 .cindex "&ACL;" "format of"
29594 .cindex "&ACL;" "verbs, definition of"
29595 An individual ACL consists of a number of statements. Each statement starts
29596 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29597 Modifiers can change the way the verb operates, define error and log messages,
29598 set variables, insert delays, and vary the processing of accepted messages.
29599
29600 If all the conditions are met, the verb is obeyed. The same condition may be
29601 used (with different arguments) more than once in the same statement. This
29602 provides a means of specifying an &"and"& conjunction between conditions. For
29603 example:
29604 .code
29605 deny  dnslists = list1.example
29606       dnslists = list2.example
29607 .endd
29608 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29609 the conditions and modifiers when it reaches a condition that fails. What
29610 happens then depends on the verb (and in one case, on a special modifier). Not
29611 all the conditions make sense at every testing point. For example, you cannot
29612 test a sender address in the ACL that is run for a VRFY command.
29613
29614
29615 .section "ACL verbs" "SECID200"
29616 The ACL verbs are as follows:
29617
29618 .ilist
29619 .cindex "&%accept%& ACL verb"
29620 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29621 of the conditions are not met, what happens depends on whether &%endpass%&
29622 appears among the conditions (for syntax see below). If the failing condition
29623 is before &%endpass%&, control is passed to the next ACL statement; if it is
29624 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29625 check a RCPT command:
29626 .code
29627 accept domains = +local_domains
29628        endpass
29629        verify = recipient
29630 .endd
29631 If the recipient domain does not match the &%domains%& condition, control
29632 passes to the next statement. If it does match, the recipient is verified, and
29633 the command is accepted if verification succeeds. However, if verification
29634 fails, the ACL yields &"deny"&, because the failing condition is after
29635 &%endpass%&.
29636
29637 The &%endpass%& feature has turned out to be confusing to many people, so its
29638 use is not recommended nowadays. It is always possible to rewrite an ACL so
29639 that &%endpass%& is not needed, and it is no longer used in the default
29640 configuration.
29641
29642 .cindex "&%message%& ACL modifier" "with &%accept%&"
29643 If a &%message%& modifier appears on an &%accept%& statement, its action
29644 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29645 (when an &%accept%& verb either accepts or passes control to the next
29646 statement), &%message%& can be used to vary the message that is sent when an
29647 SMTP command is accepted. For example, in a RCPT ACL you could have:
29648 .display
29649 &`accept  `&<&'some conditions'&>
29650 &`        message = OK, I will allow you through today`&
29651 .endd
29652 You can specify an SMTP response code, optionally followed by an &"extended
29653 response code"& at the start of the message, but the first digit must be the
29654 same as would be sent by default, which is 2 for an &%accept%& verb.
29655
29656 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29657 an error message that is used when access is denied. This behaviour is retained
29658 for backward compatibility, but current &"best practice"& is to avoid the use
29659 of &%endpass%&.
29660
29661
29662 .next
29663 .cindex "&%defer%& ACL verb"
29664 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29665 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29666 &%defer%& is the same as &%deny%&, because there is no way of sending a
29667 temporary error. For a RCPT command, &%defer%& is much the same as using a
29668 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29669 be used in any ACL, and even for a recipient it might be a simpler approach.
29670
29671
29672 .next
29673 .cindex "&%deny%& ACL verb"
29674 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29675 the conditions are not met, control is passed to the next ACL statement. For
29676 example,
29677 .code
29678 deny dnslists = blackholes.mail-abuse.org
29679 .endd
29680 rejects commands from hosts that are on a DNS black list.
29681
29682
29683 .next
29684 .cindex "&%discard%& ACL verb"
29685 &%discard%&: This verb behaves like &%accept%&, except that it returns
29686 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29687 that are concerned with receiving messages. When all the conditions are true,
29688 the sending entity receives a &"success"& response. However, &%discard%& causes
29689 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29690 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29691 message's recipients are discarded. Recipients that are discarded before DATA
29692 do not appear in the log line when the &%received_recipients%& log selector is set.
29693
29694 If the &%log_message%& modifier is set when &%discard%& operates,
29695 its contents are added to the line that is automatically written to the log.
29696 The &%message%& modifier operates exactly as it does for &%accept%&.
29697
29698
29699 .next
29700 .cindex "&%drop%& ACL verb"
29701 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29702 forcibly closed after the 5&'xx'& error message has been sent. For example:
29703 .code
29704 drop   message   = I don't take more than 20 RCPTs
29705        condition = ${if > {$rcpt_count}{20}}
29706 .endd
29707 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29708 The connection is always dropped after sending a 550 response.
29709
29710 .next
29711 .cindex "&%require%& ACL verb"
29712 &%require%&: If all the conditions are met, control is passed to the next ACL
29713 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29714 example, when checking a RCPT command,
29715 .code
29716 require message = Sender did not verify
29717         verify  = sender
29718 .endd
29719 passes control to subsequent statements only if the message's sender can be
29720 verified. Otherwise, it rejects the command. Note the positioning of the
29721 &%message%& modifier, before the &%verify%& condition. The reason for this is
29722 discussed in section &<<SECTcondmodproc>>&.
29723
29724 .next
29725 .cindex "&%warn%& ACL verb"
29726 &%warn%&: If all the conditions are true, a line specified by the
29727 &%log_message%& modifier is written to Exim's main log. Control always passes
29728 to the next ACL statement. If any condition is false, the log line is not
29729 written. If an identical log line is requested several times in the same
29730 message, only one copy is actually written to the log. If you want to force
29731 duplicates to be written, use the &%logwrite%& modifier instead.
29732
29733 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29734 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29735 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29736 first failing condition. There is more about adding header lines in section
29737 &<<SECTaddheadacl>>&.
29738
29739 If any condition on a &%warn%& statement cannot be completed (that is, there is
29740 some sort of defer), the log line specified by &%log_message%& is not written.
29741 This does not include the case of a forced failure from a lookup, which
29742 is considered to be a successful completion. After a defer, no further
29743 conditions or modifiers in the &%warn%& statement are processed. The incident
29744 is logged, and the ACL continues to be processed, from the next statement
29745 onwards.
29746
29747
29748 .vindex "&$acl_verify_message$&"
29749 When one of the &%warn%& conditions is an address verification that fails, the
29750 text of the verification failure message is in &$acl_verify_message$&. If you
29751 want this logged, you must set it up explicitly. For example:
29752 .code
29753 warn   !verify = sender
29754        log_message = sender verify failed: $acl_verify_message
29755 .endd
29756 .endlist
29757
29758 At the end of each ACL there is an implicit unconditional &%deny%&.
29759
29760 As you can see from the examples above, the conditions and modifiers are
29761 written one to a line, with the first one on the same line as the verb, and
29762 subsequent ones on following lines. If you have a very long condition, you can
29763 continue it onto several physical lines by the usual backslash continuation
29764 mechanism. It is conventional to align the conditions vertically.
29765
29766
29767
29768 .section "ACL variables" "SECTaclvariables"
29769 .cindex "&ACL;" "variables"
29770 There are some special variables that can be set during ACL processing. They
29771 can be used to pass information between different ACLs, different invocations
29772 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29773 transports, and filters that are used to deliver a message. The names of these
29774 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29775 an underscore, but the remainder of the name can be any sequence of
29776 alphanumeric characters and underscores that you choose. There is no limit on
29777 the number of ACL variables. The two sets act as follows:
29778 .ilist
29779 The values of those variables whose names begin with &$acl_c$& persist
29780 throughout an SMTP connection. They are never reset. Thus, a value that is set
29781 while receiving one message is still available when receiving the next message
29782 on the same SMTP connection.
29783 .next
29784 The values of those variables whose names begin with &$acl_m$& persist only
29785 while a message is being received. They are reset afterwards. They are also
29786 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29787 .endlist
29788
29789 When a message is accepted, the current values of all the ACL variables are
29790 preserved with the message and are subsequently made available at delivery
29791 time. The ACL variables are set by a modifier called &%set%&. For example:
29792 .code
29793 accept hosts = whatever
29794        set acl_m4 = some value
29795 accept authenticated = *
29796        set acl_c_auth = yes
29797 .endd
29798 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29799 be set. If you want to set a variable without taking any action, you can use a
29800 &%warn%& verb without any other modifiers or conditions.
29801
29802 .oindex &%strict_acl_vars%&
29803 What happens if a syntactically valid but undefined ACL variable is
29804 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29805 false (the default), an empty string is substituted; if it is true, an
29806 error is generated.
29807
29808 Versions of Exim before 4.64 have a limited set of numbered variables, but
29809 their names are compatible, so there is no problem with upgrading.
29810
29811
29812 .section "Condition and modifier processing" "SECTcondmodproc"
29813 .cindex "&ACL;" "conditions; processing"
29814 .cindex "&ACL;" "modifiers; processing"
29815 An exclamation mark preceding a condition negates its result. For example:
29816 .code
29817 deny   domains = *.dom.example
29818       !verify  = recipient
29819 .endd
29820 causes the ACL to return &"deny"& if the recipient domain ends in
29821 &'dom.example'& and the recipient address cannot be verified. Sometimes
29822 negation can be used on the right-hand side of a condition. For example, these
29823 two statements are equivalent:
29824 .code
29825 deny  hosts = !192.168.3.4
29826 deny !hosts =  192.168.3.4
29827 .endd
29828 However, for many conditions (&%verify%& being a good example), only left-hand
29829 side negation of the whole condition is possible.
29830
29831 The arguments of conditions and modifiers are expanded. A forced failure
29832 of an expansion causes a condition to be ignored, that is, it behaves as if the
29833 condition is true. Consider these two statements:
29834 .code
29835 accept  senders = ${lookup{$host_name}lsearch\
29836                   {/some/file}{$value}fail}
29837 accept  senders = ${lookup{$host_name}lsearch\
29838                   {/some/file}{$value}{}}
29839 .endd
29840 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29841 the returned list is searched, but if the lookup fails the behaviour is
29842 different in the two cases. The &%fail%& in the first statement causes the
29843 condition to be ignored, leaving no further conditions. The &%accept%& verb
29844 therefore succeeds. The second statement, however, generates an empty list when
29845 the lookup fails. No sender can match an empty list, so the condition fails,
29846 and therefore the &%accept%& also fails.
29847
29848 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29849 specify actions that are taken as the conditions for a statement are checked;
29850 others specify text for messages that are used when access is denied or a
29851 warning is generated. The &%control%& modifier affects the way an incoming
29852 message is handled.
29853
29854 The positioning of the modifiers in an ACL statement is important, because the
29855 processing of a verb ceases as soon as its outcome is known. Only those
29856 modifiers that have already been encountered will take effect. For example,
29857 consider this use of the &%message%& modifier:
29858 .code
29859 require message = Can't verify sender
29860         verify  = sender
29861         message = Can't verify recipient
29862         verify  = recipient
29863         message = This message cannot be used
29864 .endd
29865 If sender verification fails, Exim knows that the result of the statement is
29866 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29867 so its text is used as the error message. If sender verification succeeds, but
29868 recipient verification fails, the second message is used. If recipient
29869 verification succeeds, the third message becomes &"current"&, but is never used
29870 because there are no more conditions to cause failure.
29871
29872 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29873 modifier that is used, because all the conditions must be true for rejection to
29874 happen. Specifying more than one &%message%& modifier does not make sense, and
29875 the message can even be specified after all the conditions. For example:
29876 .code
29877 deny   hosts = ...
29878       !senders = *@my.domain.example
29879        message = Invalid sender from client host
29880 .endd
29881 The &"deny"& result does not happen until the end of the statement is reached,
29882 by which time Exim has set up the message.
29883
29884
29885
29886 .section "ACL modifiers" "SECTACLmodi"
29887 .cindex "&ACL;" "modifiers; list of"
29888 The ACL modifiers are as follows:
29889
29890 .vlist
29891 .vitem &*add_header*&&~=&~<&'text'&>
29892 This modifier specifies one or more header lines that are to be added to an
29893 incoming message, assuming, of course, that the message is ultimately
29894 accepted. For details, see section &<<SECTaddheadacl>>&.
29895
29896 .vitem &*continue*&&~=&~<&'text'&>
29897 .cindex "&%continue%& ACL modifier"
29898 .cindex "database" "updating in ACL"
29899 This modifier does nothing of itself, and processing of the ACL always
29900 continues with the next condition or modifier. The value of &%continue%& is in
29901 the side effects of expanding its argument. Typically this could be used to
29902 update a database. It is really just a syntactic tidiness, to avoid having to
29903 write rather ugly lines like this:
29904 .display
29905 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29906 .endd
29907 Instead, all you need is
29908 .display
29909 &`continue = `&<&'some expansion'&>
29910 .endd
29911
29912 .vitem &*control*&&~=&~<&'text'&>
29913 .cindex "&%control%& ACL modifier"
29914 This modifier affects the subsequent processing of the SMTP connection or of an
29915 incoming message that is accepted. The effect of the first type of control
29916 lasts for the duration of the connection, whereas the effect of the second type
29917 lasts only until the current message has been received. The message-specific
29918 controls always apply to the whole message, not to individual recipients,
29919 even if the &%control%& modifier appears in a RCPT ACL.
29920
29921 As there are now quite a few controls that can be applied, they are described
29922 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29923 in several different ways. For example:
29924
29925 . ==== As this is a nested list, any displays it contains must be indented
29926 . ==== as otherwise they are too far to the left. That comment applies only
29927 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29928 . ==== way.
29929
29930 .ilist
29931 It can be at the end of an &%accept%& statement:
29932 .code
29933     accept  ...some conditions
29934             control = queue_only
29935 .endd
29936 In this case, the control is applied when this statement yields &"accept"&, in
29937 other words, when the conditions are all true.
29938
29939 .next
29940 It can be in the middle of an &%accept%& statement:
29941 .code
29942     accept  ...some conditions...
29943             control = queue_only
29944             ...some more conditions...
29945 .endd
29946 If the first set of conditions are true, the control is applied, even if the
29947 statement does not accept because one of the second set of conditions is false.
29948 In this case, some subsequent statement must yield &"accept"& for the control
29949 to be relevant.
29950
29951 .next
29952 It can be used with &%warn%& to apply the control, leaving the
29953 decision about accepting or denying to a subsequent verb. For
29954 example:
29955 .code
29956     warn    ...some conditions...
29957             control = freeze
29958     accept  ...
29959 .endd
29960 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29961 &%logwrite%&, so it does not add anything to the message and does not write a
29962 log entry.
29963
29964 .next
29965 If you want to apply a control unconditionally, you can use it with a
29966 &%require%& verb. For example:
29967 .code
29968     require  control = no_multiline_responses
29969 .endd
29970 .endlist
29971
29972 .vitem &*delay*&&~=&~<&'time'&>
29973 .cindex "&%delay%& ACL modifier"
29974 .oindex "&%-bh%&"
29975 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29976 the time interval before proceeding. However, when testing Exim using the
29977 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29978 output instead). The time is given in the usual Exim notation, and the delay
29979 happens as soon as the modifier is processed. In an SMTP session, pending
29980 output is flushed before the delay is imposed.
29981
29982 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29983 example:
29984 .code
29985 deny    ...some conditions...
29986         delay = 30s
29987 .endd
29988 The delay happens if all the conditions are true, before the statement returns
29989 &"deny"&. Compare this with:
29990 .code
29991 deny    delay = 30s
29992         ...some conditions...
29993 .endd
29994 which waits for 30s before processing the conditions. The &%delay%& modifier
29995 can also be used with &%warn%& and together with &%control%&:
29996 .code
29997 warn    ...some conditions...
29998         delay = 2m
29999         control = freeze
30000 accept  ...
30001 .endd
30002
30003 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30004 responses to several commands are no longer buffered and sent in one packet (as
30005 they would normally be) because all output is flushed before imposing the
30006 delay. This optimization is disabled so that a number of small delays do not
30007 appear to the client as one large aggregated delay that might provoke an
30008 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30009 using a &%control%& modifier to set &%no_delay_flush%&.
30010
30011
30012 .vitem &*endpass*&
30013 .cindex "&%endpass%& ACL modifier"
30014 This modifier, which has no argument, is recognized only in &%accept%& and
30015 &%discard%& statements. It marks the boundary between the conditions whose
30016 failure causes control to pass to the next statement, and the conditions whose
30017 failure causes the ACL to return &"deny"&. This concept has proved to be
30018 confusing to some people, so the use of &%endpass%& is no longer recommended as
30019 &"best practice"&. See the description of &%accept%& above for more details.
30020
30021
30022 .vitem &*log_message*&&~=&~<&'text'&>
30023 .cindex "&%log_message%& ACL modifier"
30024 This modifier sets up a message that is used as part of the log message if the
30025 ACL denies access or a &%warn%& statement's conditions are true. For example:
30026 .code
30027 require log_message = wrong cipher suite $tls_in_cipher
30028         encrypted   = DES-CBC3-SHA
30029 .endd
30030 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30031 example:
30032 .display
30033 &`discard `&<&'some conditions'&>
30034 &`        log_message = Discarded $local_part@$domain because...`&
30035 .endd
30036 When access is denied, &%log_message%& adds to any underlying error message
30037 that may exist because of a condition failure. For example, while verifying a
30038 recipient address, a &':fail:'& redirection might have already set up a
30039 message.
30040
30041 The message may be defined before the conditions to which it applies, because
30042 the string expansion does not happen until Exim decides that access is to be
30043 denied. This means that any variables that are set by the condition are
30044 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30045 variables are set after a DNS black list lookup succeeds. If the expansion of
30046 &%log_message%& fails, or if the result is an empty string, the modifier is
30047 ignored.
30048
30049 .vindex "&$acl_verify_message$&"
30050 If you want to use a &%warn%& statement to log the result of an address
30051 verification, you can use &$acl_verify_message$& to include the verification
30052 error message.
30053
30054 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30055 the start of the logged message. If the same warning log message is requested
30056 more than once while receiving  a single email message, only one copy is
30057 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30058 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30059 is logged for a successful &%warn%& statement.
30060
30061 If &%log_message%& is not present and there is no underlying error message (for
30062 example, from the failure of address verification), but &%message%& is present,
30063 the &%message%& text is used for logging rejections. However, if any text for
30064 logging contains newlines, only the first line is logged. In the absence of
30065 both &%log_message%& and &%message%&, a default built-in message is used for
30066 logging rejections.
30067
30068
30069 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30070 .cindex "&%log_reject_target%& ACL modifier"
30071 .cindex "logging in ACL" "specifying which log"
30072 This modifier makes it possible to specify which logs are used for messages
30073 about ACL rejections. Its argument is a colon-separated list of words that can
30074 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30075 may be empty, in which case a rejection is not logged at all. For example, this
30076 ACL fragment writes no logging information when access is denied:
30077 .display
30078 &`deny `&<&'some conditions'&>
30079 &`     log_reject_target =`&
30080 .endd
30081 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30082 permanent and temporary rejections. Its effect lasts for the rest of the
30083 current ACL.
30084
30085
30086 .vitem &*logwrite*&&~=&~<&'text'&>
30087 .cindex "&%logwrite%& ACL modifier"
30088 .cindex "logging in ACL" "immediate"
30089 This modifier writes a message to a log file as soon as it is encountered when
30090 processing an ACL. (Compare &%log_message%&, which, except in the case of
30091 &%warn%& and &%discard%&, is used only if the ACL statement denies
30092 access.) The &%logwrite%& modifier can be used to log special incidents in
30093 ACLs. For example:
30094 .display
30095 &`accept `&<&'some special conditions'&>
30096 &`       control  = freeze`&
30097 &`       logwrite = froze message because ...`&
30098 .endd
30099 By default, the message is written to the main log. However, it may begin
30100 with a colon, followed by a comma-separated list of log names, and then
30101 another colon, to specify exactly which logs are to be written. For
30102 example:
30103 .code
30104 logwrite = :main,reject: text for main and reject logs
30105 logwrite = :panic: text for panic log only
30106 .endd
30107
30108
30109 .vitem &*message*&&~=&~<&'text'&>
30110 .cindex "&%message%& ACL modifier"
30111 This modifier sets up a text string that is expanded and used as a response
30112 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30113 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30114 there is some complication if &%endpass%& is involved; see the description of
30115 &%accept%& for details.)
30116
30117 The expansion of the message happens at the time Exim decides that the ACL is
30118 to end, not at the time it processes &%message%&. If the expansion fails, or
30119 generates an empty string, the modifier is ignored. Here is an example where
30120 &%message%& must be specified first, because the ACL ends with a rejection if
30121 the &%hosts%& condition fails:
30122 .code
30123 require  message = Host not recognized
30124          hosts = 10.0.0.0/8
30125 .endd
30126 (Once a condition has failed, no further conditions or modifiers are
30127 processed.)
30128
30129 .cindex "SMTP" "error codes"
30130 .oindex "&%smtp_banner%&
30131 For ACLs that are triggered by SMTP commands, the message is returned as part
30132 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30133 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30134 is accepted. In the case of the connect ACL, accepting with a message modifier
30135 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30136 accept message may not contain more than one line (otherwise it will be
30137 truncated at the first newline and a panic logged), and it cannot affect the
30138 EHLO options.
30139
30140 When SMTP is involved, the message may begin with an overriding response code,
30141 consisting of three digits optionally followed by an &"extended response code"&
30142 of the form &'n.n.n'&, each code being followed by a space. For example:
30143 .code
30144 deny  message = 599 1.2.3 Host not welcome
30145       hosts = 192.168.34.0/24
30146 .endd
30147 The first digit of the supplied response code must be the same as would be sent
30148 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30149 access, but for the predata ACL, note that the default success code is 354, not
30150 2&'xx'&.
30151
30152 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30153 the message modifier cannot override the 221 response code.
30154
30155 The text in a &%message%& modifier is literal; any quotes are taken as
30156 literals, but because the string is expanded, backslash escapes are processed
30157 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30158 response.
30159
30160 .vindex "&$acl_verify_message$&"
30161 For ACLs that are called by an &%acl =%& ACL condition, the message is
30162 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30163
30164 If &%message%& is used on a statement that verifies an address, the message
30165 specified overrides any message that is generated by the verification process.
30166 However, the original message is available in the variable
30167 &$acl_verify_message$&, so you can incorporate it into your message if you
30168 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30169 routers to be passed back as part of the SMTP response, you should either not
30170 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30171
30172 For compatibility with previous releases of Exim, a &%message%& modifier that
30173 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30174 modifier, but this usage is now deprecated. However, &%message%& acts only when
30175 all the conditions are true, wherever it appears in an ACL command, whereas
30176 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30177 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30178 effect.
30179
30180
30181 .vitem &*queue*&&~=&~<&'text'&>
30182 .cindex "&%queue%& ACL modifier"
30183 .cindex "named queues" "selecting in ACL"
30184 This modifier specifies the use of a named queue for spool files
30185 for the message.
30186 It can only be used before the message is received (i.e. not in
30187 the DATA ACL).
30188 This could be used, for example, for known high-volume burst sources
30189 of traffic, or for quarantine of messages.
30190 Separate queue-runner processes will be needed for named queues.
30191 If the text after expansion is empty, the default queue is used.
30192
30193
30194 .vitem &*remove_header*&&~=&~<&'text'&>
30195 This modifier specifies one or more header names in a colon-separated list
30196  that are to be removed from an incoming message, assuming, of course, that
30197 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30198
30199
30200 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30201 .cindex "&%set%& ACL modifier"
30202 This modifier puts a value into one of the ACL variables (see section
30203 &<<SECTaclvariables>>&).
30204
30205
30206 .vitem &*udpsend*&&~=&~<&'parameters'&>
30207 .cindex "UDP communications"
30208 This modifier sends a UDP packet, for purposes such as statistics
30209 collection or behaviour monitoring. The parameters are expanded, and
30210 the result of the expansion must be a colon-separated list consisting
30211 of a destination server, port number, and the packet contents. The
30212 server can be specified as a host name or IPv4 or IPv6 address. The
30213 separator can be changed with the usual angle bracket syntax. For
30214 example, you might want to collect information on which hosts connect
30215 when:
30216 .code
30217 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30218              $tod_zulu $sender_host_address
30219 .endd
30220 .endlist
30221
30222
30223
30224
30225 .section "Use of the control modifier" "SECTcontrols"
30226 .cindex "&%control%& ACL modifier"
30227 The &%control%& modifier supports the following settings:
30228
30229 .vlist
30230 .vitem &*control&~=&~allow_auth_unadvertised*&
30231 This modifier allows a client host to use the SMTP AUTH command even when it
30232 has not been advertised in response to EHLO. Furthermore, because there are
30233 apparently some really broken clients that do this, Exim will accept AUTH after
30234 HELO (rather than EHLO) when this control is set. It should be used only if you
30235 really need it, and you should limit its use to those broken clients that do
30236 not work without it. For example:
30237 .code
30238 warn hosts   = 192.168.34.25
30239      control = allow_auth_unadvertised
30240 .endd
30241 Normally, when an Exim server receives an AUTH command, it checks the name of
30242 the authentication mechanism that is given in the command to ensure that it
30243 matches an advertised mechanism. When this control is set, the check that a
30244 mechanism has been advertised is bypassed. Any configured mechanism can be used
30245 by the client. This control is permitted only in the connection and HELO ACLs.
30246
30247
30248 .vitem &*control&~=&~caseful_local_part*& &&&
30249        &*control&~=&~caselower_local_part*&
30250 .cindex "&ACL;" "case of local part in"
30251 .cindex "case of local parts"
30252 .vindex "&$local_part$&"
30253 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30254 (that is, during RCPT processing). By default, the contents of &$local_part$&
30255 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30256 any uppercase letters in the original local part are restored in &$local_part$&
30257 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30258 is encountered.
30259
30260 These controls affect only the current recipient. Moreover, they apply only to
30261 local part handling that takes place directly in the ACL (for example, as a key
30262 in lookups). If a test to verify the recipient is obeyed, the case-related
30263 handling of the local part during the verification is controlled by the router
30264 configuration (see the &%caseful_local_part%& generic router option).
30265
30266 This facility could be used, for example, to add a spam score to local parts
30267 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30268 spam score:
30269 .code
30270 warn  control = caseful_local_part
30271       set acl_m4 = ${eval:\
30272                      $acl_m4 + \
30273                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30274                     }
30275       control = caselower_local_part
30276 .endd
30277 Notice that we put back the lower cased version afterwards, assuming that
30278 is what is wanted for subsequent tests.
30279
30280
30281 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30282 .cindex "&ACL;" "cutthrough routing"
30283 .cindex "cutthrough" "requesting"
30284 This option requests delivery be attempted while the item is being received.
30285
30286 The option is usable in the RCPT ACL.
30287 If enabled for a message received via smtp and routed to an smtp transport,
30288 and only one transport, interface, destination host and port combination
30289 is used for all recipients of the message,
30290 then the delivery connection is made while the receiving connection is open
30291 and data is copied from one to the other.
30292
30293 An attempt to set this option for any recipient but the first
30294 for a mail will be quietly ignored.
30295 If a recipient-verify callout
30296 (with use_sender)
30297 connection is subsequently
30298 requested in the same ACL it is held open and used for
30299 any subsequent recipients and the data,
30300 otherwise one is made after the initial RCPT ACL completes.
30301
30302 Note that routers are used in verify mode,
30303 and cannot depend on content of received headers.
30304 Note also that headers cannot be
30305 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30306 Headers may be modified by routers (subject to the above) and transports.
30307 The &'Received-By:'& header is generated as soon as the body reception starts,
30308 rather than the traditional time after the full message is received;
30309 this will affect the timestamp.
30310
30311 All the usual ACLs are called; if one results in the message being
30312 rejected, all effort spent in delivery (including the costs on
30313 the ultimate destination) will be wasted.
30314 Note that in the case of data-time ACLs this includes the entire
30315 message body.
30316
30317 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30318 of outgoing messages is done, because it sends data to the ultimate destination
30319 before the entire message has been received from the source.
30320 It is not supported for messages received with the SMTP PRDR
30321 or CHUNKING
30322 options in use.
30323
30324 Should the ultimate destination system positively accept or reject the mail,
30325 a corresponding indication is given to the source system and nothing is queued.
30326 If the item is successfully delivered in cutthrough mode
30327 the delivery log lines are tagged with ">>" rather than "=>" and appear
30328 before the acceptance "<=" line.
30329
30330 If there is a temporary error the item is queued for later delivery in the
30331 usual fashion.
30332 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30333 to the control; the default value is &"spool"& and the alternate value
30334 &"pass"& copies an SMTP defer response from the target back to the initiator
30335 and does not queue the message.
30336 Note that this is independent of any recipient verify conditions in the ACL.
30337
30338 Delivery in this mode avoids the generation of a bounce mail to a
30339 (possibly faked)
30340 sender when the destination system is doing content-scan based rejection.
30341
30342
30343 .vitem &*control&~=&~debug/*&<&'options'&>
30344 .cindex "&ACL;" "enabling debug logging"
30345 .cindex "debugging" "enabling from an ACL"
30346 This control turns on debug logging, almost as though Exim had been invoked
30347 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30348 by default called &'debuglog'&.
30349 The filename can be adjusted with the &'tag'& option, which
30350 may access any variables already defined.  The logging may be adjusted with
30351 the &'opts'& option, which takes the same values as the &`-d`& command-line
30352 option.
30353 Logging started this way may be stopped, and the file removed,
30354 with the &'kill'& option.
30355 Some examples (which depend on variables that don't exist in all
30356 contexts):
30357 .code
30358       control = debug
30359       control = debug/tag=.$sender_host_address
30360       control = debug/opts=+expand+acl
30361       control = debug/tag=.$message_exim_id/opts=+expand
30362       control = debug/kill
30363 .endd
30364
30365
30366 .vitem &*control&~=&~dkim_disable_verify*&
30367 .cindex "disable DKIM verify"
30368 .cindex "DKIM" "disable verify"
30369 This control turns off DKIM verification processing entirely.  For details on
30370 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30371
30372
30373 .vitem &*control&~=&~dscp/*&<&'value'&>
30374 .cindex "&ACL;" "setting DSCP value"
30375 .cindex "DSCP" "inbound"
30376 This option causes the DSCP value associated with the socket for the inbound
30377 connection to be adjusted to a given value, given as one of a number of fixed
30378 strings or to numeric value.
30379 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30380 Common values include &`throughput`&, &`mincost`&, and on newer systems
30381 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30382
30383 The outbound packets from Exim will be marked with this value in the header
30384 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30385 that these values will have any effect, not be stripped by networking
30386 equipment, or do much of anything without cooperation with your Network
30387 Engineer and those of all network operators between the source and destination.
30388
30389
30390 .vitem &*control&~=&~enforce_sync*& &&&
30391        &*control&~=&~no_enforce_sync*&
30392 .cindex "SMTP" "synchronization checking"
30393 .cindex "synchronization checking in SMTP"
30394 These controls make it possible to be selective about when SMTP synchronization
30395 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30396 state of the switch (it is true by default). See the description of this option
30397 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30398
30399 The effect of these two controls lasts for the remainder of the SMTP
30400 connection. They can appear in any ACL except the one for the non-SMTP
30401 messages. The most straightforward place to put them is in the ACL defined by
30402 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30403 before the first synchronization check. The expected use is to turn off the
30404 synchronization checks for badly-behaved hosts that you nevertheless need to
30405 work with.
30406
30407
30408 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30409 .cindex "fake defer"
30410 .cindex "defer, fake"
30411 This control works in exactly the same way as &%fakereject%& (described below)
30412 except that it causes an SMTP 450 response after the message data instead of a
30413 550 response. You must take care when using &%fakedefer%& because it causes the
30414 messages to be duplicated when the sender retries. Therefore, you should not
30415 use &%fakedefer%& if the message is to be delivered normally.
30416
30417 .vitem &*control&~=&~fakereject/*&<&'message'&>
30418 .cindex "fake rejection"
30419 .cindex "rejection, fake"
30420 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30421 words, only when an SMTP message is being received. If Exim accepts the
30422 message, instead the final 250 response, a 550 rejection message is sent.
30423 However, Exim proceeds to deliver the message as normal. The control applies
30424 only to the current message, not to any subsequent ones that may be received in
30425 the same SMTP connection.
30426
30427 The text for the 550 response is taken from the &%control%& modifier. If no
30428 message is supplied, the following is used:
30429 .code
30430 550-Your message has been rejected but is being
30431 550-kept for evaluation.
30432 550-If it was a legitimate message, it may still be
30433 550 delivered to the target recipient(s).
30434 .endd
30435 This facility should be used with extreme caution.
30436
30437 .vitem &*control&~=&~freeze*&
30438 .cindex "frozen messages" "forcing in ACL"
30439 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30440 other words, only when a message is being received. If the message is accepted,
30441 it is placed on Exim's queue and frozen. The control applies only to the
30442 current message, not to any subsequent ones that may be received in the same
30443 SMTP connection.
30444
30445 This modifier can optionally be followed by &`/no_tell`&. If the global option
30446 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30447 is told about the freezing), provided all the &*control=freeze*& modifiers that
30448 are obeyed for the current message have the &`/no_tell`& option.
30449
30450 .vitem &*control&~=&~no_delay_flush*&
30451 .cindex "SMTP" "output flushing, disabling for delay"
30452 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30453 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30454 use. This control, as long as it is encountered before the &%delay%& modifier,
30455 disables such output flushing.
30456
30457 .vitem &*control&~=&~no_callout_flush*&
30458 .cindex "SMTP" "output flushing, disabling for callout"
30459 Exim normally flushes SMTP output before performing a callout in an ACL, to
30460 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30461 use. This control, as long as it is encountered before the &%verify%& condition
30462 that causes the callout, disables such output flushing.
30463
30464 .vitem &*control&~=&~no_mbox_unspool*&
30465 This control is available when Exim is compiled with the content scanning
30466 extension. Content scanning may require a copy of the current message, or parts
30467 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30468 or spam scanner. Normally, such copies are deleted when they are no longer
30469 needed. If this control is set, the copies are not deleted. The control applies
30470 only to the current message, not to any subsequent ones that may be received in
30471 the same SMTP connection. It is provided for debugging purposes and is unlikely
30472 to be useful in production.
30473
30474 .vitem &*control&~=&~no_multiline_responses*&
30475 .cindex "multiline responses, suppressing"
30476 This control is permitted for any ACL except the one for non-SMTP messages.
30477 It seems that there are broken clients in use that cannot handle multiline
30478 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30479
30480 If this control is set, multiline SMTP responses from ACL rejections are
30481 suppressed. One way of doing this would have been to put out these responses as
30482 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30483 (&"use multiline responses for more"& it says &-- ha!), and some of the
30484 responses might get close to that. So this facility, which is after all only a
30485 sop to broken clients, is implemented by doing two very easy things:
30486
30487 .ilist
30488 Extra information that is normally output as part of a rejection caused by
30489 sender verification failure is omitted. Only the final line (typically &"sender
30490 verification failed"&) is sent.
30491 .next
30492 If a &%message%& modifier supplies a multiline response, only the first
30493 line is output.
30494 .endlist
30495
30496 The setting of the switch can, of course, be made conditional on the
30497 calling host. Its effect lasts until the end of the SMTP connection.
30498
30499 .vitem &*control&~=&~no_pipelining*&
30500 .cindex "PIPELINING" "suppressing advertising"
30501 This control turns off the advertising of the PIPELINING extension to SMTP in
30502 the current session. To be useful, it must be obeyed before Exim sends its
30503 response to an EHLO command. Therefore, it should normally appear in an ACL
30504 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30505 &%pipelining_advertise_hosts%&.
30506
30507 .vitem &*control&~=&~queue_only*&
30508 .oindex "&%queue_only%&"
30509 .cindex "queueing incoming messages"
30510 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30511 other words, only when a message is being received. If the message is accepted,
30512 it is placed on Exim's queue and left there for delivery by a subsequent queue
30513 runner. No immediate delivery process is started. In other words, it has the
30514 effect as the &%queue_only%& global option. However, the control applies only
30515 to the current message, not to any subsequent ones that may be received in the
30516 same SMTP connection.
30517
30518 .vitem &*control&~=&~submission/*&<&'options'&>
30519 .cindex "message" "submission"
30520 .cindex "submission mode"
30521 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30522 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30523 the current message is a submission from a local MUA. In this case, Exim
30524 operates in &"submission mode"&, and applies certain fixups to the message if
30525 necessary. For example, it adds a &'Date:'& header line if one is not present.
30526 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30527 late (the message has already been created).
30528
30529 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30530 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30531 submission mode; the available options for this control are described there.
30532 The control applies only to the current message, not to any subsequent ones
30533 that may be received in the same SMTP connection.
30534
30535 .vitem &*control&~=&~suppress_local_fixups*&
30536 .cindex "submission fixups, suppressing"
30537 This control applies to locally submitted (non TCP/IP) messages, and is the
30538 complement of &`control = submission`&. It disables the fixups that are
30539 normally applied to locally-submitted messages. Specifically:
30540
30541 .ilist
30542 Any &'Sender:'& header line is left alone (in this respect, it is a
30543 dynamic version of &%local_sender_retain%&).
30544 .next
30545 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30546 .next
30547 There is no check that &'From:'& corresponds to the actual sender.
30548 .endlist ilist
30549
30550 This control may be useful when a remotely-originated message is accepted,
30551 passed to some scanning program, and then re-submitted for delivery. It can be
30552 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30553 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30554 data is read.
30555
30556 &*Note:*& This control applies only to the current message, not to any others
30557 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30558
30559 .vitem &*control&~=&~utf8_downconvert*&
30560 This control enables conversion of UTF-8 in message addresses
30561 to a-label form.
30562 For details see section &<<SECTi18nMTA>>&.
30563 .endlist vlist
30564
30565
30566 .section "Summary of message fixup control" "SECTsummesfix"
30567 All four possibilities for message fixups can be specified:
30568
30569 .ilist
30570 Locally submitted, fixups applied: the default.
30571 .next
30572 Locally submitted, no fixups applied: use
30573 &`control = suppress_local_fixups`&.
30574 .next
30575 Remotely submitted, no fixups applied: the default.
30576 .next
30577 Remotely submitted, fixups applied: use &`control = submission`&.
30578 .endlist
30579
30580
30581
30582 .section "Adding header lines in ACLs" "SECTaddheadacl"
30583 .cindex "header lines" "adding in an ACL"
30584 .cindex "header lines" "position of added lines"
30585 .cindex "&%add_header%& ACL modifier"
30586 The &%add_header%& modifier can be used to add one or more extra header lines
30587 to an incoming message, as in this example:
30588 .code
30589 warn dnslists = sbl.spamhaus.org : \
30590                 dialup.mail-abuse.org
30591      add_header = X-blacklisted-at: $dnslist_domain
30592 .endd
30593 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30594 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30595 receiving a message). The message must ultimately be accepted for
30596 &%add_header%& to have any significant effect. You can use &%add_header%& with
30597 any ACL verb, including &%deny%& (though this is potentially useful only in a
30598 RCPT ACL).
30599
30600 Headers will not be added to the message if the modifier is used in
30601 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30602
30603 Leading and trailing newlines are removed from
30604 the data for the &%add_header%& modifier; if it then
30605 contains one or more newlines that
30606 are not followed by a space or a tab, it is assumed to contain multiple header
30607 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30608 front of any line that is not a valid header line.
30609
30610 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30611 They are added to the message before processing the DATA and MIME ACLs.
30612 However, if an identical header line is requested more than once, only one copy
30613 is actually added to the message. Further header lines may be accumulated
30614 during the DATA and MIME ACLs, after which they are added to the message, again
30615 with duplicates suppressed. Thus, it is possible to add two identical header
30616 lines to an SMTP message, but only if one is added before DATA and one after.
30617 In the case of non-SMTP messages, new headers are accumulated during the
30618 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30619 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30620 are included in the entry that is written to the reject log.
30621
30622 .cindex "header lines" "added; visibility of"
30623 Header lines are not visible in string expansions
30624 of message headers
30625 until they are added to the
30626 message. It follows that header lines defined in the MAIL, RCPT, and predata
30627 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30628 header lines that are added by the DATA or MIME ACLs are not visible in those
30629 ACLs. Because of this restriction, you cannot use header lines as a way of
30630 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30631 this, you can use ACL variables, as described in section
30632 &<<SECTaclvariables>>&.
30633
30634 The list of headers yet to be added is given by the &%$headers_added%& variable.
30635
30636 The &%add_header%& modifier acts immediately as it is encountered during the
30637 processing of an ACL. Notice the difference between these two cases:
30638 .display
30639 &`accept add_header = ADDED: some text`&
30640 &`       `&<&'some condition'&>
30641
30642 &`accept `&<&'some condition'&>
30643 &`       add_header = ADDED: some text`&
30644 .endd
30645 In the first case, the header line is always added, whether or not the
30646 condition is true. In the second case, the header line is added only if the
30647 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30648 ACL statement. All those that are encountered before a condition fails are
30649 honoured.
30650
30651 .cindex "&%warn%& ACL verb"
30652 For compatibility with previous versions of Exim, a &%message%& modifier for a
30653 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30654 effect only if all the conditions are true, even if it appears before some of
30655 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30656 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30657 are present on a &%warn%& verb, both are processed according to their
30658 specifications.
30659
30660 By default, new header lines are added to a message at the end of the existing
30661 header lines. However, you can specify that any particular header line should
30662 be added right at the start (before all the &'Received:'& lines), immediately
30663 after the first block of &'Received:'& lines, or immediately before any line
30664 that is not a &'Received:'& or &'Resent-something:'& header.
30665
30666 This is done by specifying &":at_start:"&, &":after_received:"&, or
30667 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30668 header line, respectively. (Header text cannot start with a colon, as there has
30669 to be a header name first.) For example:
30670 .code
30671 warn add_header = \
30672        :after_received:X-My-Header: something or other...
30673 .endd
30674 If more than one header line is supplied in a single &%add_header%& modifier,
30675 each one is treated independently and can therefore be placed differently. If
30676 you add more than one line at the start, or after the Received: block, they end
30677 up in reverse order.
30678
30679 &*Warning*&: This facility currently applies only to header lines that are
30680 added in an ACL. It does NOT work for header lines that are added in a
30681 system filter or in a router or transport.
30682
30683
30684
30685 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30686 .cindex "header lines" "removing in an ACL"
30687 .cindex "header lines" "position of removed lines"
30688 .cindex "&%remove_header%& ACL modifier"
30689 The &%remove_header%& modifier can be used to remove one or more header lines
30690 from an incoming message, as in this example:
30691 .code
30692 warn   message        = Remove internal headers
30693        remove_header  = x-route-mail1 : x-route-mail2
30694 .endd
30695 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30696 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30697 receiving a message). The message must ultimately be accepted for
30698 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30699 with any ACL verb, including &%deny%&, though this is really not useful for
30700 any verb that doesn't result in a delivered message.
30701
30702 Headers will not be removed from the message if the modifier is used in
30703 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30704
30705 More than one header can be removed at the same time by using a colon separated
30706 list of header names. The header matching is case insensitive. Wildcards are
30707 not permitted, nor is list expansion performed, so you cannot use hostlists to
30708 create a list of headers, however both connection and message variable expansion
30709 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30710 .code
30711 warn   hosts           = +internal_hosts
30712        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30713 warn   message         = Remove internal headers
30714        remove_header   = $acl_c_ihdrs
30715 .endd
30716 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30717 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30718 If multiple header lines match, all are removed.
30719 There is no harm in attempting to remove the same header twice nor in removing
30720 a non-existent header. Further header lines to be removed may be accumulated
30721 during the DATA and MIME ACLs, after which they are removed from the message,
30722 if present. In the case of non-SMTP messages, headers to be removed are
30723 accumulated during the non-SMTP ACLs, and are removed from the message after
30724 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30725 ACL, there really is no effect because there is no logging of what headers
30726 would have been removed.
30727
30728 .cindex "header lines" "removed; visibility of"
30729 Header lines are not visible in string expansions until the DATA phase when it
30730 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30731 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30732 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30733 this restriction, you cannot use header lines as a way of controlling data
30734 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30735 you should instead use ACL variables, as described in section
30736 &<<SECTaclvariables>>&.
30737
30738 The &%remove_header%& modifier acts immediately as it is encountered during the
30739 processing of an ACL. Notice the difference between these two cases:
30740 .display
30741 &`accept remove_header = X-Internal`&
30742 &`       `&<&'some condition'&>
30743
30744 &`accept `&<&'some condition'&>
30745 &`       remove_header = X-Internal`&
30746 .endd
30747 In the first case, the header line is always removed, whether or not the
30748 condition is true. In the second case, the header line is removed only if the
30749 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30750 same ACL statement. All those that are encountered before a condition fails
30751 are honoured.
30752
30753 &*Warning*&: This facility currently applies only to header lines that are
30754 present during ACL processing. It does NOT remove header lines that are added
30755 in a system filter or in a router or transport.
30756
30757
30758
30759
30760 .section "ACL conditions" "SECTaclconditions"
30761 .cindex "&ACL;" "conditions; list of"
30762 Some of the conditions listed in this section are available only when Exim is
30763 compiled with the content-scanning extension. They are included here briefly
30764 for completeness. More detailed descriptions can be found in the discussion on
30765 content scanning in chapter &<<CHAPexiscan>>&.
30766
30767 Not all conditions are relevant in all circumstances. For example, testing
30768 senders and recipients does not make sense in an ACL that is being run as the
30769 result of the arrival of an ETRN command, and checks on message headers can be
30770 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30771 can use the same condition (with different parameters) more than once in the
30772 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30773 The conditions are as follows:
30774
30775
30776 .vlist
30777 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30778 .cindex "&ACL;" "nested"
30779 .cindex "&ACL;" "indirect"
30780 .cindex "&ACL;" "arguments"
30781 .cindex "&%acl%& ACL condition"
30782 The possible values of the argument are the same as for the
30783 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30784 &"accept"& the condition is true; if it returns &"deny"& the condition is
30785 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30786 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30787 condition false. This means that further processing of the &%warn%& verb
30788 ceases, but processing of the ACL continues.
30789
30790 If the argument is a named ACL, up to nine space-separated optional values
30791 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30792 and $acl_narg is set to the count of values.
30793 Previous values of these variables are restored after the call returns.
30794 The name and values are expanded separately.
30795 Note that spaces in complex expansions which are used as arguments
30796 will act as argument separators.
30797
30798 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30799 the connection is dropped. If it returns &"discard"&, the verb must be
30800 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30801 conditions are tested.
30802
30803 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30804 loops. This condition allows you to use different ACLs in different
30805 circumstances. For example, different ACLs can be used to handle RCPT commands
30806 for different local users or different local domains.
30807
30808 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30809 .cindex "&%authenticated%& ACL condition"
30810 .cindex "authentication" "ACL checking"
30811 .cindex "&ACL;" "testing for authentication"
30812 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30813 the name of the authenticator is tested against the list. To test for
30814 authentication by any authenticator, you can set
30815 .code
30816 authenticated = *
30817 .endd
30818
30819 .vitem &*condition&~=&~*&<&'string'&>
30820 .cindex "&%condition%& ACL condition"
30821 .cindex "customizing" "ACL condition"
30822 .cindex "&ACL;" "customized test"
30823 .cindex "&ACL;" "testing, customized"
30824 This feature allows you to make up custom conditions. If the result of
30825 expanding the string is an empty string, the number zero, or one of the strings
30826 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30827 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30828 any other value, some error is assumed to have occurred, and the ACL returns
30829 &"defer"&. However, if the expansion is forced to fail, the condition is
30830 ignored. The effect is to treat it as true, whether it is positive or
30831 negative.
30832
30833 .vitem &*decode&~=&~*&<&'location'&>
30834 .cindex "&%decode%& ACL condition"
30835 This condition is available only when Exim is compiled with the
30836 content-scanning extension, and it is allowed only in the ACL defined by
30837 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30838 If all goes well, the condition is true. It is false only if there are
30839 problems such as a syntax error or a memory shortage. For more details, see
30840 chapter &<<CHAPexiscan>>&.
30841
30842 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30843 .cindex "&%dnslists%& ACL condition"
30844 .cindex "DNS list" "in ACL"
30845 .cindex "black list (DNS)"
30846 .cindex "&ACL;" "testing a DNS list"
30847 This condition checks for entries in DNS black lists. These are also known as
30848 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30849 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30850 different variants of this condition to describe briefly here. See sections
30851 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30852
30853 .vitem &*domains&~=&~*&<&'domain&~list'&>
30854 .cindex "&%domains%& ACL condition"
30855 .cindex "domain" "ACL checking"
30856 .cindex "&ACL;" "testing a recipient domain"
30857 .vindex "&$domain_data$&"
30858 This condition is relevant only after a RCPT command. It checks that the domain
30859 of the recipient address is in the domain list. If percent-hack processing is
30860 enabled, it is done before this test is done. If the check succeeds with a
30861 lookup, the result of the lookup is placed in &$domain_data$& until the next
30862 &%domains%& test.
30863
30864 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30865 use &%domains%& in a DATA ACL.
30866
30867
30868 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30869 .cindex "&%encrypted%& ACL condition"
30870 .cindex "encryption" "checking in an ACL"
30871 .cindex "&ACL;" "testing for encryption"
30872 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30873 name of the cipher suite in use is tested against the list. To test for
30874 encryption without testing for any specific cipher suite(s), set
30875 .code
30876 encrypted = *
30877 .endd
30878
30879
30880 .vitem &*hosts&~=&~*&<&'host&~list'&>
30881 .cindex "&%hosts%& ACL condition"
30882 .cindex "host" "ACL checking"
30883 .cindex "&ACL;" "testing the client host"
30884 This condition tests that the calling host matches the host list. If you have
30885 name lookups or wildcarded host names and IP addresses in the same host list,
30886 you should normally put the IP addresses first. For example, you could have:
30887 .code
30888 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30889 .endd
30890 The lookup in this example uses the host name for its key. This is implied by
30891 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30892 and it wouldn't matter which way round you had these two items.)
30893
30894 The reason for the problem with host names lies in the left-to-right way that
30895 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30896 but when it reaches an item that requires a host name, it fails if it cannot
30897 find a host name to compare with the pattern. If the above list is given in the
30898 opposite order, the &%accept%& statement fails for a host whose name cannot be
30899 found, even if its IP address is 10.9.8.7.
30900
30901 If you really do want to do the name check first, and still recognize the IP
30902 address even if the name lookup fails, you can rewrite the ACL like this:
30903 .code
30904 accept hosts = dbm;/etc/friendly/hosts
30905 accept hosts = 10.9.8.7
30906 .endd
30907 The default action on failing to find the host name is to assume that the host
30908 is not in the list, so the first &%accept%& statement fails. The second
30909 statement can then check the IP address.
30910
30911 .vindex "&$host_data$&"
30912 If a &%hosts%& condition is satisfied by means of a lookup, the result
30913 of the lookup is made available in the &$host_data$& variable. This
30914 allows you, for example, to set up a statement like this:
30915 .code
30916 deny  hosts = net-lsearch;/some/file
30917 message = $host_data
30918 .endd
30919 which gives a custom error message for each denied host.
30920
30921 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30922 .cindex "&%local_parts%& ACL condition"
30923 .cindex "local part" "ACL checking"
30924 .cindex "&ACL;" "testing a local part"
30925 .vindex "&$local_part_data$&"
30926 This condition is relevant only after a RCPT command. It checks that the local
30927 part of the recipient address is in the list. If percent-hack processing is
30928 enabled, it is done before this test. If the check succeeds with a lookup, the
30929 result of the lookup is placed in &$local_part_data$&, which remains set until
30930 the next &%local_parts%& test.
30931
30932 .vitem &*malware&~=&~*&<&'option'&>
30933 .cindex "&%malware%& ACL condition"
30934 .cindex "&ACL;" "virus scanning"
30935 .cindex "&ACL;" "scanning for viruses"
30936 This condition is available only when Exim is compiled with the
30937 content-scanning extension
30938 and only after a DATA command.
30939 It causes the incoming message to be scanned for
30940 viruses. For details, see chapter &<<CHAPexiscan>>&.
30941
30942 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30943 .cindex "&%mime_regex%& ACL condition"
30944 .cindex "&ACL;" "testing by regex matching"
30945 This condition is available only when Exim is compiled with the
30946 content-scanning extension, and it is allowed only in the ACL defined by
30947 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30948 with any of the regular expressions. For details, see chapter
30949 &<<CHAPexiscan>>&.
30950
30951 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30952 .cindex "rate limiting"
30953 This condition can be used to limit the rate at which a user or host submits
30954 messages. Details are given in section &<<SECTratelimiting>>&.
30955
30956 .vitem &*recipients&~=&~*&<&'address&~list'&>
30957 .cindex "&%recipients%& ACL condition"
30958 .cindex "recipient" "ACL checking"
30959 .cindex "&ACL;" "testing a recipient"
30960 This condition is relevant only after a RCPT command. It checks the entire
30961 recipient address against a list of recipients.
30962
30963 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30964 .cindex "&%regex%& ACL condition"
30965 .cindex "&ACL;" "testing by regex matching"
30966 This condition is available only when Exim is compiled with the
30967 content-scanning extension, and is available only in the DATA, MIME, and
30968 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30969 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30970
30971 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30972 .cindex "&%sender_domains%& ACL condition"
30973 .cindex "sender" "ACL checking"
30974 .cindex "&ACL;" "testing a sender domain"
30975 .vindex "&$domain$&"
30976 .vindex "&$sender_address_domain$&"
30977 This condition tests the domain of the sender of the message against the given
30978 domain list. &*Note*&: The domain of the sender address is in
30979 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30980 of this condition. This is an exception to the general rule for testing domain
30981 lists. It is done this way so that, if this condition is used in an ACL for a
30982 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30983 influence the sender checking.
30984
30985 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30986 relaying, because sender addresses are easily, and commonly, forged.
30987
30988 .vitem &*senders&~=&~*&<&'address&~list'&>
30989 .cindex "&%senders%& ACL condition"
30990 .cindex "sender" "ACL checking"
30991 .cindex "&ACL;" "testing a sender"
30992 This condition tests the sender of the message against the given list. To test
30993 for a bounce message, which has an empty sender, set
30994 .code
30995 senders = :
30996 .endd
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 &*spam&~=&~*&<&'username'&>
31001 .cindex "&%spam%& ACL condition"
31002 .cindex "&ACL;" "scanning for spam"
31003 This condition is available only when Exim is compiled with the
31004 content-scanning extension. It causes the incoming message to be scanned by
31005 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31006
31007 .vitem &*verify&~=&~certificate*&
31008 .cindex "&%verify%& ACL condition"
31009 .cindex "TLS" "client certificate verification"
31010 .cindex "certificate" "verification of client"
31011 .cindex "&ACL;" "certificate verification"
31012 .cindex "&ACL;" "testing a TLS certificate"
31013 This condition is true in an SMTP session if the session is encrypted, and a
31014 certificate was received from the client, and the certificate was verified. The
31015 server requests a certificate only if the client matches &%tls_verify_hosts%&
31016 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31017
31018 .vitem &*verify&~=&~csa*&
31019 .cindex "CSA verification"
31020 This condition checks whether the sending host (the client) is authorized to
31021 send email. Details of how this works are given in section
31022 &<<SECTverifyCSA>>&.
31023
31024 .vitem &*verify&~=&~header_names_ascii*&
31025 .cindex "&%verify%& ACL condition"
31026 .cindex "&ACL;" "verifying header names only ASCII"
31027 .cindex "header lines" "verifying header names only ASCII"
31028 .cindex "verifying" "header names only ASCII"
31029 This condition is relevant only in an ACL that is run after a message has been
31030 received, that is, in an ACL specified by &%acl_smtp_data%& or
31031 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31032 there are no non-ASCII characters, also excluding control characters.  The
31033 allowable characters are decimal ASCII values 33 through 126.
31034
31035 Exim itself will handle headers with non-ASCII characters, but it can cause
31036 problems for downstream applications, so this option will allow their
31037 detection and rejection in the DATA ACL's.
31038
31039 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31040 .cindex "&%verify%& ACL condition"
31041 .cindex "&ACL;" "verifying sender in the header"
31042 .cindex "header lines" "verifying the sender in"
31043 .cindex "sender" "verifying in header"
31044 .cindex "verifying" "sender in header"
31045 This condition is relevant only in an ACL that is run after a message has been
31046 received, that is, in an ACL specified by &%acl_smtp_data%& or
31047 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31048 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31049 is loosely thought of as a &"sender"& address (hence the name of the test).
31050 However, an address that appears in one of these headers need not be an address
31051 that accepts bounce messages; only sender addresses in envelopes are required
31052 to accept bounces. Therefore, if you use the callout option on this check, you
31053 might want to arrange for a non-empty address in the MAIL command.
31054
31055 Details of address verification and the options are given later, starting at
31056 section &<<SECTaddressverification>>& (callouts are described in section
31057 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31058 condition to restrict it to bounce messages only:
31059 .code
31060 deny    senders = :
31061         message = A valid sender header is required for bounces
31062        !verify  = header_sender
31063 .endd
31064
31065 .vitem &*verify&~=&~header_syntax*&
31066 .cindex "&%verify%& ACL condition"
31067 .cindex "&ACL;" "verifying header syntax"
31068 .cindex "header lines" "verifying syntax"
31069 .cindex "verifying" "header syntax"
31070 This condition is relevant only in an ACL that is run after a message has been
31071 received, that is, in an ACL specified by &%acl_smtp_data%& or
31072 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31073 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31074 and &'Bcc:'&), returning true if there are no problems.
31075 Unqualified addresses (local parts without domains) are
31076 permitted only in locally generated messages and from hosts that match
31077 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31078 appropriate.
31079
31080 Note that this condition is a syntax check only. However, a common spamming
31081 ploy used to be to send syntactically invalid headers such as
31082 .code
31083 To: @
31084 .endd
31085 and this condition can be used to reject such messages, though they are not as
31086 common as they used to be.
31087
31088 .vitem &*verify&~=&~helo*&
31089 .cindex "&%verify%& ACL condition"
31090 .cindex "&ACL;" "verifying HELO/EHLO"
31091 .cindex "HELO" "verifying"
31092 .cindex "EHLO" "verifying"
31093 .cindex "verifying" "EHLO"
31094 .cindex "verifying" "HELO"
31095 This condition is true if a HELO or EHLO command has been received from the
31096 client host, and its contents have been verified. If there has been no previous
31097 attempt to verify the HELO/EHLO contents, it is carried out when this
31098 condition is encountered. See the description of the &%helo_verify_hosts%& and
31099 &%helo_try_verify_hosts%& options for details of how to request verification
31100 independently of this condition, and for detail of the verification.
31101
31102 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31103 option), this condition is always true.
31104
31105
31106 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31107 .cindex "verifying" "not blind"
31108 .cindex "bcc recipients, verifying none"
31109 This condition checks that there are no blind (bcc) recipients in the message.
31110 Every envelope recipient must appear either in a &'To:'& header line or in a
31111 &'Cc:'& header line for this condition to be true. Local parts are checked
31112 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31113 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31114 used only in a DATA or non-SMTP ACL.
31115
31116 .new
31117 There is one possible option, &`case_insensitive`&.  If this is present then
31118 local parts are checked case-insensitively.
31119 .wen
31120
31121 There are, of course, many legitimate messages that make use of blind (bcc)
31122 recipients. This check should not be used on its own for blocking messages.
31123
31124
31125 .vitem &*verify&~=&~recipient/*&<&'options'&>
31126 .cindex "&%verify%& ACL condition"
31127 .cindex "&ACL;" "verifying recipient"
31128 .cindex "recipient" "verifying"
31129 .cindex "verifying" "recipient"
31130 .vindex "&$address_data$&"
31131 This condition is relevant only after a RCPT command. It verifies the current
31132 recipient. Details of address verification are given later, starting at section
31133 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31134 of &$address_data$& is the last value that was set while routing the address.
31135 This applies even if the verification fails. When an address that is being
31136 verified is redirected to a single address, verification continues with the new
31137 address, and in that case, the subsequent value of &$address_data$& is the
31138 value for the child address.
31139
31140 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31141 .cindex "&%verify%& ACL condition"
31142 .cindex "&ACL;" "verifying host reverse lookup"
31143 .cindex "host" "verifying reverse lookup"
31144 This condition ensures that a verified host name has been looked up from the IP
31145 address of the client host. (This may have happened already if the host name
31146 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31147 Verification ensures that the host name obtained from a reverse DNS lookup, or
31148 one of its aliases, does, when it is itself looked up in the DNS, yield the
31149 original IP address.
31150
31151 There is one possible option, &`defer_ok`&.  If this is present and a
31152 DNS operation returns a temporary error, the verify condition succeeds.
31153
31154 If this condition is used for a locally generated message (that is, when there
31155 is no client host involved), it always succeeds.
31156
31157 .vitem &*verify&~=&~sender/*&<&'options'&>
31158 .cindex "&%verify%& ACL condition"
31159 .cindex "&ACL;" "verifying sender"
31160 .cindex "sender" "verifying"
31161 .cindex "verifying" "sender"
31162 This condition is relevant only after a MAIL or RCPT command, or after a
31163 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31164 the message's sender is empty (that is, this is a bounce message), the
31165 condition is true. Otherwise, the sender address is verified.
31166
31167 .vindex "&$address_data$&"
31168 .vindex "&$sender_address_data$&"
31169 If there is data in the &$address_data$& variable at the end of routing, its
31170 value is placed in &$sender_address_data$& at the end of verification. This
31171 value can be used in subsequent conditions and modifiers in the same ACL
31172 statement. It does not persist after the end of the current statement. If you
31173 want to preserve the value for longer, you can save it in an ACL variable.
31174
31175 Details of verification are given later, starting at section
31176 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31177 to avoid doing it more than once per message.
31178
31179 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31180 .cindex "&%verify%& ACL condition"
31181 This is a variation of the previous option, in which a modified address is
31182 verified as a sender.
31183
31184 Note that '/' is legal in local-parts; if the address may have such
31185 (eg. is generated from the received message)
31186 they must be protected from the options parsing by doubling:
31187 .code
31188 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31189 .endd
31190 .endlist
31191
31192
31193
31194 .section "Using DNS lists" "SECTmorednslists"
31195 .cindex "DNS list" "in ACL"
31196 .cindex "black list (DNS)"
31197 .cindex "&ACL;" "testing a DNS list"
31198 In its simplest form, the &%dnslists%& condition tests whether the calling host
31199 is on at least one of a number of DNS lists by looking up the inverted IP
31200 address in one or more DNS domains. (Note that DNS list domains are not mail
31201 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31202 special options instead.) For example, if the calling host's IP
31203 address is 192.168.62.43, and the ACL statement is
31204 .code
31205 deny dnslists = blackholes.mail-abuse.org : \
31206                 dialups.mail-abuse.org
31207 .endd
31208 the following records are looked up:
31209 .code
31210 43.62.168.192.blackholes.mail-abuse.org
31211 43.62.168.192.dialups.mail-abuse.org
31212 .endd
31213 As soon as Exim finds an existing DNS record, processing of the list stops.
31214 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31215 to test that a host is on more than one list (an &"and"& conjunction), you can
31216 use two separate conditions:
31217 .code
31218 deny dnslists = blackholes.mail-abuse.org
31219      dnslists = dialups.mail-abuse.org
31220 .endd
31221 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31222 behaves as if the host does not match the list item, that is, as if the DNS
31223 record does not exist. If there are further items in the DNS list, they are
31224 processed.
31225
31226 This is usually the required action when &%dnslists%& is used with &%deny%&
31227 (which is the most common usage), because it prevents a DNS failure from
31228 blocking mail. However, you can change this behaviour by putting one of the
31229 following special items in the list:
31230 .display
31231 &`+include_unknown `&   behave as if the item is on the list
31232 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31233 &`+defer_unknown   `&   give a temporary error
31234 .endd
31235 .cindex "&`+include_unknown`&"
31236 .cindex "&`+exclude_unknown`&"
31237 .cindex "&`+defer_unknown`&"
31238 Each of these applies to any subsequent items on the list. For example:
31239 .code
31240 deny dnslists = +defer_unknown : foo.bar.example
31241 .endd
31242 Testing the list of domains stops as soon as a match is found. If you want to
31243 warn for one list and block for another, you can use two different statements:
31244 .code
31245 deny  dnslists = blackholes.mail-abuse.org
31246 warn  message  = X-Warn: sending host is on dialups list
31247       dnslists = dialups.mail-abuse.org
31248 .endd
31249 .cindex caching "of dns lookup"
31250 .cindex DNS TTL
31251 DNS list lookups are cached by Exim for the duration of the SMTP session
31252 (but limited by the DNS return TTL value),
31253 so a lookup based on the IP address is done at most once for any incoming
31254 connection (assuming long-enough TTL).
31255 Exim does not share information between multiple incoming
31256 connections (but your local name server cache should be active).
31257
31258 There are a number of DNS lists to choose from, some commercial, some free,
31259 or free for small deployments.  An overview can be found at
31260 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31261
31262
31263
31264 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31265 .cindex "DNS list" "keyed by explicit IP address"
31266 By default, the IP address that is used in a DNS list lookup is the IP address
31267 of the calling host. However, you can specify another IP address by listing it
31268 after the domain name, introduced by a slash. For example:
31269 .code
31270 deny dnslists = black.list.tld/192.168.1.2
31271 .endd
31272 This feature is not very helpful with explicit IP addresses; it is intended for
31273 use with IP addresses that are looked up, for example, the IP addresses of the
31274 MX hosts or nameservers of an email sender address. For an example, see section
31275 &<<SECTmulkeyfor>>& below.
31276
31277
31278
31279
31280 .section "DNS lists keyed on domain names" "SECID202"
31281 .cindex "DNS list" "keyed by domain name"
31282 There are some lists that are keyed on domain names rather than inverted IP
31283 addresses (see, e.g., the &'domain based zones'& link at
31284 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31285 with these lists. You can change the name that is looked up in a DNS list by
31286 listing it after the domain name, introduced by a slash. For example,
31287 .code
31288 deny  message  = Sender's domain is listed at $dnslist_domain
31289       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31290 .endd
31291 This particular example is useful only in ACLs that are obeyed after the
31292 RCPT or DATA commands, when a sender address is available. If (for
31293 example) the message's sender is &'user@tld.example'& the name that is looked
31294 up by this example is
31295 .code
31296 tld.example.dsn.rfc-ignorant.org
31297 .endd
31298 A single &%dnslists%& condition can contain entries for both names and IP
31299 addresses. For example:
31300 .code
31301 deny dnslists = sbl.spamhaus.org : \
31302                 dsn.rfc-ignorant.org/$sender_address_domain
31303 .endd
31304 The first item checks the sending host's IP address; the second checks a domain
31305 name. The whole condition is true if either of the DNS lookups succeeds.
31306
31307
31308
31309
31310 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31311 .cindex "DNS list" "multiple keys for"
31312 The syntax described above for looking up explicitly-defined values (either
31313 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31314 name for the DNS list, what follows the slash can in fact be a list of items.
31315 As with all lists in Exim, the default separator is a colon. However, because
31316 this is a sublist within the list of DNS blacklist domains, it is necessary
31317 either to double the separators like this:
31318 .code
31319 dnslists = black.list.tld/name.1::name.2
31320 .endd
31321 or to change the separator character, like this:
31322 .code
31323 dnslists = black.list.tld/<;name.1;name.2
31324 .endd
31325 If an item in the list is an IP address, it is inverted before the DNS
31326 blacklist domain is appended. If it is not an IP address, no inversion
31327 occurs. Consider this condition:
31328 .code
31329 dnslists = black.list.tld/<;192.168.1.2;a.domain
31330 .endd
31331 The DNS lookups that occur are:
31332 .code
31333 2.1.168.192.black.list.tld
31334 a.domain.black.list.tld
31335 .endd
31336 Once a DNS record has been found (that matches a specific IP return
31337 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31338 are done. If there is a temporary DNS error, the rest of the sublist of domains
31339 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31340 only if no other DNS lookup in this sublist succeeds. In other words, a
31341 successful lookup for any of the items in the sublist overrides a temporary
31342 error for a previous item.
31343
31344 The ability to supply a list of items after the slash is in some sense just a
31345 syntactic convenience. These two examples have the same effect:
31346 .code
31347 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31348 dnslists = black.list.tld/a.domain::b.domain
31349 .endd
31350 However, when the data for the list is obtained from a lookup, the second form
31351 is usually much more convenient. Consider this example:
31352 .code
31353 deny message  = The mail servers for the domain \
31354                 $sender_address_domain \
31355                 are listed at $dnslist_domain ($dnslist_value); \
31356                 see $dnslist_text.
31357      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31358                                    ${lookup dnsdb {>|mxh=\
31359                                    $sender_address_domain} }} }
31360 .endd
31361 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31362 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31363 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31364 of expanding the condition might be something like this:
31365 .code
31366 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31367 .endd
31368 Thus, this example checks whether or not the IP addresses of the sender
31369 domain's mail servers are on the Spamhaus black list.
31370
31371 The key that was used for a successful DNS list lookup is put into the variable
31372 &$dnslist_matched$& (see section &<<SECID204>>&).
31373
31374
31375
31376
31377 .section "Data returned by DNS lists" "SECID203"
31378 .cindex "DNS list" "data returned from"
31379 DNS lists are constructed using address records in the DNS. The original RBL
31380 just used the address 127.0.0.1 on the right hand side of each record, but the
31381 RBL+ list and some other lists use a number of values with different meanings.
31382 The values used on the RBL+ list are:
31383 .display
31384 127.1.0.1  RBL
31385 127.1.0.2  DUL
31386 127.1.0.3  DUL and RBL
31387 127.1.0.4  RSS
31388 127.1.0.5  RSS and RBL
31389 127.1.0.6  RSS and DUL
31390 127.1.0.7  RSS and DUL and RBL
31391 .endd
31392 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31393 different values. Some DNS lists may return more than one address record;
31394 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31395
31396
31397 .section "Variables set from DNS lists" "SECID204"
31398 .cindex "expansion" "variables, set from DNS list"
31399 .cindex "DNS list" "variables set from"
31400 .vindex "&$dnslist_domain$&"
31401 .vindex "&$dnslist_matched$&"
31402 .vindex "&$dnslist_text$&"
31403 .vindex "&$dnslist_value$&"
31404 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31405 the name of the overall domain that matched (for example,
31406 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31407 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31408 the DNS record. When the key is an IP address, it is not reversed in
31409 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31410 cases, for example:
31411 .code
31412 deny dnslists = spamhaus.example
31413 .endd
31414 the key is also available in another variable (in this case,
31415 &$sender_host_address$&). In more complicated cases, however, this is not true.
31416 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31417 might generate a dnslists lookup like this:
31418 .code
31419 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31420 .endd
31421 If this condition succeeds, the value in &$dnslist_matched$& might be
31422 &`192.168.6.7`& (for example).
31423
31424 If more than one address record is returned by the DNS lookup, all the IP
31425 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31426 The variable &$dnslist_text$& contains the contents of any associated TXT
31427 record. For lists such as RBL+ the TXT record for a merged entry is often not
31428 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31429 information.
31430
31431 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31432 &-- although these appear before the condition in the ACL, they are not
31433 expanded until after it has failed. For example:
31434 .code
31435 deny    hosts = !+local_networks
31436         message = $sender_host_address is listed \
31437                   at $dnslist_domain
31438         dnslists = rbl-plus.mail-abuse.example
31439 .endd
31440
31441
31442
31443 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31444 .cindex "DNS list" "matching specific returned data"
31445 You can add an equals sign and an IP address after a &%dnslists%& domain name
31446 in order to restrict its action to DNS records with a matching right hand side.
31447 For example,
31448 .code
31449 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31450 .endd
31451 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31452 any address record is considered to be a match. For the moment, we assume
31453 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31454 describes how multiple records are handled.
31455
31456 More than one IP address may be given for checking, using a comma as a
31457 separator. These are alternatives &-- if any one of them matches, the
31458 &%dnslists%& condition is true. For example:
31459 .code
31460 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31461 .endd
31462 If you want to specify a constraining address list and also specify names or IP
31463 addresses to be looked up, the constraining address list must be specified
31464 first. For example:
31465 .code
31466 deny dnslists = dsn.rfc-ignorant.org\
31467                 =127.0.0.2/$sender_address_domain
31468 .endd
31469
31470 If the character &`&&`& is used instead of &`=`&, the comparison for each
31471 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31472 In other words, the listed addresses are used as bit masks. The comparison is
31473 true if all the bits in the mask are present in the address that is being
31474 tested. For example:
31475 .code
31476 dnslists = a.b.c&0.0.0.3
31477 .endd
31478 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31479 want to test whether one bit or another bit is present (as opposed to both
31480 being present), you must use multiple values. For example:
31481 .code
31482 dnslists = a.b.c&0.0.0.1,0.0.0.2
31483 .endd
31484 matches if the final component of the address is an odd number or two times
31485 an odd number.
31486
31487
31488
31489 .section "Negated DNS matching conditions" "SECID205"
31490 You can supply a negative list of IP addresses as part of a &%dnslists%&
31491 condition. Whereas
31492 .code
31493 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31494 .endd
31495 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31496 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31497 .code
31498 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31499 .endd
31500 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31501 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31502 words, the result of the test is inverted if an exclamation mark appears before
31503 the &`=`& (or the &`&&`&) sign.
31504
31505 &*Note*&: This kind of negation is not the same as negation in a domain,
31506 host, or address list (which is why the syntax is different).
31507
31508 If you are using just one list, the negation syntax does not gain you much. The
31509 previous example is precisely equivalent to
31510 .code
31511 deny  dnslists = a.b.c
31512      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31513 .endd
31514 However, if you are using multiple lists, the negation syntax is clearer.
31515 Consider this example:
31516 .code
31517 deny  dnslists = sbl.spamhaus.org : \
31518                  list.dsbl.org : \
31519                  dnsbl.njabl.org!=127.0.0.3 : \
31520                  relays.ordb.org
31521 .endd
31522 Using only positive lists, this would have to be:
31523 .code
31524 deny  dnslists = sbl.spamhaus.org : \
31525                  list.dsbl.org
31526 deny  dnslists = dnsbl.njabl.org
31527      !dnslists = dnsbl.njabl.org=127.0.0.3
31528 deny  dnslists = relays.ordb.org
31529 .endd
31530 which is less clear, and harder to maintain.
31531
31532
31533
31534
31535 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31536 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31537 thereby providing more than one IP address. When an item in a &%dnslists%& list
31538 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31539 the match to specific results from the DNS lookup, there are two ways in which
31540 the checking can be handled. For example, consider the condition:
31541 .code
31542 dnslists = a.b.c=127.0.0.1
31543 .endd
31544 What happens if the DNS lookup for the incoming IP address yields both
31545 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31546 condition true because at least one given value was found, or is it false
31547 because at least one of the found values was not listed? And how does this
31548 affect negated conditions? Both possibilities are provided for with the help of
31549 additional separators &`==`& and &`=&&`&.
31550
31551 .ilist
31552 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31553 IP addresses matches one of the listed addresses. For the example above, the
31554 condition is true because 127.0.0.1 matches.
31555 .next
31556 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31557 looked up IP addresses matches one of the listed addresses. If the condition is
31558 changed to:
31559 .code
31560 dnslists = a.b.c==127.0.0.1
31561 .endd
31562 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31563 false because 127.0.0.2 is not listed. You would need to have:
31564 .code
31565 dnslists = a.b.c==127.0.0.1,127.0.0.2
31566 .endd
31567 for the condition to be true.
31568 .endlist
31569
31570 When &`!`& is used to negate IP address matching, it inverts the result, giving
31571 the precise opposite of the behaviour above. Thus:
31572 .ilist
31573 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31574 addresses matches one of the listed addresses. Consider:
31575 .code
31576 dnslists = a.b.c!&0.0.0.1
31577 .endd
31578 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31579 false because 127.0.0.1 matches.
31580 .next
31581 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31582 looked up IP address that does not match. Consider:
31583 .code
31584 dnslists = a.b.c!=&0.0.0.1
31585 .endd
31586 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31587 true, because 127.0.0.2 does not match. You would need to have:
31588 .code
31589 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31590 .endd
31591 for the condition to be false.
31592 .endlist
31593 When the DNS lookup yields only a single IP address, there is no difference
31594 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31595
31596
31597
31598
31599 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31600 .cindex "DNS list" "information from merged"
31601 When the facility for restricting the matching IP values in a DNS list is used,
31602 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31603 the true reason for rejection. This happens when lists are merged and the IP
31604 address in the A record is used to distinguish them; unfortunately there is
31605 only one TXT record. One way round this is not to use merged lists, but that
31606 can be inefficient because it requires multiple DNS lookups where one would do
31607 in the vast majority of cases when the host of interest is not on any of the
31608 lists.
31609
31610 A less inefficient way of solving this problem is available. If
31611 two domain names, comma-separated, are given, the second is used first to
31612 do an initial check, making use of any IP value restrictions that are set.
31613 If there is a match, the first domain is used, without any IP value
31614 restrictions, to get the TXT record. As a byproduct of this, there is also
31615 a check that the IP being tested is indeed on the first list. The first
31616 domain is the one that is put in &$dnslist_domain$&. For example:
31617 .code
31618 deny message  = \
31619          rejected because $sender_host_address is blacklisted \
31620          at $dnslist_domain\n$dnslist_text
31621        dnslists = \
31622          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31623          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31624 .endd
31625 For the first blacklist item, this starts by doing a lookup in
31626 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31627 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31628 value, and as long as something is found, it looks for the corresponding TXT
31629 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31630 The second blacklist item is processed similarly.
31631
31632 If you are interested in more than one merged list, the same list must be
31633 given several times, but because the results of the DNS lookups are cached,
31634 the DNS calls themselves are not repeated. For example:
31635 .code
31636 deny dnslists = \
31637          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31638          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31639          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31640          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31641 .endd
31642 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31643 values matches (or if no record is found), this is the only lookup that is
31644 done. Only if there is a match is one of the more specific lists consulted.
31645
31646
31647
31648 .section "DNS lists and IPv6" "SECTmorednslistslast"
31649 .cindex "IPv6" "DNS black lists"
31650 .cindex "DNS list" "IPv6 usage"
31651 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31652 nibble by nibble. For example, if the calling host's IP address is
31653 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31654 .code
31655 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31656   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31657 .endd
31658 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31659 lists contain wildcard records, intended for IPv4, that interact badly with
31660 IPv6. For example, the DNS entry
31661 .code
31662 *.3.some.list.example.    A    127.0.0.1
31663 .endd
31664 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31665 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31666
31667 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31668 &%condition%& condition, as in this example:
31669 .code
31670 deny   condition = ${if isip4{$sender_host_address}}
31671        dnslists  = some.list.example
31672 .endd
31673
31674 If an explicit key is being used for a DNS lookup and it may be an IPv6
31675 address you should specify alternate list separators for both the outer
31676 (DNS list name) list and inner (lookup keys) list:
31677 .code
31678        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31679 .endd
31680
31681 .section "Rate limiting incoming messages" "SECTratelimiting"
31682 .cindex "rate limiting" "client sending"
31683 .cindex "limiting client sending rates"
31684 .oindex "&%smtp_ratelimit_*%&"
31685 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31686 which clients can send email. This is more powerful than the
31687 &%smtp_ratelimit_*%& options, because those options control the rate of
31688 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31689 works across all connections (concurrent and sequential) from the same client
31690 host. The syntax of the &%ratelimit%& condition is:
31691 .display
31692 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31693 .endd
31694 If the average client sending rate is less than &'m'& messages per time
31695 period &'p'& then the condition is false; otherwise it is true.
31696
31697 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31698 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31699 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31700 of &'p'&.
31701
31702 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31703 time interval, for example, &`8h`& for eight hours. A larger time constant
31704 means that it takes Exim longer to forget a client's past behaviour. The
31705 parameter &'m'& is the maximum number of messages that a client is permitted to
31706 send in each time interval. It also specifies the number of messages permitted
31707 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31708 constant, you can allow a client to send more messages in a burst without
31709 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31710 both small, messages must be sent at an even rate.
31711
31712 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31713 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31714 when deploying the &%ratelimit%& ACL condition. The script prints usage
31715 instructions when it is run with no arguments.
31716
31717 The key is used to look up the data for calculating the client's average
31718 sending rate. This data is stored in Exim's spool directory, alongside the
31719 retry and other hints databases. The default key is &$sender_host_address$&,
31720 which means Exim computes the sending rate of each client host IP address.
31721 By changing the key you can change how Exim identifies clients for the purpose
31722 of ratelimiting. For example, to limit the sending rate of each authenticated
31723 user, independent of the computer they are sending from, set the key to
31724 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31725 example, &$authenticated_id$& is only meaningful if the client has
31726 authenticated (which you can check with the &%authenticated%& ACL condition).
31727
31728 The lookup key does not have to identify clients: If you want to limit the
31729 rate at which a recipient receives messages, you can use the key
31730 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31731 ACL.
31732
31733 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31734 specifies what Exim measures the rate of, for example, messages or recipients
31735 or bytes. You can adjust the measurement using the &%unique=%& and/or
31736 &%count=%& options. You can also control when Exim updates the recorded rate
31737 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31738 separated by a slash, like the other parameters. They may appear in any order.
31739
31740 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31741 any options that alter the meaning of the stored data. The limit &'m'& is not
31742 stored, so you can alter the configured maximum rate and Exim will still
31743 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31744 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31745 behaviour. The lookup key is not affected by changes to the update mode and
31746 the &%count=%& option.
31747
31748
31749 .section "Ratelimit options for what is being measured" "ratoptmea"
31750 .cindex "rate limiting" "per_* options"
31751 The &%per_conn%& option limits the client's connection rate. It is not
31752 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31753 &%acl_not_smtp_start%& ACLs.
31754
31755 The &%per_mail%& option limits the client's rate of sending messages. This is
31756 the default if none of the &%per_*%& options is specified. It can be used in
31757 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31758 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31759
31760 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31761 the same ACLs as the &%per_mail%& option, though it is best to use this option
31762 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31763 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31764 in its MAIL command, which may be inaccurate or completely missing. You can
31765 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31766 in kilobytes, megabytes, or gigabytes, respectively.
31767
31768 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31769 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31770 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31771 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31772 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31773 in either case the rate limiting engine will see a message with many
31774 recipients as a large high-speed burst.
31775
31776 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31777 number of different recipients that the client has sent messages to in the
31778 last time period. That is, if the client repeatedly sends messages to the same
31779 recipient, its measured rate is not increased. This option can only be used in
31780 &%acl_smtp_rcpt%&.
31781
31782 The &%per_cmd%& option causes Exim to recompute the rate every time the
31783 condition is processed. This can be used to limit the rate of any SMTP
31784 command. If it is used in multiple ACLs it can limit the aggregate rate of
31785 multiple different commands.
31786
31787 The &%count=%& option can be used to alter how much Exim adds to the client's
31788 measured rate. For example, the &%per_byte%& option is equivalent to
31789 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31790 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31791 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31792
31793 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31794
31795
31796 .section "Ratelimit update modes" "ratoptupd"
31797 .cindex "rate limiting" "reading data without updating"
31798 You can specify one of three options with the &%ratelimit%& condition to
31799 control when its database is updated. This section describes the &%readonly%&
31800 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31801
31802 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31803 previously-computed rate to check against the limit.
31804
31805 For example, you can test the client's sending rate and deny it access (when
31806 it is too fast) in the connect ACL. If the client passes this check then it
31807 can go on to send a message, in which case its recorded rate will be updated
31808 in the MAIL ACL. Subsequent connections from the same client will check this
31809 new rate.
31810 .code
31811 acl_check_connect:
31812  deny ratelimit = 100 / 5m / readonly
31813     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31814                   (max $sender_rate_limit)
31815 # ...
31816 acl_check_mail:
31817  warn ratelimit = 100 / 5m / strict
31818     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31819                   (max $sender_rate_limit)
31820 .endd
31821
31822 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31823 processing a message then it may increase the client's measured rate more than
31824 it should. For example, this will happen if you check the &%per_rcpt%& option
31825 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31826 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31827 multiple update problems by using the &%readonly%& option on later ratelimit
31828 checks.
31829
31830 The &%per_*%& options described above do not make sense in some ACLs. If you
31831 use a &%per_*%& option in an ACL where it is not normally permitted then the
31832 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31833 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31834 next section) so you must specify the &%readonly%& option explicitly.
31835
31836
31837 .section "Ratelimit options for handling fast clients" "ratoptfast"
31838 .cindex "rate limiting" "strict and leaky modes"
31839 If a client's average rate is greater than the maximum, the rate limiting
31840 engine can react in two possible ways, depending on the presence of the
31841 &%strict%& or &%leaky%& update modes. This is independent of the other
31842 counter-measures (such as rejecting the message) that may be specified by the
31843 rest of the ACL.
31844
31845 The &%leaky%& (default) option means that the client's recorded rate is not
31846 updated if it is above the limit. The effect of this is that Exim measures the
31847 client's average rate of successfully sent email,
31848 up to the given limit.
31849 This is appropriate if the countermeasure when the condition is true
31850 consists of refusing the message, and
31851 is generally the better choice if you have clients that retry automatically.
31852 If the action when true is anything more complex then this option is
31853 likely not what is wanted.
31854
31855 The &%strict%& option means that the client's recorded rate is always
31856 updated. The effect of this is that Exim measures the client's average rate
31857 of attempts to send email, which can be much higher than the maximum it is
31858 actually allowed. If the client is over the limit it may be subjected to
31859 counter-measures by the ACL. It must slow down and allow sufficient time to
31860 pass that its computed rate falls below the maximum before it can send email
31861 again. The time (the number of smoothing periods) it must wait and not
31862 attempt to send mail can be calculated with this formula:
31863 .code
31864         ln(peakrate/maxrate)
31865 .endd
31866
31867
31868 .section "Limiting the rate of different events" "ratoptuniq"
31869 .cindex "rate limiting" "counting unique events"
31870 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31871 rate of different events. For example, the &%per_addr%& option uses this
31872 mechanism to count the number of different recipients that the client has
31873 sent messages to in the last time period; it is equivalent to
31874 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31875 measure the rate that a client uses different sender addresses with the
31876 options &`per_mail/unique=$sender_address`&.
31877
31878 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31879 has seen for that key. The whole set is thrown away when it is older than the
31880 rate smoothing period &'p'&, so each different event is counted at most once
31881 per period. In the &%leaky%& update mode, an event that causes the client to
31882 go over the limit is not added to the set, in the same way that the client's
31883 recorded rate is not updated in the same situation.
31884
31885 When you combine the &%unique=%& and &%readonly%& options, the specific
31886 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31887 rate.
31888
31889 The &%unique=%& mechanism needs more space in the ratelimit database than the
31890 other &%ratelimit%& options in order to store the event set. The number of
31891 unique values is potentially as large as the rate limit, so the extra space
31892 required increases with larger limits.
31893
31894 The uniqueification is not perfect: there is a small probability that Exim
31895 will think a new event has happened before. If the sender's rate is less than
31896 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31897 the measured rate can go above the limit, in which case Exim may under-count
31898 events by a significant margin. Fortunately, if the rate is high enough (2.7
31899 times the limit) that the false positive rate goes above 9%, then Exim will
31900 throw away the over-full event set before the measured rate falls below the
31901 limit. Therefore the only harm should be that exceptionally high sending rates
31902 are logged incorrectly; any countermeasures you configure will be as effective
31903 as intended.
31904
31905
31906 .section "Using rate limiting" "useratlim"
31907 Exim's other ACL facilities are used to define what counter-measures are taken
31908 when the rate limit is exceeded. This might be anything from logging a warning
31909 (for example, while measuring existing sending rates in order to define
31910 policy), through time delays to slow down fast senders, up to rejecting the
31911 message. For example:
31912 .code
31913 # Log all senders' rates
31914 warn ratelimit = 0 / 1h / strict
31915      log_message = Sender rate $sender_rate / $sender_rate_period
31916
31917 # Slow down fast senders; note the need to truncate $sender_rate
31918 # at the decimal point.
31919 warn ratelimit = 100 / 1h / per_rcpt / strict
31920      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31921                    $sender_rate_limit }s
31922
31923 # Keep authenticated users under control
31924 deny authenticated = *
31925      ratelimit = 100 / 1d / strict / $authenticated_id
31926
31927 # System-wide rate limit
31928 defer message = Sorry, too busy. Try again later.
31929      ratelimit = 10 / 1s / $primary_hostname
31930
31931 # Restrict incoming rate from each host, with a default
31932 # set using a macro and special cases looked up in a table.
31933 defer message = Sender rate exceeds $sender_rate_limit \
31934                messages per $sender_rate_period
31935      ratelimit = ${lookup {$sender_host_address} \
31936                    cdb {DB/ratelimits.cdb} \
31937                    {$value} {RATELIMIT} }
31938 .endd
31939 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31940 especially with the &%per_rcpt%& option, you may suffer from a performance
31941 bottleneck caused by locking on the ratelimit hints database. Apart from
31942 making your ACLs less complicated, you can reduce the problem by using a
31943 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31944 this means that Exim will lose its hints data after a reboot (including retry
31945 hints, the callout cache, and ratelimit data).
31946
31947
31948
31949 .section "Address verification" "SECTaddressverification"
31950 .cindex "verifying address" "options for"
31951 .cindex "policy control" "address verification"
31952 Several of the &%verify%& conditions described in section
31953 &<<SECTaclconditions>>& cause addresses to be verified. Section
31954 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31955 The verification conditions can be followed by options that modify the
31956 verification process. The options are separated from the keyword and from each
31957 other by slashes, and some of them contain parameters. For example:
31958 .code
31959 verify = sender/callout
31960 verify = recipient/defer_ok/callout=10s,defer_ok
31961 .endd
31962 The first stage of address verification, which always happens, is to run the
31963 address through the routers, in &"verify mode"&. Routers can detect the
31964 difference between verification and routing for delivery, and their actions can
31965 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31966 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31967 The available options are as follows:
31968
31969 .ilist
31970 If the &%callout%& option is specified, successful routing to one or more
31971 remote hosts is followed by a &"callout"& to those hosts as an additional
31972 check. Callouts and their sub-options are discussed in the next section.
31973 .next
31974 If there is a defer error while doing verification routing, the ACL
31975 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31976 options, the condition is forced to be true instead. Note that this is a main
31977 verification option as well as a suboption for callouts.
31978 .next
31979 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31980 discusses the reporting of sender address verification failures.
31981 .next
31982 The &%success_on_redirect%& option causes verification always to succeed
31983 immediately after a successful redirection. By default, if a redirection
31984 generates just one address, that address is also verified. See further
31985 discussion in section &<<SECTredirwhilveri>>&.
31986 .endlist
31987
31988 .cindex "verifying address" "differentiating failures"
31989 .vindex "&$recipient_verify_failure$&"
31990 .vindex "&$sender_verify_failure$&"
31991 .vindex "&$acl_verify_message$&"
31992 After an address verification failure, &$acl_verify_message$& contains the
31993 error message that is associated with the failure. It can be preserved by
31994 coding like this:
31995 .code
31996 warn  !verify = sender
31997        set acl_m0 = $acl_verify_message
31998 .endd
31999 If you are writing your own custom rejection message or log message when
32000 denying access, you can use this variable to include information about the
32001 verification failure.
32002
32003 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32004 appropriate) contains one of the following words:
32005
32006 .ilist
32007 &%qualify%&: The address was unqualified (no domain), and the message
32008 was neither local nor came from an exempted host.
32009 .next
32010 &%route%&: Routing failed.
32011 .next
32012 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32013 occurred at or before the MAIL command (that is, on initial
32014 connection, HELO, or MAIL).
32015 .next
32016 &%recipient%&: The RCPT command in a callout was rejected.
32017 .next
32018 &%postmaster%&: The postmaster check in a callout was rejected.
32019 .endlist
32020
32021 The main use of these variables is expected to be to distinguish between
32022 rejections of MAIL and rejections of RCPT in callouts.
32023
32024 The above variables may also be set after a &*successful*&
32025 address verification to:
32026
32027 .ilist
32028 &%random%&: A random local-part callout succeeded
32029 .endlist
32030
32031
32032
32033
32034 .section "Callout verification" "SECTcallver"
32035 .cindex "verifying address" "by callout"
32036 .cindex "callout" "verification"
32037 .cindex "SMTP" "callout verification"
32038 For non-local addresses, routing verifies the domain, but is unable to do any
32039 checking of the local part. There are situations where some means of verifying
32040 the local part is desirable. One way this can be done is to make an SMTP
32041 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32042 a subsequent host for a recipient address, to see if the host accepts the
32043 address. We use the term &'callout'& to cover both cases. Note that for a
32044 sender address, the callback is not to the client host that is trying to
32045 deliver the message, but to one of the hosts that accepts incoming mail for the
32046 sender's domain.
32047
32048 Exim does not do callouts by default. If you want them to happen, you must
32049 request them by setting appropriate options on the &%verify%& condition, as
32050 described below. This facility should be used with care, because it can add a
32051 lot of resource usage to the cost of verifying an address. However, Exim does
32052 cache the results of callouts, which helps to reduce the cost. Details of
32053 caching are in section &<<SECTcallvercache>>&.
32054
32055 Recipient callouts are usually used only between hosts that are controlled by
32056 the same administration. For example, a corporate gateway host could use
32057 callouts to check for valid recipients on an internal mailserver. A successful
32058 callout does not guarantee that a real delivery to the address would succeed;
32059 on the other hand, a failing callout does guarantee that a delivery would fail.
32060
32061 If the &%callout%& option is present on a condition that verifies an address, a
32062 second stage of verification occurs if the address is successfully routed to
32063 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32064 &(manualroute)& router, where the router specifies the hosts. However, if a
32065 router that does not set up hosts routes to an &(smtp)& transport with a
32066 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32067 &%hosts_override%& set, its hosts are always used, whether or not the router
32068 supplies a host list.
32069 Callouts are only supported on &(smtp)& transports.
32070
32071 The port that is used is taken from the transport, if it is specified and is a
32072 remote transport. (For routers that do verification only, no transport need be
32073 specified.) Otherwise, the default SMTP port is used. If a remote transport
32074 specifies an outgoing interface, this is used; otherwise the interface is not
32075 specified. Likewise, the text that is used for the HELO command is taken from
32076 the transport's &%helo_data%& option; if there is no transport, the value of
32077 &$smtp_active_hostname$& is used.
32078
32079 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32080 test whether a bounce message could be delivered to the sender address. The
32081 following SMTP commands are sent:
32082 .display
32083 &`HELO `&<&'local host name'&>
32084 &`MAIL FROM:<>`&
32085 &`RCPT TO:`&<&'the address to be tested'&>
32086 &`QUIT`&
32087 .endd
32088 LHLO is used instead of HELO if the transport's &%protocol%& option is
32089 set to &"lmtp"&.
32090
32091 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32092 settings.
32093
32094 A recipient callout check is similar. By default, it also uses an empty address
32095 for the sender. This default is chosen because most hosts do not make use of
32096 the sender address when verifying a recipient. Using the same address means
32097 that a single cache entry can be used for each recipient. Some sites, however,
32098 do make use of the sender address when verifying. These are catered for by the
32099 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32100
32101 If the response to the RCPT command is a 2&'xx'& code, the verification
32102 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32103 Exim tries the next host, if any. If there is a problem with all the remote
32104 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32105 &%callout%& option is given, in which case the condition is forced to succeed.
32106
32107 .cindex "SMTP" "output flushing, disabling for callout"
32108 A callout may take a little time. For this reason, Exim normally flushes SMTP
32109 output before performing a callout in an ACL, to avoid unexpected timeouts in
32110 clients when the SMTP PIPELINING extension is in use. The flushing can be
32111 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32112
32113
32114
32115
32116 .section "Additional parameters for callouts" "CALLaddparcall"
32117 .cindex "callout" "additional parameters for"
32118 The &%callout%& option can be followed by an equals sign and a number of
32119 optional parameters, separated by commas. For example:
32120 .code
32121 verify = recipient/callout=10s,defer_ok
32122 .endd
32123 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32124 separate verify options, is retained for backwards compatibility, but is now
32125 deprecated. The additional parameters for &%callout%& are as follows:
32126
32127
32128 .vlist
32129 .vitem <&'a&~time&~interval'&>
32130 .cindex "callout" "timeout, specifying"
32131 This specifies the timeout that applies for the callout attempt to each host.
32132 For example:
32133 .code
32134 verify = sender/callout=5s
32135 .endd
32136 The default is 30 seconds. The timeout is used for each response from the
32137 remote host. It is also used for the initial connection, unless overridden by
32138 the &%connect%& parameter.
32139
32140
32141 .vitem &*connect&~=&~*&<&'time&~interval'&>
32142 .cindex "callout" "connection timeout, specifying"
32143 This parameter makes it possible to set a different (usually smaller) timeout
32144 for making the SMTP connection. For example:
32145 .code
32146 verify = sender/callout=5s,connect=1s
32147 .endd
32148 If not specified, this timeout defaults to the general timeout value.
32149
32150 .vitem &*defer_ok*&
32151 .cindex "callout" "defer, action on"
32152 When this parameter is present, failure to contact any host, or any other kind
32153 of temporary error, is treated as success by the ACL. However, the cache is not
32154 updated in this circumstance.
32155
32156 .vitem &*fullpostmaster*&
32157 .cindex "callout" "full postmaster check"
32158 This operates like the &%postmaster%& option (see below), but if the check for
32159 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32160 accordance with the specification in RFC 2821. The RFC states that the
32161 unqualified address &'postmaster'& should be accepted.
32162
32163
32164 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32165 .cindex "callout" "sender when verifying header"
32166 When verifying addresses in header lines using the &%header_sender%&
32167 verification option, Exim behaves by default as if the addresses are envelope
32168 sender addresses from a message. Callout verification therefore tests to see
32169 whether a bounce message could be delivered, by using an empty address in the
32170 MAIL command. However, it is arguable that these addresses might never be used
32171 as envelope senders, and could therefore justifiably reject bounce messages
32172 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32173 address to use in the MAIL command. For example:
32174 .code
32175 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32176 .endd
32177 This parameter is available only for the &%header_sender%& verification option.
32178
32179
32180 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32181 .cindex "callout" "overall timeout, specifying"
32182 This parameter sets an overall timeout for performing a callout verification.
32183 For example:
32184 .code
32185 verify = sender/callout=5s,maxwait=30s
32186 .endd
32187 This timeout defaults to four times the callout timeout for individual SMTP
32188 commands. The overall timeout applies when there is more than one host that can
32189 be tried. The timeout is checked before trying the next host. This prevents
32190 very long delays if there are a large number of hosts and all are timing out
32191 (for example, when network connections are timing out).
32192
32193
32194 .vitem &*no_cache*&
32195 .cindex "callout" "cache, suppressing"
32196 .cindex "caching callout, suppressing"
32197 When this parameter is given, the callout cache is neither read nor updated.
32198
32199 .vitem &*postmaster*&
32200 .cindex "callout" "postmaster; checking"
32201 When this parameter is set, a successful callout check is followed by a similar
32202 check for the local part &'postmaster'& at the same domain. If this address is
32203 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32204 the postmaster check is recorded in a cache record; if it is a failure, this is
32205 used to fail subsequent callouts for the domain without a connection being
32206 made, until the cache record expires.
32207
32208 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32209 The postmaster check uses an empty sender in the MAIL command by default.
32210 You can use this parameter to do a postmaster check using a different address.
32211 For example:
32212 .code
32213 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32214 .endd
32215 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32216 one overrides. The &%postmaster%& parameter is equivalent to this example:
32217 .code
32218 require  verify = sender/callout=postmaster_mailfrom=
32219 .endd
32220 &*Warning*&: The caching arrangements for postmaster checking do not take
32221 account of the sender address. It is assumed that either the empty address or
32222 a fixed non-empty address will be used. All that Exim remembers is that the
32223 postmaster check for the domain succeeded or failed.
32224
32225
32226 .vitem &*random*&
32227 .cindex "callout" "&""random""& check"
32228 When this parameter is set, before doing the normal callout check, Exim does a
32229 check for a &"random"& local part at the same domain. The local part is not
32230 really random &-- it is defined by the expansion of the option
32231 &%callout_random_local_part%&, which defaults to
32232 .code
32233 $primary_hostname-$tod_epoch-testing
32234 .endd
32235 The idea here is to try to determine whether the remote host accepts all local
32236 parts without checking. If it does, there is no point in doing callouts for
32237 specific local parts. If the &"random"& check succeeds, the result is saved in
32238 a cache record, and used to force the current and subsequent callout checks to
32239 succeed without a connection being made, until the cache record expires.
32240
32241 .vitem &*use_postmaster*&
32242 .cindex "callout" "sender for recipient check"
32243 This parameter applies to recipient callouts only. For example:
32244 .code
32245 deny  !verify = recipient/callout=use_postmaster
32246 .endd
32247 .vindex "&$qualify_domain$&"
32248 It causes a non-empty postmaster address to be used in the MAIL command when
32249 performing the callout for the recipient, and also for a &"random"& check if
32250 that is configured. The local part of the address is &`postmaster`& and the
32251 domain is the contents of &$qualify_domain$&.
32252
32253 .vitem &*use_sender*&
32254 This option applies to recipient callouts only. For example:
32255 .code
32256 require  verify = recipient/callout=use_sender
32257 .endd
32258 It causes the message's actual sender address to be used in the MAIL
32259 command when performing the callout, instead of an empty address. There is no
32260 need to use this option unless you know that the called hosts make use of the
32261 sender when checking recipients. If used indiscriminately, it reduces the
32262 usefulness of callout caching.
32263
32264 .vitem &*hold*&
32265 This option applies to recipient callouts only. For example:
32266 .code
32267 require  verify = recipient/callout=use_sender,hold
32268 .endd
32269 It causes the connection to be held open and used for any further recipients
32270 and for eventual delivery (should that be done quickly).
32271 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32272 when that is used for the connections.
32273 The advantage is only gained if there are no callout cache hits
32274 (which could be enforced by the no_cache option),
32275 if the use_sender option is used,
32276 if neither the random nor the use_postmaster option is used,
32277 and if no other callouts intervene.
32278 .endlist
32279
32280 If you use any of the parameters that set a non-empty sender for the MAIL
32281 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32282 &%use_sender%&), you should think about possible loops. Recipient checking is
32283 usually done between two hosts that are under the same management, and the host
32284 that receives the callouts is not normally configured to do callouts itself.
32285 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32286 these circumstances.
32287
32288 However, if you use a non-empty sender address for a callout to an arbitrary
32289 host, there is the likelihood that the remote host will itself initiate a
32290 callout check back to your host. As it is checking what appears to be a message
32291 sender, it is likely to use an empty address in MAIL, thus avoiding a
32292 callout loop. However, to be on the safe side it would be best to set up your
32293 own ACLs so that they do not do sender verification checks when the recipient
32294 is the address you use for header sender or postmaster callout checking.
32295
32296 Another issue to think about when using non-empty senders for callouts is
32297 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32298 by the sender/recipient combination; thus, for any given recipient, many more
32299 actual callouts are performed than when an empty sender or postmaster is used.
32300
32301
32302
32303
32304 .section "Callout caching" "SECTcallvercache"
32305 .cindex "hints database" "callout cache"
32306 .cindex "callout" "cache, description of"
32307 .cindex "caching" "callout"
32308 Exim caches the results of callouts in order to reduce the amount of resources
32309 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32310 option. A hints database called &"callout"& is used for the cache. Two
32311 different record types are used: one records the result of a callout check for
32312 a specific address, and the other records information that applies to the
32313 entire domain (for example, that it accepts the local part &'postmaster'&).
32314
32315 When an original callout fails, a detailed SMTP error message is given about
32316 the failure. However, for subsequent failures use the cache data, this message
32317 is not available.
32318
32319 The expiry times for negative and positive address cache records are
32320 independent, and can be set by the global options &%callout_negative_expire%&
32321 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32322
32323 If a host gives a negative response to an SMTP connection, or rejects any
32324 commands up to and including
32325 .code
32326 MAIL FROM:<>
32327 .endd
32328 (but not including the MAIL command with a non-empty address),
32329 any callout attempt is bound to fail. Exim remembers such failures in a
32330 domain cache record, which it uses to fail callouts for the domain without
32331 making new connections, until the domain record times out. There are two
32332 separate expiry times for domain cache records:
32333 &%callout_domain_negative_expire%& (default 3h) and
32334 &%callout_domain_positive_expire%& (default 7d).
32335
32336 Domain records expire when the negative expiry time is reached if callouts
32337 cannot be made for the domain, or if the postmaster check failed.
32338 Otherwise, they expire when the positive expiry time is reached. This
32339 ensures that, for example, a host that stops accepting &"random"& local parts
32340 will eventually be noticed.
32341
32342 The callout caching mechanism is based on the domain of the address that is
32343 being tested. If the domain routes to several hosts, it is assumed that their
32344 behaviour will be the same.
32345
32346
32347
32348 .section "Sender address verification reporting" "SECTsenaddver"
32349 .cindex "verifying" "suppressing error details"
32350 See section &<<SECTaddressverification>>& for a general discussion of
32351 verification. When sender verification fails in an ACL, the details of the
32352 failure are given as additional output lines before the 550 response to the
32353 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32354 you might see:
32355 .code
32356 MAIL FROM:<xyz@abc.example>
32357 250 OK
32358 RCPT TO:<pqr@def.example>
32359 550-Verification failed for <xyz@abc.example>
32360 550-Called:   192.168.34.43
32361 550-Sent:     RCPT TO:<xyz@abc.example>
32362 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32363 550 Sender verification failed
32364 .endd
32365 If more than one RCPT command fails in the same way, the details are given
32366 only for the first of them. However, some administrators do not want to send
32367 out this much information. You can suppress the details by adding
32368 &`/no_details`& to the ACL statement that requests sender verification. For
32369 example:
32370 .code
32371 verify = sender/no_details
32372 .endd
32373
32374 .section "Redirection while verifying" "SECTredirwhilveri"
32375 .cindex "verifying" "redirection while"
32376 .cindex "address redirection" "while verifying"
32377 A dilemma arises when a local address is redirected by aliasing or forwarding
32378 during verification: should the generated addresses themselves be verified,
32379 or should the successful expansion of the original address be enough to verify
32380 it? By default, Exim takes the following pragmatic approach:
32381
32382 .ilist
32383 When an incoming address is redirected to just one child address, verification
32384 continues with the child address, and if that fails to verify, the original
32385 verification also fails.
32386 .next
32387 When an incoming address is redirected to more than one child address,
32388 verification does not continue. A success result is returned.
32389 .endlist
32390
32391 This seems the most reasonable behaviour for the common use of aliasing as a
32392 way of redirecting different local parts to the same mailbox. It means, for
32393 example, that a pair of alias entries of the form
32394 .code
32395 A.Wol:   aw123
32396 aw123:   :fail: Gone away, no forwarding address
32397 .endd
32398 work as expected, with both local parts causing verification failure. When a
32399 redirection generates more than one address, the behaviour is more like a
32400 mailing list, where the existence of the alias itself is sufficient for
32401 verification to succeed.
32402
32403 It is possible, however, to change the default behaviour so that all successful
32404 redirections count as successful verifications, however many new addresses are
32405 generated. This is specified by the &%success_on_redirect%& verification
32406 option. For example:
32407 .code
32408 require verify = recipient/success_on_redirect/callout=10s
32409 .endd
32410 In this example, verification succeeds if a router generates a new address, and
32411 the callout does not occur, because no address was routed to a remote host.
32412
32413 When verification is being tested via the &%-bv%& option, the treatment of
32414 redirections is as just described, unless the &%-v%& or any debugging option is
32415 also specified. In that case, full verification is done for every generated
32416 address and a report is output for each of them.
32417
32418
32419
32420 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32421 .cindex "CSA" "verifying"
32422 Client SMTP Authorization is a system that allows a site to advertise
32423 which machines are and are not permitted to send email. This is done by placing
32424 special SRV records in the DNS; these are looked up using the client's HELO
32425 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32426 Authorization checks in Exim are performed by the ACL condition:
32427 .code
32428 verify = csa
32429 .endd
32430 This fails if the client is not authorized. If there is a DNS problem, or if no
32431 valid CSA SRV record is found, or if the client is authorized, the condition
32432 succeeds. These three cases can be distinguished using the expansion variable
32433 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32434 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32435 be likely to cause problems for legitimate email.
32436
32437 The error messages produced by the CSA code include slightly more
32438 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32439 looking up the CSA SRV record, or problems looking up the CSA target
32440 address record. There are four reasons for &$csa_status$& being &"fail"&:
32441
32442 .ilist
32443 The client's host name is explicitly not authorized.
32444 .next
32445 The client's IP address does not match any of the CSA target IP addresses.
32446 .next
32447 The client's host name is authorized but it has no valid target IP addresses
32448 (for example, the target's addresses are IPv6 and the client is using IPv4).
32449 .next
32450 The client's host name has no CSA SRV record but a parent domain has asserted
32451 that all subdomains must be explicitly authorized.
32452 .endlist
32453
32454 The &%csa%& verification condition can take an argument which is the domain to
32455 use for the DNS query. The default is:
32456 .code
32457 verify = csa/$sender_helo_name
32458 .endd
32459 This implementation includes an extension to CSA. If the query domain
32460 is an address literal such as [192.0.2.95], or if it is a bare IP
32461 address, Exim searches for CSA SRV records in the reverse DNS as if
32462 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32463 meaningful to say:
32464 .code
32465 verify = csa/$sender_host_address
32466 .endd
32467 In fact, this is the check that Exim performs if the client does not say HELO.
32468 This extension can be turned off by setting the main configuration option
32469 &%dns_csa_use_reverse%& to be false.
32470
32471 If a CSA SRV record is not found for the domain itself, a search
32472 is performed through its parent domains for a record which might be
32473 making assertions about subdomains. The maximum depth of this search is limited
32474 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32475 default. Exim does not look for CSA SRV records in a top level domain, so the
32476 default settings handle HELO domains as long as seven
32477 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32478 of legitimate HELO domains.
32479
32480 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32481 direct SRV lookups, this is not sufficient because of the extra parent domain
32482 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32483 addresses into lookups in the reverse DNS space. The result of a successful
32484 lookup such as:
32485 .code
32486 ${lookup dnsdb {csa=$sender_helo_name}}
32487 .endd
32488 has two space-separated fields: an authorization code and a target host name.
32489 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32490 authorization required but absent, or &"?"& for unknown.
32491
32492
32493
32494
32495 .section "Bounce address tag validation" "SECTverifyPRVS"
32496 .cindex "BATV, verifying"
32497 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32498 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32499 Genuine incoming bounce messages should therefore always be addressed to
32500 recipients that have a valid tag. This scheme is a way of detecting unwanted
32501 bounce messages caused by sender address forgeries (often called &"collateral
32502 spam"&), because the recipients of such messages do not include valid tags.
32503
32504 There are two expansion items to help with the implementation of the BATV
32505 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32506 the original envelope sender address by using a simple key to add a hash of the
32507 address and some time-based randomizing information. The &%prvs%& expansion
32508 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32509 The syntax of these expansion items is described in section
32510 &<<SECTexpansionitems>>&.
32511 The validity period on signed addresses is seven days.
32512
32513 As an example, suppose the secret per-address keys are stored in an MySQL
32514 database. A query to look up the key for an address could be defined as a macro
32515 like this:
32516 .code
32517 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32518                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32519                 }{$value}}
32520 .endd
32521 Suppose also that the senders who make use of BATV are defined by an address
32522 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32523 use this:
32524 .code
32525 # Bounces: drop unsigned addresses for BATV senders
32526 deny message = This address does not send an unsigned reverse path
32527      senders = :
32528      recipients = +batv_senders
32529
32530 # Bounces: In case of prvs-signed address, check signature.
32531 deny message = Invalid reverse path signature.
32532      senders = :
32533      condition  = ${prvscheck {$local_part@$domain}\
32534                   {PRVSCHECK_SQL}{1}}
32535      !condition = $prvscheck_result
32536 .endd
32537 The first statement rejects recipients for bounce messages that are addressed
32538 to plain BATV sender addresses, because it is known that BATV senders do not
32539 send out messages with plain sender addresses. The second statement rejects
32540 recipients that are prvs-signed, but with invalid signatures (either because
32541 the key is wrong, or the signature has timed out).
32542
32543 A non-prvs-signed address is not rejected by the second statement, because the
32544 &%prvscheck%& expansion yields an empty string if its first argument is not a
32545 prvs-signed address, thus causing the &%condition%& condition to be false. If
32546 the first argument is a syntactically valid prvs-signed address, the yield is
32547 the third string (in this case &"1"&), whether or not the cryptographic and
32548 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32549 of the checks (empty for failure, &"1"& for success).
32550
32551 There is one more issue you must consider when implementing prvs-signing:
32552 you have to ensure that the routers accept prvs-signed addresses and
32553 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32554 router to remove the signature with a configuration along these lines:
32555 .code
32556 batv_redirect:
32557   driver = redirect
32558   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32559 .endd
32560 This works because, if the third argument of &%prvscheck%& is empty, the result
32561 of the expansion of a prvs-signed address is the decoded value of the original
32562 address. This router should probably be the first of your routers that handles
32563 local addresses.
32564
32565 To create BATV-signed addresses in the first place, a transport of this form
32566 can be used:
32567 .code
32568 external_smtp_batv:
32569   driver = smtp
32570   return_path = ${prvs {$return_path} \
32571                        {${lookup mysql{SELECT \
32572                        secret FROM batv_prvs WHERE \
32573                        sender='${quote_mysql:$sender_address}'} \
32574                        {$value}fail}}}
32575 .endd
32576 If no key can be found for the existing return path, no signing takes place.
32577
32578
32579
32580 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32581 .cindex "&ACL;" "relay control"
32582 .cindex "relaying" "control by ACL"
32583 .cindex "policy control" "relay control"
32584 An MTA is said to &'relay'& a message if it receives it from some host and
32585 delivers it directly to another host as a result of a remote address contained
32586 within it. Redirecting a local address via an alias or forward file and then
32587 passing the message on to another host is not relaying,
32588 .cindex "&""percent hack""&"
32589 but a redirection as a result of the &"percent hack"& is.
32590
32591 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32592 A host which is acting as a gateway or an MX backup is concerned with incoming
32593 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32594 a host which is acting as a smart host for a number of clients is concerned
32595 with outgoing relaying from those clients to the Internet at large. Often the
32596 same host is fulfilling both functions,
32597 . ///
32598 . as illustrated in the diagram below,
32599 . ///
32600 but in principle these two kinds of relaying are entirely independent. What is
32601 not wanted is the transmission of mail from arbitrary remote hosts through your
32602 system to arbitrary domains.
32603
32604
32605 You can implement relay control by means of suitable statements in the ACL that
32606 runs for each RCPT command. For convenience, it is often easiest to use
32607 Exim's named list facility to define the domains and hosts involved. For
32608 example, suppose you want to do the following:
32609
32610 .ilist
32611 Deliver a number of domains to mailboxes on the local host (or process them
32612 locally in some other way). Let's say these are &'my.dom1.example'& and
32613 &'my.dom2.example'&.
32614 .next
32615 Relay mail for a number of other domains for which you are the secondary MX.
32616 These might be &'friend1.example'& and &'friend2.example'&.
32617 .next
32618 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32619 Suppose your LAN is 192.168.45.0/24.
32620 .endlist
32621
32622
32623 In the main part of the configuration, you put the following definitions:
32624 .code
32625 domainlist local_domains    = my.dom1.example : my.dom2.example
32626 domainlist relay_to_domains = friend1.example : friend2.example
32627 hostlist   relay_from_hosts = 192.168.45.0/24
32628 .endd
32629 Now you can use these definitions in the ACL that is run for every RCPT
32630 command:
32631 .code
32632 acl_check_rcpt:
32633   accept domains = +local_domains : +relay_to_domains
32634   accept hosts   = +relay_from_hosts
32635 .endd
32636 The first statement accepts any RCPT command that contains an address in
32637 the local or relay domains. For any other domain, control passes to the second
32638 statement, which accepts the command only if it comes from one of the relay
32639 hosts. In practice, you will probably want to make your ACL more sophisticated
32640 than this, for example, by including sender and recipient verification. The
32641 default configuration includes a more comprehensive example, which is described
32642 in chapter &<<CHAPdefconfil>>&.
32643
32644
32645
32646 .section "Checking a relay configuration" "SECTcheralcon"
32647 .cindex "relaying" "checking control of"
32648 You can check the relay characteristics of your configuration in the same way
32649 that you can test any ACL behaviour for an incoming SMTP connection, by using
32650 the &%-bh%& option to run a fake SMTP session with which you interact.
32651 .ecindex IIDacl
32652
32653
32654
32655 . ////////////////////////////////////////////////////////////////////////////
32656 . ////////////////////////////////////////////////////////////////////////////
32657
32658 .chapter "Content scanning at ACL time" "CHAPexiscan"
32659 .scindex IIDcosca "content scanning" "at ACL time"
32660 The extension of Exim to include content scanning at ACL time, formerly known
32661 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32662 was integrated into the main source for Exim release 4.50, and Tom continues to
32663 maintain it. Most of the wording of this chapter is taken from Tom's
32664 specification.
32665
32666 It is also possible to scan the content of messages at other times. The
32667 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32668 scanning after all the ACLs have run. A transport filter can be used to scan
32669 messages at delivery time (see the &%transport_filter%& option, described in
32670 chapter &<<CHAPtransportgeneric>>&).
32671
32672 If you want to include the ACL-time content-scanning features when you compile
32673 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32674 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32675
32676 .ilist
32677 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32678 for all MIME parts for SMTP and non-SMTP messages, respectively.
32679 .next
32680 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32681 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32682 run at the end of message reception (the &%acl_smtp_data%& ACL).
32683 .next
32684 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32685 of messages, or parts of messages, for debugging purposes.
32686 .next
32687 Additional expansion variables that are set in the new ACL and by the new
32688 conditions.
32689 .next
32690 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32691 .endlist
32692
32693 Content-scanning is continually evolving, and new features are still being
32694 added. While such features are still unstable and liable to incompatible
32695 changes, they are made available in Exim by setting options whose names begin
32696 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32697 this manual. You can find out about them by reading the file called
32698 &_doc/experimental.txt_&.
32699
32700 All the content-scanning facilities work on a MBOX copy of the message that is
32701 temporarily created in a file called:
32702 .display
32703 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32704 .endd
32705 The &_.eml_& extension is a friendly hint to virus scanners that they can
32706 expect an MBOX-like structure inside that file. The file is created when the
32707 first content scanning facility is called. Subsequent calls to content
32708 scanning conditions open the same file again. The directory is recursively
32709 removed when the &%acl_smtp_data%& ACL has finished running, unless
32710 .code
32711 control = no_mbox_unspool
32712 .endd
32713 has been encountered. When the MIME ACL decodes files, they are put into the
32714 same directory by default.
32715
32716
32717
32718 .section "Scanning for viruses" "SECTscanvirus"
32719 .cindex "virus scanning"
32720 .cindex "content scanning" "for viruses"
32721 .cindex "content scanning" "the &%malware%& condition"
32722 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32723 It supports a &"generic"& interface to scanners called via the shell, and
32724 specialized interfaces for &"daemon"& type virus scanners, which are resident
32725 in memory and thus are much faster.
32726
32727 .new
32728 Since message data needs to have arrived,
32729 the condition may be only called in ACL defined by
32730 &%acl_smtp_data%&,
32731 &%acl_smtp_data_prdr%&,
32732 &%acl_smtp_mime%& or
32733 &%acl_smtp_dkim%&
32734 .wen
32735
32736 A timeout of 2 minutes is applied to a scanner call (by default);
32737 if it expires then a defer action is taken.
32738
32739 .oindex "&%av_scanner%&"
32740 You can set the &%av_scanner%& option in the main part of the configuration
32741 to specify which scanner to use, together with any additional options that
32742 are needed. The basic syntax is as follows:
32743 .display
32744 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32745 .endd
32746 If you do not set &%av_scanner%&, it defaults to
32747 .code
32748 av_scanner = sophie:/var/run/sophie
32749 .endd
32750 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32751 before use.
32752 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32753 The following scanner types are supported in this release,
32754 though individual ones can be included or not at build time:
32755
32756 .vlist
32757 .vitem &%avast%&
32758 .cindex "virus scanners" "avast"
32759 This is the scanner daemon of Avast. It has been tested with Avast Core
32760 Security (currently at version 2.2.0).
32761 You can get a trial version at &url(https://www.avast.com) or for Linux
32762 at &url(https://www.avast.com/linux-server-antivirus).
32763 This scanner type takes one option,
32764 which can be either a full path to a UNIX socket,
32765 or host and port specifiers separated by white space.
32766 The host may be a name or an IP address; the port is either a
32767 single number or a pair of numbers with a dash between.
32768 A list of options may follow. These options are interpreted on the
32769 Exim's side of the malware scanner, or are given on separate lines to
32770 the daemon as options before the main scan command.
32771
32772 .cindex &`pass_unscanned`& "avast"
32773 If &`pass_unscanned`&
32774 is set, any files the Avast scanner can't scan (e.g.
32775 decompression bombs, or invalid archives) are considered clean. Use with
32776 care.
32777
32778 For example:
32779 .code
32780 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32781 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32782 av_scanner = avast:192.168.2.22 5036
32783 .endd
32784 If you omit the argument, the default path
32785 &_/var/run/avast/scan.sock_&
32786 is used.
32787 If you use a remote host,
32788 you need to make Exim's spool directory available to it,
32789 as the scanner is passed a file path, not file contents.
32790 For information about available commands and their options you may use
32791 .code
32792 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32793     FLAGS
32794     SENSITIVITY
32795     PACK
32796 .endd
32797
32798 If the scanner returns a temporary failure (e.g. license issues, or
32799 permission problems), the message is deferred and a paniclog entry is
32800 written.  The usual &`defer_ok`& option is available.
32801
32802 .vitem &%aveserver%&
32803 .cindex "virus scanners" "Kaspersky"
32804 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32805 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32806 which is the path to the daemon's UNIX socket. The default is shown in this
32807 example:
32808 .code
32809 av_scanner = aveserver:/var/run/aveserver
32810 .endd
32811
32812
32813 .vitem &%clamd%&
32814 .cindex "virus scanners" "clamd"
32815 This daemon-type scanner is GPL and free. You can get it at
32816 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32817 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32818 in the MIME ACL. This is no longer believed to be necessary.
32819
32820 The options are a list of server specifiers, which may be
32821 a UNIX socket specification,
32822 a TCP socket specification,
32823 or a (global) option.
32824
32825 A socket specification consists of a space-separated list.
32826 For a Unix socket the first element is a full path for the socket,
32827 for a TCP socket the first element is the IP address
32828 and the second a port number,
32829 Any further elements are per-server (non-global) options.
32830 These per-server options are supported:
32831 .code
32832 retry=<timespec>        Retry on connect fail
32833 .endd
32834
32835 The &`retry`& option specifies a time after which a single retry for
32836 a failed connect is made.  The default is to not retry.
32837
32838 If a Unix socket file is specified, only one server is supported.
32839
32840 Examples:
32841 .code
32842 av_scanner = clamd:/opt/clamd/socket
32843 av_scanner = clamd:192.0.2.3 1234
32844 av_scanner = clamd:192.0.2.3 1234:local
32845 av_scanner = clamd:192.0.2.3 1234 retry=10s
32846 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32847 .endd
32848 If the value of av_scanner points to a UNIX socket file or contains the
32849 &`local`&
32850 option, then the ClamAV interface will pass a filename containing the data
32851 to be scanned, which should normally result in less I/O happening and be
32852 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32853 Exim does not assume that there is a common filesystem with the remote host.
32854
32855 The final example shows that multiple TCP targets can be specified.  Exim will
32856 randomly use one for each incoming email (i.e. it load balances them).  Note
32857 that only TCP targets may be used if specifying a list of scanners; a UNIX
32858 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32859 unavailable, Exim will try the remaining one(s) until it finds one that works.
32860 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32861 not keep track of scanner state between multiple messages, and the scanner
32862 selection is random, so the message will get logged in the mainlog for each
32863 email that the down scanner gets chosen first (message wrapped to be readable):
32864 .code
32865 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32866    clamd: connection to localhost, port 3310 failed
32867    (Connection refused)
32868 .endd
32869
32870 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32871 contributing the code for this scanner.
32872
32873 .vitem &%cmdline%&
32874 .cindex "virus scanners" "command line interface"
32875 This is the keyword for the generic command line scanner interface. It can be
32876 used to attach virus scanners that are invoked from the shell. This scanner
32877 type takes 3 mandatory options:
32878
32879 .olist
32880 The full path and name of the scanner binary, with all command line options,
32881 and a placeholder (&`%s`&) for the directory to scan.
32882
32883 .next
32884 A regular expression to match against the STDOUT and STDERR output of the
32885 virus scanner. If the expression matches, a virus was found. You must make
32886 absolutely sure that this expression matches on &"virus found"&. This is called
32887 the &"trigger"& expression.
32888
32889 .next
32890 Another regular expression, containing exactly one pair of parentheses, to
32891 match the name of the virus found in the scanners output. This is called the
32892 &"name"& expression.
32893 .endlist olist
32894
32895 For example, Sophos Sweep reports a virus on a line like this:
32896 .code
32897 Virus 'W32/Magistr-B' found in file ./those.bat
32898 .endd
32899 For the trigger expression, we can match the phrase &"found in file"&. For the
32900 name expression, we want to extract the W32/Magistr-B string, so we can match
32901 for the single quotes left and right of it. Altogether, this makes the
32902 configuration setting:
32903 .code
32904 av_scanner = cmdline:\
32905              /path/to/sweep -ss -all -rec -archive %s:\
32906              found in file:'(.+)'
32907 .endd
32908 .vitem &%drweb%&
32909 .cindex "virus scanners" "DrWeb"
32910 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32911 takes one option,
32912 either a full path to a UNIX socket,
32913 or host and port specifiers separated by white space.
32914 The host may be a name or an IP address; the port is either a
32915 single number or a pair of numbers with a dash between.
32916 For example:
32917 .code
32918 av_scanner = drweb:/var/run/drwebd.sock
32919 av_scanner = drweb:192.168.2.20 31337
32920 .endd
32921 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32922 is used. Thanks to Alex Miller for contributing the code for this scanner.
32923
32924 .vitem &%f-protd%&
32925 .cindex "virus scanners" "f-protd"
32926 The f-protd scanner is accessed via HTTP over TCP.
32927 One argument is taken, being a space-separated hostname and port number
32928 (or port-range).
32929 For example:
32930 .code
32931 av_scanner = f-protd:localhost 10200-10204
32932 .endd
32933 If you omit the argument, the default values shown above are used.
32934
32935 .vitem &%f-prot6d%&
32936 .cindex "virus scanners" "f-prot6d"
32937 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32938 One argument is taken, being a space-separated hostname and port number.
32939 For example:
32940 .code
32941 av_scanner = f-prot6d:localhost 10200
32942 .endd
32943 If you omit the argument, the default values show above are used.
32944
32945 .vitem &%fsecure%&
32946 .cindex "virus scanners" "F-Secure"
32947 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32948 argument which is the path to a UNIX socket. For example:
32949 .code
32950 av_scanner = fsecure:/path/to/.fsav
32951 .endd
32952 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32953 Thelmen for contributing the code for this scanner.
32954
32955 .vitem &%kavdaemon%&
32956 .cindex "virus scanners" "Kaspersky"
32957 This is the scanner daemon of Kaspersky Version 4. This version of the
32958 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32959 scanner type takes one option, which is the path to the daemon's UNIX socket.
32960 For example:
32961 .code
32962 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32963 .endd
32964 The default path is &_/var/run/AvpCtl_&.
32965
32966 .vitem &%mksd%&
32967 .cindex "virus scanners" "mksd"
32968 This was a daemon type scanner that is aimed mainly at Polish users,
32969 though some documentation was available in English.
32970 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32971 and this appears to be a candidate for removal from Exim, unless
32972 we are informed of other virus scanners which use the same protocol
32973 to integrate.
32974 The only option for this scanner type is
32975 the maximum number of processes used simultaneously to scan the attachments,
32976 provided that mksd has
32977 been run with at least the same number of child processes. For example:
32978 .code
32979 av_scanner = mksd:2
32980 .endd
32981 You can safely omit this option (the default value is 1).
32982
32983 .vitem &%sock%&
32984 .cindex "virus scanners" "simple socket-connected"
32985 This is a general-purpose way of talking to simple scanner daemons
32986 running on the local machine.
32987 There are four options:
32988 an address (which may be an IP address and port, or the path of a Unix socket),
32989 a commandline to send (may include a single %s which will be replaced with
32990 the path to the mail file to be scanned),
32991 an RE to trigger on from the returned data,
32992 and an RE to extract malware_name from the returned data.
32993 For example:
32994 .code
32995 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
32996 .endd
32997 Note that surrounding whitespace is stripped from each option, meaning
32998 there is no way to specify a trailing newline.
32999 The socket specifier and both regular-expressions are required.
33000 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33001 specify an empty element to get this.
33002
33003 .vitem &%sophie%&
33004 .cindex "virus scanners" "Sophos and Sophie"
33005 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33006 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33007 for this scanner type is the path to the UNIX socket that Sophie uses for
33008 client communication. For example:
33009 .code
33010 av_scanner = sophie:/tmp/sophie
33011 .endd
33012 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33013 the option.
33014 .endlist
33015
33016 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33017 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33018 ACL.
33019
33020 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33021 makes it possible to use different scanners. See further below for an example.
33022 The &%malware%& condition caches its results, so when you use it multiple times
33023 for the same message, the actual scanning process is only carried out once.
33024 However, using expandable items in &%av_scanner%& disables this caching, in
33025 which case each use of the &%malware%& condition causes a new scan of the
33026 message.
33027
33028 The &%malware%& condition takes a right-hand argument that is expanded before
33029 use and taken as a list, slash-separated by default.
33030 The first element can then be one of
33031
33032 .ilist
33033 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33034 The condition succeeds if a virus was found, and fail otherwise. This is the
33035 recommended usage.
33036 .next
33037 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33038 the condition fails immediately.
33039 .next
33040 A regular expression, in which case the message is scanned for viruses. The
33041 condition succeeds if a virus is found and its name matches the regular
33042 expression. This allows you to take special actions on certain types of virus.
33043 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33044 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33045 .endlist
33046
33047 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33048 messages even if there is a problem with the virus scanner.
33049 Otherwise, such a problem causes the ACL to defer.
33050
33051 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33052 specify a non-default timeout.  The default is two minutes.
33053 For example:
33054 .code
33055 malware = * / defer_ok / tmo=10s
33056 .endd
33057 A timeout causes the ACL to defer.
33058
33059 .vindex "&$callout_address$&"
33060 When a connection is made to the scanner the expansion variable &$callout_address$&
33061 is set to record the actual address used.
33062
33063 .vindex "&$malware_name$&"
33064 When a virus is found, the condition sets up an expansion variable called
33065 &$malware_name$& that contains the name of the virus. You can use it in a
33066 &%message%& modifier that specifies the error returned to the sender, and/or in
33067 logging data.
33068
33069 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33070 imposed by your anti-virus scanner.
33071
33072 Here is a very simple scanning example:
33073 .code
33074 deny message = This message contains malware ($malware_name)
33075      malware = *
33076 .endd
33077 The next example accepts messages when there is a problem with the scanner:
33078 .code
33079 deny message = This message contains malware ($malware_name)
33080      malware = */defer_ok
33081 .endd
33082 The next example shows how to use an ACL variable to scan with both sophie and
33083 aveserver. It assumes you have set:
33084 .code
33085 av_scanner = $acl_m0
33086 .endd
33087 in the main Exim configuration.
33088 .code
33089 deny message = This message contains malware ($malware_name)
33090      set acl_m0 = sophie
33091      malware = *
33092
33093 deny message = This message contains malware ($malware_name)
33094      set acl_m0 = aveserver
33095      malware = *
33096 .endd
33097
33098
33099 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33100 .cindex "content scanning" "for spam"
33101 .cindex "spam scanning"
33102 .cindex "SpamAssassin"
33103 .cindex "Rspamd"
33104 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33105 score and a report for the message.
33106 Support is also provided for Rspamd.
33107
33108 For more information about installation and configuration of SpamAssassin or
33109 Rspamd refer to their respective websites at
33110 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33111
33112 SpamAssassin can be installed with CPAN by running:
33113 .code
33114 perl -MCPAN -e 'install Mail::SpamAssassin'
33115 .endd
33116 SpamAssassin has its own set of configuration files. Please review its
33117 documentation to see how you can tweak it. The default installation should work
33118 nicely, however.
33119
33120 .oindex "&%spamd_address%&"
33121 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33122 intend to use an instance running on the local host you do not need to set
33123 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33124 you must set the &%spamd_address%& option in the global part of the Exim
33125 configuration as follows (example):
33126 .code
33127 spamd_address = 192.168.99.45 783
33128 .endd
33129 The SpamAssassin protocol relies on a TCP half-close from the client.
33130 If your SpamAssassin client side is running a Linux system with an
33131 iptables firewall, consider setting
33132 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33133 timeout, Exim uses when waiting for a response from the SpamAssassin
33134 server (currently defaulting to 120s).  With a lower value the Linux
33135 connection tracking may consider your half-closed connection as dead too
33136 soon.
33137
33138
33139 To use Rspamd (which by default listens on all local addresses
33140 on TCP port 11333)
33141 you should add &%variant=rspamd%& after the address/port pair, for example:
33142 .code
33143 spamd_address = 127.0.0.1 11333 variant=rspamd
33144 .endd
33145
33146 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33147 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33148 filename instead of an address/port pair:
33149 .code
33150 spamd_address = /var/run/spamd_socket
33151 .endd
33152 You can have multiple &%spamd%& servers to improve scalability. These can
33153 reside on other hardware reachable over the network. To specify multiple
33154 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33155 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33156 .code
33157 spamd_address = 192.168.2.10 783 : \
33158                 192.168.2.11 783 : \
33159                 192.168.2.12 783
33160 .endd
33161 Up to 32 &%spamd%& servers are supported.
33162 When a server fails to respond to the connection attempt, all other
33163 servers are tried until one succeeds. If no server responds, the &%spam%&
33164 condition defers.
33165
33166 Unix and TCP socket specifications may be mixed in any order.
33167 Each element of the list is a list itself, space-separated by default
33168 and changeable in the usual way (&<<SECTlistsepchange>>&);
33169 take care to not double the separator.
33170
33171 For TCP socket specifications a host name or IP (v4 or v6, but
33172 subject to list-separator quoting rules) address can be used,
33173 and the port can be one or a dash-separated pair.
33174 In the latter case, the range is tried in strict order.
33175
33176 Elements after the first for Unix sockets, or second for TCP socket,
33177 are options.
33178 The supported options are:
33179 .code
33180 pri=<priority>      Selection priority
33181 weight=<value>      Selection bias
33182 time=<start>-<end>  Use only between these times of day
33183 retry=<timespec>    Retry on connect fail
33184 tmo=<timespec>      Connection time limit
33185 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33186 .endd
33187
33188 The &`pri`& option specifies a priority for the server within the list,
33189 higher values being tried first.
33190 The default priority is 1.
33191
33192 The &`weight`& option specifies a selection bias.
33193 Within a priority set
33194 servers are queried in a random fashion, weighted by this value.
33195 The default value for selection bias is 1.
33196
33197 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33198 in the local time zone; each element being one or more digits.
33199 Either the seconds or both minutes and seconds, plus the leading &`.`&
33200 characters, may be omitted and will be taken as zero.
33201
33202 Timeout specifications for the &`retry`& and &`tmo`& options
33203 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33204
33205 The &`tmo`& option specifies an overall timeout for communication.
33206 The default value is two minutes.
33207
33208 The &`retry`& option specifies a time after which a single retry for
33209 a failed connect is made.
33210 The default is to not retry.
33211
33212 The &%spamd_address%& variable is expanded before use if it starts with
33213 a dollar sign. In this case, the expansion may return a string that is
33214 used as the list so that multiple spamd servers can be the result of an
33215 expansion.
33216
33217 .vindex "&$callout_address$&"
33218 When a connection is made to the server the expansion variable &$callout_address$&
33219 is set to record the actual address used.
33220
33221 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33222 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33223 .code
33224 deny message = This message was classified as SPAM
33225      spam = joe
33226 .endd
33227 The right-hand side of the &%spam%& condition specifies a name. This is
33228 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33229 to scan using a specific profile, but rather use the SpamAssassin system-wide
33230 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33231 Rspamd does not use this setting. However, you must put something on the
33232 right-hand side.
33233
33234 The name allows you to use per-domain or per-user antispam profiles in
33235 principle, but this is not straightforward in practice, because a message may
33236 have multiple recipients, not necessarily all in the same domain. Because the
33237 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33238 read the contents of the message, the variables &$local_part$& and &$domain$&
33239 are not set.
33240 Careful enforcement of single-recipient messages
33241 (e.g. by responding with defer in the recipient ACL for all recipients
33242 after the first),
33243 or the use of PRDR,
33244 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33245 are needed to use this feature.
33246
33247 The right-hand side of the &%spam%& condition is expanded before being used, so
33248 you can put lookups or conditions there. When the right-hand side evaluates to
33249 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33250
33251
33252 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33253 large ones may cause significant performance degradation. As most spam messages
33254 are quite small, it is recommended that you do not scan the big ones. For
33255 example:
33256 .code
33257 deny message = This message was classified as SPAM
33258      condition = ${if < {$message_size}{10K}}
33259      spam = nobody
33260 .endd
33261
33262 The &%spam%& condition returns true if the threshold specified in the user's
33263 SpamAssassin profile has been matched or exceeded. If you want to use the
33264 &%spam%& condition for its side effects (see the variables below), you can make
33265 it always return &"true"& by appending &`:true`& to the username.
33266
33267 .cindex "spam scanning" "returned variables"
33268 When the &%spam%& condition is run, it sets up a number of expansion
33269 variables.
33270 Except for &$spam_report$&,
33271 these variables are saved with the received message so are
33272 available for use at delivery time.
33273
33274 .vlist
33275 .vitem &$spam_score$&
33276 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33277 for inclusion in log or reject messages.
33278
33279 .vitem &$spam_score_int$&
33280 The spam score of the message, multiplied by ten, as an integer value. For
33281 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33282 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33283 The integer value is useful for numeric comparisons in conditions.
33284
33285 .vitem &$spam_bar$&
33286 A string consisting of a number of &"+"& or &"-"& characters, representing the
33287 integer part of the spam score value. A spam score of 4.4 would have a
33288 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33289 headers, since MUAs can match on such strings. The maximum length of the
33290 spam bar is 50 characters.
33291
33292 .vitem &$spam_report$&
33293 A multiline text table, containing the full SpamAssassin report for the
33294 message. Useful for inclusion in headers or reject messages.
33295 This variable is only usable in a DATA-time ACL.
33296 Beware that SpamAssassin may return non-ASCII characters, especially
33297 when running in country-specific locales, which are not legal
33298 unencoded in headers.
33299
33300 .vitem &$spam_action$&
33301 For SpamAssassin either 'reject' or 'no action' depending on the
33302 spam score versus threshold.
33303 For Rspamd, the recommended action.
33304
33305 .endlist
33306
33307 The &%spam%& condition caches its results unless expansion in
33308 spamd_address was used. If you call it again with the same user name, it
33309 does not scan again, but rather returns the same values as before.
33310
33311 The &%spam%& condition returns DEFER if there is any error while running
33312 the message through SpamAssassin or if the expansion of spamd_address
33313 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33314 statement block), append &`/defer_ok`& to the right-hand side of the
33315 spam condition, like this:
33316 .code
33317 deny message = This message was classified as SPAM
33318      spam    = joe/defer_ok
33319 .endd
33320 This causes messages to be accepted even if there is a problem with &%spamd%&.
33321
33322 Here is a longer, commented example of the use of the &%spam%&
33323 condition:
33324 .code
33325 # put headers in all messages (no matter if spam or not)
33326 warn  spam = nobody:true
33327       add_header = X-Spam-Score: $spam_score ($spam_bar)
33328       add_header = X-Spam-Report: $spam_report
33329
33330 # add second subject line with *SPAM* marker when message
33331 # is over threshold
33332 warn  spam = nobody
33333       add_header = Subject: *SPAM* $h_Subject:
33334
33335 # reject spam at high scores (> 12)
33336 deny  message = This message scored $spam_score spam points.
33337       spam = nobody:true
33338       condition = ${if >{$spam_score_int}{120}{1}{0}}
33339 .endd
33340
33341
33342
33343 .section "Scanning MIME parts" "SECTscanmimepart"
33344 .cindex "content scanning" "MIME parts"
33345 .cindex "MIME content scanning"
33346 .oindex "&%acl_smtp_mime%&"
33347 .oindex "&%acl_not_smtp_mime%&"
33348 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33349 each MIME part of an SMTP message, including multipart types, in the sequence
33350 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33351 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33352 options may both refer to the same ACL if you want the same processing in both
33353 cases.
33354
33355 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33356 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33357 the case of a non-SMTP message. However, a MIME ACL is called only if the
33358 message contains a &'Content-Type:'& header line. When a call to a MIME
33359 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33360 result code is sent to the client. In the case of an SMTP message, the
33361 &%acl_smtp_data%& ACL is not called when this happens.
33362
33363 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33364 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33365 condition to match against the raw MIME part. You can also use the
33366 &%mime_regex%& condition to match against the decoded MIME part (see section
33367 &<<SECTscanregex>>&).
33368
33369 At the start of a MIME ACL, a number of variables are set from the header
33370 information for the relevant MIME part. These are described below. The contents
33371 of the MIME part are not by default decoded into a disk file except for MIME
33372 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33373 part into a disk file, you can use the &%decode%& condition. The general
33374 syntax is:
33375 .display
33376 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33377 .endd
33378 The right hand side is expanded before use. After expansion,
33379 the value can be:
33380
33381 .olist
33382 &"0"& or &"false"&, in which case no decoding is done.
33383 .next
33384 The string &"default"&. In that case, the file is put in the temporary
33385 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33386 a sequential filename consisting of the message id and a sequence number. The
33387 full path and name is available in &$mime_decoded_filename$& after decoding.
33388 .next
33389 A full path name starting with a slash. If the full name is an existing
33390 directory, it is used as a replacement for the default directory. The filename
33391 is then sequentially assigned. If the path does not exist, it is used as
33392 the full path and filename.
33393 .next
33394 If the string does not start with a slash, it is used as the
33395 filename, and the default path is then used.
33396 .endlist
33397 The &%decode%& condition normally succeeds. It is only false for syntax
33398 errors or unusual circumstances such as memory shortages. You can easily decode
33399 a file with its original, proposed filename using
33400 .code
33401 decode = $mime_filename
33402 .endd
33403 However, you should keep in mind that &$mime_filename$& might contain
33404 anything. If you place files outside of the default path, they are not
33405 automatically unlinked.
33406
33407 For RFC822 attachments (these are messages attached to messages, with a
33408 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33409 as for the primary message, only that the &$mime_is_rfc822$& expansion
33410 variable is set (see below). Attached messages are always decoded to disk
33411 before being checked, and the files are unlinked once the check is done.
33412
33413 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33414 used to match regular expressions against raw and decoded MIME parts,
33415 respectively. They are described in section &<<SECTscanregex>>&.
33416
33417 .cindex "MIME content scanning" "returned variables"
33418 The following list describes all expansion variables that are
33419 available in the MIME ACL:
33420
33421 .vlist
33422 .vitem &$mime_boundary$&
33423 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33424 have a boundary string, which is stored in this variable. If the current part
33425 has no boundary parameter in the &'Content-Type:'& header, this variable
33426 contains the empty string.
33427
33428 .vitem &$mime_charset$&
33429 This variable contains the character set identifier, if one was found in the
33430 &'Content-Type:'& header. Examples for charset identifiers are:
33431 .code
33432 us-ascii
33433 gb2312 (Chinese)
33434 iso-8859-1
33435 .endd
33436 Please note that this value is not normalized, so you should do matches
33437 case-insensitively.
33438
33439 .vitem &$mime_content_description$&
33440 This variable contains the normalized content of the &'Content-Description:'&
33441 header. It can contain a human-readable description of the parts content. Some
33442 implementations repeat the filename for attachments here, but they are usually
33443 only used for display purposes.
33444
33445 .vitem &$mime_content_disposition$&
33446 This variable contains the normalized content of the &'Content-Disposition:'&
33447 header. You can expect strings like &"attachment"& or &"inline"& here.
33448
33449 .vitem &$mime_content_id$&
33450 This variable contains the normalized content of the &'Content-ID:'& header.
33451 This is a unique ID that can be used to reference a part from another part.
33452
33453 .vitem &$mime_content_size$&
33454 This variable is set only after the &%decode%& modifier (see above) has been
33455 successfully run. It contains the size of the decoded part in kilobytes. The
33456 size is always rounded up to full kilobytes, so only a completely empty part
33457 has a &$mime_content_size$& of zero.
33458
33459 .vitem &$mime_content_transfer_encoding$&
33460 This variable contains the normalized content of the
33461 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33462 type. Typical values are &"base64"& and &"quoted-printable"&.
33463
33464 .vitem &$mime_content_type$&
33465 If the MIME part has a &'Content-Type:'& header, this variable contains its
33466 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33467 are some examples of popular MIME types, as they may appear in this variable:
33468 .code
33469 text/plain
33470 text/html
33471 application/octet-stream
33472 image/jpeg
33473 audio/midi
33474 .endd
33475 If the MIME part has no &'Content-Type:'& header, this variable contains the
33476 empty string.
33477
33478 .vitem &$mime_decoded_filename$&
33479 This variable is set only after the &%decode%& modifier (see above) has been
33480 successfully run. It contains the full path and filename of the file
33481 containing the decoded data.
33482 .endlist
33483
33484 .cindex "RFC 2047"
33485 .vlist
33486 .vitem &$mime_filename$&
33487 This is perhaps the most important of the MIME variables. It contains a
33488 proposed filename for an attachment, if one was found in either the
33489 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33490 RFC2047
33491 or RFC2231
33492 decoded, but no additional sanity checks are done.
33493  If no filename was
33494 found, this variable contains the empty string.
33495
33496 .vitem &$mime_is_coverletter$&
33497 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33498 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33499 content in the cover letter, while not restricting attachments at all.
33500
33501 The variable contains 1 (true) for a MIME part believed to be part of the
33502 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33503 follows:
33504
33505 .olist
33506 The outermost MIME part of a message is always a cover letter.
33507
33508 .next
33509 If a multipart/alternative or multipart/related MIME part is a cover letter,
33510 so are all MIME subparts within that multipart.
33511
33512 .next
33513 If any other multipart is a cover letter, the first subpart is a cover letter,
33514 and the rest are attachments.
33515
33516 .next
33517 All parts contained within an attachment multipart are attachments.
33518 .endlist olist
33519
33520 As an example, the following will ban &"HTML mail"& (including that sent with
33521 alternative plain text), while allowing HTML files to be attached. HTML
33522 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33523 .code
33524 deny message = HTML mail is not accepted here
33525 !condition = $mime_is_rfc822
33526 condition = $mime_is_coverletter
33527 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33528 .endd
33529 .vitem &$mime_is_multipart$&
33530 This variable has the value 1 (true) when the current part has the main type
33531 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33532 Since multipart entities only serve as containers for other parts, you may not
33533 want to carry out specific actions on them.
33534
33535 .vitem &$mime_is_rfc822$&
33536 This variable has the value 1 (true) if the current part is not a part of the
33537 checked message itself, but part of an attached message. Attached message
33538 decoding is fully recursive.
33539
33540 .vitem &$mime_part_count$&
33541 This variable is a counter that is raised for each processed MIME part. It
33542 starts at zero for the very first part (which is usually a multipart). The
33543 counter is per-message, so it is reset when processing RFC822 attachments (see
33544 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33545 complete, so you can use it in the DATA ACL to determine the number of MIME
33546 parts of a message. For non-MIME messages, this variable contains the value -1.
33547 .endlist
33548
33549
33550
33551 .section "Scanning with regular expressions" "SECTscanregex"
33552 .cindex "content scanning" "with regular expressions"
33553 .cindex "regular expressions" "content scanning with"
33554 You can specify your own custom regular expression matches on the full body of
33555 the message, or on individual MIME parts.
33556
33557 The &%regex%& condition takes one or more regular expressions as arguments and
33558 matches them against the full message (when called in the DATA ACL) or a raw
33559 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33560 linewise, with a maximum line length of 32K characters. That means you cannot
33561 have multiline matches with the &%regex%& condition.
33562
33563 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33564 to 32K of decoded content (the whole content at once, not linewise). If the
33565 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33566 is decoded automatically when &%mime_regex%& is executed (using default path
33567 and filename values). If the decoded data is larger than  32K, only the first
33568 32K characters are checked.
33569
33570 The regular expressions are passed as a colon-separated list. To include a
33571 literal colon, you must double it. Since the whole right-hand side string is
33572 expanded before being used, you must also escape dollar signs and backslashes
33573 with more backslashes, or use the &`\N`& facility to disable expansion.
33574 Here is a simple example that contains two regular expressions:
33575 .code
33576 deny message = contains blacklisted regex ($regex_match_string)
33577      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33578 .endd
33579 The conditions returns true if any one of the regular expressions matches. The
33580 &$regex_match_string$& expansion variable is then set up and contains the
33581 matching regular expression.
33582 The expansion variables &$regex1$& &$regex2$& etc
33583 are set to any substrings captured by the regular expression.
33584
33585 &*Warning*&: With large messages, these conditions can be fairly
33586 CPU-intensive.
33587
33588 .ecindex IIDcosca
33589
33590
33591
33592
33593 . ////////////////////////////////////////////////////////////////////////////
33594 . ////////////////////////////////////////////////////////////////////////////
33595
33596 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33597          "Local scan function"
33598 .scindex IIDlosca "&[local_scan()]& function" "description of"
33599 .cindex "customizing" "input scan using C function"
33600 .cindex "policy control" "by local scan function"
33601 In these days of email worms, viruses, and ever-increasing spam, some sites
33602 want to apply a lot of checking to messages before accepting them.
33603
33604 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33605 passing messages to external virus and spam scanning software. You can also do
33606 a certain amount in Exim itself through string expansions and the &%condition%&
33607 condition in the ACL that runs after the SMTP DATA command or the ACL for
33608 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33609
33610 To allow for further customization to a site's own requirements, there is the
33611 possibility of linking Exim with a private message scanning function, written
33612 in C. If you want to run code that is written in something other than C, you
33613 can of course use a little C stub to call it.
33614
33615 The local scan function is run once for every incoming message, at the point
33616 when Exim is just about to accept the message.
33617 It can therefore be used to control non-SMTP messages from local processes as
33618 well as messages arriving via SMTP.
33619
33620 Exim applies a timeout to calls of the local scan function, and there is an
33621 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33622 Zero means &"no timeout"&.
33623 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33624 before calling the local scan function, so that the most common types of crash
33625 are caught. If the timeout is exceeded or one of those signals is caught, the
33626 incoming message is rejected with a temporary error if it is an SMTP message.
33627 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33628 code. The incident is logged on the main and reject logs.
33629
33630
33631
33632 .section "Building Exim to use a local scan function" "SECID207"
33633 .cindex "&[local_scan()]& function" "building Exim to use"
33634 To make use of the local scan function feature, you must tell Exim where your
33635 function is before building Exim, by setting
33636 both HAVE_LOCAL_SCAN and
33637 LOCAL_SCAN_SOURCE in your
33638 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33639 directory, so you might set
33640 .code
33641 HAVE_LOCAL_SCAN=yes
33642 LOCAL_SCAN_SOURCE=Local/local_scan.c
33643 .endd
33644 for example. The function must be called &[local_scan()]&. It is called by
33645 Exim after it has received a message, when the success return code is about to
33646 be sent. This is after all the ACLs have been run. The return code from your
33647 function controls whether the message is actually accepted or not. There is a
33648 commented template function (that just accepts the message) in the file
33649 _src/local_scan.c_.
33650
33651 If you want to make use of Exim's runtime configuration file to set options
33652 for your &[local_scan()]& function, you must also set
33653 .code
33654 LOCAL_SCAN_HAS_OPTIONS=yes
33655 .endd
33656 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33657
33658
33659
33660
33661 .section "API for local_scan()" "SECTapiforloc"
33662 .cindex "&[local_scan()]& function" "API description"
33663 .cindex &%dlfunc%& "API description"
33664 You must include this line near the start of your code:
33665 .code
33666 #include "local_scan.h"
33667 .endd
33668 This header file defines a number of variables and other values, and the
33669 prototype for the function itself. Exim is coded to use unsigned char values
33670 almost exclusively, and one of the things this header defines is a shorthand
33671 for &`unsigned char`& called &`uschar`&.
33672 It also contains the following macro definitions, to simplify casting character
33673 strings and pointers to character strings:
33674 .code
33675 #define CS   (char *)
33676 #define CCS  (const char *)
33677 #define CSS  (char **)
33678 #define US   (unsigned char *)
33679 #define CUS  (const unsigned char *)
33680 #define USS  (unsigned char **)
33681 .endd
33682 The function prototype for &[local_scan()]& is:
33683 .code
33684 extern int local_scan(int fd, uschar **return_text);
33685 .endd
33686 The arguments are as follows:
33687
33688 .ilist
33689 &%fd%& is a file descriptor for the file that contains the body of the message
33690 (the -D file). The file is open for reading and writing, but updating it is not
33691 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33692
33693 The descriptor is positioned at character 19 of the file, which is the first
33694 character of the body itself, because the first 19 characters are the message
33695 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33696 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33697 case this changes in some future version.
33698 .next
33699 &%return_text%& is an address which you can use to return a pointer to a text
33700 string at the end of the function. The value it points to on entry is NULL.
33701 .endlist
33702
33703 The function must return an &%int%& value which is one of the following macros:
33704
33705 .vlist
33706 .vitem &`LOCAL_SCAN_ACCEPT`&
33707 .vindex "&$local_scan_data$&"
33708 The message is accepted. If you pass back a string of text, it is saved with
33709 the message, and made available in the variable &$local_scan_data$&. No
33710 newlines are permitted (if there are any, they are turned into spaces) and the
33711 maximum length of text is 1000 characters.
33712
33713 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33714 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33715 queued without immediate delivery, and is frozen.
33716
33717 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33718 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33719 queued without immediate delivery.
33720
33721 .vitem &`LOCAL_SCAN_REJECT`&
33722 The message is rejected; the returned text is used as an error message which is
33723 passed back to the sender and which is also logged. Newlines are permitted &--
33724 they cause a multiline response for SMTP rejections, but are converted to
33725 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33726 used.
33727
33728 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33729 The message is temporarily rejected; the returned text is used as an error
33730 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33731 problem"& is used.
33732
33733 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33734 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33735 message is not written to the reject log. It has the effect of unsetting the
33736 &%rejected_header%& log selector for just this rejection. If
33737 &%rejected_header%& is already unset (see the discussion of the
33738 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33739 same as LOCAL_SCAN_REJECT.
33740
33741 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33742 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33743 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33744 .endlist
33745
33746 If the message is not being received by interactive SMTP, rejections are
33747 reported by writing to &%stderr%& or by sending an email, as configured by the
33748 &%-oe%& command line options.
33749
33750
33751
33752 .section "Configuration options for local_scan()" "SECTconoptloc"
33753 .cindex "&[local_scan()]& function" "configuration options"
33754 It is possible to have option settings in the main configuration file
33755 that set values in static variables in the &[local_scan()]& module. If you
33756 want to do this, you must have the line
33757 .code
33758 LOCAL_SCAN_HAS_OPTIONS=yes
33759 .endd
33760 in your &_Local/Makefile_& when you build Exim. (This line is in
33761 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33762 file, you must define static variables to hold the option values, and a table
33763 to define them.
33764
33765 The table must be a vector called &%local_scan_options%&, of type
33766 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33767 and a pointer to the variable that holds the value. The entries must appear in
33768 alphabetical order. Following &%local_scan_options%& you must also define a
33769 variable called &%local_scan_options_count%& that contains the number of
33770 entries in the table. Here is a short example, showing two kinds of option:
33771 .code
33772 static int my_integer_option = 42;
33773 static uschar *my_string_option = US"a default string";
33774
33775 optionlist local_scan_options[] = {
33776   { "my_integer", opt_int,       &my_integer_option },
33777   { "my_string",  opt_stringptr, &my_string_option }
33778 };
33779
33780 int local_scan_options_count =
33781   sizeof(local_scan_options)/sizeof(optionlist);
33782 .endd
33783 The values of the variables can now be changed from Exim's runtime
33784 configuration file by including a local scan section as in this example:
33785 .code
33786 begin local_scan
33787 my_integer = 99
33788 my_string = some string of text...
33789 .endd
33790 The available types of option data are as follows:
33791
33792 .vlist
33793 .vitem &*opt_bool*&
33794 This specifies a boolean (true/false) option. The address should point to a
33795 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33796 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33797 whether such a variable has been set at all, you can initialize it to
33798 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33799 values.)
33800
33801 .vitem &*opt_fixed*&
33802 This specifies a fixed point number, such as is used for load averages.
33803 The address should point to a variable of type &`int`&. The value is stored
33804 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33805
33806 .vitem &*opt_int*&
33807 This specifies an integer; the address should point to a variable of type
33808 &`int`&. The value may be specified in any of the integer formats accepted by
33809 Exim.
33810
33811 .vitem &*opt_mkint*&
33812 This is the same as &%opt_int%&, except that when such a value is output in a
33813 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33814 printed with the suffix K or M.
33815
33816 .vitem &*opt_octint*&
33817 This also specifies an integer, but the value is always interpreted as an
33818 octal integer, whether or not it starts with the digit zero, and it is
33819 always output in octal.
33820
33821 .vitem &*opt_stringptr*&
33822 This specifies a string value; the address must be a pointer to a
33823 variable that points to a string (for example, of type &`uschar *`&).
33824
33825 .vitem &*opt_time*&
33826 This specifies a time interval value. The address must point to a variable of
33827 type &`int`&. The value that is placed there is a number of seconds.
33828 .endlist
33829
33830 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33831 out the values of all the &[local_scan()]& options.
33832
33833
33834
33835 .section "Available Exim variables" "SECID208"
33836 .cindex "&[local_scan()]& function" "available Exim variables"
33837 The header &_local_scan.h_& gives you access to a number of C variables. These
33838 are the only ones that are guaranteed to be maintained from release to release.
33839 Note, however, that you can obtain the value of any Exim expansion variable,
33840 including &$recipients$&, by calling &'expand_string()'&. The exported
33841 C variables are as follows:
33842
33843 .vlist
33844 .vitem &*int&~body_linecount*&
33845 This variable contains the number of lines in the message's body.
33846 It is not valid if the &%spool_files_wireformat%& option is used.
33847
33848 .vitem &*int&~body_zerocount*&
33849 This variable contains the number of binary zero bytes in the message's body.
33850 It is not valid if the &%spool_files_wireformat%& option is used.
33851
33852 .vitem &*unsigned&~int&~debug_selector*&
33853 This variable is set to zero when no debugging is taking place. Otherwise, it
33854 is a bitmap of debugging selectors. Two bits are identified for use in
33855 &[local_scan()]&; they are defined as macros:
33856
33857 .ilist
33858 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33859 testing option that is not privileged &-- any caller may set it. All the
33860 other selector bits can be set only by admin users.
33861
33862 .next
33863 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33864 by the &`+local_scan`& debug selector. It is not included in the default set
33865 of debugging bits.
33866 .endlist ilist
33867
33868 Thus, to write to the debugging output only when &`+local_scan`& has been
33869 selected, you should use code like this:
33870 .code
33871 if ((debug_selector & D_local_scan) != 0)
33872   debug_printf("xxx", ...);
33873 .endd
33874 .vitem &*uschar&~*expand_string_message*&
33875 After a failing call to &'expand_string()'& (returned value NULL), the
33876 variable &%expand_string_message%& contains the error message, zero-terminated.
33877
33878 .vitem &*header_line&~*header_list*&
33879 A pointer to a chain of header lines. The &%header_line%& structure is
33880 discussed below.
33881
33882 .vitem &*header_line&~*header_last*&
33883 A pointer to the last of the header lines.
33884
33885 .vitem &*uschar&~*headers_charset*&
33886 The value of the &%headers_charset%& configuration option.
33887
33888 .vitem &*BOOL&~host_checking*&
33889 This variable is TRUE during a host checking session that is initiated by the
33890 &%-bh%& command line option.
33891
33892 .vitem &*uschar&~*interface_address*&
33893 The IP address of the interface that received the message, as a string. This
33894 is NULL for locally submitted messages.
33895
33896 .vitem &*int&~interface_port*&
33897 The port on which this message was received. When testing with the &%-bh%&
33898 command line option, the value of this variable is -1 unless a port has been
33899 specified via the &%-oMi%& option.
33900
33901 .vitem &*uschar&~*message_id*&
33902 This variable contains Exim's message id for the incoming message (the value of
33903 &$message_exim_id$&) as a zero-terminated string.
33904
33905 .vitem &*uschar&~*received_protocol*&
33906 The name of the protocol by which the message was received.
33907
33908 .vitem &*int&~recipients_count*&
33909 The number of accepted recipients.
33910
33911 .vitem &*recipient_item&~*recipients_list*&
33912 .cindex "recipient" "adding in local scan"
33913 .cindex "recipient" "removing in local scan"
33914 The list of accepted recipients, held in a vector of length
33915 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33916 can add additional recipients by calling &'receive_add_recipient()'& (see
33917 below). You can delete recipients by removing them from the vector and
33918 adjusting the value in &%recipients_count%&. In particular, by setting
33919 &%recipients_count%& to zero you remove all recipients. If you then return the
33920 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33921 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33922 and then call &'receive_add_recipient()'& as often as needed.
33923
33924 .vitem &*uschar&~*sender_address*&
33925 The envelope sender address. For bounce messages this is the empty string.
33926
33927 .vitem &*uschar&~*sender_host_address*&
33928 The IP address of the sending host, as a string. This is NULL for
33929 locally-submitted messages.
33930
33931 .vitem &*uschar&~*sender_host_authenticated*&
33932 The name of the authentication mechanism that was used, or NULL if the message
33933 was not received over an authenticated SMTP connection.
33934
33935 .vitem &*uschar&~*sender_host_name*&
33936 The name of the sending host, if known.
33937
33938 .vitem &*int&~sender_host_port*&
33939 The port on the sending host.
33940
33941 .vitem &*BOOL&~smtp_input*&
33942 This variable is TRUE for all SMTP input, including BSMTP.
33943
33944 .vitem &*BOOL&~smtp_batched_input*&
33945 This variable is TRUE for BSMTP input.
33946
33947 .vitem &*int&~store_pool*&
33948 The contents of this variable control which pool of memory is used for new
33949 requests. See section &<<SECTmemhanloc>>& for details.
33950 .endlist
33951
33952
33953 .section "Structure of header lines" "SECID209"
33954 The &%header_line%& structure contains the members listed below.
33955 You can add additional header lines by calling the &'header_add()'& function
33956 (see below). You can cause header lines to be ignored (deleted) by setting
33957 their type to *.
33958
33959
33960 .vlist
33961 .vitem &*struct&~header_line&~*next*&
33962 A pointer to the next header line, or NULL for the last line.
33963
33964 .vitem &*int&~type*&
33965 A code identifying certain headers that Exim recognizes. The codes are printing
33966 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33967 Notice in particular that any header line whose type is * is not transmitted
33968 with the message. This flagging is used for header lines that have been
33969 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33970 lines.) Effectively, * means &"deleted"&.
33971
33972 .vitem &*int&~slen*&
33973 The number of characters in the header line, including the terminating and any
33974 internal newlines.
33975
33976 .vitem &*uschar&~*text*&
33977 A pointer to the text of the header. It always ends with a newline, followed by
33978 a zero byte. Internal newlines are preserved.
33979 .endlist
33980
33981
33982
33983 .section "Structure of recipient items" "SECID210"
33984 The &%recipient_item%& structure contains these members:
33985
33986 .vlist
33987 .vitem &*uschar&~*address*&
33988 This is a pointer to the recipient address as it was received.
33989
33990 .vitem &*int&~pno*&
33991 This is used in later Exim processing when top level addresses are created by
33992 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
33993 and must always contain -1 at this stage.
33994
33995 .vitem &*uschar&~*errors_to*&
33996 If this value is not NULL, bounce messages caused by failing to deliver to the
33997 recipient are sent to the address it contains. In other words, it overrides the
33998 envelope sender for this one recipient. (Compare the &%errors_to%& generic
33999 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34000 an unqualified address, Exim qualifies it using the domain from
34001 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34002 is NULL for all recipients.
34003 .endlist
34004
34005
34006
34007 .section "Available Exim functions" "SECID211"
34008 .cindex "&[local_scan()]& function" "available Exim functions"
34009 The header &_local_scan.h_& gives you access to a number of Exim functions.
34010 These are the only ones that are guaranteed to be maintained from release to
34011 release:
34012
34013 .vlist
34014 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34015        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34016
34017 This function creates a child process that runs the command specified by
34018 &%argv%&. The environment for the process is specified by &%envp%&, which can
34019 be NULL if no environment variables are to be passed. A new umask is supplied
34020 for the process in &%newumask%&.
34021
34022 Pipes to the standard input and output of the new process are set up
34023 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34024 standard error is cloned to the standard output. If there are any file
34025 descriptors &"in the way"& in the new process, they are closed. If the final
34026 argument is TRUE, the new process is made into a process group leader.
34027
34028 The function returns the pid of the new process, or -1 if things go wrong.
34029
34030 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34031 This function waits for a child process to terminate, or for a timeout (in
34032 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34033 return value is as follows:
34034
34035 .ilist
34036 >= 0
34037
34038 The process terminated by a normal exit and the value is the process
34039 ending status.
34040
34041 .next
34042 < 0 and > &--256
34043
34044 The process was terminated by a signal and the value is the negation of the
34045 signal number.
34046
34047 .next
34048 &--256
34049
34050 The process timed out.
34051 .next
34052 &--257
34053
34054 The was some other error in wait(); &%errno%& is still set.
34055 .endlist
34056
34057 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34058 This function provide you with a means of submitting a new message to
34059 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34060 want, but this packages it all up for you.) The function creates a pipe,
34061 forks a subprocess that is running
34062 .code
34063 exim -t -oem -oi -f <>
34064 .endd
34065 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34066 that is connected to the standard input. The yield of the function is the PID
34067 of the subprocess. You can then write a message to the file descriptor, with
34068 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34069
34070 When you have finished, call &'child_close()'& to wait for the process to
34071 finish and to collect its ending status. A timeout value of zero is usually
34072 fine in this circumstance. Unless you have made a mistake with the recipient
34073 addresses, you should get a return code of zero.
34074
34075
34076 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34077        *sender_authentication)*&
34078 This function is a more sophisticated version of &'child_open()'&. The command
34079 that it runs is:
34080 .display
34081 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34082 .endd
34083 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34084
34085
34086 .vitem &*void&~debug_printf(char&~*,&~...)*&
34087 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34088 output is written to the standard error stream. If no debugging is selected,
34089 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34090 conditional on the &`local_scan`& debug selector by coding like this:
34091 .code
34092 if ((debug_selector & D_local_scan) != 0)
34093   debug_printf("xxx", ...);
34094 .endd
34095
34096 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34097 This is an interface to Exim's string expansion code. The return value is the
34098 expanded string, or NULL if there was an expansion failure.
34099 The C variable &%expand_string_message%& contains an error message after an
34100 expansion failure. If expansion does not change the string, the return value is
34101 the pointer to the input string. Otherwise, the return value points to a new
34102 block of memory that was obtained by a call to &'store_get()'&. See section
34103 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34104
34105 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34106 This function allows you to an add additional header line at the end of the
34107 existing ones. The first argument is the type, and should normally be a space
34108 character. The second argument is a format string and any number of
34109 substitution arguments as for &[sprintf()]&. You may include internal newlines
34110 if you want, and you must ensure that the string ends with a newline.
34111
34112 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34113         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34114 This function adds a new header line at a specified point in the header
34115 chain. The header itself is specified as for &'header_add()'&.
34116
34117 If &%name%& is NULL, the new header is added at the end of the chain if
34118 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34119 NULL, the header lines are searched for the first non-deleted header that
34120 matches the name. If one is found, the new header is added before it if
34121 &%after%& is false. If &%after%& is true, the new header is added after the
34122 found header and any adjacent subsequent ones with the same name (even if
34123 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34124 option controls where the header is added. If it is true, addition is at the
34125 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34126 headers, or at the top if there are no &'Received:'& headers, you could use
34127 .code
34128 header_add_at_position(TRUE, US"Received", TRUE,
34129   ' ', "X-xxx: ...");
34130 .endd
34131 Normally, there is always at least one non-deleted &'Received:'& header, but
34132 there may not be if &%received_header_text%& expands to an empty string.
34133
34134
34135 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34136 This function removes header lines. If &%occurrence%& is zero or negative, all
34137 occurrences of the header are removed. If occurrence is greater than zero, that
34138 particular instance of the header is removed. If no header(s) can be found that
34139 match the specification, the function does nothing.
34140
34141
34142 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34143         int&~length,&~BOOL&~notdel)*&"
34144 This function tests whether the given header has the given name. It is not just
34145 a string comparison, because white space is permitted between the name and the
34146 colon. If the &%notdel%& argument is true, a false return is forced for all
34147 &"deleted"& headers; otherwise they are not treated specially. For example:
34148 .code
34149 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34150 .endd
34151 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34152 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34153 This function base64-encodes a string, which is passed by address and length.
34154 The text may contain bytes of any value, including zero. The result is passed
34155 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34156 zero-terminated.
34157
34158 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34159 This function decodes a base64-encoded string. Its arguments are a
34160 zero-terminated base64-encoded string and the address of a variable that is set
34161 to point to the result, which is in dynamic memory. The length of the decoded
34162 string is the yield of the function. If the input is invalid base64 data, the
34163 yield is -1. A zero byte is added to the end of the output string to make it
34164 easy to interpret as a C string (assuming it contains no zeros of its own). The
34165 added zero byte is not included in the returned count.
34166
34167 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34168 This function checks for a match in a domain list. Domains are always
34169 matched caselessly. The return value is one of the following:
34170 .display
34171 &`OK     `& match succeeded
34172 &`FAIL   `& match failed
34173 &`DEFER  `& match deferred
34174 .endd
34175 DEFER is usually caused by some kind of lookup defer, such as the
34176 inability to contact a database.
34177
34178 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34179         BOOL&~caseless)*&"
34180 This function checks for a match in a local part list. The third argument
34181 controls case-sensitivity. The return values are as for
34182 &'lss_match_domain()'&.
34183
34184 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34185         BOOL&~caseless)*&"
34186 This function checks for a match in an address list. The third argument
34187 controls the case-sensitivity of the local part match. The domain is always
34188 matched caselessly. The return values are as for &'lss_match_domain()'&.
34189
34190 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34191         uschar&~*list)*&"
34192 This function checks for a match in a host list. The most common usage is
34193 expected to be
34194 .code
34195 lss_match_host(sender_host_name, sender_host_address, ...)
34196 .endd
34197 .vindex "&$sender_host_address$&"
34198 An empty address field matches an empty item in the host list. If the host name
34199 is NULL, the name corresponding to &$sender_host_address$& is automatically
34200 looked up if a host name is required to match an item in the list. The return
34201 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34202 returns ERROR in the case when it had to look up a host name, but the lookup
34203 failed.
34204
34205 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34206         *format,&~...)*&"
34207 This function writes to Exim's log files. The first argument should be zero (it
34208 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34209 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34210 them. It specifies to which log or logs the message is written. The remaining
34211 arguments are a format and relevant insertion arguments. The string should not
34212 contain any newlines, not even at the end.
34213
34214
34215 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34216 This function adds an additional recipient to the message. The first argument
34217 is the recipient address. If it is unqualified (has no domain), it is qualified
34218 with the &%qualify_recipient%& domain. The second argument must always be -1.
34219
34220 This function does not allow you to specify a private &%errors_to%& address (as
34221 described with the structure of &%recipient_item%& above), because it pre-dates
34222 the addition of that field to the structure. However, it is easy to add such a
34223 value afterwards. For example:
34224 .code
34225  receive_add_recipient(US"monitor@mydom.example", -1);
34226  recipients_list[recipients_count-1].errors_to =
34227    US"postmaster@mydom.example";
34228 .endd
34229
34230 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34231 This is a convenience function to remove a named recipient from the list of
34232 recipients. It returns true if a recipient was removed, and false if no
34233 matching recipient could be found. The argument must be a complete email
34234 address.
34235 .endlist
34236
34237
34238 .cindex "RFC 2047"
34239 .vlist
34240 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34241   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34242 This function decodes strings that are encoded according to RFC 2047. Typically
34243 these are the contents of header lines. First, each &"encoded word"& is decoded
34244 from the Q or B encoding into a byte-string. Then, if provided with the name of
34245 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34246 made  to translate the result to the named character set. If this fails, the
34247 binary string is returned with an error message.
34248
34249 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34250 maximum MIME word length is enforced. The third argument is the target
34251 encoding, or NULL if no translation is wanted.
34252
34253 .cindex "binary zero" "in RFC 2047 decoding"
34254 .cindex "RFC 2047" "binary zero in"
34255 If a binary zero is encountered in the decoded string, it is replaced by the
34256 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34257 not be 0 because header lines are handled as zero-terminated strings.
34258
34259 The function returns the result of processing the string, zero-terminated; if
34260 &%lenptr%& is not NULL, the length of the result is set in the variable to
34261 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34262
34263 If an error is encountered, the function returns NULL and uses the &%error%&
34264 argument to return an error message. The variable pointed to by &%error%& is
34265 set to NULL if there is no error; it may be set non-NULL even when the function
34266 returns a non-NULL value if decoding was successful, but there was a problem
34267 with translation.
34268
34269
34270 .vitem &*int&~smtp_fflush(void)*&
34271 This function is used in conjunction with &'smtp_printf()'&, as described
34272 below.
34273
34274 .vitem &*void&~smtp_printf(char&~*,&~...)*&
34275 The arguments of this function are like &[printf()]&; it writes to the SMTP
34276 output stream. You should use this function only when there is an SMTP output
34277 stream, that is, when the incoming message is being received via interactive
34278 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34279 is FALSE. If you want to test for an incoming message from another host (as
34280 opposed to a local process that used the &%-bs%& command line option), you can
34281 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34282 is involved.
34283
34284 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34285 output function, so it can be used for all forms of SMTP connection.
34286
34287 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34288 must start with an appropriate response code: 550 if you are going to return
34289 LOCAL_SCAN_REJECT, 451 if you are going to return
34290 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34291 initial lines of a multi-line response, the code must be followed by a hyphen
34292 to indicate that the line is not the final response line. You must also ensure
34293 that the lines you write terminate with CRLF. For example:
34294 .code
34295 smtp_printf("550-this is some extra info\r\n");
34296 return LOCAL_SCAN_REJECT;
34297 .endd
34298 Note that you can also create multi-line responses by including newlines in
34299 the data returned via the &%return_text%& argument. The added value of using
34300 &'smtp_printf()'& is that, for instance, you could introduce delays between
34301 multiple output lines.
34302
34303 The &'smtp_printf()'& function does not return any error indication, because it
34304 does not automatically flush pending output, and therefore does not test
34305 the state of the stream. (In the main code of Exim, flushing and error
34306 detection is done when Exim is ready for the next SMTP input command.) If
34307 you want to flush the output and check for an error (for example, the
34308 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34309 arguments. It flushes the output stream, and returns a non-zero value if there
34310 is an error.
34311
34312 .vitem &*void&~*store_get(int)*&
34313 This function accesses Exim's internal store (memory) manager. It gets a new
34314 chunk of memory whose size is given by the argument. Exim bombs out if it ever
34315 runs out of memory. See the next section for a discussion of memory handling.
34316
34317 .vitem &*void&~*store_get_perm(int)*&
34318 This function is like &'store_get()'&, but it always gets memory from the
34319 permanent pool. See the next section for a discussion of memory handling.
34320
34321 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34322 See below.
34323
34324 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34325 See below.
34326
34327 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34328 These three functions create strings using Exim's dynamic memory facilities.
34329 The first makes a copy of an entire string. The second copies up to a maximum
34330 number of characters, indicated by the second argument. The third uses a format
34331 and insertion arguments to create a new string. In each case, the result is a
34332 pointer to a new string in the current memory pool. See the next section for
34333 more discussion.
34334 .endlist
34335
34336
34337
34338 .section "More about Exim's memory handling" "SECTmemhanloc"
34339 .cindex "&[local_scan()]& function" "memory handling"
34340 No function is provided for freeing memory, because that is never needed.
34341 The dynamic memory that Exim uses when receiving a message is automatically
34342 recycled if another message is received by the same process (this applies only
34343 to incoming SMTP connections &-- other input methods can supply only one
34344 message at a time). After receiving the last message, a reception process
34345 terminates.
34346
34347 Because it is recycled, the normal dynamic memory cannot be used for holding
34348 data that must be preserved over a number of incoming messages on the same SMTP
34349 connection. However, Exim in fact uses two pools of dynamic memory; the second
34350 one is not recycled, and can be used for this purpose.
34351
34352 If you want to allocate memory that remains available for subsequent messages
34353 in the same SMTP connection, you should set
34354 .code
34355 store_pool = POOL_PERM
34356 .endd
34357 before calling the function that does the allocation. There is no need to
34358 restore the value if you do not need to; however, if you do want to revert to
34359 the normal pool, you can either restore the previous value of &%store_pool%& or
34360 set it explicitly to POOL_MAIN.
34361
34362 The pool setting applies to all functions that get dynamic memory, including
34363 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34364 There is also a convenience function called &'store_get_perm()'& that gets a
34365 block of memory from the permanent pool while preserving the value of
34366 &%store_pool%&.
34367 .ecindex IIDlosca
34368
34369
34370
34371
34372 . ////////////////////////////////////////////////////////////////////////////
34373 . ////////////////////////////////////////////////////////////////////////////
34374
34375 .chapter "System-wide message filtering" "CHAPsystemfilter"
34376 .scindex IIDsysfil1 "filter" "system filter"
34377 .scindex IIDsysfil2 "filtering all mail"
34378 .scindex IIDsysfil3 "system filter"
34379 The previous chapters (on ACLs and the local scan function) describe checks
34380 that can be applied to messages before they are accepted by a host. There is
34381 also a mechanism for checking messages once they have been received, but before
34382 they are delivered. This is called the &'system filter'&.
34383
34384 The system filter operates in a similar manner to users' filter files, but it
34385 is run just once per message (however many recipients the message has).
34386 It should not normally be used as a substitute for routing, because &%deliver%&
34387 commands in a system router provide new envelope recipient addresses.
34388 The system filter must be an Exim filter. It cannot be a Sieve filter.
34389
34390 The system filter is run at the start of a delivery attempt, before any routing
34391 is done. If a message fails to be completely delivered at the first attempt,
34392 the system filter is run again at the start of every retry.
34393 If you want your filter to do something only once per message, you can make use
34394 of the &%first_delivery%& condition in an &%if%& command in the filter to
34395 prevent it happening on retries.
34396
34397 .vindex "&$domain$&"
34398 .vindex "&$local_part$&"
34399 &*Warning*&: Because the system filter runs just once, variables that are
34400 specific to individual recipient addresses, such as &$local_part$& and
34401 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34402 you want to run a centrally-specified filter for each recipient address
34403 independently, you can do so by setting up a suitable &(redirect)& router, as
34404 described in section &<<SECTperaddfil>>& below.
34405
34406
34407 .section "Specifying a system filter" "SECID212"
34408 .cindex "uid (user id)" "system filter"
34409 .cindex "gid (group id)" "system filter"
34410 The name of the file that contains the system filter must be specified by
34411 setting &%system_filter%&. If you want the filter to run under a uid and gid
34412 other than root, you must also set &%system_filter_user%& and
34413 &%system_filter_group%& as appropriate. For example:
34414 .code
34415 system_filter = /etc/mail/exim.filter
34416 system_filter_user = exim
34417 .endd
34418 If a system filter generates any deliveries directly to files or pipes (via the
34419 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34420 specified by setting &%system_filter_file_transport%& and
34421 &%system_filter_pipe_transport%&, respectively. Similarly,
34422 &%system_filter_reply_transport%& must be set to handle any messages generated
34423 by the &%reply%& command.
34424
34425
34426 .section "Testing a system filter" "SECID213"
34427 You can run simple tests of a system filter in the same way as for a user
34428 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34429 are permitted only in system filters are recognized.
34430
34431 If you want to test the combined effect of a system filter and a user filter,
34432 you can use both &%-bF%& and &%-bf%& on the same command line.
34433
34434
34435
34436 .section "Contents of a system filter" "SECID214"
34437 The language used to specify system filters is the same as for users' filter
34438 files. It is described in the separate end-user document &'Exim's interface to
34439 mail filtering'&. However, there are some additional features that are
34440 available only in system filters; these are described in subsequent sections.
34441 If they are encountered in a user's filter file or when testing with &%-bf%&,
34442 they cause errors.
34443
34444 .cindex "frozen messages" "manual thaw; testing in filter"
34445 There are two special conditions which, though available in users' filter
34446 files, are designed for use in system filters. The condition &%first_delivery%&
34447 is true only for the first attempt at delivering a message, and
34448 &%manually_thawed%& is true only if the message has been frozen, and
34449 subsequently thawed by an admin user. An explicit forced delivery counts as a
34450 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34451
34452 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34453 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34454 succeed, it will not be tried again.
34455 If you want Exim to retry an unseen delivery until it succeeds, you should
34456 arrange to set it up every time the filter runs.
34457
34458 When a system filter finishes running, the values of the variables &$n0$& &--
34459 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34460 users' filter files. Thus a system filter can, for example, set up &"scores"&
34461 to which users' filter files can refer.
34462
34463
34464
34465 .section "Additional variable for system filters" "SECID215"
34466 .vindex "&$recipients$&"
34467 The expansion variable &$recipients$&, containing a list of all the recipients
34468 of the message (separated by commas and white space), is available in system
34469 filters. It is not available in users' filters for privacy reasons.
34470
34471
34472
34473 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34474 .cindex "freezing messages"
34475 .cindex "message" "freezing"
34476 .cindex "message" "forced failure"
34477 .cindex "&%fail%&" "in system filter"
34478 .cindex "&%freeze%& in system filter"
34479 .cindex "&%defer%& in system filter"
34480 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34481 always available in system filters, but are not normally enabled in users'
34482 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34483 for the &(redirect)& router.) These commands can optionally be followed by the
34484 word &%text%& and a string containing an error message, for example:
34485 .code
34486 fail text "this message looks like spam to me"
34487 .endd
34488 The keyword &%text%& is optional if the next character is a double quote.
34489
34490 The &%defer%& command defers delivery of the original recipients of the
34491 message. The &%fail%& command causes all the original recipients to be failed,
34492 and a bounce message to be created. The &%freeze%& command suspends all
34493 delivery attempts for the original recipients. In all cases, any new deliveries
34494 that are specified by the filter are attempted as normal after the filter has
34495 run.
34496
34497 The &%freeze%& command is ignored if the message has been manually unfrozen and
34498 not manually frozen since. This means that automatic freezing by a system
34499 filter can be used as a way of checking out suspicious messages. If a message
34500 is found to be all right, manually unfreezing it allows it to be delivered.
34501
34502 .cindex "log" "&%fail%& command log line"
34503 .cindex "&%fail%&" "log line; reducing"
34504 The text given with a fail command is used as part of the bounce message as
34505 well as being written to the log. If the message is quite long, this can fill
34506 up a lot of log space when such failures are common. To reduce the size of the
34507 log message, Exim interprets the text in a special way if it starts with the
34508 two characters &`<<`& and contains &`>>`& later. The text between these two
34509 strings is written to the log, and the rest of the text is used in the bounce
34510 message. For example:
34511 .code
34512 fail "<<filter test 1>>Your message is rejected \
34513      because it contains attachments that we are \
34514      not prepared to receive."
34515 .endd
34516
34517 .cindex "loop" "caused by &%fail%&"
34518 Take great care with the &%fail%& command when basing the decision to fail on
34519 the contents of the message, because the bounce message will of course include
34520 the contents of the original message and will therefore trigger the &%fail%&
34521 command again (causing a mail loop) unless steps are taken to prevent this.
34522 Testing the &%error_message%& condition is one way to prevent this. You could
34523 use, for example
34524 .code
34525 if $message_body contains "this is spam" and not error_message
34526 then fail text "spam is not wanted here" endif
34527 .endd
34528 though of course that might let through unwanted bounce messages. The
34529 alternative is clever checking of the body and/or headers to detect bounces
34530 generated by the filter.
34531
34532 The interpretation of a system filter file ceases after a
34533 &%defer%&,
34534 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34535 set up earlier in the filter file are honoured, so you can use a sequence such
34536 as
34537 .code
34538 mail ...
34539 freeze
34540 .endd
34541 to send a specified message when the system filter is freezing (or deferring or
34542 failing) a message. The normal deliveries for the message do not, of course,
34543 take place.
34544
34545
34546
34547 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34548 .cindex "header lines" "adding; in system filter"
34549 .cindex "header lines" "removing; in system filter"
34550 .cindex "filter" "header lines; adding/removing"
34551 Two filter commands that are available only in system filters are:
34552 .code
34553 headers add <string>
34554 headers remove <string>
34555 .endd
34556 The argument for the &%headers add%& is a string that is expanded and then
34557 added to the end of the message's headers. It is the responsibility of the
34558 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34559 space is ignored, and if the string is otherwise empty, or if the expansion is
34560 forced to fail, the command has no effect.
34561
34562 You can use &"\n"& within the string, followed by white space, to specify
34563 continued header lines. More than one header may be added in one command by
34564 including &"\n"& within the string without any following white space. For
34565 example:
34566 .code
34567 headers add "X-header-1: ....\n  \
34568              continuation of X-header-1 ...\n\
34569              X-header-2: ...."
34570 .endd
34571 Note that the header line continuation white space after the first newline must
34572 be placed before the backslash that continues the input string, because white
34573 space after input continuations is ignored.
34574
34575 The argument for &%headers remove%& is a colon-separated list of header names.
34576 This command applies only to those headers that are stored with the message;
34577 those that are added at delivery time (such as &'Envelope-To:'& and
34578 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34579 header with the same name, they are all removed.
34580
34581 The &%headers%& command in a system filter makes an immediate change to the set
34582 of header lines that was received with the message (with possible additions
34583 from ACL processing). Subsequent commands in the system filter operate on the
34584 modified set, which also forms the basis for subsequent message delivery.
34585 Unless further modified during routing or transporting, this set of headers is
34586 used for all recipients of the message.
34587
34588 During routing and transporting, the variables that refer to the contents of
34589 header lines refer only to those lines that are in this set. Thus, header lines
34590 that are added by a system filter are visible to users' filter files and to all
34591 routers and transports. This contrasts with the manipulation of header lines by
34592 routers and transports, which is not immediate, but which instead is saved up
34593 until the message is actually being written (see section
34594 &<<SECTheadersaddrem>>&).
34595
34596 If the message is not delivered at the first attempt, header lines that were
34597 added by the system filter are stored with the message, and so are still
34598 present at the next delivery attempt. Header lines that were removed are still
34599 present, but marked &"deleted"& so that they are not transported with the
34600 message. For this reason, it is usual to make the &%headers%& command
34601 conditional on &%first_delivery%& so that the set of header lines is not
34602 modified more than once.
34603
34604 Because header modification in a system filter acts immediately, you have to
34605 use an indirect approach if you want to modify the contents of a header line.
34606 For example:
34607 .code
34608 headers add "Old-Subject: $h_subject:"
34609 headers remove "Subject"
34610 headers add "Subject: new subject (was: $h_old-subject:)"
34611 headers remove "Old-Subject"
34612 .endd
34613
34614
34615
34616 .section "Setting an errors address in a system filter" "SECID217"
34617 .cindex "envelope from"
34618 .cindex "envelope sender"
34619 In a system filter, if a &%deliver%& command is followed by
34620 .code
34621 errors_to <some address>
34622 .endd
34623 in order to change the envelope sender (and hence the error reporting) for that
34624 delivery, any address may be specified. (In a user filter, only the current
34625 user's address can be set.) For example, if some mail is being monitored, you
34626 might use
34627 .code
34628 unseen deliver monitor@spying.example errors_to root@local.example
34629 .endd
34630 to take a copy which would not be sent back to the normal error reporting
34631 address if its delivery failed.
34632
34633
34634
34635 .section "Per-address filtering" "SECTperaddfil"
34636 .vindex "&$domain$&"
34637 .vindex "&$local_part$&"
34638 In contrast to the system filter, which is run just once per message for each
34639 delivery attempt, it is also possible to set up a system-wide filtering
34640 operation that runs once for each recipient address. In this case, variables
34641 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34642 filter file could be made dependent on them. This is an example of a router
34643 which implements such a filter:
34644 .code
34645 central_filter:
34646   check_local_user
34647   driver = redirect
34648   domains = +local_domains
34649   file = /central/filters/$local_part
34650   no_verify
34651   allow_filter
34652   allow_freeze
34653 .endd
34654 The filter is run in a separate process under its own uid. Therefore, either
34655 &%check_local_user%& must be set (as above), in which case the filter is run as
34656 the local user, or the &%user%& option must be used to specify which user to
34657 use. If both are set, &%user%& overrides.
34658
34659 Care should be taken to ensure that none of the commands in the filter file
34660 specify a significant delivery if the message is to go on to be delivered to
34661 its intended recipient. The router will not then claim to have dealt with the
34662 address, so it will be passed on to subsequent routers to be delivered in the
34663 normal way.
34664 .ecindex IIDsysfil1
34665 .ecindex IIDsysfil2
34666 .ecindex IIDsysfil3
34667
34668
34669
34670
34671
34672
34673 . ////////////////////////////////////////////////////////////////////////////
34674 . ////////////////////////////////////////////////////////////////////////////
34675
34676 .chapter "Message processing" "CHAPmsgproc"
34677 .scindex IIDmesproc "message" "general processing"
34678 Exim performs various transformations on the sender and recipient addresses of
34679 all messages that it handles, and also on the messages' header lines. Some of
34680 these are optional and configurable, while others always take place. All of
34681 this processing, except rewriting as a result of routing, and the addition or
34682 removal of header lines while delivering, happens when a message is received,
34683 before it is placed on Exim's queue.
34684
34685 Some of the automatic processing takes place by default only for
34686 &"locally-originated"& messages. This adjective is used to describe messages
34687 that are not received over TCP/IP, but instead are passed to an Exim process on
34688 its standard input. This includes the interactive &"local SMTP"& case that is
34689 set up by the &%-bs%& command line option.
34690
34691 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34692 or ::1) are not considered to be locally-originated. Exim does not treat the
34693 loopback interface specially in any way.
34694
34695 If you want the loopback interface to be treated specially, you must ensure
34696 that there are appropriate entries in your ACLs.
34697
34698
34699
34700
34701 .section "Submission mode for non-local messages" "SECTsubmodnon"
34702 .cindex "message" "submission"
34703 .cindex "submission mode"
34704 Processing that happens automatically for locally-originated messages (unless
34705 &%suppress_local_fixups%& is set) can also be requested for messages that are
34706 received over TCP/IP. The term &"submission mode"& is used to describe this
34707 state. Submission mode is set by the modifier
34708 .code
34709 control = submission
34710 .endd
34711 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34712 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34713 a local submission, and is normally used when the source of the message is
34714 known to be an MUA running on a client host (as opposed to an MTA). For
34715 example, to set submission mode for messages originating on the IPv4 loopback
34716 interface, you could include the following in the MAIL ACL:
34717 .code
34718 warn  hosts = 127.0.0.1
34719       control = submission
34720 .endd
34721 .cindex "&%sender_retain%& submission option"
34722 There are some options that can be used when setting submission mode. A slash
34723 is used to separate options. For example:
34724 .code
34725 control = submission/sender_retain
34726 .endd
34727 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34728 true and &%local_from_check%& false for the current incoming message. The first
34729 of these allows an existing &'Sender:'& header in the message to remain, and
34730 the second suppresses the check to ensure that &'From:'& matches the
34731 authenticated sender. With this setting, Exim still fixes up messages by adding
34732 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34733 attempt to check sender authenticity in header lines.
34734
34735 When &%sender_retain%& is not set, a submission mode setting may specify a
34736 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34737 example:
34738 .code
34739 control = submission/domain=some.domain
34740 .endd
34741 The domain may be empty. How this value is used is described in sections
34742 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34743 that allows you to specify the user's full name for inclusion in a created
34744 &'Sender:'& or &'From:'& header line. For example:
34745 .code
34746 accept authenticated = *
34747        control = submission/domain=wonderland.example/\
34748                             name=${lookup {$authenticated_id} \
34749                                    lsearch {/etc/exim/namelist}}
34750 .endd
34751 Because the name may contain any characters, including slashes, the &%name%&
34752 option must be given last. The remainder of the string is used as the name. For
34753 the example above, if &_/etc/exim/namelist_& contains:
34754 .code
34755 bigegg:  Humpty Dumpty
34756 .endd
34757 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34758 line would be:
34759 .code
34760 Sender: Humpty Dumpty <bigegg@wonderland.example>
34761 .endd
34762 .cindex "return path" "in submission mode"
34763 By default, submission mode forces the return path to the same address as is
34764 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34765 specified, the return path is also left unchanged.
34766
34767 &*Note*&: The changes caused by submission mode take effect after the predata
34768 ACL. This means that any sender checks performed before the fix-ups use the
34769 untrusted sender address specified by the user, not the trusted sender address
34770 specified by submission mode. Although this might be slightly unexpected, it
34771 does mean that you can configure ACL checks to spot that a user is trying to
34772 spoof another's address.
34773
34774 .section "Line endings" "SECTlineendings"
34775 .cindex "line endings"
34776 .cindex "carriage return"
34777 .cindex "linefeed"
34778 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34779 linefeed) is the line ending for messages transmitted over the Internet using
34780 SMTP over TCP/IP. However, within individual operating systems, different
34781 conventions are used. For example, Unix-like systems use just LF, but others
34782 use CRLF or just CR.
34783
34784 Exim was designed for Unix-like systems, and internally, it stores messages
34785 using the system's convention of a single LF as a line terminator. When
34786 receiving a message, all line endings are translated to this standard format.
34787 Originally, it was thought that programs that passed messages directly to an
34788 MTA within an operating system would use that system's convention. Experience
34789 has shown that this is not the case; for example, there are Unix applications
34790 that use CRLF in this circumstance. For this reason, and for compatibility with
34791 other MTAs, the way Exim handles line endings for all messages is now as
34792 follows:
34793
34794 .ilist
34795 LF not preceded by CR is treated as a line ending.
34796 .next
34797 CR is treated as a line ending; if it is immediately followed by LF, the LF
34798 is ignored.
34799 .next
34800 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34801 nor a local message in the state where a line containing only a dot is a
34802 terminator.
34803 .next
34804 If a bare CR is encountered within a header line, an extra space is added after
34805 the line terminator so as not to end the header line. The reasoning behind this
34806 is that bare CRs in header lines are most likely either to be mistakes, or
34807 people trying to play silly games.
34808 .next
34809 If the first header line received in a message ends with CRLF, a subsequent
34810 bare LF in a header line is treated in the same way as a bare CR in a header
34811 line.
34812 .endlist
34813
34814
34815
34816
34817
34818 .section "Unqualified addresses" "SECID218"
34819 .cindex "unqualified addresses"
34820 .cindex "address" "qualification"
34821 By default, Exim expects every envelope address it receives from an external
34822 host to be fully qualified. Unqualified addresses cause negative responses to
34823 SMTP commands. However, because SMTP is used as a means of transporting
34824 messages from MUAs running on personal workstations, there is sometimes a
34825 requirement to accept unqualified addresses from specific hosts or IP networks.
34826
34827 Exim has two options that separately control which hosts may send unqualified
34828 sender or recipient addresses in SMTP commands, namely
34829 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34830 cases, if an unqualified address is accepted, it is qualified by adding the
34831 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34832
34833 .oindex "&%qualify_domain%&"
34834 .oindex "&%qualify_recipient%&"
34835 Unqualified addresses in header lines are automatically qualified for messages
34836 that are locally originated, unless the &%-bnq%& option is given on the command
34837 line. For messages received over SMTP, unqualified addresses in header lines
34838 are qualified only if unqualified addresses are permitted in SMTP commands. In
34839 other words, such qualification is also controlled by
34840 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34841
34842
34843
34844
34845 .section "The UUCP From line" "SECID219"
34846 .cindex "&""From""& line"
34847 .cindex "UUCP" "&""From""& line"
34848 .cindex "sender" "address"
34849 .oindex "&%uucp_from_pattern%&"
34850 .oindex "&%uucp_from_sender%&"
34851 .cindex "envelope from"
34852 .cindex "envelope sender"
34853 .cindex "Sendmail compatibility" "&""From""& line"
34854 Messages that have come from UUCP (and some other applications) often begin
34855 with a line containing the envelope sender and a timestamp, following the word
34856 &"From"&. Examples of two common formats are:
34857 .code
34858 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34859 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34860 .endd
34861 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34862 Exim recognizes such lines at the start of messages that are submitted to it
34863 via the command line (that is, on the standard input). It does not recognize
34864 such lines in incoming SMTP messages, unless the sending host matches
34865 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34866 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34867 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34868 default value matches the two common cases shown above and puts the address
34869 that follows &"From"& into &$1$&.
34870
34871 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34872 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34873 a trusted user, the message's sender address is constructed by expanding the
34874 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34875 then parsed as an RFC 2822 address. If there is no domain, the local part is
34876 qualified with &%qualify_domain%& unless it is the empty string. However, if
34877 the command line &%-f%& option is used, it overrides the &"From"& line.
34878
34879 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34880 sender address is not changed. This is also the case for incoming SMTP messages
34881 that are permitted to contain &"From"& lines.
34882
34883 Only one &"From"& line is recognized. If there is more than one, the second is
34884 treated as a data line that starts the body of the message, as it is not valid
34885 as a header line. This also happens if a &"From"& line is present in an
34886 incoming SMTP message from a source that is not permitted to send them.
34887
34888
34889
34890 .section "Resent- header lines" "SECID220"
34891 .cindex "&%Resent-%& header lines"
34892 .cindex "header lines" "Resent-"
34893 RFC 2822 makes provision for sets of header lines starting with the string
34894 &`Resent-`& to be added to a message when it is resent by the original
34895 recipient to somebody else. These headers are &'Resent-Date:'&,
34896 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34897 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34898
34899 .blockquote
34900 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34901 processing of replies or other such automatic actions on messages.'&
34902 .endblockquote
34903
34904 This leaves things a bit vague as far as other processing actions such as
34905 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34906 follows:
34907
34908 .ilist
34909 A &'Resent-From:'& line that just contains the login id of the submitting user
34910 is automatically rewritten in the same way as &'From:'& (see below).
34911 .next
34912 If there's a rewriting rule for a particular header line, it is also applied to
34913 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34914 &'From:'& also rewrites &'Resent-From:'&.
34915 .next
34916 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34917 also removed.
34918 .next
34919 For a locally-submitted message,
34920 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34921 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34922 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34923 included in log lines in this case.
34924 .next
34925 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34926 &%Resent-%& header lines are present.
34927 .endlist
34928
34929
34930
34931
34932 .section "The Auto-Submitted: header line" "SECID221"
34933 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34934 includes the header line:
34935 .code
34936 Auto-Submitted: auto-replied
34937 .endd
34938
34939 .section "The Bcc: header line" "SECID222"
34940 .cindex "&'Bcc:'& header line"
34941 If Exim is called with the &%-t%& option, to take recipient addresses from a
34942 message's header, it removes any &'Bcc:'& header line that may exist (after
34943 extracting its addresses). If &%-t%& is not present on the command line, any
34944 existing &'Bcc:'& is not removed.
34945
34946
34947 .section "The Date: header line" "SECID223"
34948 .cindex "&'Date:'& header line"
34949 .cindex "header lines" "Date:"
34950 If a locally-generated or submission-mode message has no &'Date:'& header line,
34951 Exim adds one, using the current date and time, unless the
34952 &%suppress_local_fixups%& control has been specified.
34953
34954 .section "The Delivery-date: header line" "SECID224"
34955 .cindex "&'Delivery-date:'& header line"
34956 .oindex "&%delivery_date_remove%&"
34957 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34958 set. Exim can be configured to add them to the final delivery of messages. (See
34959 the generic &%delivery_date_add%& transport option.) They should not be present
34960 in messages in transit. If the &%delivery_date_remove%& configuration option is
34961 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34962 messages.
34963
34964
34965 .section "The Envelope-to: header line" "SECID225"
34966 .cindex "&'Envelope-to:'& header line"
34967 .cindex "header lines" "Envelope-to:"
34968 .oindex "&%envelope_to_remove%&"
34969 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34970 Exim can be configured to add them to the final delivery of messages. (See the
34971 generic &%envelope_to_add%& transport option.) They should not be present in
34972 messages in transit. If the &%envelope_to_remove%& configuration option is set
34973 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34974 messages.
34975
34976
34977 .section "The From: header line" "SECTthefrohea"
34978 .cindex "&'From:'& header line"
34979 .cindex "header lines" "From:"
34980 .cindex "Sendmail compatibility" "&""From""& line"
34981 .cindex "message" "submission"
34982 .cindex "submission mode"
34983 If a submission-mode message does not contain a &'From:'& header line, Exim
34984 adds one if either of the following conditions is true:
34985
34986 .ilist
34987 The envelope sender address is not empty (that is, this is not a bounce
34988 message). The added header line copies the envelope sender address.
34989 .next
34990 .vindex "&$authenticated_id$&"
34991 The SMTP session is authenticated and &$authenticated_id$& is not empty.
34992 .olist
34993 .vindex "&$qualify_domain$&"
34994 If no domain is specified by the submission control, the local part is
34995 &$authenticated_id$& and the domain is &$qualify_domain$&.
34996 .next
34997 If a non-empty domain is specified by the submission control, the local
34998 part is &$authenticated_id$&, and the domain is the specified domain.
34999 .next
35000 If an empty domain is specified by the submission control,
35001 &$authenticated_id$& is assumed to be the complete address.
35002 .endlist
35003 .endlist
35004
35005 A non-empty envelope sender takes precedence.
35006
35007 If a locally-generated incoming message does not contain a &'From:'& header
35008 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35009 containing the sender's address. The calling user's login name and full name
35010 are used to construct the address, as described in section &<<SECTconstr>>&.
35011 They are obtained from the password data by calling &[getpwuid()]& (but see the
35012 &%unknown_login%& configuration option). The address is qualified with
35013 &%qualify_domain%&.
35014
35015 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35016 &'From:'& header line containing just the unqualified login name of the calling
35017 user, this is replaced by an address containing the user's login name and full
35018 name as described in section &<<SECTconstr>>&.
35019
35020
35021 .section "The Message-ID: header line" "SECID226"
35022 .cindex "&'Message-ID:'& header line"
35023 .cindex "header lines" "Message-ID:"
35024 .cindex "message" "submission"
35025 .oindex "&%message_id_header_text%&"
35026 If a locally-generated or submission-mode incoming message does not contain a
35027 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35028 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35029 to the message. If there are any &'Resent-:'& headers in the message, it
35030 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35031 message id, preceded by the letter E to ensure it starts with a letter, and
35032 followed by @ and the primary host name. Additional information can be included
35033 in this header line by setting the &%message_id_header_text%& and/or
35034 &%message_id_header_domain%& options.
35035
35036
35037 .section "The Received: header line" "SECID227"
35038 .cindex "&'Received:'& header line"
35039 .cindex "header lines" "Received:"
35040 A &'Received:'& header line is added at the start of every message. The
35041 contents are defined by the &%received_header_text%& configuration option, and
35042 Exim automatically adds a semicolon and a timestamp to the configured string.
35043
35044 The &'Received:'& header is generated as soon as the message's header lines
35045 have been received. At this stage, the timestamp in the &'Received:'& header
35046 line is the time that the message started to be received. This is the value
35047 that is seen by the DATA ACL and by the &[local_scan()]& function.
35048
35049 Once a message is accepted, the timestamp in the &'Received:'& header line is
35050 changed to the time of acceptance, which is (apart from a small delay while the
35051 -H spool file is written) the earliest time at which delivery could start.
35052
35053
35054 .section "The References: header line" "SECID228"
35055 .cindex "&'References:'& header line"
35056 .cindex "header lines" "References:"
35057 Messages created by the &(autoreply)& transport include a &'References:'&
35058 header line. This is constructed according to the rules that are described in
35059 section 3.64 of RFC 2822 (which states that replies should contain such a
35060 header line), and section 3.14 of RFC 3834 (which states that automatic
35061 responses are not different in this respect). However, because some mail
35062 processing software does not cope well with very long header lines, no more
35063 than 12 message IDs are copied from the &'References:'& header line in the
35064 incoming message. If there are more than 12, the first one and then the final
35065 11 are copied, before adding the message ID of the incoming message.
35066
35067
35068
35069 .section "The Return-path: header line" "SECID229"
35070 .cindex "&'Return-path:'& header line"
35071 .cindex "header lines" "Return-path:"
35072 .oindex "&%return_path_remove%&"
35073 &'Return-path:'& header lines are defined as something an MTA may insert when
35074 it does the final delivery of messages. (See the generic &%return_path_add%&
35075 transport option.) Therefore, they should not be present in messages in
35076 transit. If the &%return_path_remove%& configuration option is set (the
35077 default), Exim removes &'Return-path:'& header lines from incoming messages.
35078
35079
35080
35081 .section "The Sender: header line" "SECTthesenhea"
35082 .cindex "&'Sender:'& header line"
35083 .cindex "message" "submission"
35084 .cindex "header lines" "Sender:"
35085 For a locally-originated message from an untrusted user, Exim may remove an
35086 existing &'Sender:'& header line, and it may add a new one. You can modify
35087 these actions by setting the &%local_sender_retain%& option true, the
35088 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35089 control setting.
35090
35091 When a local message is received from an untrusted user and
35092 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35093 control has not been set, a check is made to see if the address given in the
35094 &'From:'& header line is the correct (local) sender of the message. The address
35095 that is expected has the login name as the local part and the value of
35096 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35097 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35098 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35099 line is added to the message.
35100
35101 If you set &%local_from_check%& false, this checking does not occur. However,
35102 the removal of an existing &'Sender:'& line still happens, unless you also set
35103 &%local_sender_retain%& to be true. It is not possible to set both of these
35104 options true at the same time.
35105
35106 .cindex "submission mode"
35107 By default, no processing of &'Sender:'& header lines is done for messages
35108 received over TCP/IP or for messages submitted by trusted users. However, when
35109 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35110 not specified on the submission control, the following processing takes place:
35111
35112 .vindex "&$authenticated_id$&"
35113 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35114 authenticated, and &$authenticated_id$& is not empty, a sender address is
35115 created as follows:
35116
35117 .ilist
35118 .vindex "&$qualify_domain$&"
35119 If no domain is specified by the submission control, the local part is
35120 &$authenticated_id$& and the domain is &$qualify_domain$&.
35121 .next
35122 If a non-empty domain is specified by the submission control, the local part
35123 is &$authenticated_id$&, and the domain is the specified domain.
35124 .next
35125 If an empty domain is specified by the submission control,
35126 &$authenticated_id$& is assumed to be the complete address.
35127 .endlist
35128
35129 This address is compared with the address in the &'From:'& header line. If they
35130 are different, a &'Sender:'& header line containing the created address is
35131 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35132 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35133
35134 .cindex "return path" "created from &'Sender:'&"
35135 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35136 the message (the envelope sender address) is changed to be the same address,
35137 except in the case of submission mode when &%sender_retain%& is specified.
35138
35139
35140
35141 .section "Adding and removing header lines in routers and transports" &&&
35142          "SECTheadersaddrem"
35143 .cindex "header lines" "adding; in router or transport"
35144 .cindex "header lines" "removing; in router or transport"
35145 When a message is delivered, the addition and removal of header lines can be
35146 specified in a system filter, or on any of the routers and transports that
35147 process the message. Section &<<SECTaddremheasys>>& contains details about
35148 modifying headers in a system filter. Header lines can also be added in an ACL
35149 as a message is received (see section &<<SECTaddheadacl>>&).
35150
35151 In contrast to what happens in a system filter, header modifications that are
35152 specified on routers and transports apply only to the particular recipient
35153 addresses that are being processed by those routers and transports. These
35154 changes do not actually take place until a copy of the message is being
35155 transported. Therefore, they do not affect the basic set of header lines, and
35156 they do not affect the values of the variables that refer to header lines.
35157
35158 &*Note*&: In particular, this means that any expansions in the configuration of
35159 the transport cannot refer to the modified header lines, because such
35160 expansions all occur before the message is actually transported.
35161
35162 For both routers and transports, the argument of a &%headers_add%&
35163 option must be in the form of one or more RFC 2822 header lines, separated by
35164 newlines (coded as &"\n"&). For example:
35165 .code
35166 headers_add = X-added-header: added by $primary_hostname\n\
35167               X-added-second: another added header line
35168 .endd
35169 Exim does not check the syntax of these added header lines.
35170
35171 Multiple &%headers_add%& options for a single router or transport can be
35172 specified; the values will append to a single list of header lines.
35173 Each header-line is separately expanded.
35174
35175 The argument of a &%headers_remove%& option must consist of a colon-separated
35176 list of header names. This is confusing, because header names themselves are
35177 often terminated by colons. In this case, the colons are the list separators,
35178 not part of the names. For example:
35179 .code
35180 headers_remove = return-receipt-to:acknowledge-to
35181 .endd
35182
35183 Multiple &%headers_remove%& options for a single router or transport can be
35184 specified; the arguments will append to a single header-names list.
35185 Each item is separately expanded.
35186 Note that colons in complex expansions which are used to
35187 form all or part of a &%headers_remove%& list
35188 will act as list separators.
35189
35190 When &%headers_add%& or &%headers_remove%& is specified on a router,
35191 items are expanded at routing time,
35192 and then associated with all addresses that are
35193 accepted by that router, and also with any new addresses that it generates. If
35194 an address passes through several routers as a result of aliasing or
35195 forwarding, the changes are cumulative.
35196
35197 .oindex "&%unseen%&"
35198 However, this does not apply to multiple routers that result from the use of
35199 the &%unseen%& option. Any header modifications that were specified by the
35200 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35201
35202 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35203 settings cannot be delivered together in a batch, so a transport is always
35204 dealing with a set of addresses that have the same header-processing
35205 requirements.
35206
35207 The transport starts by writing the original set of header lines that arrived
35208 with the message, possibly modified by the system filter. As it writes out
35209 these lines, it consults the list of header names that were attached to the
35210 recipient address(es) by &%headers_remove%& options in routers, and it also
35211 consults the transport's own &%headers_remove%& option. Header lines whose
35212 names are on either of these lists are not written out. If there are multiple
35213 instances of any listed header, they are all skipped.
35214
35215 After the remaining original header lines have been written, new header
35216 lines that were specified by routers' &%headers_add%& options are written, in
35217 the order in which they were attached to the address. These are followed by any
35218 header lines specified by the transport's &%headers_add%& option.
35219
35220 This way of handling header line modifications in routers and transports has
35221 the following consequences:
35222
35223 .ilist
35224 The original set of header lines, possibly modified by the system filter,
35225 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35226 to it, at all times.
35227 .next
35228 Header lines that are added by a router's
35229 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35230 expansion syntax in subsequent routers or the transport.
35231 .next
35232 Conversely, header lines that are specified for removal by &%headers_remove%&
35233 in a router remain visible to subsequent routers and the transport.
35234 .next
35235 Headers added to an address by &%headers_add%& in a router cannot be removed by
35236 a later router or by a transport.
35237 .next
35238 An added header can refer to the contents of an original header that is to be
35239 removed, even it has the same name as the added header. For example:
35240 .code
35241 headers_remove = subject
35242 headers_add = Subject: new subject (was: $h_subject:)
35243 .endd
35244 .endlist
35245
35246 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35247 for a &(redirect)& router that has the &%one_time%& option set.
35248
35249
35250
35251
35252
35253 .section "Constructed addresses" "SECTconstr"
35254 .cindex "address" "constructed"
35255 .cindex "constructed address"
35256 When Exim constructs a sender address for a locally-generated message, it uses
35257 the form
35258 .display
35259 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35260 .endd
35261 For example:
35262 .code
35263 Zaphod Beeblebrox <zaphod@end.univ.example>
35264 .endd
35265 The user name is obtained from the &%-F%& command line option if set, or
35266 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35267 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35268 ampersand character, this is replaced by the login name with the first letter
35269 upper cased, as is conventional in a number of operating systems. See the
35270 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35271 The &%unknown_username%& option can be used to specify user names in cases when
35272 there is no password file entry.
35273
35274 .cindex "RFC 2047"
35275 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35276 parts of it if necessary. In addition, if it contains any non-printing
35277 characters, it is encoded as described in RFC 2047, which defines a way of
35278 including non-ASCII characters in header lines. The value of the
35279 &%headers_charset%& option specifies the name of the encoding that is used (the
35280 characters are assumed to be in this encoding). The setting of
35281 &%print_topbitchars%& controls whether characters with the top bit set (that
35282 is, with codes greater than 127) count as printing characters or not.
35283
35284
35285
35286 .section "Case of local parts" "SECID230"
35287 .cindex "case of local parts"
35288 .cindex "local part" "case of"
35289 RFC 2822 states that the case of letters in the local parts of addresses cannot
35290 be assumed to be non-significant. Exim preserves the case of local parts of
35291 addresses, but by default it uses a lower-cased form when it is routing,
35292 because on most Unix systems, usernames are in lower case and case-insensitive
35293 routing is required. However, any particular router can be made to use the
35294 original case for local parts by setting the &%caseful_local_part%& generic
35295 router option.
35296
35297 .cindex "mixed-case login names"
35298 If you must have mixed-case user names on your system, the best way to proceed,
35299 assuming you want case-independent handling of incoming email, is to set up
35300 your first router to convert incoming local parts in your domains to the
35301 correct case by means of a file lookup. For example:
35302 .code
35303 correct_case:
35304   driver = redirect
35305   domains = +local_domains
35306   data = ${lookup{$local_part}cdb\
35307               {/etc/usercased.cdb}{$value}fail}\
35308               @$domain
35309 .endd
35310 For this router, the local part is forced to lower case by the default action
35311 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35312 up a new local part in the correct case. If you then set &%caseful_local_part%&
35313 on any subsequent routers which process your domains, they will operate on
35314 local parts with the correct case in a case-sensitive manner.
35315
35316
35317
35318 .section "Dots in local parts" "SECID231"
35319 .cindex "dot" "in local part"
35320 .cindex "local part" "dots in"
35321 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35322 part may not begin or end with a dot, nor have two consecutive dots in the
35323 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35324 empty components for compatibility.
35325
35326
35327
35328 .section "Rewriting addresses" "SECID232"
35329 .cindex "rewriting" "addresses"
35330 Rewriting of sender and recipient addresses, and addresses in headers, can
35331 happen automatically, or as the result of configuration options, as described
35332 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35333 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35334
35335 Automatic rewriting includes qualification, as mentioned above. The other case
35336 in which it can happen is when an incomplete non-local domain is given. The
35337 routing process may cause this to be expanded into the full domain name. For
35338 example, a header such as
35339 .code
35340 To: hare@teaparty
35341 .endd
35342 might get rewritten as
35343 .code
35344 To: hare@teaparty.wonderland.fict.example
35345 .endd
35346 Rewriting as a result of routing is the one kind of message processing that
35347 does not happen at input time, as it cannot be done until the address has
35348 been routed.
35349
35350 Strictly, one should not do &'any'& deliveries of a message until all its
35351 addresses have been routed, in case any of the headers get changed as a
35352 result of routing. However, doing this in practice would hold up many
35353 deliveries for unreasonable amounts of time, just because one address could not
35354 immediately be routed. Exim therefore does not delay other deliveries when
35355 routing of one or more addresses is deferred.
35356 .ecindex IIDmesproc
35357
35358
35359
35360 . ////////////////////////////////////////////////////////////////////////////
35361 . ////////////////////////////////////////////////////////////////////////////
35362
35363 .chapter "SMTP processing" "CHAPSMTP"
35364 .scindex IIDsmtpproc1 "SMTP" "processing details"
35365 .scindex IIDsmtpproc2 "LMTP" "processing details"
35366 Exim supports a number of different ways of using the SMTP protocol, and its
35367 LMTP variant, which is an interactive protocol for transferring messages into a
35368 closed mail store application. This chapter contains details of how SMTP is
35369 processed. For incoming mail, the following are available:
35370
35371 .ilist
35372 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35373 .next
35374 SMTP over the standard input and output (the &%-bs%& option);
35375 .next
35376 Batched SMTP on the standard input (the &%-bS%& option).
35377 .endlist
35378
35379 For mail delivery, the following are available:
35380
35381 .ilist
35382 SMTP over TCP/IP (the &(smtp)& transport);
35383 .next
35384 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35385 &"lmtp"&);
35386 .next
35387 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35388 transport);
35389 .next
35390 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35391 the &%use_bsmtp%& option set).
35392 .endlist
35393
35394 &'Batched SMTP'& is the name for a process in which batches of messages are
35395 stored in or read from files (or pipes), in a format in which SMTP commands are
35396 used to contain the envelope information.
35397
35398
35399
35400 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35401 .cindex "SMTP" "outgoing over TCP/IP"
35402 .cindex "outgoing SMTP over TCP/IP"
35403 .cindex "LMTP" "over TCP/IP"
35404 .cindex "outgoing LMTP over TCP/IP"
35405 .cindex "EHLO"
35406 .cindex "HELO"
35407 .cindex "SIZE option on MAIL command"
35408 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35409 The &%protocol%& option selects which protocol is to be used, but the actual
35410 processing is the same in both cases.
35411
35412 If, in response to its EHLO command, Exim is told that the SIZE
35413 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35414 command. The value of <&'n'&> is the message size plus the value of the
35415 &%size_addition%& option (default 1024) to allow for additions to the message
35416 such as per-transport header lines, or changes made in a
35417 .cindex "transport" "filter"
35418 .cindex "filter" "transport filter"
35419 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35420 suppressed.
35421
35422 If the remote server advertises support for PIPELINING, Exim uses the
35423 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35424 required for the transaction.
35425
35426 If the remote server advertises support for the STARTTLS command, and Exim
35427 was built to support TLS encryption, it tries to start a TLS session unless the
35428 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35429 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35430 is called for verification.
35431
35432 If the remote server advertises support for the AUTH command, Exim scans
35433 the authenticators configuration for any suitable client settings, as described
35434 in chapter &<<CHAPSMTPAUTH>>&.
35435
35436 .cindex "carriage return"
35437 .cindex "linefeed"
35438 Responses from the remote host are supposed to be terminated by CR followed by
35439 LF. However, there are known to be hosts that do not send CR characters, so in
35440 order to be able to interwork with such hosts, Exim treats LF on its own as a
35441 line terminator.
35442
35443 If a message contains a number of different addresses, all those with the same
35444 characteristics (for example, the same envelope sender) that resolve to the
35445 same set of hosts, in the same order, are sent in a single SMTP transaction,
35446 even if they are for different domains, unless there are more than the setting
35447 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35448 they are split into groups containing no more than &%max_rcpt%&s addresses
35449 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35450 in parallel sessions. The order of hosts with identical MX values is not
35451 significant when checking whether addresses can be batched in this way.
35452
35453 When the &(smtp)& transport suffers a temporary failure that is not
35454 message-related, Exim updates its transport-specific database, which contains
35455 records indexed by host name that remember which messages are waiting for each
35456 particular host. It also updates the retry database with new retry times.
35457
35458 .cindex "hints database" "retry keys"
35459 Exim's retry hints are based on host name plus IP address, so if one address of
35460 a multi-homed host is broken, it will soon be skipped most of the time.
35461 See the next section for more detail about error handling.
35462
35463 .cindex "SMTP" "passed connection"
35464 .cindex "SMTP" "batching over TCP/IP"
35465 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35466 looks in the hints database for the transport to see if there are any queued
35467 messages waiting for the host to which it is connected. If it finds one, it
35468 creates a new Exim process using the &%-MC%& option (which can only be used by
35469 a process running as root or the Exim user) and passes the TCP/IP socket to it
35470 so that it can deliver another message using the same socket. The new process
35471 does only those deliveries that are routed to the connected host, and may in
35472 turn pass the socket on to a third process, and so on.
35473
35474 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35475 limit the number of messages sent down a single TCP/IP connection.
35476
35477 .cindex "asterisk" "after IP address"
35478 The second and subsequent messages delivered down an existing connection are
35479 identified in the main log by the addition of an asterisk after the closing
35480 square bracket of the IP address.
35481
35482
35483
35484
35485 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35486 .cindex "error" "in outgoing SMTP"
35487 .cindex "SMTP" "errors in outgoing"
35488 .cindex "host" "error"
35489 Three different kinds of error are recognized for outgoing SMTP: host errors,
35490 message errors, and recipient errors.
35491
35492 .vlist
35493 .vitem "&*Host errors*&"
35494 A host error is not associated with a particular message or with a
35495 particular recipient of a message. The host errors are:
35496
35497 .ilist
35498 Connection refused or timed out,
35499 .next
35500 Any error response code on connection,
35501 .next
35502 Any error response code to EHLO or HELO,
35503 .next
35504 Loss of connection at any time, except after &"."&,
35505 .next
35506 I/O errors at any time,
35507 .next
35508 Timeouts during the session, other than in response to MAIL, RCPT or
35509 the &"."& at the end of the data.
35510 .endlist ilist
35511
35512 For a host error, a permanent error response on connection, or in response to
35513 EHLO, causes all addresses routed to the host to be failed. Any other host
35514 error causes all addresses to be deferred, and retry data to be created for the
35515 host. It is not tried again, for any message, until its retry time arrives. If
35516 the current set of addresses are not all delivered in this run (to some
35517 alternative host), the message is added to the list of those waiting for this
35518 host, so if it is still undelivered when a subsequent successful delivery is
35519 made to the host, it will be sent down the same SMTP connection.
35520
35521 .vitem "&*Message errors*&"
35522 .cindex "message" "error"
35523 A message error is associated with a particular message when sent to a
35524 particular host, but not with a particular recipient of the message. The
35525 message errors are:
35526
35527 .ilist
35528 Any error response code to MAIL, DATA, or the &"."& that terminates
35529 the data,
35530 .next
35531 Timeout after MAIL,
35532 .next
35533 Timeout or loss of connection after the &"."& that terminates the data. A
35534 timeout after the DATA command itself is treated as a host error, as is loss of
35535 connection at any other time.
35536 .endlist ilist
35537
35538 For a message error, a permanent error response (5&'xx'&) causes all addresses
35539 to be failed, and a delivery error report to be returned to the sender. A
35540 temporary error response (4&'xx'&), or one of the timeouts, causes all
35541 addresses to be deferred. Retry data is not created for the host, but instead,
35542 a retry record for the combination of host plus message id is created. The
35543 message is not added to the list of those waiting for this host. This ensures
35544 that the failing message will not be sent to this host again until the retry
35545 time arrives. However, other messages that are routed to the host are not
35546 affected, so if it is some property of the message that is causing the error,
35547 it will not stop the delivery of other mail.
35548
35549 If the remote host specified support for the SIZE parameter in its response
35550 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35551 over-large message will cause a message error because the error arrives as a
35552 response to MAIL.
35553
35554 .vitem "&*Recipient errors*&"
35555 .cindex "recipient" "error"
35556 A recipient error is associated with a particular recipient of a message. The
35557 recipient errors are:
35558
35559 .ilist
35560 Any error response to RCPT,
35561 .next
35562 Timeout after RCPT.
35563 .endlist
35564
35565 For a recipient error, a permanent error response (5&'xx'&) causes the
35566 recipient address to be failed, and a bounce message to be returned to the
35567 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35568 address to be deferred, and routing retry data to be created for it. This is
35569 used to delay processing of the address in subsequent queue runs, until its
35570 routing retry time arrives. This applies to all messages, but because it
35571 operates only in queue runs, one attempt will be made to deliver a new message
35572 to the failing address before the delay starts to operate. This ensures that,
35573 if the failure is really related to the message rather than the recipient
35574 (&"message too big for this recipient"& is a possible example), other messages
35575 have a chance of getting delivered. If a delivery to the address does succeed,
35576 the retry information gets cleared, so all stuck messages get tried again, and
35577 the retry clock is reset.
35578
35579 The message is not added to the list of those waiting for this host. Use of the
35580 host for other messages is unaffected, and except in the case of a timeout,
35581 other recipients are processed independently, and may be successfully delivered
35582 in the current SMTP session. After a timeout it is of course impossible to
35583 proceed with the session, so all addresses get deferred. However, those other
35584 than the one that failed do not suffer any subsequent retry delays. Therefore,
35585 if one recipient is causing trouble, the others have a chance of getting
35586 through when a subsequent delivery attempt occurs before the failing
35587 recipient's retry time.
35588 .endlist
35589
35590 In all cases, if there are other hosts (or IP addresses) available for the
35591 current set of addresses (for example, from multiple MX records), they are
35592 tried in this run for any undelivered addresses, subject of course to their
35593 own retry data. In other words, recipient error retry data does not take effect
35594 until the next delivery attempt.
35595
35596 Some hosts have been observed to give temporary error responses to every
35597 MAIL command at certain times (&"insufficient space"& has been seen). It
35598 would be nice if such circumstances could be recognized, and defer data for the
35599 host itself created, but this is not possible within the current Exim design.
35600 What actually happens is that retry data for every (host, message) combination
35601 is created.
35602
35603 The reason that timeouts after MAIL and RCPT are treated specially is that
35604 these can sometimes arise as a result of the remote host's verification
35605 procedures. Exim makes this assumption, and treats them as if a temporary error
35606 response had been received. A timeout after &"."& is treated specially because
35607 it is known that some broken implementations fail to recognize the end of the
35608 message if the last character of the last line is a binary zero. Thus, it is
35609 helpful to treat this case as a message error.
35610
35611 Timeouts at other times are treated as host errors, assuming a problem with the
35612 host, or the connection to it. If a timeout after MAIL, RCPT,
35613 or &"."& is really a connection problem, the assumption is that at the next try
35614 the timeout is likely to occur at some other point in the dialogue, causing it
35615 then to be treated as a host error.
35616
35617 There is experimental evidence that some MTAs drop the connection after the
35618 terminating &"."& if they do not like the contents of the message for some
35619 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35620 should be given. That is why Exim treats this case as a message rather than a
35621 host error, in order not to delay other messages to the same host.
35622
35623
35624
35625
35626 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35627 .cindex "SMTP" "incoming over TCP/IP"
35628 .cindex "incoming SMTP over TCP/IP"
35629 .cindex "inetd"
35630 .cindex "daemon"
35631 Incoming SMTP messages can be accepted in one of two ways: by running a
35632 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35633 &_/etc/inetd.conf_& should be like this:
35634 .code
35635 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35636 .endd
35637 Exim distinguishes between this case and the case of a locally running user
35638 agent using the &%-bs%& option by checking whether or not the standard input is
35639 a socket. When it is, either the port must be privileged (less than 1024), or
35640 the caller must be root or the Exim user. If any other user passes a socket
35641 with an unprivileged port number, Exim prints a message on the standard error
35642 stream and exits with an error code.
35643
35644 By default, Exim does not make a log entry when a remote host connects or
35645 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35646 unexpected. It can be made to write such log entries by setting the
35647 &%smtp_connection%& log selector.
35648
35649 .cindex "carriage return"
35650 .cindex "linefeed"
35651 Commands from the remote host are supposed to be terminated by CR followed by
35652 LF. However, there are known to be hosts that do not send CR characters. In
35653 order to be able to interwork with such hosts, Exim treats LF on its own as a
35654 line terminator.
35655 Furthermore, because common code is used for receiving messages from all
35656 sources, a CR on its own is also interpreted as a line terminator. However, the
35657 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35658
35659 .cindex "EHLO" "invalid data"
35660 .cindex "HELO" "invalid data"
35661 One area that sometimes gives rise to problems concerns the EHLO or
35662 HELO commands. Some clients send syntactically invalid versions of these
35663 commands, which Exim rejects by default. (This is nothing to do with verifying
35664 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35665 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35666 match the broken hosts that send invalid commands.
35667
35668 .cindex "SIZE option on MAIL command"
35669 .cindex "MAIL" "SIZE option"
35670 The amount of disk space available is checked whenever SIZE is received on
35671 a MAIL command, independently of whether &%message_size_limit%& or
35672 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35673 false. A temporary error is given if there is not enough space. If
35674 &%check_spool_space%& is set, the check is for that amount of space plus the
35675 value given with SIZE, that is, it checks that the addition of the incoming
35676 message will not reduce the space below the threshold.
35677
35678 When a message is successfully received, Exim includes the local message id in
35679 its response to the final &"."& that terminates the data. If the remote host
35680 logs this text it can help with tracing what has happened to a message.
35681
35682 The Exim daemon can limit the number of simultaneous incoming connections it is
35683 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35684 number of simultaneous incoming connections from a single remote host (see the
35685 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35686 rejected using the SMTP temporary error code 421.
35687
35688 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35689 subprocess has finished, as this can get lost at busy times. Instead, it looks
35690 for completed subprocesses every time it wakes up. Provided there are other
35691 things happening (new incoming calls, starts of queue runs), completed
35692 processes will be noticed and tidied away. On very quiet systems you may
35693 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35694 it will be noticed when the daemon next wakes up.
35695
35696 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35697 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35698 high system load &-- for details see the &%smtp_accept_reserve%&,
35699 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35700 applies in both the daemon and &'inetd'& cases.
35701
35702 Exim normally starts a delivery process for each message received, though this
35703 can be varied by means of the &%-odq%& command line option and the
35704 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35705 number of simultaneously running delivery processes started in this way from
35706 SMTP input can be limited by the &%smtp_accept_queue%& and
35707 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35708 subsequently received messages are just put on the input queue without starting
35709 a delivery process.
35710
35711 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35712 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35713 started up from the &'inetd'& daemon, because in that case each connection is
35714 handled by an entirely independent Exim process. Control by load average is,
35715 however, available with &'inetd'&.
35716
35717 Exim can be configured to verify addresses in incoming SMTP commands as they
35718 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35719 to rewrite addresses at this time &-- before any syntax checking is done. See
35720 section &<<SECTrewriteS>>&.
35721
35722 Exim can also be configured to limit the rate at which a client host submits
35723 MAIL and RCPT commands in a single SMTP session. See the
35724 &%smtp_ratelimit_hosts%& option.
35725
35726
35727
35728 .section "Unrecognized SMTP commands" "SECID234"
35729 .cindex "SMTP" "unrecognized commands"
35730 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35731 commands during a single SMTP connection, it drops the connection after sending
35732 the error response to the last command. The default value for
35733 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35734 abuse that subvert web servers into making connections to SMTP ports; in these
35735 circumstances, a number of non-SMTP lines are sent first.
35736
35737
35738 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35739 .cindex "SMTP" "syntax errors"
35740 .cindex "SMTP" "protocol errors"
35741 A syntax error is detected if an SMTP command is recognized, but there is
35742 something syntactically wrong with its data, for example, a malformed email
35743 address in a RCPT command. Protocol errors include invalid command
35744 sequencing such as RCPT before MAIL. If Exim receives more than
35745 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35746 drops the connection after sending the error response to the last command. The
35747 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35748 broken clients that loop sending bad commands (yes, it has been seen).
35749
35750
35751
35752 .section "Use of non-mail SMTP commands" "SECID236"
35753 .cindex "SMTP" "non-mail commands"
35754 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35755 DATA. Exim counts such commands, and drops the connection if there are too
35756 many of them in a single SMTP session. This action catches some
35757 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35758 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35759 defines what &"too many"& means. Its default value is 10.
35760
35761 When a new message is expected, one occurrence of RSET is not counted. This
35762 allows a client to send one RSET between messages (this is not necessary,
35763 but some clients do it). Exim also allows one uncounted occurrence of HELO
35764 or EHLO, and one occurrence of STARTTLS between messages. After
35765 starting up a TLS session, another EHLO is expected, and so it too is not
35766 counted.
35767
35768 The first occurrence of AUTH in a connection, or immediately following
35769 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35770 RCPT, DATA, and QUIT are counted.
35771
35772 You can control which hosts are subject to the limit set by
35773 &%smtp_accept_max_nonmail%& by setting
35774 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35775 the limit apply to all hosts. This option means that you can exclude any
35776 specific badly-behaved hosts that you have to live with.
35777
35778
35779
35780
35781 .section "The VRFY and EXPN commands" "SECID237"
35782 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35783 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35784 appropriate) in order to decide whether the command should be accepted or not.
35785
35786 .cindex "VRFY" "processing"
35787 When no ACL is defined for VRFY, or if it rejects without
35788 setting an explicit response code, the command is accepted
35789 (with a 252 SMTP response code)
35790 in order to support awkward clients that do a VRFY before every RCPT.
35791 When VRFY is accepted, it runs exactly the same code as when Exim is
35792 called with the &%-bv%& option, and returns 250/451/550
35793 SMTP response codes.
35794
35795 .cindex "EXPN" "processing"
35796 If no ACL for EXPN is defined, the command is rejected.
35797 When EXPN is accepted, a single-level expansion of the address is done.
35798 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35799 than a verification (the &%-bv%& option). If an unqualified local part is given
35800 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35801 of VRFY and EXPN commands are logged on the main and reject logs, and
35802 VRFY verification failures are logged on the main log for consistency with
35803 RCPT failures.
35804
35805
35806
35807 .section "The ETRN command" "SECTETRN"
35808 .cindex "ETRN" "processing"
35809 RFC 1985 describes an SMTP command called ETRN that is designed to
35810 overcome the security problems of the TURN command (which has fallen into
35811 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35812 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35813 should be accepted or not. If no ACL is defined, the command is rejected.
35814
35815 The ETRN command is concerned with &"releasing"& messages that are awaiting
35816 delivery to certain hosts. As Exim does not organize its message queue by host,
35817 the only form of ETRN that is supported by default is the one where the
35818 text starts with the &"#"& prefix, in which case the remainder of the text is
35819 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35820 the &%-R%& option to happen, with the remainder of the ETRN text as its
35821 argument. For example,
35822 .code
35823 ETRN #brigadoon
35824 .endd
35825 runs the command
35826 .code
35827 exim -R brigadoon
35828 .endd
35829 which causes a delivery attempt on all messages with undelivered addresses
35830 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35831 default), Exim prevents the simultaneous execution of more than one queue run
35832 for the same argument string as a result of an ETRN command. This stops
35833 a misbehaving client from starting more than one queue runner at once.
35834
35835 .cindex "hints database" "ETRN serialization"
35836 Exim implements the serialization by means of a hints database in which a
35837 record is written whenever a process is started by ETRN, and deleted when
35838 the process completes. However, Exim does not keep the SMTP session waiting for
35839 the ETRN process to complete. Once ETRN is accepted, the client is sent
35840 a &"success"& return code. Obviously there is scope for hints records to get
35841 left lying around if there is a system or program crash. To guard against this,
35842 Exim ignores any records that are more than six hours old.
35843
35844 .oindex "&%smtp_etrn_command%&"
35845 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35846 used. This specifies a command that is run whenever ETRN is received,
35847 whatever the form of its argument. For
35848 example:
35849 .code
35850 smtp_etrn_command = /etc/etrn_command $domain \
35851                     $sender_host_address
35852 .endd
35853 .vindex "&$domain$&"
35854 The string is split up into arguments which are independently expanded. The
35855 expansion variable &$domain$& is set to the argument of the ETRN command,
35856 and no syntax checking is done on the contents of this argument. Exim does not
35857 wait for the command to complete, so its status code is not checked. Exim runs
35858 under its own uid and gid when receiving incoming SMTP, so it is not possible
35859 for it to change them before running the command.
35860
35861
35862
35863 .section "Incoming local SMTP" "SECID238"
35864 .cindex "SMTP" "local incoming"
35865 Some user agents use SMTP to pass messages to their local MTA using the
35866 standard input and output, as opposed to passing the envelope on the command
35867 line and writing the message to the standard input. This is supported by the
35868 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35869 messages over TCP/IP (including the use of ACLs), except that the envelope
35870 sender given in a MAIL command is ignored unless the caller is trusted. In
35871 an ACL you can detect this form of SMTP input by testing for an empty host
35872 identification. It is common to have this as the first line in the ACL that
35873 runs for RCPT commands:
35874 .code
35875 accept hosts = :
35876 .endd
35877 This accepts SMTP messages from local processes without doing any other tests.
35878
35879
35880
35881 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35882 .cindex "SMTP" "batched outgoing"
35883 .cindex "batched SMTP output"
35884 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35885 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35886 be output in BSMTP format. No SMTP responses are possible for this form of
35887 delivery. All it is doing is using SMTP commands as a way of transmitting the
35888 envelope along with the message.
35889
35890 The message is written to the file or pipe preceded by the SMTP commands
35891 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35892 the message that start with a dot have an extra dot added. The SMTP command
35893 HELO is not normally used. If it is required, the &%message_prefix%& option
35894 can be used to specify it.
35895
35896 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35897 one recipient address at a time by default. However, you can arrange for them
35898 to handle several addresses at once by setting the &%batch_max%& option. When
35899 this is done for BSMTP, messages may contain multiple RCPT commands. See
35900 chapter &<<CHAPbatching>>& for more details.
35901
35902 .vindex "&$host$&"
35903 When one or more addresses are routed to a BSMTP transport by a router that
35904 sets up a host list, the name of the first host on the list is available to the
35905 transport in the variable &$host$&. Here is an example of such a transport and
35906 router:
35907 .code
35908 begin routers
35909 route_append:
35910   driver = manualroute
35911   transport = smtp_appendfile
35912   route_list = domain.example  batch.host.example
35913
35914 begin transports
35915 smtp_appendfile:
35916   driver = appendfile
35917   directory = /var/bsmtp/$host
35918   batch_max = 1000
35919   use_bsmtp
35920   user = exim
35921 .endd
35922 This causes messages addressed to &'domain.example'& to be written in BSMTP
35923 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35924 message (unless there are more than 1000 recipients).
35925
35926
35927
35928 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35929 .cindex "SMTP" "batched incoming"
35930 .cindex "batched SMTP input"
35931 The &%-bS%& command line option causes Exim to accept one or more messages by
35932 reading SMTP on the standard input, but to generate no responses. If the caller
35933 is trusted, the senders in the MAIL commands are believed; otherwise the
35934 sender is always the caller of Exim. Unqualified senders and receivers are not
35935 rejected (there seems little point) but instead just get qualified. HELO
35936 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35937 as NOOP; QUIT quits.
35938
35939 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35940 ACL is run in the same way as for non-SMTP local input.
35941
35942 If an error is detected while reading a message, including a missing &"."& at
35943 the end, Exim gives up immediately. It writes details of the error to the
35944 standard output in a stylized way that the calling program should be able to
35945 make some use of automatically, for example:
35946 .code
35947 554 Unexpected end of file
35948 Transaction started in line 10
35949 Error detected in line 14
35950 .endd
35951 It writes a more verbose version, for human consumption, to the standard error
35952 file, for example:
35953 .code
35954 An error was detected while processing a file of BSMTP input.
35955 The error message was:
35956
35957 501 '>' missing at end of address
35958
35959 The SMTP transaction started in line 10.
35960 The error was detected in line 12.
35961 The SMTP command at fault was:
35962
35963 rcpt to:<malformed@in.com.plete
35964
35965 1 previous message was successfully processed.
35966 The rest of the batch was abandoned.
35967 .endd
35968 The return code from Exim is zero only if there were no errors. It is 1 if some
35969 messages were accepted before an error was detected, and 2 if no messages were
35970 accepted.
35971 .ecindex IIDsmtpproc1
35972 .ecindex IIDsmtpproc2
35973
35974
35975
35976 . ////////////////////////////////////////////////////////////////////////////
35977 . ////////////////////////////////////////////////////////////////////////////
35978
35979 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35980          "Customizing messages"
35981 When a message fails to be delivered, or remains in the queue for more than a
35982 configured amount of time, Exim sends a message to the original sender, or
35983 to an alternative configured address. The text of these messages is built into
35984 the code of Exim, but it is possible to change it, either by adding a single
35985 string, or by replacing each of the paragraphs by text supplied in a file.
35986
35987 The &'From:'& and &'To:'& header lines are automatically generated; you can
35988 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
35989 option. Exim also adds the line
35990 .code
35991 Auto-Submitted: auto-generated
35992 .endd
35993 to all warning and bounce messages,
35994
35995
35996 .section "Customizing bounce messages" "SECID239"
35997 .cindex "customizing" "bounce message"
35998 .cindex "bounce message" "customizing"
35999 If &%bounce_message_text%& is set, its contents are included in the default
36000 message immediately after &"This message was created automatically by mail
36001 delivery software."& The string is not expanded. It is not used if
36002 &%bounce_message_file%& is set.
36003
36004 When &%bounce_message_file%& is set, it must point to a template file for
36005 constructing error messages. The file consists of a series of text items,
36006 separated by lines consisting of exactly four asterisks. If the file cannot be
36007 opened, default text is used and a message is written to the main and panic
36008 logs. If any text item in the file is empty, default text is used for that
36009 item.
36010
36011 .vindex "&$bounce_recipient$&"
36012 .vindex "&$bounce_return_size_limit$&"
36013 Each item of text that is read from the file is expanded, and there are two
36014 expansion variables which can be of use here: &$bounce_recipient$& is set to
36015 the recipient of an error message while it is being created, and
36016 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36017 option, rounded to a whole number.
36018
36019 The items must appear in the file in the following order:
36020
36021 .ilist
36022 The first item is included in the headers, and should include at least a
36023 &'Subject:'& header. Exim does not check the syntax of these headers.
36024 .next
36025 The second item forms the start of the error message. After it, Exim lists the
36026 failing addresses with their error messages.
36027 .next
36028 The third item is used to introduce any text from pipe transports that is to be
36029 returned to the sender. It is omitted if there is no such text.
36030 .next
36031 The fourth, fifth and sixth items will be ignored and may be empty.
36032 The fields exist for back-compatibility
36033 .endlist
36034
36035 The default state (&%bounce_message_file%& unset) is equivalent to the
36036 following file, in which the sixth item is empty. The &'Subject:'& and some
36037 other lines have been split in order to fit them on the page:
36038 .code
36039 Subject: Mail delivery failed
36040   ${if eq{$sender_address}{$bounce_recipient}
36041   {: returning message to sender}}
36042 ****
36043 This message was created automatically by mail delivery software.
36044
36045 A message ${if eq{$sender_address}{$bounce_recipient}
36046   {that you sent }{sent by
36047
36048 <$sender_address>
36049
36050 }}could not be delivered to all of its recipients.
36051 This is a permanent error. The following address(es) failed:
36052 ****
36053 The following text was generated during the delivery attempt(s):
36054 ****
36055 ------ This is a copy of the message, including all the headers.
36056   ------
36057 ****
36058 ------ The body of the message is $message_size characters long;
36059   only the first
36060 ------ $bounce_return_size_limit or so are included here.
36061 ****
36062 .endd
36063 .section "Customizing warning messages" "SECTcustwarn"
36064 .cindex "customizing" "warning message"
36065 .cindex "warning of delay" "customizing the message"
36066 The option &%warn_message_file%& can be pointed at a template file for use when
36067 warnings about message delays are created. In this case there are only three
36068 text sections:
36069
36070 .ilist
36071 The first item is included in the headers, and should include at least a
36072 &'Subject:'& header. Exim does not check the syntax of these headers.
36073 .next
36074 The second item forms the start of the warning message. After it, Exim lists
36075 the delayed addresses.
36076 .next
36077 The third item then ends the message.
36078 .endlist
36079
36080 The default state is equivalent to the following file, except that some lines
36081 have been split here, in order to fit them on the page:
36082 .code
36083 Subject: Warning: message $message_exim_id delayed
36084   $warn_message_delay
36085 ****
36086 This message was created automatically by mail delivery software.
36087
36088 A message ${if eq{$sender_address}{$warn_message_recipients}
36089 {that you sent }{sent by
36090
36091 <$sender_address>
36092
36093 }}has not been delivered to all of its recipients after
36094 more than $warn_message_delay in the queue on $primary_hostname.
36095
36096 The message identifier is:     $message_exim_id
36097 The subject of the message is: $h_subject
36098 The date of the message is:    $h_date
36099
36100 The following address(es) have not yet been delivered:
36101 ****
36102 No action is required on your part. Delivery attempts will
36103 continue for some time, and this warning may be repeated at
36104 intervals if the message remains undelivered. Eventually the
36105 mail delivery software will give up, and when that happens,
36106 the message will be returned to you.
36107 .endd
36108 .vindex "&$warn_message_delay$&"
36109 .vindex "&$warn_message_recipients$&"
36110 However, in the default state the subject and date lines are omitted if no
36111 appropriate headers exist. During the expansion of this file,
36112 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36113 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36114 of recipients for the warning message. There may be more than one if there are
36115 multiple addresses with different &%errors_to%& settings on the routers that
36116 handled them.
36117
36118
36119
36120
36121 . ////////////////////////////////////////////////////////////////////////////
36122 . ////////////////////////////////////////////////////////////////////////////
36123
36124 .chapter "Some common configuration settings" "CHAPcomconreq"
36125 This chapter discusses some configuration settings that seem to be fairly
36126 common. More examples and discussion can be found in the Exim book.
36127
36128
36129
36130 .section "Sending mail to a smart host" "SECID240"
36131 .cindex "smart host" "example router"
36132 If you want to send all mail for non-local domains to a &"smart host"&, you
36133 should replace the default &(dnslookup)& router with a router which does the
36134 routing explicitly:
36135 .code
36136 send_to_smart_host:
36137   driver = manualroute
36138   route_list = !+local_domains smart.host.name
36139   transport = remote_smtp
36140 .endd
36141 You can use the smart host's IP address instead of the name if you wish.
36142 If you are using Exim only to submit messages to a smart host, and not for
36143 receiving incoming messages, you can arrange for it to do the submission
36144 synchronously by setting the &%mua_wrapper%& option (see chapter
36145 &<<CHAPnonqueueing>>&).
36146
36147
36148
36149
36150 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36151 .cindex "mailing lists"
36152 Exim can be used to run simple mailing lists, but for large and/or complicated
36153 requirements, the use of additional specialized mailing list software such as
36154 Majordomo or Mailman is recommended.
36155
36156 The &(redirect)& router can be used to handle mailing lists where each list
36157 is maintained in a separate file, which can therefore be managed by an
36158 independent manager. The &%domains%& router option can be used to run these
36159 lists in a separate domain from normal mail. For example:
36160 .code
36161 lists:
36162   driver = redirect
36163   domains = lists.example
36164   file = /usr/lists/$local_part
36165   forbid_pipe
36166   forbid_file
36167   errors_to = $local_part-request@lists.example
36168   no_more
36169 .endd
36170 This router is skipped for domains other than &'lists.example'&. For addresses
36171 in that domain, it looks for a file that matches the local part. If there is no
36172 such file, the router declines, but because &%no_more%& is set, no subsequent
36173 routers are tried, and so the whole delivery fails.
36174
36175 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36176 expanded into a filename or a pipe delivery, which is usually inappropriate in
36177 a mailing list.
36178
36179 .oindex "&%errors_to%&"
36180 The &%errors_to%& option specifies that any delivery errors caused by addresses
36181 taken from a mailing list are to be sent to the given address rather than the
36182 original sender of the message. However, before acting on this, Exim verifies
36183 the error address, and ignores it if verification fails.
36184
36185 For example, using the configuration above, mail sent to
36186 &'dicts@lists.example'& is passed on to those addresses contained in
36187 &_/usr/lists/dicts_&, with error reports directed to
36188 &'dicts-request@lists.example'&, provided that this address can be verified.
36189 There could be a file called &_/usr/lists/dicts-request_& containing
36190 the address(es) of this particular list's manager(s), but other approaches,
36191 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36192 or &%local_part_suffix%& options) to handle addresses of the form
36193 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36194
36195
36196
36197 .section "Syntax errors in mailing lists" "SECID241"
36198 .cindex "mailing lists" "syntax errors in"
36199 If an entry in redirection data contains a syntax error, Exim normally defers
36200 delivery of the original address. That means that a syntax error in a mailing
36201 list holds up all deliveries to the list. This may not be appropriate when a
36202 list is being maintained automatically from data supplied by users, and the
36203 addresses are not rigorously checked.
36204
36205 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36206 entries that fail to parse, noting the incident in the log. If in addition
36207 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36208 whenever a broken address is skipped. It is usually appropriate to set
36209 &%syntax_errors_to%& to the same address as &%errors_to%&.
36210
36211
36212
36213 .section "Re-expansion of mailing lists" "SECID242"
36214 .cindex "mailing lists" "re-expansion of"
36215 Exim remembers every individual address to which a message has been delivered,
36216 in order to avoid duplication, but it normally stores only the original
36217 recipient addresses with a message. If all the deliveries to a mailing list
36218 cannot be done at the first attempt, the mailing list is re-expanded when the
36219 delivery is next tried. This means that alterations to the list are taken into
36220 account at each delivery attempt, so addresses that have been added to
36221 the list since the message arrived will therefore receive a copy of the
36222 message, even though it pre-dates their subscription.
36223
36224 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36225 on the &(redirect)& router. If this is done, any addresses generated by the
36226 router that fail to deliver at the first attempt are added to the message as
36227 &"top level"& addresses, and the parent address that generated them is marked
36228 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36229 subsequent delivery attempts. The disadvantage of this is that if any of the
36230 failing addresses are incorrect, correcting them in the file has no effect on
36231 pre-existing messages.
36232
36233 The original top-level address is remembered with each of the generated
36234 addresses, and is output in any log messages. However, any intermediate parent
36235 addresses are not recorded. This makes a difference to the log only if the
36236 &%all_parents%& selector is set, but for mailing lists there is normally only
36237 one level of expansion anyway.
36238
36239
36240
36241 .section "Closed mailing lists" "SECID243"
36242 .cindex "mailing lists" "closed"
36243 The examples so far have assumed open mailing lists, to which anybody may
36244 send mail. It is also possible to set up closed lists, where mail is accepted
36245 from specified senders only. This is done by making use of the generic
36246 &%senders%& option to restrict the router that handles the list.
36247
36248 The following example uses the same file as a list of recipients and as a list
36249 of permitted senders. It requires three routers:
36250 .code
36251 lists_request:
36252   driver = redirect
36253   domains = lists.example
36254   local_part_suffix = -request
36255   file = /usr/lists/$local_part$local_part_suffix
36256   no_more
36257
36258 lists_post:
36259   driver = redirect
36260   domains = lists.example
36261   senders = ${if exists {/usr/lists/$local_part}\
36262              {lsearch;/usr/lists/$local_part}{*}}
36263   file = /usr/lists/$local_part
36264   forbid_pipe
36265   forbid_file
36266   errors_to = $local_part-request@lists.example
36267   no_more
36268
36269 lists_closed:
36270   driver = redirect
36271   domains = lists.example
36272   allow_fail
36273   data = :fail: $local_part@lists.example is a closed mailing list
36274 .endd
36275 All three routers have the same &%domains%& setting, so for any other domains,
36276 they are all skipped. The first router runs only if the local part ends in
36277 &%-request%&. It handles messages to the list manager(s) by means of an open
36278 mailing list.
36279
36280 The second router runs only if the &%senders%& precondition is satisfied. It
36281 checks for the existence of a list that corresponds to the local part, and then
36282 checks that the sender is on the list by means of a linear search. It is
36283 necessary to check for the existence of the file before trying to search it,
36284 because otherwise Exim thinks there is a configuration error. If the file does
36285 not exist, the expansion of &%senders%& is *, which matches all senders. This
36286 means that the router runs, but because there is no list, declines, and
36287 &%no_more%& ensures that no further routers are run. The address fails with an
36288 &"unrouteable address"& error.
36289
36290 The third router runs only if the second router is skipped, which happens when
36291 a mailing list exists, but the sender is not on it. This router forcibly fails
36292 the address, giving a suitable error message.
36293
36294
36295
36296
36297 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36298 .cindex "VERP"
36299 .cindex "Variable Envelope Return Paths"
36300 .cindex "envelope from"
36301 .cindex "envelope sender"
36302 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36303 are a way of helping mailing list administrators discover which subscription
36304 address is the cause of a particular delivery failure. The idea is to encode
36305 the original recipient address in the outgoing envelope sender address, so that
36306 if the message is forwarded by another host and then subsequently bounces, the
36307 original recipient can be extracted from the recipient address of the bounce.
36308
36309 .oindex &%errors_to%&
36310 .oindex &%return_path%&
36311 Envelope sender addresses can be modified by Exim using two different
36312 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36313 list examples), or the &%return_path%& option on a transport. The second of
36314 these is effective only if the message is successfully delivered to another
36315 host; it is not used for errors detected on the local host (see the description
36316 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36317 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36318 .code
36319 verp_smtp:
36320   driver = smtp
36321   max_rcpt = 1
36322   return_path = \
36323     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36324       {$1-request+$local_part=$domain@your.dom.example}fail}
36325 .endd
36326 This has the effect of rewriting the return path (envelope sender) on outgoing
36327 SMTP messages, if the local part of the original return path ends in
36328 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36329 local part and domain of the recipient into the return path. Suppose, for
36330 example, that a message whose return path has been set to
36331 &'somelist-request@your.dom.example'& is sent to
36332 &'subscriber@other.dom.example'&. In the transport, the return path is
36333 rewritten as
36334 .code
36335 somelist-request+subscriber=other.dom.example@your.dom.example
36336 .endd
36337 .vindex "&$local_part$&"
36338 For this to work, you must tell Exim to send multiple copies of messages that
36339 have more than one recipient, so that each copy has just one recipient. This is
36340 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36341 might be sent to several different recipients in the same domain, in which case
36342 &$local_part$& is not available in the transport, because it is not unique.
36343
36344 Unless your host is doing nothing but mailing list deliveries, you should
36345 probably use a separate transport for the VERP deliveries, so as not to use
36346 extra resources in making one-per-recipient copies for other deliveries. This
36347 can easily be done by expanding the &%transport%& option in the router:
36348 .code
36349 dnslookup:
36350   driver = dnslookup
36351   domains = ! +local_domains
36352   transport = \
36353     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36354       {verp_smtp}{remote_smtp}}
36355   no_more
36356 .endd
36357 If you want to change the return path using &%errors_to%& in a router instead
36358 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36359 routers that handle mailing list addresses. This will ensure that all delivery
36360 errors, including those detected on the local host, are sent to the VERP
36361 address.
36362
36363 On a host that does no local deliveries and has no manual routing, only the
36364 &(dnslookup)& router needs to be changed. A special transport is not needed for
36365 SMTP deliveries. Every mailing list recipient has its own return path value,
36366 and so Exim must hand them to the transport one at a time. Here is an example
36367 of a &(dnslookup)& router that implements VERP:
36368 .code
36369 verp_dnslookup:
36370   driver = dnslookup
36371   domains = ! +local_domains
36372   transport = remote_smtp
36373   errors_to = \
36374     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36375      {$1-request+$local_part=$domain@your.dom.example}fail}
36376   no_more
36377 .endd
36378 Before you start sending out messages with VERPed return paths, you must also
36379 configure Exim to accept the bounce messages that come back to those paths.
36380 Typically this is done by setting a &%local_part_suffix%& option for a
36381 router, and using this to route the messages to wherever you want to handle
36382 them.
36383
36384 The overhead incurred in using VERP depends very much on the size of the
36385 message, the number of recipient addresses that resolve to the same remote
36386 host, and the speed of the connection over which the message is being sent. If
36387 a lot of addresses resolve to the same host and the connection is slow, sending
36388 a separate copy of the message for each address may take substantially longer
36389 than sending a single copy with many recipients (for which VERP cannot be
36390 used).
36391
36392
36393
36394
36395
36396
36397 .section "Virtual domains" "SECTvirtualdomains"
36398 .cindex "virtual domains"
36399 .cindex "domain" "virtual"
36400 The phrase &'virtual domain'& is unfortunately used with two rather different
36401 meanings:
36402
36403 .ilist
36404 A domain for which there are no real mailboxes; all valid local parts are
36405 aliases for other email addresses. Common examples are organizational
36406 top-level domains and &"vanity"& domains.
36407 .next
36408 One of a number of independent domains that are all handled by the same host,
36409 with mailboxes on that host, but where the mailbox owners do not necessarily
36410 have login accounts on that host.
36411 .endlist
36412
36413 The first usage is probably more common, and does seem more &"virtual"& than
36414 the second. This kind of domain can be handled in Exim with a straightforward
36415 aliasing router. One approach is to create a separate alias file for each
36416 virtual domain. Exim can test for the existence of the alias file to determine
36417 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36418 to a router of this form:
36419 .code
36420 virtual:
36421   driver = redirect
36422   domains = dsearch;/etc/mail/virtual
36423   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36424   no_more
36425 .endd
36426 The &%domains%& option specifies that the router is to be skipped, unless there
36427 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36428 domain that is being processed. When the router runs, it looks up the local
36429 part in the file to find a new address (or list of addresses). The &%no_more%&
36430 setting ensures that if the lookup fails (leading to &%data%& being an empty
36431 string), Exim gives up on the address without trying any subsequent routers.
36432
36433 This one router can handle all the virtual domains because the alias filenames
36434 follow a fixed pattern. Permissions can be arranged so that appropriate people
36435 can edit the different alias files. A successful aliasing operation results in
36436 a new envelope recipient address, which is then routed from scratch.
36437
36438 The other kind of &"virtual"& domain can also be handled in a straightforward
36439 way. One approach is to create a file for each domain containing a list of
36440 valid local parts, and use it in a router like this:
36441 .code
36442 my_domains:
36443   driver = accept
36444   domains = dsearch;/etc/mail/domains
36445   local_parts = lsearch;/etc/mail/domains/$domain
36446   transport = my_mailboxes
36447 .endd
36448 The address is accepted if there is a file for the domain, and the local part
36449 can be found in the file. The &%domains%& option is used to check for the
36450 file's existence because &%domains%& is tested before the &%local_parts%&
36451 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36452 because that option is tested after &%local_parts%&. The transport is as
36453 follows:
36454 .code
36455 my_mailboxes:
36456   driver = appendfile
36457   file = /var/mail/$domain/$local_part
36458   user = mail
36459 .endd
36460 This uses a directory of mailboxes for each domain. The &%user%& setting is
36461 required, to specify which uid is to be used for writing to the mailboxes.
36462
36463 The configuration shown here is just one example of how you might support this
36464 requirement. There are many other ways this kind of configuration can be set
36465 up, for example, by using a database instead of separate files to hold all the
36466 information about the domains.
36467
36468
36469
36470 .section "Multiple user mailboxes" "SECTmulbox"
36471 .cindex "multiple mailboxes"
36472 .cindex "mailbox" "multiple"
36473 .cindex "local part" "prefix"
36474 .cindex "local part" "suffix"
36475 Heavy email users often want to operate with multiple mailboxes, into which
36476 incoming mail is automatically sorted. A popular way of handling this is to
36477 allow users to use multiple sender addresses, so that replies can easily be
36478 identified. Users are permitted to add prefixes or suffixes to their local
36479 parts for this purpose. The wildcard facility of the generic router options
36480 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36481 example, consider this router:
36482 .code
36483 userforward:
36484   driver = redirect
36485   check_local_user
36486   file = $home/.forward
36487   local_part_suffix = -*
36488   local_part_suffix_optional
36489   allow_filter
36490 .endd
36491 .vindex "&$local_part_suffix$&"
36492 It runs a user's &_.forward_& file for all local parts of the form
36493 &'username-*'&. Within the filter file the user can distinguish different
36494 cases by testing the variable &$local_part_suffix$&. For example:
36495 .code
36496 if $local_part_suffix contains -special then
36497 save /home/$local_part/Mail/special
36498 endif
36499 .endd
36500 If the filter file does not exist, or does not deal with such addresses, they
36501 fall through to subsequent routers, and, assuming no subsequent use of the
36502 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36503 control over which suffixes are valid.
36504
36505 Alternatively, a suffix can be used to trigger the use of a different
36506 &_.forward_& file &-- which is the way a similar facility is implemented in
36507 another MTA:
36508 .code
36509 userforward:
36510   driver = redirect
36511   check_local_user
36512   file = $home/.forward$local_part_suffix
36513   local_part_suffix = -*
36514   local_part_suffix_optional
36515   allow_filter
36516 .endd
36517 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36518 example, &_.forward-special_& is used. Once again, if the appropriate file
36519 does not exist, or does not deal with the address, it is passed on to
36520 subsequent routers, which could, if required, look for an unqualified
36521 &_.forward_& file to use as a default.
36522
36523
36524
36525 .section "Simplified vacation processing" "SECID244"
36526 .cindex "vacation processing"
36527 The traditional way of running the &'vacation'& program is for a user to set up
36528 a pipe command in a &_.forward_& file
36529 (see section &<<SECTspecitredli>>& for syntax details).
36530 This is prone to error by inexperienced users. There are two features of Exim
36531 that can be used to make this process simpler for users:
36532
36533 .ilist
36534 A local part prefix such as &"vacation-"& can be specified on a router which
36535 can cause the message to be delivered directly to the &'vacation'& program, or
36536 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36537 &_.forward_& file are then much simpler. For example:
36538 .code
36539 spqr, vacation-spqr
36540 .endd
36541 .next
36542 The &%require_files%& generic router option can be used to trigger a
36543 vacation delivery by checking for the existence of a certain file in the
36544 user's home directory. The &%unseen%& generic option should also be used, to
36545 ensure that the original delivery also proceeds. In this case, all the user has
36546 to do is to create a file called, say, &_.vacation_&, containing a vacation
36547 message.
36548 .endlist
36549
36550 Another advantage of both these methods is that they both work even when the
36551 use of arbitrary pipes by users is locked out.
36552
36553
36554
36555 .section "Taking copies of mail" "SECID245"
36556 .cindex "message" "copying every"
36557 Some installations have policies that require archive copies of all messages to
36558 be made. A single copy of each message can easily be taken by an appropriate
36559 command in a system filter, which could, for example, use a different file for
36560 each day's messages.
36561
36562 There is also a shadow transport mechanism that can be used to take copies of
36563 messages that are successfully delivered by local transports, one copy per
36564 delivery. This could be used, &'inter alia'&, to implement automatic
36565 notification of delivery by sites that insist on doing such things.
36566
36567
36568
36569 .section "Intermittently connected hosts" "SECID246"
36570 .cindex "intermittently connected hosts"
36571 It has become quite common (because it is cheaper) for hosts to connect to the
36572 Internet periodically rather than remain connected all the time. The normal
36573 arrangement is that mail for such hosts accumulates on a system that is
36574 permanently connected.
36575
36576 Exim was designed for use on permanently connected hosts, and so it is not
36577 particularly well-suited to use in an intermittently connected environment.
36578 Nevertheless there are some features that can be used.
36579
36580
36581 .section "Exim on the upstream server host" "SECID247"
36582 It is tempting to arrange for incoming mail for the intermittently connected
36583 host to remain in Exim's queue until the client connects. However, this
36584 approach does not scale very well. Two different kinds of waiting message are
36585 being mixed up in the same queue &-- those that cannot be delivered because of
36586 some temporary problem, and those that are waiting for their destination host
36587 to connect. This makes it hard to manage the queue, as well as wasting
36588 resources, because each queue runner scans the entire queue.
36589
36590 A better approach is to separate off those messages that are waiting for an
36591 intermittently connected host. This can be done by delivering these messages
36592 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36593 format, from where they are transmitted by other software when their
36594 destination connects. This makes it easy to collect all the mail for one host
36595 in a single directory, and to apply local timeout rules on a per-message basis
36596 if required.
36597
36598 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36599 you are doing this, you should configure Exim with a long retry period for the
36600 intermittent host. For example:
36601 .code
36602 cheshire.wonderland.fict.example    *   F,5d,24h
36603 .endd
36604 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36605 which messages it has queued up for that host. Once the intermittent host comes
36606 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36607 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36608 causes all the queued up messages to be delivered, often down a single SMTP
36609 connection. While the host remains connected, any new messages get delivered
36610 immediately.
36611
36612 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36613 issued with a different IP address each time it connects, Exim's retry
36614 mechanisms on the holding host get confused, because the IP address is normally
36615 used as part of the key string for holding retry information. This can be
36616 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36617 Since this has disadvantages for permanently connected hosts, it is best to
36618 arrange a separate transport for the intermittently connected ones.
36619
36620
36621
36622 .section "Exim on the intermittently connected client host" "SECID248"
36623 The value of &%smtp_accept_queue_per_connection%& should probably be
36624 increased, or even set to zero (that is, disabled) on the intermittently
36625 connected host, so that all incoming messages down a single connection get
36626 delivered immediately.
36627
36628 .cindex "SMTP" "passed connection"
36629 .cindex "SMTP" "multiple deliveries"
36630 .cindex "multiple SMTP deliveries"
36631 Mail waiting to be sent from an intermittently connected host will probably
36632 not have been routed, because without a connection DNS lookups are not
36633 possible. This means that if a normal queue run is done at connection time,
36634 each message is likely to be sent in a separate SMTP session. This can be
36635 avoided by starting the queue run with a command line option beginning with
36636 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36637 first pass, routing is done but no deliveries take place. The second pass is a
36638 normal queue run; since all the messages have been previously routed, those
36639 destined for the same host are likely to get sent as multiple deliveries in a
36640 single SMTP connection.
36641
36642
36643
36644 . ////////////////////////////////////////////////////////////////////////////
36645 . ////////////////////////////////////////////////////////////////////////////
36646
36647 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36648          "Exim as a non-queueing client"
36649 .cindex "client, non-queueing"
36650 .cindex "smart host" "suppressing queueing"
36651 On a personal computer, it is a common requirement for all
36652 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36653 configured to operate that way, for all the popular operating systems.
36654 However, there are some MUAs for Unix-like systems that cannot be so
36655 configured: they submit messages using the command line interface of
36656 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36657 messages this way.
36658
36659 If the personal computer runs continuously, there is no problem, because it can
36660 run a conventional MTA that handles delivery to the smart host, and deal with
36661 any delays via its queueing mechanism. However, if the computer does not run
36662 continuously or runs different operating systems at different times, queueing
36663 email is not desirable.
36664
36665 There is therefore a requirement for something that can provide the
36666 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36667 any queueing or retrying facilities. Furthermore, the delivery to the smart
36668 host should be synchronous, so that if it fails, the sending MUA is immediately
36669 informed. In other words, we want something that extends an MUA that submits
36670 to a local MTA via the command line so that it behaves like one that submits
36671 to a remote smart host using TCP/SMTP.
36672
36673 There are a number of applications (for example, there is one called &'ssmtp'&)
36674 that do this job. However, people have found them to be lacking in various
36675 ways. For instance, you might want to allow aliasing and forwarding to be done
36676 before sending a message to the smart host.
36677
36678 Exim already had the necessary infrastructure for doing this job. Just a few
36679 tweaks were needed to make it behave as required, though it is somewhat of an
36680 overkill to use a fully-featured MTA for this purpose.
36681
36682 .oindex "&%mua_wrapper%&"
36683 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36684 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36685 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36686 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36687 compatible router and transport configuration. Typically there will be just one
36688 router and one transport, sending everything to a smart host.
36689
36690 When run in MUA wrapping mode, the behaviour of Exim changes in the
36691 following ways:
36692
36693 .ilist
36694 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36695 In other words, the only way to submit messages is via the command line.
36696 .next
36697 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36698 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36699 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36700 does not finish until the delivery attempt is complete. If the delivery is
36701 successful, a zero return code is given.
36702 .next
36703 Address redirection is permitted, but the final routing for all addresses must
36704 be to the same remote transport, and to the same list of hosts. Furthermore,
36705 the return address (envelope sender) must be the same for all recipients, as
36706 must any added or deleted header lines. In other words, it must be possible to
36707 deliver the message in a single SMTP transaction, however many recipients there
36708 are.
36709 .next
36710 If these conditions are not met, or if routing any address results in a
36711 failure or defer status, or if Exim is unable to deliver all the recipients
36712 successfully to one of the smart hosts, delivery of the entire message fails.
36713 .next
36714 Because no queueing is allowed, all failures are treated as permanent; there
36715 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36716 smart host. Furthermore, because only a single yes/no response can be given to
36717 the caller, it is not possible to deliver to some recipients and not others. If
36718 there is an error (temporary or permanent) for any recipient, all are failed.
36719 .next
36720 If more than one smart host is listed, Exim will try another host after a
36721 connection failure or a timeout, in the normal way. However, if this kind of
36722 failure happens for all the hosts, the delivery fails.
36723 .next
36724 When delivery fails, an error message is written to the standard error stream
36725 (as well as to Exim's log), and Exim exits to the caller with a return code
36726 value 1. The message is expunged from Exim's spool files. No bounce messages
36727 are ever generated.
36728 .next
36729 No retry data is maintained, and any retry rules are ignored.
36730 .next
36731 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36732 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36733 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36734 .endlist
36735
36736 The overall effect is that Exim makes a single synchronous attempt to deliver
36737 the message, failing if there is any kind of problem. Because no local
36738 deliveries are done and no daemon can be run, Exim does not need root
36739 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36740 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36741 the advantages and disadvantages of running without root privilege.
36742
36743
36744
36745
36746 . ////////////////////////////////////////////////////////////////////////////
36747 . ////////////////////////////////////////////////////////////////////////////
36748
36749 .chapter "Log files" "CHAPlog"
36750 .scindex IIDloggen "log" "general description"
36751 .cindex "log" "types of"
36752 Exim writes three different logs, referred to as the main log, the reject log,
36753 and the panic log:
36754
36755 .ilist
36756 .cindex "main log"
36757 The main log records the arrival of each message and each delivery in a single
36758 line in each case. The format is as compact as possible, in an attempt to keep
36759 down the size of log files. Two-character flag sequences make it easy to pick
36760 out these lines. A number of other events are recorded in the main log. Some of
36761 them are optional, in which case the &%log_selector%& option controls whether
36762 they are included or not. A Perl script called &'eximstats'&, which does simple
36763 analysis of main log files, is provided in the Exim distribution (see section
36764 &<<SECTmailstat>>&).
36765 .next
36766 .cindex "reject log"
36767 The reject log records information from messages that are rejected as a result
36768 of a configuration option (that is, for policy reasons).
36769 The first line of each rejection is a copy of the line that is also written to
36770 the main log. Then, if the message's header has been read at the time the log
36771 is written, its contents are written to this log. Only the original header
36772 lines are available; header lines added by ACLs are not logged. You can use the
36773 reject log to check that your policy controls are working correctly; on a busy
36774 host this may be easier than scanning the main log for rejection messages. You
36775 can suppress the writing of the reject log by setting &%write_rejectlog%&
36776 false.
36777 .next
36778 .cindex "panic log"
36779 .cindex "system log"
36780 When certain serious errors occur, Exim writes entries to its panic log. If the
36781 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36782 are usually written to the main log as well, but can get lost amid the mass of
36783 other entries. The panic log should be empty under normal circumstances. It is
36784 therefore a good idea to check it (or to have a &'cron'& script check it)
36785 regularly, in order to become aware of any problems. When Exim cannot open its
36786 panic log, it tries as a last resort to write to the system log (syslog). This
36787 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36788 message itself is written at priority LOG_CRIT.
36789 .endlist
36790
36791 Every log line starts with a timestamp, in the format shown in the following
36792 example. Note that many of the examples shown in this chapter are line-wrapped.
36793 In the log file, this would be all on one line:
36794 .code
36795 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36796   by QUIT
36797 .endd
36798 By default, the timestamps are in the local timezone. There are two
36799 ways of changing this:
36800
36801 .ilist
36802 You can set the &%timezone%& option to a different time zone; in particular, if
36803 you set
36804 .code
36805 timezone = UTC
36806 .endd
36807 the timestamps will be in UTC (aka GMT).
36808 .next
36809 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36810 example:
36811 .code
36812 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36813 .endd
36814 .endlist
36815
36816 .cindex "log" "process ids in"
36817 .cindex "pid (process id)" "in log lines"
36818 Exim does not include its process id in log lines by default, but you can
36819 request that it does so by specifying the &`pid`& log selector (see section
36820 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36821 brackets, immediately after the time and date.
36822
36823
36824
36825
36826 .section "Where the logs are written" "SECTwhelogwri"
36827 .cindex "log" "destination"
36828 .cindex "log" "to file"
36829 .cindex "log" "to syslog"
36830 .cindex "syslog"
36831 The logs may be written to local files, or to syslog, or both. However, it
36832 should be noted that many syslog implementations use UDP as a transport, and
36833 are therefore unreliable in the sense that messages are not guaranteed to
36834 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36835 It has also been reported that on large log files (tens of megabytes) you may
36836 need to tweak syslog to prevent it syncing the file with each write &-- on
36837 Linux this has been seen to make syslog take 90% plus of CPU time.
36838
36839 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36840 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36841 configuration. This latter string is expanded, so it can contain, for example,
36842 references to the host name:
36843 .code
36844 log_file_path = /var/log/$primary_hostname/exim_%slog
36845 .endd
36846 It is generally advisable, however, to set the string in &_Local/Makefile_&
36847 rather than at runtime, because then the setting is available right from the
36848 start of Exim's execution. Otherwise, if there's something it wants to log
36849 before it has read the configuration file (for example, an error in the
36850 configuration file) it will not use the path you want, and may not be able to
36851 log at all.
36852
36853 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36854 list, currently limited to at most two items. This is one option where the
36855 facility for changing a list separator may not be used. The list must always be
36856 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36857 otherwise the item must either be an absolute path, containing &`%s`& at the
36858 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36859 implying the use of a default path.
36860
36861 When Exim encounters an empty item in the list, it searches the list defined by
36862 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36863 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36864 mean &"use the path specified at build time"&. It no such item exists, log
36865 files are written in the &_log_& subdirectory of the spool directory. This is
36866 equivalent to the setting:
36867 .code
36868 log_file_path = $spool_directory/log/%slog
36869 .endd
36870 If you do not specify anything at build time or runtime,
36871 or if you unset the option at runtime (i.e. &`log_file_path = `&),
36872 that is where the logs are written.
36873
36874 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
36875 are in use &-- see section &<<SECTdatlogfil>>& below.
36876
36877 Here are some examples of possible settings:
36878 .display
36879 &`LOG_FILE_PATH=syslog                    `& syslog only
36880 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36881 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36882 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36883 .endd
36884 If there are more than two paths in the list, the first is used and a panic
36885 error is logged.
36886
36887
36888
36889 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36890 .cindex "log" "cycling local files"
36891 .cindex "cycling logs"
36892 .cindex "&'exicyclog'&"
36893 .cindex "log" "local files; writing to"
36894 Some operating systems provide centralized and standardized methods for cycling
36895 log files. For those that do not, a utility script called &'exicyclog'& is
36896 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36897 main and reject logs each time it is called. The maximum number of old logs to
36898 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36899
36900 An Exim delivery process opens the main log when it first needs to write to it,
36901 and it keeps the file open in case subsequent entries are required &-- for
36902 example, if a number of different deliveries are being done for the same
36903 message. However, remote SMTP deliveries can take a long time, and this means
36904 that the file may be kept open long after it is renamed if &'exicyclog'& or
36905 something similar is being used to rename log files on a regular basis. To
36906 ensure that a switch of log files is noticed as soon as possible, Exim calls
36907 &[stat()]& on the main log's name before reusing an open file, and if the file
36908 does not exist, or its inode has changed, the old file is closed and Exim
36909 tries to open the main log from scratch. Thus, an old log file may remain open
36910 for quite some time, but no Exim processes should write to it once it has been
36911 renamed.
36912
36913
36914
36915 .section "Datestamped log files" "SECTdatlogfil"
36916 .cindex "log" "datestamped files"
36917 Instead of cycling the main and reject log files by renaming them
36918 periodically, some sites like to use files whose names contain a datestamp,
36919 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36920 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36921 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36922 point where the datestamp is required. For example:
36923 .code
36924 log_file_path = /var/spool/exim/log/%slog-%D
36925 log_file_path = /var/log/exim-%s-%D.log
36926 log_file_path = /var/spool/exim/log/%D-%slog
36927 log_file_path = /var/log/exim/%s.%M
36928 .endd
36929 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36930 examples of names generated by the above examples:
36931 .code
36932 /var/spool/exim/log/mainlog-20021225
36933 /var/log/exim-reject-20021225.log
36934 /var/spool/exim/log/20021225-mainlog
36935 /var/log/exim/main.200212
36936 .endd
36937 When this form of log file is specified, Exim automatically switches to new
36938 files at midnight. It does not make any attempt to compress old logs; you
36939 will need to write your own script if you require this. You should not
36940 run &'exicyclog'& with this form of logging.
36941
36942 The location of the panic log is also determined by &%log_file_path%&, but it
36943 is not datestamped, because rotation of the panic log does not make sense.
36944 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36945 the string. In addition, if it immediately follows a slash, a following
36946 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36947 character is removed. Thus, the four examples above would give these panic
36948 log names:
36949 .code
36950 /var/spool/exim/log/paniclog
36951 /var/log/exim-panic.log
36952 /var/spool/exim/log/paniclog
36953 /var/log/exim/panic
36954 .endd
36955
36956
36957 .section "Logging to syslog" "SECID249"
36958 .cindex "log" "syslog; writing to"
36959 The use of syslog does not change what Exim logs or the format of its messages,
36960 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36961 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36962 that, the same strings are written to syslog as to log files. The syslog
36963 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36964 by default, but you can change these by setting the &%syslog_facility%& and
36965 &%syslog_processname%& options, respectively. If Exim was compiled with
36966 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36967 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36968 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36969 the time and host name to each line.
36970 The three log streams are mapped onto syslog priorities as follows:
36971
36972 .ilist
36973 &'mainlog'& is mapped to LOG_INFO
36974 .next
36975 &'rejectlog'& is mapped to LOG_NOTICE
36976 .next
36977 &'paniclog'& is mapped to LOG_ALERT
36978 .endlist
36979
36980 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36981 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36982 these are routed by syslog to the same place. You can suppress this duplication
36983 by setting &%syslog_duplication%& false.
36984
36985 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36986 entries contain multiple lines when headers are included. To cope with both
36987 these cases, entries written to syslog are split into separate &[syslog()]&
36988 calls at each internal newline, and also after a maximum of
36989 870 data characters. (This allows for a total syslog line length of 1024, when
36990 additions such as timestamps are added.) If you are running a syslog
36991 replacement that can handle lines longer than the 1024 characters allowed by
36992 RFC 3164, you should set
36993 .code
36994 SYSLOG_LONG_LINES=yes
36995 .endd
36996 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
36997 lines, but it still splits at internal newlines in &'reject'& log entries.
36998
36999 To make it easy to re-assemble split lines later, each component of a split
37000 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37001 where <&'n'&> is the component number and <&'m'&> is the total number of
37002 components in the entry. The / delimiter is used when the line was split
37003 because it was too long; if it was split because of an internal newline, the \
37004 delimiter is used. For example, supposing the length limit to be 50 instead of
37005 870, the following would be the result of a typical rejection message to
37006 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37007 name, and pid as added by syslog:
37008 .code
37009 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37010 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37011 [3/5]  when scanning for sender: missing or malformed lo
37012 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37013 [5/5] mple>)
37014 .endd
37015 The same error might cause the following lines to be written to &"rejectlog"&
37016 (LOG_NOTICE):
37017 .code
37018 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37019 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37020 [3/18] er when scanning for sender: missing or malformed
37021 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37022 [5\18] .example>)
37023 [6\18] Recipients: ph10@some.domain.cam.example
37024 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37025 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37026 [9\18]        id 16RdAL-0006pc-00
37027 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37028 [11\18] 09:43 +0100
37029 [12\18] F From: <>
37030 [13\18]   Subject: this is a test header
37031 [18\18]   X-something: this is another header
37032 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37033 [16\18] le>
37034 [17\18] B Bcc:
37035 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37036 .endd
37037 Log lines that are neither too long nor contain newlines are written to syslog
37038 without modification.
37039
37040 If only syslog is being used, the Exim monitor is unable to provide a log tail
37041 display, unless syslog is routing &'mainlog'& to a file on the local host and
37042 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37043 where it is.
37044
37045
37046
37047 .section "Log line flags" "SECID250"
37048 One line is written to the main log for each message received, and for each
37049 successful, unsuccessful, and delayed delivery. These lines can readily be
37050 picked out by the distinctive two-character flags that immediately follow the
37051 timestamp. The flags are:
37052 .display
37053 &`<=`&     message arrival
37054 &`(=`&     message fakereject
37055 &`=>`&     normal message delivery
37056 &`->`&     additional address in same delivery
37057 &`>>`&     cutthrough message delivery
37058 &`*>`&     delivery suppressed by &%-N%&
37059 &`**`&     delivery failed; address bounced
37060 &`==`&     delivery deferred; temporary problem
37061 .endd
37062
37063
37064 .section "Logging message reception" "SECID251"
37065 .cindex "log" "reception line"
37066 The format of the single-line entry in the main log that is written for every
37067 message received is shown in the basic example below, which is split over
37068 several lines in order to fit it on the page:
37069 .code
37070 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37071   H=mailer.fict.example [192.168.123.123] U=exim
37072   P=smtp S=5678 id=<incoming message id>
37073 .endd
37074 The address immediately following &"<="& is the envelope sender address. A
37075 bounce message is shown with the sender address &"<>"&, and if it is locally
37076 generated, this is followed by an item of the form
37077 .code
37078 R=<message id>
37079 .endd
37080 which is a reference to the message that caused the bounce to be sent.
37081
37082 .cindex "HELO"
37083 .cindex "EHLO"
37084 For messages from other hosts, the H and U fields identify the remote host and
37085 record the RFC 1413 identity of the user that sent the message, if one was
37086 received. The number given in square brackets is the IP address of the sending
37087 host. If there is a single, unparenthesized  host name in the H field, as
37088 above, it has been verified to correspond to the IP address (see the
37089 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37090 by the remote host in the SMTP HELO or EHLO command, and has not been
37091 verified. If verification yields a different name to that given for HELO or
37092 EHLO, the verified name appears first, followed by the HELO or EHLO
37093 name in parentheses.
37094
37095 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37096 without brackets, in the HELO or EHLO command, leading to entries in
37097 the log containing text like these examples:
37098 .code
37099 H=(10.21.32.43) [192.168.8.34]
37100 H=([10.21.32.43]) [192.168.8.34]
37101 .endd
37102 This can be confusing. Only the final address in square brackets can be relied
37103 on.
37104
37105 For locally generated messages (that is, messages not received over TCP/IP),
37106 the H field is omitted, and the U field contains the login name of the caller
37107 of Exim.
37108
37109 .cindex "authentication" "logging"
37110 .cindex "AUTH" "logging"
37111 For all messages, the P field specifies the protocol used to receive the
37112 message. This is the value that is stored in &$received_protocol$&. In the case
37113 of incoming SMTP messages, the value indicates whether or not any SMTP
37114 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37115 session was encrypted, there is an additional X field that records the cipher
37116 suite that was used.
37117
37118 .cindex log protocol
37119 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37120 hosts that have authenticated themselves using the SMTP AUTH command. The first
37121 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37122 there is an additional item A= followed by the name of the authenticator that
37123 was used. If an authenticated identification was set up by the authenticator's
37124 &%server_set_id%& option, this is logged too, separated by a colon from the
37125 authenticator name.
37126
37127 .cindex "size" "of message"
37128 The id field records the existing message id, if present. The size of the
37129 received message is given by the S field. When the message is delivered,
37130 headers may be removed or added, so that the size of delivered copies of the
37131 message may not correspond with this value (and indeed may be different to each
37132 other).
37133
37134 The &%log_selector%& option can be used to request the logging of additional
37135 data when a message is received. See section &<<SECTlogselector>>& below.
37136
37137
37138
37139 .section "Logging deliveries" "SECID252"
37140 .cindex "log" "delivery line"
37141 The format of the single-line entry in the main log that is written for every
37142 delivery is shown in one of the examples below, for local and remote
37143 deliveries, respectively. Each example has been split into multiple lines in order
37144 to fit it on the page:
37145 .code
37146 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37147   <marv@hitch.fict.example> R=localuser T=local_delivery
37148 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37149   monk@holistic.fict.example R=dnslookup T=remote_smtp
37150   H=holistic.fict.example [192.168.234.234]
37151 .endd
37152 For ordinary local deliveries, the original address is given in angle brackets
37153 after the final delivery address, which might be a pipe or a file. If
37154 intermediate address(es) exist between the original and the final address, the
37155 last of these is given in parentheses after the final address. The R and T
37156 fields record the router and transport that were used to process the address.
37157
37158 If SMTP AUTH was used for the delivery there is an additional item A=
37159 followed by the name of the authenticator that was used.
37160 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37161 option, this is logged too, separated by a colon from the authenticator name.
37162
37163 If a shadow transport was run after a successful local delivery, the log line
37164 for the successful delivery has an item added on the end, of the form
37165 .display
37166 &`ST=<`&&'shadow transport name'&&`>`&
37167 .endd
37168 If the shadow transport did not succeed, the error message is put in
37169 parentheses afterwards.
37170
37171 .cindex "asterisk" "after IP address"
37172 When more than one address is included in a single delivery (for example, two
37173 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37174 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37175 down a single SMTP connection, an asterisk follows the IP address in the log
37176 lines for the second and subsequent messages.
37177 When two or more messages are delivered down a single TLS connection, the
37178 DNS and some TLS-related information logged for the first message delivered
37179 will not be present in the log lines for the second and subsequent messages.
37180 TLS cipher information is still available.
37181
37182 .cindex "delivery" "cutthrough; logging"
37183 .cindex "cutthrough" "logging"
37184 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37185 line precedes the reception line, since cutthrough waits for a possible
37186 rejection from the destination in case it can reject the sourced item.
37187
37188 The generation of a reply message by a filter file gets logged as a
37189 &"delivery"& to the addressee, preceded by &">"&.
37190
37191 The &%log_selector%& option can be used to request the logging of additional
37192 data when a message is delivered. See section &<<SECTlogselector>>& below.
37193
37194
37195 .section "Discarded deliveries" "SECID253"
37196 .cindex "discarded messages"
37197 .cindex "message" "discarded"
37198 .cindex "delivery" "discarded; logging"
37199 When a message is discarded as a result of the command &"seen finish"& being
37200 obeyed in a filter file which generates no deliveries, a log entry of the form
37201 .code
37202 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37203   <low.club@bridge.example> R=userforward
37204 .endd
37205 is written, to record why no deliveries are logged. When a message is discarded
37206 because it is aliased to &":blackhole:"& the log line is like this:
37207 .code
37208 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37209   <hole@nowhere.example> R=blackhole_router
37210 .endd
37211
37212
37213 .section "Deferred deliveries" "SECID254"
37214 When a delivery is deferred, a line of the following form is logged:
37215 .code
37216 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37217   R=dnslookup T=smtp defer (146): Connection refused
37218 .endd
37219 In the case of remote deliveries, the error is the one that was given for the
37220 last IP address that was tried. Details of individual SMTP failures are also
37221 written to the log, so the above line would be preceded by something like
37222 .code
37223 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37224   mail1.endrest.example [192.168.239.239]: Connection refused
37225 .endd
37226 When a deferred address is skipped because its retry time has not been reached,
37227 a message is written to the log, but this can be suppressed by setting an
37228 appropriate value in &%log_selector%&.
37229
37230
37231
37232 .section "Delivery failures" "SECID255"
37233 .cindex "delivery" "failure; logging"
37234 If a delivery fails because an address cannot be routed, a line of the
37235 following form is logged:
37236 .code
37237 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37238   <jim@trek99.example>: unknown mail domain
37239 .endd
37240 If a delivery fails at transport time, the router and transport are shown, and
37241 the response from the remote host is included, as in this example:
37242 .code
37243 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37244   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37245   after pipelined RCPT TO:<ace400@pb.example>: host
37246   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37247   <ace400@pb.example>...Addressee unknown
37248 .endd
37249 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37250 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37251 disabling PIPELINING. The log lines for all forms of delivery failure are
37252 flagged with &`**`&.
37253
37254
37255
37256 .section "Fake deliveries" "SECID256"
37257 .cindex "delivery" "fake; logging"
37258 If a delivery does not actually take place because the &%-N%& option has been
37259 used to suppress it, a normal delivery line is written to the log, except that
37260 &"=>"& is replaced by &"*>"&.
37261
37262
37263
37264 .section "Completion" "SECID257"
37265 A line of the form
37266 .code
37267 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37268 .endd
37269 is written to the main log when a message is about to be removed from the spool
37270 at the end of its processing.
37271
37272
37273
37274
37275 .section "Summary of Fields in Log Lines" "SECID258"
37276 .cindex "log" "summary of fields"
37277 A summary of the field identifiers that are used in log lines is shown in
37278 the following table:
37279 .display
37280 &`A   `&        authenticator name (and optional id and sender)
37281 &`C   `&        SMTP confirmation on delivery
37282 &`    `&        command list for &"no mail in SMTP session"&
37283 &`CV  `&        certificate verification status
37284 &`D   `&        duration of &"no mail in SMTP session"&
37285 &`DKIM`&        domain verified in incoming message
37286 &`DN  `&        distinguished name from peer certificate
37287 &`DS  `&        DNSSEC secured lookups
37288 &`DT  `&        on &`=>`& lines: time taken for a delivery
37289 &`F   `&        sender address (on delivery lines)
37290 &`H   `&        host name and IP address
37291 &`I   `&        local interface used
37292 &`id  `&        message id (from header) for incoming message
37293 &`K   `&        CHUNKING extension used
37294 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37295 &`M8S `&        8BITMIME status for incoming message
37296 &`P   `&        on &`<=`& lines: protocol used
37297 &`    `&        on &`=>`& and &`**`& lines: return path
37298 &`PRDR`&        PRDR extension used
37299 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37300 &`Q   `&        alternate queue name
37301 &`QT  `&        on &`=>`& lines: time spent on queue so far
37302 &`    `&        on &"Completed"& lines: time spent on queue
37303 &`R   `&        on &`<=`& lines: reference for local bounce
37304 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37305 &`RT  `&        on &`<=`& lines: time taken for reception
37306 &`S   `&        size of message in bytes
37307 &`SNI `&        server name indication from TLS client hello
37308 &`ST  `&        shadow transport name
37309 &`T   `&        on &`<=`& lines: message subject (topic)
37310 &`TFO `&        connection took advantage of TCP Fast Open
37311 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37312 &`U   `&        local user or RFC 1413 identity
37313 &`X   `&        TLS cipher suite
37314 .endd
37315
37316
37317 .section "Other log entries" "SECID259"
37318 Various other types of log entry are written from time to time. Most should be
37319 self-explanatory. Among the more common are:
37320
37321 .ilist
37322 .cindex "retry" "time not reached"
37323 &'retry time not reached'&&~&~An address previously suffered a temporary error
37324 during routing or local delivery, and the time to retry has not yet arrived.
37325 This message is not written to an individual message log file unless it happens
37326 during the first delivery attempt.
37327 .next
37328 &'retry time not reached for any host'&&~&~An address previously suffered
37329 temporary errors during remote delivery, and the retry time has not yet arrived
37330 for any of the hosts to which it is routed.
37331 .next
37332 .cindex "spool directory" "file locked"
37333 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37334 some other Exim process is already working on the message. This can be quite
37335 common if queue running processes are started at frequent intervals. The
37336 &'exiwhat'& utility script can be used to find out what Exim processes are
37337 doing.
37338 .next
37339 .cindex "error" "ignored"
37340 &'error ignored'&&~&~There are several circumstances that give rise to this
37341 message:
37342 .olist
37343 Exim failed to deliver a bounce message whose age was greater than
37344 &%ignore_bounce_errors_after%&. The bounce was discarded.
37345 .next
37346 A filter file set up a delivery using the &"noerror"& option, and the delivery
37347 failed. The delivery was discarded.
37348 .next
37349 A delivery set up by a router configured with
37350 . ==== As this is a nested list, any displays it contains must be indented
37351 . ==== as otherwise they are too far to the left.
37352 .code
37353     errors_to = <>
37354 .endd
37355 failed. The delivery was discarded.
37356 .endlist olist
37357 .next
37358 .cindex DKIM "log line"
37359 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37360 logging and the message has a DKIM signature header.
37361 .endlist ilist
37362
37363
37364
37365
37366
37367 .section "Reducing or increasing what is logged" "SECTlogselector"
37368 .cindex "log" "selectors"
37369 By setting the &%log_selector%& global option, you can disable some of Exim's
37370 default logging, or you can request additional logging. The value of
37371 &%log_selector%& is made up of names preceded by plus or minus characters. For
37372 example:
37373 .code
37374 log_selector = +arguments -retry_defer
37375 .endd
37376 The list of optional log items is in the following table, with the default
37377 selection marked by asterisks:
37378 .display
37379 &` 8bitmime                   `&  received 8BITMIME status
37380 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37381 &` address_rewrite            `&  address rewriting
37382 &` all_parents                `&  all parents in => lines
37383 &` arguments                  `&  command line arguments
37384 &`*connection_reject          `&  connection rejections
37385 &`*delay_delivery             `&  immediate delivery delayed
37386 &` deliver_time               `&  time taken to perform delivery
37387 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37388 &`*dkim                       `&  DKIM verified domain on <= lines
37389 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37390 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37391 &` dnssec                     `&  DNSSEC secured lookups
37392 &`*etrn                       `&  ETRN commands
37393 &`*host_lookup_failed         `&  as it says
37394 &` ident_timeout              `&  timeout for ident connection
37395 &` incoming_interface         `&  local interface on <= and => lines
37396 &` incoming_port              `&  remote port on <= lines
37397 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37398 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37399 &`*msg_id                     `&  on <= lines, Message-ID: header value
37400 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37401 &` outgoing_interface         `&  local interface on => lines
37402 &` outgoing_port              `&  add remote port to => lines
37403 &`*queue_run                  `&  start and end queue runs
37404 &` queue_time                 `&  time on queue for one recipient
37405 &` queue_time_overall         `&  time on queue for whole message
37406 &` pid                        `&  Exim process id
37407 &` pipelining                 `&  PIPELINING use, on <= and => lines
37408 &` proxy                      `&  proxy address on <= and => lines
37409 &` receive_time               `&  time taken to receive message
37410 &` received_recipients        `&  recipients on <= lines
37411 &` received_sender            `&  sender on <= lines
37412 &`*rejected_header            `&  header contents on reject log
37413 &`*retry_defer                `&  &"retry time not reached"&
37414 &` return_path_on_delivery    `&  put return path on => and ** lines
37415 &` sender_on_delivery         `&  add sender to => lines
37416 &`*sender_verify_fail         `&  sender verification failures
37417 &`*size_reject                `&  rejection because too big
37418 &`*skip_delivery              `&  delivery skipped in a queue run
37419 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37420 &` smtp_connection            `&  incoming SMTP connections
37421 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37422 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37423 &` smtp_no_mail               `&  session with no MAIL commands
37424 &` smtp_protocol_error        `&  SMTP protocol errors
37425 &` smtp_syntax_error          `&  SMTP syntax errors
37426 &` subject                    `&  contents of &'Subject:'& on <= lines
37427 &`*tls_certificate_verified   `&  certificate verification status
37428 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37429 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37430 &` tls_sni                    `&  TLS SNI on <= lines
37431 &` unknown_in_list            `&  DNS lookup failed in list match
37432
37433 &` all                        `&  all of the above
37434 .endd
37435 See also the &%slow_lookup_log%& main configuration option,
37436 section &<<SECID99>>&
37437
37438 More details on each of these items follows:
37439
37440 .ilist
37441 .cindex "8BITMIME"
37442 .cindex "log" "8BITMIME"
37443 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37444 which may help in tracking down interoperability issues with ancient MTAs
37445 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37446 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37447 &`7BIT`& and &`8BITMIME`& respectively.
37448 .next
37449 .cindex "&%warn%& ACL verb" "log when skipping"
37450 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37451 its conditions cannot be evaluated, a log line to this effect is written if
37452 this log selector is set.
37453 .next
37454 .cindex "log" "rewriting"
37455 .cindex "rewriting" "logging"
37456 &%address_rewrite%&: This applies both to global rewrites and per-transport
37457 rewrites, but not to rewrites in filters run as an unprivileged user (because
37458 such users cannot access the log).
37459 .next
37460 .cindex "log" "full parentage"
37461 &%all_parents%&: Normally only the original and final addresses are logged on
37462 delivery lines; with this selector, intermediate parents are given in
37463 parentheses between them.
37464 .next
37465 .cindex "log" "Exim arguments"
37466 .cindex "Exim arguments, logging"
37467 &%arguments%&: This causes Exim to write the arguments with which it was called
37468 to the main log, preceded by the current working directory. This is a debugging
37469 feature, added to make it easier to find out how certain MUAs call
37470 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37471 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37472 that are empty or that contain white space are quoted. Non-printing characters
37473 are shown as escape sequences. This facility cannot log unrecognized arguments,
37474 because the arguments are checked before the configuration file is read. The
37475 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37476 between the caller and Exim.
37477 .next
37478 .cindex "log" "connection rejections"
37479 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37480 connection is rejected, for whatever reason.
37481 .next
37482 .cindex "log" "delayed delivery"
37483 .cindex "delayed delivery, logging"
37484 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37485 started for an incoming message because the load is too high or too many
37486 messages were received on one connection. Logging does not occur if no delivery
37487 process is started because &%queue_only%& is set or &%-odq%& was used.
37488 .next
37489 .cindex "log" "delivery duration"
37490 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37491 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37492 If millisecond logging is enabled, short times will be shown with greater
37493 precision, eg. &`DT=0.304s`&.
37494 .next
37495 .cindex "log" "message size on delivery"
37496 .cindex "size" "of message"
37497 &%delivery_size%&: For each delivery, the size of message delivered is added to
37498 the &"=>"& line, tagged with S=.
37499 .next
37500 .cindex log "DKIM verification"
37501 .cindex DKIM "verification logging"
37502 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37503 verifies successfully a tag of DKIM is added, with one of the verified domains.
37504 .next
37505 .cindex log "DKIM verification"
37506 .cindex DKIM "verification logging"
37507 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37508 .next
37509 .cindex "log" "dnslist defer"
37510 .cindex "DNS list" "logging defer"
37511 .cindex "black list (DNS)"
37512 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37513 DNS black list suffers a temporary error.
37514 .next
37515 .cindex log dnssec
37516 .cindex dnssec logging
37517 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37518 dns lookups gave secure results a tag of DS is added.
37519 For acceptance this covers the reverse and forward lookups for host name verification.
37520 It does not cover helo-name verification.
37521 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37522 .next
37523 .cindex "log" "ETRN commands"
37524 .cindex "ETRN" "logging"
37525 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37526 is run to determine whether or not it is actually accepted. An invalid ETRN
37527 command, or one received within a message transaction is not logged by this
37528 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37529 .next
37530 .cindex "log" "host lookup failure"
37531 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37532 any addresses, or when a lookup of an IP address fails to find a host name, a
37533 log line is written. This logging does not apply to direct DNS lookups when
37534 routing email addresses, but it does apply to &"byname"& lookups.
37535 .next
37536 .cindex "log" "ident timeout"
37537 .cindex "RFC 1413" "logging timeout"
37538 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37539 client's ident port times out.
37540 .next
37541 .cindex "log" "incoming interface"
37542 .cindex "log" "local interface"
37543 .cindex "log" "local address and port"
37544 .cindex "TCP/IP" "logging local address and port"
37545 .cindex "interface" "logging"
37546 &%incoming_interface%&: The interface on which a message was received is added
37547 to the &"<="& line as an IP address in square brackets, tagged by I= and
37548 followed by a colon and the port number. The local interface and port are also
37549 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37550 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37551 The latter can be disabled by turning off the &%outgoing_interface%& option.
37552 .next
37553 .cindex log "incoming proxy address"
37554 .cindex proxy "logging proxy address"
37555 .cindex "TCP/IP" "logging proxy address"
37556 &%proxy%&: The internal (closest to the system running Exim) IP address
37557 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37558 on a proxied connection
37559 or the &"=>"& line for a message delivered on a proxied connection.
37560 See &<<SECTproxyInbound>>& for more information.
37561 .next
37562 .cindex "log" "incoming remote port"
37563 .cindex "port" "logging remote"
37564 .cindex "TCP/IP" "logging incoming remote port"
37565 .vindex "&$sender_fullhost$&"
37566 .vindex "&$sender_rcvhost$&"
37567 &%incoming_port%&: The remote port number from which a message was received is
37568 added to log entries and &'Received:'& header lines, following the IP address
37569 in square brackets, and separated from it by a colon. This is implemented by
37570 changing the value that is put in the &$sender_fullhost$& and
37571 &$sender_rcvhost$& variables. Recording the remote port number has become more
37572 important with the widening use of NAT (see RFC 2505).
37573 .next
37574 .cindex "log" "dropped connection"
37575 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37576 connection is unexpectedly dropped.
37577 .next
37578 .cindex "log" "millisecond timestamps"
37579 .cindex millisecond logging
37580 .cindex timestamps "millisecond, in logs"
37581 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37582 appended to the seconds value.
37583 .next
37584 .new
37585 .cindex "log" "message id"
37586 &%msg_id%&: The value of the Message-ID: header.
37587 .next
37588 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37589 This will be either because the message is a bounce, or was submitted locally
37590 (submission mode) without one.
37591 The field identifier will have an asterix appended: &"id*="&.
37592 .wen
37593 .next
37594 .cindex "log" "outgoing interface"
37595 .cindex "log" "local interface"
37596 .cindex "log" "local address and port"
37597 .cindex "TCP/IP" "logging local address and port"
37598 .cindex "interface" "logging"
37599 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37600 interface on which a message was sent is added to delivery lines as an I= tag
37601 followed by IP address in square brackets. You can disable this by turning
37602 off the &%outgoing_interface%& option.
37603 .next
37604 .cindex "log" "outgoing remote port"
37605 .cindex "port" "logging outgoing remote"
37606 .cindex "TCP/IP" "logging outgoing remote port"
37607 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37608 containing => tags) following the IP address.
37609 The local port is also added if &%incoming_interface%& and
37610 &%outgoing_interface%& are both enabled.
37611 This option is not included in the default setting, because for most ordinary
37612 configurations, the remote port number is always 25 (the SMTP port), and the
37613 local port is a random ephemeral port.
37614 .next
37615 .cindex "log" "process ids in"
37616 .cindex "pid (process id)" "in log lines"
37617 &%pid%&: The current process id is added to every log line, in square brackets,
37618 immediately after the time and date.
37619 .next
37620 .cindex log pipelining
37621 .cindex pipelining "logging outgoing"
37622 &%pipelining%&: A field is added to delivery and accept
37623 log lines when the ESMTP PIPELINING extension was used.
37624 The field is a single "L".
37625
37626 On accept lines, where PIPELINING was offered but not used by the client,
37627 the field has a minus appended.
37628
37629 .new
37630 .cindex "pipelining" "early connection"
37631 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37632 accept "L" fields have a period appended if the feature was
37633 offered but not used, or an asterisk appended if used.
37634 Delivery "L" fields have an asterisk appended if used.
37635 .wen
37636
37637 .next
37638 .cindex "log" "queue run"
37639 .cindex "queue runner" "logging"
37640 &%queue_run%&: The start and end of every queue run are logged.
37641 .next
37642 .cindex "log" "queue time"
37643 &%queue_time%&: The amount of time the message has been in the queue on the
37644 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37645 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37646 includes reception time as well as the delivery time for the current address.
37647 This means that it may be longer than the difference between the arrival and
37648 delivery log line times, because the arrival log line is not written until the
37649 message has been successfully received.
37650 If millisecond logging is enabled, short times will be shown with greater
37651 precision, eg. &`QT=1.578s`&.
37652 .next
37653 &%queue_time_overall%&: The amount of time the message has been in the queue on
37654 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37655 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37656 message, so it includes reception time as well as the total delivery time.
37657 .next
37658 .cindex "log" "receive duration"
37659 &%receive_time%&: For each message, the amount of real time it has taken to
37660 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37661 If millisecond logging is enabled, short times will be shown with greater
37662 precision, eg. &`RT=0.204s`&.
37663 .next
37664 .cindex "log" "recipients"
37665 &%received_recipients%&: The recipients of a message are listed in the main log
37666 as soon as the message is received. The list appears at the end of the log line
37667 that is written when a message is received, preceded by the word &"for"&. The
37668 addresses are listed after they have been qualified, but before any rewriting
37669 has taken place.
37670 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37671 in the list.
37672 .next
37673 .cindex "log" "sender reception"
37674 &%received_sender%&: The unrewritten original sender of a message is added to
37675 the end of the log line that records the message's arrival, after the word
37676 &"from"& (before the recipients if &%received_recipients%& is also set).
37677 .next
37678 .cindex "log" "header lines for rejection"
37679 &%rejected_header%&: If a message's header has been received at the time a
37680 rejection is written to the reject log, the complete header is added to the
37681 log. Header logging can be turned off individually for messages that are
37682 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37683 .next
37684 .cindex "log" "retry defer"
37685 &%retry_defer%&: A log line is written if a delivery is deferred because a
37686 retry time has not yet been reached. However, this &"retry time not reached"&
37687 message is always omitted from individual message logs after the first delivery
37688 attempt.
37689 .next
37690 .cindex "log" "return path"
37691 &%return_path_on_delivery%&: The return path that is being transmitted with
37692 the message is included in delivery and bounce lines, using the tag P=.
37693 This is omitted if no delivery actually happens, for example, if routing fails,
37694 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37695 .next
37696 .cindex "log" "sender on delivery"
37697 &%sender_on_delivery%&: The message's sender address is added to every delivery
37698 and bounce line, tagged by F= (for &"from"&).
37699 This is the original sender that was received with the message; it is not
37700 necessarily the same as the outgoing return path.
37701 .next
37702 .cindex "log" "sender verify failure"
37703 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37704 gives details of a sender verification failure is not written. Log lines for
37705 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37706 detail is lost.
37707 .next
37708 .cindex "log" "size rejection"
37709 &%size_reject%&: A log line is written whenever a message is rejected because
37710 it is too big.
37711 .next
37712 .cindex "log" "frozen messages; skipped"
37713 .cindex "frozen messages" "logging skipping"
37714 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37715 queue run because it is frozen or because another process is already delivering
37716 it.
37717 .cindex "&""spool file is locked""&"
37718 The message that is written is &"spool file is locked"&.
37719 .next
37720 .cindex "log" "smtp confirmation"
37721 .cindex "SMTP" "logging confirmation"
37722 .cindex "LMTP" "logging confirmation"
37723 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37724 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37725 A number of MTAs (including Exim) return an identifying string in this
37726 response.
37727 .next
37728 .cindex "log" "SMTP connections"
37729 .cindex "SMTP" "logging connections"
37730 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37731 established or closed, unless the connection is from a host that matches
37732 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37733 only when the closure is unexpected.) This applies to connections from local
37734 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37735 dropped in the middle of a message, a log line is always written, whether or
37736 not this selector is set, but otherwise nothing is written at the start and end
37737 of connections unless this selector is enabled.
37738
37739 For TCP/IP connections to an Exim daemon, the current number of connections is
37740 included in the log message for each new connection, but note that the count is
37741 reset if the daemon is restarted.
37742 Also, because connections are closed (and the closure is logged) in
37743 subprocesses, the count may not include connections that have been closed but
37744 whose termination the daemon has not yet noticed. Thus, while it is possible to
37745 match up the opening and closing of connections in the log, the value of the
37746 logged counts may not be entirely accurate.
37747 .next
37748 .cindex "log" "SMTP transaction; incomplete"
37749 .cindex "SMTP" "logging incomplete transactions"
37750 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37751 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37752 and the message sender plus any accepted recipients are included in the log
37753 line. This can provide evidence of dictionary attacks.
37754 .next
37755 .cindex "log" "non-MAIL SMTP sessions"
37756 .cindex "MAIL" "logging session without"
37757 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37758 connection terminates without having issued a MAIL command. This includes both
37759 the case when the connection is dropped, and the case when QUIT is used. It
37760 does not include cases where the connection is rejected right at the start (by
37761 an ACL, or because there are too many connections, or whatever). These cases
37762 already have their own log lines.
37763
37764 The log line that is written contains the identity of the client in the usual
37765 way, followed by D= and a time, which records the duration of the connection.
37766 If the connection was authenticated, this fact is logged exactly as it is for
37767 an incoming message, with an A= item. If the connection was encrypted, CV=,
37768 DN=, and X= items may appear as they do for an incoming message, controlled by
37769 the same logging options.
37770
37771 Finally, if any SMTP commands were issued during the connection, a C= item
37772 is added to the line, listing the commands that were used. For example,
37773 .code
37774 C=EHLO,QUIT
37775 .endd
37776 shows that the client issued QUIT straight after EHLO. If there were fewer
37777 than 20 commands, they are all listed. If there were more than 20 commands,
37778 the last 20 are listed, preceded by &"..."&. However, with the default
37779 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37780 have been aborted before 20 non-mail commands are processed.
37781 .next
37782 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37783 colon-separated, is appended to the A= item for a message arrival or delivery
37784 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37785 was accepted or used.
37786 .next
37787 .cindex "log" "SMTP protocol error"
37788 .cindex "SMTP" "logging protocol error"
37789 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37790 encountered. Exim does not have perfect detection of all protocol errors
37791 because of transmission delays and the use of pipelining. If PIPELINING has
37792 been advertised to a client, an Exim server assumes that the client will use
37793 it, and therefore it does not count &"expected"& errors (for example, RCPT
37794 received after rejecting MAIL) as protocol errors.
37795 .next
37796 .cindex "SMTP" "logging syntax errors"
37797 .cindex "SMTP" "syntax errors; logging"
37798 .cindex "SMTP" "unknown command; logging"
37799 .cindex "log" "unknown SMTP command"
37800 .cindex "log" "SMTP syntax error"
37801 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37802 encountered. An unrecognized command is treated as a syntax error. For an
37803 external connection, the host identity is given; for an internal connection
37804 using &%-bs%& the sender identification (normally the calling user) is given.
37805 .next
37806 .cindex "log" "subject"
37807 .cindex "subject, logging"
37808 &%subject%&: The subject of the message is added to the arrival log line,
37809 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37810 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37811 specifies whether characters with values greater than 127 should be logged
37812 unchanged, or whether they should be rendered as escape sequences.
37813 .next
37814 .cindex "log" "certificate verification"
37815 .cindex log DANE
37816 .cindex DANE logging
37817 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37818 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37819 verified
37820 using a CA trust anchor,
37821 &`CA=dane`& if using a DNS trust anchor,
37822 and &`CV=no`& if not.
37823 .next
37824 .cindex "log" "TLS cipher"
37825 .cindex "TLS" "logging cipher"
37826 &%tls_cipher%&: When a message is sent or received over an encrypted
37827 connection, the cipher suite used is added to the log line, preceded by X=.
37828 .next
37829 .cindex "log" "TLS peer DN"
37830 .cindex "TLS" "logging peer DN"
37831 &%tls_peerdn%&: When a message is sent or received over an encrypted
37832 connection, and a certificate is supplied by the remote host, the peer DN is
37833 added to the log line, preceded by DN=.
37834 .next
37835 .cindex "log" "TLS SNI"
37836 .cindex "TLS" "logging SNI"
37837 &%tls_sni%&: When a message is received over an encrypted connection, and
37838 the remote host provided the Server Name Indication extension, the SNI is
37839 added to the log line, preceded by SNI=.
37840 .next
37841 .cindex "log" "DNS failure in list"
37842 &%unknown_in_list%&: This setting causes a log entry to be written when the
37843 result of a list match is failure because a DNS lookup failed.
37844 .endlist
37845
37846
37847 .section "Message log" "SECID260"
37848 .cindex "message" "log file for"
37849 .cindex "log" "message log; description of"
37850 .cindex "&_msglog_& directory"
37851 .oindex "&%preserve_message_logs%&"
37852 In addition to the general log files, Exim writes a log file for each message
37853 that it handles. The names of these per-message logs are the message ids, and
37854 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37855 message log contains copies of the log lines that apply to the message. This
37856 makes it easier to inspect the status of an individual message without having
37857 to search the main log. A message log is deleted when processing of the message
37858 is complete, unless &%preserve_message_logs%& is set, but this should be used
37859 only with great care because they can fill up your disk very quickly.
37860
37861 On a heavily loaded system, it may be desirable to disable the use of
37862 per-message logs, in order to reduce disk I/O. This can be done by setting the
37863 &%message_logs%& option false.
37864 .ecindex IIDloggen
37865
37866
37867
37868
37869 . ////////////////////////////////////////////////////////////////////////////
37870 . ////////////////////////////////////////////////////////////////////////////
37871
37872 .chapter "Exim utilities" "CHAPutils"
37873 .scindex IIDutils "utilities"
37874 A number of utility scripts and programs are supplied with Exim and are
37875 described in this chapter. There is also the Exim Monitor, which is covered in
37876 the next chapter. The utilities described here are:
37877
37878 .itable none 0 0 3  7* left  15* left  40* left
37879 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37880   "list what Exim processes are doing"
37881 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37882 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37883 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37884 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37885                                                 various criteria"
37886 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37887 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37888   "extract statistics from the log"
37889 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37890   "check address acceptance from given IP"
37891 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37892 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37893 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37894 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37895 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37896 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37897 .endtable
37898
37899 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37900 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37901 &url(https://duncanthrax.net/exilog/) for details.
37902
37903
37904
37905
37906 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37907 .cindex "&'exiwhat'&"
37908 .cindex "process, querying"
37909 .cindex "SIGUSR1"
37910 On operating systems that can restart a system call after receiving a signal
37911 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37912 a line describing what it is doing to the file &_exim-process.info_& in the
37913 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37914 processes it can find, having first emptied the file. It then waits for one
37915 second to allow the Exim processes to react before displaying the results. In
37916 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37917 send the signal to the Exim processes, so it is normally run as root.
37918
37919 &*Warning*&: This is not an efficient process. It is intended for occasional
37920 use by system administrators. It is not sensible, for example, to set up a
37921 script that sends SIGUSR1 signals to Exim processes at short intervals.
37922
37923
37924 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37925 varies in different operating systems. Not only are different options used,
37926 but the format of the output is different. For this reason, there are some
37927 system configuration options that configure exactly how &'exiwhat'& works. If
37928 it doesn't seem to be working for you, check the following compile-time
37929 options:
37930 .display
37931 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37932 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37933 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37934 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37935 .endd
37936 An example of typical output from &'exiwhat'& is
37937 .code
37938 164 daemon: -q1h, listening on port 25
37939 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37940 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37941   [10.19.42.42] (editor@ref.example)
37942 10592 handling incoming call from [192.168.243.242]
37943 10628 accepting a local non-SMTP message
37944 .endd
37945 The first number in the output line is the process number. The third line has
37946 been split here, in order to fit it on the page.
37947
37948
37949
37950 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37951 .cindex "&'exiqgrep'&"
37952 .cindex "queue" "grepping"
37953 This utility is a Perl script contributed by Matt Hubbard. It runs
37954 .code
37955 exim -bpu
37956 .endd
37957 or (in case &*-a*& switch is specified)
37958 .code
37959 exim -bp
37960 .endd
37961 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37962 contain alternate exim configuration the queue management might be using.
37963
37964 to obtain a queue listing, and then greps the output to select messages
37965 that match given criteria. The following selection options are available:
37966
37967 .vlist
37968 .vitem &*-f*&&~<&'regex'&>
37969 Match the sender address using a case-insensitive search. The field that is
37970 tested is enclosed in angle brackets, so you can test for bounce messages with
37971 .code
37972 exiqgrep -f '^<>$'
37973 .endd
37974 .vitem &*-r*&&~<&'regex'&>
37975 Match a recipient address using a case-insensitive search. The field that is
37976 tested is not enclosed in angle brackets.
37977
37978 .vitem &*-s*&&~<&'regex'&>
37979 Match against the size field.
37980
37981 .vitem &*-y*&&~<&'seconds'&>
37982 Match messages that are younger than the given time.
37983
37984 .vitem &*-o*&&~<&'seconds'&>
37985 Match messages that are older than the given time.
37986
37987 .vitem &*-z*&
37988 Match only frozen messages.
37989
37990 .vitem &*-x*&
37991 Match only non-frozen messages.
37992
37993 .new
37994 .vitem &*-G*&&~<&'queuename'&>
37995 Match only messages in the given queue.  Without this, the default queue is searched.
37996 .wen
37997 .endlist
37998
37999 The following options control the format of the output:
38000
38001 .vlist
38002 .vitem &*-c*&
38003 Display only the count of matching messages.
38004
38005 .vitem &*-l*&
38006 Long format &-- display the full message information as output by Exim. This is
38007 the default.
38008
38009 .vitem &*-i*&
38010 Display message ids only.
38011
38012 .vitem &*-b*&
38013 Brief format &-- one line per message.
38014
38015 .vitem &*-R*&
38016 Display messages in reverse order.
38017
38018 .vitem &*-a*&
38019 Include delivered recipients in queue listing.
38020 .endlist
38021
38022 There is one more option, &%-h%&, which outputs a list of options.
38023
38024
38025
38026 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38027 .cindex "&'exiqsumm'&"
38028 .cindex "queue" "summary"
38029 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38030 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38031 running a command such as
38032 .code
38033 exim -bp | exiqsumm
38034 .endd
38035 The output consists of one line for each domain that has messages waiting for
38036 it, as in the following example:
38037 .code
38038 3   2322   74m   66m  msn.com.example
38039 .endd
38040 Each line lists the number of pending deliveries for a domain, their total
38041 volume, and the length of time that the oldest and the newest messages have
38042 been waiting. Note that the number of pending deliveries is greater than the
38043 number of messages when messages have more than one recipient.
38044
38045 A summary line is output at the end. By default the output is sorted on the
38046 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38047 the output to be sorted by oldest message and by count of messages,
38048 respectively. There are also three options that split the messages for each
38049 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38050 separates frozen messages, and &%-s%& separates messages according to their
38051 sender.
38052
38053 The output of &'exim -bp'& contains the original addresses in the message, so
38054 this also applies to the output from &'exiqsumm'&. No domains from addresses
38055 generated by aliasing or forwarding are included (unless the &%one_time%&
38056 option of the &(redirect)& router has been used to convert them into &"top
38057 level"& addresses).
38058
38059
38060
38061
38062 .section "Extracting specific information from the log (exigrep)" &&&
38063          "SECTextspeinf"
38064 .cindex "&'exigrep'&"
38065 .cindex "log" "extracts; grepping for"
38066 The &'exigrep'& utility is a Perl script that searches one or more main log
38067 files for entries that match a given pattern. When it finds a match, it
38068 extracts all the log entries for the relevant message, not just those that
38069 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38070 given message, or all mail for a given user, or for a given host, for example.
38071 The input files can be in Exim log format or syslog format.
38072 If a matching log line is not associated with a specific message, it is
38073 included in &'exigrep'&'s output without any additional lines. The usage is:
38074 .display
38075 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38076 .endd
38077 If no log filenames are given on the command line, the standard input is read.
38078
38079 The &%-t%& argument specifies a number of seconds. It adds an additional
38080 condition for message selection. Messages that are complete are shown only if
38081 they spent more than <&'n'&> seconds in the queue.
38082
38083 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38084 makes it case-sensitive. This may give a performance improvement when searching
38085 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38086 option; with &%-I%& they do not. In both cases it is possible to change the
38087 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38088
38089 The &%-l%& option means &"literal"&, that is, treat all characters in the
38090 pattern as standing for themselves. Otherwise the pattern must be a Perl
38091 regular expression.
38092
38093 The &%-v%& option inverts the matching condition. That is, a line is selected
38094 if it does &'not'& match the pattern.
38095
38096 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38097 that are generated as a result/response to a message that &'exigrep'& matched
38098 normally.
38099
38100 Example of &%-M%&:
38101 user_a sends a message to user_b, which generates a bounce back to user_b. If
38102 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38103 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38104 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38105 when searching for &"user_a"& will show both messages since the bounce is
38106 &"related"& to or a &"result"& of the first message that was found by the
38107 search term.
38108
38109 If the location of a &'zcat'& command is known from the definition of
38110 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38111 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38112 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38113 autodetection of some well known compression extensions.
38114
38115
38116 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38117 .cindex "&'exipick'&"
38118 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38119 lists messages from the queue according to a variety of criteria. For details
38120 of &'exipick'&'s facilities, run &'exipick'& with
38121 the &%--help%& option.
38122
38123
38124 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38125 .cindex "log" "cycling local files"
38126 .cindex "cycling logs"
38127 .cindex "&'exicyclog'&"
38128 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38129 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38130 you are using log files with datestamps in their names (see section
38131 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38132 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38133 There are two command line options for &'exicyclog'&:
38134 .ilist
38135 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38136 default that is set when Exim is built. The default default is 10.
38137 .next
38138 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38139 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38140 overriding the script's default, which is to find the setting from Exim's
38141 configuration.
38142 .endlist
38143
38144 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38145 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38146 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38147 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38148 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38149 logs are handled similarly.
38150
38151 If the limit is greater than 99, the script uses 3-digit numbers such as
38152 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38153 to one that is greater, or &'vice versa'&, you will have to fix the names of
38154 any existing log files.
38155
38156 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38157 the end are deleted. All files with numbers greater than 01 are compressed,
38158 using a compression command which is configured by the COMPRESS_COMMAND
38159 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38160 root &%crontab%& entry of the form
38161 .code
38162 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38163 .endd
38164 assuming you have used the name &"exim"& for the Exim user. You can run
38165 &'exicyclog'& as root if you wish, but there is no need.
38166
38167
38168
38169 .section "Mail statistics (eximstats)" "SECTmailstat"
38170 .cindex "statistics"
38171 .cindex "&'eximstats'&"
38172 A Perl script called &'eximstats'& is provided for extracting statistical
38173 information from log files. The output is either plain text, or HTML.
38174 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38175 . --- 404 error and everything else points to that.
38176
38177 The &'eximstats'& script has been hacked about quite a bit over time. The
38178 latest version is the result of some extensive revision by Steve Campbell. A
38179 lot of information is given by default, but there are options for suppressing
38180 various parts of it. Following any options, the arguments to the script are a
38181 list of files, which should be main log files. For example:
38182 .code
38183 eximstats -nr /var/spool/exim/log/mainlog.01
38184 .endd
38185 By default, &'eximstats'& extracts information about the number and volume of
38186 messages received from or delivered to various hosts. The information is sorted
38187 both by message count and by volume, and the top fifty hosts in each category
38188 are listed on the standard output. Similar information, based on email
38189 addresses or domains instead of hosts can be requested by means of various
38190 options. For messages delivered and received locally, similar statistics are
38191 also produced per user.
38192
38193 The output also includes total counts and statistics about delivery errors, and
38194 histograms showing the number of messages received and deliveries made in each
38195 hour of the day. A delivery with more than one address in its envelope (for
38196 example, an SMTP transaction with more than one RCPT command) is counted
38197 as a single delivery by &'eximstats'&.
38198
38199 Though normally more deliveries than receipts are reported (as messages may
38200 have multiple recipients), it is possible for &'eximstats'& to report more
38201 messages received than delivered, even though the queue is empty at the start
38202 and end of the period in question. If an incoming message contains no valid
38203 recipients, no deliveries are recorded for it. A bounce message is handled as
38204 an entirely separate message.
38205
38206 &'eximstats'& always outputs a grand total summary giving the volume and number
38207 of messages received and deliveries made, and the number of hosts involved in
38208 each case. It also outputs the number of messages that were delayed (that is,
38209 not completely delivered at the first attempt), and the number that had at
38210 least one address that failed.
38211
38212 The remainder of the output is in sections that can be independently disabled
38213 or modified by various options. It consists of a summary of deliveries by
38214 transport, histograms of messages received and delivered per time interval
38215 (default per hour), information about the time messages spent in the queue,
38216 a list of relayed messages, lists of the top fifty sending hosts, local
38217 senders, destination hosts, and destination local users by count and by volume,
38218 and a list of delivery errors that occurred.
38219
38220 The relay information lists messages that were actually relayed, that is, they
38221 came from a remote host and were directly delivered to some other remote host,
38222 without being processed (for example, for aliasing or forwarding) locally.
38223
38224 There are quite a few options for &'eximstats'& to control exactly what it
38225 outputs. These are documented in the Perl script itself, and can be extracted
38226 by running the command &(perldoc)& on the script. For example:
38227 .code
38228 perldoc /usr/exim/bin/eximstats
38229 .endd
38230
38231 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38232 .cindex "&'exim_checkaccess'&"
38233 .cindex "policy control" "checking access"
38234 .cindex "checking access"
38235 The &%-bh%& command line argument allows you to run a fake SMTP session with
38236 debugging output, in order to check what Exim is doing when it is applying
38237 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38238 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38239 sometimes you just want to answer the question &"Does this address have
38240 access?"& without bothering with any further details.
38241
38242 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38243 two arguments, an IP address and an email address:
38244 .code
38245 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38246 .endd
38247 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38248 given email address would be accepted in a RCPT command in a TCP/IP
38249 connection from the host with the given IP address. The output of the utility
38250 is either the word &"accepted"&, or the SMTP error response, for example:
38251 .code
38252 Rejected:
38253 550 Relay not permitted
38254 .endd
38255 When running this test, the utility uses &`<>`& as the envelope sender address
38256 for the MAIL command, but you can change this by providing additional
38257 options. These are passed directly to the Exim command. For example, to specify
38258 that the test is to be run with the sender address &'himself@there.example'&
38259 you can use:
38260 .code
38261 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38262                  -f himself@there.example
38263 .endd
38264 Note that these additional Exim command line items must be given after the two
38265 mandatory arguments.
38266
38267 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38268 while running its checks. You can run checks that include callouts by using
38269 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38270
38271
38272
38273 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38274 .cindex "DBM" "building dbm files"
38275 .cindex "building DBM files"
38276 .cindex "&'exim_dbmbuild'&"
38277 .cindex "lower casing"
38278 .cindex "binary zero" "in lookup key"
38279 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38280 the format used by the &(lsearch)& lookup (see section
38281 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38282 names as keys and the remainder of the information as data. The lower-casing
38283 can be prevented by calling the program with the &%-nolc%& option.
38284
38285 A terminating zero is included as part of the key string. This is expected by
38286 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38287 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38288 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38289 files.
38290
38291 The program requires two arguments: the name of the input file (which can be a
38292 single hyphen to indicate the standard input), and the name of the output file.
38293 It creates the output under a temporary name, and then renames it if all went
38294 well.
38295
38296 .cindex "USE_DB"
38297 If the native DB interface is in use (USE_DB is set in a compile-time
38298 configuration file &-- this is common in free versions of Unix) the two
38299 filenames must be different, because in this mode the Berkeley DB functions
38300 create a single output file using exactly the name given. For example,
38301 .code
38302 exim_dbmbuild /etc/aliases /etc/aliases.db
38303 .endd
38304 reads the system alias file and creates a DBM version of it in
38305 &_/etc/aliases.db_&.
38306
38307 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38308 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38309 environment, the suffixes are added to the second argument of
38310 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38311 when the Berkeley functions are used in compatibility mode (though this is not
38312 recommended), because in that case it adds a &_.db_& suffix to the filename.
38313
38314 If a duplicate key is encountered, the program outputs a warning, and when it
38315 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38316 option is used. By default, only the first of a set of duplicates is used &--
38317 this makes it compatible with &(lsearch)& lookups. There is an option
38318 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38319 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38320 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38321 return code is 2.
38322
38323
38324
38325
38326 .section "Finding individual retry times (exinext)" "SECTfinindret"
38327 .cindex "retry" "times"
38328 .cindex "&'exinext'&"
38329 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38330 fish specific information out of the retry database. Given a mail domain (or a
38331 complete address), it looks up the hosts for that domain, and outputs any retry
38332 information for the hosts or for the domain. At present, the retry information
38333 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38334 output. For example:
38335 .code
38336 $ exinext piglet@milne.fict.example
38337 kanga.milne.example:192.168.8.1 error 146: Connection refused
38338   first failed: 21-Feb-1996 14:57:34
38339   last tried:   21-Feb-1996 14:57:34
38340   next try at:  21-Feb-1996 15:02:34
38341 roo.milne.example:192.168.8.3 error 146: Connection refused
38342   first failed: 20-Jan-1996 13:12:08
38343   last tried:   21-Feb-1996 11:42:03
38344   next try at:  21-Feb-1996 19:42:03
38345   past final cutoff time
38346 .endd
38347 You can also give &'exinext'& a local part, without a domain, and it
38348 will give any retry information for that local part in your default domain.
38349 A message id can be used to obtain retry information pertaining to a specific
38350 message. This exists only when an attempt to deliver a message to a remote host
38351 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38352 &'exinext'& is not particularly efficient, but then it is not expected to be
38353 run very often.
38354
38355 The &'exinext'& utility calls Exim to find out information such as the location
38356 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38357 passed on to the &'exim'& commands. The first specifies an alternate Exim
38358 configuration file, and the second sets macros for use within the configuration
38359 file. These features are mainly to help in testing, but might also be useful in
38360 environments where more than one configuration file is in use.
38361
38362
38363
38364 .section "Hints database maintenance" "SECThindatmai"
38365 .cindex "hints database" "maintenance"
38366 .cindex "maintaining Exim's hints database"
38367 Three utility programs are provided for maintaining the DBM files that Exim
38368 uses to contain its delivery hint information. Each program requires two
38369 arguments. The first specifies the name of Exim's spool directory, and the
38370 second is the name of the database it is to operate on. These are as follows:
38371
38372 .ilist
38373 &'retry'&: the database of retry information
38374 .next
38375 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38376 for remote hosts
38377 .next
38378 &'callout'&: the callout cache
38379 .next
38380 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38381 .next
38382 &'misc'&: other hints data
38383 .endlist
38384
38385 The &'misc'& database is used for
38386
38387 .ilist
38388 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38389 .next
38390 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38391 &(smtp)& transport)
38392 .next
38393 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38394 in a transport)
38395 .endlist
38396
38397
38398
38399 .section "exim_dumpdb" "SECID261"
38400 .cindex "&'exim_dumpdb'&"
38401 The entire contents of a database are written to the standard output by the
38402 &'exim_dumpdb'& program, which has no options or arguments other than the
38403 spool and database names. For example, to dump the retry database:
38404 .code
38405 exim_dumpdb /var/spool/exim retry
38406 .endd
38407 Two lines of output are produced for each entry:
38408 .code
38409 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38410 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38411 .endd
38412 The first item on the first line is the key of the record. It starts with one
38413 of the letters R, or T, depending on whether it refers to a routing or
38414 transport retry. For a local delivery, the next part is the local address; for
38415 a remote delivery it is the name of the remote host, followed by its failing IP
38416 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38417 transport). If the remote port is not the standard one (port 25), it is added
38418 to the IP address. Then there follows an error code, an additional error code,
38419 and a textual description of the error.
38420
38421 The three times on the second line are the time of first failure, the time of
38422 the last delivery attempt, and the computed time for the next attempt. The line
38423 ends with an asterisk if the cutoff time for the last retry rule has been
38424 exceeded.
38425
38426 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38427 consists of a host name followed by a list of ids for messages that are or were
38428 waiting to be delivered to that host. If there are a very large number for any
38429 one host, continuation records, with a sequence number added to the host name,
38430 may be seen. The data in these records is often out of date, because a message
38431 may be routed to several alternative hosts, and Exim makes no effort to keep
38432 cross-references.
38433
38434
38435
38436 .section "exim_tidydb" "SECID262"
38437 .cindex "&'exim_tidydb'&"
38438 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38439 database. If run with no options, it removes all records that are more than 30
38440 days old. The age is calculated from the date and time that the record was last
38441 updated. Note that, in the case of the retry database, it is &'not'& the time
38442 since the first delivery failure. Information about a host that has been down
38443 for more than 30 days will remain in the database, provided that the record is
38444 updated sufficiently often.
38445
38446 The cutoff date can be altered by means of the &%-t%& option, which must be
38447 followed by a time. For example, to remove all records older than a week from
38448 the retry database:
38449 .code
38450 exim_tidydb -t 7d /var/spool/exim retry
38451 .endd
38452 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38453 message ids. In the former these appear as data in records keyed by host &--
38454 they were messages that were waiting for that host &-- and in the latter they
38455 are the keys for retry information for messages that have suffered certain
38456 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38457 message ids in database records are those of messages that are still on the
38458 queue. Message ids for messages that no longer exist are removed from
38459 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38460 For the &'retry'& database, records whose keys are non-existent message ids are
38461 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38462 whenever it removes information from the database.
38463
38464 Certain records are automatically removed by Exim when they are no longer
38465 needed, but others are not. For example, if all the MX hosts for a domain are
38466 down, a retry record is created for each one. If the primary MX host comes back
38467 first, its record is removed when Exim successfully delivers to it, but the
38468 records for the others remain because Exim has not tried to use those hosts.
38469
38470 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38471 hints databases. You should do this at a quiet time of day, because it requires
38472 a database to be locked (and therefore inaccessible to Exim) while it does its
38473 work. Removing records from a DBM file does not normally make the file smaller,
38474 but all the common DBM libraries are able to re-use the space that is released.
38475 After an initial phase of increasing in size, the databases normally reach a
38476 point at which they no longer get any bigger, as long as they are regularly
38477 tidied.
38478
38479 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38480 databases is likely to keep on increasing.
38481
38482
38483
38484
38485 .section "exim_fixdb" "SECID263"
38486 .cindex "&'exim_fixdb'&"
38487 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38488 Its main use is for testing Exim, but it might also be occasionally useful for
38489 getting round problems in a live system. It has no options, and its interface
38490 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38491 key of a database record can then be entered, and the data for that record is
38492 displayed.
38493
38494 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38495 except the &'retry'& database, that is the only operation that can be carried
38496 out. For the &'retry'& database, each field is output preceded by a number, and
38497 data for individual fields can be changed by typing the field number followed
38498 by new data, for example:
38499 .code
38500 > 4 951102:1000
38501 .endd
38502 resets the time of the next delivery attempt. Time values are given as a
38503 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38504 used as optional separators.
38505
38506
38507
38508
38509 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38510 .cindex "mailbox" "maintenance"
38511 .cindex "&'exim_lock'&"
38512 .cindex "locking mailboxes"
38513 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38514 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38515 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38516 a user agent while investigating a problem. The utility requires the name of
38517 the file as its first argument. If the locking is successful, the second
38518 argument is run as a command (using C's &[system()]& function); if there is no
38519 second argument, the value of the SHELL environment variable is used; if this
38520 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38521 is unlocked and the utility ends. The following options are available:
38522
38523 .vlist
38524 .vitem &%-fcntl%&
38525 Use &[fcntl()]& locking on the open mailbox.
38526
38527 .vitem &%-flock%&
38528 Use &[flock()]& locking on the open mailbox, provided the operating system
38529 supports it.
38530
38531 .vitem &%-interval%&
38532 This must be followed by a number, which is a number of seconds; it sets the
38533 interval to sleep between retries (default 3).
38534
38535 .vitem &%-lockfile%&
38536 Create a lock file before opening the mailbox.
38537
38538 .vitem &%-mbx%&
38539 Lock the mailbox using MBX rules.
38540
38541 .vitem &%-q%&
38542 Suppress verification output.
38543
38544 .vitem &%-retries%&
38545 This must be followed by a number; it sets the number of times to try to get
38546 the lock (default 10).
38547
38548 .vitem &%-restore_time%&
38549 This option causes &%exim_lock%& to restore the modified and read times to the
38550 locked file before exiting. This allows you to access a locked mailbox (for
38551 example, to take a backup copy) without disturbing the times that the user
38552 subsequently sees.
38553
38554 .vitem &%-timeout%&
38555 This must be followed by a number, which is a number of seconds; it sets a
38556 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38557 default), a non-blocking call is used.
38558
38559 .vitem &%-v%&
38560 Generate verbose output.
38561 .endlist
38562
38563 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38564 default is to create a lock file and also to use &[fcntl()]& locking on the
38565 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38566 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38567 requires that the directory containing the file be writeable. Locking by lock
38568 file does not last forever; Exim assumes that a lock file is expired if it is
38569 more than 30 minutes old.
38570
38571 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38572 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38573 to be taken out on the open mailbox, and an exclusive lock on the file
38574 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38575 number of the mailbox file. When the locking is released, if an exclusive lock
38576 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38577
38578 The default output contains verification of the locking that takes place. The
38579 &%-v%& option causes some additional information to be given. The &%-q%& option
38580 suppresses all output except error messages.
38581
38582 A command such as
38583 .code
38584 exim_lock /var/spool/mail/spqr
38585 .endd
38586 runs an interactive shell while the file is locked, whereas
38587 .display
38588 &`exim_lock -q /var/spool/mail/spqr <<End`&
38589 <&'some commands'&>
38590 &`End`&
38591 .endd
38592 runs a specific non-interactive sequence of commands while the file is locked,
38593 suppressing all verification output. A single command can be run by a command
38594 such as
38595 .code
38596 exim_lock -q /var/spool/mail/spqr \
38597   "cp /var/spool/mail/spqr /some/where"
38598 .endd
38599 Note that if a command is supplied, it must be entirely contained within the
38600 second argument &-- hence the quotes.
38601 .ecindex IIDutils
38602
38603
38604 . ////////////////////////////////////////////////////////////////////////////
38605 . ////////////////////////////////////////////////////////////////////////////
38606
38607 .chapter "The Exim monitor" "CHAPeximon"
38608 .scindex IIDeximon "Exim monitor" "description"
38609 .cindex "X-windows"
38610 .cindex "&'eximon'&"
38611 .cindex "Local/eximon.conf"
38612 .cindex "&_exim_monitor/EDITME_&"
38613 The Exim monitor is an application which displays in an X window information
38614 about the state of Exim's queue and what Exim is doing. An admin user can
38615 perform certain operations on messages from this GUI interface; however all
38616 such facilities are also available from the command line, and indeed, the
38617 monitor itself makes use of the command line to perform any actions requested.
38618
38619
38620
38621 .section "Running the monitor" "SECID264"
38622 The monitor is started by running the script called &'eximon'&. This is a shell
38623 script that sets up a number of environment variables, and then runs the
38624 binary called &_eximon.bin_&. The default appearance of the monitor window can
38625 be changed by editing the &_Local/eximon.conf_& file created by editing
38626 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38627 parameters are for.
38628
38629 The parameters that get built into the &'eximon'& script can be overridden for
38630 a particular invocation by setting up environment variables of the same names,
38631 preceded by &`EXIMON_`&. For example, a shell command such as
38632 .code
38633 EXIMON_LOG_DEPTH=400 eximon
38634 .endd
38635 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38636 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38637 overrides the Exim log file configuration. This makes it possible to have
38638 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38639 syslog messages are routed to a file on the local host.
38640
38641 X resources can be used to change the appearance of the window in the normal
38642 way. For example, a resource setting of the form
38643 .code
38644 Eximon*background: gray94
38645 .endd
38646 changes the colour of the background to light grey rather than white. The
38647 stripcharts are drawn with both the data lines and the reference lines in
38648 black. This means that the reference lines are not visible when on top of the
38649 data. However, their colour can be changed by setting a resource called
38650 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38651 For example, if your X server is running Unix, you could set up lighter
38652 reference lines in the stripcharts by obeying
38653 .code
38654 xrdb -merge <<End
38655 Eximon*highlight: gray
38656 End
38657 .endd
38658 .cindex "admin user"
38659 In order to see the contents of messages in the queue, and to operate on them,
38660 &'eximon'& must either be run as root or by an admin user.
38661
38662 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38663 contain X11 resource parameters interpreted by the X11 library.  In addition,
38664 if the first parameter starts with the string "gdb" then it is removed and the
38665 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38666 versioned variants of gdb can be invoked).
38667
38668 The monitor's window is divided into three parts. The first contains one or
38669 more stripcharts and two action buttons, the second contains a &"tail"& of the
38670 main log file, and the third is a display of the queue of messages awaiting
38671 delivery, with two more action buttons. The following sections describe these
38672 different parts of the display.
38673
38674
38675
38676
38677 .section "The stripcharts" "SECID265"
38678 .cindex "stripchart"
38679 The first stripchart is always a count of messages in the queue. Its name can
38680 be configured by setting QUEUE_STRIPCHART_NAME in the
38681 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38682 configuration script by regular expression matches on log file entries, making
38683 it possible to display, for example, counts of messages delivered to certain
38684 hosts or using certain transports. The supplied defaults display counts of
38685 received and delivered messages, and of local and SMTP deliveries. The default
38686 period between stripchart updates is one minute; this can be adjusted by a
38687 parameter in the &_Local/eximon.conf_& file.
38688
38689 The stripchart displays rescale themselves automatically as the value they are
38690 displaying changes. There are always 10 horizontal lines in each chart; the
38691 title string indicates the value of each division when it is greater than one.
38692 For example, &"x2"& means that each division represents a value of 2.
38693
38694 It is also possible to have a stripchart which shows the percentage fullness of
38695 a particular disk partition, which is useful when local deliveries are confined
38696 to a single partition.
38697
38698 .cindex "&%statvfs%& function"
38699 This relies on the availability of the &[statvfs()]& function or equivalent in
38700 the operating system. Most, but not all versions of Unix that support Exim have
38701 this. For this particular stripchart, the top of the chart always represents
38702 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38703 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38704 &_Local/eximon.conf_& file.
38705
38706
38707
38708
38709 .section "Main action buttons" "SECID266"
38710 .cindex "size" "of monitor window"
38711 .cindex "Exim monitor" "window size"
38712 .cindex "window size"
38713 Below the stripcharts there is an action button for quitting the monitor. Next
38714 to this is another button marked &"Size"&. They are placed here so that
38715 shrinking the window to its default minimum size leaves just the queue count
38716 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38717 the window to expand to its maximum size, unless it is already at the maximum,
38718 in which case it is reduced to its minimum.
38719
38720 When expanding to the maximum, if the window cannot be fully seen where it
38721 currently is, it is moved back to where it was the last time it was at full
38722 size. When it is expanding from its minimum size, the old position is
38723 remembered, and next time it is reduced to the minimum it is moved back there.
38724
38725 The idea is that you can keep a reduced window just showing one or two
38726 stripcharts at a convenient place on your screen, easily expand it to show
38727 the full window when required, and just as easily put it back to what it was.
38728 The idea is copied from what the &'twm'& window manager does for its
38729 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38730 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38731
38732 Normally, the monitor starts up with the window at its full size, but it can be
38733 built so that it starts up with the window at its smallest size, by setting
38734 START_SMALL=yes in &_Local/eximon.conf_&.
38735
38736
38737
38738 .section "The log display" "SECID267"
38739 .cindex "log" "tail of; in monitor"
38740 The second section of the window is an area in which a display of the tail of
38741 the main log is maintained.
38742 To save space on the screen, the timestamp on each log line is shortened by
38743 removing the date and, if &%log_timezone%& is set, the timezone.
38744 The log tail is not available when the only destination for logging data is
38745 syslog, unless the syslog lines are routed to a local file whose name is passed
38746 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38747
38748 The log sub-window has a scroll bar at its lefthand side which can be used to
38749 move back to look at earlier text, and the up and down arrow keys also have a
38750 scrolling effect. The amount of log that is kept depends on the setting of
38751 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38752 to use. When this is full, the earlier 50% of data is discarded &-- this is
38753 much more efficient than throwing it away line by line. The sub-window also has
38754 a horizontal scroll bar for accessing the ends of long log lines. This is the
38755 only means of horizontal scrolling; the right and left arrow keys are not
38756 available. Text can be cut from this part of the window using the mouse in the
38757 normal way. The size of this subwindow is controlled by parameters in the
38758 configuration file &_Local/eximon.conf_&.
38759
38760 Searches of the text in the log window can be carried out by means of the ^R
38761 and ^S keystrokes, which default to a reverse and a forward search,
38762 respectively. The search covers only the text that is displayed in the window.
38763 It cannot go further back up the log.
38764
38765 The point from which the search starts is indicated by a caret marker. This is
38766 normally at the end of the text in the window, but can be positioned explicitly
38767 by pointing and clicking with the left mouse button, and is moved automatically
38768 by a successful search. If new text arrives in the window when it is scrolled
38769 back, the caret remains where it is, but if the window is not scrolled back,
38770 the caret is moved to the end of the new text.
38771
38772 Pressing ^R or ^S pops up a window into which the search text can be typed.
38773 There are buttons for selecting forward or reverse searching, for carrying out
38774 the search, and for cancelling. If the &"Search"& button is pressed, the search
38775 happens and the window remains so that further searches can be done. If the
38776 &"Return"& key is pressed, a single search is done and the window is closed. If
38777 ^C is typed the search is cancelled.
38778
38779 The searching facility is implemented using the facilities of the Athena text
38780 widget. By default this pops up a window containing both &"search"& and
38781 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38782 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38783 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38784 provided version of &%TextPop%& when the remaining parts of the text widget
38785 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38786 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38787 on these systems, at the expense of having unwanted items in the search popup
38788 window.
38789
38790
38791
38792 .section "The queue display" "SECID268"
38793 .cindex "queue" "display in monitor"
38794 The bottom section of the monitor window contains a list of all messages that
38795 are in the queue, which includes those currently being received or delivered,
38796 as well as those awaiting delivery. The size of this subwindow is controlled by
38797 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38798 at which it is updated is controlled by another parameter in the same file &--
38799 the default is 5 minutes, since queue scans can be quite expensive. However,
38800 there is an &"Update"& action button just above the display which can be used
38801 to force an update of the queue display at any time.
38802
38803 When a host is down for some time, a lot of pending mail can build up for it,
38804 and this can make it hard to deal with other messages in the queue. To help
38805 with this situation there is a button next to &"Update"& called &"Hide"&. If
38806 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38807 type anything in here and press &"Return"&, the text is added to a chain of
38808 such texts, and if every undelivered address in a message matches at least one
38809 of the texts, the message is not displayed.
38810
38811 If there is an address that does not match any of the texts, all the addresses
38812 are displayed as normal. The matching happens on the ends of addresses so, for
38813 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38814 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38815 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38816 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38817 a hide request is automatically cancelled after one hour.
38818
38819 While the dialogue box is displayed, you can't press any buttons or do anything
38820 else to the monitor window. For this reason, if you want to cut text from the
38821 queue display to use in the dialogue box, you have to do the cutting before
38822 pressing the &"Hide"& button.
38823
38824 The queue display contains, for each unhidden queued message, the length of
38825 time it has been in the queue, the size of the message, the message id, the
38826 message sender, and the first undelivered recipient, all on one line. If it is
38827 a bounce message, the sender is shown as &"<>"&. If there is more than one
38828 recipient to which the message has not yet been delivered, subsequent ones are
38829 listed on additional lines, up to a maximum configured number, following which
38830 an ellipsis is displayed. Recipients that have already received the message are
38831 not shown.
38832
38833 .cindex "frozen messages" "display"
38834 If a message is frozen, an asterisk is displayed at the left-hand side.
38835
38836 The queue display has a vertical scroll bar, and can also be scrolled by means
38837 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38838 The text searching facilities, as described above for the log window, are also
38839 available, but the caret is always moved to the end of the text when the queue
38840 display is updated.
38841
38842
38843
38844 .section "The queue menu" "SECID269"
38845 .cindex "queue" "menu in monitor"
38846 If the &%shift%& key is held down and the left button is clicked when the mouse
38847 pointer is over the text for any message, an action menu pops up, and the first
38848 line of the queue display for the message is highlighted. This does not affect
38849 any selected text.
38850
38851 If you want to use some other event for popping up the menu, you can set the
38852 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38853 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38854 value set in this parameter is a standard X event description. For example, to
38855 run eximon using &%ctrl%& rather than &%shift%& you could use
38856 .code
38857 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38858 .endd
38859 The title of the menu is the message id, and it contains entries which act as
38860 follows:
38861
38862 .ilist
38863 &'message log'&: The contents of the message log for the message are displayed
38864 in a new text window.
38865 .next
38866 &'headers'&: Information from the spool file that contains the envelope
38867 information and headers is displayed in a new text window. See chapter
38868 &<<CHAPspool>>& for a description of the format of spool files.
38869 .next
38870 &'body'&: The contents of the spool file containing the body of the message are
38871 displayed in a new text window. There is a default limit of 20,000 bytes to the
38872 amount of data displayed. This can be changed by setting the BODY_MAX
38873 option at compile time, or the EXIMON_BODY_MAX option at runtime.
38874 .next
38875 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38876 delivery of the message. This causes an automatic thaw if the message is
38877 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38878 a new text window. The delivery is run in a separate process, to avoid holding
38879 up the monitor while the delivery proceeds.
38880 .next
38881 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38882 that the message be frozen.
38883 .next
38884 .cindex "thawing messages"
38885 .cindex "unfreezing messages"
38886 .cindex "frozen messages" "thawing"
38887 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38888 that the message be thawed.
38889 .next
38890 .cindex "delivery" "forcing failure"
38891 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38892 that Exim gives up trying to deliver the message. A bounce message is generated
38893 for any remaining undelivered addresses.
38894 .next
38895 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38896 that the message be deleted from the system without generating a bounce
38897 message.
38898 .next
38899 &'add recipient'&: A dialog box is displayed into which a recipient address can
38900 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38901 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38902 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38903 causes a call to Exim to be made using the &%-Mar%& option to request that an
38904 additional recipient be added to the message, unless the entry box is empty, in
38905 which case no action is taken.
38906 .next
38907 &'mark delivered'&: A dialog box is displayed into which a recipient address
38908 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38909 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38910 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38911 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38912 recipient address as already delivered, unless the entry box is empty, in which
38913 case no action is taken.
38914 .next
38915 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38916 mark all recipient addresses as already delivered.
38917 .next
38918 &'edit sender'&: A dialog box is displayed initialized with the current
38919 sender's address. Pressing RETURN causes a call to Exim to be made using the
38920 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38921 in which case no action is taken. If you want to set an empty sender (as in
38922 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38923 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38924 the address is qualified with that domain.
38925 .endlist
38926
38927 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38928 other cases when a call to Exim is made, if there is any output from Exim (in
38929 particular, if the command fails) a window containing the command and the
38930 output is displayed. Otherwise, the results of the action are normally apparent
38931 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38932 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38933 if no output is generated.
38934
38935 The queue display is automatically updated for actions such as freezing and
38936 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38937 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38938 force an update of the display after one of these actions.
38939
38940 In any text window that is displayed as result of a menu action, the normal
38941 cut-and-paste facility is available, and searching can be carried out using ^R
38942 and ^S, as described above for the log tail window.
38943 .ecindex IIDeximon
38944
38945
38946
38947
38948
38949 . ////////////////////////////////////////////////////////////////////////////
38950 . ////////////////////////////////////////////////////////////////////////////
38951
38952 .chapter "Security considerations" "CHAPsecurity"
38953 .scindex IIDsecurcon "security" "discussion of"
38954 This chapter discusses a number of issues concerned with security, some of
38955 which are also covered in other parts of this manual.
38956
38957 For reasons that this author does not understand, some people have promoted
38958 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38959 existence of this chapter in the documentation. However, the intent of the
38960 chapter is simply to describe the way Exim works in relation to certain
38961 security concerns, not to make any specific claims about the effectiveness of
38962 its security as compared with other MTAs.
38963
38964 What follows is a description of the way Exim is supposed to be. Best efforts
38965 have been made to try to ensure that the code agrees with the theory, but an
38966 absence of bugs can never be guaranteed. Any that are reported will get fixed
38967 as soon as possible.
38968
38969
38970 .section "Building a more &""hardened""& Exim" "SECID286"
38971 .cindex "security" "build-time features"
38972 There are a number of build-time options that can be set in &_Local/Makefile_&
38973 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38974 Exim administrator who does not have the root password, or by someone who has
38975 penetrated the Exim (but not the root) account. These options are as follows:
38976
38977 .ilist
38978 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38979 start of any filenames used with the &%-C%& option. When it is set, these
38980 filenames are also not allowed to contain the sequence &"/../"&. (However, if
38981 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38982 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38983 default setting for &%ALT_CONFIG_PREFIX%&.
38984
38985 If the permitted configuration files are confined to a directory to
38986 which only root has access, this guards against someone who has broken
38987 into the Exim account from running a privileged Exim with an arbitrary
38988 configuration file, and using it to break into other accounts.
38989 .next
38990
38991 If a non-trusted configuration file (i.e. not the default configuration file
38992 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
38993 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
38994 the next item), then root privilege is retained only if the caller of Exim is
38995 root. This locks out the possibility of testing a configuration using &%-C%&
38996 right through message reception and delivery, even if the caller is root. The
38997 reception works, but by that time, Exim is running as the Exim user, so when
38998 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
38999 privilege to be lost. However, root can test reception and delivery using two
39000 separate commands.
39001
39002 .next
39003 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39004 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39005 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39006 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39007 the restrictive side.  Requiring build-time selection of safe macros is onerous
39008 but this option is intended solely as a transition mechanism to permit
39009 previously-working configurations to continue to work after release 4.73.
39010 .next
39011 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39012 is disabled.
39013 .next
39014 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39015 never to be used for any deliveries. This is like the &%never_users%& runtime
39016 option, but it cannot be overridden; the runtime option adds additional users
39017 to the list. The default setting is &"root"&; this prevents a non-root user who
39018 is permitted to modify the runtime file from using Exim as a way to get root.
39019 .endlist
39020
39021
39022
39023 .section "Root privilege" "SECID270"
39024 .cindex "setuid"
39025 .cindex "root privilege"
39026 The Exim binary is normally setuid to root, which means that it gains root
39027 privilege (runs as root) when it starts execution. In some special cases (for
39028 example, when the daemon is not in use and there are no local deliveries), it
39029 may be possible to run Exim setuid to some user other than root. This is
39030 discussed in the next section. However, in most installations, root privilege
39031 is required for two things:
39032
39033 .ilist
39034 To set up a socket connected to the standard SMTP port (25) when initialising
39035 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39036 not required.
39037 .next
39038 To be able to change uid and gid in order to read users' &_.forward_& files and
39039 perform local deliveries as the receiving user or as specified in the
39040 configuration.
39041 .endlist
39042
39043 It is not necessary to be root to do any of the other things Exim does, such as
39044 receiving messages and delivering them externally over SMTP, and it is
39045 obviously more secure if Exim does not run as root except when necessary.
39046 For this reason, a user and group for Exim to use must be defined in
39047 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39048 group"&. Their values can be changed by the runtime configuration, though this
39049 is not recommended. Often a user called &'exim'& is used, but some sites use
39050 &'mail'& or another user name altogether.
39051
39052 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39053 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39054 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39055
39056 After a new Exim process has interpreted its command line options, it changes
39057 uid and gid in the following cases:
39058
39059 .ilist
39060 .oindex "&%-C%&"
39061 .oindex "&%-D%&"
39062 If the &%-C%& option is used to specify an alternate configuration file, or if
39063 the &%-D%& option is used to define macro values for the configuration, and the
39064 calling process is not running as root, the uid and gid are changed to those of
39065 the calling process.
39066 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39067 option may not be used at all.
39068 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39069 can be supplied if the calling process is running as root, the Exim run-time
39070 user or CONFIGURE_OWNER, if defined.
39071 .next
39072 .oindex "&%-be%&"
39073 .oindex "&%-bf%&"
39074 .oindex "&%-bF%&"
39075 If the expansion test option (&%-be%&) or one of the filter testing options
39076 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39077 calling process.
39078 .next
39079 If the process is not a daemon process or a queue runner process or a delivery
39080 process or a process for testing address routing (started with &%-bt%&), the
39081 uid and gid are changed to the Exim user and group. This means that Exim always
39082 runs under its own uid and gid when receiving messages. This also applies when
39083 testing address verification
39084 .oindex "&%-bv%&"
39085 .oindex "&%-bh%&"
39086 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39087 option).
39088 .next
39089 For a daemon, queue runner, delivery, or address testing process, the uid
39090 remains as root at this stage, but the gid is changed to the Exim group.
39091 .endlist
39092
39093 The processes that initially retain root privilege behave as follows:
39094
39095 .ilist
39096 A daemon process changes the gid to the Exim group and the uid to the Exim
39097 user after setting up one or more listening sockets. The &[initgroups()]&
39098 function is called, so that if the Exim user is in any additional groups, they
39099 will be used during message reception.
39100 .next
39101 A queue runner process retains root privilege throughout its execution. Its
39102 job is to fork a controlled sequence of delivery processes.
39103 .next
39104 A delivery process retains root privilege throughout most of its execution,
39105 but any actual deliveries (that is, the transports themselves) are run in
39106 subprocesses which always change to a non-root uid and gid. For local
39107 deliveries this is typically the uid and gid of the owner of the mailbox; for
39108 remote deliveries, the Exim uid and gid are used. Once all the delivery
39109 subprocesses have been run, a delivery process changes to the Exim uid and gid
39110 while doing post-delivery tidying up such as updating the retry database and
39111 generating bounce and warning messages.
39112
39113 While the recipient addresses in a message are being routed, the delivery
39114 process runs as root. However, if a user's filter file has to be processed,
39115 this is done in a subprocess that runs under the individual user's uid and
39116 gid. A system filter is run as root unless &%system_filter_user%& is set.
39117 .next
39118 A process that is testing addresses (the &%-bt%& option) runs as root so that
39119 the routing is done in the same environment as a message delivery.
39120 .endlist
39121
39122
39123
39124
39125 .section "Running Exim without privilege" "SECTrunexiwitpri"
39126 .cindex "privilege, running without"
39127 .cindex "unprivileged running"
39128 .cindex "root privilege" "running without"
39129 Some installations like to run Exim in an unprivileged state for more of its
39130 operation, for added security. Support for this mode of operation is provided
39131 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39132 gid are changed to the Exim user and group at the start of a delivery process
39133 (and also queue runner and address testing processes). This means that address
39134 routing is no longer run as root, and the deliveries themselves cannot change
39135 to any other uid.
39136
39137 .cindex SIGHUP
39138 .cindex "daemon" "restarting"
39139 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39140 that the daemon can still be started in the usual way, and it can respond
39141 correctly to SIGHUP because the re-invocation regains root privilege.
39142
39143 An alternative approach is to make Exim setuid to the Exim user and also setgid
39144 to the Exim group. If you do this, the daemon must be started from a root
39145 process. (Calling Exim from a root process makes it behave in the way it does
39146 when it is setuid root.) However, the daemon cannot restart itself after a
39147 SIGHUP signal because it cannot regain privilege.
39148
39149 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39150 stops Exim from trying to re-invoke itself to do a delivery after a message has
39151 been received. Such a re-invocation is a waste of resources because it has no
39152 effect.
39153
39154 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39155 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39156 to the Exim user seems a clean approach, but there is one complication:
39157
39158 In this style of operation, Exim is running with the real uid and gid set to
39159 those of the calling process, and the effective uid/gid set to Exim's values.
39160 Ideally, any association with the calling process' uid/gid should be dropped,
39161 that is, the real uid/gid should be reset to the effective values so as to
39162 discard any privileges that the caller may have. While some operating systems
39163 have a function that permits this action for a non-root effective uid, quite a
39164 number of them do not. Because of this lack of standardization, Exim does not
39165 address this problem at this time.
39166
39167 For this reason, the recommended approach for &"mostly unprivileged"& running
39168 is to keep the Exim binary setuid to root, and to set
39169 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39170 be used in the most straightforward way.
39171
39172 If you configure Exim not to run delivery processes as root, there are a
39173 number of restrictions on what you can do:
39174
39175 .ilist
39176 You can deliver only as the Exim user/group. You should  explicitly use the
39177 &%user%& and &%group%& options to override routers or local transports that
39178 normally deliver as the recipient. This makes sure that configurations that
39179 work in this mode function the same way in normal mode. Any implicit or
39180 explicit specification of another user causes an error.
39181 .next
39182 Use of &_.forward_& files is severely restricted, such that it is usually
39183 not worthwhile to include them in the configuration.
39184 .next
39185 Users who wish to use &_.forward_& would have to make their home directory and
39186 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39187 and their equivalents in Exim filters, cannot be used. While they could be
39188 enabled in the Exim user's name, that would be insecure and not very useful.
39189 .next
39190 Unless the local user mailboxes are all owned by the Exim user (possible in
39191 some POP3 or IMAP-only environments):
39192
39193 .olist
39194 They must be owned by the Exim group and be writeable by that group. This
39195 implies you must set &%mode%& in the appendfile configuration, as well as the
39196 mode of the mailbox files themselves.
39197 .next
39198 You must set &%no_check_owner%&, since most or all of the files will not be
39199 owned by the Exim user.
39200 .next
39201 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39202 on a newly created mailbox when unprivileged. This also implies that new
39203 mailboxes need to be created manually.
39204 .endlist olist
39205 .endlist ilist
39206
39207
39208 These restrictions severely restrict what can be done in local deliveries.
39209 However, there are no restrictions on remote deliveries. If you are running a
39210 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39211 gives more security at essentially no cost.
39212
39213 If you are using the &%mua_wrapper%& facility (see chapter
39214 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39215
39216
39217
39218
39219 .section "Delivering to local files" "SECID271"
39220 Full details of the checks applied by &(appendfile)& before it writes to a file
39221 are given in chapter &<<CHAPappendfile>>&.
39222
39223
39224
39225 .section "Running local commands" "SECTsecconslocalcmds"
39226 .cindex "security" "local commands"
39227 .cindex "security" "command injection attacks"
39228 There are a number of ways in which an administrator can configure Exim to run
39229 commands based upon received, untrustworthy, data. Further, in some
39230 configurations a user who can control a &_.forward_& file can also arrange to
39231 run commands. Configuration to check includes, but is not limited to:
39232
39233 .ilist
39234 Use of &%use_shell%& in the pipe transport: various forms of shell command
39235 injection may be possible with this option present. It is dangerous and should
39236 be used only with considerable caution. Consider constraints which whitelist
39237 allowed characters in a variable which is to be used in a pipe transport that
39238 has &%use_shell%& enabled.
39239 .next
39240 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39241 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39242 &_.forward_& files in a redirect router. If Exim is running on a central mail
39243 hub to which ordinary users do not have shell access, but home directories are
39244 NFS mounted (for instance) then administrators should review the list of these
39245 forbid options available, and should bear in mind that the options that may
39246 need forbidding can change as new features are added between releases.
39247 .next
39248 The &%${run...}%& expansion item does not use a shell by default, but
39249 administrators can configure use of &_/bin/sh_& as part of the command.
39250 Such invocations should be viewed with prejudicial suspicion.
39251 .next
39252 Administrators who use embedded Perl are advised to explore how Perl's
39253 taint checking might apply to their usage.
39254 .next
39255 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39256 administrators are well advised to view its use with suspicion, in case (for
39257 instance) it allows a local-part to contain embedded Exim directives.
39258 .next
39259 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39260 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39261 each can reference arbitrary lists and files, rather than just being a list
39262 of opaque strings.
39263 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39264 real-world security vulnerabilities caused by its use with untrustworthy data
39265 injected in, for SQL injection attacks.
39266 Consider the use of the &%inlisti%& expansion condition instead.
39267 .endlist
39268
39269
39270
39271
39272 .section "Trust in configuration data" "SECTsecconfdata"
39273 .cindex "security" "data sources"
39274 .cindex "security" "regular expressions"
39275 .cindex "regular expressions" "security"
39276 .cindex "PCRE" "security"
39277 If configuration data for Exim can come from untrustworthy sources, there
39278 are some issues to be aware of:
39279
39280 .ilist
39281 Use of &%${expand...}%& may provide a path for shell injection attacks.
39282 .next
39283 Letting untrusted data provide a regular expression is unwise.
39284 .next
39285 Using &%${match...}%& to apply a fixed regular expression against untrusted
39286 data may result in pathological behaviour within PCRE.  Be aware of what
39287 "backtracking" means and consider options for being more strict with a regular
39288 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39289 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39290 possessive quantifiers or just not using regular expressions against untrusted
39291 data.
39292 .next
39293 It can be important to correctly use &%${quote:...}%&,
39294 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39295 items to ensure that data is correctly constructed.
39296 .next
39297 Some lookups might return multiple results, even though normal usage is only
39298 expected to yield one result.
39299 .endlist
39300
39301
39302
39303
39304 .section "IPv4 source routing" "SECID272"
39305 .cindex "source routing" "in IP packets"
39306 .cindex "IP source routing"
39307 Many operating systems suppress IP source-routed packets in the kernel, but
39308 some cannot be made to do this, so Exim does its own check. It logs incoming
39309 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39310 IPv6. No special checking is currently done.
39311
39312
39313
39314 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39315 Support for these SMTP commands is disabled by default. If required, they can
39316 be enabled by defining suitable ACLs.
39317
39318
39319
39320
39321 .section "Privileged users" "SECID274"
39322 .cindex "trusted users"
39323 .cindex "admin user"
39324 .cindex "privileged user"
39325 .cindex "user" "trusted"
39326 .cindex "user" "admin"
39327 Exim recognizes two sets of users with special privileges. Trusted users are
39328 able to submit new messages to Exim locally, but supply their own sender
39329 addresses and information about a sending host. For other users submitting
39330 local messages, Exim sets up the sender address from the uid, and doesn't
39331 permit a remote host to be specified.
39332
39333 .oindex "&%-f%&"
39334 However, an untrusted user is permitted to use the &%-f%& command line option
39335 in the special form &%-f <>%& to indicate that a delivery failure for the
39336 message should not cause an error report. This affects the message's envelope,
39337 but it does not affect the &'Sender:'& header. Untrusted users may also be
39338 permitted to use specific forms of address with the &%-f%& option by setting
39339 the &%untrusted_set_sender%& option.
39340
39341 Trusted users are used to run processes that receive mail messages from some
39342 other mail domain and pass them on to Exim for delivery either locally, or over
39343 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39344 as any user listed in the &%trusted_users%& configuration option, or under any
39345 group listed in the &%trusted_groups%& option.
39346
39347 Admin users are permitted to do things to the messages on Exim's queue. They
39348 can freeze or thaw messages, cause them to be returned to their senders, remove
39349 them entirely, or modify them in various ways. In addition, admin users can run
39350 the Exim monitor and see all the information it is capable of providing, which
39351 includes the contents of files on the spool.
39352
39353 .oindex "&%-M%&"
39354 .oindex "&%-q%&"
39355 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39356 delivery of messages on its queue is restricted to admin users. This
39357 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39358 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39359 queue is also restricted to admin users. This restriction can be relaxed by
39360 setting &%no_queue_list_requires_admin%&.
39361
39362 Exim recognizes an admin user if the calling process is running as root or as
39363 the Exim user or if any of the groups associated with the calling process is
39364 the Exim group. It is not necessary actually to be running under the Exim
39365 group. However, if admin users who are not root or the Exim user are to access
39366 the contents of files on the spool via the Exim monitor (which runs
39367 unprivileged), Exim must be built to allow group read access to its spool
39368 files.
39369
39370 By default, regular users are trusted to perform basic testing and
39371 introspection commands, as themselves.  This setting can be tightened by
39372 setting the &%commandline_checks_require_admin%& option.
39373 This affects most of the checking options,
39374 such as &%-be%& and anything else &%-b*%&.
39375
39376
39377 .section "Spool files" "SECID275"
39378 .cindex "spool directory" "files"
39379 Exim's spool directory and everything it contains is owned by the Exim user and
39380 set to the Exim group. The mode for spool files is defined in the
39381 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39382 any user who is a member of the Exim group can access these files.
39383
39384
39385
39386 .section "Use of argv[0]" "SECID276"
39387 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39388 of specific strings, Exim assumes certain options. For example, calling Exim
39389 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39390 to calling it with the option &%-bS%&. There are no security implications in
39391 this.
39392
39393
39394
39395 .section "Use of %f formatting" "SECID277"
39396 The only use made of &"%f"& by Exim is in formatting load average values. These
39397 are actually stored in integer variables as 1000 times the load average.
39398 Consequently, their range is limited and so therefore is the length of the
39399 converted output.
39400
39401
39402
39403 .section "Embedded Exim path" "SECID278"
39404 Exim uses its own path name, which is embedded in the code, only when it needs
39405 to re-exec in order to regain root privilege. Therefore, it is not root when it
39406 does so. If some bug allowed the path to get overwritten, it would lead to an
39407 arbitrary program's being run as exim, not as root.
39408
39409
39410
39411 .section "Dynamic module directory" "SECTdynmoddir"
39412 Any dynamically loadable modules must be installed into the directory
39413 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39414 loading it.
39415
39416
39417 .section "Use of sprintf()" "SECID279"
39418 .cindex "&[sprintf()]&"
39419 A large number of occurrences of &"sprintf"& in the code are actually calls to
39420 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39421 The intermediate formatting is done into a large fixed buffer by a function
39422 that runs through the format string itself, and checks the length of each
39423 conversion before performing it, thus preventing buffer overruns.
39424
39425 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39426 the output buffer is known to be sufficiently long to contain the converted
39427 string.
39428
39429
39430
39431 .section "Use of debug_printf() and log_write()" "SECID280"
39432 Arbitrary strings are passed to both these functions, but they do their
39433 formatting by calling the function &'string_vformat()'&, which runs through
39434 the format string itself, and checks the length of each conversion.
39435
39436
39437
39438 .section "Use of strcat() and strcpy()" "SECID281"
39439 These are used only in cases where the output buffer is known to be large
39440 enough to hold the result.
39441 .ecindex IIDsecurcon
39442
39443
39444
39445
39446 . ////////////////////////////////////////////////////////////////////////////
39447 . ////////////////////////////////////////////////////////////////////////////
39448
39449 .chapter "Format of spool files" "CHAPspool"
39450 .scindex IIDforspo1 "format" "spool files"
39451 .scindex IIDforspo2 "spool directory" "format of files"
39452 .scindex IIDforspo3 "spool files" "format of"
39453 .cindex "spool files" "editing"
39454 A message on Exim's queue consists of two files, whose names are the message id
39455 followed by -D and -H, respectively. The data portion of the message is kept in
39456 the -D file on its own. The message's envelope, status, and headers are all
39457 kept in the -H file, whose format is described in this chapter. Each of these
39458 two files contains the final component of its own name as its first line. This
39459 is insurance against disk crashes where the directory is lost but the files
39460 themselves are recoverable.
39461
39462 The file formats may be changed, or new formats added, at any release.
39463 Spool files are not intended as an interface to other programs
39464 and should not be used as such.
39465
39466 Some people are tempted into editing -D files in order to modify messages. You
39467 need to be extremely careful if you do this; it is not recommended and you are
39468 on your own if you do it. Here are some of the pitfalls:
39469
39470 .ilist
39471 You must ensure that Exim does not try to deliver the message while you are
39472 fiddling with it. The safest way is to take out a write lock on the -D file,
39473 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39474 place, the lock will be retained. If you write a new file and rename it, the
39475 lock will be lost at the instant of rename.
39476 .next
39477 .vindex "&$body_linecount$&"
39478 If you change the number of lines in the file, the value of
39479 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39480 cause incomplete transmission of messages or undeliverable messages.
39481 .next
39482 If the message is in MIME format, you must take care not to break it.
39483 .next
39484 If the message is cryptographically signed, any change will invalidate the
39485 signature.
39486 .endlist
39487 All in all, modifying -D files is fraught with danger.
39488
39489 Files whose names end with -J may also be seen in the &_input_& directory (or
39490 its subdirectories when &%split_spool_directory%& is set). These are journal
39491 files, used to record addresses to which the message has been delivered during
39492 the course of a delivery attempt. If there are still undelivered recipients at
39493 the end, the -H file is updated, and the -J file is deleted. If, however, there
39494 is some kind of crash (for example, a power outage) before this happens, the -J
39495 file remains in existence. When Exim next processes the message, it notices the
39496 -J file and uses it to update the -H file before starting the next delivery
39497 attempt.
39498
39499 Files whose names end with -K or .eml may also be seen in the spool.
39500 These are temporaries used for DKIM or malware processing, when that is used.
39501 They should be tidied up by normal operations; any old ones are probably
39502 relics of crashes and can be removed.
39503
39504 .section "Format of the -H file" "SECID282"
39505 .cindex "uid (user id)" "in spool file"
39506 .cindex "gid (group id)" "in spool file"
39507 The second line of the -H file contains the login name for the uid of the
39508 process that called Exim to read the message, followed by the numerical uid and
39509 gid. For a locally generated message, this is normally the user who sent the
39510 message. For a message received over TCP/IP via the daemon, it is
39511 normally the Exim user.
39512
39513 The third line of the file contains the address of the message's sender as
39514 transmitted in the envelope, contained in angle brackets. The sender address is
39515 empty for bounce messages. For incoming SMTP mail, the sender address is given
39516 in the MAIL command. For locally generated mail, the sender address is
39517 created by Exim from the login name of the current user and the configured
39518 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39519 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39520 &"<>"& or an address that matches &%untrusted_set_senders%&.
39521
39522 The fourth line contains two numbers. The first is the time that the message
39523 was received, in the conventional Unix form &-- the number of seconds since the
39524 start of the epoch. The second number is a count of the number of messages
39525 warning of delayed delivery that have been sent to the sender.
39526
39527 There follow a number of lines starting with a hyphen. These can appear in any
39528 order, and are omitted when not relevant:
39529
39530 .vlist
39531 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39532 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39533 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39534 recognized, to provide backward compatibility. In the old format, a line of
39535 this form is present for every ACL variable that is not empty. The number
39536 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39537 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39538 the data string for the variable. The string itself starts at the beginning of
39539 the next line, and is followed by a newline character. It may contain internal
39540 newlines.
39541
39542 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39543 A line of this form is present for every ACL connection variable that is
39544 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39545 The length is the length of the data string for the variable. The string itself
39546 starts at the beginning of the next line, and is followed by a newline
39547 character. It may contain internal newlines.
39548
39549 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39550 A line of this form is present for every ACL message variable that is defined.
39551 Note that there is a space between &%-aclm%& and the rest of the name. The
39552 length is the length of the data string for the variable. The string itself
39553 starts at the beginning of the next line, and is followed by a newline
39554 character. It may contain internal newlines.
39555
39556 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39557 This is present if, when the message was received over SMTP, the value of
39558 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39559
39560 .vitem &%-allow_unqualified_recipient%&
39561 This is present if unqualified recipient addresses are permitted in header
39562 lines (to stop such addresses from being qualified if rewriting occurs at
39563 transport time). Local messages that were input using &%-bnq%& and remote
39564 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39565
39566 .vitem &%-allow_unqualified_sender%&
39567 This is present if unqualified sender addresses are permitted in header lines
39568 (to stop such addresses from being qualified if rewriting occurs at transport
39569 time). Local messages that were input using &%-bnq%& and remote messages from
39570 hosts that match &%sender_unqualified_hosts%& set this flag.
39571
39572 .vitem "&%-auth_id%&&~<&'text'&>"
39573 The id information for a message received on an authenticated SMTP connection
39574 &-- the value of the &$authenticated_id$& variable.
39575
39576 .vitem "&%-auth_sender%&&~<&'address'&>"
39577 The address of an authenticated sender &-- the value of the
39578 &$authenticated_sender$& variable.
39579
39580 .vitem "&%-body_linecount%&&~<&'number'&>"
39581 This records the number of lines in the body of the message, and is
39582 present unless &%-spool_file_wireformat%& is.
39583
39584 .vitem "&%-body_zerocount%&&~<&'number'&>"
39585 This records the number of binary zero bytes in the body of the message, and is
39586 present if the number is greater than zero.
39587
39588 .vitem &%-deliver_firsttime%&
39589 This is written when a new message is first added to the spool. When the spool
39590 file is updated after a deferral, it is omitted.
39591
39592 .vitem "&%-frozen%&&~<&'time'&>"
39593 .cindex "frozen messages" "spool data"
39594 The message is frozen, and the freezing happened at <&'time'&>.
39595
39596 .vitem "&%-helo_name%&&~<&'text'&>"
39597 This records the host name as specified by a remote host in a HELO or EHLO
39598 command.
39599
39600 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39601 This records the IP address of the host from which the message was received and
39602 the remote port number that was used. It is omitted for locally generated
39603 messages.
39604
39605 .vitem "&%-host_auth%&&~<&'text'&>"
39606 If the message was received on an authenticated SMTP connection, this records
39607 the name of the authenticator &-- the value of the
39608 &$sender_host_authenticated$& variable.
39609
39610 .vitem &%-host_lookup_failed%&
39611 This is present if an attempt to look up the sending host's name from its IP
39612 address failed. It corresponds to the &$host_lookup_failed$& variable.
39613
39614 .vitem "&%-host_name%&&~<&'text'&>"
39615 .cindex "reverse DNS lookup"
39616 .cindex "DNS" "reverse lookup"
39617 This records the name of the remote host from which the message was received,
39618 if the host name was looked up from the IP address when the message was being
39619 received. It is not present if no reverse lookup was done.
39620
39621 .vitem "&%-ident%&&~<&'text'&>"
39622 For locally submitted messages, this records the login of the originating user,
39623 unless it was a trusted user and the &%-oMt%& option was used to specify an
39624 ident value. For messages received over TCP/IP, this records the ident string
39625 supplied by the remote host, if any.
39626
39627 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39628 This records the IP address of the local interface and the port number through
39629 which a message was received from a remote host. It is omitted for locally
39630 generated messages.
39631
39632 .vitem &%-local%&
39633 The message is from a local sender.
39634
39635 .vitem &%-localerror%&
39636 The message is a locally-generated bounce message.
39637
39638 .vitem "&%-local_scan%&&~<&'string'&>"
39639 This records the data string that was returned by the &[local_scan()]& function
39640 when the message was received &-- the value of the &$local_scan_data$&
39641 variable. It is omitted if no data was returned.
39642
39643 .vitem &%-manual_thaw%&
39644 The message was frozen but has been thawed manually, that is, by an explicit
39645 Exim command rather than via the auto-thaw process.
39646
39647 .vitem &%-N%&
39648 A testing delivery process was started using the &%-N%& option to suppress any
39649 actual deliveries, but delivery was deferred. At any further delivery attempts,
39650 &%-N%& is assumed.
39651
39652 .vitem &%-received_protocol%&
39653 This records the value of the &$received_protocol$& variable, which contains
39654 the name of the protocol by which the message was received.
39655
39656 .vitem &%-sender_set_untrusted%&
39657 The envelope sender of this message was set by an untrusted local caller (used
39658 to ensure that the caller is displayed in queue listings).
39659
39660 .vitem "&%-spam_score_int%&&~<&'number'&>"
39661 If a message was scanned by SpamAssassin, this is present. It records the value
39662 of &$spam_score_int$&.
39663
39664 .vitem &%-spool_file_wireformat%&
39665 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39666 rather than Unix-format.
39667 The line-ending is CRLF rather than newline.
39668 There is still, however, no leading-dot-stuffing.
39669
39670 .vitem &%-tls_certificate_verified%&
39671 A TLS certificate was received from the client that sent this message, and the
39672 certificate was verified by the server.
39673
39674 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39675 When the message was received over an encrypted connection, this records the
39676 name of the cipher suite that was used.
39677
39678 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39679 When the message was received over an encrypted connection, and a certificate
39680 was received from the client, this records the Distinguished Name from that
39681 certificate.
39682 .endlist
39683
39684 .new
39685 Any of the above may have an extra hyphen prepended, to indicate the the
39686 corresponding data is untrusted.
39687 .wen
39688
39689 Following the options there is a list of those addresses to which the message
39690 is not to be delivered. This set of addresses is initialized from the command
39691 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39692 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39693 the address is added to this set. The addresses are kept internally as a
39694 balanced binary tree, and it is a representation of that tree which is written
39695 to the spool file. If an address is expanded via an alias or forward file, the
39696 original address is added to the tree when deliveries to all its child
39697 addresses are complete.
39698
39699 If the tree is empty, there is a single line in the spool file containing just
39700 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39701 Y or N, followed by an address. The address is the value for the node of the
39702 tree, and the letters indicate whether the node has a left branch and/or a
39703 right branch attached to it, respectively. If branches exist, they immediately
39704 follow. Here is an example of a three-node tree:
39705 .code
39706 YY darcy@austen.fict.example
39707 NN alice@wonderland.fict.example
39708 NN editor@thesaurus.ref.example
39709 .endd
39710 After the non-recipients tree, there is a list of the message's recipients.
39711 This is a simple list, preceded by a count. It includes all the original
39712 recipients of the message, including those to whom the message has already been
39713 delivered. In the simplest case, the list contains one address per line. For
39714 example:
39715 .code
39716 4
39717 editor@thesaurus.ref.example
39718 darcy@austen.fict.example
39719 rdo@foundation
39720 alice@wonderland.fict.example
39721 .endd
39722 However, when a child address has been added to the top-level addresses as a
39723 result of the use of the &%one_time%& option on a &(redirect)& router, each
39724 line is of the following form:
39725 .display
39726 <&'top-level address'&> <&'errors_to address'&> &&&
39727   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39728 .endd
39729 The 01 flag bit indicates the presence of the three other fields that follow
39730 the top-level address. Other bits may be used in future to support additional
39731 fields. The <&'parent number'&> is the offset in the recipients list of the
39732 original parent of the &"one time"& address. The first two fields are the
39733 envelope sender that is associated with this address and its length. If the
39734 length is zero, there is no special envelope sender (there are then two space
39735 characters in the line). A non-empty field can arise from a &(redirect)& router
39736 that has an &%errors_to%& setting.
39737
39738
39739 A blank line separates the envelope and status information from the headers
39740 which follow. A header may occupy several lines of the file, and to save effort
39741 when reading it in, each header is preceded by a number and an identifying
39742 character. The number is the number of characters in the header, including any
39743 embedded newlines and the terminating newline. The character is one of the
39744 following:
39745
39746 .table2 50pt
39747 .row <&'blank'&>         "header in which Exim has no special interest"
39748 .row &`B`&               "&'Bcc:'& header"
39749 .row &`C`&               "&'Cc:'& header"
39750 .row &`F`&               "&'From:'& header"
39751 .row &`I`&               "&'Message-id:'& header"
39752 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39753 .row &`R`&               "&'Reply-To:'& header"
39754 .row &`S`&               "&'Sender:'& header"
39755 .row &`T`&               "&'To:'& header"
39756 .row &`*`&               "replaced or deleted header"
39757 .endtable
39758
39759 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39760 purposes. They are not transmitted when the message is delivered. Here is a
39761 typical set of headers:
39762 .code
39763 111P Received: by hobbit.fict.example with local (Exim 4.00)
39764 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39765 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39766 038* X-rewrote-sender: bb@hobbit.fict.example
39767 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39768 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39769 099* To: alice@wonderland.fict.example, rdo@foundation,
39770 darcy@austen.fict.example, editor@thesaurus.ref.example
39771 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39772 darcy@austen.fict.example, editor@thesaurus.ref.example
39773 038  Date: Fri, 11 May 2001 10:28:59 +0100
39774 .endd
39775 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39776 &'To:'& header have been rewritten, the last one because routing expanded the
39777 unqualified domain &'foundation'&.
39778 .ecindex IIDforspo1
39779 .ecindex IIDforspo2
39780 .ecindex IIDforspo3
39781
39782 .section "Format of the -D file" "SECID282a"
39783 The data file is traditionally in Unix-standard format: lines are ended with
39784 an ASCII newline character.
39785 However, when the &%spool_wireformat%& main option is used some -D files
39786 can have an alternate format.
39787 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39788 The -D file lines (not including the first name-component line) are
39789 suitable for direct copying to the wire when transmitting using the
39790 ESMTP CHUNKING option, meaning lower processing overhead.
39791 Lines are terminated with an ASCII CRLF pair.
39792 There is no dot-stuffing (and no dot-termination).
39793
39794 . ////////////////////////////////////////////////////////////////////////////
39795 . ////////////////////////////////////////////////////////////////////////////
39796
39797 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
39798          "DKIM, SPF and DMARC Support"
39799
39800 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39801 .cindex "DKIM"
39802
39803 DKIM is a mechanism by which messages sent by some entity can be provably
39804 linked to a domain which that entity controls.  It permits reputation to
39805 be tracked on a per-domain basis, rather than merely upon source IP address.
39806 DKIM is documented in RFC 6376.
39807
39808 As DKIM relies on the message being unchanged in transit, messages handled
39809 by a mailing-list (which traditionally adds to the message) will not match
39810 any original DKIM signature.
39811
39812 DKIM support is compiled into Exim by default if TLS support is present.
39813 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39814
39815 Exim's DKIM implementation allows for
39816 .olist
39817 Signing outgoing messages: This function is implemented in the SMTP transport.
39818 It can co-exist with all other Exim features
39819 (including transport filters)
39820 except cutthrough delivery.
39821 .next
39822 Verifying signatures in incoming messages: This is implemented by an additional
39823 ACL (acl_smtp_dkim), which can be called several times per message, with
39824 different signature contexts.
39825 .endlist
39826
39827 In typical Exim style, the verification implementation does not include any
39828 default "policy". Instead it enables you to build your own policy using
39829 Exim's standard controls.
39830
39831 Please note that verification of DKIM signatures in incoming mail is turned
39832 on by default for logging (in the <= line) purposes.
39833
39834 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39835 When set, for each signature in incoming email,
39836 exim will log a line displaying the most important signature details, and the
39837 signature status. Here is an example (with line-breaks added for clarity):
39838 .code
39839 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39840     d=facebookmail.com s=q1-2009b
39841     c=relaxed/relaxed a=rsa-sha1
39842     i=@facebookmail.com t=1252484542 [verification succeeded]
39843 .endd
39844
39845 You might want to turn off DKIM verification processing entirely for internal
39846 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39847 control modifier. This should typically be done in the RCPT ACL, at points
39848 where you accept mail from relay sources (internal hosts or authenticated
39849 senders).
39850
39851
39852 .section "Signing outgoing messages" "SECDKIMSIGN"
39853 .cindex "DKIM" "signing"
39854
39855 For signing to be usable you must have published a DKIM record in DNS.
39856 Note that RFC 8301 (which does not cover EC keys) says:
39857 .code
39858 rsa-sha1 MUST NOT be used for signing or verifying.
39859
39860 Signers MUST use RSA keys of at least 1024 bits for all keys.
39861 Signers SHOULD use RSA keys of at least 2048 bits.
39862 .endd
39863
39864 Note also that the key content (the 'p=' field)
39865 in the DNS record is different between RSA and EC keys;
39866 for the former it is the base64 of the ASN.1 for the RSA public key
39867 (equivalent to the private-key .pem with the header/trailer stripped)
39868 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39869
39870 Signing is enabled by setting private options on the SMTP transport.
39871 These options take (expandable) strings as arguments.
39872
39873 .option dkim_domain smtp string list&!! unset
39874 The domain(s) you want to sign with.
39875 After expansion, this can be a list.
39876 Each element in turn,
39877 .new
39878 lowercased,
39879 .wen
39880 is put into the &%$dkim_domain%& expansion variable
39881 while expanding the remaining signing options.
39882 If it is empty after expansion, DKIM signing is not done,
39883 and no error will result even if &%dkim_strict%& is set.
39884
39885 .option dkim_selector smtp string list&!! unset
39886 This sets the key selector string.
39887 After expansion, which can use &$dkim_domain$&, this can be a list.
39888 Each element in turn is put in the expansion
39889 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39890 option along with &%$dkim_domain%&.
39891 If the option is empty after expansion, DKIM signing is not done for this domain,
39892 and no error will result even if &%dkim_strict%& is set.
39893
39894 .option dkim_private_key smtp string&!! unset
39895 This sets the private key to use.
39896 You can use the &%$dkim_domain%& and
39897 &%$dkim_selector%& expansion variables to determine the private key to use.
39898 The result can either
39899 .ilist
39900 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39901 .next
39902 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39903 be a valid Ed25519 private key (same format as above)
39904 .next
39905 start with a slash, in which case it is treated as a file that contains
39906 the private key
39907 .next
39908 be "0", "false" or the empty string, in which case the message will not
39909 be signed. This case will not result in an error, even if &%dkim_strict%&
39910 is set.
39911 .endlist
39912
39913 To generate keys under OpenSSL:
39914 .code
39915 openssl genrsa -out dkim_rsa.private 2048
39916 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39917 .endd
39918 Take the base-64 lines from the output of the second command, concatenated,
39919 for the DNS TXT record.
39920 See section 3.6 of RFC6376 for the record specification.
39921
39922 Under GnuTLS:
39923 .code
39924 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39925 certtool --load-privkey=dkim_rsa.private --pubkey-info
39926 .endd
39927
39928 Note that RFC 8301 says:
39929 .code
39930 Signers MUST use RSA keys of at least 1024 bits for all keys.
39931 Signers SHOULD use RSA keys of at least 2048 bits.
39932 .endd
39933
39934 .new
39935 EC keys for DKIM are defined by RFC 8463.
39936 .wen
39937 They are considerably smaller than RSA keys for equivalent protection.
39938 As they are a recent development, users should consider dual-signing
39939 (by setting a list of selectors, and an expansion for this option)
39940 for some transition period.
39941 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39942 for EC keys.
39943
39944 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39945 .code
39946 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39947 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39948 .endd
39949
39950 To produce the required public key value for a DNS record:
39951 .code
39952 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39953 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39954 .endd
39955
39956 .new
39957 Exim also supports an alternate format
39958 of Ed25519 keys in DNS which was a candidate during development
39959 of the standard, but not adopted.
39960 A future release will probably drop that support.
39961 .wen
39962
39963 .option dkim_hash smtp string&!! sha256
39964 Can be set to any one of the supported hash methods, which are:
39965 .ilist
39966 &`sha1`& &-- should not be used, is old and insecure
39967 .next
39968 &`sha256`& &-- the default
39969 .next
39970 &`sha512`& &-- possibly more secure but less well supported
39971 .endlist
39972
39973 Note that RFC 8301 says:
39974 .code
39975 rsa-sha1 MUST NOT be used for signing or verifying.
39976 .endd
39977
39978 .option dkim_identity smtp string&!! unset
39979 If set after expansion, the value is used to set an "i=" tag in
39980 the signing header.  The DKIM standards restrict the permissible
39981 syntax of this optional tag to a mail address, with possibly-empty
39982 local part, an @, and a domain identical to or subdomain of the "d="
39983 tag value.  Note that Exim does not check the value.
39984
39985 .option dkim_canon smtp string&!! unset
39986 This option sets the canonicalization method used when signing a message.
39987 The DKIM RFC currently supports two methods: "simple" and "relaxed".
39988 The option defaults to "relaxed" when unset. Note: the current implementation
39989 only supports signing with the same canonicalization method for both headers and body.
39990
39991 .option dkim_strict smtp string&!! unset
39992 This  option  defines  how  Exim  behaves  when  signing a message that
39993 should be signed fails for some reason.  When the expansion evaluates to
39994 either "1" or "true", Exim will defer. Otherwise Exim will send the message
39995 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
39996 variables here.
39997
39998 .option dkim_sign_headers smtp string&!! "see below"
39999 If set, this option must expand to a colon-separated
40000 list of header names.
40001 Headers with these names, or the absence or such a header, will be included
40002 in the message signature.
40003 When unspecified, the header names listed in RFC4871 will be used,
40004 whether or not each header is present in the message.
40005 The default list is available for the expansion in the macro
40006 "_DKIM_SIGN_HEADERS".
40007
40008 If a name is repeated, multiple headers by that name (or the absence thereof)
40009 will be signed.  The textually later headers in the headers part of the
40010 message are signed first, if there are multiples.
40011
40012 A name can be prefixed with either an '=' or a '+' character.
40013 If an '=' prefix is used, all headers that are present with this name
40014 will be signed.
40015 If a '+' prefix if used, all headers that are present with this name
40016 will be signed, and one signature added for a missing header with the
40017 name will be appended.
40018
40019 .option dkim_timestamps smtp integer&!! unset
40020 This option controls the inclusion of timestamp information in the signature.
40021 If not set, no such information will be included.
40022 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40023 for the expiry tag
40024 (eg. 1209600 for two weeks);
40025 both creation (t=) and expiry (x=) tags will be included.
40026
40027 RFC 6376 lists these tags as RECOMMENDED.
40028
40029
40030 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40031 .cindex "DKIM" "verification"
40032
40033 Verification of DKIM signatures in SMTP incoming email is done for all
40034 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40035 .new
40036 .cindex DKIM "selecting signature algorithms"
40037 Individual classes of signature algorithm can be ignored by changing
40038 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40039 The &%dkim_verify_minimal%& option can be set to cease verification
40040 processing for a message once the first passing signature is found.
40041 .wen
40042
40043 .cindex authentication "expansion item"
40044 Performing verification sets up information used by the
40045 &%authresults%& expansion item.
40046
40047 .new
40048 For most purposes the default option settings suffice and the remainder
40049 of this section can be ignored.
40050 .wen
40051
40052 The results of verification are made available to the
40053 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40054 A missing ACL definition defaults to accept.
40055 By default, the ACL is called once for each
40056 syntactically(!) correct signature in the incoming message.
40057 If any ACL call does not accept, the message is not accepted.
40058 If a cutthrough delivery was in progress for the message, that is
40059 summarily dropped (having wasted the transmission effort).
40060
40061 To evaluate the verification result in the ACL
40062 a large number of expansion variables
40063 containing the signature status and its details are set up during the
40064 runtime of the ACL.
40065
40066 Calling the ACL only for existing signatures is not sufficient to build
40067 more advanced policies. For that reason, the main option
40068 &%dkim_verify_signers%&, and an expansion variable
40069 &%$dkim_signers%& exist.
40070
40071 The main option &%dkim_verify_signers%& can be set to a colon-separated
40072 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40073 called. It is expanded when the message has been received. At this point,
40074 the expansion variable &%$dkim_signers%& already contains a colon-separated
40075 list of signer domains and identities for the message. When
40076 &%dkim_verify_signers%& is not specified in the main configuration,
40077 it defaults as:
40078 .code
40079 dkim_verify_signers = $dkim_signers
40080 .endd
40081 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40082 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40083 call the ACL for known domains or identities. This would be achieved as follows:
40084 .code
40085 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40086 .endd
40087 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40088 and "ebay.com", plus all domains and identities that have signatures in the message.
40089 You can also be more creative in constructing your policy. For example:
40090 .code
40091 dkim_verify_signers = $sender_address_domain:$dkim_signers
40092 .endd
40093
40094 If a domain or identity is listed several times in the (expanded) value of
40095 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40096
40097 .new
40098 Note that if the option is set using untrustworthy data
40099 (such as the From: header)
40100 care should be taken to force lowercase for domains
40101 and for the domain part if identities.
40102 The default setting can be regarded as trustworthy in this respect.
40103 .wen
40104
40105 If multiple signatures match a domain (or identity), the ACL is called once
40106 for each matching signature.
40107
40108
40109 Inside the DKIM ACL, the following expansion variables are
40110 available (from most to least important):
40111
40112
40113 .vlist
40114 .vitem &%$dkim_cur_signer%&
40115 The signer that is being evaluated in this ACL run. This can be a domain or
40116 an identity. This is one of the list items from the expanded main option
40117 &%dkim_verify_signers%& (see above).
40118
40119 .vitem &%$dkim_verify_status%&
40120 Within the DKIM ACL,
40121 a string describing the general status of the signature. One of
40122 .ilist
40123 &%none%&: There is no signature in the message for the current domain or
40124 identity (as reflected by &%$dkim_cur_signer%&).
40125 .next
40126 &%invalid%&: The signature could not be verified due to a processing error.
40127 More detail is available in &%$dkim_verify_reason%&.
40128 .next
40129 &%fail%&: Verification of the signature failed.  More detail is
40130 available in &%$dkim_verify_reason%&.
40131 .next
40132 &%pass%&: The signature passed verification. It is valid.
40133 .endlist
40134
40135 This variable can be overwritten using an ACL 'set' modifier.
40136 This might, for instance, be done to enforce a policy restriction on
40137 hash-method or key-size:
40138 .code
40139   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40140        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40141        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40142                                   {< {$dkim_key_length}{1024}}}}
40143        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40144        set dkim_verify_status = fail
40145        set dkim_verify_reason = hash too weak or key too short
40146 .endd
40147
40148 So long as a DKIM ACL is defined (it need do no more than accept),
40149 after all the DKIM ACL runs have completed, the value becomes a
40150 colon-separated list of the values after each run.
40151 This is maintained for the mime, prdr and data ACLs.
40152
40153 .vitem &%$dkim_verify_reason%&
40154 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40155 "fail" or "invalid". One of
40156 .ilist
40157 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40158 key for the domain could not be retrieved. This may be a temporary problem.
40159 .next
40160 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40161 record for the domain is syntactically invalid.
40162 .next
40163 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40164 body hash does not match the one specified in the signature header. This
40165 means that the message body was modified in transit.
40166 .next
40167 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40168 could not be verified. This may mean that headers were modified,
40169 re-written or otherwise changed in a way which is incompatible with
40170 DKIM verification. It may of course also mean that the signature is forged.
40171 .endlist
40172
40173 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40174
40175 .vitem &%$dkim_domain%&
40176 The signing domain. IMPORTANT: This variable is only populated if there is
40177 an actual signature in the message for the current domain or identity (as
40178 reflected by &%$dkim_cur_signer%&).
40179
40180 .vitem &%$dkim_identity%&
40181 The signing identity, if present. IMPORTANT: This variable is only populated
40182 if there is an actual signature in the message for the current domain or
40183 identity (as reflected by &%$dkim_cur_signer%&).
40184
40185 .vitem &%$dkim_selector%&
40186 The key record selector string.
40187
40188 .vitem &%$dkim_algo%&
40189 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40190 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40191 may also be 'ed25519-sha256'.
40192 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40193 for EC keys.
40194
40195 Note that RFC 8301 says:
40196 .code
40197 rsa-sha1 MUST NOT be used for signing or verifying.
40198
40199 DKIM signatures identified as having been signed with historic
40200 algorithms (currently, rsa-sha1) have permanently failed evaluation
40201 .endd
40202
40203 To enforce this you must either have a DKIM ACL which checks this variable
40204 and overwrites the &$dkim_verify_status$& variable as discussed above,
40205 .new
40206 or have set the main option &%dkim_verify_hashes%& to exclude
40207 processing of such signatures.
40208 .wen
40209
40210 .vitem &%$dkim_canon_body%&
40211 The body canonicalization method. One of 'relaxed' or 'simple'.
40212
40213 .vitem &%$dkim_canon_headers%&
40214 The header canonicalization method. One of 'relaxed' or 'simple'.
40215
40216 .vitem &%$dkim_copiedheaders%&
40217 A transcript of headers and their values which are included in the signature
40218 (copied from the 'z=' tag of the signature).
40219 Note that RFC6376 requires that verification fail if the From: header is
40220 not included in the signature.  Exim does not enforce this; sites wishing
40221 strict enforcement should code the check explicitly.
40222
40223 .vitem &%$dkim_bodylength%&
40224 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40225 limit was set by the signer, "9999999999999" is returned. This makes sure
40226 that this variable always expands to an integer value.
40227 &*Note:*& The presence of the signature tag specifying a signing body length
40228 is one possible route to spoofing of valid DKIM signatures.
40229 A paranoid implementation might wish to regard signature where this variable
40230 shows less than the "no limit" return as being invalid.
40231
40232 .vitem &%$dkim_created%&
40233 UNIX timestamp reflecting the date and time when the signature was created.
40234 When this was not specified by the signer, "0" is returned.
40235
40236 .vitem &%$dkim_expires%&
40237 UNIX timestamp reflecting the date and time when the signer wants the
40238 signature to be treated as "expired". When this was not specified by the
40239 signer, "9999999999999" is returned. This makes it possible to do useful
40240 integer size comparisons against this value.
40241 Note that Exim does not check this value.
40242
40243 .vitem &%$dkim_headernames%&
40244 A colon-separated list of names of headers included in the signature.
40245
40246 .vitem &%$dkim_key_testing%&
40247 "1" if the key record has the "testing" flag set, "0" if not.
40248
40249 .vitem &%$dkim_key_nosubdomains%&
40250 "1" if the key record forbids subdomaining, "0" otherwise.
40251
40252 .vitem &%$dkim_key_srvtype%&
40253 Service type (tag s=) from the key record. Defaults to "*" if not specified
40254 in the key record.
40255
40256 .vitem &%$dkim_key_granularity%&
40257 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40258 in the key record.
40259
40260 .vitem &%$dkim_key_notes%&
40261 Notes from the key record (tag n=).
40262
40263 .vitem &%$dkim_key_length%&
40264 Number of bits in the key.
40265
40266 Note that RFC 8301 says:
40267 .code
40268 Verifiers MUST NOT consider signatures using RSA keys of
40269 less than 1024 bits as valid signatures.
40270 .endd
40271
40272 To enforce this you must have a DKIM ACL which checks this variable
40273 and overwrites the &$dkim_verify_status$& variable as discussed above.
40274 As EC keys are much smaller, the check should only do this for RSA keys.
40275
40276 .endlist
40277
40278 In addition, two ACL conditions are provided:
40279
40280 .vlist
40281 .vitem &%dkim_signers%&
40282 ACL condition that checks a colon-separated list of domains or identities
40283 for a match against the domain or identity that the ACL is currently verifying
40284 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40285 verb to a group of domains or identities. For example:
40286
40287 .code
40288 # Warn when Mail purportedly from GMail has no gmail signature
40289 warn log_message = GMail sender without gmail.com DKIM signature
40290      sender_domains = gmail.com
40291      dkim_signers = gmail.com
40292      dkim_status = none
40293 .endd
40294
40295 Note that the above does not check for a total lack of DKIM signing;
40296 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40297
40298 .vitem &%dkim_status%&
40299 ACL condition that checks a colon-separated list of possible DKIM verification
40300 results against the actual result of verification. This is typically used
40301 to restrict an ACL verb to a list of verification outcomes, for example:
40302
40303 .code
40304 deny message = Mail from Paypal with invalid/missing signature
40305      sender_domains = paypal.com:paypal.de
40306      dkim_signers = paypal.com:paypal.de
40307      dkim_status = none:invalid:fail
40308 .endd
40309
40310 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40311 see the documentation of the &%$dkim_verify_status%& expansion variable above
40312 for more information of what they mean.
40313 .endlist
40314
40315
40316
40317
40318 .section "SPF (Sender Policy Framework)" SECSPF
40319 .cindex SPF verification
40320
40321 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40322 messages with its domain in the envelope from, documented by RFC 7208.
40323 For more information on SPF see &url(http://www.openspf.org).
40324 . --- 2018-09-07: still not https
40325
40326 Messages sent by a system not authorised will fail checking of such assertions.
40327 This includes retransmissions done by traditional forwarders.
40328
40329 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40330 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40331 &url(https://www.libspf2.org/).
40332 There is no Exim involvement in the transmission of messages;
40333 publishing certain DNS records is all that is required.
40334
40335 For verification, an ACL condition and an expansion lookup are provided.
40336 .cindex authentication "expansion item"
40337 Performing verification sets up information used by the
40338 &%authresults%& expansion item.
40339
40340
40341 .cindex SPF "ACL condition"
40342 .cindex ACL "spf condition"
40343 The ACL condition "spf" can be used at or after the MAIL ACL.
40344 It takes as an argument a list of strings giving the outcome of the SPF check,
40345 and will succeed for any matching outcome.
40346 Valid strings are:
40347 .vlist
40348 .vitem &%pass%&
40349 The SPF check passed, the sending host is positively verified by SPF.
40350
40351 .vitem &%fail%&
40352 The SPF check failed, the sending host is NOT allowed to send mail for the
40353 domain in the envelope-from address.
40354
40355 .vitem &%softfail%&
40356 The SPF check failed, but the queried domain can't absolutely confirm that this
40357 is a forgery.
40358
40359 .vitem &%none%&
40360 The queried domain does not publish SPF records.
40361
40362 .vitem &%neutral%&
40363 The SPF check returned a "neutral" state.  This means the queried domain has
40364 published a SPF record, but wants to allow outside servers to send mail under
40365 its domain as well.  This should be treated like "none".
40366
40367 .vitem &%permerror%&
40368 This indicates a syntax error in the SPF record of the queried domain.
40369 You may deny messages when this occurs.
40370
40371 .vitem &%temperror%&
40372 This indicates a temporary error during all processing, including Exim's
40373 SPF processing.  You may defer messages when this occurs.
40374 .endlist
40375
40376 You can prefix each string with an exclamation mark to  invert
40377 its meaning,  for example  "!fail" will  match all  results but
40378 "fail".  The  string  list is  evaluated  left-to-right,  in a
40379 short-circuit fashion.
40380
40381 Example:
40382 .code
40383 deny spf = fail
40384      message = $sender_host_address is not allowed to send mail from \
40385                ${if def:sender_address_domain \
40386                     {$sender_address_domain}{$sender_helo_name}}.  \
40387                Please see http://www.openspf.org/Why?scope=\
40388                ${if def:sender_address_domain {mfrom}{helo}};\
40389                identity=${if def:sender_address_domain \
40390                              {$sender_address}{$sender_helo_name}};\
40391                ip=$sender_host_address
40392 .endd
40393
40394 When the spf condition has run, it sets up several expansion
40395 variables:
40396
40397 .cindex SPF "verification variables"
40398 .vlist
40399 .vitem &$spf_header_comment$&
40400 .vindex &$spf_header_comment$&
40401   This contains a human-readable string describing the outcome
40402   of the SPF check. You can add it to a custom header or use
40403   it for logging purposes.
40404
40405 .vitem &$spf_received$&
40406 .vindex &$spf_received$&
40407   This contains a complete Received-SPF: header that can be
40408   added to the message. Please note that according to the SPF
40409   draft, this header must be added at the top of the header
40410   list. Please see section 10 on how you can do this.
40411
40412   Note: in case of "Best-guess" (see below), the convention is
40413   to put this string in a header called X-SPF-Guess: instead.
40414
40415 .vitem &$spf_result$&
40416 .vindex &$spf_result$&
40417   This contains the outcome of the SPF check in string form,
40418   one of pass, fail, softfail, none, neutral, permerror or
40419   temperror.
40420
40421 .vitem &$spf_result_guessed$&
40422 .vindex &$spf_result_guessed$&
40423   This boolean is true only if a best-guess operation was used
40424   and required in order to obtain a result.
40425
40426 .vitem &$spf_smtp_comment$&
40427 .vindex &$spf_smtp_comment$&
40428   This contains a string that can be used in a SMTP response
40429   to the calling party. Useful for "fail".
40430 .endlist
40431
40432
40433 .cindex SPF "ACL condition"
40434 .cindex ACL "spf_guess condition"
40435 .cindex SPF "best guess"
40436 In addition to SPF, you can also perform checks for so-called
40437 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40438 SPF, but it is supported by the same framework that enables SPF
40439 capability.
40440 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
40441 for a description of what it means.
40442 . --- 2018-09-07: still not https:
40443
40444 To access this feature, simply use the spf_guess condition in place
40445 of the spf one.  For example:
40446
40447 .code
40448 deny spf_guess = fail
40449      message = $sender_host_address doesn't look trustworthy to me
40450 .endd
40451
40452 In case you decide to reject messages based on this check, you
40453 should note that although it uses the same framework, "Best-guess"
40454 is not SPF, and therefore you should not mention SPF at all in your
40455 reject message.
40456
40457 When the spf_guess condition has run, it sets up the same expansion
40458 variables as when spf condition is run, described above.
40459
40460 Additionally, since Best-guess is not standardized, you may redefine
40461 what "Best-guess" means to you by redefining the main configuration
40462 &%spf_guess%& option.
40463 For example, the following:
40464
40465 .code
40466 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40467 .endd
40468
40469 would relax host matching rules to a broader network range.
40470
40471
40472 .cindex SPF "lookup expansion"
40473 .cindex lookup spf
40474 A lookup expansion is also available. It takes an email
40475 address as the key and an IP address
40476 .new
40477 (v4 or v6)
40478 .wen
40479 as the database:
40480
40481 .code
40482   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40483 .endd
40484
40485 The lookup will return the same result strings as can appear in
40486 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40487
40488
40489
40490
40491
40492 .new
40493 .section DMARC SECDMARC
40494 .cindex DMARC verification
40495
40496 DMARC combines feedback from SPF, DKIM, and header From: in order
40497 to attempt to provide better indicators of the authenticity of an
40498 email.  This document does not explain the fundamentals; you
40499 should read and understand how it works by visiting the website at
40500 &url(http://www.dmarc.org/).
40501
40502 If Exim is built with DMARC support,
40503 the libopendmarc library is used.
40504
40505 For building Exim yourself, obtain the library from
40506 &url(http://sourceforge.net/projects/opendmarc/)
40507 to obtain a copy, or find it in your favorite rpm package
40508 repository.  You will need to attend to the local/Makefile feature
40509 SUPPORT_DMARC and the associated LDFLAGS addition.
40510 This description assumes
40511 that headers will be in /usr/local/include, and that the libraries
40512 are in /usr/local/lib.
40513
40514 . subsection
40515
40516 There are three main-configuration options:
40517 .cindex DMARC "configuration options"
40518
40519 The &%dmarc_tld_file%& option
40520 .oindex &%dmarc_tld_file%&
40521 defines the location of a text file of valid
40522 top level domains the opendmarc library uses
40523 during domain parsing. Maintained by Mozilla,
40524 the most current version can be downloaded
40525 from a link at &url(https://publicsuffix.org/list/, currently pointing
40526 at https://publicsuffix.org/list/public_suffix_list.dat)
40527 See also util/renew-opendmarc-tlds.sh script.
40528 The default for the option is /etc/exim/opendmarc.tlds.
40529
40530
40531 The &%dmarc_history_file%& option, if set
40532 .oindex &%dmarc_history_file%&
40533 defines the location of a file to log results
40534 of dmarc verification on inbound emails. The
40535 contents are importable by the opendmarc tools
40536 which will manage the data, send out DMARC
40537 reports, and expire the data. Make sure the
40538 directory of this file is writable by the user
40539 exim runs as.
40540 The default is unset.
40541
40542 The &%dmarc_forensic_sender%& option
40543 .oindex &%dmarc_forensic_sender%&
40544 defines an alternate email address to use when sending a
40545 forensic report detailing alignment failures
40546 if a sender domain's dmarc record specifies it
40547 and you have configured Exim to send them.
40548 If set, this is expanded and used for the
40549 From: header line; the address is extracted
40550 from it and used for the envelope from.
40551 If not set (the default), the From: header is expanded from
40552 the dsn_from option, and <> is used for the
40553 envelope from.
40554
40555 . I wish we had subsections...
40556
40557 .cindex DMARC controls
40558 By default, the DMARC processing will run for any remote,
40559 non-authenticated user.  It makes sense to only verify DMARC
40560 status of messages coming from remote, untrusted sources.  You can
40561 use standard conditions such as hosts, senders, etc, to decide that
40562 DMARC verification should *not* be performed for them and disable
40563 DMARC with a control setting:
40564 .code
40565   control = dmarc_disable_verify
40566 .endd
40567 A DMARC record can also specify a "forensic address", which gives
40568 exim an email address to submit reports about failed alignment.
40569 Exim does not do this by default because in certain conditions it
40570 results in unintended information leakage (what lists a user might
40571 be subscribed to, etc).  You must configure exim to submit forensic
40572 reports to the owner of the domain.  If the DMARC record contains a
40573 forensic address and you specify the control statement below, then
40574 exim will send these forensic emails.  It's also advised that you
40575 configure a dmarc_forensic_sender because the default sender address
40576 construction might be inadequate.
40577 .code
40578   control = dmarc_enable_forensic
40579 .endd
40580 (AGAIN: You can choose not to send these forensic reports by simply
40581 not putting the dmarc_enable_forensic control line at any point in
40582 your exim config.  If you don't tell it to send them, it will not
40583 send them.)
40584
40585 There are no options to either control.  Both must appear before
40586 the DATA acl.
40587
40588 . subsection
40589
40590 DMARC checks cam be run on incoming SMTP  messages by using the
40591 "dmarc_status" ACL condition in the DATA ACL.  You are required to
40592 call the "spf" condition first in the ACLs, then the "dmarc_status"
40593 condition.  Putting this condition in the ACLs is required in order
40594 for a DMARC check to actually occur.  All of the variables are set
40595 up before the DATA ACL, but there is no actual DMARC check that
40596 occurs until a "dmarc_status" condition is encountered in the ACLs.
40597
40598 The dmarc_status condition takes a list of strings on its
40599 right-hand side.  These strings describe recommended action based
40600 on the DMARC check.  To understand what the policy recommendations
40601 mean, refer to the DMARC website above.  Valid strings are:
40602 .display
40603 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40604 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40605 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40606 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40607 &'norecord    '& No policy section in the DMARC record for this sender domain.
40608 &'nofrom      '& Unable to determine the domain of the sender.
40609 &'temperror   '& Library error or dns error.
40610 &'off         '& The DMARC check was disabled for this email.
40611 .endd
40612 You can prefix each string with an exclamation mark to invert its
40613 meaning, for example "!accept" will match all results but
40614 "accept".  The string list is evaluated left-to-right in a
40615 short-circuit fashion.  When a string matches the outcome of the
40616 DMARC check, the condition succeeds.  If none of the listed
40617 strings matches the outcome of the DMARC check, the condition
40618 fails.
40619
40620 Of course, you can also use any other lookup method that Exim
40621 supports, including LDAP, Postgres, MySQL, etc, as long as the
40622 result is a list of colon-separated strings.
40623
40624 Performing the check sets up information used by the
40625 &%authresults%& expansion item.
40626
40627 Several expansion variables are set before the DATA ACL is
40628 processed, and you can use them in this ACL.  The following
40629 expansion variables are available:
40630
40631 &$dmarc_status$&
40632 .vindex &$dmarc_status$&
40633 .cindex DMARC result
40634 is a one word status indicating what the DMARC library
40635 thinks of the email.  It is a combination of the results of
40636 DMARC record lookup and the SPF/DKIM/DMARC processing results
40637 (if a DMARC record was found).  The actual policy declared
40638 in the DMARC record is in a separate expansion variable.
40639
40640 &$dmarc_status_text$&
40641 .vindex &$dmarc_status_text$&
40642 is a slightly longer, human readable status.
40643
40644 &$dmarc_used_domain$&
40645 .vindex &$dmarc_used_domain$&
40646 is the domain which DMARC used to look up the DMARC policy record.
40647
40648 &$dmarc_domain_policy$&
40649 .vindex &$dmarc_domain_policy$&
40650 is the policy declared in the DMARC record.  Valid values
40651 are "none", "reject" and "quarantine".  It is blank when there
40652 is any error, including no DMARC record.
40653
40654 . subsection
40655
40656 By default, Exim's DMARC configuration is intended to be
40657 non-intrusive and conservative.  To facilitate this, Exim will not
40658 create any type of logging files without explicit configuration by
40659 you, the admin.  Nor will Exim send out any emails/reports about
40660 DMARC issues without explicit configuration by you, the admin (other
40661 than typical bounce messages that may come about due to ACL
40662 processing or failure delivery issues).
40663
40664 In order to log statistics suitable to be imported by the opendmarc
40665 tools, you need to:
40666 .ilist
40667 Configure the global setting dmarc_history_file
40668 .next
40669 Configure cron jobs to call the appropriate opendmarc history
40670 import scripts and truncating the dmarc_history_file
40671 .endlist
40672
40673 In order to send forensic reports, you need to:
40674 .ilist
40675 Configure the global setting dmarc_forensic_sender
40676 .next
40677 Configure, somewhere before the DATA ACL, the control option to
40678 enable sending DMARC forensic reports
40679 .endlist
40680
40681 . subsection
40682
40683 Example usage:
40684 .code
40685 (RCPT ACL)
40686   warn    domains        = +local_domains
40687           hosts          = +local_hosts
40688           control        = dmarc_disable_verify
40689
40690   warn    !domains       = +screwed_up_dmarc_records
40691           control        = dmarc_enable_forensic
40692
40693   warn    condition      = (lookup if destined to mailing list)
40694           set acl_m_mailing_list = 1
40695
40696 (DATA ACL)
40697   warn    dmarc_status   = accept : none : off
40698           !authenticated = *
40699           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40700
40701   warn    dmarc_status   = !accept
40702           !authenticated = *
40703           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40704
40705   warn    dmarc_status   = quarantine
40706           !authenticated = *
40707           set $acl_m_quarantine = 1
40708           # Do something in a transport with this flag variable
40709
40710   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40711           condition      = ${if eq{$acl_m_mailing_list}{1}}
40712           message        = Messages from $dmarc_used_domain break mailing lists
40713
40714   deny    dmarc_status   = reject
40715           !authenticated = *
40716           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40717
40718   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40719 .endd
40720
40721 .wen
40722
40723
40724
40725
40726 . ////////////////////////////////////////////////////////////////////////////
40727 . ////////////////////////////////////////////////////////////////////////////
40728
40729 .chapter "Proxies" "CHAPproxies" &&&
40730          "Proxy support"
40731 .cindex "proxy support"
40732 .cindex "proxy" "access via"
40733
40734 A proxy is an intermediate system through which communication is passed.
40735 Proxies may provide a security, availability or load-distribution function.
40736
40737
40738 .section "Inbound proxies" SECTproxyInbound
40739 .cindex proxy inbound
40740 .cindex proxy "server side"
40741 .cindex proxy "Proxy protocol"
40742 .cindex "Proxy protocol" proxy
40743
40744 Exim has support for receiving inbound SMTP connections via a proxy
40745 that uses &"Proxy Protocol"& to speak to it.
40746 To include this support, include &"SUPPORT_PROXY=yes"&
40747 in Local/Makefile.
40748
40749 It was built on the HAProxy specification, found at
40750 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40751
40752 The purpose of this facility is so that an application load balancer,
40753 such as HAProxy, can sit in front of several Exim servers
40754 to distribute load.
40755 Exim uses the local protocol communication with the proxy to obtain
40756 the remote SMTP system IP address and port information.
40757 There is no logging if a host passes or
40758 fails Proxy Protocol negotiation, but it can easily be determined and
40759 recorded in an ACL (example is below).
40760
40761 Use of a proxy is enabled by setting the &%hosts_proxy%&
40762 main configuration option to a hostlist; connections from these
40763 hosts will use Proxy Protocol.
40764 Exim supports both version 1 and version 2 of the Proxy Protocol and
40765 automatically determines which version is in use.
40766
40767 The Proxy Protocol header is the first data received on a TCP connection
40768 and is inserted before any TLS-on-connect handshake from the client; Exim
40769 negotiates TLS between Exim-as-server and the remote client, not between
40770 Exim and the proxy server.
40771
40772 The following expansion variables are usable
40773 (&"internal"& and &"external"& here refer to the interfaces
40774 of the proxy):
40775 .display
40776 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40777 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40778 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40779 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40780 &'proxy_session            '& boolean: SMTP connection via proxy
40781 .endd
40782 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40783 there was a protocol error.
40784 The variables &$sender_host_address$& and &$sender_host_port$&
40785 will have values for the actual client system, not the proxy.
40786
40787 Since the real connections are all coming from the proxy, and the
40788 per host connection tracking is done before Proxy Protocol is
40789 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40790 handle all of the parallel volume you expect per inbound proxy.
40791 With the option set so high, you lose the ability
40792 to protect your server from many connections from one IP.
40793 In order to prevent your server from overload, you
40794 need to add a per connection ratelimit to your connect ACL.
40795 A possible solution is:
40796 .display
40797   # Set max number of connections per host
40798   LIMIT   = 5
40799   # Or do some kind of IP lookup in a flat file or database
40800   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40801
40802   defer   message        = Too many connections from this IP right now
40803           ratelimit      = LIMIT / 5s / per_conn / strict
40804 .endd
40805
40806
40807
40808 .section "Outbound proxies" SECTproxySOCKS
40809 .cindex proxy outbound
40810 .cindex proxy "client side"
40811 .cindex proxy SOCKS
40812 .cindex SOCKS proxy
40813 Exim has support for sending outbound SMTP via a proxy
40814 using a protocol called SOCKS5 (defined by RFC1928).
40815 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40816 Local/Makefile.
40817
40818 Use of a proxy is enabled by setting the &%socks_proxy%& option
40819 on an smtp transport.
40820 The option value is expanded and should then be a list
40821 (colon-separated by default) of proxy specifiers.
40822 Each proxy specifier is a list
40823 (space-separated by default) where the initial element
40824 is an IP address and any subsequent elements are options.
40825
40826 Options are a string <name>=<value>.
40827 The list of options is in the following table:
40828 .display
40829 &'auth   '& authentication method
40830 &'name   '& authentication username
40831 &'pass   '& authentication password
40832 &'port   '& tcp port
40833 &'tmo    '& connection timeout
40834 &'pri    '& priority
40835 &'weight '& selection bias
40836 .endd
40837
40838 More details on each of these options follows:
40839
40840 .ilist
40841 .cindex authentication "to proxy"
40842 .cindex proxy authentication
40843 &%auth%&: Either &"none"& (default) or &"name"&.
40844 Using &"name"& selects username/password authentication per RFC 1929
40845 for access to the proxy.
40846 Default is &"none"&.
40847 .next
40848 &%name%&: sets the username for the &"name"& authentication method.
40849 Default is empty.
40850 .next
40851 &%pass%&: sets the password for the &"name"& authentication method.
40852 Default is empty.
40853 .next
40854 &%port%&: the TCP port number to use for the connection to the proxy.
40855 Default is 1080.
40856 .next
40857 &%tmo%&: sets a connection timeout in seconds for this proxy.
40858 Default is 5.
40859 .next
40860 &%pri%&: specifies a priority for the proxy within the list,
40861 higher values being tried first.
40862 The default priority is 1.
40863 .next
40864 &%weight%&: specifies a selection bias.
40865 Within a priority set servers are queried in a random fashion,
40866 weighted by this value.
40867 The default value for selection bias is 1.
40868 .endlist
40869
40870 Proxies from the list are tried according to their priority
40871 and weight settings until one responds.  The timeout for the
40872 overall connection applies to the set of proxied attempts.
40873
40874 .section Logging SECTproxyLog
40875 To log the (local) IP of a proxy in the incoming or delivery logline,
40876 add &"+proxy"& to the &%log_selector%& option.
40877 This will add a component tagged with &"PRX="& to the line.
40878
40879 . ////////////////////////////////////////////////////////////////////////////
40880 . ////////////////////////////////////////////////////////////////////////////
40881
40882 .chapter "Internationalisation" "CHAPi18n" &&&
40883          "Internationalisation""
40884 .cindex internationalisation "email address"
40885 .cindex EAI
40886 .cindex i18n
40887 .cindex utf8 "mail name handling"
40888
40889 Exim has support for Internationalised mail names.
40890 To include this it must be built with SUPPORT_I18N and the libidn library.
40891 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40892
40893 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40894 instead of it) then IDNA2008 is supported; this adds an extra library
40895 requirement, upon libidn2.
40896
40897 .section "MTA operations" SECTi18nMTA
40898 .cindex SMTPUTF8 "ESMTP option"
40899 The main configuration option &%smtputf8_advertise_hosts%& specifies
40900 a host list.  If this matches the sending host and
40901 accept_8bitmime is true (the default) then the ESMTP option
40902 SMTPUTF8 will be advertised.
40903
40904 If the sender specifies the SMTPUTF8 option on a MAIL command
40905 international handling for the message is enabled and
40906 the expansion variable &$message_smtputf8$& will have value TRUE.
40907
40908 The option &%allow_utf8_domains%& is set to true for this
40909 message. All DNS lookups are converted to a-label form
40910 whatever the setting of &%allow_utf8_domains%&
40911 when Exim is built with SUPPORT_I18N.
40912
40913 Both localparts and domain are maintained as the original
40914 UTF-8 form internally; any comparison or regular-expression use will
40915 require appropriate care.  Filenames created, eg. by
40916 the appendfile transport, will have UTF-8 names.
40917
40918 HELO names sent by the smtp transport will have any UTF-8
40919 components expanded to a-label form,
40920 and any certificate name checks will be done using the a-label
40921 form of the name.
40922
40923 .cindex log protocol
40924 .cindex SMTPUTF8 logging
40925 .cindex i18n logging
40926 Log lines and Received-by: header lines will acquire a "utf8"
40927 prefix on the protocol element, eg. utf8esmtp.
40928
40929 The following expansion operators can be used:
40930 .code
40931 ${utf8_domain_to_alabel:str}
40932 ${utf8_domain_from_alabel:str}
40933 ${utf8_localpart_to_alabel:str}
40934 ${utf8_localpart_from_alabel:str}
40935 .endd
40936
40937 .cindex utf8 "address downconversion"
40938 .cindex i18n "utf8 address downconversion"
40939 The RCPT ACL
40940 may use the following modifier:
40941 .display
40942 control = utf8_downconvert
40943 control = utf8_downconvert/<value>
40944 .endd
40945 This sets a flag requiring that addresses are converted to
40946 a-label form before smtp delivery, for use in a
40947 Message Submission Agent context.
40948 If a value is appended it may be:
40949 .display
40950 &`1  `& (default) mandatory downconversion
40951 &`0  `& no downconversion
40952 &`-1 `& if SMTPUTF8 not supported by destination host
40953 .endd
40954
40955 If mua_wrapper is set, the utf8_downconvert control
40956 is initially set to -1.
40957
40958 The smtp transport has an option &%utf8_downconvert%&.
40959 If set it must expand to one of the three values described above,
40960 and it overrides any previously set value.
40961
40962
40963 There is no explicit support for VRFY and EXPN.
40964 Configurations supporting these should inspect
40965 &$smtp_command_argument$& for an SMTPUTF8 argument.
40966
40967 There is no support for LMTP on Unix sockets.
40968 Using the "lmtp" protocol option on an smtp transport,
40969 for LMTP over TCP, should work as expected.
40970
40971 There is no support for DSN unitext handling,
40972 and no provision for converting logging from or to UTF-8.
40973
40974
40975
40976 .section "MDA operations" SECTi18nMDA
40977 To aid in constructing names suitable for IMAP folders
40978 the following expansion operator can be used:
40979 .code
40980 ${imapfolder {<string>} {<sep>} {<specials>}}
40981 .endd
40982
40983 The string is converted from the charset specified by
40984 the "headers charset" command (in a filter file)
40985 or &%headers_charset%& main configuration option (otherwise),
40986 to the
40987 modified UTF-7 encoding specified by RFC 2060,
40988 with the following exception: All occurrences of <sep>
40989 (which has to be a single character)
40990 are replaced with periods ("."), and all periods and slashes that are not
40991 <sep> and are not in the <specials> string are BASE64 encoded.
40992
40993 The third argument can be omitted, defaulting to an empty string.
40994 The second argument can be omitted, defaulting to "/".
40995
40996 This is the encoding used by Courier for Maildir names on disk, and followed
40997 by many other IMAP servers.
40998
40999 Examples:
41000 .display
41001 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41002 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41003 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41004 .endd
41005
41006 Note that the source charset setting is vital, and also that characters
41007 must be representable in UTF-16.
41008
41009
41010 . ////////////////////////////////////////////////////////////////////////////
41011 . ////////////////////////////////////////////////////////////////////////////
41012
41013 .chapter "Events" "CHAPevents" &&&
41014          "Events"
41015 .cindex events
41016
41017 The events mechanism in Exim can be used to intercept processing at a number
41018 of points.  It was originally invented to give a way to do customised logging
41019 actions (for example, to a database) but can also be used to modify some
41020 processing actions.
41021
41022 Most installations will never need to use Events.
41023 The support can be left out of a build by defining DISABLE_EVENT=yes
41024 in &_Local/Makefile_&.
41025
41026 There are two major classes of events: main and transport.
41027 The main configuration option &%event_action%& controls reception events;
41028 a transport option &%event_action%& controls delivery events.
41029
41030 Both options are a string which is expanded when the event fires.
41031 An example might look like:
41032 .cindex logging custom
41033 .code
41034 event_action = ${if eq {msg:delivery}{$event_name} \
41035 {${lookup pgsql {SELECT * FROM record_Delivery( \
41036     '${quote_pgsql:$sender_address_domain}',\
41037     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41038     '${quote_pgsql:$domain}', \
41039     '${quote_pgsql:${lc:$local_part}}', \
41040     '${quote_pgsql:$host_address}', \
41041     '${quote_pgsql:${lc:$host}}', \
41042     '${quote_pgsql:$message_exim_id}')}} \
41043 } {}}
41044 .endd
41045
41046 Events have names which correspond to the point in process at which they fire.
41047 The name is placed in the variable &$event_name$& and the event action
41048 expansion must check this, as it will be called for every possible event type.
41049
41050 .new
41051 The current list of events is:
41052 .wen
41053 .display
41054 &`dane:fail              after    transport  `& per connection
41055 &`msg:complete           after    main       `& per message
41056 &`msg:delivery           after    transport  `& per recipient
41057 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41058 &`msg:rcpt:defer         after    transport  `& per recipient
41059 &`msg:host:defer         after    transport  `& per attempt
41060 &`msg:fail:delivery      after    transport  `& per recipient
41061 &`msg:fail:internal      after    main       `& per recipient
41062 &`tcp:connect            before   transport  `& per connection
41063 &`tcp:close              after    transport  `& per connection
41064 &`tls:cert               before   both       `& per certificate in verification chain
41065 &`smtp:connect           after    transport  `& per connection
41066 &`smtp:ehlo              after    transport  `& per connection
41067 .endd
41068 New event types may be added in future.
41069
41070 The event name is a colon-separated list, defining the type of
41071 event in a tree of possibilities.  It may be used as a list
41072 or just matched on as a whole.  There will be no spaces in the name.
41073
41074 The second column in the table above describes whether the event fires
41075 before or after the action is associates with.  Those which fire before
41076 can be used to affect that action (more on this below).
41077
41078 The third column in the table above says what section of the configuration
41079 should define the event action.
41080
41081 An additional variable, &$event_data$&, is filled with information varying
41082 with the event type:
41083 .display
41084 &`dane:fail            `& failure reason
41085 &`msg:delivery         `& smtp confirmation message
41086 &`msg:fail:internal    `& failure reason
41087 &`msg:fail:delivery    `& smtp error message
41088 &`msg:rcpt:host:defer  `& error string
41089 &`msg:rcpt:defer       `& error string
41090 &`msg:host:defer       `& error string
41091 &`tls:cert             `& verification chain depth
41092 &`smtp:connect         `& smtp banner
41093 &`smtp:ehlo            `& smtp ehlo response
41094 .endd
41095
41096 The :defer events populate one extra variable: &$event_defer_errno$&.
41097
41098 For complex operations an ACL expansion can be used in &%event_action%&
41099 however due to the multiple contexts that Exim operates in during
41100 the course of its processing:
41101 .ilist
41102 variables set in transport events will not be visible outside that
41103 transport call
41104 .next
41105 acl_m variables in a server context are lost on a new connection,
41106 and after smtp helo/ehlo/mail/starttls/rset commands
41107 .endlist
41108 Using an ACL expansion with the logwrite modifier can be
41109 a useful way of writing to the main log.
41110
41111 The expansion of the event_action option should normally
41112 return an empty string.  Should it return anything else the
41113 following will be forced:
41114 .display
41115 &`tcp:connect      `&  do not connect
41116 &`tls:cert         `&  refuse verification
41117 &`smtp:connect     `&  close connection
41118 .endd
41119 All other message types ignore the result string, and
41120 no other use is made of it.
41121
41122 For a tcp:connect event, if the connection is being made to a proxy
41123 then the address and port variables will be that of the proxy and not
41124 the target system.
41125
41126 For tls:cert events, if GnuTLS is in use this will trigger only per
41127 chain element received on the connection.
41128 For OpenSSL it will trigger for every chain element including those
41129 loaded locally.
41130
41131 . ////////////////////////////////////////////////////////////////////////////
41132 . ////////////////////////////////////////////////////////////////////////////
41133
41134 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41135          "Adding drivers or lookups"
41136 .cindex "adding drivers"
41137 .cindex "new drivers, adding"
41138 .cindex "drivers" "adding new"
41139 The following actions have to be taken in order to add a new router, transport,
41140 authenticator, or lookup type to Exim:
41141
41142 .olist
41143 Choose a name for the driver or lookup type that does not conflict with any
41144 existing name; I will use &"newdriver"& in what follows.
41145 .next
41146 Add to &_src/EDITME_& the line:
41147 .display
41148 <&'type'&>&`_NEWDRIVER=yes`&
41149 .endd
41150 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41151 code is not to be included in the binary by default, comment this line out. You
41152 should also add any relevant comments about the driver or lookup type.
41153 .next
41154 Add to &_src/config.h.defaults_& the line:
41155 .code
41156 #define <type>_NEWDRIVER
41157 .endd
41158 .next
41159 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41160 and create a table entry as is done for all the other drivers and lookup types.
41161 .next
41162 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41163 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41164 Add your &`NEWDRIVER`& to that list.
41165 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41166 simple form that most lookups have.
41167 .next
41168 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41169 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41170 driver or lookup type and add it to the definition of OBJ.
41171 .next
41172 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41173 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41174 .next
41175 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41176 &_src_&.
41177 .next
41178 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41179 as for other drivers and lookups.
41180 .endlist
41181
41182 Then all you need to do is write the code! A good way to start is to make a
41183 proforma by copying an existing module of the same type, globally changing all
41184 occurrences of the name, and cutting out most of the code. Note that any
41185 options you create must be listed in alphabetical order, because the tables are
41186 searched using a binary chop procedure.
41187
41188 There is a &_README_& file in each of the sub-directories of &_src_& describing
41189 the interface that is expected.
41190
41191
41192
41193
41194 . ////////////////////////////////////////////////////////////////////////////
41195 . ////////////////////////////////////////////////////////////////////////////
41196
41197 . /////////////////////////////////////////////////////////////////////////////
41198 . These lines are processing instructions for the Simple DocBook Processor that
41199 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41200 . PDFs than using xmlto and fop. They will be ignored by all other XML
41201 . processors.
41202 . /////////////////////////////////////////////////////////////////////////////
41203
41204 .literal xml
41205 <?sdop
41206   format="newpage"
41207   foot_right_recto="&chaptertitle;"
41208   foot_right_verso="&chaptertitle;"
41209 ?>
41210 .literal off
41211
41212 .makeindex "Options index"   "option"
41213 .makeindex "Variables index" "variable"
41214 .makeindex "Concept index"   "concept"
41215
41216
41217 . /////////////////////////////////////////////////////////////////////////////
41218 . /////////////////////////////////////////////////////////////////////////////