Expansions: Reduce memory use of ${listcount }
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt.readsock
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.93"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2019
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part_prefix_v$&"
1403 .vindex "&$local_part$&"
1404 .vindex "&$local_part_suffix$&"
1405 .vindex "&$local_part_suffix_v$&"
1406 .cindex affix "router precondition"
1407 If the &%local_parts%& option is set, the local part of the address must be in
1408 the set of local parts that it defines. If &%local_part_prefix%& or
1409 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1410 part before this check. If you want to do precondition tests on local parts
1411 that include affixes, you can do so by using a &%condition%& option (see below)
1412 .new
1413 that uses the variables &$local_part$&, &$local_part_prefix$&,
1414 &$local_part_prefix_v$&, &$local_part_suffix$&
1415 and &$local_part_suffix_v$& as necessary.
1416 .wen
1417 .next
1418 .vindex "&$local_user_uid$&"
1419 .vindex "&$local_user_gid$&"
1420 .vindex "&$home$&"
1421 If the &%check_local_user%& option is set, the local part must be the name of
1422 an account on the local host. If this check succeeds, the uid and gid of the
1423 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1424 user's home directory is placed in &$home$&; these values can be used in the
1425 remaining preconditions.
1426 .next
1427 If the &%router_home_directory%& option is set, it is expanded at this point,
1428 because it overrides the value of &$home$&. If this expansion were left till
1429 later, the value of &$home$& as set by &%check_local_user%& would be used in
1430 subsequent tests. Having two different values of &$home$& in the same router
1431 could lead to confusion.
1432 .next
1433 If the &%senders%& option is set, the envelope sender address must be in the
1434 set of addresses that it defines.
1435 .next
1436 If the &%require_files%& option is set, the existence or non-existence of
1437 specified files is tested.
1438 .next
1439 .cindex "customizing" "precondition"
1440 If the &%condition%& option is set, it is evaluated and tested. This option
1441 uses an expanded string to allow you to set up your own custom preconditions.
1442 Expanded strings are described in chapter &<<CHAPexpand>>&.
1443 .endlist
1444
1445
1446 Note that &%require_files%& comes near the end of the list, so you cannot use
1447 it to check for the existence of a file in which to lookup up a domain, local
1448 part, or sender. However, as these options are all expanded, you can use the
1449 &%exists%& expansion condition to make such tests within each condition. The
1450 &%require_files%& option is intended for checking files that the router may be
1451 going to use internally, or which are needed by a specific transport (for
1452 example, &_.procmailrc_&).
1453
1454
1455
1456 .section "Delivery in detail" "SECID18"
1457 .cindex "delivery" "in detail"
1458 When a message is to be delivered, the sequence of events is as follows:
1459
1460 .ilist
1461 If a system-wide filter file is specified, the message is passed to it. The
1462 filter may add recipients to the message, replace the recipients, discard the
1463 message, cause a new message to be generated, or cause the message delivery to
1464 fail. The format of the system filter file is the same as for Exim user filter
1465 files, described in the separate document entitled &'Exim's interfaces to mail
1466 filtering'&.
1467 .cindex "Sieve filter" "not available for system filter"
1468 (&*Note*&: Sieve cannot be used for system filter files.)
1469
1470 Some additional features are available in system filters &-- see chapter
1471 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1472 filter only once per delivery attempt, however many recipients it has. However,
1473 if there are several delivery attempts because one or more addresses could not
1474 be immediately delivered, the system filter is run each time. The filter
1475 condition &%first_delivery%& can be used to detect the first run of the system
1476 filter.
1477 .next
1478 Each recipient address is offered to each configured router, in turn, subject to
1479 its preconditions, until one is able to handle it. If no router can handle the
1480 address, that is, if they all decline, the address is failed. Because routers
1481 can be targeted at particular domains, several locally handled domains can be
1482 processed entirely independently of each other.
1483 .next
1484 .cindex "routing" "loops in"
1485 .cindex "loop" "while routing"
1486 A router that accepts an address may assign it to a local or a remote
1487 transport. However, the transport is not run at this time. Instead, the address
1488 is placed on a list for the particular transport, which will be run later.
1489 Alternatively, the router may generate one or more new addresses (typically
1490 from alias, forward, or filter files). New addresses are fed back into this
1491 process from the top, but in order to avoid loops, a router ignores any address
1492 which has an identically-named ancestor that was processed by itself.
1493 .next
1494 When all the routing has been done, addresses that have been successfully
1495 handled are passed to their assigned transports. When local transports are
1496 doing real local deliveries, they handle only one address at a time, but if a
1497 local transport is being used as a pseudo-remote transport (for example, to
1498 collect batched SMTP messages for transmission by some other means) multiple
1499 addresses can be handled. Remote transports can always handle more than one
1500 address at a time, but can be configured not to do so, or to restrict multiple
1501 addresses to the same domain.
1502 .next
1503 Each local delivery to a file or a pipe runs in a separate process under a
1504 non-privileged uid, and these deliveries are run one at a time. Remote
1505 deliveries also run in separate processes, normally under a uid that is private
1506 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1507 run in parallel. The maximum number of simultaneous remote deliveries for any
1508 one message is set by the &%remote_max_parallel%& option.
1509 The order in which deliveries are done is not defined, except that all local
1510 deliveries happen before any remote deliveries.
1511 .next
1512 .cindex "queue runner"
1513 When it encounters a local delivery during a queue run, Exim checks its retry
1514 database to see if there has been a previous temporary delivery failure for the
1515 address before running the local transport. If there was a previous failure,
1516 Exim does not attempt a new delivery until the retry time for the address is
1517 reached. However, this happens only for delivery attempts that are part of a
1518 queue run. Local deliveries are always attempted when delivery immediately
1519 follows message reception, even if retry times are set for them. This makes for
1520 better behaviour if one particular message is causing problems (for example,
1521 causing quota overflow, or provoking an error in a filter file).
1522 .next
1523 .cindex "delivery" "retry in remote transports"
1524 Remote transports do their own retry handling, since an address may be
1525 deliverable to one of a number of hosts, each of which may have a different
1526 retry time. If there have been previous temporary failures and no host has
1527 reached its retry time, no delivery is attempted, whether in a queue run or
1528 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1529 .next
1530 If there were any permanent errors, a bounce message is returned to an
1531 appropriate address (the sender in the common case), with details of the error
1532 for each failing address. Exim can be configured to send copies of bounce
1533 messages to other addresses.
1534 .next
1535 .cindex "delivery" "deferral"
1536 If one or more addresses suffered a temporary failure, the message is left on
1537 the queue, to be tried again later. Delivery of these addresses is said to be
1538 &'deferred'&.
1539 .next
1540 When all the recipient addresses have either been delivered or bounced,
1541 handling of the message is complete. The spool files and message log are
1542 deleted, though the message log can optionally be preserved if required.
1543 .endlist
1544
1545
1546
1547
1548 .section "Retry mechanism" "SECID19"
1549 .cindex "delivery" "retry mechanism"
1550 .cindex "retry" "description of mechanism"
1551 .cindex "queue runner"
1552 Exim's mechanism for retrying messages that fail to get delivered at the first
1553 attempt is the queue runner process. You must either run an Exim daemon that
1554 uses the &%-q%& option with a time interval to start queue runners at regular
1555 intervals or use some other means (such as &'cron'&) to start them. If you do
1556 not arrange for queue runners to be run, messages that fail temporarily at the
1557 first attempt will remain in your queue forever. A queue runner process works
1558 its way through the queue, one message at a time, trying each delivery that has
1559 passed its retry time.
1560 You can run several queue runners at once.
1561
1562 Exim uses a set of configured rules to determine when next to retry the failing
1563 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1564 should give up trying to deliver to the address, at which point it generates a
1565 bounce message. If no retry rules are set for a particular host, address, and
1566 error combination, no retries are attempted, and temporary errors are treated
1567 as permanent.
1568
1569
1570
1571 .section "Temporary delivery failure" "SECID20"
1572 .cindex "delivery" "temporary failure"
1573 There are many reasons why a message may not be immediately deliverable to a
1574 particular address. Failure to connect to a remote machine (because it, or the
1575 connection to it, is down) is one of the most common. Temporary failures may be
1576 detected during routing as well as during the transport stage of delivery.
1577 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1578 is on a file system where the user is over quota. Exim can be configured to
1579 impose its own quotas on local mailboxes; where system quotas are set they will
1580 also apply.
1581
1582 If a host is unreachable for a period of time, a number of messages may be
1583 waiting for it by the time it recovers, and sending them in a single SMTP
1584 connection is clearly beneficial. Whenever a delivery to a remote host is
1585 deferred,
1586 .cindex "hints database" "deferred deliveries"
1587 Exim makes a note in its hints database, and whenever a successful
1588 SMTP delivery has happened, it looks to see if any other messages are waiting
1589 for the same host. If any are found, they are sent over the same SMTP
1590 connection, subject to a configuration limit as to the maximum number in any
1591 one connection.
1592
1593
1594
1595 .section "Permanent delivery failure" "SECID21"
1596 .cindex "delivery" "permanent failure"
1597 .cindex "bounce message" "when generated"
1598 When a message cannot be delivered to some or all of its intended recipients, a
1599 bounce message is generated. Temporary delivery failures turn into permanent
1600 errors when their timeout expires. All the addresses that fail in a given
1601 delivery attempt are listed in a single message. If the original message has
1602 many recipients, it is possible for some addresses to fail in one delivery
1603 attempt and others to fail subsequently, giving rise to more than one bounce
1604 message. The wording of bounce messages can be customized by the administrator.
1605 See chapter &<<CHAPemsgcust>>& for details.
1606
1607 .cindex "&'X-Failed-Recipients:'& header line"
1608 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1609 failed addresses, for the benefit of programs that try to analyse such messages
1610 automatically.
1611
1612 .cindex "bounce message" "recipient of"
1613 A bounce message is normally sent to the sender of the original message, as
1614 obtained from the message's envelope. For incoming SMTP messages, this is the
1615 address given in the MAIL command. However, when an address is expanded via a
1616 forward or alias file, an alternative address can be specified for delivery
1617 failures of the generated addresses. For a mailing list expansion (see section
1618 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1619 of the list.
1620
1621
1622
1623 .section "Failures to deliver bounce messages" "SECID22"
1624 .cindex "bounce message" "failure to deliver"
1625 If a bounce message (either locally generated or received from a remote host)
1626 itself suffers a permanent delivery failure, the message is left in the queue,
1627 but it is frozen, awaiting the attention of an administrator. There are options
1628 that can be used to make Exim discard such failed messages, or to keep them
1629 for only a short time (see &%timeout_frozen_after%& and
1630 &%ignore_bounce_errors_after%&).
1631
1632
1633
1634
1635
1636 . ////////////////////////////////////////////////////////////////////////////
1637 . ////////////////////////////////////////////////////////////////////////////
1638
1639 .chapter "Building and installing Exim" "CHID3"
1640 .scindex IIDbuex "building Exim"
1641
1642 .section "Unpacking" "SECID23"
1643 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1644 creates a directory with the name of the current release (for example,
1645 &_exim-&version()_&) into which the following files are placed:
1646
1647 .table2 140pt
1648 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1649 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1650   documented"
1651 .irow &_LICENCE_&         "the GNU General Public Licence"
1652 .irow &_Makefile_&        "top-level make file"
1653 .irow &_NOTICE_&          "conditions for the use of Exim"
1654 .irow &_README_&          "list of files, directories and simple build &&&
1655   instructions"
1656 .endtable
1657
1658 Other files whose names begin with &_README_& may also be present. The
1659 following subdirectories are created:
1660
1661 .table2 140pt
1662 .irow &_Local_&           "an empty directory for local configuration files"
1663 .irow &_OS_&              "OS-specific files"
1664 .irow &_doc_&             "documentation files"
1665 .irow &_exim_monitor_&    "source files for the Exim monitor"
1666 .irow &_scripts_&         "scripts used in the build process"
1667 .irow &_src_&             "remaining source files"
1668 .irow &_util_&            "independent utilities"
1669 .endtable
1670
1671 The main utility programs are contained in the &_src_& directory and are built
1672 with the Exim binary. The &_util_& directory contains a few optional scripts
1673 that may be useful to some sites.
1674
1675
1676 .section "Multiple machine architectures and operating systems" "SECID24"
1677 .cindex "building Exim" "multiple OS/architectures"
1678 The building process for Exim is arranged to make it easy to build binaries for
1679 a number of different architectures and operating systems from the same set of
1680 source files. Compilation does not take place in the &_src_& directory.
1681 Instead, a &'build directory'& is created for each architecture and operating
1682 system.
1683 .cindex "symbolic link" "to build directory"
1684 Symbolic links to the sources are installed in this directory, which is where
1685 the actual building takes place. In most cases, Exim can discover the machine
1686 architecture and operating system for itself, but the defaults can be
1687 overridden if necessary.
1688 .cindex compiler requirements
1689 .cindex compiler version
1690 A C99-capable compiler will be required for the build.
1691
1692
1693 .section "PCRE library" "SECTpcre"
1694 .cindex "PCRE library"
1695 Exim no longer has an embedded PCRE library as the vast majority of
1696 modern systems include PCRE as a system library, although you may need to
1697 install the PCRE package or the PCRE development package for your operating
1698 system. If your system has a normal PCRE installation the Exim build
1699 process will need no further configuration. If the library or the
1700 headers are in an unusual location you will need to either set the PCRE_LIBS
1701 and INCLUDE directives appropriately,
1702 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1703 If your operating system has no
1704 PCRE support then you will need to obtain and build the current PCRE
1705 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1706 More information on PCRE is available at &url(https://www.pcre.org/).
1707
1708 .section "DBM libraries" "SECTdb"
1709 .cindex "DBM libraries" "discussion of"
1710 .cindex "hints database" "DBM files used for"
1711 Even if you do not use any DBM files in your configuration, Exim still needs a
1712 DBM library in order to operate, because it uses indexed files for its hints
1713 databases. Unfortunately, there are a number of DBM libraries in existence, and
1714 different operating systems often have different ones installed.
1715
1716 .cindex "Solaris" "DBM library for"
1717 .cindex "IRIX, DBM library for"
1718 .cindex "BSD, DBM library for"
1719 .cindex "Linux, DBM library for"
1720 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1721 Linux distribution, the DBM configuration should happen automatically, and you
1722 may be able to ignore this section. Otherwise, you may have to learn more than
1723 you would like about DBM libraries from what follows.
1724
1725 .cindex "&'ndbm'& DBM library"
1726 Licensed versions of Unix normally contain a library of DBM functions operating
1727 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1728 versions of Unix seem to vary in what they contain as standard. In particular,
1729 some early versions of Linux have no default DBM library, and different
1730 distributors have chosen to bundle different libraries with their packaged
1731 versions. However, the more recent releases seem to have standardized on the
1732 Berkeley DB library.
1733
1734 Different DBM libraries have different conventions for naming the files they
1735 use. When a program opens a file called &_dbmfile_&, there are several
1736 possibilities:
1737
1738 .olist
1739 A traditional &'ndbm'& implementation, such as that supplied as part of
1740 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1741 .next
1742 .cindex "&'gdbm'& DBM library"
1743 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1744 compatibility interface it makes two different hard links to it with names
1745 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1746 filename is used unmodified.
1747 .next
1748 .cindex "Berkeley DB library"
1749 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1750 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1751 programmer exactly the same as the traditional &'ndbm'& implementation.
1752 .next
1753 If the Berkeley package is used in its native mode, it operates on a single
1754 file called &_dbmfile_&; the programmer's interface is somewhat different to
1755 the traditional &'ndbm'& interface.
1756 .next
1757 To complicate things further, there are several very different versions of the
1758 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1759 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1760 Maintenance of some of the earlier releases has ceased. All versions of
1761 Berkeley DB could be obtained from
1762 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1763 page with far newer versions listed.
1764 It is probably wise to plan to move your storage configurations away from
1765 Berkeley DB format, as today there are smaller and simpler alternatives more
1766 suited to Exim's usage model.
1767 .next
1768 .cindex "&'tdb'& DBM library"
1769 Yet another DBM library, called &'tdb'&, is available from
1770 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1771 operates on a single file.
1772 .endlist
1773
1774 .cindex "USE_DB"
1775 .cindex "DBM libraries" "configuration for building"
1776 Exim and its utilities can be compiled to use any of these interfaces. In order
1777 to use any version of the Berkeley DB package in native mode, you must set
1778 USE_DB in an appropriate configuration file (typically
1779 &_Local/Makefile_&). For example:
1780 .code
1781 USE_DB=yes
1782 .endd
1783 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1784 error is diagnosed if you set more than one of these.
1785
1786 At the lowest level, the build-time configuration sets none of these options,
1787 thereby assuming an interface of type (1). However, some operating system
1788 configuration files (for example, those for the BSD operating systems and
1789 Linux) assume type (4) by setting USE_DB as their default, and the
1790 configuration files for Cygwin set USE_GDBM. Anything you set in
1791 &_Local/Makefile_&, however, overrides these system defaults.
1792
1793 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1794 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1795 in one of these lines:
1796 .code
1797 DBMLIB = -ldb
1798 DBMLIB = -ltdb
1799 .endd
1800 Settings like that will work if the DBM library is installed in the standard
1801 place. Sometimes it is not, and the library's header file may also not be in
1802 the default path. You may need to set INCLUDE to specify where the header
1803 file is, and to specify the path to the library more fully in DBMLIB, as in
1804 this example:
1805 .code
1806 INCLUDE=-I/usr/local/include/db-4.1
1807 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1808 .endd
1809 There is further detailed discussion about the various DBM libraries in the
1810 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1811
1812
1813
1814 .section "Pre-building configuration" "SECID25"
1815 .cindex "building Exim" "pre-building configuration"
1816 .cindex "configuration for building Exim"
1817 .cindex "&_Local/Makefile_&"
1818 .cindex "&_src/EDITME_&"
1819 Before building Exim, a local configuration file that specifies options
1820 independent of any operating system has to be created with the name
1821 &_Local/Makefile_&. A template for this file is supplied as the file
1822 &_src/EDITME_&, and it contains full descriptions of all the option settings
1823 therein. These descriptions are therefore not repeated here. If you are
1824 building Exim for the first time, the simplest thing to do is to copy
1825 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1826
1827 There are three settings that you must supply, because Exim will not build
1828 without them. They are the location of the runtime configuration file
1829 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1830 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1831 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1832 a colon-separated list of filenames; Exim uses the first of them that exists.
1833
1834 There are a few other parameters that can be specified either at build time or
1835 at runtime, to enable the same binary to be used on a number of different
1836 machines. However, if the locations of Exim's spool directory and log file
1837 directory (if not within the spool directory) are fixed, it is recommended that
1838 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1839 detected early in Exim's execution (such as a malformed configuration file) can
1840 be logged.
1841
1842 .cindex "content scanning" "specifying at build time"
1843 Exim's interfaces for calling virus and spam scanning software directly from
1844 access control lists are not compiled by default. If you want to include these
1845 facilities, you need to set
1846 .code
1847 WITH_CONTENT_SCAN=yes
1848 .endd
1849 in your &_Local/Makefile_&. For details of the facilities themselves, see
1850 chapter &<<CHAPexiscan>>&.
1851
1852
1853 .cindex "&_Local/eximon.conf_&"
1854 .cindex "&_exim_monitor/EDITME_&"
1855 If you are going to build the Exim monitor, a similar configuration process is
1856 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1857 your installation and saved under the name &_Local/eximon.conf_&. If you are
1858 happy with the default settings described in &_exim_monitor/EDITME_&,
1859 &_Local/eximon.conf_& can be empty, but it must exist.
1860
1861 This is all the configuration that is needed in straightforward cases for known
1862 operating systems. However, the building process is set up so that it is easy
1863 to override options that are set by default or by operating-system-specific
1864 configuration files, for example, to change the C compiler, which
1865 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1866 do this.
1867
1868
1869
1870 .section "Support for iconv()" "SECID26"
1871 .cindex "&[iconv()]& support"
1872 .cindex "RFC 2047"
1873 The contents of header lines in messages may be encoded according to the rules
1874 described RFC 2047. This makes it possible to transmit characters that are not
1875 in the ASCII character set, and to label them as being in a particular
1876 character set. When Exim is inspecting header lines by means of the &%$h_%&
1877 mechanism, it decodes them, and translates them into a specified character set
1878 (default is set at build time). The translation is possible only if the operating system
1879 supports the &[iconv()]& function.
1880
1881 However, some of the operating systems that supply &[iconv()]& do not support
1882 very many conversions. The GNU &%libiconv%& library (available from
1883 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1884 systems to remedy this deficiency, as well as on systems that do not supply
1885 &[iconv()]& at all. After installing &%libiconv%&, you should add
1886 .code
1887 HAVE_ICONV=yes
1888 .endd
1889 to your &_Local/Makefile_& and rebuild Exim.
1890
1891
1892
1893 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1894 .cindex "TLS" "including support for TLS"
1895 .cindex "encryption" "including support for"
1896 .cindex "OpenSSL" "building Exim with"
1897 .cindex "GnuTLS" "building Exim with"
1898 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1899 command as per RFC 2487. It can also support clients that expect to
1900 start a TLS session immediately on connection to a non-standard port (see the
1901 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1902 line option).
1903
1904 If you want to build Exim with TLS support, you must first install either the
1905 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1906 implementing SSL.
1907
1908 If you do not want TLS support you should set
1909 .code
1910 DISABLE_TLS=yes
1911 .endd
1912 in &_Local/Makefile_&.
1913
1914 If OpenSSL is installed, you should set
1915 .code
1916 USE_OPENSL=yes
1917 TLS_LIBS=-lssl -lcrypto
1918 .endd
1919 in &_Local/Makefile_&. You may also need to specify the locations of the
1920 OpenSSL library and include files. For example:
1921 .code
1922 USE_OPENSSL=yes
1923 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1924 TLS_INCLUDE=-I/usr/local/openssl/include/
1925 .endd
1926 .cindex "pkg-config" "OpenSSL"
1927 If you have &'pkg-config'& available, then instead you can just use:
1928 .code
1929 USE_OPENSSL=yes
1930 USE_OPENSSL_PC=openssl
1931 .endd
1932 .cindex "USE_GNUTLS"
1933 If GnuTLS is installed, you should set
1934 .code
1935 USE_GNUTLS=yes
1936 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1937 .endd
1938 in &_Local/Makefile_&, and again you may need to specify the locations of the
1939 library and include files. For example:
1940 .code
1941 USE_GNUTLS=yes
1942 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1943 TLS_INCLUDE=-I/usr/gnu/include
1944 .endd
1945 .cindex "pkg-config" "GnuTLS"
1946 If you have &'pkg-config'& available, then instead you can just use:
1947 .code
1948 USE_GNUTLS=yes
1949 USE_GNUTLS_PC=gnutls
1950 .endd
1951
1952 You do not need to set TLS_INCLUDE if the relevant directory is already
1953 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1954 given in chapter &<<CHAPTLS>>&.
1955
1956
1957
1958
1959 .section "Use of tcpwrappers" "SECID27"
1960
1961 .cindex "tcpwrappers, building Exim to support"
1962 .cindex "USE_TCP_WRAPPERS"
1963 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1964 .cindex "tcp_wrappers_daemon_name"
1965 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1966 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1967 alternative to Exim's own checking facilities for installations that are
1968 already making use of &'tcpwrappers'& for other purposes. To do this, you
1969 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1970 &_tcpd.h_& to be available at compile time, and also ensure that the library
1971 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1972 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1973 you might have
1974 .code
1975 USE_TCP_WRAPPERS=yes
1976 CFLAGS=-O -I/usr/local/include
1977 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1978 .endd
1979 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1980 files is &"exim"&. For example, the line
1981 .code
1982 exim : LOCAL  192.168.1.  .friendly.domain.example
1983 .endd
1984 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1985 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1986 All other connections are denied. The daemon name used by &'tcpwrappers'&
1987 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1988 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1989 configure file. Consult the &'tcpwrappers'& documentation for
1990 further details.
1991
1992
1993 .section "Including support for IPv6" "SECID28"
1994 .cindex "IPv6" "including support for"
1995 Exim contains code for use on systems that have IPv6 support. Setting
1996 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1997 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1998 where the IPv6 support is not fully integrated into the normal include and
1999 library files.
2000
2001 Two different types of DNS record for handling IPv6 addresses have been
2002 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2003 currently seen as the mainstream. Another record type called A6 was proposed
2004 as better than AAAA because it had more flexibility. However, it was felt to be
2005 over-complex, and its status was reduced to &"experimental"&.
2006 Exim used to
2007 have a compile option for including A6 record support but this has now been
2008 withdrawn.
2009
2010
2011
2012 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2013 .cindex "lookup modules"
2014 .cindex "dynamic modules"
2015 .cindex ".so building"
2016 On some platforms, Exim supports not compiling all lookup types directly into
2017 the main binary, instead putting some into external modules which can be loaded
2018 on demand.
2019 This permits packagers to build Exim with support for lookups with extensive
2020 library dependencies without requiring all users to install all of those
2021 dependencies.
2022 Most, but not all, lookup types can be built this way.
2023
2024 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2025 installed; Exim will only load modules from that directory, as a security
2026 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2027 for your OS; see &_OS/Makefile-Linux_& for an example.
2028 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2029 see &_src/EDITME_& for details.
2030
2031 Then, for each module to be loaded dynamically, define the relevant
2032 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2033 For example, this will build in lsearch but load sqlite and mysql support
2034 on demand:
2035 .code
2036 LOOKUP_LSEARCH=yes
2037 LOOKUP_SQLITE=2
2038 LOOKUP_MYSQL=2
2039 .endd
2040
2041
2042 .section "The building process" "SECID29"
2043 .cindex "build directory"
2044 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2045 created, run &'make'& at the top level. It determines the architecture and
2046 operating system types, and creates a build directory if one does not exist.
2047 For example, on a Sun system running Solaris 8, the directory
2048 &_build-SunOS5-5.8-sparc_& is created.
2049 .cindex "symbolic link" "to source files"
2050 Symbolic links to relevant source files are installed in the build directory.
2051
2052 If this is the first time &'make'& has been run, it calls a script that builds
2053 a make file inside the build directory, using the configuration files from the
2054 &_Local_& directory. The new make file is then passed to another instance of
2055 &'make'&. This does the real work, building a number of utility scripts, and
2056 then compiling and linking the binaries for the Exim monitor (if configured), a
2057 number of utility programs, and finally Exim itself. The command &`make
2058 makefile`& can be used to force a rebuild of the make file in the build
2059 directory, should this ever be necessary.
2060
2061 If you have problems building Exim, check for any comments there may be in the
2062 &_README_& file concerning your operating system, and also take a look at the
2063 FAQ, where some common problems are covered.
2064
2065
2066
2067 .section 'Output from &"make"&' "SECID283"
2068 The output produced by the &'make'& process for compile lines is often very
2069 unreadable, because these lines can be very long. For this reason, the normal
2070 output is suppressed by default, and instead output similar to that which
2071 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2072 each module that is being compiled or linked. However, it is still possible to
2073 get the full output, by calling &'make'& like this:
2074 .code
2075 FULLECHO='' make -e
2076 .endd
2077 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2078 command reflection in &'make'&. When you ask for the full output, it is
2079 given in addition to the short output.
2080
2081
2082
2083 .section "Overriding build-time options for Exim" "SECToverride"
2084 .cindex "build-time options, overriding"
2085 The main make file that is created at the beginning of the building process
2086 consists of the concatenation of a number of files which set configuration
2087 values, followed by a fixed set of &'make'& instructions. If a value is set
2088 more than once, the last setting overrides any previous ones. This provides a
2089 convenient way of overriding defaults. The files that are concatenated are, in
2090 order:
2091 .display
2092 &_OS/Makefile-Default_&
2093 &_OS/Makefile-_&<&'ostype'&>
2094 &_Local/Makefile_&
2095 &_Local/Makefile-_&<&'ostype'&>
2096 &_Local/Makefile-_&<&'archtype'&>
2097 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2098 &_OS/Makefile-Base_&
2099 .endd
2100 .cindex "&_Local/Makefile_&"
2101 .cindex "building Exim" "operating system type"
2102 .cindex "building Exim" "architecture type"
2103 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2104 architecture type. &_Local/Makefile_& is required to exist, and the building
2105 process fails if it is absent. The other three &_Local_& files are optional,
2106 and are often not needed.
2107
2108 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2109 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2110 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2111 values are used, thereby providing a means of forcing particular settings.
2112 Otherwise, the scripts try to get values from the &%uname%& command. If this
2113 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2114 of &'ad hoc'& transformations are then applied, to produce the standard names
2115 that Exim expects. You can run these scripts directly from the shell in order
2116 to find out what values are being used on your system.
2117
2118
2119 &_OS/Makefile-Default_& contains comments about the variables that are set
2120 therein. Some (but not all) are mentioned below. If there is something that
2121 needs changing, review the contents of this file and the contents of the make
2122 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2123 default values are.
2124
2125
2126 .cindex "building Exim" "overriding default settings"
2127 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2128 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2129 need to change the original files. Instead, you should make the changes by
2130 putting the new values in an appropriate &_Local_& file. For example,
2131 .cindex "Tru64-Unix build-time settings"
2132 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2133 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2134 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2135 called with the option &%-std1%&, to make it recognize some of the features of
2136 Standard C that Exim uses. (Most other compilers recognize Standard C by
2137 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2138 containing the lines
2139 .code
2140 CC=cc
2141 CFLAGS=-std1
2142 .endd
2143 If you are compiling for just one operating system, it may be easier to put
2144 these lines directly into &_Local/Makefile_&.
2145
2146 Keeping all your local configuration settings separate from the distributed
2147 files makes it easy to transfer them to new versions of Exim simply by copying
2148 the contents of the &_Local_& directory.
2149
2150
2151 .cindex "NIS lookup type" "including support for"
2152 .cindex "NIS+ lookup type" "including support for"
2153 .cindex "LDAP" "including support for"
2154 .cindex "lookup" "inclusion in binary"
2155 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2156 lookup, but not all systems have these components installed, so the default is
2157 not to include the relevant code in the binary. All the different kinds of file
2158 and database lookup that Exim supports are implemented as separate code modules
2159 which are included only if the relevant compile-time options are set. In the
2160 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2161 .code
2162 LOOKUP_LDAP=yes
2163 LOOKUP_NIS=yes
2164 LOOKUP_NISPLUS=yes
2165 .endd
2166 and similar settings apply to the other lookup types. They are all listed in
2167 &_src/EDITME_&. In many cases the relevant include files and interface
2168 libraries need to be installed before compiling Exim.
2169 .cindex "cdb" "including support for"
2170 However, there are some optional lookup types (such as cdb) for which
2171 the code is entirely contained within Exim, and no external include
2172 files or libraries are required. When a lookup type is not included in the
2173 binary, attempts to configure Exim to use it cause runtime configuration
2174 errors.
2175
2176 .cindex "pkg-config" "lookups"
2177 .cindex "pkg-config" "authenticators"
2178 Many systems now use a tool called &'pkg-config'& to encapsulate information
2179 about how to compile against a library; Exim has some initial support for
2180 being able to use pkg-config for lookups and authenticators.  For any given
2181 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2182 variable with the &`_PC`& suffix in the name and assign as the value the
2183 name of the package to be queried.  The results of querying via the
2184 &'pkg-config'& command will be added to the appropriate Makefile variables
2185 with &`+=`& directives, so your version of &'make'& will need to support that
2186 syntax.  For instance:
2187 .code
2188 LOOKUP_SQLITE=yes
2189 LOOKUP_SQLITE_PC=sqlite3
2190 AUTH_GSASL=yes
2191 AUTH_GSASL_PC=libgsasl
2192 AUTH_HEIMDAL_GSSAPI=yes
2193 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2194 .endd
2195
2196 .cindex "Perl" "including support for"
2197 Exim can be linked with an embedded Perl interpreter, allowing Perl
2198 subroutines to be called during string expansion. To enable this facility,
2199 .code
2200 EXIM_PERL=perl.o
2201 .endd
2202 must be defined in &_Local/Makefile_&. Details of this facility are given in
2203 chapter &<<CHAPperl>>&.
2204
2205 .cindex "X11 libraries, location of"
2206 The location of the X11 libraries is something that varies a lot between
2207 operating systems, and there may be different versions of X11 to cope
2208 with. Exim itself makes no use of X11, but if you are compiling the Exim
2209 monitor, the X11 libraries must be available.
2210 The following three variables are set in &_OS/Makefile-Default_&:
2211 .code
2212 X11=/usr/X11R6
2213 XINCLUDE=-I$(X11)/include
2214 XLFLAGS=-L$(X11)/lib
2215 .endd
2216 These are overridden in some of the operating-system configuration files. For
2217 example, in &_OS/Makefile-SunOS5_& there is
2218 .code
2219 X11=/usr/openwin
2220 XINCLUDE=-I$(X11)/include
2221 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2222 .endd
2223 If you need to override the default setting for your operating system, place a
2224 definition of all three of these variables into your
2225 &_Local/Makefile-<ostype>_& file.
2226
2227 .cindex "EXTRALIBS"
2228 If you need to add any extra libraries to the link steps, these can be put in a
2229 variable called EXTRALIBS, which appears in all the link commands, but by
2230 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2231 command for linking the main Exim binary, and not for any associated utilities.
2232
2233 .cindex "DBM libraries" "configuration for building"
2234 There is also DBMLIB, which appears in the link commands for binaries that
2235 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2236 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2237 binary, and which can be used, for example, to include additional X11
2238 libraries.
2239
2240 .cindex "configuration file" "editing"
2241 The make file copes with rebuilding Exim correctly if any of the configuration
2242 files are edited. However, if an optional configuration file is deleted, it is
2243 necessary to touch the associated non-optional file (that is,
2244 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2245
2246
2247 .section "OS-specific header files" "SECID30"
2248 .cindex "&_os.h_&"
2249 .cindex "building Exim" "OS-specific C header files"
2250 The &_OS_& directory contains a number of files with names of the form
2251 &_os.h-<ostype>_&. These are system-specific C header files that should not
2252 normally need to be changed. There is a list of macro settings that are
2253 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2254 are porting Exim to a new operating system.
2255
2256
2257
2258 .section "Overriding build-time options for the monitor" "SECID31"
2259 .cindex "building Eximon"
2260 A similar process is used for overriding things when building the Exim monitor,
2261 where the files that are involved are
2262 .display
2263 &_OS/eximon.conf-Default_&
2264 &_OS/eximon.conf-_&<&'ostype'&>
2265 &_Local/eximon.conf_&
2266 &_Local/eximon.conf-_&<&'ostype'&>
2267 &_Local/eximon.conf-_&<&'archtype'&>
2268 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2269 .endd
2270 .cindex "&_Local/eximon.conf_&"
2271 As with Exim itself, the final three files need not exist, and in this case the
2272 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2273 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2274 variables of the same name, preceded by EXIMON_. For example, setting
2275 EXIMON_LOG_DEPTH in the environment overrides the value of
2276 LOG_DEPTH at runtime.
2277 .ecindex IIDbuex
2278
2279
2280 .section "Installing Exim binaries and scripts" "SECID32"
2281 .cindex "installing Exim"
2282 .cindex "BIN_DIRECTORY"
2283 The command &`make install`& runs the &(exim_install)& script with no
2284 arguments. The script copies binaries and utility scripts into the directory
2285 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2286 .cindex "setuid" "installing Exim with"
2287 The install script copies files only if they are newer than the files they are
2288 going to replace. The Exim binary is required to be owned by root and have the
2289 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2290 install`& as root so that it can set up the Exim binary in this way. However, in
2291 some special situations (for example, if a host is doing no local deliveries)
2292 it may be possible to run Exim without making the binary setuid root (see
2293 chapter &<<CHAPsecurity>>& for details).
2294
2295 .cindex "CONFIGURE_FILE"
2296 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2297 in &_Local/Makefile_&. If this names a single file, and the file does not
2298 exist, the default configuration file &_src/configure.default_& is copied there
2299 by the installation script. If a runtime configuration file already exists, it
2300 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2301 alternative files, no default is installed.
2302
2303 .cindex "system aliases file"
2304 .cindex "&_/etc/aliases_&"
2305 One change is made to the default configuration file when it is installed: the
2306 default configuration contains a router that references a system aliases file.
2307 The path to this file is set to the value specified by
2308 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2309 If the system aliases file does not exist, the installation script creates it,
2310 and outputs a comment to the user.
2311
2312 The created file contains no aliases, but it does contain comments about the
2313 aliases a site should normally have. Mail aliases have traditionally been
2314 kept in &_/etc/aliases_&. However, some operating systems are now using
2315 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2316 Exim's configuration if necessary.
2317
2318 The default configuration uses the local host's name as the only local domain,
2319 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2320 running as the local user. System aliases and &_.forward_& files in users' home
2321 directories are supported, but no NIS or NIS+ support is configured. Domains
2322 other than the name of the local host are routed using the DNS, with delivery
2323 over SMTP.
2324
2325 It is possible to install Exim for special purposes (such as building a binary
2326 distribution) in a private part of the file system. You can do this by a
2327 command such as
2328 .code
2329 make DESTDIR=/some/directory/ install
2330 .endd
2331 This has the effect of pre-pending the specified directory to all the file
2332 paths, except the name of the system aliases file that appears in the default
2333 configuration. (If a default alias file is created, its name &'is'& modified.)
2334 For backwards compatibility, ROOT is used if DESTDIR is not set,
2335 but this usage is deprecated.
2336
2337 .cindex "installing Exim" "what is not installed"
2338 Running &'make install'& does not copy the Exim 4 conversion script
2339 &'convert4r4'&. You will probably run this only once if you are
2340 upgrading from Exim 3. None of the documentation files in the &_doc_&
2341 directory are copied, except for the info files when you have set
2342 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2343
2344 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2345 to their names. The Exim binary itself, however, is handled differently. It is
2346 installed under a name that includes the version number and the compile number,
2347 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2348 called &_exim_& to point to the binary. If you are updating a previous version
2349 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2350 from the directory (as seen by other processes).
2351
2352 .cindex "installing Exim" "testing the script"
2353 If you want to see what the &'make install'& will do before running it for
2354 real, you can pass the &%-n%& option to the installation script by this
2355 command:
2356 .code
2357 make INSTALL_ARG=-n install
2358 .endd
2359 The contents of the variable INSTALL_ARG are passed to the installation
2360 script. You do not need to be root to run this test. Alternatively, you can run
2361 the installation script directly, but this must be from within the build
2362 directory. For example, from the top-level Exim directory you could use this
2363 command:
2364 .code
2365 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2366 .endd
2367 .cindex "installing Exim" "install script options"
2368 There are two other options that can be supplied to the installation script.
2369
2370 .ilist
2371 &%-no_chown%& bypasses the call to change the owner of the installed binary
2372 to root, and the call to make it a setuid binary.
2373 .next
2374 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2375 installed binary.
2376 .endlist
2377
2378 INSTALL_ARG can be used to pass these options to the script. For example:
2379 .code
2380 make INSTALL_ARG=-no_symlink install
2381 .endd
2382 The installation script can also be given arguments specifying which files are
2383 to be copied. For example, to install just the Exim binary, and nothing else,
2384 without creating the symbolic link, you could use:
2385 .code
2386 make INSTALL_ARG='-no_symlink exim' install
2387 .endd
2388
2389
2390
2391 .section "Installing info documentation" "SECTinsinfdoc"
2392 .cindex "installing Exim" "&'info'& documentation"
2393 Not all systems use the GNU &'info'& system for documentation, and for this
2394 reason, the Texinfo source of Exim's documentation is not included in the main
2395 distribution. Instead it is available separately from the FTP site (see section
2396 &<<SECTavail>>&).
2397
2398 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2399 source of the documentation is found in the source tree, running &`make
2400 install`& automatically builds the info files and installs them.
2401
2402
2403
2404 .section "Setting up the spool directory" "SECID33"
2405 .cindex "spool directory" "creating"
2406 When it starts up, Exim tries to create its spool directory if it does not
2407 exist. The Exim uid and gid are used for the owner and group of the spool
2408 directory. Sub-directories are automatically created in the spool directory as
2409 necessary.
2410
2411
2412
2413
2414 .section "Testing" "SECID34"
2415 .cindex "testing" "installation"
2416 Having installed Exim, you can check that the runtime configuration file is
2417 syntactically valid by running the following command, which assumes that the
2418 Exim binary directory is within your PATH environment variable:
2419 .code
2420 exim -bV
2421 .endd
2422 If there are any errors in the configuration file, Exim outputs error messages.
2423 Otherwise it outputs the version number and build date,
2424 the DBM library that is being used, and information about which drivers and
2425 other optional code modules are included in the binary.
2426 Some simple routing tests can be done by using the address testing option. For
2427 example,
2428 .display
2429 &`exim -bt`& <&'local username'&>
2430 .endd
2431 should verify that it recognizes a local mailbox, and
2432 .display
2433 &`exim -bt`& <&'remote address'&>
2434 .endd
2435 a remote one. Then try getting it to deliver mail, both locally and remotely.
2436 This can be done by passing messages directly to Exim, without going through a
2437 user agent. For example:
2438 .code
2439 exim -v postmaster@your.domain.example
2440 From: user@your.domain.example
2441 To: postmaster@your.domain.example
2442 Subject: Testing Exim
2443
2444 This is a test message.
2445 ^D
2446 .endd
2447 The &%-v%& option causes Exim to output some verification of what it is doing.
2448 In this case you should see copies of three log lines, one for the message's
2449 arrival, one for its delivery, and one containing &"Completed"&.
2450
2451 .cindex "delivery" "problems with"
2452 If you encounter problems, look at Exim's log files (&'mainlog'& and
2453 &'paniclog'&) to see if there is any relevant information there. Another source
2454 of information is running Exim with debugging turned on, by specifying the
2455 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2456 with debugging turned on by a command of the form
2457 .display
2458 &`exim -d -M`& <&'exim-message-id'&>
2459 .endd
2460 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2461 produces rather a lot of output, but you can cut this down to specific areas.
2462 For example, if you use &%-d-all+route%& only the debugging information
2463 relevant to routing is included. (See the &%-d%& option in chapter
2464 &<<CHAPcommandline>>& for more details.)
2465
2466 .cindex '&"sticky"& bit'
2467 .cindex "lock files"
2468 One specific problem that has shown up on some sites is the inability to do
2469 local deliveries into a shared mailbox directory, because it does not have the
2470 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2471 writing to a mailbox file, and if it cannot create the lock file, the delivery
2472 is deferred. You can get round this either by setting the &"sticky bit"& on the
2473 directory, or by setting a specific group for local deliveries and allowing
2474 that group to create files in the directory (see the comments above the
2475 &(local_delivery)& transport in the default configuration file). Another
2476 approach is to configure Exim not to use lock files, but just to rely on
2477 &[fcntl()]& locking instead. However, you should do this only if all user
2478 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2479 see chapter &<<CHAPappendfile>>&.
2480
2481 One thing that cannot be tested on a system that is already running an MTA is
2482 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2483 &%-oX%& option can be used to run an Exim daemon that listens on some other
2484 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2485 &'exim_checkaccess'& utility can be used to check out policy controls on
2486 incoming SMTP mail.
2487
2488 Testing a new version on a system that is already running Exim can most easily
2489 be done by building a binary with a different CONFIGURE_FILE setting. From
2490 within the runtime configuration, all other file and directory names
2491 that Exim uses can be altered, in order to keep it entirely clear of the
2492 production version.
2493
2494
2495 .section "Replacing another MTA with Exim" "SECID35"
2496 .cindex "replacing another MTA"
2497 Building and installing Exim for the first time does not of itself put it in
2498 general use. The name by which the system's MTA is called by mail user agents
2499 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2500 operating system), and it is necessary to make this name point to the &'exim'&
2501 binary in order to get the user agents to pass messages to Exim. This is
2502 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2503 or &_/usr/lib/sendmail_&
2504 .cindex "symbolic link" "to &'exim'& binary"
2505 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2506 privilege and executable status from the old MTA. It is then necessary to stop
2507 and restart the mailer daemon, if one is running.
2508
2509 .cindex "FreeBSD, MTA indirection"
2510 .cindex "&_/etc/mail/mailer.conf_&"
2511 Some operating systems have introduced alternative ways of switching MTAs. For
2512 example, if you are running FreeBSD, you need to edit the file
2513 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2514 described. A typical example of the contents of this file for running Exim is
2515 as follows:
2516 .code
2517 sendmail            /usr/exim/bin/exim
2518 send-mail           /usr/exim/bin/exim
2519 mailq               /usr/exim/bin/exim -bp
2520 newaliases          /usr/bin/true
2521 .endd
2522 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2523 your Exim installation is &"live"&. Check it by sending a message from your
2524 favourite user agent.
2525
2526 You should consider what to tell your users about the change of MTA. Exim may
2527 have different capabilities to what was previously running, and there are
2528 various operational differences such as the text of messages produced by
2529 command line options and in bounce messages. If you allow your users to make
2530 use of Exim's filtering capabilities, you should make the document entitled
2531 &'Exim's interface to mail filtering'& available to them.
2532
2533
2534
2535 .section "Upgrading Exim" "SECID36"
2536 .cindex "upgrading Exim"
2537 If you are already running Exim on your host, building and installing a new
2538 version automatically makes it available to MUAs, or any other programs that
2539 call the MTA directly. However, if you are running an Exim daemon, you do need
2540 .cindex restart "on HUP signal"
2541 .cindex signal "HUP, to restart"
2542 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2543 new binary. You do not need to stop processing mail in order to install a new
2544 version of Exim. The install script does not modify an existing runtime
2545 configuration file.
2546
2547
2548
2549
2550 .section "Stopping the Exim daemon on Solaris" "SECID37"
2551 .cindex "Solaris" "stopping Exim on"
2552 The standard command for stopping the mailer daemon on Solaris is
2553 .code
2554 /etc/init.d/sendmail stop
2555 .endd
2556 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2557 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2558 for the text &"sendmail"&; this is not present because the actual program name
2559 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2560 solution is to replace the line that finds the process id with something like
2561 .code
2562 pid=`cat /var/spool/exim/exim-daemon.pid`
2563 .endd
2564 to obtain the daemon's pid directly from the file that Exim saves it in.
2565
2566 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2567 still be received from local processes, and if automatic delivery is configured
2568 (the normal case), deliveries will still occur.
2569
2570
2571
2572
2573 . ////////////////////////////////////////////////////////////////////////////
2574 . ////////////////////////////////////////////////////////////////////////////
2575
2576 .chapter "The Exim command line" "CHAPcommandline"
2577 .scindex IIDclo1 "command line" "options"
2578 .scindex IIDclo2 "options" "command line"
2579 Exim's command line takes the standard Unix form of a sequence of options,
2580 each starting with a hyphen character, followed by a number of arguments. The
2581 options are compatible with the main options of Sendmail, and there are also
2582 some additional options, some of which are compatible with Smail 3. Certain
2583 combinations of options do not make sense, and provoke an error if used.
2584 The form of the arguments depends on which options are set.
2585
2586
2587 .section "Setting options by program name" "SECID38"
2588 .cindex "&'mailq'&"
2589 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2590 were present before any other options.
2591 The &%-bp%& option requests a listing of the contents of the mail queue on the
2592 standard output.
2593 This feature is for compatibility with some systems that contain a command of
2594 that name in one of the standard libraries, symbolically linked to
2595 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2596
2597 .cindex "&'rsmtp'&"
2598 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2599 were present before any other options, for compatibility with Smail. The
2600 &%-bS%& option is used for reading in a number of messages in batched SMTP
2601 format.
2602
2603 .cindex "&'rmail'&"
2604 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2605 &%-oee%& options were present before any other options, for compatibility with
2606 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2607
2608 .cindex "&'runq'&"
2609 .cindex "queue runner"
2610 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2611 were present before any other options, for compatibility with Smail. The &%-q%&
2612 option causes a single queue runner process to be started.
2613
2614 .cindex "&'newaliases'&"
2615 .cindex "alias file" "building"
2616 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2617 If Exim is called under the name &'newaliases'& it behaves as if the option
2618 &%-bi%& were present before any other options, for compatibility with Sendmail.
2619 This option is used for rebuilding Sendmail's alias file. Exim does not have
2620 the concept of a single alias file, but can be configured to run a given
2621 command if called with the &%-bi%& option.
2622
2623
2624 .section "Trusted and admin users" "SECTtrustedadmin"
2625 Some Exim options are available only to &'trusted users'& and others are
2626 available only to &'admin users'&. In the description below, the phrases &"Exim
2627 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2628 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2629 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2630
2631 .ilist
2632 .cindex "trusted users" "definition of"
2633 .cindex "user" "trusted definition of"
2634 The trusted users are root, the Exim user, any user listed in the
2635 &%trusted_users%& configuration option, and any user whose current group or any
2636 supplementary group is one of those listed in the &%trusted_groups%&
2637 configuration option. Note that the Exim group is not automatically trusted.
2638
2639 .cindex '&"From"& line'
2640 .cindex "envelope from"
2641 .cindex "envelope sender"
2642 Trusted users are always permitted to use the &%-f%& option or a leading
2643 &"From&~"& line to specify the envelope sender of a message that is passed to
2644 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2645 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2646 users to set envelope senders.
2647
2648 .cindex "&'From:'& header line"
2649 .cindex "&'Sender:'& header line"
2650 .cindex "header lines" "From:"
2651 .cindex "header lines" "Sender:"
2652 For a trusted user, there is never any check on the contents of the &'From:'&
2653 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2654 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2655
2656 Trusted users may also specify a host name, host address, interface address,
2657 protocol name, ident value, and authentication data when submitting a message
2658 locally. Thus, they are able to insert messages into Exim's queue locally that
2659 have the characteristics of messages received from a remote host. Untrusted
2660 users may in some circumstances use &%-f%&, but can never set the other values
2661 that are available to trusted users.
2662 .next
2663 .cindex "user" "admin definition of"
2664 .cindex "admin user" "definition of"
2665 The admin users are root, the Exim user, and any user that is a member of the
2666 Exim group or of any group listed in the &%admin_groups%& configuration option.
2667 The current group does not have to be one of these groups.
2668
2669 Admin users are permitted to list the queue, and to carry out certain
2670 operations on messages, for example, to force delivery failures. It is also
2671 necessary to be an admin user in order to see the full information provided by
2672 the Exim monitor, and full debugging output.
2673
2674 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2675 Exim to attempt delivery of messages on its queue is restricted to admin users.
2676 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2677 option false (that is, specifying &%no_prod_requires_admin%&).
2678
2679 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2680 is restricted to admin users unless &%queue_list_requires_admin%& is set
2681 false.
2682 .endlist
2683
2684
2685 &*Warning*&: If you configure your system so that admin users are able to
2686 edit Exim's configuration file, you are giving those users an easy way of
2687 getting root. There is further discussion of this issue at the start of chapter
2688 &<<CHAPconf>>&.
2689
2690
2691
2692
2693 .section "Command line options" "SECID39"
2694 Exim's command line options are described in alphabetical order below. If none
2695 of the options that specifies a specific action (such as starting the daemon or
2696 a queue runner, or testing an address, or receiving a message in a specific
2697 format, or listing the queue) are present, and there is at least one argument
2698 on the command line, &%-bm%& (accept a local message on the standard input,
2699 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2700 outputs a brief message about itself and exits.
2701
2702 . ////////////////////////////////////////////////////////////////////////////
2703 . Insert a stylized XML comment here, to identify the start of the command line
2704 . options. This is for the benefit of the Perl script that automatically
2705 . creates a man page for the options.
2706 . ////////////////////////////////////////////////////////////////////////////
2707
2708 .literal xml
2709 <!-- === Start of command line options === -->
2710 .literal off
2711
2712
2713 .vlist
2714 .vitem &%--%&
2715 .oindex "--"
2716 .cindex "options" "command line; terminating"
2717 This is a pseudo-option whose only purpose is to terminate the options and
2718 therefore to cause subsequent command line items to be treated as arguments
2719 rather than options, even if they begin with hyphens.
2720
2721 .vitem &%--help%&
2722 .oindex "&%--help%&"
2723 This option causes Exim to output a few sentences stating what it is.
2724 The same output is generated if the Exim binary is called with no options and
2725 no arguments.
2726
2727 .vitem &%--version%&
2728 .oindex "&%--version%&"
2729 This option is an alias for &%-bV%& and causes version information to be
2730 displayed.
2731
2732 .vitem &%-Ac%& &&&
2733        &%-Am%&
2734 .oindex "&%-Ac%&"
2735 .oindex "&%-Am%&"
2736 These options are used by Sendmail for selecting configuration files and are
2737 ignored by Exim.
2738
2739 .vitem &%-B%&<&'type'&>
2740 .oindex "&%-B%&"
2741 .cindex "8-bit characters"
2742 .cindex "Sendmail compatibility" "8-bit characters"
2743 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2744 clean; it ignores this option.
2745
2746 .vitem &%-bd%&
2747 .oindex "&%-bd%&"
2748 .cindex "daemon"
2749 .cindex "SMTP" "listener"
2750 .cindex "queue runner"
2751 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2752 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2753 that the daemon should also initiate periodic queue runs.
2754
2755 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2756 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2757 disconnect from the controlling terminal. When running this way, it can be
2758 stopped by pressing ctrl-C.
2759
2760 By default, Exim listens for incoming connections to the standard SMTP port on
2761 all the host's running interfaces. However, it is possible to listen on other
2762 ports, on multiple ports, and only on specific interfaces. Chapter
2763 &<<CHAPinterfaces>>& contains a description of the options that control this.
2764
2765 When a listening daemon
2766 .cindex "daemon" "process id (pid)"
2767 .cindex "pid (process id)" "of daemon"
2768 is started without the use of &%-oX%& (that is, without overriding the normal
2769 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2770 in Exim's spool directory. This location can be overridden by setting
2771 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2772 running as root.
2773
2774 When &%-oX%& is used on the command line to start a listening daemon, the
2775 process id is not written to the normal pid file path. However, &%-oP%& can be
2776 used to specify a path on the command line if a pid file is required.
2777
2778 The SIGHUP signal
2779 .cindex "SIGHUP"
2780 .cindex restart "on HUP signal"
2781 .cindex signal "HUP, to restart"
2782 .cindex "daemon" "restarting"
2783 .cindex signal "to reload configuration"
2784 .cindex daemon "reload configuration"
2785 .cindex reload configuration
2786 can be used to cause the daemon to re-execute itself. This should be done
2787 whenever Exim's configuration file, or any file that is incorporated into it by
2788 means of the &%.include%& facility, is changed, and also whenever a new version
2789 of Exim is installed. It is not necessary to do this when other files that are
2790 referenced from the configuration (for example, alias files) are changed,
2791 because these are reread each time they are used.
2792
2793 .vitem &%-bdf%&
2794 .oindex "&%-bdf%&"
2795 This option has the same effect as &%-bd%& except that it never disconnects
2796 from the controlling terminal, even when no debugging is specified.
2797
2798 .vitem &%-be%&
2799 .oindex "&%-be%&"
2800 .cindex "testing" "string expansion"
2801 .cindex "expansion" "testing"
2802 Run Exim in expansion testing mode. Exim discards its root privilege, to
2803 prevent ordinary users from using this mode to read otherwise inaccessible
2804 files. If no arguments are given, Exim runs interactively, prompting for lines
2805 of data. Otherwise, it processes each argument in turn.
2806
2807 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2808 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2809 used without command line arguments. If successful, it uses the &[readline()]&
2810 function, which provides extensive line-editing facilities, for reading the
2811 test data. A line history is supported.
2812
2813 Long expansion expressions can be split over several lines by using backslash
2814 continuations. As in Exim's runtime configuration, white space at the start of
2815 continuation lines is ignored. Each argument or data line is passed through the
2816 string expansion mechanism, and the result is output. Variable values from the
2817 configuration file (for example, &$qualify_domain$&) are available, but no
2818 message-specific values (such as &$message_exim_id$&) are set, because no message
2819 is being processed (but see &%-bem%& and &%-Mset%&).
2820
2821 &*Note*&: If you use this mechanism to test lookups, and you change the data
2822 files or databases you are using, you must exit and restart Exim before trying
2823 the same lookup again. Otherwise, because each Exim process caches the results
2824 of lookups, you will just get the same result as before.
2825
2826 Macro processing is done on lines before string-expansion: new macros can be
2827 defined and macros will be expanded.
2828 Because macros in the config file are often used for secrets, those are only
2829 available to admin users.
2830
2831 .vitem &%-bem%&&~<&'filename'&>
2832 .oindex "&%-bem%&"
2833 .cindex "testing" "string expansion"
2834 .cindex "expansion" "testing"
2835 This option operates like &%-be%& except that it must be followed by the name
2836 of a file. For example:
2837 .code
2838 exim -bem /tmp/testmessage
2839 .endd
2840 The file is read as a message (as if receiving a locally-submitted non-SMTP
2841 message) before any of the test expansions are done. Thus, message-specific
2842 variables such as &$message_size$& and &$header_from:$& are available. However,
2843 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2844 recipients are read from the headers in the normal way, and are shown in the
2845 &$recipients$& variable. Note that recipients cannot be given on the command
2846 line, because further arguments are taken as strings to expand (just like
2847 &%-be%&).
2848
2849 .vitem &%-bF%&&~<&'filename'&>
2850 .oindex "&%-bF%&"
2851 .cindex "system filter" "testing"
2852 .cindex "testing" "system filter"
2853 This option is the same as &%-bf%& except that it assumes that the filter being
2854 tested is a system filter. The additional commands that are available only in
2855 system filters are recognized.
2856
2857 .vitem &%-bf%&&~<&'filename'&>
2858 .oindex "&%-bf%&"
2859 .cindex "filter" "testing"
2860 .cindex "testing" "filter file"
2861 .cindex "forward file" "testing"
2862 .cindex "testing" "forward file"
2863 .cindex "Sieve filter" "testing"
2864 This option runs Exim in user filter testing mode; the file is the filter file
2865 to be tested, and a test message must be supplied on the standard input. If
2866 there are no message-dependent tests in the filter, an empty file can be
2867 supplied.
2868
2869 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2870 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2871 filter and a user filter in the same run. For example:
2872 .code
2873 exim -bF /system/filter -bf /user/filter </test/message
2874 .endd
2875 This is helpful when the system filter adds header lines or sets filter
2876 variables that are used by the user filter.
2877
2878 If the test filter file does not begin with one of the special lines
2879 .code
2880 # Exim filter
2881 # Sieve filter
2882 .endd
2883 it is taken to be a normal &_.forward_& file, and is tested for validity under
2884 that interpretation. See sections &<<SECTitenonfilred>>& to
2885 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2886 redirection lists.
2887
2888 The result of an Exim command that uses &%-bf%&, provided no errors are
2889 detected, is a list of the actions that Exim would try to take if presented
2890 with the message for real. More details of filter testing are given in the
2891 separate document entitled &'Exim's interfaces to mail filtering'&.
2892
2893 When testing a filter file,
2894 .cindex "&""From""& line"
2895 .cindex "envelope from"
2896 .cindex "envelope sender"
2897 .oindex "&%-f%&" "for filter testing"
2898 the envelope sender can be set by the &%-f%& option,
2899 or by a &"From&~"& line at the start of the test message. Various parameters
2900 that would normally be taken from the envelope recipient address of the message
2901 can be set by means of additional command line options (see the next four
2902 options).
2903
2904 .vitem &%-bfd%&&~<&'domain'&>
2905 .oindex "&%-bfd%&"
2906 .vindex "&$qualify_domain$&"
2907 This sets the domain of the recipient address when a filter file is being
2908 tested by means of the &%-bf%& option. The default is the value of
2909 &$qualify_domain$&.
2910
2911 .vitem &%-bfl%&&~<&'local&~part'&>
2912 .oindex "&%-bfl%&"
2913 This sets the local part of the recipient address when a filter file is being
2914 tested by means of the &%-bf%& option. The default is the username of the
2915 process that calls Exim. A local part should be specified with any prefix or
2916 suffix stripped, because that is how it appears to the filter when a message is
2917 actually being delivered.
2918
2919 .vitem &%-bfp%&&~<&'prefix'&>
2920 .oindex "&%-bfp%&"
2921 .cindex affix "filter testing"
2922 This sets the prefix of the local part of the recipient address when a filter
2923 file is being tested by means of the &%-bf%& option. The default is an empty
2924 prefix.
2925
2926 .vitem &%-bfs%&&~<&'suffix'&>
2927 .oindex "&%-bfs%&"
2928 .cindex affix "filter testing"
2929 This sets the suffix of the local part of the recipient address when a filter
2930 file is being tested by means of the &%-bf%& option. The default is an empty
2931 suffix.
2932
2933 .vitem &%-bh%&&~<&'IP&~address'&>
2934 .oindex "&%-bh%&"
2935 .cindex "testing" "incoming SMTP"
2936 .cindex "SMTP" "testing incoming"
2937 .cindex "testing" "relay control"
2938 .cindex "relaying" "testing configuration"
2939 .cindex "policy control" "testing"
2940 .cindex "debugging" "&%-bh%& option"
2941 This option runs a fake SMTP session as if from the given IP address, using the
2942 standard input and output. The IP address may include a port number at the end,
2943 after a full stop. For example:
2944 .code
2945 exim -bh 10.9.8.7.1234
2946 exim -bh fe80::a00:20ff:fe86:a061.5678
2947 .endd
2948 When an IPv6 address is given, it is converted into canonical form. In the case
2949 of the second example above, the value of &$sender_host_address$& after
2950 conversion to the canonical form is
2951 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2952
2953 Comments as to what is going on are written to the standard error file. These
2954 include lines beginning with &"LOG"& for anything that would have been logged.
2955 This facility is provided for testing configuration options for incoming
2956 messages, to make sure they implement the required policy. For example, you can
2957 test your relay controls using &%-bh%&.
2958
2959 &*Warning 1*&:
2960 .cindex "RFC 1413"
2961 You can test features of the configuration that rely on ident (RFC 1413)
2962 information by using the &%-oMt%& option. However, Exim cannot actually perform
2963 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2964 connection.
2965
2966 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2967 are also skipped when testing using &%-bh%&. If you want these callouts to
2968 occur, use &%-bhc%& instead.
2969
2970 Messages supplied during the testing session are discarded, and nothing is
2971 written to any of the real log files. There may be pauses when DNS (and other)
2972 lookups are taking place, and of course these may time out. The &%-oMi%& option
2973 can be used to specify a specific IP interface and port if this is important,
2974 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2975 session were authenticated.
2976
2977 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2978 output just states whether a given recipient address from a given host is
2979 acceptable or not. See section &<<SECTcheckaccess>>&.
2980
2981 Features such as authentication and encryption, where the client input is not
2982 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2983 specialized SMTP test program such as
2984 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2985
2986 .vitem &%-bhc%&&~<&'IP&~address'&>
2987 .oindex "&%-bhc%&"
2988 This option operates in the same way as &%-bh%&, except that address
2989 verification callouts are performed if required. This includes consulting and
2990 updating the callout cache database.
2991
2992 .vitem &%-bi%&
2993 .oindex "&%-bi%&"
2994 .cindex "alias file" "building"
2995 .cindex "building alias file"
2996 .cindex "Sendmail compatibility" "&%-bi%& option"
2997 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2998 Exim does not have the concept of a single alias file, and so it cannot mimic
2999 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3000 tend to appear in various scripts such as NIS make files, so the option must be
3001 recognized.
3002
3003 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3004 configuration option is run, under the uid and gid of the caller of Exim. If
3005 the &%-oA%& option is used, its value is passed to the command as an argument.
3006 The command set by &%bi_command%& may not contain arguments. The command can
3007 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3008 if this is required. If the &%bi_command%& option is not set, calling Exim with
3009 &%-bi%& is a no-op.
3010
3011 . // Keep :help first, then the rest in alphabetical order
3012 .vitem &%-bI:help%&
3013 .oindex "&%-bI:help%&"
3014 .cindex "querying exim information"
3015 We shall provide various options starting &`-bI:`& for querying Exim for
3016 information.  The output of many of these will be intended for machine
3017 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3018 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3019 options shall cause Exim to exit after producing the requested output.
3020
3021 .vitem &%-bI:dscp%&
3022 .oindex "&%-bI:dscp%&"
3023 .cindex "DSCP" "values"
3024 This option causes Exim to emit an alphabetically sorted list of all
3025 recognised DSCP names.
3026
3027 .vitem &%-bI:sieve%&
3028 .oindex "&%-bI:sieve%&"
3029 .cindex "Sieve filter" "capabilities"
3030 This option causes Exim to emit an alphabetically sorted list of all supported
3031 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3032 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3033 &`SIEVE`& capability response line.  As the precise list may depend upon
3034 compile-time build options, which this option will adapt to, this is the only
3035 way to guarantee a correct response.
3036
3037 .vitem &%-bm%&
3038 .oindex "&%-bm%&"
3039 .cindex "local message reception"
3040 This option runs an Exim receiving process that accepts an incoming,
3041 locally-generated message on the standard input. The recipients are given as the
3042 command arguments (except when &%-t%& is also present &-- see below). Each
3043 argument can be a comma-separated list of RFC 2822 addresses. This is the
3044 default option for selecting the overall action of an Exim call; it is assumed
3045 if no other conflicting option is present.
3046
3047 If any addresses in the message are unqualified (have no domain), they are
3048 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3049 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3050 suppressing this for special cases.
3051
3052 Policy checks on the contents of local messages can be enforced by means of
3053 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3054
3055 .cindex "return code" "for &%-bm%&"
3056 The return code is zero if the message is successfully accepted. Otherwise, the
3057 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3058
3059 The format
3060 .cindex "message" "format"
3061 .cindex "format" "message"
3062 .cindex "&""From""& line"
3063 .cindex "UUCP" "&""From""& line"
3064 .cindex "Sendmail compatibility" "&""From""& line"
3065 of the message must be as defined in RFC 2822, except that, for
3066 compatibility with Sendmail and Smail, a line in one of the forms
3067 .code
3068 From sender Fri Jan  5 12:55 GMT 1997
3069 From sender Fri, 5 Jan 97 12:55:01
3070 .endd
3071 (with the weekday optional, and possibly with additional text after the date)
3072 is permitted to appear at the start of the message. There appears to be no
3073 authoritative specification of the format of this line. Exim recognizes it by
3074 matching against the regular expression defined by the &%uucp_from_pattern%&
3075 option, which can be changed if necessary.
3076
3077 .oindex "&%-f%&" "overriding &""From""& line"
3078 The specified sender is treated as if it were given as the argument to the
3079 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3080 preference to the address taken from the message. The caller of Exim must be a
3081 trusted user for the sender of a message to be set in this way.
3082
3083 .vitem &%-bmalware%&&~<&'filename'&>
3084 .oindex "&%-bmalware%&"
3085 .cindex "testing", "malware"
3086 .cindex "malware scan test"
3087 This debugging option causes Exim to scan the given file or directory
3088 (depending on the used scanner interface),
3089 using the malware scanning framework.  The option of &%av_scanner%& influences
3090 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3091 the expansion should have defaults which apply to this invocation.  ACLs are
3092 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3093 will never be populated and &%-bmalware%& will fail.
3094
3095 Exim will have changed working directory before resolving the filename, so
3096 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3097 user when it tries to open the file, rather than as the invoking user.
3098 This option requires admin privileges.
3099
3100 The &%-bmalware%& option will not be extended to be more generally useful,
3101 there are better tools for file-scanning.  This option exists to help
3102 administrators verify their Exim and AV scanner configuration.
3103
3104 .vitem &%-bnq%&
3105 .oindex "&%-bnq%&"
3106 .cindex "address qualification, suppressing"
3107 By default, Exim automatically qualifies unqualified addresses (those
3108 without domains) that appear in messages that are submitted locally (that
3109 is, not over TCP/IP). This qualification applies both to addresses in
3110 envelopes, and addresses in header lines. Sender addresses are qualified using
3111 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3112 defaults to the value of &%qualify_domain%&).
3113
3114 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3115 being used to re-submit messages that originally came from remote hosts after
3116 content scanning, you probably do not want to qualify unqualified addresses in
3117 header lines. (Such lines will be present only if you have not enabled a header
3118 syntax check in the appropriate ACL.)
3119
3120 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3121 messages that originate on the local host. When this is used, unqualified
3122 addresses in the envelope provoke errors (causing message rejection) and
3123 unqualified addresses in header lines are left alone.
3124
3125
3126 .vitem &%-bP%&
3127 .oindex "&%-bP%&"
3128 .cindex "configuration options" "extracting"
3129 .cindex "options" "configuration &-- extracting"
3130 If this option is given with no arguments, it causes the values of all Exim's
3131 main configuration options to be written to the standard output. The values
3132 of one or more specific options can be requested by giving their names as
3133 arguments, for example:
3134 .code
3135 exim -bP qualify_domain hold_domains
3136 .endd
3137 .cindex "hiding configuration option values"
3138 .cindex "configuration options" "hiding value of"
3139 .cindex "options" "hiding value of"
3140 However, any option setting that is preceded by the word &"hide"& in the
3141 configuration file is not shown in full, except to an admin user. For other
3142 users, the output is as in this example:
3143 .code
3144 mysql_servers = <value not displayable>
3145 .endd
3146 If &%config%& is given as an argument, the config is
3147 output, as it was parsed, any include file resolved, any comment removed.
3148
3149 If &%config_file%& is given as an argument, the name of the runtime
3150 configuration file is output. (&%configure_file%& works too, for
3151 backward compatibility.)
3152 If a list of configuration files was supplied, the value that is output here
3153 is the name of the file that was actually used.
3154
3155 .cindex "options" "hiding name of"
3156 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3157 name will not be output.
3158
3159 .cindex "daemon" "process id (pid)"
3160 .cindex "pid (process id)" "of daemon"
3161 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3162 directories where log files and daemon pid files are written are output,
3163 respectively. If these values are unset, log files are written in a
3164 sub-directory of the spool directory called &%log%&, and the pid file is
3165 written directly into the spool directory.
3166
3167 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3168 .code
3169 exim -bP +local_domains
3170 .endd
3171 it searches for a matching named list of any type (domain, host, address, or
3172 local part) and outputs what it finds.
3173
3174 .cindex "options" "router &-- extracting"
3175 .cindex "options" "transport &-- extracting"
3176 .cindex "options" "authenticator &-- extracting"
3177 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3178 followed by the name of an appropriate driver instance, the option settings for
3179 that driver are output. For example:
3180 .code
3181 exim -bP transport local_delivery
3182 .endd
3183 The generic driver options are output first, followed by the driver's private
3184 options. A list of the names of drivers of a particular type can be obtained by
3185 using one of the words &%router_list%&, &%transport_list%&, or
3186 &%authenticator_list%&, and a complete list of all drivers with their option
3187 settings can be obtained by using &%routers%&, &%transports%&, or
3188 &%authenticators%&.
3189
3190 .cindex "environment"
3191 If &%environment%& is given as an argument, the set of environment
3192 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3193 variables.
3194
3195 .cindex "options" "macro &-- extracting"
3196 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3197 are available, similarly to the drivers.  Because macros are sometimes used
3198 for storing passwords, this option is restricted.
3199 The output format is one item per line.
3200 For the "-bP macro <name>" form, if no such macro is found
3201 the exit status will be nonzero.
3202
3203 .vitem &%-bp%&
3204 .oindex "&%-bp%&"
3205 .cindex "queue" "listing messages in"
3206 .cindex "listing" "messages in the queue"
3207 This option requests a listing of the contents of the mail queue on the
3208 standard output. If the &%-bp%& option is followed by a list of message ids,
3209 just those messages are listed. By default, this option can be used only by an
3210 admin user. However, the &%queue_list_requires_admin%& option can be set false
3211 to allow any user to see the queue.
3212
3213 Each message in the queue is displayed as in the following example:
3214 .code
3215 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3216           red.king@looking-glass.fict.example
3217           <other addresses>
3218 .endd
3219 .cindex "message" "size in queue listing"
3220 .cindex "size" "of message"
3221 The first line contains the length of time the message has been in the queue
3222 (in this case 25 minutes), the size of the message (2.9K), the unique local
3223 identifier for the message, and the message sender, as contained in the
3224 envelope. For bounce messages, the sender address is empty, and appears as
3225 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3226 the default sender address, the user's login name is shown in parentheses
3227 before the sender address.
3228
3229 .cindex "frozen messages" "in queue listing"
3230 If the message is frozen (attempts to deliver it are suspended) then the text
3231 &"*** frozen ***"& is displayed at the end of this line.
3232
3233 The recipients of the message (taken from the envelope, not the headers) are
3234 displayed on subsequent lines. Those addresses to which the message has already
3235 been delivered are marked with the letter D. If an original address gets
3236 expanded into several addresses via an alias or forward file, the original is
3237 displayed with a D only when deliveries for all of its child addresses are
3238 complete.
3239
3240
3241 .vitem &%-bpa%&
3242 .oindex "&%-bpa%&"
3243 This option operates like &%-bp%&, but in addition it shows delivered addresses
3244 that were generated from the original top level address(es) in each message by
3245 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3246 of just &"D"&.
3247
3248
3249 .vitem &%-bpc%&
3250 .oindex "&%-bpc%&"
3251 .cindex "queue" "count of messages on"
3252 This option counts the number of messages in the queue, and writes the total
3253 to the standard output. It is restricted to admin users, unless
3254 &%queue_list_requires_admin%& is set false.
3255
3256
3257 .vitem &%-bpr%&
3258 .oindex "&%-bpr%&"
3259 This option operates like &%-bp%&, but the output is not sorted into
3260 chronological order of message arrival. This can speed it up when there are
3261 lots of messages in the queue, and is particularly useful if the output is
3262 going to be post-processed in a way that doesn't need the sorting.
3263
3264 .vitem &%-bpra%&
3265 .oindex "&%-bpra%&"
3266 This option is a combination of &%-bpr%& and &%-bpa%&.
3267
3268 .vitem &%-bpru%&
3269 .oindex "&%-bpru%&"
3270 This option is a combination of &%-bpr%& and &%-bpu%&.
3271
3272
3273 .vitem &%-bpu%&
3274 .oindex "&%-bpu%&"
3275 This option operates like &%-bp%& but shows only undelivered top-level
3276 addresses for each message displayed. Addresses generated by aliasing or
3277 forwarding are not shown, unless the message was deferred after processing by a
3278 router with the &%one_time%& option set.
3279
3280
3281 .vitem &%-brt%&
3282 .oindex "&%-brt%&"
3283 .cindex "testing" "retry configuration"
3284 .cindex "retry" "configuration testing"
3285 This option is for testing retry rules, and it must be followed by up to three
3286 arguments. It causes Exim to look for a retry rule that matches the values
3287 and to write it to the standard output. For example:
3288 .code
3289 exim -brt bach.comp.mus.example
3290 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3291 .endd
3292 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3293 argument, which is required, can be a complete address in the form
3294 &'local_part@domain'&, or it can be just a domain name. If the second argument
3295 contains a dot, it is interpreted as an optional second domain name; if no
3296 retry rule is found for the first argument, the second is tried. This ties in
3297 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3298 rule is found that matches the host, one that matches the mail domain is
3299 sought. Finally, an argument that is the name of a specific delivery error, as
3300 used in setting up retry rules, can be given. For example:
3301 .code
3302 exim -brt haydn.comp.mus.example quota_3d
3303 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3304 .endd
3305
3306 .vitem &%-brw%&
3307 .oindex "&%-brw%&"
3308 .cindex "testing" "rewriting"
3309 .cindex "rewriting" "testing"
3310 This option is for testing address rewriting rules, and it must be followed by
3311 a single argument, consisting of either a local part without a domain, or a
3312 complete address with a fully qualified domain. Exim outputs how this address
3313 would be rewritten for each possible place it might appear. See chapter
3314 &<<CHAPrewrite>>& for further details.
3315
3316 .vitem &%-bS%&
3317 .oindex "&%-bS%&"
3318 .cindex "SMTP" "batched incoming"
3319 .cindex "batched SMTP input"
3320 This option is used for batched SMTP input, which is an alternative interface
3321 for non-interactive local message submission. A number of messages can be
3322 submitted in a single run. However, despite its name, this is not really SMTP
3323 input. Exim reads each message's envelope from SMTP commands on the standard
3324 input, but generates no responses. If the caller is trusted, or
3325 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3326 believed; otherwise the sender is always the caller of Exim.
3327
3328 The message itself is read from the standard input, in SMTP format (leading
3329 dots doubled), terminated by a line containing just a single dot. An error is
3330 provoked if the terminating dot is missing. A further message may then follow.
3331
3332 As for other local message submissions, the contents of incoming batch SMTP
3333 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3334 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3335 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3336
3337 Some other SMTP commands are recognized in the input. HELO and EHLO act
3338 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3339 QUIT quits, ignoring the rest of the standard input.
3340
3341 .cindex "return code" "for &%-bS%&"
3342 If any error is encountered, reports are written to the standard output and
3343 error streams, and Exim gives up immediately. The return code is 0 if no error
3344 was detected; it is 1 if one or more messages were accepted before the error
3345 was detected; otherwise it is 2.
3346
3347 More details of input using batched SMTP are given in section
3348 &<<SECTincomingbatchedSMTP>>&.
3349
3350 .vitem &%-bs%&
3351 .oindex "&%-bs%&"
3352 .cindex "SMTP" "local input"
3353 .cindex "local SMTP input"
3354 This option causes Exim to accept one or more messages by reading SMTP commands
3355 on the standard input, and producing SMTP replies on the standard output. SMTP
3356 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3357 Some user agents use this interface as a way of passing locally-generated
3358 messages to the MTA.
3359
3360 In
3361 .cindex "sender" "source of"
3362 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3363 set, the senders of messages are taken from the SMTP MAIL commands.
3364 Otherwise the content of these commands is ignored and the sender is set up as
3365 the calling user. Unqualified addresses are automatically qualified using
3366 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3367 &%-bnq%& option is used.
3368
3369 .cindex "inetd"
3370 The
3371 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3372 using a listening daemon. Exim can distinguish the two cases by checking
3373 whether the standard input is a TCP/IP socket. When Exim is called from
3374 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3375 above concerning senders and qualification do not apply. In this situation,
3376 Exim behaves in exactly the same way as it does when receiving a message via
3377 the listening daemon.
3378
3379 .vitem &%-bt%&
3380 .oindex "&%-bt%&"
3381 .cindex "testing" "addresses"
3382 .cindex "address" "testing"
3383 This option runs Exim in address testing mode, in which each argument is taken
3384 as a recipient address to be tested for deliverability. The results are
3385 written to the standard output. If a test fails, and the caller is not an admin
3386 user, no details of the failure are output, because these might contain
3387 sensitive information such as usernames and passwords for database lookups.
3388
3389 If no arguments are given, Exim runs in an interactive manner, prompting with a
3390 right angle bracket for addresses to be tested.
3391
3392 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3393 &[readline()]& function, because it is running as &'root'& and there are
3394 security issues.
3395
3396 Each address is handled as if it were the recipient address of a message
3397 (compare the &%-bv%& option). It is passed to the routers and the result is
3398 written to the standard output. However, any router that has
3399 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3400 genuine routing tests if your first router passes everything to a scanner
3401 program.
3402
3403 .cindex "return code" "for &%-bt%&"
3404 The return code is 2 if any address failed outright; it is 1 if no address
3405 failed outright but at least one could not be resolved for some reason. Return
3406 code 0 is given only when all addresses succeed.
3407
3408 .cindex "duplicate addresses"
3409 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3410 addresses after routing is complete, so that only one delivery takes place.
3411 This does not happen when testing with &%-bt%&; the full results of routing are
3412 always shown.
3413
3414 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3415 routers in the configuration makes any tests on the sender address of a
3416 message,
3417 .oindex "&%-f%&" "for address testing"
3418 you can use the &%-f%& option to set an appropriate sender when running
3419 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3420 default qualifying domain. However, if you have set up (for example) routers
3421 whose behaviour depends on the contents of an incoming message, you cannot test
3422 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3423 doing such tests.
3424
3425 .vitem &%-bV%&
3426 .oindex "&%-bV%&"
3427 .cindex "version number of Exim"
3428 This option causes Exim to write the current version number, compilation
3429 number, and compilation date of the &'exim'& binary to the standard output.
3430 It also lists the DBM library that is being used, the optional modules (such as
3431 specific lookup types), the drivers that are included in the binary, and the
3432 name of the runtime configuration file that is in use.
3433
3434 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3435 configuration file. However, this is a static check only. It cannot check
3436 values that are to be expanded. For example, although a misspelt ACL verb is
3437 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3438 alone to discover (for example) all the typos in the configuration; some
3439 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3440 dynamic testing facilities.
3441
3442 .vitem &%-bv%&
3443 .oindex "&%-bv%&"
3444 .cindex "verifying address" "using &%-bv%&"
3445 .cindex "address" "verification"
3446 This option runs Exim in address verification mode, in which each argument is
3447 taken as a recipient address to be verified by the routers. (This does
3448 not involve any verification callouts). During normal operation, verification
3449 happens mostly as a consequence processing a &%verify%& condition in an ACL
3450 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3451 including callouts, see the &%-bh%& and &%-bhc%& options.
3452
3453 If verification fails, and the caller is not an admin user, no details of the
3454 failure are output, because these might contain sensitive information such as
3455 usernames and passwords for database lookups.
3456
3457 If no arguments are given, Exim runs in an interactive manner, prompting with a
3458 right angle bracket for addresses to be verified.
3459
3460 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3461 &[readline()]& function, because it is running as &'exim'& and there are
3462 security issues.
3463
3464 Verification differs from address testing (the &%-bt%& option) in that routers
3465 that have &%no_verify%& set are skipped, and if the address is accepted by a
3466 router that has &%fail_verify%& set, verification fails. The address is
3467 verified as a recipient if &%-bv%& is used; to test verification for a sender
3468 address, &%-bvs%& should be used.
3469
3470 If the &%-v%& option is not set, the output consists of a single line for each
3471 address, stating whether it was verified or not, and giving a reason in the
3472 latter case. Without &%-v%&, generating more than one address by redirection
3473 causes verification to end successfully, without considering the generated
3474 addresses. However, if just one address is generated, processing continues,
3475 and the generated address must verify successfully for the overall verification
3476 to succeed.
3477
3478 When &%-v%& is set, more details are given of how the address has been handled,
3479 and in the case of address redirection, all the generated addresses are also
3480 considered. Verification may succeed for some and fail for others.
3481
3482 The
3483 .cindex "return code" "for &%-bv%&"
3484 return code is 2 if any address failed outright; it is 1 if no address
3485 failed outright but at least one could not be resolved for some reason. Return
3486 code 0 is given only when all addresses succeed.
3487
3488 If any of the routers in the configuration makes any tests on the sender
3489 address of a message, you should use the &%-f%& option to set an appropriate
3490 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3491 calling user at the default qualifying domain.
3492
3493 .vitem &%-bvs%&
3494 .oindex "&%-bvs%&"
3495 This option acts like &%-bv%&, but verifies the address as a sender rather
3496 than a recipient address. This affects any rewriting and qualification that
3497 might happen.
3498
3499 .vitem &%-bw%&
3500 .oindex "&%-bw%&"
3501 .cindex "daemon"
3502 .cindex "inetd"
3503 .cindex "inetd" "wait mode"
3504 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3505 similarly to the &%-bd%& option.  All port specifications on the command-line
3506 and in the configuration file are ignored.  Queue-running may not be specified.
3507
3508 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3509 listening for connections.  This permits the system to start up and have
3510 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3511 each port only when the first connection is received.
3512
3513 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3514 which the daemon will exit, which should cause inetd to listen once more.
3515
3516 .vitem &%-C%&&~<&'filelist'&>
3517 .oindex "&%-C%&"
3518 .cindex "configuration file" "alternate"
3519 .cindex "CONFIGURE_FILE"
3520 .cindex "alternate configuration file"
3521 This option causes Exim to find the runtime configuration file from the given
3522 list instead of from the list specified by the CONFIGURE_FILE
3523 compile-time setting. Usually, the list will consist of just a single filename,
3524 but it can be a colon-separated list of names. In this case, the first
3525 file that exists is used. Failure to open an existing file stops Exim from
3526 proceeding any further along the list, and an error is generated.
3527
3528 When this option is used by a caller other than root, and the list is different
3529 from the compiled-in list, Exim gives up its root privilege immediately, and
3530 runs with the real and effective uid and gid set to those of the caller.
3531 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3532 file contains a list of full pathnames, one per line, for configuration files
3533 which are trusted. Root privilege is retained for any configuration file so
3534 listed, as long as the caller is the Exim user (or the user specified in the
3535 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3536 not writeable by inappropriate users or groups.
3537
3538 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3539 configuration using &%-C%& right through message reception and delivery,
3540 even if the caller is root. The reception works, but by that time, Exim is
3541 running as the Exim user, so when it re-executes to regain privilege for the
3542 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3543 test reception and delivery using two separate commands (one to put a message
3544 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3545
3546 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3547 prefix string with which any file named in a &%-C%& command line option
3548 must start. In addition, the filename must not contain the sequence &`/../`&.
3549 However, if the value of the &%-C%& option is identical to the value of
3550 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3551 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3552 unset, any filename can be used with &%-C%&.
3553
3554 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3555 to a directory to which only root has access. This prevents someone who has
3556 broken into the Exim account from running a privileged Exim with an arbitrary
3557 configuration file.
3558
3559 The &%-C%& facility is useful for ensuring that configuration files are
3560 syntactically correct, but cannot be used for test deliveries, unless the
3561 caller is privileged, or unless it is an exotic configuration that does not
3562 require privilege. No check is made on the owner or group of the files
3563 specified by this option.
3564
3565
3566 .vitem &%-D%&<&'macro'&>=<&'value'&>
3567 .oindex "&%-D%&"
3568 .cindex "macro" "setting on command line"
3569 This option can be used to override macro definitions in the configuration file
3570 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3571 unprivileged caller, it causes Exim to give up its root privilege.
3572 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3573 completely disabled, and its use causes an immediate error exit.
3574
3575 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3576 colon-separated list of macros which are considered safe and, if &%-D%& only
3577 supplies macros from this list, and the values are acceptable, then Exim will
3578 not give up root privilege if the caller is root, the Exim run-time user, or
3579 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3580 to be removed in the future.  Acceptable values for the macros satisfy the
3581 regexp: &`^[A-Za-z0-9_/.-]*$`&
3582
3583 The entire option (including equals sign if present) must all be within one
3584 command line item. &%-D%& can be used to set the value of a macro to the empty
3585 string, in which case the equals sign is optional. These two commands are
3586 synonymous:
3587 .code
3588 exim -DABC  ...
3589 exim -DABC= ...
3590 .endd
3591 To include spaces in a macro definition item, quotes must be used. If you use
3592 quotes, spaces are permitted around the macro name and the equals sign. For
3593 example:
3594 .code
3595 exim '-D ABC = something' ...
3596 .endd
3597 &%-D%& may be repeated up to 10 times on a command line.
3598 Only macro names up to 22 letters long can be set.
3599
3600
3601 .vitem &%-d%&<&'debug&~options'&>
3602 .oindex "&%-d%&"
3603 .cindex "debugging" "list of selectors"
3604 .cindex "debugging" "&%-d%& option"
3605 This option causes debugging information to be written to the standard
3606 error stream. It is restricted to admin users because debugging output may show
3607 database queries that contain password information. Also, the details of users'
3608 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3609 writes an error message to the standard error stream and exits with a non-zero
3610 return code.
3611
3612 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3613 standard debugging data is output. This can be reduced, or increased to include
3614 some more rarely needed information, by directly following &%-d%& with a string
3615 made up of names preceded by plus or minus characters. These add or remove sets
3616 of debugging data, respectively. For example, &%-d+filter%& adds filter
3617 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3618 no spaces are allowed in the debug setting. The available debugging categories
3619 are:
3620 .display
3621 &`acl            `& ACL interpretation
3622 &`auth           `& authenticators
3623 &`deliver        `& general delivery logic
3624 &`dns            `& DNS lookups (see also resolver)
3625 &`dnsbl          `& DNS black list (aka RBL) code
3626 &`exec           `& arguments for &[execv()]& calls
3627 &`expand         `& detailed debugging for string expansions
3628 &`filter         `& filter handling
3629 &`hints_lookup   `& hints data lookups
3630 &`host_lookup    `& all types of name-to-IP address handling
3631 &`ident          `& ident lookup
3632 &`interface      `& lists of local interfaces
3633 &`lists          `& matching things in lists
3634 &`load           `& system load checks
3635 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3636                     &<<CHAPlocalscan>>&)
3637 &`lookup         `& general lookup code and all lookups
3638 &`memory         `& memory handling
3639 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3640 &`pid            `& modifier: add pid to debug output lines
3641 &`process_info   `& setting info for the process log
3642 &`queue_run      `& queue runs
3643 &`receive        `& general message reception logic
3644 &`resolver       `& turn on the DNS resolver's debugging output
3645 &`retry          `& retry handling
3646 &`rewrite        `& address rewriting
3647 &`route          `& address routing
3648 &`timestamp      `& modifier: add timestamp to debug output lines
3649 &`tls            `& TLS logic
3650 &`transport      `& transports
3651 &`uid            `& changes of uid/gid and looking up uid/gid
3652 &`verify         `& address verification logic
3653 &`all            `& almost all of the above (see below), and also &%-v%&
3654 .endd
3655 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3656 for &`-all`&. The reason for this is that &`+all`& is something that people
3657 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3658 is included, an awful lot of output that is very rarely of interest is
3659 generated, so it now has to be explicitly requested. However, &`-all`& does
3660 turn everything off.
3661
3662 .cindex "resolver, debugging output"
3663 .cindex "DNS resolver, debugging output"
3664 The &`resolver`& option produces output only if the DNS resolver was compiled
3665 with DEBUG enabled. This is not the case in some operating systems. Also,
3666 unfortunately, debugging output from the DNS resolver is written to stdout
3667 rather than stderr.
3668
3669 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3670 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3671 However, the &`pid`& selector is forced when debugging is turned on for a
3672 daemon, which then passes it on to any re-executed Exims. Exim also
3673 automatically adds the pid to debug lines when several remote deliveries are
3674 run in parallel.
3675
3676 The &`timestamp`& selector causes the current time to be inserted at the start
3677 of all debug output lines. This can be useful when trying to track down delays
3678 in processing.
3679
3680 .cindex debugging "UTF-8 in"
3681 .cindex UTF-8 "in debug output"
3682 The &`noutf8`& selector disables the use of
3683 UTF-8 line-drawing characters to group related information.
3684 When disabled. ascii-art is used instead.
3685 Using the &`+all`& option does not set this modifier,
3686
3687 If the &%debug_print%& option is set in any driver, it produces output whenever
3688 any debugging is selected, or if &%-v%& is used.
3689
3690 .vitem &%-dd%&<&'debug&~options'&>
3691 .oindex "&%-dd%&"
3692 This option behaves exactly like &%-d%& except when used on a command that
3693 starts a daemon process. In that case, debugging is turned off for the
3694 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3695 behaviour of the daemon without creating as much output as full debugging does.
3696
3697 .vitem &%-dropcr%&
3698 .oindex "&%-dropcr%&"
3699 This is an obsolete option that is now a no-op. It used to affect the way Exim
3700 handled CR and LF characters in incoming messages. What happens now is
3701 described in section &<<SECTlineendings>>&.
3702
3703 .vitem &%-E%&
3704 .oindex "&%-E%&"
3705 .cindex "bounce message" "generating"
3706 This option specifies that an incoming message is a locally-generated delivery
3707 failure report. It is used internally by Exim when handling delivery failures
3708 and is not intended for external use. Its only effect is to stop Exim
3709 generating certain messages to the postmaster, as otherwise message cascades
3710 could occur in some situations. As part of the same option, a message id may
3711 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3712 new message contains the id, following &"R="&, as a cross-reference.
3713
3714 .vitem &%-e%&&'x'&
3715 .oindex "&%-e%&&'x'&"
3716 There are a number of Sendmail options starting with &%-oe%& which seem to be
3717 called by various programs without the leading &%o%& in the option. For
3718 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3719 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3720
3721 .vitem &%-F%&&~<&'string'&>
3722 .oindex "&%-F%&"
3723 .cindex "sender" "name"
3724 .cindex "name" "of sender"
3725 This option sets the sender's full name for use when a locally-generated
3726 message is being accepted. In the absence of this option, the user's &'gecos'&
3727 entry from the password data is used. As users are generally permitted to alter
3728 their &'gecos'& entries, no security considerations are involved. White space
3729 between &%-F%& and the <&'string'&> is optional.
3730
3731 .vitem &%-f%&&~<&'address'&>
3732 .oindex "&%-f%&"
3733 .cindex "sender" "address"
3734 .cindex "address" "sender"
3735 .cindex "trusted users"
3736 .cindex "envelope from"
3737 .cindex "envelope sender"
3738 .cindex "user" "trusted"
3739 This option sets the address of the envelope sender of a locally-generated
3740 message (also known as the return path). The option can normally be used only
3741 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3742 users to use it.
3743
3744 Processes running as root or the Exim user are always trusted. Other
3745 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3746 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3747 of a local message is set to the caller's login name at the default qualify
3748 domain.
3749
3750 There is one exception to the restriction on the use of &%-f%&: an empty sender
3751 can be specified by any user, trusted or not, to create a message that can
3752 never provoke a bounce. An empty sender can be specified either as an empty
3753 string, or as a pair of angle brackets with nothing between them, as in these
3754 examples of shell commands:
3755 .code
3756 exim -f '<>' user@domain
3757 exim -f "" user@domain
3758 .endd
3759 In addition, the use of &%-f%& is not restricted when testing a filter file
3760 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3761 &%-bv%& options.
3762
3763 Allowing untrusted users to change the sender address does not of itself make
3764 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3765 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3766 though this can be overridden by setting &%no_local_from_check%&.
3767
3768 White
3769 .cindex "&""From""& line"
3770 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3771 given as two arguments or one combined argument). The sender of a
3772 locally-generated message can also be set (when permitted) by an initial
3773 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3774 if &%-f%& is also present, it overrides &"From&~"&.
3775
3776 .vitem &%-G%&
3777 .oindex "&%-G%&"
3778 .cindex "submission fixups, suppressing (command-line)"
3779 This option is equivalent to an ACL applying:
3780 .code
3781 control = suppress_local_fixups
3782 .endd
3783 for every message received.  Note that Sendmail will complain about such
3784 bad formatting, where Exim silently just does not fix it up.  This may change
3785 in future.
3786
3787 As this affects audit information, the caller must be a trusted user to use
3788 this option.
3789
3790 .vitem &%-h%&&~<&'number'&>
3791 .oindex "&%-h%&"
3792 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3793 This option is accepted for compatibility with Sendmail, but has no effect. (In
3794 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3795 headers.)
3796
3797 .vitem &%-i%&
3798 .oindex "&%-i%&"
3799 .cindex "Solaris" "&'mail'& command"
3800 .cindex "dot" "in incoming non-SMTP message"
3801 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3802 line by itself should not terminate an incoming, non-SMTP message. I can find
3803 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3804 command in Solaris 2.4 uses it. See also &%-ti%&.
3805
3806 .vitem &%-L%&&~<&'tag'&>
3807 .oindex "&%-L%&"
3808 .cindex "syslog" "process name; set with flag"
3809 This option is equivalent to setting &%syslog_processname%& in the config
3810 file and setting &%log_file_path%& to &`syslog`&.
3811 Its use is restricted to administrators.  The configuration file has to be
3812 read and parsed, to determine access rights, before this is set and takes
3813 effect, so early configuration file errors will not honour this flag.
3814
3815 The tag should not be longer than 32 characters.
3816
3817 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3818 .oindex "&%-M%&"
3819 .cindex "forcing delivery"
3820 .cindex "delivery" "forcing attempt"
3821 .cindex "frozen messages" "forcing delivery"
3822 This option requests Exim to run a delivery attempt on each message in turn. If
3823 any of the messages are frozen, they are automatically thawed before the
3824 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3825 and &%hold_domains%& are ignored.
3826
3827 Retry
3828 .cindex "hints database" "overriding retry hints"
3829 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3830 the normal retry time has not yet been reached. This option requires the caller
3831 to be an admin user. However, there is an option called &%prod_requires_admin%&
3832 which can be set false to relax this restriction (and also the same requirement
3833 for the &%-q%&, &%-R%&, and &%-S%& options).
3834
3835 The deliveries happen synchronously, that is, the original Exim process does
3836 not terminate until all the delivery attempts have finished. No output is
3837 produced unless there is a serious error. If you want to see what is happening,
3838 use the &%-v%& option as well, or inspect Exim's main log.
3839
3840 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3841 .oindex "&%-Mar%&"
3842 .cindex "message" "adding recipients"
3843 .cindex "recipient" "adding"
3844 This option requests Exim to add the addresses to the list of recipients of the
3845 message (&"ar"& for &"add recipients"&). The first argument must be a message
3846 id, and the remaining ones must be email addresses. However, if the message is
3847 active (in the middle of a delivery attempt), it is not altered. This option
3848 can be used only by an admin user.
3849
3850 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3851         &~<&'message&~id'&>"
3852 .oindex "&%-MC%&"
3853 .cindex "SMTP" "passed connection"
3854 .cindex "SMTP" "multiple deliveries"
3855 .cindex "multiple SMTP deliveries"
3856 This option is not intended for use by external callers. It is used internally
3857 by Exim to invoke another instance of itself to deliver a waiting message using
3858 an existing SMTP connection, which is passed as the standard input. Details are
3859 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3860 must be root or the Exim user in order to use it.
3861
3862 .vitem &%-MCA%&
3863 .oindex "&%-MCA%&"
3864 This option is not intended for use by external callers. It is used internally
3865 by Exim in conjunction with the &%-MC%& option. It signifies that the
3866 connection to the remote host has been authenticated.
3867
3868 .vitem &%-MCD%&
3869 .oindex "&%-MCD%&"
3870 This option is not intended for use by external callers. It is used internally
3871 by Exim in conjunction with the &%-MC%& option. It signifies that the
3872 remote host supports the ESMTP &_DSN_& extension.
3873
3874 .new
3875 .vitem &%-MCd%&
3876 .oindex "&%-MCd%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-d%& option
3879 to pass on an information string on the purpose of the process.
3880 .wen
3881
3882 .vitem &%-MCG%&&~<&'queue&~name'&>
3883 .oindex "&%-MCG%&"
3884 This option is not intended for use by external callers. It is used internally
3885 by Exim in conjunction with the &%-MC%& option. It signifies that an
3886 alternate queue is used, named by the following argument.
3887
3888 .vitem &%-MCK%&
3889 .oindex "&%-MCK%&"
3890 This option is not intended for use by external callers. It is used internally
3891 by Exim in conjunction with the &%-MC%& option. It signifies that a
3892 remote host supports the ESMTP &_CHUNKING_& extension.
3893
3894 .vitem &%-MCP%&
3895 .oindex "&%-MCP%&"
3896 This option is not intended for use by external callers. It is used internally
3897 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3898 which Exim is connected supports pipelining.
3899
3900 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3901 .oindex "&%-MCQ%&"
3902 This option is not intended for use by external callers. It is used internally
3903 by Exim in conjunction with the &%-MC%& option when the original delivery was
3904 started by a queue runner. It passes on the process id of the queue runner,
3905 together with the file descriptor number of an open pipe. Closure of the pipe
3906 signals the final completion of the sequence of processes that are passing
3907 messages through the same SMTP connection.
3908
3909 .vitem &%-MCS%&
3910 .oindex "&%-MCS%&"
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3913 SMTP SIZE option should be used on messages delivered down the existing
3914 connection.
3915
3916 .vitem &%-MCT%&
3917 .oindex "&%-MCT%&"
3918 This option is not intended for use by external callers. It is used internally
3919 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3920 host to which Exim is connected supports TLS encryption.
3921
3922 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3923 .oindex "&%-MCt%&"
3924 This option is not intended for use by external callers. It is used internally
3925 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3926 connection is being proxied by a parent process for handling TLS encryption.
3927 The arguments give the local address and port being proxied, and the TLS cipher.
3928
3929 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3930 .oindex "&%-Mc%&"
3931 .cindex "hints database" "not overridden by &%-Mc%&"
3932 .cindex "delivery" "manually started &-- not forced"
3933 This option requests Exim to run a delivery attempt on each message, in turn,
3934 but unlike the &%-M%& option, it does check for retry hints, and respects any
3935 that are found. This option is not very useful to external callers. It is
3936 provided mainly for internal use by Exim when it needs to re-invoke itself in
3937 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3938 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3939 respects retry times and other options such as &%hold_domains%& that are
3940 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3941 If you want to run a specific delivery as if in a queue run, you should use
3942 &%-q%& with a message id argument. A distinction between queue run deliveries
3943 and other deliveries is made in one or two places.
3944
3945 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3946 .oindex "&%-Mes%&"
3947 .cindex "message" "changing sender"
3948 .cindex "sender" "changing"
3949 This option requests Exim to change the sender address in the message to the
3950 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3951 &"edit sender"&). There must be exactly two arguments. The first argument must
3952 be a message id, and the second one an email address. However, if the message
3953 is active (in the middle of a delivery attempt), its status is not altered.
3954 This option can be used only by an admin user.
3955
3956 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3957 .oindex "&%-Mf%&"
3958 .cindex "freezing messages"
3959 .cindex "message" "manually freezing"
3960 This option requests Exim to mark each listed message as &"frozen"&. This
3961 prevents any delivery attempts taking place until the message is &"thawed"&,
3962 either manually or as a result of the &%auto_thaw%& configuration option.
3963 However, if any of the messages are active (in the middle of a delivery
3964 attempt), their status is not altered. This option can be used only by an admin
3965 user.
3966
3967 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3968 .oindex "&%-Mg%&"
3969 .cindex "giving up on messages"
3970 .cindex "message" "abandoning delivery attempts"
3971 .cindex "delivery" "abandoning further attempts"
3972 This option requests Exim to give up trying to deliver the listed messages,
3973 including any that are frozen. However, if any of the messages are active,
3974 their status is not altered. For non-bounce messages, a delivery error message
3975 is sent to the sender, containing the text &"cancelled by administrator"&.
3976 Bounce messages are just discarded. This option can be used only by an admin
3977 user.
3978
3979 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3980 .oindex "&%-MG%&"
3981 .cindex queue named
3982 .cindex "named queues" "moving messages"
3983 .cindex "queue" "moving messages"
3984 This option requests that each listed message be moved from its current
3985 queue to the given named queue.
3986 The destination queue name argument is required, but can be an empty
3987 string to define the default queue.
3988 If the messages are not currently located in the default queue,
3989 a &%-qG<name>%& option will be required to define the source queue.
3990
3991 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3992 .oindex "&%-Mmad%&"
3993 .cindex "delivery" "cancelling all"
3994 This option requests Exim to mark all the recipient addresses in the messages
3995 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3996 message is active (in the middle of a delivery attempt), its status is not
3997 altered. This option can be used only by an admin user.
3998
3999 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4000 .oindex "&%-Mmd%&"
4001 .cindex "delivery" "cancelling by address"
4002 .cindex "recipient" "removing"
4003 .cindex "removing recipients"
4004 This option requests Exim to mark the given addresses as already delivered
4005 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4006 the remaining ones must be email addresses. These are matched to recipient
4007 addresses in the message in a case-sensitive manner. If the message is active
4008 (in the middle of a delivery attempt), its status is not altered. This option
4009 can be used only by an admin user.
4010
4011 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4012 .oindex "&%-Mrm%&"
4013 .cindex "removing messages"
4014 .cindex "abandoning mail"
4015 .cindex "message" "manually discarding"
4016 This option requests Exim to remove the given messages from the queue. No
4017 bounce messages are sent; each message is simply forgotten. However, if any of
4018 the messages are active, their status is not altered. This option can be used
4019 only by an admin user or by the user who originally caused the message to be
4020 placed in the queue.
4021
4022 . .new
4023 . .vitem &%-MS%&
4024 . .oindex "&%-MS%&"
4025 . .cindex REQUIRETLS
4026 . This option is used to request REQUIRETLS processing on the message.
4027 . It is used internally by Exim in conjunction with -E when generating
4028 . a bounce message.
4029 . .wen
4030
4031 .vitem &%-Mset%&&~<&'message&~id'&>
4032 .oindex "&%-Mset%&"
4033 .cindex "testing" "string expansion"
4034 .cindex "expansion" "testing"
4035 This option is useful only in conjunction with &%-be%& (that is, when testing
4036 string expansions). Exim loads the given message from its spool before doing
4037 the test expansions, thus setting message-specific variables such as
4038 &$message_size$& and the header variables. The &$recipients$& variable is made
4039 available. This feature is provided to make it easier to test expansions that
4040 make use of these variables. However, this option can be used only by an admin
4041 user. See also &%-bem%&.
4042
4043 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4044 .oindex "&%-Mt%&"
4045 .cindex "thawing messages"
4046 .cindex "unfreezing messages"
4047 .cindex "frozen messages" "thawing"
4048 .cindex "message" "thawing frozen"
4049 This option requests Exim to &"thaw"& any of the listed messages that are
4050 &"frozen"&, so that delivery attempts can resume. However, if any of the
4051 messages are active, their status is not altered. This option can be used only
4052 by an admin user.
4053
4054 .vitem &%-Mvb%&&~<&'message&~id'&>
4055 .oindex "&%-Mvb%&"
4056 .cindex "listing" "message body"
4057 .cindex "message" "listing body of"
4058 This option causes the contents of the message body (-D) spool file to be
4059 written to the standard output. This option can be used only by an admin user.
4060
4061 .vitem &%-Mvc%&&~<&'message&~id'&>
4062 .oindex "&%-Mvc%&"
4063 .cindex "message" "listing in RFC 2822 format"
4064 .cindex "listing" "message in RFC 2822 format"
4065 This option causes a copy of the complete message (header lines plus body) to
4066 be written to the standard output in RFC 2822 format. This option can be used
4067 only by an admin user.
4068
4069 .vitem &%-Mvh%&&~<&'message&~id'&>
4070 .oindex "&%-Mvh%&"
4071 .cindex "listing" "message headers"
4072 .cindex "header lines" "listing"
4073 .cindex "message" "listing header lines"
4074 This option causes the contents of the message headers (-H) spool file to be
4075 written to the standard output. This option can be used only by an admin user.
4076
4077 .vitem &%-Mvl%&&~<&'message&~id'&>
4078 .oindex "&%-Mvl%&"
4079 .cindex "listing" "message log"
4080 .cindex "message" "listing message log"
4081 This option causes the contents of the message log spool file to be written to
4082 the standard output. This option can be used only by an admin user.
4083
4084 .vitem &%-m%&
4085 .oindex "&%-m%&"
4086 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4087 treats it that way too.
4088
4089 .vitem &%-N%&
4090 .oindex "&%-N%&"
4091 .cindex "debugging" "&%-N%& option"
4092 .cindex "debugging" "suppressing delivery"
4093 This is a debugging option that inhibits delivery of a message at the transport
4094 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4095 it just doesn't actually transport the message, but instead behaves as if it
4096 had successfully done so. However, it does not make any updates to the retry
4097 database, and the log entries for deliveries are flagged with &"*>"& rather
4098 than &"=>"&.
4099
4100 Because &%-N%& discards any message to which it applies, only root or the Exim
4101 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4102 words, an ordinary user can use it only when supplying an incoming message to
4103 which it will apply. Although transportation never fails when &%-N%& is set, an
4104 address may be deferred because of a configuration problem on a transport, or a
4105 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4106 the message, and applies to any subsequent delivery attempts that may happen
4107 for that message.
4108
4109 .vitem &%-n%&
4110 .oindex "&%-n%&"
4111 This option is interpreted by Sendmail to mean &"no aliasing"&.
4112 For normal modes of operation, it is ignored by Exim.
4113 When combined with &%-bP%& it makes the output more terse (suppresses
4114 option names, environment values and config pretty printing).
4115
4116 .vitem &%-O%&&~<&'data'&>
4117 .oindex "&%-O%&"
4118 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4119 Exim.
4120
4121 .vitem &%-oA%&&~<&'file&~name'&>
4122 .oindex "&%-oA%&"
4123 .cindex "Sendmail compatibility" "&%-oA%& option"
4124 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4125 alternative alias filename. Exim handles &%-bi%& differently; see the
4126 description above.
4127
4128 .vitem &%-oB%&&~<&'n'&>
4129 .oindex "&%-oB%&"
4130 .cindex "SMTP" "passed connection"
4131 .cindex "SMTP" "multiple deliveries"
4132 .cindex "multiple SMTP deliveries"
4133 This is a debugging option which limits the maximum number of messages that can
4134 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4135 transport. If <&'n'&> is omitted, the limit is set to 1.
4136
4137 .vitem &%-odb%&
4138 .oindex "&%-odb%&"
4139 .cindex "background delivery"
4140 .cindex "delivery" "in the background"
4141 This option applies to all modes in which Exim accepts incoming messages,
4142 including the listening daemon. It requests &"background"& delivery of such
4143 messages, which means that the accepting process automatically starts a
4144 delivery process for each message received, but does not wait for the delivery
4145 processes to finish.
4146
4147 When all the messages have been received, the reception process exits,
4148 leaving the delivery processes to finish in their own time. The standard output
4149 and error streams are closed at the start of each delivery process.
4150 This is the default action if none of the &%-od%& options are present.
4151
4152 If one of the queueing options in the configuration file
4153 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4154 overrides it if &%queue_only_override%& is set true, which is the default
4155 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4156
4157 .vitem &%-odf%&
4158 .oindex "&%-odf%&"
4159 .cindex "foreground delivery"
4160 .cindex "delivery" "in the foreground"
4161 This option requests &"foreground"& (synchronous) delivery when Exim has
4162 accepted a locally-generated message. (For the daemon it is exactly the same as
4163 &%-odb%&.) A delivery process is automatically started to deliver the message,
4164 and Exim waits for it to complete before proceeding.
4165
4166 The original Exim reception process does not finish until the delivery
4167 process for the final message has ended. The standard error stream is left open
4168 during deliveries.
4169
4170 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4171 false and one of the queueing options in the configuration file is in effect.
4172
4173 If there is a temporary delivery error during foreground delivery, the
4174 message is left in the queue for later delivery, and the original reception
4175 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4176 restricted configuration that never queues messages.
4177
4178
4179 .vitem &%-odi%&
4180 .oindex "&%-odi%&"
4181 This option is synonymous with &%-odf%&. It is provided for compatibility with
4182 Sendmail.
4183
4184 .vitem &%-odq%&
4185 .oindex "&%-odq%&"
4186 .cindex "non-immediate delivery"
4187 .cindex "delivery" "suppressing immediate"
4188 .cindex "queueing incoming messages"
4189 This option applies to all modes in which Exim accepts incoming messages,
4190 including the listening daemon. It specifies that the accepting process should
4191 not automatically start a delivery process for each message received. Messages
4192 are placed in the queue, and remain there until a subsequent queue runner
4193 process encounters them. There are several configuration options (such as
4194 &%queue_only%&) that can be used to queue incoming messages under certain
4195 conditions. This option overrides all of them and also &%-odqs%&. It always
4196 forces queueing.
4197
4198 .vitem &%-odqs%&
4199 .oindex "&%-odqs%&"
4200 .cindex "SMTP" "delaying delivery"
4201 .cindex "first pass routing"
4202 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4203 However, like &%-odb%& and &%-odi%&, this option has no effect if
4204 &%queue_only_override%& is false and one of the queueing options in the
4205 configuration file is in effect.
4206
4207 When &%-odqs%& does operate, a delivery process is started for each incoming
4208 message, in the background by default, but in the foreground if &%-odi%& is
4209 also present. The recipient addresses are routed, and local deliveries are done
4210 in the normal way. However, if any SMTP deliveries are required, they are not
4211 done at this time, so the message remains in the queue until a subsequent queue
4212 runner process encounters it. Because routing was done, Exim knows which
4213 messages are waiting for which hosts, and so a number of messages for the same
4214 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4215 configuration option has the same effect for specific domains. See also the
4216 &%-qq%& option.
4217
4218 .vitem &%-oee%&
4219 .oindex "&%-oee%&"
4220 .cindex "error" "reporting"
4221 If an error is detected while a non-SMTP message is being received (for
4222 example, a malformed address), the error is reported to the sender in a mail
4223 message.
4224
4225 .cindex "return code" "for &%-oee%&"
4226 Provided
4227 this error message is successfully sent, the Exim receiving process
4228 exits with a return code of zero. If not, the return code is 2 if the problem
4229 is that the original message has no recipients, or 1 for any other error.
4230 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4231
4232 .vitem &%-oem%&
4233 .oindex "&%-oem%&"
4234 .cindex "error" "reporting"
4235 .cindex "return code" "for &%-oem%&"
4236 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4237 return code, whether or not the error message was successfully sent.
4238 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4239
4240 .vitem &%-oep%&
4241 .oindex "&%-oep%&"
4242 .cindex "error" "reporting"
4243 If an error is detected while a non-SMTP message is being received, the
4244 error is reported by writing a message to the standard error file (stderr).
4245 .cindex "return code" "for &%-oep%&"
4246 The return code is 1 for all errors.
4247
4248 .vitem &%-oeq%&
4249 .oindex "&%-oeq%&"
4250 .cindex "error" "reporting"
4251 This option is supported for compatibility with Sendmail, but has the same
4252 effect as &%-oep%&.
4253
4254 .vitem &%-oew%&
4255 .oindex "&%-oew%&"
4256 .cindex "error" "reporting"
4257 This option is supported for compatibility with Sendmail, but has the same
4258 effect as &%-oem%&.
4259
4260 .vitem &%-oi%&
4261 .oindex "&%-oi%&"
4262 .cindex "dot" "in incoming non-SMTP message"
4263 This option, which has the same effect as &%-i%&, specifies that a dot on a
4264 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4265 single dot does terminate, though Exim does no special processing for other
4266 lines that start with a dot. This option is set by default if Exim is called as
4267 &'rmail'&. See also &%-ti%&.
4268
4269 .vitem &%-oitrue%&
4270 .oindex "&%-oitrue%&"
4271 This option is treated as synonymous with &%-oi%&.
4272
4273 .vitem &%-oMa%&&~<&'host&~address'&>
4274 .oindex "&%-oMa%&"
4275 .cindex "sender" "host address, specifying for local message"
4276 A number of options starting with &%-oM%& can be used to set values associated
4277 with remote hosts on locally-submitted messages (that is, messages not received
4278 over TCP/IP). These options can be used by any caller in conjunction with the
4279 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4280 other circumstances, they are ignored unless the caller is trusted.
4281
4282 The &%-oMa%& option sets the sender host address. This may include a port
4283 number at the end, after a full stop (period). For example:
4284 .code
4285 exim -bs -oMa 10.9.8.7.1234
4286 .endd
4287 An alternative syntax is to enclose the IP address in square brackets,
4288 followed by a colon and the port number:
4289 .code
4290 exim -bs -oMa [10.9.8.7]:1234
4291 .endd
4292 The IP address is placed in the &$sender_host_address$& variable, and the
4293 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4294 are present on the command line, the sender host IP address is taken from
4295 whichever one is last.
4296
4297 .vitem &%-oMaa%&&~<&'name'&>
4298 .oindex "&%-oMaa%&"
4299 .cindex "authentication" "name, specifying for local message"
4300 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4301 option sets the value of &$sender_host_authenticated$& (the authenticator
4302 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4303 This option can be used with &%-bh%& and &%-bs%& to set up an
4304 authenticated SMTP session without actually using the SMTP AUTH command.
4305
4306 .vitem &%-oMai%&&~<&'string'&>
4307 .oindex "&%-oMai%&"
4308 .cindex "authentication" "id, specifying for local message"
4309 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4310 option sets the value of &$authenticated_id$& (the id that was authenticated).
4311 This overrides the default value (the caller's login id, except with &%-bh%&,
4312 where there is no default) for messages from local sources. See chapter
4313 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4314
4315 .vitem &%-oMas%&&~<&'address'&>
4316 .oindex "&%-oMas%&"
4317 .cindex "authentication" "sender, specifying for local message"
4318 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4319 option sets the authenticated sender value in &$authenticated_sender$&. It
4320 overrides the sender address that is created from the caller's login id for
4321 messages from local sources, except when &%-bh%& is used, when there is no
4322 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4323 specified on a MAIL command overrides this value. See chapter
4324 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4325
4326 .vitem &%-oMi%&&~<&'interface&~address'&>
4327 .oindex "&%-oMi%&"
4328 .cindex "interface" "address, specifying for local message"
4329 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4330 option sets the IP interface address value. A port number may be included,
4331 using the same syntax as for &%-oMa%&. The interface address is placed in
4332 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4333
4334 .vitem &%-oMm%&&~<&'message&~reference'&>
4335 .oindex "&%-oMm%&"
4336 .cindex "message reference" "message reference, specifying for local message"
4337 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4338 option sets the message reference, e.g. message-id, and is logged during
4339 delivery. This is useful when some kind of audit trail is required to tie
4340 messages together. The format of the message reference is checked and will
4341 abort if the format is invalid. The option will only be accepted if exim is
4342 running in trusted mode, not as any regular user.
4343
4344 The best example of a message reference is when Exim sends a bounce message.
4345 The message reference is the message-id of the original message for which Exim
4346 is sending the bounce.
4347
4348 .vitem &%-oMr%&&~<&'protocol&~name'&>
4349 .oindex "&%-oMr%&"
4350 .cindex "protocol, specifying for local message"
4351 .vindex "&$received_protocol$&"
4352 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4353 option sets the received protocol value that is stored in
4354 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4355 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4356 SMTP protocol names (see the description of &$received_protocol$& in section
4357 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4358 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4359 be set by &%-oMr%&. Repeated use of this option is not supported.
4360
4361 .vitem &%-oMs%&&~<&'host&~name'&>
4362 .oindex "&%-oMs%&"
4363 .cindex "sender" "host name, specifying for local message"
4364 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4365 option sets the sender host name in &$sender_host_name$&. When this option is
4366 present, Exim does not attempt to look up a host name from an IP address; it
4367 uses the name it is given.
4368
4369 .vitem &%-oMt%&&~<&'ident&~string'&>
4370 .oindex "&%-oMt%&"
4371 .cindex "sender" "ident string, specifying for local message"
4372 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4373 option sets the sender ident value in &$sender_ident$&. The default setting for
4374 local callers is the login id of the calling process, except when &%-bh%& is
4375 used, when there is no default.
4376
4377 .vitem &%-om%&
4378 .oindex "&%-om%&"
4379 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4380 In Sendmail, this option means &"me too"&, indicating that the sender of a
4381 message should receive a copy of the message if the sender appears in an alias
4382 expansion. Exim always does this, so the option does nothing.
4383
4384 .vitem &%-oo%&
4385 .oindex "&%-oo%&"
4386 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4387 This option is ignored. In Sendmail it specifies &"old style headers"&,
4388 whatever that means.
4389
4390 .vitem &%-oP%&&~<&'path'&>
4391 .oindex "&%-oP%&"
4392 .cindex "pid (process id)" "of daemon"
4393 .cindex "daemon" "process id (pid)"
4394 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4395 value. The option specifies the file to which the process id of the daemon is
4396 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4397 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4398 because in those cases, the normal pid file is not used.
4399
4400 .new
4401 .vitem &%-oPX%&
4402 .oindex "&%-oPX%&"
4403 .cindex "pid (process id)" "of daemon"
4404 .cindex "daemon" "process id (pid)"
4405 This option is not intended for general use.
4406 The daemon uses it when terminating due to a SIGTEM, possibly in
4407 combination with &%-oP%&&~<&'path'&>.
4408 It causes the pid file to be removed.
4409 .wen
4410
4411 .vitem &%-or%&&~<&'time'&>
4412 .oindex "&%-or%&"
4413 .cindex "timeout" "for non-SMTP input"
4414 This option sets a timeout value for incoming non-SMTP messages. If it is not
4415 set, Exim will wait forever for the standard input. The value can also be set
4416 by the &%receive_timeout%& option. The format used for specifying times is
4417 described in section &<<SECTtimeformat>>&.
4418
4419 .vitem &%-os%&&~<&'time'&>
4420 .oindex "&%-os%&"
4421 .cindex "timeout" "for SMTP input"
4422 .cindex "SMTP" "input timeout"
4423 This option sets a timeout value for incoming SMTP messages. The timeout
4424 applies to each SMTP command and block of data. The value can also be set by
4425 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4426 for specifying times is described in section &<<SECTtimeformat>>&.
4427
4428 .vitem &%-ov%&
4429 .oindex "&%-ov%&"
4430 This option has exactly the same effect as &%-v%&.
4431
4432 .vitem &%-oX%&&~<&'number&~or&~string'&>
4433 .oindex "&%-oX%&"
4434 .cindex "TCP/IP" "setting listening ports"
4435 .cindex "TCP/IP" "setting listening interfaces"
4436 .cindex "port" "receiving TCP/IP"
4437 This option is relevant only when the &%-bd%& (start listening daemon) option
4438 is also given. It controls which ports and interfaces the daemon uses. Details
4439 of the syntax, and how it interacts with configuration file options, are given
4440 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4441 file is written unless &%-oP%& is also present to specify a pid filename.
4442
4443 .vitem &%-pd%&
4444 .oindex "&%-pd%&"
4445 .cindex "Perl" "starting the interpreter"
4446 This option applies when an embedded Perl interpreter is linked with Exim (see
4447 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4448 option, forcing the starting of the interpreter to be delayed until it is
4449 needed.
4450
4451 .vitem &%-ps%&
4452 .oindex "&%-ps%&"
4453 .cindex "Perl" "starting the interpreter"
4454 This option applies when an embedded Perl interpreter is linked with Exim (see
4455 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4456 option, forcing the starting of the interpreter to occur as soon as Exim is
4457 started.
4458
4459 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4460 .oindex "&%-p%&"
4461 For compatibility with Sendmail, this option is equivalent to
4462 .display
4463 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4464 .endd
4465 It sets the incoming protocol and host name (for trusted callers). The
4466 host name and its colon can be omitted when only the protocol is to be set.
4467 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4468 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4469 or &`s`& using this option (but that does not seem a real limitation).
4470 Repeated use of this option is not supported.
4471
4472 .vitem &%-q%&
4473 .oindex "&%-q%&"
4474 .cindex "queue runner" "starting manually"
4475 This option is normally restricted to admin users. However, there is a
4476 configuration option called &%prod_requires_admin%& which can be set false to
4477 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4478 and &%-S%& options).
4479
4480 .cindex "queue runner" "description of operation"
4481 If other commandline options do not specify an action,
4482 the &%-q%& option starts one queue runner process. This scans the queue of
4483 waiting messages, and runs a delivery process for each one in turn. It waits
4484 for each delivery process to finish before starting the next one. A delivery
4485 process may not actually do any deliveries if the retry times for the addresses
4486 have not been reached. Use &%-qf%& (see below) if you want to override this.
4487
4488 If
4489 .cindex "SMTP" "passed connection"
4490 .cindex "SMTP" "multiple deliveries"
4491 .cindex "multiple SMTP deliveries"
4492 the delivery process spawns other processes to deliver other messages down
4493 passed SMTP connections, the queue runner waits for these to finish before
4494 proceeding.
4495
4496 When all the queued messages have been considered, the original queue runner
4497 process terminates. In other words, a single pass is made over the waiting
4498 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4499 this to be repeated periodically.
4500
4501 Exim processes the waiting messages in an unpredictable order. It isn't very
4502 random, but it is likely to be different each time, which is all that matters.
4503 If one particular message screws up a remote MTA, other messages to the same
4504 MTA have a chance of getting through if they get tried first.
4505
4506 It is possible to cause the messages to be processed in lexical message id
4507 order, which is essentially the order in which they arrived, by setting the
4508 &%queue_run_in_order%& option, but this is not recommended for normal use.
4509
4510 .vitem &%-q%&<&'qflags'&>
4511 The &%-q%& option may be followed by one or more flag letters that change its
4512 behaviour. They are all optional, but if more than one is present, they must
4513 appear in the correct order. Each flag is described in a separate item below.
4514
4515 .vitem &%-qq...%&
4516 .oindex "&%-qq%&"
4517 .cindex "queue" "double scanning"
4518 .cindex "queue" "routing"
4519 .cindex "routing" "whole queue before delivery"
4520 .cindex "first pass routing"
4521 An option starting with &%-qq%& requests a two-stage queue run. In the first
4522 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4523 every domain. Addresses are routed, local deliveries happen, but no remote
4524 transports are run.
4525
4526 .new
4527 Performance will be best if the &%queue_run_in_order%& option is false.
4528 .wen
4529
4530 .cindex "hints database" "remembering routing"
4531 The hints database that remembers which messages are waiting for specific hosts
4532 is updated, as if delivery to those hosts had been deferred. After this is
4533 complete, a second, normal queue scan happens, with routing and delivery taking
4534 place as normal. Messages that are routed to the same host should mostly be
4535 delivered down a single SMTP
4536 .cindex "SMTP" "passed connection"
4537 .cindex "SMTP" "multiple deliveries"
4538 .cindex "multiple SMTP deliveries"
4539 connection because of the hints that were set up during the first queue scan.
4540 This option may be useful for hosts that are connected to the Internet
4541 intermittently.
4542
4543 .vitem &%-q[q]i...%&
4544 .oindex "&%-qi%&"
4545 .cindex "queue" "initial delivery"
4546 If the &'i'& flag is present, the queue runner runs delivery processes only for
4547 those messages that haven't previously been tried. (&'i'& stands for &"initial
4548 delivery"&.) This can be helpful if you are putting messages in the queue using
4549 &%-odq%& and want a queue runner just to process the new messages.
4550
4551 .vitem &%-q[q][i]f...%&
4552 .oindex "&%-qf%&"
4553 .cindex "queue" "forcing delivery"
4554 .cindex "delivery" "forcing in queue run"
4555 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4556 message, whereas without &'f'& only those non-frozen addresses that have passed
4557 their retry times are tried.
4558
4559 .vitem &%-q[q][i]ff...%&
4560 .oindex "&%-qff%&"
4561 .cindex "frozen messages" "forcing delivery"
4562 If &'ff'& is present, a delivery attempt is forced for every message, whether
4563 frozen or not.
4564
4565 .vitem &%-q[q][i][f[f]]l%&
4566 .oindex "&%-ql%&"
4567 .cindex "queue" "local deliveries only"
4568 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4569 be done. If a message requires any remote deliveries, it remains in the queue
4570 for later delivery.
4571
4572 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4573 .oindex "&%-qG%&"
4574 .cindex queue named
4575 .cindex "named queues"  "deliver from"
4576 .cindex "queue" "delivering specific messages"
4577 If the &'G'& flag and a name is present, the queue runner operates on the
4578 queue with the given name rather than the default queue.
4579 The name should not contain a &'/'& character.
4580 For a periodic queue run (see below)
4581 append to the name a slash and a time value.
4582
4583 If other commandline options specify an action, a &'-qG<name>'& option
4584 will specify a queue to operate on.
4585 For example:
4586 .code
4587 exim -bp -qGquarantine
4588 mailq -qGquarantine
4589 exim -qGoffpeak -Rf @special.domain.example
4590 .endd
4591
4592 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4593 When scanning the queue, Exim can be made to skip over messages whose ids are
4594 lexically less than a given value by following the &%-q%& option with a
4595 starting message id. For example:
4596 .code
4597 exim -q 0t5C6f-0000c8-00
4598 .endd
4599 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4600 second message id is given, messages whose ids are lexically greater than it
4601 are also skipped. If the same id is given twice, for example,
4602 .code
4603 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4604 .endd
4605 just one delivery process is started, for that message. This differs from
4606 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4607 that it counts as a delivery from a queue run. Note that the selection
4608 mechanism does not affect the order in which the messages are scanned. There
4609 are also other ways of selecting specific sets of messages for delivery in a
4610 queue run &-- see &%-R%& and &%-S%&.
4611
4612 .vitem &%-q%&<&'qflags'&><&'time'&>
4613 .cindex "queue runner" "starting periodically"
4614 .cindex "periodic queue running"
4615 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4616 starting a queue runner process at intervals specified by the given time value
4617 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4618 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4619 single daemon process handles both functions. A common way of starting up a
4620 combined daemon at system boot time is to use a command such as
4621 .code
4622 /usr/exim/bin/exim -bd -q30m
4623 .endd
4624 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4625 process every 30 minutes.
4626
4627 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4628 pid file is written unless one is explicitly requested by the &%-oP%& option.
4629
4630 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4631 .oindex "&%-qR%&"
4632 This option is synonymous with &%-R%&. It is provided for Sendmail
4633 compatibility.
4634
4635 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4636 .oindex "&%-qS%&"
4637 This option is synonymous with &%-S%&.
4638
4639 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4640 .oindex "&%-R%&"
4641 .cindex "queue runner" "for specific recipients"
4642 .cindex "delivery" "to given domain"
4643 .cindex "domain" "delivery to"
4644 The <&'rsflags'&> may be empty, in which case the white space before the string
4645 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4646 which are the possible values for <&'rsflags'&>. White space is required if
4647 <&'rsflags'&> is not empty.
4648
4649 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4650 perform a single queue run, except that, when scanning the messages on the
4651 queue, Exim processes only those that have at least one undelivered recipient
4652 address containing the given string, which is checked in a case-independent
4653 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4654 regular expression; otherwise it is a literal string.
4655
4656 If you want to do periodic queue runs for messages with specific recipients,
4657 you can combine &%-R%& with &%-q%& and a time value. For example:
4658 .code
4659 exim -q25m -R @special.domain.example
4660 .endd
4661 This example does a queue run for messages with recipients in the given domain
4662 every 25 minutes. Any additional flags that are specified with &%-q%& are
4663 applied to each queue run.
4664
4665 Once a message is selected for delivery by this mechanism, all its addresses
4666 are processed. For the first selected message, Exim overrides any retry
4667 information and forces a delivery attempt for each undelivered address. This
4668 means that if delivery of any address in the first message is successful, any
4669 existing retry information is deleted, and so delivery attempts for that
4670 address in subsequently selected messages (which are processed without forcing)
4671 will run. However, if delivery of any address does not succeed, the retry
4672 information is updated, and in subsequently selected messages, the failing
4673 address will be skipped.
4674
4675 .cindex "frozen messages" "forcing delivery"
4676 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4677 all selected messages, not just the first; frozen messages are included when
4678 &'ff'& is present.
4679
4680 The &%-R%& option makes it straightforward to initiate delivery of all messages
4681 to a given domain after a host has been down for some time. When the SMTP
4682 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4683 effect is to run Exim with the &%-R%& option, but it can be configured to run
4684 an arbitrary command instead.
4685
4686 .vitem &%-r%&
4687 .oindex "&%-r%&"
4688 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4689
4690 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4691 .oindex "&%-S%&"
4692 .cindex "delivery" "from given sender"
4693 .cindex "queue runner" "for specific senders"
4694 This option acts like &%-R%& except that it checks the string against each
4695 message's sender instead of against the recipients. If &%-R%& is also set, both
4696 conditions must be met for a message to be selected. If either of the options
4697 has &'f'& or &'ff'& in its flags, the associated action is taken.
4698
4699 .vitem &%-Tqt%&&~<&'times'&>
4700 .oindex "&%-Tqt%&"
4701 This is an option that is exclusively for use by the Exim testing suite. It is not
4702 recognized when Exim is run normally. It allows for the setting up of explicit
4703 &"queue times"& so that various warning/retry features can be tested.
4704
4705 .vitem &%-t%&
4706 .oindex "&%-t%&"
4707 .cindex "recipient" "extracting from header lines"
4708 .cindex "&'Bcc:'& header line"
4709 .cindex "&'Cc:'& header line"
4710 .cindex "&'To:'& header line"
4711 When Exim is receiving a locally-generated, non-SMTP message on its standard
4712 input, the &%-t%& option causes the recipients of the message to be obtained
4713 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4714 from the command arguments. The addresses are extracted before any rewriting
4715 takes place and the &'Bcc:'& header line, if present, is then removed.
4716
4717 .cindex "Sendmail compatibility" "&%-t%& option"
4718 If the command has any arguments, they specify addresses to which the message
4719 is &'not'& to be delivered. That is, the argument addresses are removed from
4720 the recipients list obtained from the headers. This is compatible with Smail 3
4721 and in accordance with the documented behaviour of several versions of
4722 Sendmail, as described in man pages on a number of operating systems (e.g.
4723 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4724 argument addresses to those obtained from the headers, and the O'Reilly
4725 Sendmail book documents it that way. Exim can be made to add argument addresses
4726 instead of subtracting them by setting the option
4727 &%extract_addresses_remove_arguments%& false.
4728
4729 .cindex "&%Resent-%& header lines" "with &%-t%&"
4730 If there are any &%Resent-%& header lines in the message, Exim extracts
4731 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4732 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4733 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4734 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4735
4736 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4737 message is resent several times). The RFC also specifies that they should be
4738 added at the front of the message, and separated by &'Received:'& lines. It is
4739 not at all clear how &%-t%& should operate in the present of multiple sets,
4740 nor indeed exactly what constitutes a &"set"&.
4741 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4742 are often added at the end of the header, and if a message is resent more than
4743 once, it is common for the original set of &%Resent-%& headers to be renamed as
4744 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4745
4746 .vitem &%-ti%&
4747 .oindex "&%-ti%&"
4748 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4749 compatibility with Sendmail.
4750
4751 .vitem &%-tls-on-connect%&
4752 .oindex "&%-tls-on-connect%&"
4753 .cindex "TLS" "use without STARTTLS"
4754 .cindex "TLS" "automatic start"
4755 This option is available when Exim is compiled with TLS support. It forces all
4756 incoming SMTP connections to behave as if the incoming port is listed in the
4757 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4758 &<<CHAPTLS>>& for further details.
4759
4760
4761 .vitem &%-U%&
4762 .oindex "&%-U%&"
4763 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4764 Sendmail uses this option for &"initial message submission"&, and its
4765 documentation states that in future releases, it may complain about
4766 syntactically invalid messages rather than fixing them when this flag is not
4767 set. Exim ignores this option.
4768
4769 .vitem &%-v%&
4770 .oindex "&%-v%&"
4771 This option causes Exim to write information to the standard error stream,
4772 describing what it is doing. In particular, it shows the log lines for
4773 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4774 dialogue is shown. Some of the log lines shown may not actually be written to
4775 the log if the setting of &%log_selector%& discards them. Any relevant
4776 selectors are shown with each log line. If none are shown, the logging is
4777 unconditional.
4778
4779 .vitem &%-x%&
4780 .oindex "&%-x%&"
4781 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4782 National Language Support extended characters in the body of the mail item"&).
4783 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4784 this option.
4785
4786 .vitem &%-X%&&~<&'logfile'&>
4787 .oindex "&%-X%&"
4788 This option is interpreted by Sendmail to cause debug information to be sent
4789 to the named file.  It is ignored by Exim.
4790
4791 .vitem &%-z%&&~<&'log-line'&>
4792 .oindex "&%-z%&"
4793 This option writes its argument to Exim's logfile.
4794 Use is restricted to administrators; the intent is for operational notes.
4795 Quotes should be used to maintain a multi-word item as a single argument,
4796 under most shells.
4797 .endlist
4798
4799 .ecindex IIDclo1
4800 .ecindex IIDclo2
4801
4802
4803 . ////////////////////////////////////////////////////////////////////////////
4804 . Insert a stylized DocBook comment here, to identify the end of the command
4805 . line options. This is for the benefit of the Perl script that automatically
4806 . creates a man page for the options.
4807 . ////////////////////////////////////////////////////////////////////////////
4808
4809 .literal xml
4810 <!-- === End of command line options === -->
4811 .literal off
4812
4813
4814
4815
4816
4817 . ////////////////////////////////////////////////////////////////////////////
4818 . ////////////////////////////////////////////////////////////////////////////
4819
4820
4821 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4822          "The runtime configuration file"
4823
4824 .cindex "runtime configuration"
4825 .cindex "configuration file" "general description"
4826 .cindex "CONFIGURE_FILE"
4827 .cindex "configuration file" "errors in"
4828 .cindex "error" "in configuration file"
4829 .cindex "return code" "for bad configuration"
4830 Exim uses a single runtime configuration file that is read whenever an Exim
4831 binary is executed. Note that in normal operation, this happens frequently,
4832 because Exim is designed to operate in a distributed manner, without central
4833 control.
4834
4835 If a syntax error is detected while reading the configuration file, Exim
4836 writes a message on the standard error, and exits with a non-zero return code.
4837 The message is also written to the panic log. &*Note*&: Only simple syntax
4838 errors can be detected at this time. The values of any expanded options are
4839 not checked until the expansion happens, even when the expansion does not
4840 actually alter the string.
4841
4842 The name of the configuration file is compiled into the binary for security
4843 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4844 most configurations, this specifies a single file. However, it is permitted to
4845 give a colon-separated list of filenames, in which case Exim uses the first
4846 existing file in the list.
4847
4848 .cindex "EXIM_USER"
4849 .cindex "EXIM_GROUP"
4850 .cindex "CONFIGURE_OWNER"
4851 .cindex "CONFIGURE_GROUP"
4852 .cindex "configuration file" "ownership"
4853 .cindex "ownership" "configuration file"
4854 The runtime configuration file must be owned by root or by the user that is
4855 specified at compile time by the CONFIGURE_OWNER option (if set). The
4856 configuration file must not be world-writeable, or group-writeable unless its
4857 group is the root group or the one specified at compile time by the
4858 CONFIGURE_GROUP option.
4859
4860 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4861 to root, anybody who is able to edit the runtime configuration file has an
4862 easy way to run commands as root. If you specify a user or group in the
4863 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4864 who are members of that group will trivially be able to obtain root privileges.
4865
4866 Up to Exim version 4.72, the runtime configuration file was also permitted to
4867 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4868 since it offered a simple privilege escalation for any attacker who managed to
4869 compromise the Exim user account.
4870
4871 A default configuration file, which will work correctly in simple situations,
4872 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4873 defines just one filename, the installation process copies the default
4874 configuration to a new file of that name if it did not previously exist. If
4875 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4876 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4877 configuration.
4878
4879
4880
4881 .section "Using a different configuration file" "SECID40"
4882 .cindex "configuration file" "alternate"
4883 A one-off alternate configuration can be specified by the &%-C%& command line
4884 option, which may specify a single file or a list of files. However, when
4885 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4886 unless the argument for &%-C%& is identical to the built-in value from
4887 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4888 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4889 is useful mainly for checking the syntax of configuration files before
4890 installing them. No owner or group checks are done on a configuration file
4891 specified by &%-C%&, if root privilege has been dropped.
4892
4893 Even the Exim user is not trusted to specify an arbitrary configuration file
4894 with the &%-C%& option to be used with root privileges, unless that file is
4895 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4896 testing a configuration using &%-C%& right through message reception and
4897 delivery, even if the caller is root. The reception works, but by that time,
4898 Exim is running as the Exim user, so when it re-execs to regain privilege for
4899 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4900 can test reception and delivery using two separate commands (one to put a
4901 message in the queue, using &%-odq%&, and another to do the delivery, using
4902 &%-M%&).
4903
4904 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4905 prefix string with which any file named in a &%-C%& command line option must
4906 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4907 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4908 filename can be used with &%-C%&.
4909
4910 One-off changes to a configuration can be specified by the &%-D%& command line
4911 option, which defines and overrides values for macros used inside the
4912 configuration file. However, like &%-C%&, the use of this option by a
4913 non-privileged user causes Exim to discard its root privilege.
4914 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4915 completely disabled, and its use causes an immediate error exit.
4916
4917 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4918 to declare certain macro names trusted, such that root privilege will not
4919 necessarily be discarded.
4920 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4921 considered safe and, if &%-D%& only supplies macros from this list, and the
4922 values are acceptable, then Exim will not give up root privilege if the caller
4923 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4924 transition mechanism and is expected to be removed in the future.  Acceptable
4925 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4926
4927 Some sites may wish to use the same Exim binary on different machines that
4928 share a file system, but to use different configuration files on each machine.
4929 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4930 looks for a file whose name is the configuration filename followed by a dot
4931 and the machine's node name, as obtained from the &[uname()]& function. If this
4932 file does not exist, the standard name is tried. This processing occurs for
4933 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4934
4935 In some esoteric situations different versions of Exim may be run under
4936 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4937 help with this. See the comments in &_src/EDITME_& for details.
4938
4939
4940
4941 .section "Configuration file format" "SECTconffilfor"
4942 .cindex "configuration file" "format of"
4943 .cindex "format" "configuration file"
4944 Exim's configuration file is divided into a number of different parts. General
4945 option settings must always appear at the start of the file. The other parts
4946 are all optional, and may appear in any order. Each part other than the first
4947 is introduced by the word &"begin"& followed by at least one literal
4948 space, and the name of the part. The optional parts are:
4949
4950 .ilist
4951 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4952 &<<CHAPACL>>&).
4953 .next
4954 .cindex "AUTH" "configuration"
4955 &'authenticators'&: Configuration settings for the authenticator drivers. These
4956 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4957 .next
4958 &'routers'&: Configuration settings for the router drivers. Routers process
4959 addresses and determine how the message is to be delivered (see chapters
4960 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4961 .next
4962 &'transports'&: Configuration settings for the transport drivers. Transports
4963 define mechanisms for copying messages to destinations (see chapters
4964 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4965 .next
4966 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4967 If there is no retry section, or if it is empty (that is, no retry rules are
4968 defined), Exim will not retry deliveries. In this situation, temporary errors
4969 are treated the same as permanent errors. Retry rules are discussed in chapter
4970 &<<CHAPretry>>&.
4971 .next
4972 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4973 when new addresses are generated during delivery. Rewriting is discussed in
4974 chapter &<<CHAPrewrite>>&.
4975 .next
4976 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4977 want to use this feature, you must set
4978 .code
4979 LOCAL_SCAN_HAS_OPTIONS=yes
4980 .endd
4981 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4982 facility are given in chapter &<<CHAPlocalscan>>&.
4983 .endlist
4984
4985 .cindex "configuration file" "leading white space in"
4986 .cindex "configuration file" "trailing white space in"
4987 .cindex "white space" "in configuration file"
4988 Leading and trailing white space in configuration lines is always ignored.
4989
4990 Blank lines in the file, and lines starting with a # character (ignoring
4991 leading white space) are treated as comments and are ignored. &*Note*&: A
4992 # character other than at the beginning of a line is not treated specially,
4993 and does not introduce a comment.
4994
4995 Any non-comment line can be continued by ending it with a backslash. Note that
4996 the general rule for white space means that trailing white space after the
4997 backslash and leading white space at the start of continuation
4998 lines is ignored. Comment lines beginning with # (but not empty lines) may
4999 appear in the middle of a sequence of continuation lines.
5000
5001 A convenient way to create a configuration file is to start from the
5002 default, which is supplied in &_src/configure.default_&, and add, delete, or
5003 change settings as required.
5004
5005 The ACLs, retry rules, and rewriting rules have their own syntax which is
5006 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5007 respectively. The other parts of the configuration file have some syntactic
5008 items in common, and these are described below, from section &<<SECTcos>>&
5009 onwards. Before that, the inclusion, macro, and conditional facilities are
5010 described.
5011
5012
5013
5014 .section "File inclusions in the configuration file" "SECID41"
5015 .cindex "inclusions in configuration file"
5016 .cindex "configuration file" "including other files"
5017 .cindex "&`.include`& in configuration file"
5018 .cindex "&`.include_if_exists`& in configuration file"
5019 You can include other files inside Exim's runtime configuration file by
5020 using this syntax:
5021 .display
5022 &`.include`& <&'filename'&>
5023 &`.include_if_exists`& <&'filename'&>
5024 .endd
5025 on a line by itself. Double quotes round the filename are optional. If you use
5026 the first form, a configuration error occurs if the file does not exist; the
5027 second form does nothing for non-existent files.
5028 The first form allows a relative name. It is resolved relative to
5029 the directory of the including file. For the second form an absolute filename
5030 is required.
5031
5032 Includes may be nested to any depth, but remember that Exim reads its
5033 configuration file often, so it is a good idea to keep them to a minimum.
5034 If you change the contents of an included file, you must HUP the daemon,
5035 because an included file is read only when the configuration itself is read.
5036
5037 The processing of inclusions happens early, at a physical line level, so, like
5038 comment lines, an inclusion can be used in the middle of an option setting,
5039 for example:
5040 .code
5041 hosts_lookup = a.b.c \
5042                .include /some/file
5043 .endd
5044 Include processing happens after macro processing (see below). Its effect is to
5045 process the lines of the included file as if they occurred inline where the
5046 inclusion appears.
5047
5048
5049
5050 .section "Macros in the configuration file" "SECTmacrodefs"
5051 .cindex "macro" "description of"
5052 .cindex "configuration file" "macros"
5053 If a line in the main part of the configuration (that is, before the first
5054 &"begin"& line) begins with an upper case letter, it is taken as a macro
5055 definition, and must be of the form
5056 .display
5057 <&'name'&> = <&'rest of line'&>
5058 .endd
5059 The name must consist of letters, digits, and underscores, and need not all be
5060 in upper case, though that is recommended. The rest of the line, including any
5061 continuations, is the replacement text, and has leading and trailing white
5062 space removed. Quotes are not removed. The replacement text can never end with
5063 a backslash character, but this doesn't seem to be a serious limitation.
5064
5065 Macros may also be defined between router, transport, authenticator, or ACL
5066 definitions. They may not, however, be defined within an individual driver or
5067 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5068
5069 .section "Macro substitution" "SECID42"
5070 Once a macro is defined, all subsequent lines in the file (and any included
5071 files) are scanned for the macro name; if there are several macros, the line is
5072 scanned for each, in turn, in the order in which the macros are defined. The
5073 replacement text is not re-scanned for the current macro, though it is scanned
5074 for subsequently defined macros. For this reason, a macro name may not contain
5075 the name of a previously defined macro as a substring. You could, for example,
5076 define
5077 .display
5078 &`ABCD_XYZ = `&<&'something'&>
5079 &`ABCD = `&<&'something else'&>
5080 .endd
5081 but putting the definitions in the opposite order would provoke a configuration
5082 error. Macro expansion is applied to individual physical lines from the file,
5083 before checking for line continuation or file inclusion (see above). If a line
5084 consists solely of a macro name, and the expansion of the macro is empty, the
5085 line is ignored. A macro at the start of a line may turn the line into a
5086 comment line or a &`.include`& line.
5087
5088
5089 .section "Redefining macros" "SECID43"
5090 Once defined, the value of a macro can be redefined later in the configuration
5091 (or in an included file). Redefinition is specified by using &'=='& instead of
5092 &'='&. For example:
5093 .code
5094 MAC =  initial value
5095 ...
5096 MAC == updated value
5097 .endd
5098 Redefinition does not alter the order in which the macros are applied to the
5099 subsequent lines of the configuration file. It is still the same order in which
5100 the macros were originally defined. All that changes is the macro's value.
5101 Redefinition makes it possible to accumulate values. For example:
5102 .code
5103 MAC =  initial value
5104 ...
5105 MAC == MAC and something added
5106 .endd
5107 This can be helpful in situations where the configuration file is built
5108 from a number of other files.
5109
5110 .section "Overriding macro values" "SECID44"
5111 The values set for macros in the configuration file can be overridden by the
5112 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5113 used, unless called by root or the Exim user. A definition on the command line
5114 using the &%-D%& option causes all definitions and redefinitions within the
5115 file to be ignored.
5116
5117
5118
5119 .section "Example of macro usage" "SECID45"
5120 As an example of macro usage, consider a configuration where aliases are looked
5121 up in a MySQL database. It helps to keep the file less cluttered if long
5122 strings such as SQL statements are defined separately as macros, for example:
5123 .code
5124 ALIAS_QUERY = select mailbox from user where \
5125               login='${quote_mysql:$local_part}';
5126 .endd
5127 This can then be used in a &(redirect)& router setting like this:
5128 .code
5129 data = ${lookup mysql{ALIAS_QUERY}}
5130 .endd
5131 In earlier versions of Exim macros were sometimes used for domain, host, or
5132 address lists. In Exim 4 these are handled better by named lists &-- see
5133 section &<<SECTnamedlists>>&.
5134
5135
5136 .section "Builtin macros" "SECTbuiltinmacros"
5137 Exim defines some macros depending on facilities available, which may
5138 differ due to build-time definitions and from one release to another.
5139 All of these macros start with an underscore.
5140 They can be used to conditionally include parts of a configuration
5141 (see below).
5142
5143 The following classes of macros are defined:
5144 .display
5145 &` _HAVE_*                    `&  build-time defines
5146 &` _DRIVER_ROUTER_*           `&  router drivers
5147 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5148 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5149 &` _LOG_*                     `&  log_selector values
5150 &` _OPT_MAIN_*                `&  main config options
5151 &` _OPT_ROUTERS_*             `&  generic router options
5152 &` _OPT_TRANSPORTS_*          `&  generic transport options
5153 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5154 &` _OPT_ROUTER_*_*            `&  private router options
5155 &` _OPT_TRANSPORT_*_*         `&  private transport options
5156 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5157 .endd
5158
5159 Use an &"exim -bP macros"& command to get the list of macros.
5160
5161
5162 .section "Conditional skips in the configuration file" "SECID46"
5163 .cindex "configuration file" "conditional skips"
5164 .cindex "&`.ifdef`&"
5165 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5166 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5167 portions of the configuration file. The processing happens whenever the file is
5168 read (that is, when an Exim binary starts to run).
5169
5170 The implementation is very simple. Instances of the first four directives must
5171 be followed by text that includes the names of one or macros. The condition
5172 that is tested is whether or not any macro substitution has taken place in the
5173 line. Thus:
5174 .code
5175 .ifdef AAA
5176 message_size_limit = 50M
5177 .else
5178 message_size_limit = 100M
5179 .endif
5180 .endd
5181 sets a message size limit of 50M if the macro &`AAA`& is defined
5182 (or &`A`& or &`AA`&), and 100M
5183 otherwise. If there is more than one macro named on the line, the condition
5184 is true if any of them are defined. That is, it is an &"or"& condition. To
5185 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5186
5187 Although you can use a macro expansion to generate one of these directives,
5188 it is not very useful, because the condition &"there was a macro substitution
5189 in this line"& will always be true.
5190
5191 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5192 to clarify complicated nestings.
5193
5194
5195
5196 .section "Common option syntax" "SECTcos"
5197 .cindex "common option syntax"
5198 .cindex "syntax of common options"
5199 .cindex "configuration file" "common option syntax"
5200 For the main set of options, driver options, and &[local_scan()]& options,
5201 each setting is on a line by itself, and starts with a name consisting of
5202 lower-case letters and underscores. Many options require a data value, and in
5203 these cases the name must be followed by an equals sign (with optional white
5204 space) and then the value. For example:
5205 .code
5206 qualify_domain = mydomain.example.com
5207 .endd
5208 .cindex "hiding configuration option values"
5209 .cindex "configuration options" "hiding value of"
5210 .cindex "options" "hiding value of"
5211 Some option settings may contain sensitive data, for example, passwords for
5212 accessing databases. To stop non-admin users from using the &%-bP%& command
5213 line option to read these values, you can precede the option settings with the
5214 word &"hide"&. For example:
5215 .code
5216 hide mysql_servers = localhost/users/admin/secret-password
5217 .endd
5218 For non-admin users, such options are displayed like this:
5219 .code
5220 mysql_servers = <value not displayable>
5221 .endd
5222 If &"hide"& is used on a driver option, it hides the value of that option on
5223 all instances of the same driver.
5224
5225 The following sections describe the syntax used for the different data types
5226 that are found in option settings.
5227
5228
5229 .section "Boolean options" "SECID47"
5230 .cindex "format" "boolean"
5231 .cindex "boolean configuration values"
5232 .oindex "&%no_%&&'xxx'&"
5233 .oindex "&%not_%&&'xxx'&"
5234 Options whose type is given as boolean are on/off switches. There are two
5235 different ways of specifying such options: with and without a data value. If
5236 the option name is specified on its own without data, the switch is turned on;
5237 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5238 boolean options may be followed by an equals sign and one of the words
5239 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5240 the following two settings have exactly the same effect:
5241 .code
5242 queue_only
5243 queue_only = true
5244 .endd
5245 The following two lines also have the same (opposite) effect:
5246 .code
5247 no_queue_only
5248 queue_only = false
5249 .endd
5250 You can use whichever syntax you prefer.
5251
5252
5253
5254
5255 .section "Integer values" "SECID48"
5256 .cindex "integer configuration values"
5257 .cindex "format" "integer"
5258 If an option's type is given as &"integer"&, the value can be given in decimal,
5259 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5260 number is assumed. Otherwise, it is treated as an octal number unless it starts
5261 with the characters &"0x"&, in which case the remainder is interpreted as a
5262 hexadecimal number.
5263
5264 If an integer value is followed by the letter K, it is multiplied by 1024; if
5265 it is followed by the letter M, it is multiplied by 1024x1024;
5266 if by the letter G, 1024x1024x1024.
5267 When the values
5268 of integer option settings are output, values which are an exact multiple of
5269 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5270 and M. The printing style is independent of the actual input format that was
5271 used.
5272
5273
5274 .section "Octal integer values" "SECID49"
5275 .cindex "integer format"
5276 .cindex "format" "octal integer"
5277 If an option's type is given as &"octal integer"&, its value is always
5278 interpreted as an octal number, whether or not it starts with the digit zero.
5279 Such options are always output in octal.
5280
5281
5282 .section "Fixed point numbers" "SECID50"
5283 .cindex "fixed point configuration values"
5284 .cindex "format" "fixed point"
5285 If an option's type is given as &"fixed-point"&, its value must be a decimal
5286 integer, optionally followed by a decimal point and up to three further digits.
5287
5288
5289
5290 .section "Time intervals" "SECTtimeformat"
5291 .cindex "time interval" "specifying in configuration"
5292 .cindex "format" "time interval"
5293 A time interval is specified as a sequence of numbers, each followed by one of
5294 the following letters, with no intervening white space:
5295
5296 .table2 30pt
5297 .irow &%s%& seconds
5298 .irow &%m%& minutes
5299 .irow &%h%& hours
5300 .irow &%d%& days
5301 .irow &%w%& weeks
5302 .endtable
5303
5304 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5305 intervals are output in the same format. Exim does not restrict the values; it
5306 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5307
5308
5309
5310 .section "String values" "SECTstrings"
5311 .cindex "string" "format of configuration values"
5312 .cindex "format" "string"
5313 If an option's type is specified as &"string"&, the value can be specified with
5314 or without double-quotes. If it does not start with a double-quote, the value
5315 consists of the remainder of the line plus any continuation lines, starting at
5316 the first character after any leading white space, with trailing white space
5317 removed, and with no interpretation of the characters in the string. Because
5318 Exim removes comment lines (those beginning with #) at an early stage, they can
5319 appear in the middle of a multi-line string. The following two settings are
5320 therefore equivalent:
5321 .code
5322 trusted_users = uucp:mail
5323 trusted_users = uucp:\
5324                 # This comment line is ignored
5325                 mail
5326 .endd
5327 .cindex "string" "quoted"
5328 .cindex "escape characters in quoted strings"
5329 If a string does start with a double-quote, it must end with a closing
5330 double-quote, and any backslash characters other than those used for line
5331 continuation are interpreted as escape characters, as follows:
5332
5333 .table2 100pt
5334 .irow &`\\`&                     "single backslash"
5335 .irow &`\n`&                     "newline"
5336 .irow &`\r`&                     "carriage return"
5337 .irow &`\t`&                     "tab"
5338 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5339 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5340                                    character"
5341 .endtable
5342
5343 If a backslash is followed by some other character, including a double-quote
5344 character, that character replaces the pair.
5345
5346 Quoting is necessary only if you want to make use of the backslash escapes to
5347 insert special characters, or if you need to specify a value with leading or
5348 trailing spaces. These cases are rare, so quoting is almost never needed in
5349 current versions of Exim. In versions of Exim before 3.14, quoting was required
5350 in order to continue lines, so you may come across older configuration files
5351 and examples that apparently quote unnecessarily.
5352
5353
5354 .section "Expanded strings" "SECID51"
5355 .cindex "expansion" "definition of"
5356 Some strings in the configuration file are subjected to &'string expansion'&,
5357 by which means various parts of the string may be changed according to the
5358 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5359 is as just described; in particular, the handling of backslashes in quoted
5360 strings is done as part of the input process, before expansion takes place.
5361 However, backslash is also an escape character for the expander, so any
5362 backslashes that are required for that reason must be doubled if they are
5363 within a quoted configuration string.
5364
5365
5366 .section "User and group names" "SECID52"
5367 .cindex "user name" "format of"
5368 .cindex "format" "user name"
5369 .cindex "groups" "name format"
5370 .cindex "format" "group name"
5371 User and group names are specified as strings, using the syntax described
5372 above, but the strings are interpreted specially. A user or group name must
5373 either consist entirely of digits, or be a name that can be looked up using the
5374 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5375
5376
5377 .section "List construction" "SECTlistconstruct"
5378 .cindex "list" "syntax of in configuration"
5379 .cindex "format" "list item in configuration"
5380 .cindex "string" "list, definition of"
5381 The data for some configuration options is a list of items, with colon as the
5382 default separator. Many of these options are shown with type &"string list"& in
5383 the descriptions later in this document. Others are listed as &"domain list"&,
5384 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5385 are all the same; however, those other than &"string list"& are subject to
5386 particular kinds of interpretation, as described in chapter
5387 &<<CHAPdomhosaddlists>>&.
5388
5389 In all these cases, the entire list is treated as a single string as far as the
5390 input syntax is concerned. The &%trusted_users%& setting in section
5391 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5392 in a list, it must be entered as two colons. Leading and trailing white space
5393 on each item in a list is ignored. This makes it possible to include items that
5394 start with a colon, and in particular, certain forms of IPv6 address. For
5395 example, the list
5396 .code
5397 local_interfaces = 127.0.0.1 : ::::1
5398 .endd
5399 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5400
5401 &*Note*&: Although leading and trailing white space is ignored in individual
5402 list items, it is not ignored when parsing the list. The space after the first
5403 colon in the example above is necessary. If it were not there, the list would
5404 be interpreted as the two items 127.0.0.1:: and 1.
5405
5406 .section "Changing list separators" "SECTlistsepchange"
5407 .cindex "list separator" "changing"
5408 .cindex "IPv6" "addresses in lists"
5409 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5410 introduced to allow the separator character to be changed. If a list begins
5411 with a left angle bracket, followed by any punctuation character, that
5412 character is used instead of colon as the list separator. For example, the list
5413 above can be rewritten to use a semicolon separator like this:
5414 .code
5415 local_interfaces = <; 127.0.0.1 ; ::1
5416 .endd
5417 This facility applies to all lists, with the exception of the list in
5418 &%log_file_path%&. It is recommended that the use of non-colon separators be
5419 confined to circumstances where they really are needed.
5420
5421 .cindex "list separator" "newline as"
5422 .cindex "newline" "as list separator"
5423 It is also possible to use newline and other control characters (those with
5424 code values less than 32, plus DEL) as separators in lists. Such separators
5425 must be provided literally at the time the list is processed. For options that
5426 are string-expanded, you can write the separator using a normal escape
5427 sequence. This will be processed by the expander before the string is
5428 interpreted as a list. For example, if a newline-separated list of domains is
5429 generated by a lookup, you can process it directly by a line such as this:
5430 .code
5431 domains = <\n ${lookup mysql{.....}}
5432 .endd
5433 This avoids having to change the list separator in such data. You are unlikely
5434 to want to use a control character as a separator in an option that is not
5435 expanded, because the value is literal text. However, it can be done by giving
5436 the value in quotes. For example:
5437 .code
5438 local_interfaces = "<\n 127.0.0.1 \n ::1"
5439 .endd
5440 Unlike printing character separators, which can be included in list items by
5441 doubling, it is not possible to include a control character as data when it is
5442 set as the separator. Two such characters in succession are interpreted as
5443 enclosing an empty list item.
5444
5445
5446
5447 .section "Empty items in lists" "SECTempitelis"
5448 .cindex "list" "empty item in"
5449 An empty item at the end of a list is always ignored. In other words, trailing
5450 separator characters are ignored. Thus, the list in
5451 .code
5452 senders = user@domain :
5453 .endd
5454 contains only a single item. If you want to include an empty string as one item
5455 in a list, it must not be the last item. For example, this list contains three
5456 items, the second of which is empty:
5457 .code
5458 senders = user1@domain : : user2@domain
5459 .endd
5460 &*Note*&: There must be white space between the two colons, as otherwise they
5461 are interpreted as representing a single colon data character (and the list
5462 would then contain just one item). If you want to specify a list that contains
5463 just one, empty item, you can do it as in this example:
5464 .code
5465 senders = :
5466 .endd
5467 In this case, the first item is empty, and the second is discarded because it
5468 is at the end of the list.
5469
5470
5471
5472
5473 .section "Format of driver configurations" "SECTfordricon"
5474 .cindex "drivers" "configuration format"
5475 There are separate parts in the configuration for defining routers, transports,
5476 and authenticators. In each part, you are defining a number of driver
5477 instances, each with its own set of options. Each driver instance is defined by
5478 a sequence of lines like this:
5479 .display
5480 <&'instance name'&>:
5481   <&'option'&>
5482   ...
5483   <&'option'&>
5484 .endd
5485 In the following example, the instance name is &(localuser)&, and it is
5486 followed by three options settings:
5487 .code
5488 localuser:
5489   driver = accept
5490   check_local_user
5491   transport = local_delivery
5492 .endd
5493 For each driver instance, you specify which Exim code module it uses &-- by the
5494 setting of the &%driver%& option &-- and (optionally) some configuration
5495 settings. For example, in the case of transports, if you want a transport to
5496 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5497 a local file you would use the &(appendfile)& driver. Each of the drivers is
5498 described in detail in its own separate chapter later in this manual.
5499
5500 You can have several routers, transports, or authenticators that are based on
5501 the same underlying driver (each must have a different instance name).
5502
5503 The order in which routers are defined is important, because addresses are
5504 passed to individual routers one by one, in order. The order in which
5505 transports are defined does not matter at all. The order in which
5506 authenticators are defined is used only when Exim, as a client, is searching
5507 them to find one that matches an authentication mechanism offered by the
5508 server.
5509
5510 .cindex "generic options"
5511 .cindex "options" "generic &-- definition of"
5512 Within a driver instance definition, there are two kinds of option: &'generic'&
5513 and &'private'&. The generic options are those that apply to all drivers of the
5514 same type (that is, all routers, all transports or all authenticators). The
5515 &%driver%& option is a generic option that must appear in every definition.
5516 .cindex "private options"
5517 The private options are special for each driver, and none need appear, because
5518 they all have default values.
5519
5520 The options may appear in any order, except that the &%driver%& option must
5521 precede any private options, since these depend on the particular driver. For
5522 this reason, it is recommended that &%driver%& always be the first option.
5523
5524 Driver instance names, which are used for reference in log entries and
5525 elsewhere, can be any sequence of letters, digits, and underscores (starting
5526 with a letter) and must be unique among drivers of the same type. A router and
5527 a transport (for example) can each have the same name, but no two router
5528 instances can have the same name. The name of a driver instance should not be
5529 confused with the name of the underlying driver module. For example, the
5530 configuration lines:
5531 .code
5532 remote_smtp:
5533   driver = smtp
5534 .endd
5535 create an instance of the &(smtp)& transport driver whose name is
5536 &(remote_smtp)&. The same driver code can be used more than once, with
5537 different instance names and different option settings each time. A second
5538 instance of the &(smtp)& transport, with different options, might be defined
5539 thus:
5540 .code
5541 special_smtp:
5542   driver = smtp
5543   port = 1234
5544   command_timeout = 10s
5545 .endd
5546 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5547 these transport instances from routers, and these names would appear in log
5548 lines.
5549
5550 Comment lines may be present in the middle of driver specifications. The full
5551 list of option settings for any particular driver instance, including all the
5552 defaulted values, can be extracted by making use of the &%-bP%& command line
5553 option.
5554
5555
5556
5557
5558
5559
5560 . ////////////////////////////////////////////////////////////////////////////
5561 . ////////////////////////////////////////////////////////////////////////////
5562
5563 .chapter "The default configuration file" "CHAPdefconfil"
5564 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5565 .cindex "default" "configuration file &""walk through""&"
5566 The default configuration file supplied with Exim as &_src/configure.default_&
5567 is sufficient for a host with simple mail requirements. As an introduction to
5568 the way Exim is configured, this chapter &"walks through"& the default
5569 configuration, giving brief explanations of the settings. Detailed descriptions
5570 of the options are given in subsequent chapters. The default configuration file
5571 itself contains extensive comments about ways you might want to modify the
5572 initial settings. However, note that there are many options that are not
5573 mentioned at all in the default configuration.
5574
5575
5576
5577 .section "Macros" "SECTdefconfmacros"
5578 All macros should be defined before any options.
5579
5580 One macro is specified, but commented out, in the default configuration:
5581 .code
5582 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5583 .endd
5584 If all off-site mail is expected to be delivered to a "smarthost", then set the
5585 hostname here and uncomment the macro.  This will affect which router is used
5586 later on.  If this is left commented out, then Exim will perform direct-to-MX
5587 deliveries using a &(dnslookup)& router.
5588
5589 In addition to macros defined here, Exim includes a number of built-in macros
5590 to enable configuration to be guarded by a binary built with support for a
5591 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5592
5593
5594 .section "Main configuration settings" "SECTdefconfmain"
5595 The main (global) configuration option settings section must always come first
5596 in the file, after the macros.
5597 The first thing you'll see in the file, after some initial comments, is the line
5598 .code
5599 # primary_hostname =
5600 .endd
5601 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5602 to know the official, fully qualified name of your host, and this is where you
5603 can specify it. However, in most cases you do not need to set this option. When
5604 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5605
5606 The first three non-comment configuration lines are as follows:
5607 .code
5608 domainlist local_domains    = @
5609 domainlist relay_to_domains =
5610 hostlist   relay_from_hosts = 127.0.0.1
5611 .endd
5612 These are not, in fact, option settings. They are definitions of two named
5613 domain lists and one named host list. Exim allows you to give names to lists of
5614 domains, hosts, and email addresses, in order to make it easier to manage the
5615 configuration file (see section &<<SECTnamedlists>>&).
5616
5617 The first line defines a domain list called &'local_domains'&; this is used
5618 later in the configuration to identify domains that are to be delivered
5619 on the local host.
5620
5621 .cindex "@ in a domain list"
5622 There is just one item in this list, the string &"@"&. This is a special form
5623 of entry which means &"the name of the local host"&. Thus, if the local host is
5624 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5625 be delivered locally. Because the local host's name is referenced indirectly,
5626 the same configuration file can be used on different hosts.
5627
5628 The second line defines a domain list called &'relay_to_domains'&, but the
5629 list itself is empty. Later in the configuration we will come to the part that
5630 controls mail relaying through the local host; it allows relaying to any
5631 domains in this list. By default, therefore, no relaying on the basis of a mail
5632 domain is permitted.
5633
5634 The third line defines a host list called &'relay_from_hosts'&. This list is
5635 used later in the configuration to permit relaying from any host or IP address
5636 that matches the list. The default contains just the IP address of the IPv4
5637 loopback interface, which means that processes on the local host are able to
5638 submit mail for relaying by sending it over TCP/IP to that interface. No other
5639 hosts are permitted to submit messages for relaying.
5640
5641 Just to be sure there's no misunderstanding: at this point in the configuration
5642 we aren't actually setting up any controls. We are just defining some domains
5643 and hosts that will be used in the controls that are specified later.
5644
5645 The next two configuration lines are genuine option settings:
5646 .code
5647 acl_smtp_rcpt = acl_check_rcpt
5648 acl_smtp_data = acl_check_data
5649 .endd
5650 These options specify &'Access Control Lists'& (ACLs) that are to be used
5651 during an incoming SMTP session for every recipient of a message (every RCPT
5652 command), and after the contents of the message have been received,
5653 respectively. The names of the lists are &'acl_check_rcpt'& and
5654 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5655 section of the configuration. The RCPT ACL controls which recipients are
5656 accepted for an incoming message &-- if a configuration does not provide an ACL
5657 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5658 contents of a message to be checked.
5659
5660 Two commented-out option settings are next:
5661 .code
5662 # av_scanner = clamd:/tmp/clamd
5663 # spamd_address = 127.0.0.1 783
5664 .endd
5665 These are example settings that can be used when Exim is compiled with the
5666 content-scanning extension. The first specifies the interface to the virus
5667 scanner, and the second specifies the interface to SpamAssassin. Further
5668 details are given in chapter &<<CHAPexiscan>>&.
5669
5670 Three more commented-out option settings follow:
5671 .code
5672 # tls_advertise_hosts = *
5673 # tls_certificate = /etc/ssl/exim.crt
5674 # tls_privatekey = /etc/ssl/exim.pem
5675 .endd
5676 These are example settings that can be used when Exim is compiled with
5677 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5678 first one specifies the list of clients that are allowed to use TLS when
5679 connecting to this server; in this case, the wildcard means all clients. The
5680 other options specify where Exim should find its TLS certificate and private
5681 key, which together prove the server's identity to any clients that connect.
5682 More details are given in chapter &<<CHAPTLS>>&.
5683
5684 Another two commented-out option settings follow:
5685 .code
5686 # daemon_smtp_ports = 25 : 465 : 587
5687 # tls_on_connect_ports = 465
5688 .endd
5689 .cindex "port" "465 and 587"
5690 .cindex "port" "for message submission"
5691 .cindex "message" "submission, ports for"
5692 .cindex "submissions protocol"
5693 .cindex "smtps protocol"
5694 .cindex "ssmtp protocol"
5695 .cindex "SMTP" "submissions protocol"
5696 .cindex "SMTP" "ssmtp protocol"
5697 .cindex "SMTP" "smtps protocol"
5698 These options provide better support for roaming users who wish to use this
5699 server for message submission. They are not much use unless you have turned on
5700 TLS (as described in the previous paragraph) and authentication (about which
5701 more in section &<<SECTdefconfauth>>&).
5702 Mail submission from mail clients (MUAs) should be separate from inbound mail
5703 to your domain (MX delivery) for various good reasons (eg, ability to impose
5704 much saner TLS protocol and ciphersuite requirements without unintended
5705 consequences).
5706 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5707 which uses STARTTLS, so this is the &"submission"& port.
5708 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5709 which should be used in preference to 587.
5710 You should also consider deploying SRV records to help clients find
5711 these ports.
5712 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5713
5714 Two more commented-out options settings follow:
5715 .code
5716 # qualify_domain =
5717 # qualify_recipient =
5718 .endd
5719 The first of these specifies a domain that Exim uses when it constructs a
5720 complete email address from a local login name. This is often needed when Exim
5721 receives a message from a local process. If you do not set &%qualify_domain%&,
5722 the value of &%primary_hostname%& is used. If you set both of these options,
5723 you can have different qualification domains for sender and recipient
5724 addresses. If you set only the first one, its value is used in both cases.
5725
5726 .cindex "domain literal" "recognizing format"
5727 The following line must be uncommented if you want Exim to recognize
5728 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5729 (an IP address within square brackets) instead of a named domain.
5730 .code
5731 # allow_domain_literals
5732 .endd
5733 The RFCs still require this form, but many people think that in the modern
5734 Internet it makes little sense to permit mail to be sent to specific hosts by
5735 quoting their IP addresses. This ancient format has been used by people who
5736 try to abuse hosts by using them for unwanted relaying. However, some
5737 people believe there are circumstances (for example, messages addressed to
5738 &'postmaster'&) where domain literals are still useful.
5739
5740 The next configuration line is a kind of trigger guard:
5741 .code
5742 never_users = root
5743 .endd
5744 It specifies that no delivery must ever be run as the root user. The normal
5745 convention is to set up &'root'& as an alias for the system administrator. This
5746 setting is a guard against slips in the configuration.
5747 The list of users specified by &%never_users%& is not, however, the complete
5748 list; the build-time configuration in &_Local/Makefile_& has an option called
5749 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5750 contents of &%never_users%& are added to this list. By default
5751 FIXED_NEVER_USERS also specifies root.
5752
5753 When a remote host connects to Exim in order to send mail, the only information
5754 Exim has about the host's identity is its IP address. The next configuration
5755 line,
5756 .code
5757 host_lookup = *
5758 .endd
5759 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5760 in order to get a host name. This improves the quality of the logging
5761 information, but if you feel it is too expensive, you can remove it entirely,
5762 or restrict the lookup to hosts on &"nearby"& networks.
5763 Note that it is not always possible to find a host name from an IP address,
5764 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5765 unreachable.
5766
5767 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5768 1413 (hence their names):
5769 .code
5770 rfc1413_hosts = *
5771 rfc1413_query_timeout = 0s
5772 .endd
5773 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5774 Few hosts offer RFC1413 service these days; calls have to be
5775 terminated by a timeout and this needlessly delays the startup
5776 of an incoming SMTP connection.
5777 If you have hosts for which you trust RFC1413 and need this
5778 information, you can change this.
5779
5780 This line enables an efficiency SMTP option.  It is negotiated by clients
5781 and not expected to cause problems but can be disabled if needed.
5782 .code
5783 prdr_enable = true
5784 .endd
5785
5786 When Exim receives messages over SMTP connections, it expects all addresses to
5787 be fully qualified with a domain, as required by the SMTP definition. However,
5788 if you are running a server to which simple clients submit messages, you may
5789 find that they send unqualified addresses. The two commented-out options:
5790 .code
5791 # sender_unqualified_hosts =
5792 # recipient_unqualified_hosts =
5793 .endd
5794 show how you can specify hosts that are permitted to send unqualified sender
5795 and recipient addresses, respectively.
5796
5797 The &%log_selector%& option is used to increase the detail of logging
5798 over the default:
5799 .code
5800 log_selector = +smtp_protocol_error +smtp_syntax_error \
5801                +tls_certificate_verified
5802 .endd
5803
5804 The &%percent_hack_domains%& option is also commented out:
5805 .code
5806 # percent_hack_domains =
5807 .endd
5808 It provides a list of domains for which the &"percent hack"& is to operate.
5809 This is an almost obsolete form of explicit email routing. If you do not know
5810 anything about it, you can safely ignore this topic.
5811
5812 The next two settings in the main part of the default configuration are
5813 concerned with messages that have been &"frozen"& on Exim's queue. When a
5814 message is frozen, Exim no longer continues to try to deliver it. Freezing
5815 occurs when a bounce message encounters a permanent failure because the sender
5816 address of the original message that caused the bounce is invalid, so the
5817 bounce cannot be delivered. This is probably the most common case, but there
5818 are also other conditions that cause freezing, and frozen messages are not
5819 always bounce messages.
5820 .code
5821 ignore_bounce_errors_after = 2d
5822 timeout_frozen_after = 7d
5823 .endd
5824 The first of these options specifies that failing bounce messages are to be
5825 discarded after 2 days in the queue. The second specifies that any frozen
5826 message (whether a bounce message or not) is to be timed out (and discarded)
5827 after a week. In this configuration, the first setting ensures that no failing
5828 bounce message ever lasts a week.
5829
5830 Exim queues it's messages in a spool directory. If you expect to have
5831 large queues, you may consider using this option. It splits the spool
5832 directory into subdirectories to avoid file system degradation from
5833 many files in a single directory, resulting in better performance.
5834 Manual manipulation of queued messages becomes more complex (though fortunately
5835 not often needed).
5836 .code
5837 # split_spool_directory = true
5838 .endd
5839
5840 In an ideal world everybody follows the standards. For non-ASCII
5841 messages RFC 2047 is a standard, allowing a maximum line length of 76
5842 characters. Exim adheres that standard and won't process messages which
5843 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5844 In particular, the Exim maintainers have had multiple reports of
5845 problems from Russian administrators of issues until they disable this
5846 check, because of some popular, yet buggy, mail composition software.
5847 .code
5848 # check_rfc2047_length = false
5849 .endd
5850
5851 If you need to be strictly RFC compliant you may wish to disable the
5852 8BITMIME advertisement. Use this, if you exchange mails with systems
5853 that are not 8-bit clean.
5854 .code
5855 # accept_8bitmime = false
5856 .endd
5857
5858 Libraries you use may depend on specific environment settings.  This
5859 imposes a security risk (e.g. PATH). There are two lists:
5860 &%keep_environment%& for the variables to import as they are, and
5861 &%add_environment%& for variables we want to set to a fixed value.
5862 Note that TZ is handled separately, by the $%timezone%$ runtime
5863 option and by the TIMEZONE_DEFAULT buildtime option.
5864 .code
5865 # keep_environment = ^LDAP
5866 # add_environment = PATH=/usr/bin::/bin
5867 .endd
5868
5869
5870 .section "ACL configuration" "SECID54"
5871 .cindex "default" "ACLs"
5872 .cindex "&ACL;" "default configuration"
5873 In the default configuration, the ACL section follows the main configuration.
5874 It starts with the line
5875 .code
5876 begin acl
5877 .endd
5878 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5879 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5880 and &%acl_smtp_data%& above.
5881
5882 .cindex "RCPT" "ACL for"
5883 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5884 RCPT command specifies one of the message's recipients. The ACL statements
5885 are considered in order, until the recipient address is either accepted or
5886 rejected. The RCPT command is then accepted or rejected, according to the
5887 result of the ACL processing.
5888 .code
5889 acl_check_rcpt:
5890 .endd
5891 This line, consisting of a name terminated by a colon, marks the start of the
5892 ACL, and names it.
5893 .code
5894 accept  hosts = :
5895 .endd
5896 This ACL statement accepts the recipient if the sending host matches the list.
5897 But what does that strange list mean? It doesn't actually contain any host
5898 names or IP addresses. The presence of the colon puts an empty item in the
5899 list; Exim matches this only if the incoming message did not come from a remote
5900 host, because in that case, the remote hostname is empty. The colon is
5901 important. Without it, the list itself is empty, and can never match anything.
5902
5903 What this statement is doing is to accept unconditionally all recipients in
5904 messages that are submitted by SMTP from local processes using the standard
5905 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5906 manner.
5907 .code
5908 deny    message       = Restricted characters in address
5909         domains       = +local_domains
5910         local_parts   = ^[.] : ^.*[@%!/|]
5911
5912 deny    message       = Restricted characters in address
5913         domains       = !+local_domains
5914         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5915 .endd
5916 These statements are concerned with local parts that contain any of the
5917 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5918 Although these characters are entirely legal in local parts (in the case of
5919 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5920 in Internet mail addresses.
5921
5922 The first three have in the past been associated with explicitly routed
5923 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5924 option). Addresses containing these characters are regularly tried by spammers
5925 in an attempt to bypass relaying restrictions, and also by open relay testing
5926 programs. Unless you really need them it is safest to reject these characters
5927 at this early stage. This configuration is heavy-handed in rejecting these
5928 characters for all messages it accepts from remote hosts. This is a deliberate
5929 policy of being as safe as possible.
5930
5931 The first rule above is stricter, and is applied to messages that are addressed
5932 to one of the local domains handled by this host. This is implemented by the
5933 first condition, which restricts it to domains that are listed in the
5934 &'local_domains'& domain list. The &"+"& character is used to indicate a
5935 reference to a named list. In this configuration, there is just one domain in
5936 &'local_domains'&, but in general there may be many.
5937
5938 The second condition on the first statement uses two regular expressions to
5939 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5940 or &"|"&. If you have local accounts that include these characters, you will
5941 have to modify this rule.
5942
5943 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5944 allows them because they have been encountered in practice. (Consider the
5945 common convention of local parts constructed as
5946 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5947 the author of Exim, who has no second initial.) However, a local part starting
5948 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5949 filename (for example, for a mailing list). This is also true for local parts
5950 that contain slashes. A pipe symbol can also be troublesome if the local part
5951 is incorporated unthinkingly into a shell command line.
5952
5953 The second rule above applies to all other domains, and is less strict. This
5954 allows your own users to send outgoing messages to sites that use slashes
5955 and vertical bars in their local parts. It blocks local parts that begin
5956 with a dot, slash, or vertical bar, but allows these characters within the
5957 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5958 and &"!"& is blocked, as before. The motivation here is to prevent your users
5959 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5960 .code
5961 accept  local_parts   = postmaster
5962         domains       = +local_domains
5963 .endd
5964 This statement, which has two conditions, accepts an incoming address if the
5965 local part is &'postmaster'& and the domain is one of those listed in the
5966 &'local_domains'& domain list. The &"+"& character is used to indicate a
5967 reference to a named list. In this configuration, there is just one domain in
5968 &'local_domains'&, but in general there may be many.
5969
5970 The presence of this statement means that mail to postmaster is never blocked
5971 by any of the subsequent tests. This can be helpful while sorting out problems
5972 in cases where the subsequent tests are incorrectly denying access.
5973 .code
5974 require verify        = sender
5975 .endd
5976 This statement requires the sender address to be verified before any subsequent
5977 ACL statement can be used. If verification fails, the incoming recipient
5978 address is refused. Verification consists of trying to route the address, to
5979 see if a bounce message could be delivered to it. In the case of remote
5980 addresses, basic verification checks only the domain, but &'callouts'& can be
5981 used for more verification if required. Section &<<SECTaddressverification>>&
5982 discusses the details of address verification.
5983 .code
5984 accept  hosts         = +relay_from_hosts
5985         control       = submission
5986 .endd
5987 This statement accepts the address if the message is coming from one of the
5988 hosts that are defined as being allowed to relay through this host. Recipient
5989 verification is omitted here, because in many cases the clients are dumb MUAs
5990 that do not cope well with SMTP error responses. For the same reason, the
5991 second line specifies &"submission mode"& for messages that are accepted. This
5992 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5993 messages that are deficient in some way, for example, because they lack a
5994 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5995 probably add recipient verification here, and disable submission mode.
5996 .code
5997 accept  authenticated = *
5998         control       = submission
5999 .endd
6000 This statement accepts the address if the client host has authenticated itself.
6001 Submission mode is again specified, on the grounds that such messages are most
6002 likely to come from MUAs. The default configuration does not define any
6003 authenticators, though it does include some nearly complete commented-out
6004 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6005 fact authenticate until you complete the authenticator definitions.
6006 .code
6007 require message = relay not permitted
6008         domains = +local_domains : +relay_to_domains
6009 .endd
6010 This statement rejects the address if its domain is neither a local domain nor
6011 one of the domains for which this host is a relay.
6012 .code
6013 require verify = recipient
6014 .endd
6015 This statement requires the recipient address to be verified; if verification
6016 fails, the address is rejected.
6017 .code
6018 # deny    message     = rejected because $sender_host_address \
6019 #                       is in a black list at $dnslist_domain\n\
6020 #                       $dnslist_text
6021 #         dnslists    = black.list.example
6022 #
6023 # warn    dnslists    = black.list.example
6024 #         add_header  = X-Warning: $sender_host_address is in \
6025 #                       a black list at $dnslist_domain
6026 #         log_message = found in $dnslist_domain
6027 .endd
6028 These commented-out lines are examples of how you could configure Exim to check
6029 sending hosts against a DNS black list. The first statement rejects messages
6030 from blacklisted hosts, whereas the second just inserts a warning header
6031 line.
6032 .code
6033 # require verify = csa
6034 .endd
6035 This commented-out line is an example of how you could turn on client SMTP
6036 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6037 records.
6038 .code
6039 accept
6040 .endd
6041 The final statement in the first ACL unconditionally accepts any recipient
6042 address that has successfully passed all the previous tests.
6043 .code
6044 acl_check_data:
6045 .endd
6046 This line marks the start of the second ACL, and names it. Most of the contents
6047 of this ACL are commented out:
6048 .code
6049 # deny    malware   = *
6050 #         message   = This message contains a virus \
6051 #                     ($malware_name).
6052 .endd
6053 These lines are examples of how to arrange for messages to be scanned for
6054 viruses when Exim has been compiled with the content-scanning extension, and a
6055 suitable virus scanner is installed. If the message is found to contain a
6056 virus, it is rejected with the given custom error message.
6057 .code
6058 # warn    spam      = nobody
6059 #         message   = X-Spam_score: $spam_score\n\
6060 #                     X-Spam_score_int: $spam_score_int\n\
6061 #                     X-Spam_bar: $spam_bar\n\
6062 #                     X-Spam_report: $spam_report
6063 .endd
6064 These lines are an example of how to arrange for messages to be scanned by
6065 SpamAssassin when Exim has been compiled with the content-scanning extension,
6066 and SpamAssassin has been installed. The SpamAssassin check is run with
6067 &`nobody`& as its user parameter, and the results are added to the message as a
6068 series of extra header line. In this case, the message is not rejected,
6069 whatever the spam score.
6070 .code
6071 accept
6072 .endd
6073 This final line in the DATA ACL accepts the message unconditionally.
6074
6075
6076 .section "Router configuration" "SECID55"
6077 .cindex "default" "routers"
6078 .cindex "routers" "default"
6079 The router configuration comes next in the default configuration, introduced
6080 by the line
6081 .code
6082 begin routers
6083 .endd
6084 Routers are the modules in Exim that make decisions about where to send
6085 messages. An address is passed to each router, in turn, until it is either
6086 accepted, or failed. This means that the order in which you define the routers
6087 matters. Each router is fully described in its own chapter later in this
6088 manual. Here we give only brief overviews.
6089 .code
6090 # domain_literal:
6091 #   driver = ipliteral
6092 #   domains = !+local_domains
6093 #   transport = remote_smtp
6094 .endd
6095 .cindex "domain literal" "default router"
6096 This router is commented out because the majority of sites do not want to
6097 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6098 you uncomment this router, you also need to uncomment the setting of
6099 &%allow_domain_literals%& in the main part of the configuration.
6100
6101 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6102 macro has been defined, per
6103 .code
6104 .ifdef ROUTER_SMARTHOST
6105 smarthost:
6106 #...
6107 .else
6108 dnslookup:
6109 #...
6110 .endif
6111 .endd
6112
6113 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6114 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6115 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6116 skip these routers because of the &%domains%& option.
6117
6118 .code
6119 smarthost:
6120   driver = manualroute
6121   domains = ! +local_domains
6122   transport = smarthost_smtp
6123   route_data = ROUTER_SMARTHOST
6124   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6125   no_more
6126 .endd
6127 This router only handles mail which is not to any local domains; this is
6128 specified by the line
6129 .code
6130 domains = ! +local_domains
6131 .endd
6132 The &%domains%& option lists the domains to which this router applies, but the
6133 exclamation mark is a negation sign, so the router is used only for domains
6134 that are not in the domain list called &'local_domains'& (which was defined at
6135 the start of the configuration). The plus sign before &'local_domains'&
6136 indicates that it is referring to a named list. Addresses in other domains are
6137 passed on to the following routers.
6138
6139 The name of the router driver is &(manualroute)& because we are manually
6140 specifying how mail should be routed onwards, instead of using DNS MX.
6141 While the name of this router instance is arbitrary, the &%driver%& option must
6142 be one of the driver modules that is in the Exim binary.
6143
6144 With no pre-conditions other than &%domains%&, all mail for non-local domains
6145 will be handled by this router, and the &%no_more%& setting will ensure that no
6146 other routers will be used for messages matching the pre-conditions.  See
6147 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6148 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6149 and the macro supplies the value; the address is then queued for the
6150 &(smarthost_smtp)& transport.
6151
6152 .code
6153 dnslookup:
6154   driver = dnslookup
6155   domains = ! +local_domains
6156   transport = remote_smtp
6157   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6158   no_more
6159 .endd
6160 The &%domains%& option behaves as per smarthost, above.
6161
6162 The name of the router driver is &(dnslookup)&,
6163 and is specified by the &%driver%& option. Do not be confused by the fact that
6164 the name of this router instance is the same as the name of the driver. The
6165 instance name is arbitrary, but the name set in the &%driver%& option must be
6166 one of the driver modules that is in the Exim binary.
6167
6168 The &(dnslookup)& router routes addresses by looking up their domains in the
6169 DNS in order to obtain a list of hosts to which the address is routed. If the
6170 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6171 specified by the &%transport%& option. If the router does not find the domain
6172 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6173 the address fails and is bounced.
6174
6175 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6176 be entirely ignored. This option is present because a number of cases have been
6177 encountered where MX records in the DNS point to host names
6178 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6179 Completely ignoring these IP addresses causes Exim to fail to route the
6180 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6181 continue to try to deliver the message periodically until the address timed
6182 out.
6183 .code
6184 system_aliases:
6185   driver = redirect
6186   allow_fail
6187   allow_defer
6188   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6189 # user = exim
6190   file_transport = address_file
6191   pipe_transport = address_pipe
6192 .endd
6193 Control reaches this and subsequent routers only for addresses in the local
6194 domains. This router checks to see whether the local part is defined as an
6195 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6196 data that it looks up from that file. If no data is found for the local part,
6197 the value of the &%data%& option is empty, causing the address to be passed to
6198 the next router.
6199
6200 &_/etc/aliases_& is a conventional name for the system aliases file that is
6201 often used. That is why it is referenced by from the default configuration
6202 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6203 &_Local/Makefile_& before building Exim.
6204 .code
6205 userforward:
6206   driver = redirect
6207   check_local_user
6208 # local_part_suffix = +* : -*
6209 # local_part_suffix_optional
6210   file = $home/.forward
6211 # allow_filter
6212   no_verify
6213   no_expn
6214   check_ancestor
6215   file_transport = address_file
6216   pipe_transport = address_pipe
6217   reply_transport = address_reply
6218 .endd
6219 This is the most complicated router in the default configuration. It is another
6220 redirection router, but this time it is looking for forwarding data set up by
6221 individual users. The &%check_local_user%& setting specifies a check that the
6222 local part of the address is the login name of a local user. If it is not, the
6223 router is skipped. The two commented options that follow &%check_local_user%&,
6224 namely:
6225 .code
6226 # local_part_suffix = +* : -*
6227 # local_part_suffix_optional
6228 .endd
6229 .vindex "&$local_part_suffix$&"
6230 show how you can specify the recognition of local part suffixes. If the first
6231 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6232 by any sequence of characters, is removed from the local part and placed in the
6233 variable &$local_part_suffix$&. The second suffix option specifies that the
6234 presence of a suffix in the local part is optional. When a suffix is present,
6235 the check for a local login uses the local part with the suffix removed.
6236
6237 When a local user account is found, the file called &_.forward_& in the user's
6238 home directory is consulted. If it does not exist, or is empty, the router
6239 declines. Otherwise, the contents of &_.forward_& are interpreted as
6240 redirection data (see chapter &<<CHAPredirect>>& for more details).
6241
6242 .cindex "Sieve filter" "enabling in default router"
6243 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6244 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6245 is commented out by default), the contents of the file are interpreted as a set
6246 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6247 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6248 separate document entitled &'Exim's interfaces to mail filtering'&.
6249
6250 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6251 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6252 There are two reasons for doing this:
6253
6254 .olist
6255 Whether or not a local user has a &_.forward_& file is not really relevant when
6256 checking an address for validity; it makes sense not to waste resources doing
6257 unnecessary work.
6258 .next
6259 More importantly, when Exim is verifying addresses or handling an EXPN
6260 command during an SMTP session, it is running as the Exim user, not as root.
6261 The group is the Exim group, and no additional groups are set up.
6262 It may therefore not be possible for Exim to read users' &_.forward_& files at
6263 this time.
6264 .endlist
6265
6266 The setting of &%check_ancestor%& prevents the router from generating a new
6267 address that is the same as any previous address that was redirected. (This
6268 works round a problem concerning a bad interaction between aliasing and
6269 forwarding &-- see section &<<SECTredlocmai>>&).
6270
6271 The final three option settings specify the transports that are to be used when
6272 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6273 auto-reply, respectively. For example, if a &_.forward_& file contains
6274 .code
6275 a.nother@elsewhere.example, /home/spqr/archive
6276 .endd
6277 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6278 transport.
6279 .code
6280 localuser:
6281   driver = accept
6282   check_local_user
6283 # local_part_suffix = +* : -*
6284 # local_part_suffix_optional
6285   transport = local_delivery
6286 .endd
6287 The final router sets up delivery into local mailboxes, provided that the local
6288 part is the name of a local login, by accepting the address and assigning it to
6289 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6290 routers, so the address is bounced. The commented suffix settings fulfil the
6291 same purpose as they do for the &(userforward)& router.
6292
6293
6294 .section "Transport configuration" "SECID56"
6295 .cindex "default" "transports"
6296 .cindex "transports" "default"
6297 Transports define mechanisms for actually delivering messages. They operate
6298 only when referenced from routers, so the order in which they are defined does
6299 not matter. The transports section of the configuration starts with
6300 .code
6301 begin transports
6302 .endd
6303 Two remote transports and four local transports are defined.
6304 .code
6305 remote_smtp:
6306   driver = smtp
6307   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6308 .ifdef _HAVE_PRDR
6309   hosts_try_prdr = *
6310 .endif
6311 .endd
6312 This transport is used for delivering messages over SMTP connections.
6313 The list of remote hosts comes from the router.
6314 The &%message_size_limit%& usage is a hack to avoid sending on messages
6315 with over-long lines.
6316
6317 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6318 negotiated between client and server and not expected to cause problems
6319 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6320 use of the &%hosts_try_prdr%& configuration option.
6321
6322 The other remote transport is used when delivering to a specific smarthost
6323 with whom there must be some kind of existing relationship, instead of the
6324 usual federated system.
6325
6326 .code
6327 smarthost_smtp:
6328   driver = smtp
6329   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6330   multi_domain
6331   #
6332 .ifdef _HAVE_TLS
6333   # Comment out any of these which you have to, then file a Support
6334   # request with your smarthost provider to get things fixed:
6335   hosts_require_tls = *
6336   tls_verify_hosts = *
6337   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6338   # have to comment it out then this will at least log whether you succeed
6339   # or not:
6340   tls_try_verify_hosts = *
6341   #
6342   # The SNI name should match the name which we'll expect to verify;
6343   # many mail systems don't use SNI and this doesn't matter, but if it does,
6344   # we need to send a name which the remote site will recognize.
6345   # This _should_ be the name which the smarthost operators specified as
6346   # the hostname for sending your mail to.
6347   tls_sni = ROUTER_SMARTHOST
6348   #
6349 .ifdef _HAVE_OPENSSL
6350   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6351 .endif
6352 .ifdef _HAVE_GNUTLS
6353   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6354 .endif
6355 .endif
6356 .ifdef _HAVE_PRDR
6357   hosts_try_prdr = *
6358 .endif
6359 .endd
6360 After the same &%message_size_limit%& hack, we then specify that this Transport
6361 can handle messages to multiple domains in one run.  The assumption here is
6362 that you're routing all non-local mail to the same place and that place is
6363 happy to take all messages from you as quickly as possible.
6364 All other options depend upon built-in macros; if Exim was built without TLS support
6365 then no other options are defined.
6366 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6367 and versions using the &%tls_require_ciphers%& option, where the value to be
6368 used depends upon the library providing TLS.
6369 Beyond that, the options adopt the stance that you should have TLS support available
6370 from your smarthost on today's Internet, so we turn on requiring TLS for the
6371 mail to be delivered, and requiring that the certificate be valid, and match
6372 the expected hostname.  The &%tls_sni%& option can be used by service providers
6373 to select an appropriate certificate to present to you and here we re-use the
6374 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6375 You want to specify the hostname which you'll expect to validate for, and that
6376 should not be subject to insecure tampering via DNS results.
6377
6378 For the &%hosts_try_prdr%& option see the previous transport.
6379
6380 All other options are defaulted.
6381 .code
6382 local_delivery:
6383   driver = appendfile
6384   file = /var/mail/$local_part_verified
6385   delivery_date_add
6386   envelope_to_add
6387   return_path_add
6388 # group = mail
6389 # mode = 0660
6390 .endd
6391 This &(appendfile)& transport is used for local delivery to user mailboxes in
6392 traditional BSD mailbox format.
6393
6394 .new
6395 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6396 as it is provided by a potential bad actor.
6397 Instead we use &$local_part_verified$&,
6398 the result of looking up &$local_part$& in the user database
6399 (done by using &%check_local_user%& in the the router).
6400 .wen
6401
6402 By default &(appendfile)& runs under the uid and gid of the
6403 local user, which requires the sticky bit to be set on the &_/var/mail_&
6404 directory. Some systems use the alternative approach of running mail deliveries
6405 under a particular group instead of using the sticky bit. The commented options
6406 show how this can be done.
6407
6408 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6409 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6410 similarly-named options above.
6411 .code
6412 address_pipe:
6413   driver = pipe
6414   return_output
6415 .endd
6416 This transport is used for handling deliveries to pipes that are generated by
6417 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6418 option specifies that any output on stdout or stderr generated by the pipe is to
6419 be returned to the sender.
6420 .code
6421 address_file:
6422   driver = appendfile
6423   delivery_date_add
6424   envelope_to_add
6425   return_path_add
6426 .endd
6427 This transport is used for handling deliveries to files that are generated by
6428 redirection. The name of the file is not specified in this instance of
6429 &(appendfile)&, because it comes from the &(redirect)& router.
6430 .code
6431 address_reply:
6432   driver = autoreply
6433 .endd
6434 This transport is used for handling automatic replies generated by users'
6435 filter files.
6436
6437
6438
6439 .section "Default retry rule" "SECID57"
6440 .cindex "retry" "default rule"
6441 .cindex "default" "retry rule"
6442 The retry section of the configuration file contains rules which affect the way
6443 Exim retries deliveries that cannot be completed at the first attempt. It is
6444 introduced by the line
6445 .code
6446 begin retry
6447 .endd
6448 In the default configuration, there is just one rule, which applies to all
6449 errors:
6450 .code
6451 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6452 .endd
6453 This causes any temporarily failing address to be retried every 15 minutes for
6454 2 hours, then at intervals starting at one hour and increasing by a factor of
6455 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6456 is not delivered after 4 days of temporary failure, it is bounced. The time is
6457 measured from first failure, not from the time the message was received.
6458
6459 If the retry section is removed from the configuration, or is empty (that is,
6460 if no retry rules are defined), Exim will not retry deliveries. This turns
6461 temporary errors into permanent errors.
6462
6463
6464 .section "Rewriting configuration" "SECID58"
6465 The rewriting section of the configuration, introduced by
6466 .code
6467 begin rewrite
6468 .endd
6469 contains rules for rewriting addresses in messages as they arrive. There are no
6470 rewriting rules in the default configuration file.
6471
6472
6473
6474 .section "Authenticators configuration" "SECTdefconfauth"
6475 .cindex "AUTH" "configuration"
6476 The authenticators section of the configuration, introduced by
6477 .code
6478 begin authenticators
6479 .endd
6480 defines mechanisms for the use of the SMTP AUTH command. The default
6481 configuration file contains two commented-out example authenticators
6482 which support plaintext username/password authentication using the
6483 standard PLAIN mechanism and the traditional but non-standard LOGIN
6484 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6485 to support most MUA software.
6486
6487 The example PLAIN authenticator looks like this:
6488 .code
6489 #PLAIN:
6490 #  driver                  = plaintext
6491 #  server_set_id           = $auth2
6492 #  server_prompts          = :
6493 #  server_condition        = Authentication is not yet configured
6494 #  server_advertise_condition = ${if def:tls_in_cipher }
6495 .endd
6496 And the example LOGIN authenticator looks like this:
6497 .code
6498 #LOGIN:
6499 #  driver                  = plaintext
6500 #  server_set_id           = $auth1
6501 #  server_prompts          = <| Username: | Password:
6502 #  server_condition        = Authentication is not yet configured
6503 #  server_advertise_condition = ${if def:tls_in_cipher }
6504 .endd
6505
6506 The &%server_set_id%& option makes Exim remember the authenticated username
6507 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6508 &%server_prompts%& option configures the &(plaintext)& authenticator so
6509 that it implements the details of the specific authentication mechanism,
6510 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6511 when Exim offers authentication to clients; in the examples, this is only
6512 when TLS or SSL has been started, so to enable the authenticators you also
6513 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6514
6515 The &%server_condition%& setting defines how to verify that the username and
6516 password are correct. In the examples it just produces an error message.
6517 To make the authenticators work, you can use a string expansion
6518 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6519
6520 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6521 usercode and password are in different positions.
6522 Chapter &<<CHAPplaintext>>& covers both.
6523
6524 .ecindex IIDconfiwal
6525
6526
6527
6528 . ////////////////////////////////////////////////////////////////////////////
6529 . ////////////////////////////////////////////////////////////////////////////
6530
6531 .chapter "Regular expressions" "CHAPregexp"
6532
6533 .cindex "regular expressions" "library"
6534 .cindex "PCRE"
6535 Exim supports the use of regular expressions in many of its options. It
6536 uses the PCRE regular expression library; this provides regular expression
6537 matching that is compatible with Perl 5. The syntax and semantics of
6538 regular expressions is discussed in
6539 online Perl manpages, in
6540 many Perl reference books, and also in
6541 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6542 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6543 . --- the http: URL here redirects to another page with the ISBN in the URL
6544 . --- where trying to use https: just redirects back to http:, so sticking
6545 . --- to the old URL for now.  2018-09-07.
6546
6547 The documentation for the syntax and semantics of the regular expressions that
6548 are supported by PCRE is included in the PCRE distribution, and no further
6549 description is included here. The PCRE functions are called from Exim using
6550 the default option settings (that is, with no PCRE options set), except that
6551 the PCRE_CASELESS option is set when the matching is required to be
6552 case-insensitive.
6553
6554 In most cases, when a regular expression is required in an Exim configuration,
6555 it has to start with a circumflex, in order to distinguish it from plain text
6556 or an &"ends with"& wildcard. In this example of a configuration setting, the
6557 second item in the colon-separated list is a regular expression.
6558 .code
6559 domains = a.b.c : ^\\d{3} : *.y.z : ...
6560 .endd
6561 The doubling of the backslash is required because of string expansion that
6562 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6563 of this issue, and a way of avoiding the need for doubling backslashes. The
6564 regular expression that is eventually used in this example contains just one
6565 backslash. The circumflex is included in the regular expression, and has the
6566 normal effect of &"anchoring"& it to the start of the string that is being
6567 matched.
6568
6569 There are, however, two cases where a circumflex is not required for the
6570 recognition of a regular expression: these are the &%match%& condition in a
6571 string expansion, and the &%matches%& condition in an Exim filter file. In
6572 these cases, the relevant string is always treated as a regular expression; if
6573 it does not start with a circumflex, the expression is not anchored, and can
6574 match anywhere in the subject string.
6575
6576 In all cases, if you want a regular expression to match at the end of a string,
6577 you must code the $ metacharacter to indicate this. For example:
6578 .code
6579 domains = ^\\d{3}\\.example
6580 .endd
6581 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6582 You need to use:
6583 .code
6584 domains = ^\\d{3}\\.example\$
6585 .endd
6586 if you want &'example'& to be the top-level domain. The backslash before the
6587 $ is needed because string expansion also interprets dollar characters.
6588
6589
6590
6591 . ////////////////////////////////////////////////////////////////////////////
6592 . ////////////////////////////////////////////////////////////////////////////
6593
6594 .chapter "File and database lookups" "CHAPfdlookup"
6595 .scindex IIDfidalo1 "file" "lookups"
6596 .scindex IIDfidalo2 "database" "lookups"
6597 .cindex "lookup" "description of"
6598 Exim can be configured to look up data in files or databases as it processes
6599 messages. Two different kinds of syntax are used:
6600
6601 .olist
6602 A string that is to be expanded may contain explicit lookup requests. These
6603 cause parts of the string to be replaced by data that is obtained from the
6604 lookup. Lookups of this type are conditional expansion items. Different results
6605 can be defined for the cases of lookup success and failure. See chapter
6606 &<<CHAPexpand>>&, where string expansions are described in detail.
6607 The key for the lookup is specified as part of the string expansion.
6608 .next
6609 Lists of domains, hosts, and email addresses can contain lookup requests as a
6610 way of avoiding excessively long linear lists. In this case, the data that is
6611 returned by the lookup is often (but not always) discarded; whether the lookup
6612 succeeds or fails is what really counts. These kinds of list are described in
6613 chapter &<<CHAPdomhosaddlists>>&.
6614 The key for the lookup is given by the context in which the list is expanded.
6615 .endlist
6616
6617 String expansions, lists, and lookups interact with each other in such a way
6618 that there is no order in which to describe any one of them that does not
6619 involve references to the others. Each of these three chapters makes more sense
6620 if you have read the other two first. If you are reading this for the first
6621 time, be aware that some of it will make a lot more sense after you have read
6622 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6623
6624 .section "Examples of different lookup syntax" "SECID60"
6625 It is easy to confuse the two different kinds of lookup, especially as the
6626 lists that may contain the second kind are always expanded before being
6627 processed as lists. Therefore, they may also contain lookups of the first kind.
6628 Be careful to distinguish between the following two examples:
6629 .code
6630 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6631 domains = lsearch;/some/file
6632 .endd
6633 The first uses a string expansion, the result of which must be a domain list.
6634 No strings have been specified for a successful or a failing lookup; the
6635 defaults in this case are the looked-up data and an empty string, respectively.
6636 The expansion takes place before the string is processed as a list, and the
6637 file that is searched could contain lines like this:
6638 .code
6639 192.168.3.4: domain1:domain2:...
6640 192.168.1.9: domain3:domain4:...
6641 .endd
6642 When the lookup succeeds, the result of the expansion is a list of domains (and
6643 possibly other types of item that are allowed in domain lists).
6644
6645 In the second example, the lookup is a single item in a domain list. It causes
6646 Exim to use a lookup to see if the domain that is being processed can be found
6647 in the file. The file could contains lines like this:
6648 .code
6649 domain1:
6650 domain2:
6651 .endd
6652 Any data that follows the keys is not relevant when checking that the domain
6653 matches the list item.
6654
6655 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6656 Consider a file containing lines like this:
6657 .code
6658 192.168.5.6: lsearch;/another/file
6659 .endd
6660 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6661 first &%domains%& setting above generates the second setting, which therefore
6662 causes a second lookup to occur.
6663
6664 The rest of this chapter describes the different lookup types that are
6665 available. Any of them can be used in any part of the configuration where a
6666 lookup is permitted.
6667
6668
6669 .section "Lookup types" "SECID61"
6670 .cindex "lookup" "types of"
6671 .cindex "single-key lookup" "definition of"
6672 Two different types of data lookup are implemented:
6673
6674 .ilist
6675 The &'single-key'& type requires the specification of a file in which to look,
6676 and a single key to search for. The key must be a non-empty string for the
6677 lookup to succeed. The lookup type determines how the file is searched.
6678 .new
6679 .cindex "tainted data" "single-key lookups"
6680 The file string may not be tainted
6681 .wen
6682 .next
6683 .cindex "query-style lookup" "definition of"
6684 The &'query-style'& type accepts a generalized database query. No particular
6685 key value is assumed by Exim for query-style lookups. You can use whichever
6686 Exim variables you need to construct the database query.
6687 .endlist
6688
6689 The code for each lookup type is in a separate source file that is included in
6690 the binary of Exim only if the corresponding compile-time option is set. The
6691 default settings in &_src/EDITME_& are:
6692 .code
6693 LOOKUP_DBM=yes
6694 LOOKUP_LSEARCH=yes
6695 .endd
6696 which means that only linear searching and DBM lookups are included by default.
6697 For some types of lookup (e.g. SQL databases), you need to install appropriate
6698 libraries and header files before building Exim.
6699
6700
6701
6702
6703 .section "Single-key lookup types" "SECTsinglekeylookups"
6704 .cindex "lookup" "single-key types"
6705 .cindex "single-key lookup" "list of types"
6706 The following single-key lookup types are implemented:
6707
6708 .ilist
6709 .cindex "cdb" "description of"
6710 .cindex "lookup" "cdb"
6711 .cindex "binary zero" "in lookup key"
6712 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6713 string without a terminating binary zero. The cdb format is designed for
6714 indexed files that are read frequently and never updated, except by total
6715 re-creation. As such, it is particularly suitable for large files containing
6716 aliases or other indexed data referenced by an MTA. Information about cdb and
6717 tools for building the files can be found in several places:
6718 .display
6719 &url(https://cr.yp.to/cdb.html)
6720 &url(https://www.corpit.ru/mjt/tinycdb.html)
6721 &url(https://packages.debian.org/stable/utils/freecdb)
6722 &url(https://github.com/philpennock/cdbtools) (in Go)
6723 .endd
6724 A cdb distribution is not needed in order to build Exim with cdb support,
6725 because the code for reading cdb files is included directly in Exim itself.
6726 However, no means of building or testing cdb files is provided with Exim, so
6727 you need to obtain a cdb distribution in order to do this.
6728 .next
6729 .cindex "DBM" "lookup type"
6730 .cindex "lookup" "dbm"
6731 .cindex "binary zero" "in lookup key"
6732 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6733 DBM file by looking up the record with the given key. A terminating binary
6734 zero is included in the key that is passed to the DBM library. See section
6735 &<<SECTdb>>& for a discussion of DBM libraries.
6736
6737 .cindex "Berkeley DB library" "file format"
6738 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6739 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6740 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6741 the DB_UNKNOWN option. This enables it to handle any of the types of database
6742 that the library supports, and can be useful for accessing DBM files created by
6743 other applications. (For earlier DB versions, DB_HASH is always used.)
6744 .next
6745 .cindex "lookup" "dbmjz"
6746 .cindex "lookup" "dbm &-- embedded NULs"
6747 .cindex "sasldb2"
6748 .cindex "dbmjz lookup type"
6749 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6750 interpreted as an Exim list; the elements of the list are joined together with
6751 ASCII NUL characters to form the lookup key.  An example usage would be to
6752 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6753 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6754 &(cram_md5)& authenticator.
6755 .next
6756 .cindex "lookup" "dbmnz"
6757 .cindex "lookup" "dbm &-- terminating zero"
6758 .cindex "binary zero" "in lookup key"
6759 .cindex "Courier"
6760 .cindex "&_/etc/userdbshadow.dat_&"
6761 .cindex "dbmnz lookup type"
6762 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6763 is not included in the key that is passed to the DBM library. You may need this
6764 if you want to look up data in files that are created by or shared with some
6765 other application that does not use terminating zeros. For example, you need to
6766 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6767 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6768 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6769 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6770 .next
6771 .cindex "lookup" "dsearch"
6772 .cindex "dsearch lookup type"
6773 &(dsearch)&: The given file must be an
6774 .new
6775 absolute
6776 .wen
6777 directory path; this is searched for an entry
6778 whose name is the key by calling the &[lstat()]& function.
6779 The key may not
6780 contain any forward slash characters.
6781 If &[lstat()]& succeeds then so does the lookup.
6782 .new
6783 .cindex "tainted data" "dsearch result"
6784 The result is regarded as untainted.
6785
6786 Options for the lookup can be given by appending them after the word "dsearch",
6787 separated by a comma.  Options, if present, are a comma-separated list having
6788 each element starting with a tag name and an equals.
6789
6790 Two options are supported, for the return value and for filtering match
6791 candidates.
6792 The "ret" option requests an alternate result value of
6793 the entire path for the entry. Example:
6794 .code
6795 ${lookup {passwd} dsearch,ret=full {/etc}}
6796 .endd
6797 The default result is just the requested entry.
6798 The "filter" option requests that only directory entries of a given type
6799 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6800 not matching "." or ".."). Example:
6801 .code
6802 ${lookup {passwd} dsearch,filter=file {/etc}}
6803 .endd
6804 The default matching is for any entry type, including directories
6805 and symlinks.
6806 .wen
6807
6808 An example of how this
6809 lookup can be used to support virtual domains is given in section
6810 &<<SECTvirtualdomains>>&.
6811 .next
6812 .cindex "lookup" "iplsearch"
6813 .cindex "iplsearch lookup type"
6814 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6815 terminated by a colon or white space or the end of the line. The keys in the
6816 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6817 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6818 being interpreted as a key terminator. For example:
6819 .code
6820 1.2.3.4:           data for 1.2.3.4
6821 192.168.0.0/16:    data for 192.168.0.0/16
6822 "abcd::cdab":      data for abcd::cdab
6823 "abcd:abcd::/32"   data for abcd:abcd::/32
6824 .endd
6825 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6826 file is searched linearly, using the CIDR masks where present, until a matching
6827 key is found. The first key that matches is used; there is no attempt to find a
6828 &"best"& match. Apart from the way the keys are matched, the processing for
6829 &(iplsearch)& is the same as for &(lsearch)&.
6830
6831 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6832 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6833 lookup types support only literal keys.
6834
6835 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6836 the implicit key is the host's IP address rather than its name (see section
6837 &<<SECThoslispatsikey>>&).
6838
6839 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6840 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6841 notation before executing the lookup.)
6842 .next
6843 .cindex lookup json
6844 .cindex json "lookup type"
6845 .cindex JSON expansions
6846 &(json)&: The given file is a text file with a JSON structure.
6847 An element of the structure is extracted, defined by the search key.
6848 The key is a list of subelement selectors
6849 (colon-separated by default but changeable in the usual way)
6850 which are applied in turn to select smaller and smaller portions
6851 of the JSON structure.
6852 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6853 nunbered array element is selected.
6854 Otherwise it must apply to a JSON object; the named element is selected.
6855 The final resulting element can be a simple JSON type or a JSON object
6856 or array; for the latter two a string-representation os the JSON
6857 is returned.
6858 For elements of type string, the returned value is de-quoted.
6859 .next
6860 .cindex "linear search"
6861 .cindex "lookup" "lsearch"
6862 .cindex "lsearch lookup type"
6863 .cindex "case sensitivity" "in lsearch lookup"
6864 &(lsearch)&: The given file is a text file that is searched linearly for a
6865 line beginning with the search key, terminated by a colon or white space or the
6866 end of the line. The search is case-insensitive; that is, upper and lower case
6867 letters are treated as the same. The first occurrence of the key that is found
6868 in the file is used.
6869
6870 White space between the key and the colon is permitted. The remainder of the
6871 line, with leading and trailing white space removed, is the data. This can be
6872 continued onto subsequent lines by starting them with any amount of white
6873 space, but only a single space character is included in the data at such a
6874 junction. If the data begins with a colon, the key must be terminated by a
6875 colon, for example:
6876 .code
6877 baduser:  :fail:
6878 .endd
6879 Empty lines and lines beginning with # are ignored, even if they occur in the
6880 middle of an item. This is the traditional textual format of alias files. Note
6881 that the keys in an &(lsearch)& file are literal strings. There is no
6882 wildcarding of any kind.
6883
6884 .cindex "lookup" "lsearch &-- colons in keys"
6885 .cindex "white space" "in lsearch key"
6886 In most &(lsearch)& files, keys are not required to contain colons or #
6887 characters, or white space. However, if you need this feature, it is available.
6888 If a key begins with a doublequote character, it is terminated only by a
6889 matching quote (or end of line), and the normal escaping rules apply to its
6890 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6891 quoted keys (exactly as for unquoted keys). There is no special handling of
6892 quotes for the data part of an &(lsearch)& line.
6893
6894 .next
6895 .cindex "NIS lookup type"
6896 .cindex "lookup" "NIS"
6897 .cindex "binary zero" "in lookup key"
6898 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6899 the given key, without a terminating binary zero. There is a variant called
6900 &(nis0)& which does include the terminating binary zero in the key. This is
6901 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6902 aliases; the full map names must be used.
6903
6904 .next
6905 .cindex "wildlsearch lookup type"
6906 .cindex "lookup" "wildlsearch"
6907 .cindex "nwildlsearch lookup type"
6908 .cindex "lookup" "nwildlsearch"
6909 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6910 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6911 the file may be wildcarded. The difference between these two lookup types is
6912 that for &(wildlsearch)&, each key in the file is string-expanded before being
6913 used, whereas for &(nwildlsearch)&, no expansion takes place.
6914
6915 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6916 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6917 file that are regular expressions can be made case-sensitive by the use of
6918 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6919
6920 . ==== As this is a nested list, any displays it contains must be indented
6921 . ==== as otherwise they are too far to the left.
6922
6923 .olist
6924 The string may begin with an asterisk to mean &"ends with"&. For example:
6925 .code
6926     *.a.b.c       data for anything.a.b.c
6927     *fish         data for anythingfish
6928 .endd
6929 .next
6930 The string may begin with a circumflex to indicate a regular expression. For
6931 example, for &(wildlsearch)&:
6932 .code
6933     ^\N\d+\.a\.b\N    data for <digits>.a.b
6934 .endd
6935 Note the use of &`\N`& to disable expansion of the contents of the regular
6936 expression. If you are using &(nwildlsearch)&, where the keys are not
6937 string-expanded, the equivalent entry is:
6938 .code
6939     ^\d+\.a\.b        data for <digits>.a.b
6940 .endd
6941 The case-insensitive flag is set at the start of compiling the regular
6942 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6943 For example, to make the entire pattern case-sensitive:
6944 .code
6945     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6946 .endd
6947
6948 If the regular expression contains white space or colon characters, you must
6949 either quote it (see &(lsearch)& above), or represent these characters in other
6950 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6951 colon. This may be easier than quoting, because if you quote, you have to
6952 escape all the backslashes inside the quotes.
6953
6954 &*Note*&: It is not possible to capture substrings in a regular expression
6955 match for later use, because the results of all lookups are cached. If a lookup
6956 is repeated, the result is taken from the cache, and no actual pattern matching
6957 takes place. The values of all the numeric variables are unset after a
6958 &((n)wildlsearch)& match.
6959
6960 .next
6961 Although I cannot see it being of much use, the general matching function that
6962 is used to implement &((n)wildlsearch)& means that the string may begin with a
6963 lookup name terminated by a semicolon, and followed by lookup data. For
6964 example:
6965 .code
6966     cdb;/some/file  data for keys that match the file
6967 .endd
6968 The data that is obtained from the nested lookup is discarded.
6969 .endlist olist
6970
6971 Keys that do not match any of these patterns are interpreted literally. The
6972 continuation rules for the data are the same as for &(lsearch)&, and keys may
6973 be followed by optional colons.
6974
6975 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6976 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6977 lookup types support only literal keys.
6978
6979 .next
6980 .cindex "lookup" "spf"
6981 If Exim is built with SPF support, manual lookups can be done
6982 (as opposed to the standard ACL condition method.
6983 For details see section &<<SECSPF>>&.
6984 .endlist ilist
6985
6986
6987 .section "Query-style lookup types" "SECTquerystylelookups"
6988 .cindex "lookup" "query-style types"
6989 .cindex "query-style lookup" "list of types"
6990 The supported query-style lookup types are listed below. Further details about
6991 many of them are given in later sections.
6992
6993 .ilist
6994 .cindex "DNS" "as a lookup type"
6995 .cindex "lookup" "DNS"
6996 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6997 are given in the supplied query. The resulting data is the contents of the
6998 records. See section &<<SECTdnsdb>>&.
6999 .next
7000 .cindex "InterBase lookup type"
7001 .cindex "lookup" "InterBase"
7002 &(ibase)&: This does a lookup in an InterBase database.
7003 .next
7004 .cindex "LDAP" "lookup type"
7005 .cindex "lookup" "LDAP"
7006 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7007 returns attributes from a single entry. There is a variant called &(ldapm)&
7008 that permits values from multiple entries to be returned. A third variant
7009 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7010 any attribute values. See section &<<SECTldap>>&.
7011 .next
7012 .cindex "MySQL" "lookup type"
7013 .cindex "lookup" "MySQL"
7014 &(mysql)&: The format of the query is an SQL statement that is passed to a
7015 MySQL database. See section &<<SECTsql>>&.
7016 .next
7017 .cindex "NIS+ lookup type"
7018 .cindex "lookup" "NIS+"
7019 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7020 the field to be returned. See section &<<SECTnisplus>>&.
7021 .next
7022 .cindex "Oracle" "lookup type"
7023 .cindex "lookup" "Oracle"
7024 &(oracle)&: The format of the query is an SQL statement that is passed to an
7025 Oracle database. See section &<<SECTsql>>&.
7026 .next
7027 .cindex "lookup" "passwd"
7028 .cindex "passwd lookup type"
7029 .cindex "&_/etc/passwd_&"
7030 &(passwd)& is a query-style lookup with queries that are just user names. The
7031 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7032 success, the result string is the same as you would get from an &(lsearch)&
7033 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7034 password value. For example:
7035 .code
7036 *:42:42:King Rat:/home/kr:/bin/bash
7037 .endd
7038 .next
7039 .cindex "PostgreSQL lookup type"
7040 .cindex "lookup" "PostgreSQL"
7041 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7042 PostgreSQL database. See section &<<SECTsql>>&.
7043
7044 .next
7045 .cindex "Redis lookup type"
7046 .cindex lookup Redis
7047 &(redis)&: The format of the query is either a simple get or simple set,
7048 passed to a Redis database. See section &<<SECTsql>>&.
7049
7050 .next
7051 .cindex "sqlite lookup type"
7052 .cindex "lookup" "sqlite"
7053 &(sqlite)&: The format of the query is
7054 new
7055 an optional filename
7056 .wen
7057 followed by an SQL statement
7058 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7059
7060 .next
7061 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7062 not likely to be useful in normal operation.
7063 .next
7064 .cindex "whoson lookup type"
7065 .cindex "lookup" "whoson"
7066 . --- still http:-only, 2018-09-07
7067 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7068 allows a server to check whether a particular (dynamically allocated) IP
7069 address is currently allocated to a known (trusted) user and, optionally, to
7070 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7071 at one time for &"POP before SMTP"& authentication, but that approach has been
7072 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7073 &"POP before SMTP"& checking using ACL statements such as
7074 .code
7075 require condition = \
7076   ${lookup whoson {$sender_host_address}{yes}{no}}
7077 .endd
7078 The query consists of a single IP address. The value returned is the name of
7079 the authenticated user, which is stored in the variable &$value$&. However, in
7080 this example, the data in &$value$& is not used; the result of the lookup is
7081 one of the fixed strings &"yes"& or &"no"&.
7082 .endlist
7083
7084
7085
7086 .section "Temporary errors in lookups" "SECID63"
7087 .cindex "lookup" "temporary error in"
7088 Lookup functions can return temporary error codes if the lookup cannot be
7089 completed. For example, an SQL or LDAP database might be unavailable. For this
7090 reason, it is not advisable to use a lookup that might do this for critical
7091 options such as a list of local domains.
7092
7093 When a lookup cannot be completed in a router or transport, delivery
7094 of the message (to the relevant address) is deferred, as for any other
7095 temporary error. In other circumstances Exim may assume the lookup has failed,
7096 or may give up altogether.
7097
7098
7099
7100 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7101 .cindex "wildcard lookups"
7102 .cindex "lookup" "default values"
7103 .cindex "lookup" "wildcard"
7104 .cindex "lookup" "* added to type"
7105 .cindex "default" "in single-key lookups"
7106 In this context, a &"default value"& is a value specified by the administrator
7107 that is to be used if a lookup fails.
7108
7109 &*Note:*& This section applies only to single-key lookups. For query-style
7110 lookups, the facilities of the query language must be used. An attempt to
7111 specify a default for a query-style lookup provokes an error.
7112
7113 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7114 and the initial lookup fails, the key &"*"& is looked up in the file to
7115 provide a default value. See also the section on partial matching below.
7116
7117 .cindex "*@ with single-key lookup"
7118 .cindex "lookup" "*@ added to type"
7119 .cindex "alias file" "per-domain default"
7120 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7121 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7122 character, a second lookup is done with everything before the last @ replaced
7123 by *. This makes it possible to provide per-domain defaults in alias files
7124 that include the domains in the keys. If the second lookup fails (or doesn't
7125 take place because there is no @ in the key), &"*"& is looked up.
7126 For example, a &(redirect)& router might contain:
7127 .code
7128 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7129 .endd
7130 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7131 looks up these keys, in this order:
7132 .code
7133 jane@eyre.example
7134 *@eyre.example
7135 *
7136 .endd
7137 The data is taken from whichever key it finds first. &*Note*&: In an
7138 &(lsearch)& file, this does not mean the first of these keys in the file. A
7139 complete scan is done for each key, and only if it is not found at all does
7140 Exim move on to try the next key.
7141
7142
7143
7144 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7145 .cindex "partial matching"
7146 .cindex "wildcard lookups"
7147 .cindex "lookup" "partial matching"
7148 .cindex "lookup" "wildcard"
7149 .cindex "asterisk" "in search type"
7150 The normal operation of a single-key lookup is to search the file for an exact
7151 match with the given key. However, in a number of situations where domains are
7152 being looked up, it is useful to be able to do partial matching. In this case,
7153 information in the file that has a key starting with &"*."& is matched by any
7154 domain that ends with the components that follow the full stop. For example, if
7155 a key in a DBM file is
7156 .code
7157 *.dates.fict.example
7158 .endd
7159 then when partial matching is enabled this is matched by (amongst others)
7160 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7161 by &'dates.fict.example'&, if that does not appear as a separate key in the
7162 file.
7163
7164 &*Note*&: Partial matching is not available for query-style lookups. It is
7165 also not available for any lookup items in address lists (see section
7166 &<<SECTaddresslist>>&).
7167
7168 Partial matching is implemented by doing a series of separate lookups using
7169 keys constructed by modifying the original subject key. This means that it can
7170 be used with any of the single-key lookup types, provided that
7171 partial matching keys
7172 beginning with a special prefix (default &"*."&) are included in the data file.
7173 Keys in the file that do not begin with the prefix are matched only by
7174 unmodified subject keys when partial matching is in use.
7175
7176 Partial matching is requested by adding the string &"partial-"& to the front of
7177 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7178 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7179 is added at the start of the subject key, and it is looked up again. If that
7180 fails, further lookups are tried with dot-separated components removed from the
7181 start of the subject key, one-by-one, and &"*."& added on the front of what
7182 remains.
7183
7184 A minimum number of two non-* components are required. This can be adjusted
7185 by including a number before the hyphen in the search type. For example,
7186 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7187 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7188 subject key is &'2250.dates.fict.example'& then the following keys are looked
7189 up when the minimum number of non-* components is two:
7190 .code
7191 2250.dates.fict.example
7192 *.2250.dates.fict.example
7193 *.dates.fict.example
7194 *.fict.example
7195 .endd
7196 As soon as one key in the sequence is successfully looked up, the lookup
7197 finishes.
7198
7199 .cindex "lookup" "partial matching &-- changing prefix"
7200 .cindex "prefix" "for partial matching"
7201 The use of &"*."& as the partial matching prefix is a default that can be
7202 changed. The motivation for this feature is to allow Exim to operate with file
7203 formats that are used by other MTAs. A different prefix can be supplied in
7204 parentheses instead of the hyphen after &"partial"&. For example:
7205 .code
7206 domains = partial(.)lsearch;/some/file
7207 .endd
7208 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7209 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7210 components is unchanged). The prefix may consist of any punctuation characters
7211 other than a closing parenthesis. It may be empty, for example:
7212 .code
7213 domains = partial1()cdb;/some/file
7214 .endd
7215 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7216 &`a.b.c`&, &`b.c`&, and &`c`&.
7217
7218 If &"partial0"& is specified, what happens at the end (when the lookup with
7219 just one non-wild component has failed, and the original key is shortened right
7220 down to the null string) depends on the prefix:
7221
7222 .ilist
7223 If the prefix has zero length, the whole lookup fails.
7224 .next
7225 If the prefix has length 1, a lookup for just the prefix is done. For
7226 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7227 .next
7228 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7229 remainder is looked up. With the default prefix, therefore, the final lookup is
7230 for &"*"& on its own.
7231 .next
7232 Otherwise, the whole prefix is looked up.
7233 .endlist
7234
7235
7236 If the search type ends in &"*"& or &"*@"& (see section
7237 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7238 this implies happens after all partial lookups have failed. If &"partial0"& is
7239 specified, adding &"*"& to the search type has no effect with the default
7240 prefix, because the &"*"& key is already included in the sequence of partial
7241 lookups. However, there might be a use for lookup types such as
7242 &"partial0(.)lsearch*"&.
7243
7244 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7245 in domain lists and the like. Partial matching works only in terms of
7246 dot-separated components; a key such as &`*fict.example`&
7247 in a database file is useless, because the asterisk in a partial matching
7248 subject key is always followed by a dot.
7249
7250
7251
7252
7253 .section "Lookup caching" "SECID64"
7254 .cindex "lookup" "caching"
7255 .cindex "caching" "lookup data"
7256 Exim caches all lookup results in order to avoid needless repetition of
7257 lookups. However, because (apart from the daemon) Exim operates as a collection
7258 of independent, short-lived processes, this caching applies only within a
7259 single Exim process. There is no inter-process lookup caching facility.
7260
7261 For single-key lookups, Exim keeps the relevant files open in case there is
7262 another lookup that needs them. In some types of configuration this can lead to
7263 many files being kept open for messages with many recipients. To avoid hitting
7264 the operating system limit on the number of simultaneously open files, Exim
7265 closes the least recently used file when it needs to open more files than its
7266 own internal limit, which can be changed via the &%lookup_open_max%& option.
7267
7268 The single-key lookup files are closed and the lookup caches are flushed at
7269 strategic points during delivery &-- for example, after all routing is
7270 complete.
7271
7272
7273
7274
7275 .section "Quoting lookup data" "SECID65"
7276 .cindex "lookup" "quoting"
7277 .cindex "quoting" "in lookups"
7278 When data from an incoming message is included in a query-style lookup, there
7279 is the possibility of special characters in the data messing up the syntax of
7280 the query. For example, a NIS+ query that contains
7281 .code
7282 [name=$local_part]
7283 .endd
7284 will be broken if the local part happens to contain a closing square bracket.
7285 For NIS+, data can be enclosed in double quotes like this:
7286 .code
7287 [name="$local_part"]
7288 .endd
7289 but this still leaves the problem of a double quote in the data. The rule for
7290 NIS+ is that double quotes must be doubled. Other lookup types have different
7291 rules, and to cope with the differing requirements, an expansion operator
7292 of the following form is provided:
7293 .code
7294 ${quote_<lookup-type>:<string>}
7295 .endd
7296 For example, the safest way to write the NIS+ query is
7297 .code
7298 [name="${quote_nisplus:$local_part}"]
7299 .endd
7300 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7301 operator can be used for all lookup types, but has no effect for single-key
7302 lookups, since no quoting is ever needed in their key strings.
7303
7304
7305
7306
7307 .section "More about dnsdb" "SECTdnsdb"
7308 .cindex "dnsdb lookup"
7309 .cindex "lookup" "dnsdb"
7310 .cindex "DNS" "as a lookup type"
7311 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7312 of a record type and a domain name, separated by an equals sign. For example,
7313 an expansion string could contain:
7314 .code
7315 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7316 .endd
7317 If the lookup succeeds, the result is placed in &$value$&, which in this case
7318 is used on its own as the result. If the lookup does not succeed, the
7319 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7320 &<<SECTforexpfai>>& for an explanation of what this means.
7321
7322 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7323 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7324 If no type is given, TXT is assumed.
7325
7326 For any record type, if multiple records are found, the data is returned as a
7327 concatenation, with newline as the default separator. The order, of course,
7328 depends on the DNS resolver. You can specify a different separator character
7329 between multiple records by putting a right angle-bracket followed immediately
7330 by the new separator at the start of the query. For example:
7331 .code
7332 ${lookup dnsdb{>: a=host1.example}}
7333 .endd
7334 It is permitted to specify a space as the separator character. Further
7335 white space is ignored.
7336 For lookup types that return multiple fields per record,
7337 an alternate field separator can be specified using a comma after the main
7338 separator character, followed immediately by the field separator.
7339
7340 .cindex "PTR record" "in &(dnsdb)& lookup"
7341 When the type is PTR,
7342 the data can be an IP address, written as normal; inversion and the addition of
7343 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7344 .code
7345 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7346 .endd
7347 If the data for a PTR record is not a syntactically valid IP address, it is not
7348 altered and nothing is added.
7349
7350 .cindex "MX record" "in &(dnsdb)& lookup"
7351 .cindex "SRV record" "in &(dnsdb)& lookup"
7352 For an MX lookup, both the preference value and the host name are returned for
7353 each record, separated by a space. For an SRV lookup, the priority, weight,
7354 port, and host name are returned for each record, separated by spaces.
7355 The field separator can be modified as above.
7356
7357 .cindex "TXT record" "in &(dnsdb)& lookup"
7358 .cindex "SPF record" "in &(dnsdb)& lookup"
7359 For TXT records with multiple items of data, only the first item is returned,
7360 unless a field separator is specified.
7361 To concatenate items without a separator, use a semicolon instead.
7362 For SPF records the
7363 default behaviour is to concatenate multiple items without using a separator.
7364 .code
7365 ${lookup dnsdb{>\n,: txt=a.b.example}}
7366 ${lookup dnsdb{>\n; txt=a.b.example}}
7367 ${lookup dnsdb{spf=example.org}}
7368 .endd
7369 It is permitted to specify a space as the separator character. Further
7370 white space is ignored.
7371
7372 .cindex "SOA record" "in &(dnsdb)& lookup"
7373 For an SOA lookup, while no result is obtained the lookup is redone with
7374 successively more leading components dropped from the given domain.
7375 Only the primary-nameserver field is returned unless a field separator is
7376 specified.
7377 .code
7378 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7379 .endd
7380
7381 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7382 .cindex "dnsdb modifiers"
7383 .cindex "modifiers" "dnsdb"
7384 .cindex "options" "dnsdb"
7385 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7386 each followed by a comma,
7387 that may appear before the record type.
7388
7389 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7390 temporary DNS error for any of them, the behaviour is controlled by
7391 a defer-option modifier.
7392 The possible keywords are
7393 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7394 With &"strict"& behaviour, any temporary DNS error causes the
7395 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7396 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7397 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7398 error causes the whole lookup to defer only if none of the other lookups
7399 succeed. The default is &"lax"&, so the following lookups are equivalent:
7400 .code
7401 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7402 ${lookup dnsdb{a=one.host.com:two.host.com}}
7403 .endd
7404 Thus, in the default case, as long as at least one of the DNS lookups
7405 yields some data, the lookup succeeds.
7406
7407 .cindex "DNSSEC" "dns lookup"
7408 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7409 The possible keywords are
7410 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7411 With &"strict"& or &"lax"& DNSSEC information is requested
7412 with the lookup.
7413 With &"strict"& a response from the DNS resolver that
7414 is not labelled as authenticated data
7415 is treated as equivalent to a temporary DNS error.
7416 The default is &"lax"&.
7417
7418 See also the &$lookup_dnssec_authenticated$& variable.
7419
7420 .cindex timeout "dns lookup"
7421 .cindex "DNS" timeout
7422 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7423 The form is &"retrans_VAL"& where VAL is an Exim time specification
7424 (e.g. &"5s"&).
7425 The default value is set by the main configuration option &%dns_retrans%&.
7426
7427 Retries for the dnsdb lookup can be controlled by a retry modifier.
7428 The form if &"retry_VAL"& where VAL is an integer.
7429 The default count is set by the main configuration option &%dns_retry%&.
7430
7431 .cindex caching "of dns lookup"
7432 .cindex TTL "of dns lookup"
7433 .cindex DNS TTL
7434 Dnsdb lookup results are cached within a single process (and its children).
7435 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7436 value of the set of returned DNS records.
7437
7438
7439 .section "Pseudo dnsdb record types" "SECID66"
7440 .cindex "MX record" "in &(dnsdb)& lookup"
7441 By default, both the preference value and the host name are returned for
7442 each MX record, separated by a space. If you want only host names, you can use
7443 the pseudo-type MXH:
7444 .code
7445 ${lookup dnsdb{mxh=a.b.example}}
7446 .endd
7447 In this case, the preference values are omitted, and just the host names are
7448 returned.
7449
7450 .cindex "name server for enclosing domain"
7451 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7452 records on the given domain, but if none are found, it removes the first
7453 component of the domain name, and tries again. This process continues until NS
7454 records are found or there are no more components left (or there is a DNS
7455 error). In other words, it may return the name servers for a top-level domain,
7456 but it never returns the root name servers. If there are no NS records for the
7457 top-level domain, the lookup fails. Consider these examples:
7458 .code
7459 ${lookup dnsdb{zns=xxx.quercite.com}}
7460 ${lookup dnsdb{zns=xxx.edu}}
7461 .endd
7462 Assuming that in each case there are no NS records for the full domain name,
7463 the first returns the name servers for &%quercite.com%&, and the second returns
7464 the name servers for &%edu%&.
7465
7466 You should be careful about how you use this lookup because, unless the
7467 top-level domain does not exist, the lookup always returns some host names. The
7468 sort of use to which this might be put is for seeing if the name servers for a
7469 given domain are on a blacklist. You can probably assume that the name servers
7470 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7471 such a list.
7472
7473 .cindex "CSA" "in &(dnsdb)& lookup"
7474 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7475 records according to the CSA rules, which are described in section
7476 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7477 not sufficient because of the extra parent domain search behaviour of CSA. The
7478 result of a successful lookup such as:
7479 .code
7480 ${lookup dnsdb {csa=$sender_helo_name}}
7481 .endd
7482 has two space-separated fields: an authorization code and a target host name.
7483 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7484 authorization required but absent, or &"?"& for unknown.
7485
7486 .cindex "A+" "in &(dnsdb)& lookup"
7487 The pseudo-type A+ performs an AAAA
7488 and then an A lookup.  All results are returned; defer processing
7489 (see below) is handled separately for each lookup.  Example:
7490 .code
7491 ${lookup dnsdb {>; a+=$sender_helo_name}}
7492 .endd
7493
7494
7495 .section "Multiple dnsdb lookups" "SECID67"
7496 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7497 However, you can specify a list of domains or IP addresses in a single
7498 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7499 the default separator, but with the ability to change this. For example:
7500 .code
7501 ${lookup dnsdb{one.domain.com:two.domain.com}}
7502 ${lookup dnsdb{a=one.host.com:two.host.com}}
7503 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7504 .endd
7505 In order to retain backwards compatibility, there is one special case: if
7506 the lookup type is PTR and no change of separator is specified, Exim looks
7507 to see if the rest of the string is precisely one IPv6 address. In this
7508 case, it does not treat it as a list.
7509
7510 The data from each lookup is concatenated, with newline separators by default,
7511 in the same way that multiple DNS records for a single item are handled. A
7512 different separator can be specified, as described above.
7513
7514
7515
7516
7517 .section "More about LDAP" "SECTldap"
7518 .cindex "LDAP" "lookup, more about"
7519 .cindex "lookup" "LDAP"
7520 .cindex "Solaris" "LDAP"
7521 The original LDAP implementation came from the University of Michigan; this has
7522 become &"Open LDAP"&, and there are now two different releases. Another
7523 implementation comes from Netscape, and Solaris 7 and subsequent releases
7524 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7525 the lookup function level, their error handling is different. For this reason
7526 it is necessary to set a compile-time variable when building Exim with LDAP, to
7527 indicate which LDAP library is in use. One of the following should appear in
7528 your &_Local/Makefile_&:
7529 .code
7530 LDAP_LIB_TYPE=UMICHIGAN
7531 LDAP_LIB_TYPE=OPENLDAP1
7532 LDAP_LIB_TYPE=OPENLDAP2
7533 LDAP_LIB_TYPE=NETSCAPE
7534 LDAP_LIB_TYPE=SOLARIS
7535 .endd
7536 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7537 same interface as the University of Michigan version.
7538
7539 There are three LDAP lookup types in Exim. These behave slightly differently in
7540 the way they handle the results of a query:
7541
7542 .ilist
7543 &(ldap)& requires the result to contain just one entry; if there are more, it
7544 gives an error.
7545 .next
7546 &(ldapdn)& also requires the result to contain just one entry, but it is the
7547 Distinguished Name that is returned rather than any attribute values.
7548 .next
7549 &(ldapm)& permits the result to contain more than one entry; the attributes
7550 from all of them are returned.
7551 .endlist
7552
7553
7554 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7555 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7556 the data returned by a successful lookup is described in the next section.
7557 First we explain how LDAP queries are coded.
7558
7559
7560 .section "Format of LDAP queries" "SECTforldaque"
7561 .cindex "LDAP" "query format"
7562 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7563 the configuration of a &(redirect)& router one might have this setting:
7564 .code
7565 data = ${lookup ldap \
7566   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7567   c=UK?mailbox?base?}}
7568 .endd
7569 .cindex "LDAP" "with TLS"
7570 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7571 secure (encrypted) LDAP connections. The second of these ensures that an
7572 encrypted TLS connection is used.
7573
7574 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7575 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7576 See the &%ldap_start_tls%& option.
7577
7578 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7579 controlled. Every part of the TLS configuration can be configured by settings in
7580 &_exim.conf_&. Depending on the version of the client libraries installed on
7581 your system, some of the initialization may have required setting options in
7582 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7583 certificates. This revealed a nuance where the current UID that exim was
7584 running as could affect which config files it read. With Exim 4.83, these
7585 methods become optional, only taking effect if not specifically set in
7586 &_exim.conf_&.
7587
7588
7589 .section "LDAP quoting" "SECID68"
7590 .cindex "LDAP" "quoting"
7591 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7592 and the second because the LDAP query is represented as a URL. Furthermore,
7593 within an LDAP query, two different kinds of quoting are required. For this
7594 reason, there are two different LDAP-specific quoting operators.
7595
7596 The &%quote_ldap%& operator is designed for use on strings that are part of
7597 filter specifications. Conceptually, it first does the following conversions on
7598 the string:
7599 .code
7600 *   =>   \2A
7601 (   =>   \28
7602 )   =>   \29
7603 \   =>   \5C
7604 .endd
7605 in accordance with RFC 2254. The resulting string is then quoted according
7606 to the rules for URLs, that is, all non-alphanumeric characters except
7607 .code
7608 ! $ ' - . _ ( ) * +
7609 .endd
7610 are converted to their hex values, preceded by a percent sign. For example:
7611 .code
7612 ${quote_ldap: a(bc)*, a<yz>; }
7613 .endd
7614 yields
7615 .code
7616 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7617 .endd
7618 Removing the URL quoting, this is (with a leading and a trailing space):
7619 .code
7620 a\28bc\29\2A, a<yz>;
7621 .endd
7622 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7623 base DN specifications in queries. Conceptually, it first converts the string
7624 by inserting a backslash in front of any of the following characters:
7625 .code
7626 , + " \ < > ;
7627 .endd
7628 It also inserts a backslash before any leading spaces or # characters, and
7629 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7630 is then quoted according to the rules for URLs. For example:
7631 .code
7632 ${quote_ldap_dn: a(bc)*, a<yz>; }
7633 .endd
7634 yields
7635 .code
7636 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7637 .endd
7638 Removing the URL quoting, this is (with a trailing space):
7639 .code
7640 \ a(bc)*\, a\<yz\>\;\
7641 .endd
7642 There are some further comments about quoting in the section on LDAP
7643 authentication below.
7644
7645
7646 .section "LDAP connections" "SECID69"
7647 .cindex "LDAP" "connections"
7648 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7649 is in use, via a Unix domain socket. The example given above does not specify
7650 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7651 by starting it with
7652 .code
7653 ldap://<hostname>:<port>/...
7654 .endd
7655 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7656 used. When no server is specified in a query, a list of default servers is
7657 taken from the &%ldap_default_servers%& configuration option. This supplies a
7658 colon-separated list of servers which are tried in turn until one successfully
7659 handles a query, or there is a serious error. Successful handling either
7660 returns the requested data, or indicates that it does not exist. Serious errors
7661 are syntactical, or multiple values when only a single value is expected.
7662 Errors which cause the next server to be tried are connection failures, bind
7663 failures, and timeouts.
7664
7665 For each server name in the list, a port number can be given. The standard way
7666 of specifying a host and port is to use a colon separator (RFC 1738). Because
7667 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7668 doubled. For example
7669 .code
7670 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7671 .endd
7672 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7673 to the LDAP library with no server name, and the library's default (normally
7674 the local host) is used.
7675
7676 If you are using the OpenLDAP library, you can connect to an LDAP server using
7677 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7678 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7679 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7680 not available.
7681
7682 For this type of connection, instead of a host name for the server, a pathname
7683 for the socket is required, and the port number is not relevant. The pathname
7684 can be specified either as an item in &%ldap_default_servers%&, or inline in
7685 the query. In the former case, you can have settings such as
7686 .code
7687 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7688 .endd
7689 When the pathname is given in the query, you have to escape the slashes as
7690 &`%2F`& to fit in with the LDAP URL syntax. For example:
7691 .code
7692 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7693 .endd
7694 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7695 a pathname, it uses the Unix domain socket code, even if the query actually
7696 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7697 socket connection. This behaviour means that you can use a setting of
7698 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7699 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7700 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7701 backup host.
7702
7703 If an explicit &`ldapi`& type is given in a query when a host name is
7704 specified, an error is diagnosed. However, if there are more items in
7705 &%ldap_default_servers%&, they are tried. In other words:
7706
7707 .ilist
7708 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7709 interface.
7710 .next
7711 Using &`ldapi`& with a host name causes an error.
7712 .endlist
7713
7714
7715 Using &`ldapi`& with no host or path in the query, and no setting of
7716 &%ldap_default_servers%&, does whatever the library does by default.
7717
7718
7719
7720 .section "LDAP authentication and control information" "SECID70"
7721 .cindex "LDAP" "authentication"
7722 The LDAP URL syntax provides no way of passing authentication and other control
7723 information to the server. To make this possible, the URL in an LDAP query may
7724 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7725 spaces. If a value contains spaces it must be enclosed in double quotes, and
7726 when double quotes are used, backslash is interpreted in the usual way inside
7727 them. The following names are recognized:
7728 .display
7729 &`DEREFERENCE`&  set the dereferencing parameter
7730 &`NETTIME    `&  set a timeout for a network operation
7731 &`USER       `&  set the DN, for authenticating the LDAP bind
7732 &`PASS       `&  set the password, likewise
7733 &`REFERRALS  `&  set the referrals parameter
7734 &`SERVERS    `&  set alternate server list for this query only
7735 &`SIZE       `&  set the limit for the number of entries returned
7736 &`TIME       `&  set the maximum waiting time for a query
7737 .endd
7738 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7739 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7740 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7741 library from trying to follow referrals issued by the LDAP server.
7742
7743 .cindex LDAP timeout
7744 .cindex timeout "LDAP lookup"
7745 The name CONNECT is an obsolete name for NETTIME, retained for
7746 backwards compatibility. This timeout (specified as a number of seconds) is
7747 enforced from the client end for operations that can be carried out over a
7748 network. Specifically, it applies to network connections and calls to the
7749 &'ldap_result()'& function. If the value is greater than zero, it is used if
7750 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7751 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7752 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7753 Netscape SDK; for OpenLDAP no action is taken.
7754
7755 The TIME parameter (also a number of seconds) is passed to the server to
7756 set a server-side limit on the time taken to complete a search.
7757
7758 The SERVERS parameter allows you to specify an alternate list of ldap servers
7759 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7760 default list of ldap servers, and a single lookup can specify a single ldap
7761 server to use.  But when you need to do a lookup with a list of servers that is
7762 different than the default list (maybe different order, maybe a completely
7763 different set of servers), the SERVERS parameter allows you to specify this
7764 alternate list (colon-separated).
7765
7766 Here is an example of an LDAP query in an Exim lookup that uses some of these
7767 values. This is a single line, folded to fit on the page:
7768 .code
7769 ${lookup ldap
7770   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7771   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7772   {$value}fail}
7773 .endd
7774 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7775 any of the auxiliary data. Exim configuration settings that include lookups
7776 which contain password information should be preceded by &"hide"& to prevent
7777 non-admin users from using the &%-bP%& option to see their values.
7778
7779 The auxiliary data items may be given in any order. The default is no
7780 connection timeout (the system timeout is used), no user or password, no limit
7781 on the number of entries returned, and no time limit on queries.
7782
7783 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7784 removes any URL quoting that it may contain before passing it LDAP. Apparently
7785 some libraries do this for themselves, but some do not. Removing the URL
7786 quoting has two advantages:
7787
7788 .ilist
7789 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7790 DNs as with DNs inside actual queries.
7791 .next
7792 It permits spaces inside USER= DNs.
7793 .endlist
7794
7795 For example, a setting such as
7796 .code
7797 USER=cn=${quote_ldap_dn:$1}
7798 .endd
7799 should work even if &$1$& contains spaces.
7800
7801 Expanded data for the PASS= value should be quoted using the &%quote%&
7802 expansion operator, rather than the LDAP quote operators. The only reason this
7803 field needs quoting is to ensure that it conforms to the Exim syntax, which
7804 does not allow unquoted spaces. For example:
7805 .code
7806 PASS=${quote:$3}
7807 .endd
7808 The LDAP authentication mechanism can be used to check passwords as part of
7809 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7810 &<<CHAPexpand>>&.
7811
7812
7813
7814 .section "Format of data returned by LDAP" "SECID71"
7815 .cindex "LDAP" "returned data formats"
7816 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7817 as a sequence of values, for example
7818 .code
7819 cn=manager,o=University of Cambridge,c=UK
7820 .endd
7821 The &(ldap)& lookup type generates an error if more than one entry matches the
7822 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7823 the result between the data from different entries. It is possible for multiple
7824 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7825 you know that whatever values are returned all came from a single entry in the
7826 directory.
7827
7828 In the common case where you specify a single attribute in your LDAP query, the
7829 result is not quoted, and does not contain the attribute name. If the attribute
7830 has multiple values, they are separated by commas. Any comma that is
7831 part of an attribute's value is doubled.
7832
7833 If you specify multiple attributes, the result contains space-separated, quoted
7834 strings, each preceded by the attribute name and an equals sign. Within the
7835 quotes, the quote character, backslash, and newline are escaped with
7836 backslashes, and commas are used to separate multiple values for the attribute.
7837 Any commas in attribute values are doubled
7838 (permitting treatment of the values as a comma-separated list).
7839 Apart from the escaping, the string within quotes takes the same form as the
7840 output when a single attribute is requested. Specifying no attributes is the
7841 same as specifying all of an entry's attributes.
7842
7843 Here are some examples of the output format. The first line of each pair is an
7844 LDAP query, and the second is the data that is returned. The attribute called
7845 &%attr1%& has two values, one of them with an embedded comma, whereas
7846 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7847 (they have SUP &%attr%& in their schema definitions).
7848
7849 .code
7850 ldap:///o=base?attr1?sub?(uid=fred)
7851 value1.1,value1,,2
7852
7853 ldap:///o=base?attr2?sub?(uid=fred)
7854 value two
7855
7856 ldap:///o=base?attr?sub?(uid=fred)
7857 value1.1,value1,,2,value two
7858
7859 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7860 attr1="value1.1,value1,,2" attr2="value two"
7861
7862 ldap:///o=base??sub?(uid=fred)
7863 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7864 .endd
7865 You can
7866 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7867 results of LDAP lookups.
7868 The &%extract%& operator in string expansions can be used to pick out
7869 individual fields from data that consists of &'key'&=&'value'& pairs.
7870 The &%listextract%& operator should be used to pick out individual values
7871 of attributes, even when only a single value is expected.
7872 The doubling of embedded commas allows you to use the returned data as a
7873 comma separated list (using the "<," syntax for changing the input list separator).
7874
7875
7876
7877
7878 .section "More about NIS+" "SECTnisplus"
7879 .cindex "NIS+ lookup type"
7880 .cindex "lookup" "NIS+"
7881 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7882 and field name. If this is given, the result of a successful query is the
7883 contents of the named field; otherwise the result consists of a concatenation
7884 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7885 values containing spaces are quoted. For example, the query
7886 .code
7887 [name=mg1456],passwd.org_dir
7888 .endd
7889 might return the string
7890 .code
7891 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7892 home=/home/mg1456 shell=/bin/bash shadow=""
7893 .endd
7894 (split over two lines here to fit on the page), whereas
7895 .code
7896 [name=mg1456],passwd.org_dir:gcos
7897 .endd
7898 would just return
7899 .code
7900 Martin Guerre
7901 .endd
7902 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7903 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7904 operator is to double any quote characters within the text.
7905
7906
7907
7908 .section "SQL lookups" "SECTsql"
7909 .cindex "SQL lookup types"
7910 .cindex "MySQL" "lookup type"
7911 .cindex "PostgreSQL lookup type"
7912 .cindex "lookup" "MySQL"
7913 .cindex "lookup" "PostgreSQL"
7914 .cindex "Oracle" "lookup type"
7915 .cindex "lookup" "Oracle"
7916 .cindex "InterBase lookup type"
7917 .cindex "lookup" "InterBase"
7918 .cindex "Redis lookup type"
7919 .cindex lookup Redis
7920 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7921 and SQLite
7922 databases. Queries for these databases contain SQL statements, so an example
7923 might be
7924 .code
7925 ${lookup mysql{select mailbox from users where id='userx'}\
7926   {$value}fail}
7927 .endd
7928 If the result of the query contains more than one field, the data for each
7929 field in the row is returned, preceded by its name, so the result of
7930 .code
7931 ${lookup pgsql{select home,name from users where id='userx'}\
7932   {$value}}
7933 .endd
7934 might be
7935 .code
7936 home=/home/userx name="Mister X"
7937 .endd
7938 Empty values and values containing spaces are double quoted, with embedded
7939 quotes escaped by a backslash. If the result of the query contains just one
7940 field, the value is passed back verbatim, without a field name, for example:
7941 .code
7942 Mister X
7943 .endd
7944 If the result of the query yields more than one row, it is all concatenated,
7945 with a newline between the data for each row.
7946
7947
7948 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7949 .cindex "MySQL" "lookup type"
7950 .cindex "PostgreSQL lookup type"
7951 .cindex "lookup" "MySQL"
7952 .cindex "lookup" "PostgreSQL"
7953 .cindex "Oracle" "lookup type"
7954 .cindex "lookup" "Oracle"
7955 .cindex "InterBase lookup type"
7956 .cindex "lookup" "InterBase"
7957 .cindex "Redis lookup type"
7958 .cindex lookup Redis
7959 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7960 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7961 or &%redis_servers%&
7962 option (as appropriate) must be set to a colon-separated list of server
7963 information.
7964 .oindex &%mysql_servers%&
7965 .oindex &%pgsql_servers%&
7966 .oindex &%oracle_servers%&
7967 .oindex &%ibase_servers%&
7968 .oindex &%redis_servers%&
7969 (For MySQL and PostgreSQL, the global option need not be set if all
7970 queries contain their own server information &-- see section
7971 &<<SECTspeserque>>&.)
7972 For all but Redis
7973 each item in the list is a slash-separated list of four
7974 items: host name, database name, user name, and password. In the case of
7975 Oracle, the host name field is used for the &"service name"&, and the database
7976 name field is not used and should be empty. For example:
7977 .code
7978 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7979 .endd
7980 Because password data is sensitive, you should always precede the setting with
7981 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7982 option. Here is an example where two MySQL servers are listed:
7983 .code
7984 hide mysql_servers = localhost/users/root/secret:\
7985                      otherhost/users/root/othersecret
7986 .endd
7987 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7988 because this is a colon-separated list, the colon has to be doubled. For each
7989 query, these parameter groups are tried in order until a connection is made and
7990 a query is successfully processed. The result of a query may be that no data is
7991 found, but that is still a successful query. In other words, the list of
7992 servers provides a backup facility, not a list of different places to look.
7993
7994 For Redis the global option need not be specified if all queries contain their
7995 own server information &-- see section &<<SECTspeserque>>&.
7996 If specified, the option must be set to a colon-separated list of server
7997 information.
7998 Each item in the list is a slash-separated list of three items:
7999 host, database number, and password.
8000 .olist
8001 The host is required and may be either an IPv4 address and optional
8002 port number (separated by a colon, which needs doubling due to the
8003 higher-level list), or a Unix socket pathname enclosed in parentheses
8004 .next
8005 The database number is optional; if present that number is selected in the backend
8006 .next
8007 The password is optional; if present it is used to authenticate to the backend
8008 .endlist
8009
8010 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8011 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8012 respectively, and the characters single-quote, double-quote, and backslash
8013 itself are escaped with backslashes.
8014
8015 The &%quote_redis%& expansion operator
8016 escapes whitespace and backslash characters with a backslash.
8017
8018 .section "Specifying the server in the query" "SECTspeserque"
8019 .new
8020 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8021 it is possible to specify a list of servers with an individual query. This is
8022 done by appending a comma-separated option to the query type:
8023 .display
8024 .endd
8025 &`,servers=`&&'server1:server2:server3:...'&
8026 .wen
8027 Each item in the list may take one of two forms:
8028 .olist
8029 If it contains no slashes it is assumed to be just a host name. The appropriate
8030 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8031 of the same name, and the remaining parameters (database, user, password) are
8032 taken from there.
8033 .next
8034 If it contains any slashes, it is taken as a complete parameter set.
8035 .endlist
8036 The list of servers is used in exactly the same way as the global list.
8037 Once a connection to a server has happened and a query has been
8038 successfully executed, processing of the lookup ceases.
8039
8040 This feature is intended for use in master/slave situations where updates
8041 are occurring and you want to update the master rather than a slave. If the
8042 master is in the list as a backup for reading, you might have a global setting
8043 like this:
8044 .code
8045 mysql_servers = slave1/db/name/pw:\
8046                 slave2/db/name/pw:\
8047                 master/db/name/pw
8048 .endd
8049 In an updating lookup, you could then write:
8050 .code
8051 ${lookup mysql,servers=master {UPDATE ...} }
8052 .endd
8053 That query would then be sent only to the master server. If, on the other hand,
8054 the master is not to be used for reading, and so is not present in the global
8055 option, you can still update it by a query of this form:
8056 .code
8057 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8058 .endd
8059
8060 .new
8061 An older syntax places the servers speciification before the qury,
8062 semicolon separated:
8063 .code
8064 ${lookup mysql{servers=master; UPDATE ...} }
8065 .endd
8066 The new version avoids potential issues with tainted
8067 arguments in the query, for explicit expansion.
8068 &*Note*&: server specifications in list-style lookups are still problematic.
8069 .wen
8070
8071
8072 .section "Special MySQL features" "SECID73"
8073 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8074 causes a connection to the server on the local host by means of a Unix domain
8075 socket. An alternate socket can be specified in parentheses.
8076 An option group name for MySQL option files can be specified in square brackets;
8077 the default value is &"exim"&.
8078 The full syntax of each item in &%mysql_servers%& is:
8079 .display
8080 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8081   <&'database'&>/<&'user'&>/<&'password'&>
8082 .endd
8083 Any of the four sub-parts of the first field can be omitted. For normal use on
8084 the local host it can be left blank or set to just &"localhost"&.
8085
8086 No database need be supplied &-- but if it is absent here, it must be given in
8087 the queries.
8088
8089 If a MySQL query is issued that does not request any data (an insert, update,
8090 or delete command), the result of the lookup is the number of rows affected.
8091
8092 &*Warning*&: This can be misleading. If an update does not actually change
8093 anything (for example, setting a field to the value it already has), the result
8094 is zero because no rows are affected.
8095
8096
8097 .section "Special PostgreSQL features" "SECID74"
8098 PostgreSQL lookups can also use Unix domain socket connections to the database.
8099 This is usually faster and costs less CPU time than a TCP/IP connection.
8100 However it can be used only if the mail server runs on the same machine as the
8101 database server. A configuration line for PostgreSQL via Unix domain sockets
8102 looks like this:
8103 .code
8104 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8105 .endd
8106 In other words, instead of supplying a host name, a path to the socket is
8107 given. The path name is enclosed in parentheses so that its slashes aren't
8108 visually confused with the delimiters for the other server parameters.
8109
8110 If a PostgreSQL query is issued that does not request any data (an insert,
8111 update, or delete command), the result of the lookup is the number of rows
8112 affected.
8113
8114 .section "More about SQLite" "SECTsqlite"
8115 .cindex "lookup" "SQLite"
8116 .cindex "sqlite lookup type"
8117 SQLite is different to the other SQL lookups because a filename is required in
8118 addition to the SQL query. An SQLite database is a single file, and there is no
8119 daemon as in the other SQL databases.
8120
8121 .new
8122 .oindex &%sqlite_dbfile%&
8123 The preferred way of specifying the file is by using the 
8124 &%sqlite_dbfile%& option, set to
8125 an absolute path.
8126 .wen
8127 A deprecated method is available, prefixing the query with the filename
8128 separated by white space.
8129 This means that the path name cannot contain white space.
8130 .cindex "tainted data" "sqlite file"
8131 It also means that the query cannot use any tainted values, as that taints
8132 the entire query including the filename - resulting in a refusal to open
8133 the file.
8134
8135 .new
8136 Here is a lookup expansion example:
8137 .code
8138 sqlite_dbfile = /some/thing/sqlitedb
8139 ...
8140 ${lookup sqlite {select name from aliases where id='userx';}}
8141 .endd
8142 In a list, the syntax is similar. For example:
8143 .code
8144 domainlist relay_to_domains = sqlite;\
8145    select * from relays where ip='$sender_host_address';
8146 .endd
8147 .wen
8148 The only character affected by the &%quote_sqlite%& operator is a single
8149 quote, which it doubles.
8150
8151 .cindex timeout SQLite
8152 .cindex sqlite "lookup timeout"
8153 The SQLite library handles multiple simultaneous accesses to the database
8154 internally. Multiple readers are permitted, but only one process can
8155 update at once. Attempts to access the database while it is being updated
8156 are rejected after a timeout period, during which the SQLite library
8157 waits for the lock to be released. In Exim, the default timeout is set
8158 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8159 option.
8160
8161 .section "More about Redis" "SECTredis"
8162 .cindex "lookup" "Redis"
8163 .cindex "redis lookup type"
8164 Redis is a non-SQL database. Commands are simple get and set.
8165 Examples:
8166 .code
8167 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8168 ${lookup redis{get keyname}}
8169 .endd
8170
8171 As of release 4.91, "lightweight" support for Redis Cluster is available.
8172 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8173 of which must be reachable from the running exim instance. If the cluster has
8174 master/slave replication, the list must contain all the master and slave
8175 servers.
8176
8177 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8178 immediately follow the redirection but treats the response as a DEFER, moving on
8179 to the next server in the &%redis_servers%& list until the correct server is
8180 reached.
8181
8182 .ecindex IIDfidalo1
8183 .ecindex IIDfidalo2
8184
8185
8186 . ////////////////////////////////////////////////////////////////////////////
8187 . ////////////////////////////////////////////////////////////////////////////
8188
8189 .chapter "Domain, host, address, and local part lists" &&&
8190          "CHAPdomhosaddlists" &&&
8191          "Domain, host, and address lists"
8192 .scindex IIDdohoadli "lists of domains; hosts; etc."
8193 A number of Exim configuration options contain lists of domains, hosts,
8194 email addresses, or local parts. For example, the &%hold_domains%& option
8195 contains a list of domains whose delivery is currently suspended. These lists
8196 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8197 arguments to expansion conditions such as &%match_domain%&.
8198
8199 Each item in one of these lists is a pattern to be matched against a domain,
8200 host, email address, or local part, respectively. In the sections below, the
8201 different types of pattern for each case are described, but first we cover some
8202 general facilities that apply to all four kinds of list.
8203
8204 Note that other parts of Exim use a &'string list'& which does not
8205 support all the complexity available in
8206 domain, host, address and local part lists.
8207
8208
8209
8210 .section "Expansion of lists" "SECTlistexpand"
8211 .cindex "expansion" "of lists"
8212 Each list is expanded as a single string before it is used.
8213
8214 &'Exception: the router headers_remove option, where list-item
8215 splitting is done before string-expansion.'&
8216
8217 The result of
8218 expansion must be a list, possibly containing empty items, which is split up
8219 into separate items for matching. By default, colon is the separator character,
8220 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8221 &<<SECTempitelis>>& for details of the list syntax; the second of these
8222 discusses the way to specify empty list items.
8223
8224
8225 If the string expansion is forced to fail, Exim behaves as if the item it is
8226 testing (domain, host, address, or local part) is not in the list. Other
8227 expansion failures cause temporary errors.
8228
8229 If an item in a list is a regular expression, backslashes, dollars and possibly
8230 other special characters in the expression must be protected against
8231 misinterpretation by the string expander. The easiest way to do this is to use
8232 the &`\N`& expansion feature to indicate that the contents of the regular
8233 expression should not be expanded. For example, in an ACL you might have:
8234 .code
8235 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8236                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8237 .endd
8238 The first item is a regular expression that is protected from expansion by
8239 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8240 senders based on the receiving domain.
8241
8242
8243
8244
8245 .section "Negated items in lists" "SECID76"
8246 .cindex "list" "negation"
8247 .cindex "negation" "in lists"
8248 Items in a list may be positive or negative. Negative items are indicated by a
8249 leading exclamation mark, which may be followed by optional white space. A list
8250 defines a set of items (domains, etc). When Exim processes one of these lists,
8251 it is trying to find out whether a domain, host, address, or local part
8252 (respectively) is in the set that is defined by the list. It works like this:
8253
8254 The list is scanned from left to right. If a positive item is matched, the
8255 subject that is being checked is in the set; if a negative item is matched, the
8256 subject is not in the set. If the end of the list is reached without the
8257 subject having matched any of the patterns, it is in the set if the last item
8258 was a negative one, but not if it was a positive one. For example, the list in
8259 .code
8260 domainlist relay_to_domains = !a.b.c : *.b.c
8261 .endd
8262 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8263 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8264 list is positive. However, if the setting were
8265 .code
8266 domainlist relay_to_domains = !a.b.c
8267 .endd
8268 then all domains other than &'a.b.c'& would match because the last item in the
8269 list is negative. In other words, a list that ends with a negative item behaves
8270 as if it had an extra item &`:*`& on the end.
8271
8272 Another way of thinking about positive and negative items in lists is to read
8273 the connector as &"or"& after a positive item and as &"and"& after a negative
8274 item.
8275
8276
8277
8278 .section "File names in lists" "SECTfilnamlis"
8279 .cindex "list" "filename in"
8280 If an item in a domain, host, address, or local part list is an absolute
8281 filename (beginning with a slash character), each line of the file is read and
8282 processed as if it were an independent item in the list, except that further
8283 filenames are not allowed,
8284 and no expansion of the data from the file takes place.
8285 Empty lines in the file are ignored, and the file may also contain comment
8286 lines:
8287
8288 .ilist
8289 For domain and host lists, if a # character appears anywhere in a line of the
8290 file, it and all following characters are ignored.
8291 .next
8292 Because local parts may legitimately contain # characters, a comment in an
8293 address list or local part list file is recognized only if # is preceded by
8294 white space or the start of the line. For example:
8295 .code
8296 not#comment@x.y.z   # but this is a comment
8297 .endd
8298 .endlist
8299
8300 Putting a filename in a list has the same effect as inserting each line of the
8301 file as an item in the list (blank lines and comments excepted). However, there
8302 is one important difference: the file is read each time the list is processed,
8303 so if its contents vary over time, Exim's behaviour changes.
8304
8305 If a filename is preceded by an exclamation mark, the sense of any match
8306 within the file is inverted. For example, if
8307 .code
8308 hold_domains = !/etc/nohold-domains
8309 .endd
8310 and the file contains the lines
8311 .code
8312 !a.b.c
8313 *.b.c
8314 .endd
8315 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8316 any domain matching &`*.b.c`& is not.
8317
8318
8319
8320 .section "An lsearch file is not an out-of-line list" "SECID77"
8321 As will be described in the sections that follow, lookups can be used in lists
8322 to provide indexed methods of checking list membership. There has been some
8323 confusion about the way &(lsearch)& lookups work in lists. Because
8324 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8325 sometimes thought that it is allowed to contain wild cards and other kinds of
8326 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8327 always fixed strings, just as for any other single-key lookup type.
8328
8329 If you want to use a file to contain wild-card patterns that form part of a
8330 list, just give the filename on its own, without a search type, as described
8331 in the previous section. You could also use the &(wildlsearch)& or
8332 &(nwildlsearch)&, but there is no advantage in doing this.
8333
8334
8335
8336
8337 .section "Named lists" "SECTnamedlists"
8338 .cindex "named lists"
8339 .cindex "list" "named"
8340 A list of domains, hosts, email addresses, or local parts can be given a name
8341 which is then used to refer to the list elsewhere in the configuration. This is
8342 particularly convenient if the same list is required in several different
8343 places. It also allows lists to be given meaningful names, which can improve
8344 the readability of the configuration. For example, it is conventional to define
8345 a domain list called &'local_domains'& for all the domains that are handled
8346 locally on a host, using a configuration line such as
8347 .code
8348 domainlist local_domains = localhost:my.dom.example
8349 .endd
8350 Named lists are referenced by giving their name preceded by a plus sign, so,
8351 for example, a router that is intended to handle local domains would be
8352 configured with the line
8353 .code
8354 domains = +local_domains
8355 .endd
8356 The first router in a configuration is often one that handles all domains
8357 except the local ones, using a configuration with a negated item like this:
8358 .code
8359 dnslookup:
8360   driver = dnslookup
8361   domains = ! +local_domains
8362   transport = remote_smtp
8363   no_more
8364 .endd
8365 The four kinds of named list are created by configuration lines starting with
8366 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8367 respectively. Then there follows the name that you are defining, followed by an
8368 equals sign and the list itself. For example:
8369 .code
8370 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8371 addresslist bad_senders = cdb;/etc/badsenders
8372 .endd
8373 A named list may refer to other named lists:
8374 .code
8375 domainlist  dom1 = first.example : second.example
8376 domainlist  dom2 = +dom1 : third.example
8377 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8378 .endd
8379 &*Warning*&: If the last item in a referenced list is a negative one, the
8380 effect may not be what you intended, because the negation does not propagate
8381 out to the higher level. For example, consider:
8382 .code
8383 domainlist  dom1 = !a.b
8384 domainlist  dom2 = +dom1 : *.b
8385 .endd
8386 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8387 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8388 means it matches the second list as well. The effect is not the same as
8389 .code
8390 domainlist  dom2 = !a.b : *.b
8391 .endd
8392 where &'x.y'& does not match. It's best to avoid negation altogether in
8393 referenced lists if you can.
8394
8395 .new
8396 .cindex "hiding named list values"
8397 .cindex "named lists" "hiding value of"
8398 Some named list definitions may contain sensitive data, for example, passwords for
8399 accessing databases. To stop non-admin users from using the &%-bP%& command
8400 line option to read these values, you can precede the definition with the
8401 word &"hide"&. For example:
8402 .code
8403 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8404 .endd
8405 .wen
8406
8407
8408 Named lists may have a performance advantage. When Exim is routing an
8409 address or checking an incoming message, it caches the result of tests on named
8410 lists. So, if you have a setting such as
8411 .code
8412 domains = +local_domains
8413 .endd
8414 on several of your routers
8415 or in several ACL statements,
8416 the actual test is done only for the first one. However, the caching works only
8417 if there are no expansions within the list itself or any sublists that it
8418 references. In other words, caching happens only for lists that are known to be
8419 the same each time they are referenced.
8420
8421 By default, there may be up to 16 named lists of each type. This limit can be
8422 extended by changing a compile-time variable. The use of domain and host lists
8423 is recommended for concepts such as local domains, relay domains, and relay
8424 hosts. The default configuration is set up like this.
8425
8426
8427
8428 .section "Named lists compared with macros" "SECID78"
8429 .cindex "list" "named compared with macro"
8430 .cindex "macro" "compared with named list"
8431 At first sight, named lists might seem to be no different from macros in the
8432 configuration file. However, macros are just textual substitutions. If you
8433 write
8434 .code
8435 ALIST = host1 : host2
8436 auth_advertise_hosts = !ALIST
8437 .endd
8438 it probably won't do what you want, because that is exactly the same as
8439 .code
8440 auth_advertise_hosts = !host1 : host2
8441 .endd
8442 Notice that the second host name is not negated. However, if you use a host
8443 list, and write
8444 .code
8445 hostlist alist = host1 : host2
8446 auth_advertise_hosts = ! +alist
8447 .endd
8448 the negation applies to the whole list, and so that is equivalent to
8449 .code
8450 auth_advertise_hosts = !host1 : !host2
8451 .endd
8452
8453
8454 .section "Named list caching" "SECID79"
8455 .cindex "list" "caching of named"
8456 .cindex "caching" "named lists"
8457 While processing a message, Exim caches the result of checking a named list if
8458 it is sure that the list is the same each time. In practice, this means that
8459 the cache operates only if the list contains no $ characters, which guarantees
8460 that it will not change when it is expanded. Sometimes, however, you may have
8461 an expanded list that you know will be the same each time within a given
8462 message. For example:
8463 .code
8464 domainlist special_domains = \
8465            ${lookup{$sender_host_address}cdb{/some/file}}
8466 .endd
8467 This provides a list of domains that depends only on the sending host's IP
8468 address. If this domain list is referenced a number of times (for example,
8469 in several ACL lines, or in several routers) the result of the check is not
8470 cached by default, because Exim does not know that it is going to be the
8471 same list each time.
8472
8473 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8474 cache the result anyway. For example:
8475 .code
8476 domainlist_cache special_domains = ${lookup{...
8477 .endd
8478 If you do this, you should be absolutely sure that caching is going to do
8479 the right thing in all cases. When in doubt, leave it out.
8480
8481
8482
8483 .section "Domain lists" "SECTdomainlist"
8484 .cindex "domain list" "patterns for"
8485 .cindex "list" "domain list"
8486 Domain lists contain patterns that are to be matched against a mail domain.
8487 The following types of item may appear in domain lists:
8488
8489 .ilist
8490 .cindex "primary host name"
8491 .cindex "host name" "matched in domain list"
8492 .oindex "&%primary_hostname%&"
8493 .cindex "domain list" "matching primary host name"
8494 .cindex "@ in a domain list"
8495 If a pattern consists of a single @ character, it matches the local host name,
8496 as set by the &%primary_hostname%& option (or defaulted). This makes it
8497 possible to use the same configuration file on several different hosts that
8498 differ only in their names.
8499 .next
8500 .cindex "@[] in a domain list"
8501 .cindex "domain list" "matching local IP interfaces"
8502 .cindex "domain literal"
8503 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8504 in square brackets (as in an email address that contains a domain literal), but
8505 only if that IP address is recognized as local for email routing purposes. The
8506 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8507 control which of a host's several IP addresses are treated as local.
8508 In today's Internet, the use of domain literals is controversial.
8509 .next
8510 .cindex "@mx_any"
8511 .cindex "@mx_primary"
8512 .cindex "@mx_secondary"
8513 .cindex "domain list" "matching MX pointers to local host"
8514 If a pattern consists of the string &`@mx_any`& it matches any domain that
8515 has an MX record pointing to the local host or to any host that is listed in
8516 .oindex "&%hosts_treat_as_local%&"
8517 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8518 are similar, except that the first matches only when a primary MX target is the
8519 local host, and the second only when no primary MX target is the local host,
8520 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8521 preference value &-- there may of course be more than one of them.
8522
8523 The MX lookup that takes place when matching a pattern of this type is
8524 performed with the resolver options for widening names turned off. Thus, for
8525 example, a single-component domain will &'not'& be expanded by adding the
8526 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8527 options of the &(dnslookup)& router for a discussion of domain widening.
8528
8529 Sometimes you may want to ignore certain IP addresses when using one of these
8530 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8531 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8532 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8533 on a router). For example:
8534 .code
8535 domains = @mx_any/ignore=127.0.0.1
8536 .endd
8537 This example matches any domain that has an MX record pointing to one of
8538 the local host's IP addresses other than 127.0.0.1.
8539
8540 The list of IP addresses is in fact processed by the same code that processes
8541 host lists, so it may contain CIDR-coded network specifications and it may also
8542 contain negative items.
8543
8544 Because the list of IP addresses is a sublist within a domain list, you have to
8545 be careful about delimiters if there is more than one address. Like any other
8546 list, the default delimiter can be changed. Thus, you might have:
8547 .code
8548 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8549           an.other.domain : ...
8550 .endd
8551 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8552 involved, it is easiest to change the delimiter for the main list as well:
8553 .code
8554 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8555           an.other.domain ? ...
8556 .endd
8557 .next
8558 .cindex "asterisk" "in domain list"
8559 .cindex "domain list" "asterisk in"
8560 .cindex "domain list" "matching &""ends with""&"
8561 If a pattern starts with an asterisk, the remaining characters of the pattern
8562 are compared with the terminating characters of the domain. The use of &"*"& in
8563 domain lists differs from its use in partial matching lookups. In a domain
8564 list, the character following the asterisk need not be a dot, whereas partial
8565 matching works only in terms of dot-separated components. For example, a domain
8566 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8567 &'cipher.key.ex'&.
8568
8569 .next
8570 .cindex "regular expressions" "in domain list"
8571 .cindex "domain list" "matching regular expression"
8572 If a pattern starts with a circumflex character, it is treated as a regular
8573 expression, and matched against the domain using a regular expression matching
8574 function. The circumflex is treated as part of the regular expression.
8575 Email domains are case-independent, so this regular expression match is by
8576 default case-independent, but you can make it case-dependent by starting it
8577 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8578 are given in chapter &<<CHAPregexp>>&.
8579
8580 &*Warning*&: Because domain lists are expanded before being processed, you
8581 must escape any backslash and dollar characters in the regular expression, or
8582 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8583 it is not to be expanded (unless you really do want to build a regular
8584 expression by expansion, of course).
8585 .next
8586 .cindex "lookup" "in domain list"
8587 .cindex "domain list" "matching by lookup"
8588 If a pattern starts with the name of a single-key lookup type followed by a
8589 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8590 must be a filename in a suitable format for the lookup type. For example, for
8591 &"cdb;"& it must be an absolute path:
8592 .code
8593 domains = cdb;/etc/mail/local_domains.cdb
8594 .endd
8595 The appropriate type of lookup is done on the file using the domain name as the
8596 key. In most cases, the data that is looked up is not used; Exim is interested
8597 only in whether or not the key is present in the file. However, when a lookup
8598 is used for the &%domains%& option on a router
8599 or a &%domains%& condition in an ACL statement, the data is preserved in the
8600 &$domain_data$& variable and can be referred to in other router options or
8601 other statements in the same ACL.
8602
8603 .next
8604 Any of the single-key lookup type names may be preceded by
8605 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8606 .code
8607 domains = partial-dbm;/partial/domains
8608 .endd
8609 This causes partial matching logic to be invoked; a description of how this
8610 works is given in section &<<SECTpartiallookup>>&.
8611
8612 .next
8613 .cindex "asterisk" "in lookup type"
8614 Any of the single-key lookup types may be followed by an asterisk. This causes
8615 a default lookup for a key consisting of a single asterisk to be done if the
8616 original lookup fails. This is not a useful feature when using a domain list to
8617 select particular domains (because any domain would match), but it might have
8618 value if the result of the lookup is being used via the &$domain_data$&
8619 expansion variable.
8620 .next
8621 If the pattern starts with the name of a query-style lookup type followed by a
8622 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8623 pattern must be an appropriate query for the lookup type, as described in
8624 chapter &<<CHAPfdlookup>>&. For example:
8625 .code
8626 hold_domains = mysql;select domain from holdlist \
8627   where domain = '${quote_mysql:$domain}';
8628 .endd
8629 In most cases, the data that is looked up is not used (so for an SQL query, for
8630 example, it doesn't matter what field you select). Exim is interested only in
8631 whether or not the query succeeds. However, when a lookup is used for the
8632 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8633 variable and can be referred to in other options.
8634 .next
8635 .new
8636 If the pattern starts with the name of a lookup type
8637 of either kind (single-key or query-style) it may be
8638 followed by a command and options,
8639 The options are lookup-type specific and consist of a comma-separated list.
8640 Each item starts with a tag and and equals "=".
8641 .wen
8642 .next
8643 .cindex "domain list" "matching literal domain name"
8644 If none of the above cases apply, a caseless textual comparison is made
8645 between the pattern and the domain.
8646 .endlist
8647
8648 Here is an example that uses several different kinds of pattern:
8649 .code
8650 domainlist funny_domains = \
8651   @ : \
8652   lib.unseen.edu : \
8653   *.foundation.fict.example : \
8654   \N^[1-2]\d{3}\.fict\.example$\N : \
8655   partial-dbm;/opt/data/penguin/book : \
8656   nis;domains.byname : \
8657   nisplus;[name=$domain,status=local],domains.org_dir
8658 .endd
8659 There are obvious processing trade-offs among the various matching modes. Using
8660 an asterisk is faster than a regular expression, and listing a few names
8661 explicitly probably is too. The use of a file or database lookup is expensive,
8662 but may be the only option if hundreds of names are required. Because the
8663 patterns are tested in order, it makes sense to put the most commonly matched
8664 patterns earlier.
8665
8666
8667
8668 .section "Host lists" "SECThostlist"
8669 .cindex "host list" "patterns in"
8670 .cindex "list" "host list"
8671 Host lists are used to control what remote hosts are allowed to do. For
8672 example, some hosts may be allowed to use the local host as a relay, and some
8673 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8674 two different ways, by name or by IP address. In a host list, some types of
8675 pattern are matched to a host name, and some are matched to an IP address.
8676 You need to be particularly careful with this when single-key lookups are
8677 involved, to ensure that the right value is being used as the key.
8678
8679
8680 .section "Special host list patterns" "SECID80"
8681 .cindex "empty item in hosts list"
8682 .cindex "host list" "empty string in"
8683 If a host list item is the empty string, it matches only when no remote host is
8684 involved. This is the case when a message is being received from a local
8685 process using SMTP on the standard input, that is, when a TCP/IP connection is
8686 not used.
8687
8688 .cindex "asterisk" "in host list"
8689 The special pattern &"*"& in a host list matches any host or no host. Neither
8690 the IP address nor the name is actually inspected.
8691
8692
8693
8694 .section "Host list patterns that match by IP address" "SECThoslispatip"
8695 .cindex "host list" "matching IP addresses"
8696 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8697 the incoming address actually appears in the IPv6 host as
8698 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8699 list, it is converted into a traditional IPv4 address first. (Not all operating
8700 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8701 concerns.)
8702
8703 The following types of pattern in a host list check the remote host by
8704 inspecting its IP address:
8705
8706 .ilist
8707 If the pattern is a plain domain name (not a regular expression, not starting
8708 with *, not a lookup of any kind), Exim calls the operating system function
8709 to find the associated IP address(es). Exim uses the newer
8710 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8711 This typically causes a forward DNS lookup of the name. The result is compared
8712 with the IP address of the subject host.
8713
8714 If there is a temporary problem (such as a DNS timeout) with the host name
8715 lookup, a temporary error occurs. For example, if the list is being used in an
8716 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8717 temporary SMTP error code. If no IP address can be found for the host name,
8718 what happens is described in section &<<SECTbehipnot>>& below.
8719
8720 .next
8721 .cindex "@ in a host list"
8722 If the pattern is &"@"&, the primary host name is substituted and used as a
8723 domain name, as just described.
8724
8725 .next
8726 If the pattern is an IP address, it is matched against the IP address of the
8727 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8728 IPv6 addresses can be given in colon-separated format, but the colons have to
8729 be doubled so as not to be taken as item separators when the default list
8730 separator is used. IPv6 addresses are recognized even when Exim is compiled
8731 without IPv6 support. This means that if they appear in a host list on an
8732 IPv4-only host, Exim will not treat them as host names. They are just addresses
8733 that can never match a client host.
8734
8735 .next
8736 .cindex "@[] in a host list"
8737 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8738 the local host. For example, if the local host is an IPv4 host with one
8739 interface address 10.45.23.56, these two ACL statements have the same effect:
8740 .code
8741 accept hosts = 127.0.0.1 : 10.45.23.56
8742 accept hosts = @[]
8743 .endd
8744 .next
8745 .cindex "CIDR notation"
8746 If the pattern is an IP address followed by a slash and a mask length (for
8747 example 10.11.42.0/24), it is matched against the IP address of the subject
8748 host under the given mask. This allows, an entire network of hosts to be
8749 included (or excluded) by a single item. The mask uses CIDR notation; it
8750 specifies the number of address bits that must match, starting from the most
8751 significant end of the address.
8752
8753 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8754 of a range of addresses. It is the number of bits in the network portion of the
8755 address. The above example specifies a 24-bit netmask, so it matches all 256
8756 addresses in the 10.11.42.0 network. An item such as
8757 .code
8758 192.168.23.236/31
8759 .endd
8760 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8761 32 for an IPv4 address is the same as no mask at all; just a single address
8762 matches.
8763
8764 Here is another example which shows an IPv4 and an IPv6 network:
8765 .code
8766 recipient_unqualified_hosts = 192.168.0.0/16: \
8767                               3ffe::ffff::836f::::/48
8768 .endd
8769 The doubling of list separator characters applies only when these items
8770 appear inline in a host list. It is not required when indirecting via a file.
8771 For example:
8772 .code
8773 recipient_unqualified_hosts = /opt/exim/unqualnets
8774 .endd
8775 could make use of a file containing
8776 .code
8777 172.16.0.0/12
8778 3ffe:ffff:836f::/48
8779 .endd
8780 to have exactly the same effect as the previous example. When listing IPv6
8781 addresses inline, it is usually more convenient to use the facility for
8782 changing separator characters. This list contains the same two networks:
8783 .code
8784 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8785                                  3ffe:ffff:836f::/48
8786 .endd
8787 The separator is changed to semicolon by the leading &"<;"& at the start of the
8788 list.
8789 .endlist
8790
8791
8792
8793 .section "Host list patterns for single-key lookups by host address" &&&
8794          "SECThoslispatsikey"
8795 .cindex "host list" "lookup of IP address"
8796 When a host is to be identified by a single-key lookup of its complete IP
8797 address, the pattern takes this form:
8798 .display
8799 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8800 .endd
8801 For example:
8802 .code
8803 hosts_lookup = net-cdb;/hosts-by-ip.db
8804 .endd
8805 The text form of the IP address of the subject host is used as the lookup key.
8806 IPv6 addresses are converted to an unabbreviated form, using lower case
8807 letters, with dots as separators because colon is the key terminator in
8808 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8809 quoting the keys, but this is a facility that was added later.] The data
8810 returned by the lookup is not used.
8811
8812 .cindex "IP address" "masking"
8813 .cindex "host list" "masked IP address"
8814 Single-key lookups can also be performed using masked IP addresses, using
8815 patterns of this form:
8816 .display
8817 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8818 .endd
8819 For example:
8820 .code
8821 net24-dbm;/networks.db
8822 .endd
8823 The IP address of the subject host is masked using <&'number'&> as the mask
8824 length. A textual string is constructed from the masked value, followed by the
8825 mask, and this is used as the lookup key. For example, if the host's IP address
8826 is 192.168.34.6, the key that is looked up for the above example is
8827 &"192.168.34.0/24"&.
8828
8829 When an IPv6 address is converted to a string, dots are normally used instead
8830 of colons, so that keys in &(lsearch)& files need not contain colons (which
8831 terminate &(lsearch)& keys). This was implemented some time before the ability
8832 to quote keys was made available in &(lsearch)& files. However, the more
8833 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8834 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8835 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8836 converted using colons and not dots.
8837 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8838 addresses are always used.
8839 The latter are converted to IPv4 addresses, in dotted-quad form.
8840
8841 Ideally, it would be nice to tidy up this anomalous situation by changing to
8842 colons in all cases, given that quoting is now available for &(lsearch)&.
8843 However, this would be an incompatible change that might break some existing
8844 configurations.
8845
8846 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8847 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8848 the former case the key strings include the mask value, whereas in the latter
8849 case the IP address is used on its own.
8850
8851
8852
8853 .section "Host list patterns that match by host name" "SECThoslispatnam"
8854 .cindex "host" "lookup failures"
8855 .cindex "unknown host name"
8856 .cindex "host list" "matching host name"
8857 There are several types of pattern that require Exim to know the name of the
8858 remote host. These are either wildcard patterns or lookups by name. (If a
8859 complete hostname is given without any wildcarding, it is used to find an IP
8860 address to match against, as described in section &<<SECThoslispatip>>&
8861 above.)
8862
8863 If the remote host name is not already known when Exim encounters one of these
8864 patterns, it has to be found from the IP address.
8865 Although many sites on the Internet are conscientious about maintaining reverse
8866 DNS data for their hosts, there are also many that do not do this.
8867 Consequently, a name cannot always be found, and this may lead to unwanted
8868 effects. Take care when configuring host lists with wildcarded name patterns.
8869 Consider what will happen if a name cannot be found.
8870
8871 Because of the problems of determining host names from IP addresses, matching
8872 against host names is not as common as matching against IP addresses.
8873
8874 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8875 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8876 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8877 are done can be changed by setting the &%host_lookup_order%& option. For
8878 security, once Exim has found one or more names, it looks up the IP addresses
8879 for these names and compares them with the IP address that it started with.
8880 Only those names whose IP addresses match are accepted. Any other names are
8881 discarded. If no names are left, Exim behaves as if the host name cannot be
8882 found. In the most common case there is only one name and one IP address.
8883
8884 There are some options that control what happens if a host name cannot be
8885 found. These are described in section &<<SECTbehipnot>>& below.
8886
8887 .cindex "host" "alias for"
8888 .cindex "alias for host"
8889 As a result of aliasing, hosts may have more than one name. When processing any
8890 of the following types of pattern, all the host's names are checked:
8891
8892 .ilist
8893 .cindex "asterisk" "in host list"
8894 If a pattern starts with &"*"& the remainder of the item must match the end of
8895 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8896 &'.b.c'&. This special simple form is provided because this is a very common
8897 requirement. Other kinds of wildcarding require the use of a regular
8898 expression.
8899 .next
8900 .cindex "regular expressions" "in host list"
8901 .cindex "host list" "regular expression in"
8902 If the item starts with &"^"& it is taken to be a regular expression which is
8903 matched against the host name. Host names are case-independent, so this regular
8904 expression match is by default case-independent, but you can make it
8905 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8906 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8907 example,
8908 .code
8909 ^(a|b)\.c\.d$
8910 .endd
8911 is a regular expression that matches either of the two hosts &'a.c.d'& or
8912 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8913 that backslash and dollar characters are not misinterpreted as part of the
8914 string expansion. The simplest way to do this is to use &`\N`& to mark that
8915 part of the string as non-expandable. For example:
8916 .code
8917 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8918 .endd
8919 &*Warning*&: If you want to match a complete host name, you must include the
8920 &`$`& terminating metacharacter in the regular expression, as in the above
8921 example. Without it, a match at the start of the host name is all that is
8922 required.
8923 .endlist
8924
8925
8926
8927
8928 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8929 .cindex "host" "lookup failures, permanent"
8930 While processing a host list, Exim may need to look up an IP address from a
8931 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8932 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8933 behaviour when it fails to find the information it is seeking is the same.
8934
8935 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8936 apply to temporary DNS errors, whose handling is described in the next section.
8937
8938 .cindex "&`+include_unknown`&"
8939 .cindex "&`+ignore_unknown`&"
8940 Exim parses a host list from left to right. If it encounters a permanent
8941 lookup failure in any item in the host list before it has found a match,
8942 Exim treats it as a failure and the default behavior is as if the host
8943 does not match the list. This may not always be what you want to happen.
8944 To change Exim's behaviour, the special items &`+include_unknown`& or
8945 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8946 not recognized in an indirected file).
8947
8948 .ilist
8949 If any item that follows &`+include_unknown`& requires information that
8950 cannot found, Exim behaves as if the host does match the list. For example,
8951 .code
8952 host_reject_connection = +include_unknown:*.enemy.ex
8953 .endd
8954 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8955 any hosts whose name it cannot find.
8956
8957 .next
8958 If any item that follows &`+ignore_unknown`& requires information that cannot
8959 be found, Exim ignores that item and proceeds to the rest of the list. For
8960 example:
8961 .code
8962 accept hosts = +ignore_unknown : friend.example : \
8963                192.168.4.5
8964 .endd
8965 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8966 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8967 name can be found for 192.168.4.5, it is rejected.
8968 .endlist
8969
8970 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8971 list. The effect of each one lasts until the next, or until the end of the
8972 list.
8973
8974 .section "Mixing wildcarded host names and addresses in host lists" &&&
8975          "SECTmixwilhos"
8976 .cindex "host list" "mixing names and addresses in"
8977
8978 This section explains the host/ip processing logic with the same concepts
8979 as the previous section, but specifically addresses what happens when a
8980 wildcarded hostname is one of the items in the hostlist.
8981
8982 .ilist
8983 If you have name lookups or wildcarded host names and
8984 IP addresses in the same host list, you should normally put the IP
8985 addresses first. For example, in an ACL you could have:
8986 .code
8987 accept hosts = 10.9.8.7 : *.friend.example
8988 .endd
8989 The reason you normally would order it this way lies in the
8990 left-to-right way that Exim processes lists.  It can test IP addresses
8991 without doing any DNS lookups, but when it reaches an item that requires
8992 a host name, it fails if it cannot find a host name to compare with the
8993 pattern. If the above list is given in the opposite order, the
8994 &%accept%& statement fails for a host whose name cannot be found, even
8995 if its IP address is 10.9.8.7.
8996
8997 .next
8998 If you really do want to do the name check first, and still recognize the IP
8999 address, you can rewrite the ACL like this:
9000 .code
9001 accept hosts = *.friend.example
9002 accept hosts = 10.9.8.7
9003 .endd
9004 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9005 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9006 &`+ignore_unknown`&, which was discussed in depth in the first example in
9007 this section.
9008 .endlist
9009
9010
9011 .section "Temporary DNS errors when looking up host information" &&&
9012          "SECTtemdnserr"
9013 .cindex "host" "lookup failures, temporary"
9014 .cindex "&`+include_defer`&"
9015 .cindex "&`+ignore_defer`&"
9016 A temporary DNS lookup failure normally causes a defer action (except when
9017 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9018 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9019 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9020 section. These options should be used with care, probably only in non-critical
9021 host lists such as whitelists.
9022
9023
9024
9025 .section "Host list patterns for single-key lookups by host name" &&&
9026          "SECThoslispatnamsk"
9027 .cindex "unknown host name"
9028 .cindex "host list" "matching host name"
9029 If a pattern is of the form
9030 .display
9031 <&'single-key-search-type'&>;<&'search-data'&>
9032 .endd
9033 for example
9034 .code
9035 dbm;/host/accept/list
9036 .endd
9037 a single-key lookup is performed, using the host name as its key. If the
9038 lookup succeeds, the host matches the item. The actual data that is looked up
9039 is not used.
9040
9041 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9042 keys in the file, not IP addresses. If you want to do lookups based on IP
9043 addresses, you must precede the search type with &"net-"& (see section
9044 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9045 two items in the same list, one doing an address lookup and one doing a name
9046 lookup, both using the same file.
9047
9048
9049
9050 .section "Host list patterns for query-style lookups" "SECID81"
9051 If a pattern is of the form
9052 .display
9053 <&'query-style-search-type'&>;<&'query'&>
9054 .endd
9055 the query is obeyed, and if it succeeds, the host matches the item. The actual
9056 data that is looked up is not used. The variables &$sender_host_address$& and
9057 &$sender_host_name$& can be used in the query. For example:
9058 .code
9059 hosts_lookup = pgsql;\
9060   select ip from hostlist where ip='$sender_host_address'
9061 .endd
9062 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9063 can use the &%sg%& expansion item to change this if you need to. If you want to
9064 use masked IP addresses in database queries, you can use the &%mask%& expansion
9065 operator.
9066
9067 If the query contains a reference to &$sender_host_name$&, Exim automatically
9068 looks up the host name if it has not already done so. (See section
9069 &<<SECThoslispatnam>>& for comments on finding host names.)
9070
9071 Historical note: prior to release 4.30, Exim would always attempt to find a
9072 host name before running the query, unless the search type was preceded by
9073 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9074 still recognized for query-style lookups, but its presence or absence has no
9075 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9076 See section &<<SECThoslispatsikey>>&.)
9077
9078
9079
9080
9081
9082 .section "Address lists" "SECTaddresslist"
9083 .cindex "list" "address list"
9084 .cindex "address list" "empty item"
9085 .cindex "address list" "patterns"
9086 Address lists contain patterns that are matched against mail addresses. There
9087 is one special case to be considered: the sender address of a bounce message is
9088 always empty. You can test for this by providing an empty item in an address
9089 list. For example, you can set up a router to process bounce messages by
9090 using this option setting:
9091 .code
9092 senders = :
9093 .endd
9094 The presence of the colon creates an empty item. If you do not provide any
9095 data, the list is empty and matches nothing. The empty sender can also be
9096 detected by a regular expression that matches an empty string,
9097 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9098
9099 Non-empty items in an address list can be straightforward email addresses. For
9100 example:
9101 .code
9102 senders = jbc@askone.example : hs@anacreon.example
9103 .endd
9104 A certain amount of wildcarding is permitted. If a pattern contains an @
9105 character, but is not a regular expression and does not begin with a
9106 semicolon-terminated lookup type (described below), the local part of the
9107 subject address is compared with the local part of the pattern, which may start
9108 with an asterisk. If the local parts match, the domain is checked in exactly
9109 the same way as for a pattern in a domain list. For example, the domain can be
9110 wildcarded, refer to a named list, or be a lookup:
9111 .code
9112 deny senders = *@*.spamming.site:\
9113                *@+hostile_domains:\
9114                bozo@partial-lsearch;/list/of/dodgy/sites:\
9115                *@dbm;/bad/domains.db
9116 .endd
9117 .cindex "local part" "starting with !"
9118 .cindex "address list" "local part starting with !"
9119 If a local part that begins with an exclamation mark is required, it has to be
9120 specified using a regular expression, because otherwise the exclamation mark is
9121 treated as a sign of negation, as is standard in lists.
9122
9123 If a non-empty pattern that is not a regular expression or a lookup does not
9124 contain an @ character, it is matched against the domain part of the subject
9125 address. The only two formats that are recognized this way are a literal
9126 domain, or a domain pattern that starts with *. In both these cases, the effect
9127 is the same as if &`*@`& preceded the pattern. For example:
9128 .code
9129 deny senders = enemy.domain : *.enemy.domain
9130 .endd
9131
9132 The following kinds of more complicated address list pattern can match any
9133 address, including the empty address that is characteristic of bounce message
9134 senders:
9135
9136 .ilist
9137 .cindex "regular expressions" "in address list"
9138 .cindex "address list" "regular expression in"
9139 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9140 done against the complete address, with the pattern as the regular expression.
9141 You must take care that backslash and dollar characters are not misinterpreted
9142 as part of the string expansion. The simplest way to do this is to use &`\N`&
9143 to mark that part of the string as non-expandable. For example:
9144 .code
9145 deny senders = \N^.*this.*@example\.com$\N : \
9146                \N^\d{8}.+@spamhaus.example$\N : ...
9147 .endd
9148 The &`\N`& sequences are removed by the expansion, so these items do indeed
9149 start with &"^"& by the time they are being interpreted as address patterns.
9150
9151 .next
9152 .cindex "address list" "lookup for complete address"
9153 Complete addresses can be looked up by using a pattern that starts with a
9154 lookup type terminated by a semicolon, followed by the data for the lookup. For
9155 example:
9156 .code
9157 deny senders = cdb;/etc/blocked.senders : \
9158   mysql;select address from blocked where \
9159   address='${quote_mysql:$sender_address}'
9160 .endd
9161 Both query-style and single-key lookup types can be used. For a single-key
9162 lookup type, Exim uses the complete address as the key. However, empty keys are
9163 not supported for single-key lookups, so a match against the empty address
9164 always fails. This restriction does not apply to query-style lookups.
9165
9166 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9167 cannot be used, and is ignored if specified, with an entry being written to the
9168 panic log.
9169 .cindex "*@ with single-key lookup"
9170 However, you can configure lookup defaults, as described in section
9171 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9172 default. For example, with this lookup:
9173 .code
9174 accept senders = lsearch*@;/some/file
9175 .endd
9176 the file could contains lines like this:
9177 .code
9178 user1@domain1.example
9179 *@domain2.example
9180 .endd
9181 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9182 that are tried is:
9183 .code
9184 nimrod@jaeger.example
9185 *@jaeger.example
9186 *
9187 .endd
9188 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9189 would mean that every address matches, thus rendering the test useless.
9190
9191 &*Warning 2*&: Do not confuse these two kinds of item:
9192 .code
9193 deny recipients = dbm*@;/some/file
9194 deny recipients = *@dbm;/some/file
9195 .endd
9196 The first does a whole address lookup, with defaulting, as just described,
9197 because it starts with a lookup type. The second matches the local part and
9198 domain independently, as described in a bullet point below.
9199 .endlist
9200
9201
9202 The following kinds of address list pattern can match only non-empty addresses.
9203 If the subject address is empty, a match against any of these pattern types
9204 always fails.
9205
9206
9207 .ilist
9208 .cindex "@@ with single-key lookup"
9209 .cindex "address list" "@@ lookup type"
9210 .cindex "address list" "split local part and domain"
9211 If a pattern starts with &"@@"& followed by a single-key lookup item
9212 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9213 split into a local part and a domain. The domain is looked up in the file. If
9214 it is not found, there is no match. If it is found, the data that is looked up
9215 from the file is treated as a colon-separated list of local part patterns, each
9216 of which is matched against the subject local part in turn.
9217
9218 .cindex "asterisk" "in address list"
9219 The lookup may be a partial one, and/or one involving a search for a default
9220 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9221 patterns that are looked up can be regular expressions or begin with &"*"&, or
9222 even be further lookups. They may also be independently negated. For example,
9223 with
9224 .code
9225 deny senders = @@dbm;/etc/reject-by-domain
9226 .endd
9227 the data from which the DBM file is built could contain lines like
9228 .code
9229 baddomain.com:  !postmaster : *
9230 .endd
9231 to reject all senders except &%postmaster%& from that domain.
9232
9233 .cindex "local part" "starting with !"
9234 If a local part that actually begins with an exclamation mark is required, it
9235 has to be specified using a regular expression. In &(lsearch)& files, an entry
9236 may be split over several lines by indenting the second and subsequent lines,
9237 but the separating colon must still be included at line breaks. White space
9238 surrounding the colons is ignored. For example:
9239 .code
9240 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9241   spammer3 : spammer4
9242 .endd
9243 As in all colon-separated lists in Exim, a colon can be included in an item by
9244 doubling.
9245
9246 If the last item in the list starts with a right angle-bracket, the remainder
9247 of the item is taken as a new key to look up in order to obtain a continuation
9248 list of local parts. The new key can be any sequence of characters. Thus one
9249 might have entries like
9250 .code
9251 aol.com: spammer1 : spammer 2 : >*
9252 xyz.com: spammer3 : >*
9253 *:       ^\d{8}$
9254 .endd
9255 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9256 local parts for all domains, in addition to the specific local parts listed for
9257 each domain. Of course, using this feature costs another lookup each time a
9258 chain is followed, but the effort needed to maintain the data is reduced.
9259
9260 .cindex "loop" "in lookups"
9261 It is possible to construct loops using this facility, and in order to catch
9262 them, the chains may be no more than fifty items long.
9263
9264 .next
9265 The @@<&'lookup'&> style of item can also be used with a query-style
9266 lookup, but in this case, the chaining facility is not available. The lookup
9267 can only return a single list of local parts.
9268 .endlist
9269
9270 &*Warning*&: There is an important difference between the address list items
9271 in these two examples:
9272 .code
9273 senders = +my_list
9274 senders = *@+my_list
9275 .endd
9276 In the first one, &`my_list`& is a named address list, whereas in the second
9277 example it is a named domain list.
9278
9279
9280
9281
9282 .section "Case of letters in address lists" "SECTcasletadd"
9283 .cindex "case of local parts"
9284 .cindex "address list" "case forcing"
9285 .cindex "case forcing in address lists"
9286 Domains in email addresses are always handled caselessly, but for local parts
9287 case may be significant on some systems (see &%caseful_local_part%& for how
9288 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9289 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9290 blocking lists should be done in a case-independent manner. Since most address
9291 lists in Exim are used for this kind of control, Exim attempts to do this by
9292 default.
9293
9294 The domain portion of an address is always lowercased before matching it to an
9295 address list. The local part is lowercased by default, and any string
9296 comparisons that take place are done caselessly. This means that the data in
9297 the address list itself, in files included as plain filenames, and in any file
9298 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9299 keys in files that are looked up by a search type other than &(lsearch)& (which
9300 works caselessly) must be in lower case, because these lookups are not
9301 case-independent.
9302
9303 .cindex "&`+caseful`&"
9304 To allow for the possibility of caseful address list matching, if an item in
9305 an address list is the string &"+caseful"&, the original case of the local
9306 part is restored for any comparisons that follow, and string comparisons are no
9307 longer case-independent. This does not affect the domain, which remains in
9308 lower case. However, although independent matches on the domain alone are still
9309 performed caselessly, regular expressions that match against an entire address
9310 become case-sensitive after &"+caseful"& has been seen.
9311
9312
9313
9314 .section "Local part lists" "SECTlocparlis"
9315 .cindex "list" "local part list"
9316 .cindex "local part" "list"
9317 Case-sensitivity in local part lists is handled in the same way as for address
9318 lists, as just described. The &"+caseful"& item can be used if required. In a
9319 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9320 set false, the subject is lowercased and the matching is initially
9321 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9322 matching in the local part list, but not elsewhere in the router. If
9323 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9324 option is case-sensitive from the start.
9325
9326 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9327 comments are handled in the same way as address lists &-- they are recognized
9328 only if the # is preceded by white space or the start of the line.
9329 Otherwise, local part lists are matched in the same way as domain lists, except
9330 that the special items that refer to the local host (&`@`&, &`@[]`&,
9331 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9332 Refer to section &<<SECTdomainlist>>& for details of the other available item
9333 types.
9334 .ecindex IIDdohoadli
9335
9336
9337
9338
9339 . ////////////////////////////////////////////////////////////////////////////
9340 . ////////////////////////////////////////////////////////////////////////////
9341
9342 .chapter "String expansions" "CHAPexpand"
9343 .scindex IIDstrexp "expansion" "of strings"
9344 Many strings in Exim's runtime configuration are expanded before use. Some of
9345 them are expanded every time they are used; others are expanded only once.
9346
9347 When a string is being expanded it is copied verbatim from left to right except
9348 .cindex expansion "string concatenation"
9349 when a dollar or backslash character is encountered. A dollar specifies the
9350 start of a portion of the string that is interpreted and replaced as described
9351 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9352 escape character, as described in the following section.
9353
9354 Whether a string is expanded depends upon the context.  Usually this is solely
9355 dependent upon the option for which a value is sought; in this documentation,
9356 options for which string expansion is performed are marked with &dagger; after
9357 the data type.  ACL rules always expand strings.  A couple of expansion
9358 conditions do not expand some of the brace-delimited branches, for security
9359 reasons,
9360 .cindex "tainted data" expansion
9361 .cindex expansion "tainted data"
9362 and expansion of data deriving from the sender (&"tainted data"&)
9363 is not permitted.
9364
9365
9366
9367 .section "Literal text in expanded strings" "SECTlittext"
9368 .cindex "expansion" "including literal text"
9369 An uninterpreted dollar can be included in an expanded string by putting a
9370 backslash in front of it. A backslash can be used to prevent any special
9371 character being treated specially in an expansion, including backslash itself.
9372 If the string appears in quotes in the configuration file, two backslashes are
9373 required because the quotes themselves cause interpretation of backslashes when
9374 the string is read in (see section &<<SECTstrings>>&).
9375
9376 .cindex "expansion" "non-expandable substrings"
9377 A portion of the string can specified as non-expandable by placing it between
9378 two occurrences of &`\N`&. This is particularly useful for protecting regular
9379 expressions, which often contain backslashes and dollar signs. For example:
9380 .code
9381 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9382 .endd
9383 On encountering the first &`\N`&, the expander copies subsequent characters
9384 without interpretation until it reaches the next &`\N`& or the end of the
9385 string.
9386
9387
9388
9389 .section "Character escape sequences in expanded strings" "SECID82"
9390 .cindex "expansion" "escape sequences"
9391 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9392 expanded string is recognized as an escape sequence for the character newline,
9393 carriage return, or tab, respectively. A backslash followed by up to three
9394 octal digits is recognized as an octal encoding for a single character, and a
9395 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9396 encoding.
9397
9398 These escape sequences are also recognized in quoted strings when they are read
9399 in. Their interpretation in expansions as well is useful for unquoted strings,
9400 and for other cases such as looked-up strings that are then expanded.
9401
9402
9403 .section "Testing string expansions" "SECID83"
9404 .cindex "expansion" "testing"
9405 .cindex "testing" "string expansion"
9406 .oindex "&%-be%&"
9407 Many expansions can be tested by calling Exim with the &%-be%& option. This
9408 takes the command arguments, or lines from the standard input if there are no
9409 arguments, runs them through the string expansion code, and writes the results
9410 to the standard output. Variables based on configuration values are set up, but
9411 since no message is being processed, variables such as &$local_part$& have no
9412 value. Nevertheless the &%-be%& option can be useful for checking out file and
9413 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9414 and &%nhash%&.
9415
9416 Exim gives up its root privilege when it is called with the &%-be%& option, and
9417 instead runs under the uid and gid it was called with, to prevent users from
9418 using &%-be%& for reading files to which they do not have access.
9419
9420 .oindex "&%-bem%&"
9421 If you want to test expansions that include variables whose values are taken
9422 from a message, there are two other options that can be used. The &%-bem%&
9423 option is like &%-be%& except that it is followed by a filename. The file is
9424 read as a message before doing the test expansions. For example:
9425 .code
9426 exim -bem /tmp/test.message '$h_subject:'
9427 .endd
9428 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9429 Exim message identifier. For example:
9430 .code
9431 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9432 .endd
9433 This loads the message from Exim's spool before doing the test expansions, and
9434 is therefore restricted to admin users.
9435
9436
9437 .section "Forced expansion failure" "SECTforexpfai"
9438 .cindex "expansion" "forced failure"
9439 A number of expansions that are described in the following section have
9440 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9441 (which are sometimes called &"curly brackets"&). Which of the two strings is
9442 used depends on some condition that is evaluated as part of the expansion. If,
9443 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9444 the entire string expansion fails in a way that can be detected by the code
9445 that requested the expansion. This is called &"forced expansion failure"&, and
9446 its consequences depend on the circumstances. In some cases it is no different
9447 from any other expansion failure, but in others a different action may be
9448 taken. Such variations are mentioned in the documentation of the option that is
9449 being expanded.
9450
9451
9452
9453
9454 .section "Expansion items" "SECTexpansionitems"
9455 The following items are recognized in expanded strings. White space may be used
9456 between sub-items that are keywords or substrings enclosed in braces inside an
9457 outer set of braces, to improve readability. &*Warning*&: Within braces,
9458 white space is significant.
9459
9460 .vlist
9461 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9462 .cindex "expansion" "variables"
9463 Substitute the contents of the named variable, for example:
9464 .code
9465 $local_part
9466 ${domain}
9467 .endd
9468 The second form can be used to separate the name from subsequent alphanumeric
9469 characters. This form (using braces) is available only for variables; it does
9470 &'not'& apply to message headers. The names of the variables are given in
9471 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9472 given, the expansion fails.
9473
9474 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9475 .cindex "expansion" "operators"
9476 The string is first itself expanded, and then the operation specified by
9477 <&'op'&> is applied to it. For example:
9478 .code
9479 ${lc:$local_part}
9480 .endd
9481 The string starts with the first character after the colon, which may be
9482 leading white space. A list of operators is given in section &<<SECTexpop>>&
9483 below. The operator notation is used for simple expansion items that have just
9484 one argument, because it reduces the number of braces and therefore makes the
9485 string easier to understand.
9486
9487 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9488 This item inserts &"basic"& header lines. It is described with the &%header%&
9489 expansion item below.
9490
9491
9492 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9493 .cindex "expansion" "calling an acl"
9494 .cindex "&%acl%&" "call from expansion"
9495 The name and zero to nine argument strings are first expanded separately.  The expanded
9496 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9497 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9498 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9499 and may use the variables; if another acl expansion is used the values
9500 are restored after it returns.  If the ACL sets
9501 a value using a "message =" modifier and returns accept or deny, the value becomes
9502 the result of the expansion.
9503 If no message is set and the ACL returns accept or deny
9504 the expansion result is an empty string.
9505 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9506
9507
9508 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9509 .cindex authentication "results header"
9510 .cindex headers "authentication-results:"
9511 .cindex authentication "expansion item"
9512 This item returns a string suitable for insertion as an
9513 &'Authentication-Results:'&
9514 header line.
9515 The given <&'authserv-id'&> is included in the result; typically this
9516 will be a domain name identifying the system performing the authentications.
9517 Methods that might be present in the result include:
9518 .code
9519 none
9520 iprev
9521 auth
9522 spf
9523 dkim
9524 .endd
9525
9526 Example use (as an ACL modifier):
9527 .code
9528       add_header = :at_start:${authresults {$primary_hostname}}
9529 .endd
9530 This is safe even if no authentication results are available.
9531
9532
9533 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9534        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9535 .cindex "expansion" "extracting certificate fields"
9536 .cindex "&%certextract%&" "certificate fields"
9537 .cindex "certificate" "extracting fields"
9538 The <&'certificate'&> must be a variable of type certificate.
9539 The field name is expanded and used to retrieve the relevant field from
9540 the certificate.  Supported fields are:
9541 .display
9542 &`version        `&
9543 &`serial_number  `&
9544 &`subject        `& RFC4514 DN
9545 &`issuer         `& RFC4514 DN
9546 &`notbefore      `& time
9547 &`notafter       `& time
9548 &`sig_algorithm  `&
9549 &`signature      `&
9550 &`subj_altname   `& tagged list
9551 &`ocsp_uri       `& list
9552 &`crl_uri        `& list
9553 .endd
9554 If the field is found,
9555 <&'string2'&> is expanded, and replaces the whole item;
9556 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9557 variable &$value$& contains the value that has been extracted. Afterwards, it
9558 is restored to any previous value it might have had.
9559
9560 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9561 key is not found. If {<&'string2'&>} is also omitted, the value that was
9562 extracted is used.
9563
9564 Some field names take optional modifiers, appended and separated by commas.
9565
9566 The field selectors marked as "RFC4514" above
9567 output a Distinguished Name string which is
9568 not quite
9569 parseable by Exim as a comma-separated tagged list
9570 (the exceptions being elements containing commas).
9571 RDN elements of a single type may be selected by
9572 a modifier of the type label; if so the expansion
9573 result is a list (newline-separated by default).
9574 The separator may be changed by another modifier of
9575 a right angle-bracket followed immediately by the new separator.
9576 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9577
9578 The field selectors marked as "time" above
9579 take an optional modifier of "int"
9580 for which the result is the number of seconds since epoch.
9581 Otherwise the result is a human-readable string
9582 in the timezone selected by the main "timezone" option.
9583
9584 The field selectors marked as "list" above return a list,
9585 newline-separated by default,
9586 (embedded separator characters in elements are doubled).
9587 The separator may be changed by a modifier of
9588 a right angle-bracket followed immediately by the new separator.
9589
9590 The field selectors marked as "tagged" above
9591 prefix each list element with a type string and an equals sign.
9592 Elements of only one type may be selected by a modifier
9593 which is one of "dns", "uri" or "mail";
9594 if so the element tags are omitted.
9595
9596 If not otherwise noted field values are presented in human-readable form.
9597
9598 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9599        {*&<&'arg'&>&*}...}*&"
9600 .cindex &%dlfunc%&
9601 This expansion dynamically loads and then calls a locally-written C function.
9602 This functionality is available only if Exim is compiled with
9603 .code
9604 EXPAND_DLFUNC=yes
9605 .endd
9606 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9607 object so that it doesn't reload the same object file in the same Exim process
9608 (but of course Exim does start new processes frequently).
9609
9610 There may be from zero to eight arguments to the function.
9611
9612 When compiling
9613 a local function that is to be called in this way,
9614 first &_DLFUNC_IMPL_& should be defined,
9615 and second &_local_scan.h_& should be included.
9616 The Exim variables and functions that are defined by that API
9617 are also available for dynamically loaded functions. The function itself
9618 must have the following type:
9619 .code
9620 int dlfunction(uschar **yield, int argc, uschar *argv[])
9621 .endd
9622 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9623 function should return one of the following values:
9624
9625 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9626 into the expanded string that is being built.
9627
9628 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9629 from &'yield'&, if it is set.
9630
9631 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9632 taken from &'yield'& if it is set.
9633
9634 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9635
9636 When compiling a function that is to be used in this way with gcc,
9637 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9638 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9639
9640
9641 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9642 .cindex "expansion" "extracting value from environment"
9643 .cindex "environment" "values from"
9644 The key is first expanded separately, and leading and trailing white space
9645 removed.
9646 This is then searched for as a name in the environment.
9647 If a variable is found then its value is placed in &$value$&
9648 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9649
9650 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9651 appear, for example:
9652 .code
9653 ${env{USER}{$value} fail }
9654 .endd
9655 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9656 {<&'string1'&>} must be present for &"fail"& to be recognized.
9657
9658 If {<&'string2'&>} is omitted an empty string is substituted on
9659 search failure.
9660 If {<&'string1'&>} is omitted the search result is substituted on
9661 search success.
9662
9663 The environment is adjusted by the &%keep_environment%& and
9664 &%add_environment%& main section options.
9665
9666
9667 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9668        {*&<&'string3'&>&*}}*&"
9669 .cindex "expansion" "extracting substrings by key"
9670 .cindex "&%extract%&" "substrings by key"
9671 The key and <&'string1'&> are first expanded separately. Leading and trailing
9672 white space is removed from the key (but not from any of the strings). The key
9673 must not be empty and must not consist entirely of digits.
9674 The expanded <&'string1'&> must be of the form:
9675 .display
9676 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9677 .endd
9678 .vindex "&$value$&"
9679 where the equals signs and spaces (but not both) are optional. If any of the
9680 values contain white space, they must be enclosed in double quotes, and any
9681 values that are enclosed in double quotes are subject to escape processing as
9682 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9683 for the value that corresponds to the key. The search is case-insensitive. If
9684 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9685 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9686 variable &$value$& contains the value that has been extracted. Afterwards, it
9687 is restored to any previous value it might have had.
9688
9689 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9690 key is not found. If {<&'string2'&>} is also omitted, the value that was
9691 extracted is used. Thus, for example, these two expansions are identical, and
9692 yield &"2001"&:
9693 .code
9694 ${extract{gid}{uid=1984 gid=2001}}
9695 ${extract{gid}{uid=1984 gid=2001}{$value}}
9696 .endd
9697 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9698 appear, for example:
9699 .code
9700 ${extract{Z}{A=... B=...}{$value} fail }
9701 .endd
9702 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9703 {<&'string2'&>} must be present for &"fail"& to be recognized.
9704
9705 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9706        {*&<&'string3'&>&*}}*&" &&&
9707        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9708        {*&<&'string3'&>&*}}*&"
9709 .cindex "expansion" "extracting from JSON object"
9710 .cindex JSON expansions
9711 The key and <&'string1'&> are first expanded separately. Leading and trailing
9712 white space is removed from the key (but not from any of the strings). The key
9713 must not be empty and must not consist entirely of digits.
9714 The expanded <&'string1'&> must be of the form:
9715 .display
9716 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9717 .endd
9718 .vindex "&$value$&"
9719 The braces, commas and colons, and the quoting of the member name are required;
9720 the spaces are optional.
9721 Matching of the key against the member names is done case-sensitively.
9722 For the &"json"& variant,
9723 if a returned value is a JSON string, it retains its leading and
9724 trailing quotes.
9725 For the &"jsons"& variant, which is intended for use with JSON strings, the
9726 leading and trailing quotes are removed from the returned value.
9727 . XXX should be a UTF-8 compare
9728
9729 The results of matching are handled as above.
9730
9731
9732 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9733         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9734 .cindex "expansion" "extracting substrings by number"
9735 .cindex "&%extract%&" "substrings by number"
9736 The <&'number'&> argument must consist entirely of decimal digits,
9737 apart from leading and trailing white space, which is ignored.
9738 This is what distinguishes this form of &%extract%& from the previous kind. It
9739 behaves in the same way, except that, instead of extracting a named field, it
9740 extracts from <&'string1'&> the field whose number is given as the first
9741 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9742 <&'string3'&> as before.
9743
9744 The fields in the string are separated by any one of the characters in the
9745 separator string. These may include space or tab characters.
9746 The first field is numbered one. If the number is negative, the fields are
9747 counted from the end of the string, with the rightmost one numbered -1. If the
9748 number given is zero, the entire string is returned. If the modulus of the
9749 number is greater than the number of fields in the string, the result is the
9750 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9751 provided. For example:
9752 .code
9753 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9754 .endd
9755 yields &"42"&, and
9756 .code
9757 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9758 .endd
9759 yields &"99"&. Two successive separators mean that the field between them is
9760 empty (for example, the fifth field above).
9761
9762
9763 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9764         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9765        "&*${extract jsons{*&<&'number'&>&*}}&&&
9766         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9767 .cindex "expansion" "extracting from JSON array"
9768 .cindex JSON expansions
9769 The <&'number'&> argument must consist entirely of decimal digits,
9770 apart from leading and trailing white space, which is ignored.
9771
9772 Field selection and result handling is as above;
9773 there is no choice of field separator.
9774 For the &"json"& variant,
9775 if a returned value is a JSON string, it retains its leading and
9776 trailing quotes.
9777 For the &"jsons"& variant, which is intended for use with JSON strings, the
9778 leading and trailing quotes are removed from the returned value.
9779
9780
9781 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9782 .cindex "list" "selecting by condition"
9783 .cindex "expansion" "selecting from list by condition"
9784 .vindex "&$item$&"
9785 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9786 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9787 For each item
9788 in this list, its value is place in &$item$&, and then the condition is
9789 evaluated. If the condition is true, &$item$& is added to the output as an
9790 item in a new list; if the condition is false, the item is discarded. The
9791 separator used for the output list is the same as the one used for the
9792 input, but a separator setting is not included in the output. For example:
9793 .code
9794 ${filter{a:b:c}{!eq{$item}{b}}}
9795 .endd
9796 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9797 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9798
9799
9800 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9801 .cindex "hash function" "textual"
9802 .cindex "expansion" "textual hash"
9803 This is a textual hashing function, and was the first to be implemented in
9804 early versions of Exim. In current releases, there are other hashing functions
9805 (numeric, MD5, and SHA-1), which are described below.
9806
9807 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9808 <&'n'&>. If you are using fixed values for these numbers, that is, if
9809 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9810 use the simpler operator notation that avoids some of the braces:
9811 .code
9812 ${hash_<n>_<m>:<string>}
9813 .endd
9814 The second number is optional (in both notations). If <&'n'&> is greater than
9815 or equal to the length of the string, the expansion item returns the string.
9816 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9817 function to the string. The new string consists of characters taken from the
9818 first <&'m'&> characters of the string
9819 .code
9820 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9821 .endd
9822 If <&'m'&> is not present the value 26 is used, so that only lower case
9823 letters appear. For example:
9824 .display
9825 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9826 &`$hash{5}{monty}}           `&   yields  &`monty`&
9827 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9828 .endd
9829
9830 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9831         &*$h_*&<&'header&~name'&>&*:*&" &&&
9832        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9833         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9834        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9835         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9836        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9837         &*$rh_*&<&'header&~name'&>&*:*&"
9838 .cindex "expansion" "header insertion"
9839 .vindex "&$header_$&"
9840 .vindex "&$bheader_$&"
9841 .vindex "&$lheader_$&"
9842 .vindex "&$rheader_$&"
9843 .cindex "header lines" "in expansion strings"
9844 .cindex "header lines" "character sets"
9845 .cindex "header lines" "decoding"
9846 Substitute the contents of the named message header line, for example
9847 .code
9848 $header_reply-to:
9849 .endd
9850 The newline that terminates a header line is not included in the expansion, but
9851 internal newlines (caused by splitting the header line over several physical
9852 lines) may be present.
9853
9854 The difference between the four pairs of expansions is in the way
9855 the data in the header line is interpreted.
9856
9857 .ilist
9858 .cindex "white space" "in header lines"
9859 &%rheader%& gives the original &"raw"& content of the header line, with no
9860 processing at all, and without the removal of leading and trailing white space.
9861
9862 .next
9863 .cindex "list" "of header lines"
9864 &%lheader%& gives a colon-separated list, one element per header when there
9865 are multiple headers with a given name.
9866 Any embedded colon characters within an element are doubled, so normal Exim
9867 list-processing facilities can be used.
9868 The terminating newline of each element is removed; in other respects
9869 the content is &"raw"&.
9870
9871 .next
9872 .cindex "base64 encoding" "in header lines"
9873 &%bheader%& removes leading and trailing white space, and then decodes base64
9874 or quoted-printable MIME &"words"& within the header text, but does no
9875 character set translation. If decoding of what looks superficially like a MIME
9876 &"word"& fails, the raw string is returned. If decoding
9877 .cindex "binary zero" "in header line"
9878 produces a binary zero character, it is replaced by a question mark &-- this is
9879 what Exim does for binary zeros that are actually received in header lines.
9880
9881 .next
9882 &%header%& tries to translate the string as decoded by &%bheader%& to a
9883 standard character set. This is an attempt to produce the same string as would
9884 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9885 returned. Translation is attempted only on operating systems that support the
9886 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9887 a system Makefile or in &_Local/Makefile_&.
9888 .endlist ilist
9889
9890 In a filter file, the target character set for &%header%& can be specified by a
9891 command of the following form:
9892 .code
9893 headers charset "UTF-8"
9894 .endd
9895 This command affects all references to &$h_$& (or &$header_$&) expansions in
9896 subsequently obeyed filter commands. In the absence of this command, the target
9897 character set in a filter is taken from the setting of the &%headers_charset%&
9898 option in the runtime configuration. The value of this option defaults to the
9899 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9900 ISO-8859-1.
9901
9902 Header names follow the syntax of RFC 2822, which states that they may contain
9903 any printing characters except space and colon. Consequently, curly brackets
9904 &'do not'& terminate header names, and should not be used to enclose them as
9905 if they were variables. Attempting to do so causes a syntax error.
9906
9907 Only header lines that are common to all copies of a message are visible to
9908 this mechanism. These are the original header lines that are received with the
9909 message, and any that are added by an ACL statement or by a system
9910 filter. Header lines that are added to a particular copy of a message by a
9911 router or transport are not accessible.
9912
9913 For incoming SMTP messages, no header lines are visible in
9914 ACLs that are obeyed before the data phase completes,
9915 because the header structure is not set up until the message is received.
9916 They are visible in DKIM, PRDR and DATA ACLs.
9917 Header lines that are added in a RCPT ACL (for example)
9918 are saved until the message's incoming header lines are available, at which
9919 point they are added.
9920 When any of the above ACLs ar
9921 running, however, header lines added by earlier ACLs are visible.
9922
9923 Upper case and lower case letters are synonymous in header names. If the
9924 following character is white space, the terminating colon may be omitted, but
9925 this is not recommended, because you may then forget it when it is needed. When
9926 white space terminates the header name, this white space is included in the
9927 expanded string.  If the message does not contain the given header, the
9928 expansion item is replaced by an empty string. (See the &%def%& condition in
9929 section &<<SECTexpcond>>& for a means of testing for the existence of a
9930 header.)
9931
9932 If there is more than one header with the same name, they are all concatenated
9933 to form the substitution string, up to a maximum length of 64K. Unless
9934 &%rheader%& is being used, leading and trailing white space is removed from
9935 each header before concatenation, and a completely empty header is ignored. A
9936 newline character is then inserted between non-empty headers, but there is no
9937 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9938 those headers that contain lists of addresses, a comma is also inserted at the
9939 junctions between headers. This does not happen for the &%rheader%& expansion.
9940
9941 .new
9942 .cindex "tainted data"
9943 When the headers are from an incoming message,
9944 the result of expanding any of these variables is tainted.
9945 .wen
9946
9947
9948 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9949 .cindex "expansion" "hmac hashing"
9950 .cindex &%hmac%&
9951 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9952 shared secret and some text into a message authentication code, as specified in
9953 RFC 2104. This differs from &`${md5:secret_text...}`& or
9954 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9955 cryptographic hash, allowing for authentication that is not possible with MD5
9956 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9957 present. For example:
9958 .code
9959 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9960 .endd
9961 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9962 produces:
9963 .code
9964 dd97e3ba5d1a61b5006108f8c8252953
9965 .endd
9966 As an example of how this might be used, you might put in the main part of
9967 an Exim configuration:
9968 .code
9969 SPAMSCAN_SECRET=cohgheeLei2thahw
9970 .endd
9971 In a router or a transport you could then have:
9972 .code
9973 headers_add = \
9974   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9975   ${hmac{md5}{SPAMSCAN_SECRET}\
9976   {${primary_hostname},${message_exim_id},$h_message-id:}}
9977 .endd
9978 Then given a message, you can check where it was scanned by looking at the
9979 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9980 this header line is authentic by recomputing the authentication code from the
9981 host name, message ID and the &'Message-id:'& header line. This can be done
9982 using Exim's &%-be%& option, or by other means, for example, by using the
9983 &'hmac_md5_hex()'& function in Perl.
9984
9985
9986 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9987 .cindex "expansion" "conditional"
9988 .cindex "&%if%&, expansion item"
9989 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9990 item; otherwise <&'string2'&> is used. The available conditions are described
9991 in section &<<SECTexpcond>>& below. For example:
9992 .code
9993 ${if eq {$local_part}{postmaster} {yes}{no} }
9994 .endd
9995 The second string need not be present; if it is not and the condition is not
9996 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9997 be present instead of the second string (without any curly brackets). In this
9998 case, the expansion is forced to fail if the condition is not true (see section
9999 &<<SECTforexpfai>>&).
10000
10001 If both strings are omitted, the result is the string &`true`& if the condition
10002 is true, and the empty string if the condition is false. This makes it less
10003 cumbersome to write custom ACL and router conditions. For example, instead of
10004 .code
10005 condition = ${if >{$acl_m4}{3}{true}{false}}
10006 .endd
10007 you can use
10008 .code
10009 condition = ${if >{$acl_m4}{3}}
10010 .endd
10011
10012
10013
10014 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10015 .cindex expansion "imap folder"
10016 .cindex "&%imapfolder%& expansion item"
10017 This item converts a (possibly multilevel, or with non-ASCII characters)
10018 folder specification to a Maildir name for filesystem use.
10019 For information on internationalisation support see &<<SECTi18nMDA>>&.
10020
10021
10022
10023 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10024 .cindex "expansion" "string truncation"
10025 .cindex "&%length%& expansion item"
10026 The &%length%& item is used to extract the initial portion of a string. Both
10027 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10028 you are using a fixed value for the number, that is, if <&'string1'&> does not
10029 change when expanded, you can use the simpler operator notation that avoids
10030 some of the braces:
10031 .code
10032 ${length_<n>:<string>}
10033 .endd
10034 The result of this item is either the first <&'n'&> bytes or the whole
10035 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10036 &%strlen%&, which gives the length of a string.
10037 All measurement is done in bytes and is not UTF-8 aware.
10038
10039
10040 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10041         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10042 .cindex "expansion" "extracting list elements by number"
10043 .cindex "&%listextract%&" "extract list elements by number"
10044 .cindex "list" "extracting elements by number"
10045 The <&'number'&> argument must consist entirely of decimal digits,
10046 apart from an optional leading minus,
10047 and leading and trailing white space (which is ignored).
10048
10049 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10050 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10051
10052 The first field of the list is numbered one.
10053 If the number is negative, the fields are
10054 counted from the end of the list, with the rightmost one numbered -1.
10055 The numbered element of the list is extracted and placed in &$value$&,
10056 then <&'string2'&> is expanded as the result.
10057
10058 If the modulus of the
10059 number is zero or greater than the number of fields in the string,
10060 the result is the expansion of <&'string3'&>.
10061
10062 For example:
10063 .code
10064 ${listextract{2}{x:42:99}}
10065 .endd
10066 yields &"42"&, and
10067 .code
10068 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10069 .endd
10070 yields &"result: 42"&.
10071
10072 If {<&'string3'&>} is omitted, an empty string is used for string3.
10073 If {<&'string2'&>} is also omitted, the value that was
10074 extracted is used.
10075 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10076
10077
10078 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10079         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10080 This is the first of one of two different types of lookup item, which are both
10081 described in the next item.
10082
10083 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10084         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10085 .cindex "expansion" "lookup in"
10086 .cindex "file" "lookups"
10087 .cindex "lookup" "in expanded string"
10088 The two forms of lookup item specify data lookups in files and databases, as
10089 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10090 lookups, and the second is used for query-style lookups. The <&'key'&>,
10091 <&'file'&>, and <&'query'&> strings are expanded before use.
10092
10093 If there is any white space in a lookup item which is part of a filter command,
10094 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10095 other place where white space is significant, the lookup item must be enclosed
10096 in double quotes. The use of data lookups in users' filter files may be locked
10097 out by the system administrator.
10098
10099 .vindex "&$value$&"
10100 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10101 During its expansion, the variable &$value$& contains the data returned by the
10102 lookup. Afterwards it reverts to the value it had previously (at the outer
10103 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10104 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10105 string on failure. If <&'string2'&> is provided, it can itself be a nested
10106 lookup, thus providing a mechanism for looking up a default value when the
10107 original lookup fails.
10108
10109 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10110 data for the outer lookup while the parameters of the second lookup are
10111 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10112 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10113 appear, and in this case, if the lookup fails, the entire expansion is forced
10114 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10115 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10116 successful lookup, and nothing in the case of failure.
10117
10118 For single-key lookups, the string &"partial"& is permitted to precede the
10119 search type in order to do partial matching, and * or *@ may follow a search
10120 type to request default lookups if the key does not match (see sections
10121 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10122
10123 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10124 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10125 and non-wild parts of the key during the expansion of the replacement text.
10126 They return to their previous values at the end of the lookup item.
10127
10128 This example looks up the postmaster alias in the conventional alias file:
10129 .code
10130 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10131 .endd
10132 This example uses NIS+ to look up the full name of the user corresponding to
10133 the local part of an address, forcing the expansion to fail if it is not found:
10134 .code
10135 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10136   {$value}fail}
10137 .endd
10138
10139
10140 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10141 .cindex "expansion" "list creation"
10142 .vindex "&$item$&"
10143 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10144 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10145 For each item
10146 in this list, its value is place in &$item$&, and then <&'string2'&> is
10147 expanded and added to the output as an item in a new list. The separator used
10148 for the output list is the same as the one used for the input, but a separator
10149 setting is not included in the output. For example:
10150 .code
10151 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10152 .endd
10153 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10154 value of &$item$& is restored to what it was before. See also the &%filter%&
10155 and &%reduce%& expansion items.
10156
10157 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10158 .cindex "expansion" "numeric hash"
10159 .cindex "hash function" "numeric"
10160 The three strings are expanded; the first two must yield numbers. Call them
10161 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10162 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10163 can use the simpler operator notation that avoids some of the braces:
10164 .code
10165 ${nhash_<n>_<m>:<string>}
10166 .endd
10167 The second number is optional (in both notations). If there is only one number,
10168 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10169 processed by a div/mod hash function that returns two numbers, separated by a
10170 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10171 example,
10172 .code
10173 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10174 .endd
10175 returns the string &"6/33"&.
10176
10177
10178
10179 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10180 .cindex "Perl" "use in expanded string"
10181 .cindex "expansion" "calling Perl from"
10182 This item is available only if Exim has been built to include an embedded Perl
10183 interpreter. The subroutine name and the arguments are first separately
10184 expanded, and then the Perl subroutine is called with those arguments. No
10185 additional arguments need be given; the maximum number permitted, including the
10186 name of the subroutine, is nine.
10187
10188 The return value of the subroutine is inserted into the expanded string, unless
10189 the return value is &%undef%&. In that case, the expansion fails in the same
10190 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10191 Whatever you return is evaluated in a scalar context. For example, if you
10192 return the name of a Perl vector, the return value is the size of the vector,
10193 not its contents.
10194
10195 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10196 with the error message that was passed to &%die%&. More details of the embedded
10197 Perl facility are given in chapter &<<CHAPperl>>&.
10198
10199 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10200 out the use of this expansion item in filter files.
10201
10202
10203 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10204 .cindex "&%prvs%& expansion item"
10205 The first argument is a complete email address and the second is secret
10206 keystring. The third argument, specifying a key number, is optional. If absent,
10207 it defaults to 0. The result of the expansion is a prvs-signed email address,
10208 to be typically used with the &%return_path%& option on an &(smtp)& transport
10209 as part of a bounce address tag validation (BATV) scheme. For more discussion
10210 and an example, see section &<<SECTverifyPRVS>>&.
10211
10212 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10213         {*&<&'string'&>&*}}*&"
10214 .cindex "&%prvscheck%& expansion item"
10215 This expansion item is the complement of the &%prvs%& item. It is used for
10216 checking prvs-signed addresses. If the expansion of the first argument does not
10217 yield a syntactically valid prvs-signed address, the whole item expands to the
10218 empty string. When the first argument does expand to a syntactically valid
10219 prvs-signed address, the second argument is expanded, with the prvs-decoded
10220 version of the address and the key number extracted from the address in the
10221 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10222
10223 These two variables can be used in the expansion of the second argument to
10224 retrieve the secret. The validity of the prvs-signed address is then checked
10225 against the secret. The result is stored in the variable &$prvscheck_result$&,
10226 which is empty for failure or &"1"& for success.
10227
10228 The third argument is optional; if it is missing, it defaults to an empty
10229 string. This argument is now expanded. If the result is an empty string, the
10230 result of the expansion is the decoded version of the address. This is the case
10231 whether or not the signature was valid. Otherwise, the result of the expansion
10232 is the expansion of the third argument.
10233
10234 All three variables can be used in the expansion of the third argument.
10235 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10236 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10237
10238 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10239 .cindex "expansion" "inserting an entire file"
10240 .cindex "file" "inserting into expansion"
10241 .cindex "&%readfile%& expansion item"
10242 The filename and end-of-line string are first expanded separately. The file is
10243 then read, and its contents replace the entire item. All newline characters in
10244 the file are replaced by the end-of-line string if it is present. Otherwise,
10245 newlines are left in the string.
10246 String expansion is not applied to the contents of the file. If you want this,
10247 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10248 the string expansion fails.
10249
10250 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10251 locks out the use of this expansion item in filter files.
10252
10253
10254
10255 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10256         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10257 .cindex "expansion" "inserting from a socket"
10258 .cindex "socket, use of in expansion"
10259 .cindex "&%readsocket%& expansion item"
10260 This item inserts data from a Unix domain or TCP socket into the expanded
10261 string. The minimal way of using it uses just two arguments, as in these
10262 examples:
10263 .code
10264 ${readsocket{/socket/name}{request string}}
10265 ${readsocket{inet:some.host:1234}{request string}}
10266 .endd
10267 For a Unix domain socket, the first substring must be the path to the socket.
10268 For an Internet socket, the first substring must contain &`inet:`& followed by
10269 a host name or IP address, followed by a colon and a port, which can be a
10270 number or the name of a TCP port in &_/etc/services_&. An IP address may
10271 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10272 example:
10273 .code
10274 ${readsocket{inet:[::1]:1234}{request string}}
10275 .endd
10276 Only a single host name may be given, but if looking it up yields more than
10277 one IP address, they are each tried in turn until a connection is made. For
10278 both kinds of socket, Exim makes a connection, writes the request string
10279 unless it is an empty string; and no terminating NUL is ever sent)
10280 and reads from the socket until an end-of-file
10281 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10282 extend what can be done. Firstly, you can vary the timeout. For example:
10283 .code
10284 ${readsocket{/socket/name}{request string}{3s}}
10285 .endd
10286
10287 The third argument is a list of options, of which the first element is the timeout
10288 and must be present if any options are given.
10289 Further elements are options of form &'name=value'&.
10290 Example:
10291 .code
10292 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10293 .endd
10294
10295 .new
10296 The following option names are recognised:
10297 .ilist
10298 &*buf*&
10299 Only relevant for plaintext (non-TLS) connections.
10300 This defines buferring used when readong from the socket.
10301 Values are &"line"& (the default), &"full"& and &"no"& (meaning none).
10302 .next
10303
10304 &*cache*&
10305 Defines if the result data can be cached for use by a later identical
10306 request in the same process.
10307 Values are &"yes"& or &"no"& (the default).
10308 If not, all cached results for this connection specification
10309 will be invalidated.
10310
10311 .next
10312 &*keepopen*&
10313 If set to &"yes"& the socket will be left open for a later call
10314 to the same service, and also no shutdown (see below) will be done.
10315 The default is &"no"&.
10316
10317 .next
10318 &*shutdown*&
10319 Defines whether or not a write-shutdown is done on the connection after
10320 sending the request. Values are &"yes"& (the default) or &"no"&
10321 (preferred, eg. by some webservers).
10322
10323 .next
10324 &*tls*&
10325 Controls the use of TLS on the connection.
10326 Values are &"yes"& or &"no"& (the default).
10327 If it is enabled, a shutdown as descripbed above is never done.
10328 .endlist
10329 .wen
10330
10331
10332 A fourth argument allows you to change any newlines that are in the data
10333 that is read, in the same way as for &%readfile%& (see above). This example
10334 turns them into spaces:
10335 .code
10336 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10337 .endd
10338 As with all expansions, the substrings are expanded before the processing
10339 happens. Errors in these sub-expansions cause the expansion to fail. In
10340 addition, the following errors can occur:
10341
10342 .ilist
10343 Failure to create a socket file descriptor;
10344 .next
10345 Failure to connect the socket;
10346 .next
10347 Failure to write the request string;
10348 .next
10349 Timeout on reading from the socket.
10350 .endlist
10351
10352 By default, any of these errors causes the expansion to fail. However, if
10353 you supply a fifth substring, it is expanded and used when any of the above
10354 errors occurs. For example:
10355 .code
10356 ${readsocket{/socket/name}{request string}{3s}{\n}\
10357   {socket failure}}
10358 .endd
10359 You can test for the existence of a Unix domain socket by wrapping this
10360 expansion in &`${if exists`&, but there is a race condition between that test
10361 and the actual opening of the socket, so it is safer to use the fifth argument
10362 if you want to be absolutely sure of avoiding an expansion error for a
10363 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10364
10365 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10366 locks out the use of this expansion item in filter files.
10367
10368
10369 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10370 .cindex "expansion" "reducing a list to a scalar"
10371 .cindex "list" "reducing to a scalar"
10372 .vindex "&$value$&"
10373 .vindex "&$item$&"
10374 This operation reduces a list to a single, scalar string. After expansion,
10375 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10376 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10377 Then <&'string2'&> is expanded and
10378 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10379 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10380 them. The result of that expansion is assigned to &$value$& before the next
10381 iteration. When the end of the list is reached, the final value of &$value$& is
10382 added to the expansion output. The &%reduce%& expansion item can be used in a
10383 number of ways. For example, to add up a list of numbers:
10384 .code
10385 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10386 .endd
10387 The result of that expansion would be &`6`&. The maximum of a list of numbers
10388 can be found:
10389 .code
10390 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10391 .endd
10392 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10393 restored to what they were before. See also the &%filter%& and &%map%&
10394 expansion items.
10395
10396 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10397 This item inserts &"raw"& header lines. It is described with the &%header%&
10398 expansion item in section &<<SECTexpansionitems>>& above.
10399
10400 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10401         {*&<&'string2'&>&*}}*&"
10402 .cindex "expansion" "running a command"
10403 .cindex "&%run%& expansion item"
10404 The command and its arguments are first expanded as one string. The string is
10405 split apart into individual arguments by spaces, and then the command is run
10406 in a separate process, but under the same uid and gid.  As in other command
10407 executions from Exim, a shell is not used by default. If the command requires
10408 a shell, you must explicitly code it.
10409
10410 Since the arguments are split by spaces, when there is a variable expansion
10411 which has an empty result, it will cause the situation that the argument will
10412 simply be omitted when the program is actually executed by Exim. If the
10413 script/program requires a specific number of arguments and the expanded
10414 variable could possibly result in this empty expansion, the variable must be
10415 quoted. This is more difficult if the expanded variable itself could result
10416 in a string containing quotes, because it would interfere with the quotes
10417 around the command arguments. A possible guard against this is to wrap the
10418 variable in the &%sg%& operator to change any quote marks to some other
10419 character.
10420
10421 The standard input for the command exists, but is empty. The standard output
10422 and standard error are set to the same file descriptor.
10423 .cindex "return code" "from &%run%& expansion"
10424 .vindex "&$value$&"
10425 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10426 and replaces the entire item; during this expansion, the standard output/error
10427 from the command is in the variable &$value$&. If the command fails,
10428 <&'string2'&>, if present, is expanded and used. Once again, during the
10429 expansion, the standard output/error from the command is in the variable
10430 &$value$&.
10431
10432 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10433 can be the word &"fail"& (not in braces) to force expansion failure if the
10434 command does not succeed. If both strings are omitted, the result is contents
10435 of the standard output/error on success, and nothing on failure.
10436
10437 .vindex "&$run_in_acl$&"
10438 The standard output/error of the command is put in the variable &$value$&.
10439 In this ACL example, the output of a command is logged for the admin to
10440 troubleshoot:
10441 .code
10442 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10443       log_message  = Output of id: $value
10444 .endd
10445 If the command requires shell idioms, such as the > redirect operator, the
10446 shell must be invoked directly, such as with:
10447 .code
10448 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10449 .endd
10450
10451 .vindex "&$runrc$&"
10452 The return code from the command is put in the variable &$runrc$&, and this
10453 remains set afterwards, so in a filter file you can do things like this:
10454 .code
10455 if "${run{x y z}{}}$runrc" is 1 then ...
10456   elif $runrc is 2 then ...
10457   ...
10458 endif
10459 .endd
10460 If execution of the command fails (for example, the command does not exist),
10461 the return code is 127 &-- the same code that shells use for non-existent
10462 commands.
10463
10464 &*Warning*&: In a router or transport, you cannot assume the order in which
10465 option values are expanded, except for those preconditions whose order of
10466 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10467 by the expansion of one option, and use it in another.
10468
10469 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10470 out the use of this expansion item in filter files.
10471
10472
10473 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10474 .cindex "expansion" "string substitution"
10475 .cindex "&%sg%& expansion item"
10476 This item works like Perl's substitution operator (s) with the global (/g)
10477 option; hence its name. However, unlike the Perl equivalent, Exim does not
10478 modify the subject string; instead it returns the modified string for insertion
10479 into the overall expansion. The item takes three arguments: the subject string,
10480 a regular expression, and a substitution string. For example:
10481 .code
10482 ${sg{abcdefabcdef}{abc}{xyz}}
10483 .endd
10484 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10485 if any $, } or \ characters are required in the regular expression or in the
10486 substitution string, they have to be escaped. For example:
10487 .code
10488 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10489 .endd
10490 yields &"defabc"&, and
10491 .code
10492 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10493 .endd
10494 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10495 the regular expression from string expansion.
10496
10497 The regular expression is compiled in 8-bit mode, working against bytes
10498 rather than any Unicode-aware character handling.
10499
10500
10501 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10502 .cindex sorting "a list"
10503 .cindex list sorting
10504 .cindex expansion "list sorting"
10505 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10506 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10507 The <&'comparator'&> argument is interpreted as the operator
10508 of a two-argument expansion condition.
10509 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10510 The comparison should return true when applied to two values
10511 if the first value should sort before the second value.
10512 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10513 the element being placed in &$item$&,
10514 to give values for comparison.
10515
10516 The item result is a sorted list,
10517 with the original list separator,
10518 of the list elements (in full) of the original.
10519
10520 Examples:
10521 .code
10522 ${sort{3:2:1:4}{<}{$item}}
10523 .endd
10524 sorts a list of numbers, and
10525 .code
10526 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10527 .endd
10528 will sort an MX lookup into priority order.
10529
10530
10531 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10532 .cindex "&%substr%& expansion item"
10533 .cindex "substring extraction"
10534 .cindex "expansion" "substring extraction"
10535 The three strings are expanded; the first two must yield numbers. Call them
10536 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10537 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10538 can use the simpler operator notation that avoids some of the braces:
10539 .code
10540 ${substr_<n>_<m>:<string>}
10541 .endd
10542 The second number is optional (in both notations).
10543 If it is absent in the simpler format, the preceding underscore must also be
10544 omitted.
10545
10546 The &%substr%& item can be used to extract more general substrings than
10547 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10548 length required. For example
10549 .code
10550 ${substr{3}{2}{$local_part}}
10551 .endd
10552 If the starting offset is greater than the string length the result is the
10553 null string; if the length plus starting offset is greater than the string
10554 length, the result is the right-hand part of the string, starting from the
10555 given offset. The first byte (character) in the string has offset zero.
10556
10557 The &%substr%& expansion item can take negative offset values to count
10558 from the right-hand end of its operand. The last byte (character) is offset -1,
10559 the second-last is offset -2, and so on. Thus, for example,
10560 .code
10561 ${substr{-5}{2}{1234567}}
10562 .endd
10563 yields &"34"&. If the absolute value of a negative offset is greater than the
10564 length of the string, the substring starts at the beginning of the string, and
10565 the length is reduced by the amount of overshoot. Thus, for example,
10566 .code
10567 ${substr{-5}{2}{12}}
10568 .endd
10569 yields an empty string, but
10570 .code
10571 ${substr{-3}{2}{12}}
10572 .endd
10573 yields &"1"&.
10574
10575 When the second number is omitted from &%substr%&, the remainder of the string
10576 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10577 string preceding the offset point are taken. For example, an offset of -1 and
10578 no length, as in these semantically identical examples:
10579 .code
10580 ${substr_-1:abcde}
10581 ${substr{-1}{abcde}}
10582 .endd
10583 yields all but the last character of the string, that is, &"abcd"&.
10584
10585 All measurement is done in bytes and is not UTF-8 aware.
10586
10587
10588
10589 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10590         {*&<&'replacements'&>&*}}*&"
10591 .cindex "expansion" "character translation"
10592 .cindex "&%tr%& expansion item"
10593 This item does single-character (in bytes) translation on its subject string. The second
10594 argument is a list of characters to be translated in the subject string. Each
10595 matching character is replaced by the corresponding character from the
10596 replacement list. For example
10597 .code
10598 ${tr{abcdea}{ac}{13}}
10599 .endd
10600 yields &`1b3de1`&. If there are duplicates in the second character string, the
10601 last occurrence is used. If the third string is shorter than the second, its
10602 last character is replicated. However, if it is empty, no translation takes
10603 place.
10604
10605 All character handling is done in bytes and is not UTF-8 aware.
10606
10607 .endlist
10608
10609
10610
10611 .section "Expansion operators" "SECTexpop"
10612 .cindex "expansion" "operators"
10613 For expansion items that perform transformations on a single argument string,
10614 the &"operator"& notation is used because it is simpler and uses fewer braces.
10615 The substring is first expanded before the operation is applied to it. The
10616 following operations can be performed:
10617
10618 .vlist
10619 .vitem &*${address:*&<&'string'&>&*}*&
10620 .cindex "expansion" "RFC 2822 address handling"
10621 .cindex "&%address%& expansion item"
10622 The string is interpreted as an RFC 2822 address, as it might appear in a
10623 header line, and the effective address is extracted from it. If the string does
10624 not parse successfully, the result is empty.
10625
10626 The parsing correctly handles SMTPUTF8 Unicode in the string.
10627
10628
10629 .vitem &*${addresses:*&<&'string'&>&*}*&
10630 .cindex "expansion" "RFC 2822 address handling"
10631 .cindex "&%addresses%& expansion item"
10632 The string (after expansion) is interpreted as a list of addresses in RFC
10633 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10634 operative address (&'local-part@domain'&) is extracted from each item, and the
10635 result of the expansion is a colon-separated list, with appropriate
10636 doubling of colons should any happen to be present in the email addresses.
10637 Syntactically invalid RFC2822 address items are omitted from the output.
10638
10639 It is possible to specify a character other than colon for the output
10640 separator by starting the string with > followed by the new separator
10641 character. For example:
10642 .code
10643 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10644 .endd
10645 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10646 first, so if the expanded string starts with >, it may change the output
10647 separator unintentionally. This can be avoided by setting the output
10648 separator explicitly:
10649 .code
10650 ${addresses:>:$h_from:}
10651 .endd
10652
10653 Compare the &%address%& (singular)
10654 expansion item, which extracts the working address from a single RFC2822
10655 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10656 processing lists.
10657
10658 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10659 a strict interpretation of header line formatting.  Exim parses the bare,
10660 unquoted portion of an email address and if it finds a comma, treats it as an
10661 email address separator. For the example header line:
10662 .code
10663 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10664 .endd
10665 The first example below demonstrates that Q-encoded email addresses are parsed
10666 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10667 It does not see the comma because it's still encoded as "=2C".  The second
10668 example below is passed the contents of &`$header_from:`&, meaning it gets
10669 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10670 The third example shows that the presence of a comma is skipped when it is
10671 quoted.  The fourth example shows SMTPUTF8 handling.
10672 .code
10673 # exim -be '${addresses:From: \
10674 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10675 user@example.com
10676 # exim -be '${addresses:From: Last, First <user@example.com>}'
10677 Last:user@example.com
10678 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10679 user@example.com
10680 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10681 フィリップ@example.jp
10682 .endd
10683
10684 .vitem &*${base32:*&<&'digits'&>&*}*&
10685 .cindex "&%base32%& expansion item"
10686 .cindex "expansion" "conversion to base 32"
10687 The string must consist entirely of decimal digits. The number is converted to
10688 base 32 and output as a (empty, for zero) string of characters.
10689 Only lowercase letters are used.
10690
10691 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10692 .cindex "&%base32d%& expansion item"
10693 .cindex "expansion" "conversion to base 32"
10694 The string must consist entirely of base-32 digits.
10695 The number is converted to decimal and output as a string.
10696
10697 .vitem &*${base62:*&<&'digits'&>&*}*&
10698 .cindex "&%base62%& expansion item"
10699 .cindex "expansion" "conversion to base 62"
10700 The string must consist entirely of decimal digits. The number is converted to
10701 base 62 and output as a string of six characters, including leading zeros. In
10702 the few operating environments where Exim uses base 36 instead of base 62 for
10703 its message identifiers (because those systems do not have case-sensitive
10704 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10705 to be absolutely clear: this is &'not'& base64 encoding.
10706
10707 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10708 .cindex "&%base62d%& expansion item"
10709 .cindex "expansion" "conversion to base 62"
10710 The string must consist entirely of base-62 digits, or, in operating
10711 environments where Exim uses base 36 instead of base 62 for its message
10712 identifiers, base-36 digits. The number is converted to decimal and output as a
10713 string.
10714
10715 .vitem &*${base64:*&<&'string'&>&*}*&
10716 .cindex "expansion" "base64 encoding"
10717 .cindex "base64 encoding" "in string expansion"
10718 .cindex "&%base64%& expansion item"
10719 .cindex certificate "base64 of DER"
10720 This operator converts a string into one that is base64 encoded.
10721
10722 If the string is a single variable of type certificate,
10723 returns the base64 encoding of the DER form of the certificate.
10724
10725
10726 .vitem &*${base64d:*&<&'string'&>&*}*&
10727 .cindex "expansion" "base64 decoding"
10728 .cindex "base64 decoding" "in string expansion"
10729 .cindex "&%base64d%& expansion item"
10730 This operator converts a base64-encoded string into the un-coded form.
10731
10732
10733 .vitem &*${domain:*&<&'string'&>&*}*&
10734 .cindex "domain" "extraction"
10735 .cindex "expansion" "domain extraction"
10736 The string is interpreted as an RFC 2822 address and the domain is extracted
10737 from it. If the string does not parse successfully, the result is empty.
10738
10739
10740 .vitem &*${escape:*&<&'string'&>&*}*&
10741 .cindex "expansion" "escaping non-printing characters"
10742 .cindex "&%escape%& expansion item"
10743 If the string contains any non-printing characters, they are converted to
10744 escape sequences starting with a backslash. Whether characters with the most
10745 significant bit set (so-called &"8-bit characters"&) count as printing or not
10746 is controlled by the &%print_topbitchars%& option.
10747
10748 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10749 .cindex "expansion" "escaping 8-bit characters"
10750 .cindex "&%escape8bit%& expansion item"
10751 If the string contains and characters with the most significant bit set,
10752 they are converted to escape sequences starting with a backslash.
10753 Backslashes and DEL characters are also converted.
10754
10755
10756 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10757 .cindex "expansion" "expression evaluation"
10758 .cindex "expansion" "arithmetic expression"
10759 .cindex "&%eval%& expansion item"
10760 These items supports simple arithmetic and bitwise logical operations in
10761 expansion strings. The string (after expansion) must be a conventional
10762 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10763 logical operators, and parentheses. All operations are carried out using
10764 integer arithmetic. The operator priorities are as follows (the same as in the
10765 C programming language):
10766 .table2 70pt 300pt
10767 .irow &'highest:'& "not (~), negate (-)"
10768 .irow ""   "multiply (*), divide (/), remainder (%)"
10769 .irow ""   "plus (+), minus (-)"
10770 .irow ""   "shift-left (<<), shift-right (>>)"
10771 .irow ""   "and (&&)"
10772 .irow ""   "xor (^)"
10773 .irow &'lowest:'&  "or (|)"
10774 .endtable
10775 Binary operators with the same priority are evaluated from left to right. White
10776 space is permitted before or after operators.
10777
10778 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10779 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10780 decimal, even if they start with a leading zero; hexadecimal numbers are not
10781 permitted. This can be useful when processing numbers extracted from dates or
10782 times, which often do have leading zeros.
10783
10784 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10785 or 1024*1024*1024,
10786 respectively. Negative numbers are supported. The result of the computation is
10787 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10788
10789 .display
10790 &`${eval:1+1}            `&  yields 2
10791 &`${eval:1+2*3}          `&  yields 7
10792 &`${eval:(1+2)*3}        `&  yields 9
10793 &`${eval:2+42%5}         `&  yields 4
10794 &`${eval:0xc&amp;5}          `&  yields 4
10795 &`${eval:0xc|5}          `&  yields 13
10796 &`${eval:0xc^5}          `&  yields 9
10797 &`${eval:0xc>>1}         `&  yields 6
10798 &`${eval:0xc<<1}         `&  yields 24
10799 &`${eval:~255&amp;0x1234}    `&  yields 4608
10800 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10801 .endd
10802
10803 As a more realistic example, in an ACL you might have
10804 .code
10805 deny   message = Too many bad recipients
10806        condition =                    \
10807          ${if and {                   \
10808            {>{$rcpt_count}{10}}       \
10809            {                          \
10810            <                          \
10811              {$recipients_count}      \
10812              {${eval:$rcpt_count/2}}  \
10813            }                          \
10814          }{yes}{no}}
10815 .endd
10816 The condition is true if there have been more than 10 RCPT commands and
10817 fewer than half of them have resulted in a valid recipient.
10818
10819
10820 .vitem &*${expand:*&<&'string'&>&*}*&
10821 .cindex "expansion" "re-expansion of substring"
10822 The &%expand%& operator causes a string to be expanded for a second time. For
10823 example,
10824 .code
10825 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10826 .endd
10827 first looks up a string in a file while expanding the operand for &%expand%&,
10828 and then re-expands what it has found.
10829
10830
10831 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10832 .cindex "Unicode"
10833 .cindex "UTF-8" "conversion from"
10834 .cindex "expansion" "UTF-8 conversion"
10835 .cindex "&%from_utf8%& expansion item"
10836 The world is slowly moving towards Unicode, although there are no standards for
10837 email yet. However, other applications (including some databases) are starting
10838 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10839 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10840 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10841 the result is an undefined sequence of bytes.
10842
10843 Unicode code points with values less than 256 are compatible with ASCII and
10844 ISO-8859-1 (also known as Latin-1).
10845 For example, character 169 is the copyright symbol in both cases, though the
10846 way it is encoded is different. In UTF-8, more than one byte is needed for
10847 characters with code values greater than 127, whereas ISO-8859-1 is a
10848 single-byte encoding (but thereby limited to 256 characters). This makes
10849 translation from UTF-8 to ISO-8859-1 straightforward.
10850
10851
10852 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10853 .cindex "hash function" "textual"
10854 .cindex "expansion" "textual hash"
10855 The &%hash%& operator is a simpler interface to the hashing function that can
10856 be used when the two parameters are fixed numbers (as opposed to strings that
10857 change when expanded). The effect is the same as
10858 .code
10859 ${hash{<n>}{<m>}{<string>}}
10860 .endd
10861 See the description of the general &%hash%& item above for details. The
10862 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10863
10864
10865
10866 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10867 .cindex "base64 encoding" "conversion from hex"
10868 .cindex "expansion" "hex to base64"
10869 .cindex "&%hex2b64%& expansion item"
10870 This operator converts a hex string into one that is base64 encoded. This can
10871 be useful for processing the output of the various hashing functions.
10872
10873
10874
10875 .vitem &*${hexquote:*&<&'string'&>&*}*&
10876 .cindex "quoting" "hex-encoded unprintable characters"
10877 .cindex "&%hexquote%& expansion item"
10878 This operator converts non-printable characters in a string into a hex
10879 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10880 as is, and other byte values are converted to &`\xNN`&, for example, a
10881 byte value 127 is converted to &`\x7f`&.
10882
10883
10884 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10885 .cindex "&%ipv6denorm%& expansion item"
10886 .cindex "IP address" normalisation
10887 This expands an IPv6 address to a full eight-element colon-separated set
10888 of hex digits including leading zeroes.
10889 A trailing ipv4-style dotted-decimal set is converted to hex.
10890 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10891
10892 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10893 .cindex "&%ipv6norm%& expansion item"
10894 .cindex "IP address" normalisation
10895 .cindex "IP address" "canonical form"
10896 This converts an IPv6 address to canonical form.
10897 Leading zeroes of groups are omitted, and the longest
10898 set of zero-valued groups is replaced with a double colon.
10899 A trailing ipv4-style dotted-decimal set is converted to hex.
10900 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10901
10902
10903 .vitem &*${lc:*&<&'string'&>&*}*&
10904 .cindex "case forcing in strings"
10905 .cindex "string" "case forcing"
10906 .cindex "lower casing"
10907 .cindex "expansion" "case forcing"
10908 .cindex "&%lc%& expansion item"
10909 This forces the letters in the string into lower-case, for example:
10910 .code
10911 ${lc:$local_part}
10912 .endd
10913 Case is defined per the system C locale.
10914
10915 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10916 .cindex "expansion" "string truncation"
10917 .cindex "&%length%& expansion item"
10918 The &%length%& operator is a simpler interface to the &%length%& function that
10919 can be used when the parameter is a fixed number (as opposed to a string that
10920 changes when expanded). The effect is the same as
10921 .code
10922 ${length{<number>}{<string>}}
10923 .endd
10924 See the description of the general &%length%& item above for details. Note that
10925 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10926 when &%length%& is used as an operator.
10927 All measurement is done in bytes and is not UTF-8 aware.
10928
10929
10930 .vitem &*${listcount:*&<&'string'&>&*}*&
10931 .cindex "expansion" "list item count"
10932 .cindex "list" "item count"
10933 .cindex "list" "count of items"
10934 .cindex "&%listcount%& expansion item"
10935 The string is interpreted as a list and the number of items is returned.
10936
10937
10938 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10939 .cindex "expansion" "named list"
10940 .cindex "&%listnamed%& expansion item"
10941 The name is interpreted as a named list and the content of the list is returned,
10942 expanding any referenced lists, re-quoting as needed for colon-separation.
10943 If the optional type is given it must be one of "a", "d", "h" or "l"
10944 and selects address-, domain-, host- or localpart- lists to search among respectively.
10945 Otherwise all types are searched in an undefined order and the first
10946 matching list is returned.
10947
10948
10949 .vitem &*${local_part:*&<&'string'&>&*}*&
10950 .cindex "expansion" "local part extraction"
10951 .cindex "&%local_part%& expansion item"
10952 The string is interpreted as an RFC 2822 address and the local part is
10953 extracted from it. If the string does not parse successfully, the result is
10954 empty.
10955 The parsing correctly handles SMTPUTF8 Unicode in the string.
10956
10957
10958 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10959 .cindex "masked IP address"
10960 .cindex "IP address" "masking"
10961 .cindex "CIDR notation"
10962 .cindex "expansion" "IP address masking"
10963 .cindex "&%mask%& expansion item"
10964 If the form of the string to be operated on is not an IP address followed by a
10965 slash and an integer (that is, a network address in CIDR notation), the
10966 expansion fails. Otherwise, this operator converts the IP address to binary,
10967 masks off the least significant bits according to the bit count, and converts
10968 the result back to text, with mask appended. For example,
10969 .code
10970 ${mask:10.111.131.206/28}
10971 .endd
10972 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10973 be mostly used for looking up masked addresses in files, the result for an IPv6
10974 address uses dots to separate components instead of colons, because colon
10975 terminates a key string in lsearch files. So, for example,
10976 .code
10977 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10978 .endd
10979 returns the string
10980 .code
10981 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10982 .endd
10983 Letters in IPv6 addresses are always output in lower case.
10984
10985
10986 .vitem &*${md5:*&<&'string'&>&*}*&
10987 .cindex "MD5 hash"
10988 .cindex "expansion" "MD5 hash"
10989 .cindex certificate fingerprint
10990 .cindex "&%md5%& expansion item"
10991 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10992 as a 32-digit hexadecimal number, in which any letters are in lower case.
10993
10994 If the string is a single variable of type certificate,
10995 returns the MD5 hash fingerprint of the certificate.
10996
10997
10998 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10999 .cindex "expansion" "numeric hash"
11000 .cindex "hash function" "numeric"
11001 The &%nhash%& operator is a simpler interface to the numeric hashing function
11002 that can be used when the two parameters are fixed numbers (as opposed to
11003 strings that change when expanded). The effect is the same as
11004 .code
11005 ${nhash{<n>}{<m>}{<string>}}
11006 .endd
11007 See the description of the general &%nhash%& item above for details.
11008
11009
11010 .vitem &*${quote:*&<&'string'&>&*}*&
11011 .cindex "quoting" "in string expansions"
11012 .cindex "expansion" "quoting"
11013 .cindex "&%quote%& expansion item"
11014 The &%quote%& operator puts its argument into double quotes if it
11015 is an empty string or
11016 contains anything other than letters, digits, underscores, dots, and hyphens.
11017 Any occurrences of double quotes and backslashes are escaped with a backslash.
11018 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11019 respectively For example,
11020 .code
11021 ${quote:ab"*"cd}
11022 .endd
11023 becomes
11024 .code
11025 "ab\"*\"cd"
11026 .endd
11027 The place where this is useful is when the argument is a substitution from a
11028 variable or a message header.
11029
11030 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11031 .cindex "&%quote_local_part%& expansion item"
11032 This operator is like &%quote%&, except that it quotes the string only if
11033 required to do so by the rules of RFC 2822 for quoting local parts. For
11034 example, a plus sign would not cause quoting (but it would for &%quote%&).
11035 If you are creating a new email address from the contents of &$local_part$&
11036 (or any other unknown data), you should always use this operator.
11037
11038 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11039 will likely use the quoting form.
11040 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11041
11042
11043 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11044 .cindex "quoting" "lookup-specific"
11045 This operator applies lookup-specific quoting rules to the string. Each
11046 query-style lookup type has its own quoting rules which are described with
11047 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11048 .code
11049 ${quote_ldap:two * two}
11050 .endd
11051 returns
11052 .code
11053 two%20%5C2A%20two
11054 .endd
11055 For single-key lookup types, no quoting is ever necessary and this operator
11056 yields an unchanged string.
11057
11058
11059 .vitem &*${randint:*&<&'n'&>&*}*&
11060 .cindex "random number"
11061 This operator returns a somewhat random number which is less than the
11062 supplied number and is at least 0.  The quality of this randomness depends
11063 on how Exim was built; the values are not suitable for keying material.
11064 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11065 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11066 for versions of GnuTLS with that function.
11067 Otherwise, the implementation may be arc4random(), random() seeded by
11068 srandomdev() or srandom(), or a custom implementation even weaker than
11069 random().
11070
11071
11072 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11073 .cindex "expansion" "IP address"
11074 This operator reverses an IP address; for IPv4 addresses, the result is in
11075 dotted-quad decimal form, while for IPv6 addresses the result is in
11076 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11077 for DNS.  For example,
11078 .code
11079 ${reverse_ip:192.0.2.4}
11080 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11081 .endd
11082 returns
11083 .code
11084 4.2.0.192
11085 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
11086 .endd
11087
11088
11089 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11090 .cindex "expansion" "RFC 2047"
11091 .cindex "RFC 2047" "expansion operator"
11092 .cindex "&%rfc2047%& expansion item"
11093 This operator encodes text according to the rules of RFC 2047. This is an
11094 encoding that is used in header lines to encode non-ASCII characters. It is
11095 assumed that the input string is in the encoding specified by the
11096 &%headers_charset%& option, which gets its default at build time. If the string
11097 contains only characters in the range 33&--126, and no instances of the
11098 characters
11099 .code
11100 ? = ( ) < > @ , ; : \ " . [ ] _
11101 .endd
11102 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11103 string, using as many &"encoded words"& as necessary to encode all the
11104 characters.
11105
11106
11107 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11108 .cindex "expansion" "RFC 2047"
11109 .cindex "RFC 2047" "decoding"
11110 .cindex "&%rfc2047d%& expansion item"
11111 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11112 bytes are replaced by question marks. Characters are converted into the
11113 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11114 not recognized unless &%check_rfc2047_length%& is set false.
11115
11116 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11117 access a header line, RFC 2047 decoding is done automatically. You do not need
11118 to use this operator as well.
11119
11120
11121
11122 .vitem &*${rxquote:*&<&'string'&>&*}*&
11123 .cindex "quoting" "in regular expressions"
11124 .cindex "regular expressions" "quoting"
11125 .cindex "&%rxquote%& expansion item"
11126 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11127 characters in its argument. This is useful when substituting the values of
11128 variables or headers inside regular expressions.
11129
11130
11131 .vitem &*${sha1:*&<&'string'&>&*}*&
11132 .cindex "SHA-1 hash"
11133 .cindex "expansion" "SHA-1 hashing"
11134 .cindex certificate fingerprint
11135 .cindex "&%sha1%& expansion item"
11136 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11137 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11138
11139 If the string is a single variable of type certificate,
11140 returns the SHA-1 hash fingerprint of the certificate.
11141
11142
11143 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11144        &*${sha2:*&<&'string'&>&*}*& &&&
11145        &*${sha2_<n>:*&<&'string'&>&*}*&
11146 .cindex "SHA-256 hash"
11147 .cindex "SHA-2 hash"
11148 .cindex certificate fingerprint
11149 .cindex "expansion" "SHA-256 hashing"
11150 .cindex "&%sha256%& expansion item"
11151 .cindex "&%sha2%& expansion item"
11152 The &%sha256%& operator computes the SHA-256 hash value of the string
11153 and returns
11154 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11155
11156 If the string is a single variable of type certificate,
11157 returns the SHA-256 hash fingerprint of the certificate.
11158
11159 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11160 (except for certificates, which are not supported).
11161 Finally, if an underbar
11162 and a number is appended it specifies the output length, selecting a
11163 member of the SHA-2 family of hash functions.
11164 Values of 256, 384 and 512 are accepted, with 256 being the default.
11165
11166
11167 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11168        &*${sha3_<n>:*&<&'string'&>&*}*&
11169 .cindex "SHA3 hash"
11170 .cindex "expansion" "SHA3 hashing"
11171 .cindex "&%sha3%& expansion item"
11172 The &%sha3%& operator computes the SHA3-256 hash value of the string
11173 and returns
11174 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11175
11176 If a number is appended, separated by an underbar, it specifies
11177 the output length.  Values of 224, 256, 384 and 512 are accepted;
11178 with 256 being the default.
11179
11180 The &%sha3%& expansion item is only supported if Exim has been
11181 compiled with GnuTLS 3.5.0 or later,
11182 or OpenSSL 1.1.1 or later.
11183 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11184
11185
11186 .vitem &*${stat:*&<&'string'&>&*}*&
11187 .cindex "expansion" "statting a file"
11188 .cindex "file" "extracting characteristics"
11189 .cindex "&%stat%& expansion item"
11190 The string, after expansion, must be a file path. A call to the &[stat()]&
11191 function is made for this path. If &[stat()]& fails, an error occurs and the
11192 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11193 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11194 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11195 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11196 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11197 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11198 can extract individual fields using the &%extract%& expansion item.
11199
11200 The use of the &%stat%& expansion in users' filter files can be locked out by
11201 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11202 systems for files larger than 2GB.
11203
11204 .vitem &*${str2b64:*&<&'string'&>&*}*&
11205 .cindex "&%str2b64%& expansion item"
11206 Now deprecated, a synonym for the &%base64%& expansion operator.
11207
11208
11209
11210 .vitem &*${strlen:*&<&'string'&>&*}*&
11211 .cindex "expansion" "string length"
11212 .cindex "string" "length in expansion"
11213 .cindex "&%strlen%& expansion item"
11214 The item is replace by the length of the expanded string, expressed as a
11215 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11216 All measurement is done in bytes and is not UTF-8 aware.
11217
11218
11219 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11220 .cindex "&%substr%& expansion item"
11221 .cindex "substring extraction"
11222 .cindex "expansion" "substring expansion"
11223 The &%substr%& operator is a simpler interface to the &%substr%& function that
11224 can be used when the two parameters are fixed numbers (as opposed to strings
11225 that change when expanded). The effect is the same as
11226 .code
11227 ${substr{<start>}{<length>}{<string>}}
11228 .endd
11229 See the description of the general &%substr%& item above for details. The
11230 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11231 All measurement is done in bytes and is not UTF-8 aware.
11232
11233 .vitem &*${time_eval:*&<&'string'&>&*}*&
11234 .cindex "&%time_eval%& expansion item"
11235 .cindex "time interval" "decoding"
11236 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11237 seconds.
11238
11239 .vitem &*${time_interval:*&<&'string'&>&*}*&
11240 .cindex "&%time_interval%& expansion item"
11241 .cindex "time interval" "formatting"
11242 The argument (after sub-expansion) must be a sequence of decimal digits that
11243 represents an interval of time as a number of seconds. It is converted into a
11244 number of larger units and output in Exim's normal time format, for example,
11245 &`1w3d4h2m6s`&.
11246
11247 .vitem &*${uc:*&<&'string'&>&*}*&
11248 .cindex "case forcing in strings"
11249 .cindex "string" "case forcing"
11250 .cindex "upper casing"
11251 .cindex "expansion" "case forcing"
11252 .cindex "&%uc%& expansion item"
11253 This forces the letters in the string into upper-case.
11254 Case is defined per the system C locale.
11255
11256 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11257 .cindex "correction of invalid utf-8 sequences in strings"
11258 .cindex "utf-8" "utf-8 sequences"
11259 .cindex "incorrect utf-8"
11260 .cindex "expansion" "utf-8 forcing"
11261 .cindex "&%utf8clean%& expansion item"
11262 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11263 In versions of Exim before 4.92, this did not correctly do so for a truncated
11264 final codepoint's encoding, and the character would be silently dropped.
11265 If you must handle detection of this scenario across both sets of Exim behavior,
11266 the complexity will depend upon the task.
11267 For instance, to detect if the first character is multibyte and a 1-byte
11268 extraction can be successfully used as a path component (as is common for
11269 dividing up delivery folders), you might use:
11270 .code
11271 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11272 .endd
11273 (which will false-positive if the first character of the local part is a
11274 literal question mark).
11275
11276 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11277        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11278        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11279        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11280 .cindex expansion UTF-8
11281 .cindex UTF-8 expansion
11282 .cindex EAI
11283 .cindex internationalisation
11284 .cindex "&%utf8_domain_to_alabel%& expansion item"
11285 .cindex "&%utf8_domain_from_alabel%& expansion item"
11286 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11287 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11288 These convert EAI mail name components between UTF-8 and a-label forms.
11289 For information on internationalisation support see &<<SECTi18nMTA>>&.
11290 .endlist
11291
11292
11293
11294
11295
11296
11297 .section "Expansion conditions" "SECTexpcond"
11298 .scindex IIDexpcond "expansion" "conditions"
11299 The following conditions are available for testing by the &%${if%& construct
11300 while expanding strings:
11301
11302 .vlist
11303 .vitem &*!*&<&'condition'&>
11304 .cindex "expansion" "negating a condition"
11305 .cindex "negation" "in expansion condition"
11306 Preceding any condition with an exclamation mark negates the result of the
11307 condition.
11308
11309 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11310 .cindex "numeric comparison"
11311 .cindex "expansion" "numeric comparison"
11312 There are a number of symbolic operators for doing numeric comparisons. They
11313 are:
11314 .display
11315 &`=   `&   equal
11316 &`==  `&   equal
11317 &`>   `&   greater
11318 &`>=  `&   greater or equal
11319 &`<   `&   less
11320 &`<=  `&   less or equal
11321 .endd
11322 For example:
11323 .code
11324 ${if >{$message_size}{10M} ...
11325 .endd
11326 Note that the general negation operator provides for inequality testing. The
11327 two strings must take the form of optionally signed decimal integers,
11328 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11329 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11330 As a special case, the numerical value of an empty string is taken as
11331 zero.
11332
11333 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11334 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11335 10M, not if 10M is larger than &$message_size$&.
11336
11337
11338 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11339         {*&<&'arg2'&>&*}...}*&
11340 .cindex "expansion" "calling an acl"
11341 .cindex "&%acl%&" "expansion condition"
11342 The name and zero to nine argument strings are first expanded separately.  The expanded
11343 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11344 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11345 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11346 and may use the variables; if another acl expansion is used the values
11347 are restored after it returns.  If the ACL sets
11348 a value using a "message =" modifier the variable $value becomes
11349 the result of the expansion, otherwise it is empty.
11350 If the ACL returns accept the condition is true; if deny, false.
11351 If the ACL returns defer the result is a forced-fail.
11352
11353 .vitem &*bool&~{*&<&'string'&>&*}*&
11354 .cindex "expansion" "boolean parsing"
11355 .cindex "&%bool%& expansion condition"
11356 This condition turns a string holding a true or false representation into
11357 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11358 (case-insensitively); also integer numbers map to true if non-zero,
11359 false if zero.
11360 An empty string is treated as false.
11361 Leading and trailing whitespace is ignored;
11362 thus a string consisting only of whitespace is false.
11363 All other string values will result in expansion failure.
11364
11365 When combined with ACL variables, this expansion condition will let you
11366 make decisions in one place and act on those decisions in another place.
11367 For example:
11368 .code
11369 ${if bool{$acl_m_privileged_sender} ...
11370 .endd
11371
11372
11373 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11374 .cindex "expansion" "boolean parsing"
11375 .cindex "&%bool_lax%& expansion condition"
11376 Like &%bool%&, this condition turns a string into a boolean state.  But
11377 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11378 loose definition that the Router &%condition%& option uses.  The empty string
11379 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11380 true.  Leading and trailing whitespace is ignored.
11381
11382 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11383
11384 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11385 .cindex "expansion" "encrypted comparison"
11386 .cindex "encrypted strings, comparing"
11387 .cindex "&%crypteq%& expansion condition"
11388 This condition is included in the Exim binary if it is built to support any
11389 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11390 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11391 included in the binary.
11392
11393 The &%crypteq%& condition has two arguments. The first is encrypted and
11394 compared against the second, which is already encrypted. The second string may
11395 be in the LDAP form for storing encrypted strings, which starts with the
11396 encryption type in curly brackets, followed by the data. If the second string
11397 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11398 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11399 Typically this will be a field from a password file. An example of an encrypted
11400 string in LDAP form is:
11401 .code
11402 {md5}CY9rzUYh03PK3k6DJie09g==
11403 .endd
11404 If such a string appears directly in an expansion, the curly brackets have to
11405 be quoted, because they are part of the expansion syntax. For example:
11406 .code
11407 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11408 .endd
11409 The following encryption types (whose names are matched case-independently) are
11410 supported:
11411
11412 .ilist
11413 .cindex "MD5 hash"
11414 .cindex "base64 encoding" "in encrypted password"
11415 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11416 printable characters to compare with the remainder of the second string. If the
11417 length of the comparison string is 24, Exim assumes that it is base64 encoded
11418 (as in the above example). If the length is 32, Exim assumes that it is a
11419 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11420 comparison fails.
11421
11422 .next
11423 .cindex "SHA-1 hash"
11424 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11425 printable characters to compare with the remainder of the second string. If the
11426 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11427 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11428 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11429
11430 .next
11431 .cindex "&[crypt()]&"
11432 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11433 only the first eight characters of the password. However, in modern operating
11434 systems this is no longer true, and in many cases the entire password is used,
11435 whatever its length.
11436
11437 .next
11438 .cindex "&[crypt16()]&"
11439 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11440 use up to 16 characters of the password in some operating systems. Again, in
11441 modern operating systems, more characters may be used.
11442 .endlist
11443 Exim has its own version of &[crypt16()]&, which is just a double call to
11444 &[crypt()]&. For operating systems that have their own version, setting
11445 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11446 operating system version instead of its own. This option is set by default in
11447 the OS-dependent &_Makefile_& for those operating systems that are known to
11448 support &[crypt16()]&.
11449
11450 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11451 it was not using the same algorithm as some operating systems' versions. It
11452 turns out that as well as &[crypt16()]& there is a function called
11453 &[bigcrypt()]& in some operating systems. This may or may not use the same
11454 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11455
11456 However, since there is now a move away from the traditional &[crypt()]&
11457 functions towards using SHA1 and other algorithms, tidying up this area of
11458 Exim is seen as very low priority.
11459
11460 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11461 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11462 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11463 default is &`{crypt}`&. Whatever the default, you can always use either
11464 function by specifying it explicitly in curly brackets.
11465
11466 .vitem &*def:*&<&'variable&~name'&>
11467 .cindex "expansion" "checking for empty variable"
11468 .cindex "&%def%& expansion condition"
11469 The &%def%& condition must be followed by the name of one of the expansion
11470 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11471 variable does not contain the empty string. For example:
11472 .code
11473 ${if def:sender_ident {from $sender_ident}}
11474 .endd
11475 Note that the variable name is given without a leading &%$%& character. If the
11476 variable does not exist, the expansion fails.
11477
11478 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11479         &~&*def:h_*&<&'header&~name'&>&*:*&"
11480 .cindex "expansion" "checking header line existence"
11481 This condition is true if a message is being processed and the named header
11482 exists in the message. For example,
11483 .code
11484 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11485 .endd
11486 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11487 the header name must be terminated by a colon if white space does not follow.
11488
11489 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11490        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11491 .cindex "string" "comparison"
11492 .cindex "expansion" "string comparison"
11493 .cindex "&%eq%& expansion condition"
11494 .cindex "&%eqi%& expansion condition"
11495 The two substrings are first expanded. The condition is true if the two
11496 resulting strings are identical. For &%eq%& the comparison includes the case of
11497 letters, whereas for &%eqi%& the comparison is case-independent, where
11498 case is defined per the system C locale.
11499
11500 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11501 .cindex "expansion" "file existence test"
11502 .cindex "file" "existence test"
11503 .cindex "&%exists%&, expansion condition"
11504 The substring is first expanded and then interpreted as an absolute path. The
11505 condition is true if the named file (or directory) exists. The existence test
11506 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11507 users' filter files may be locked out by the system administrator.
11508
11509 .vitem &*first_delivery*&
11510 .cindex "delivery" "first"
11511 .cindex "first delivery"
11512 .cindex "expansion" "first delivery test"
11513 .cindex "&%first_delivery%& expansion condition"
11514 This condition, which has no data, is true during a message's first delivery
11515 attempt. It is false during any subsequent delivery attempts.
11516
11517
11518 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11519        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11520 .cindex "list" "iterative conditions"
11521 .cindex "expansion" "&*forall*& condition"
11522 .cindex "expansion" "&*forany*& condition"
11523 .vindex "&$item$&"
11524 These conditions iterate over a list. The first argument is expanded to form
11525 the list. By default, the list separator is a colon, but it can be changed by
11526 the normal method (&<<SECTlistsepchange>>&).
11527 The second argument is interpreted as a condition that is to
11528 be applied to each item in the list in turn. During the interpretation of the
11529 condition, the current list item is placed in a variable called &$item$&.
11530 .ilist
11531 For &*forany*&, interpretation stops if the condition is true for any item, and
11532 the result of the whole condition is true. If the condition is false for all
11533 items in the list, the overall condition is false.
11534 .next
11535 For &*forall*&, interpretation stops if the condition is false for any item,
11536 and the result of the whole condition is false. If the condition is true for
11537 all items in the list, the overall condition is true.
11538 .endlist
11539 Note that negation of &*forany*& means that the condition must be false for all
11540 items for the overall condition to succeed, and negation of &*forall*& means
11541 that the condition must be false for at least one item. In this example, the
11542 list separator is changed to a comma:
11543 .code
11544 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11545 .endd
11546 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11547 being processed, to enable these expansion items to be nested.
11548
11549 To scan a named list, expand it with the &*listnamed*& operator.
11550
11551 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11552        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11553        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11554        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11555 .cindex JSON "iterative conditions"
11556 .cindex JSON expansions
11557 .cindex expansion "&*forall_json*& condition"
11558 .cindex expansion "&*forany_json*& condition"
11559 .cindex expansion "&*forall_jsons*& condition"
11560 .cindex expansion "&*forany_jsons*& condition"
11561 As for the above, except that the first argument must, after expansion,
11562 be a JSON array.
11563 The array separator is not changeable.
11564 For the &"jsons"& variants the elements are expected to be JSON strings
11565 and have their quotes removed before the evaluation of the condition.
11566
11567
11568
11569 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11570        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11571 .cindex "string" "comparison"
11572 .cindex "expansion" "string comparison"
11573 .cindex "&%ge%& expansion condition"
11574 .cindex "&%gei%& expansion condition"
11575 The two substrings are first expanded. The condition is true if the first
11576 string is lexically greater than or equal to the second string. For &%ge%& the
11577 comparison includes the case of letters, whereas for &%gei%& the comparison is
11578 case-independent.
11579 Case and collation order are defined per the system C locale.
11580
11581 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11582        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11583 .cindex "string" "comparison"
11584 .cindex "expansion" "string comparison"
11585 .cindex "&%gt%& expansion condition"
11586 .cindex "&%gti%& expansion condition"
11587 The two substrings are first expanded. The condition is true if the first
11588 string is lexically greater than the second string. For &%gt%& the comparison
11589 includes the case of letters, whereas for &%gti%& the comparison is
11590 case-independent.
11591 Case and collation order are defined per the system C locale.
11592
11593 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11594        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11595 .cindex "string" "comparison"
11596 .cindex "list" "iterative conditions"
11597 Both strings are expanded; the second string is treated as a list of simple
11598 strings; if the first string is a member of the second, then the condition
11599 is true.
11600 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11601
11602 These are simpler to use versions of the more powerful &*forany*& condition.
11603 Examples, and the &*forany*& equivalents:
11604 .code
11605 ${if inlist{needle}{foo:needle:bar}}
11606   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11607 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11608   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11609 .endd
11610
11611 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11612        &*isip4&~{*&<&'string'&>&*}*& &&&
11613        &*isip6&~{*&<&'string'&>&*}*&
11614 .cindex "IP address" "testing string format"
11615 .cindex "string" "testing for IP address"
11616 .cindex "&%isip%& expansion condition"
11617 .cindex "&%isip4%& expansion condition"
11618 .cindex "&%isip6%& expansion condition"
11619 The substring is first expanded, and then tested to see if it has the form of
11620 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11621 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11622
11623 For an IPv4 address, the test is for four dot-separated components, each of
11624 which consists of from one to three digits. For an IPv6 address, up to eight
11625 colon-separated components are permitted, each containing from one to four
11626 hexadecimal digits. There may be fewer than eight components if an empty
11627 component (adjacent colons) is present. Only one empty component is permitted.
11628
11629 &*Note*&: The checks used to be just on the form of the address; actual numerical
11630 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11631 check.
11632 This is no longer the case.
11633
11634 The main use of these tests is to distinguish between IP addresses and
11635 host names, or between IPv4 and IPv6 addresses. For example, you could use
11636 .code
11637 ${if isip4{$sender_host_address}...
11638 .endd
11639 to test which IP version an incoming SMTP connection is using.
11640
11641 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11642 .cindex "LDAP" "use for authentication"
11643 .cindex "expansion" "LDAP authentication test"
11644 .cindex "&%ldapauth%& expansion condition"
11645 This condition supports user authentication using LDAP. See section
11646 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11647 queries. For this use, the query must contain a user name and password. The
11648 query itself is not used, and can be empty. The condition is true if the
11649 password is not empty, and the user name and password are accepted by the LDAP
11650 server. An empty password is rejected without calling LDAP because LDAP binds
11651 with an empty password are considered anonymous regardless of the username, and
11652 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11653 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11654 this can be used.
11655
11656
11657 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11658        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11659 .cindex "string" "comparison"
11660 .cindex "expansion" "string comparison"
11661 .cindex "&%le%& expansion condition"
11662 .cindex "&%lei%& expansion condition"
11663 The two substrings are first expanded. The condition is true if the first
11664 string is lexically less than or equal to the second string. For &%le%& the
11665 comparison includes the case of letters, whereas for &%lei%& the comparison is
11666 case-independent.
11667 Case and collation order are defined per the system C locale.
11668
11669 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11670        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11671 .cindex "string" "comparison"
11672 .cindex "expansion" "string comparison"
11673 .cindex "&%lt%& expansion condition"
11674 .cindex "&%lti%& expansion condition"
11675 The two substrings are first expanded. The condition is true if the first
11676 string is lexically less than the second string. For &%lt%& the comparison
11677 includes the case of letters, whereas for &%lti%& the comparison is
11678 case-independent.
11679 Case and collation order are defined per the system C locale.
11680
11681
11682 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11683 .cindex "expansion" "regular expression comparison"
11684 .cindex "regular expressions" "match in expanded string"
11685 .cindex "&%match%& expansion condition"
11686 The two substrings are first expanded. The second is then treated as a regular
11687 expression and applied to the first. Because of the pre-expansion, if the
11688 regular expression contains dollar, or backslash characters, they must be
11689 escaped. Care must also be taken if the regular expression contains braces
11690 (curly brackets). A closing brace must be escaped so that it is not taken as a
11691 premature termination of <&'string2'&>. The easiest approach is to use the
11692 &`\N`& feature to disable expansion of the regular expression.
11693 For example,
11694 .code
11695 ${if match {$local_part}{\N^\d{3}\N} ...
11696 .endd
11697 If the whole expansion string is in double quotes, further escaping of
11698 backslashes is also required.
11699
11700 The condition is true if the regular expression match succeeds.
11701 The regular expression is not required to begin with a circumflex
11702 metacharacter, but if there is no circumflex, the expression is not anchored,
11703 and it may match anywhere in the subject, not just at the start. If you want
11704 the pattern to match at the end of the subject, you must include the &`$`&
11705 metacharacter at an appropriate point.
11706 All character handling is done in bytes and is not UTF-8 aware,
11707 but we might change this in a future Exim release.
11708
11709 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11710 At the start of an &%if%& expansion the values of the numeric variable
11711 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11712 succeeds causes them to be reset to the substrings of that condition and they
11713 will have these values during the expansion of the success string. At the end
11714 of the &%if%& expansion, the previous values are restored. After testing a
11715 combination of conditions using &%or%&, the subsequent values of the numeric
11716 variables are those of the condition that succeeded.
11717
11718 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11719 .cindex "&%match_address%& expansion condition"
11720 See &*match_local_part*&.
11721
11722 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11723 .cindex "&%match_domain%& expansion condition"
11724 See &*match_local_part*&.
11725
11726 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11727 .cindex "&%match_ip%& expansion condition"
11728 This condition matches an IP address to a list of IP address patterns. It must
11729 be followed by two argument strings. The first (after expansion) must be an IP
11730 address or an empty string. The second (not expanded) is a restricted host
11731 list that can match only an IP address, not a host name. For example:
11732 .code
11733 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11734 .endd
11735 The specific types of host list item that are permitted in the list are:
11736
11737 .ilist
11738 An IP address, optionally with a CIDR mask.
11739 .next
11740 A single asterisk, which matches any IP address.
11741 .next
11742 An empty item, which matches only if the IP address is empty. This could be
11743 useful for testing for a locally submitted message or one from specific hosts
11744 in a single test such as
11745 . ==== As this is a nested list, any displays it contains must be indented
11746 . ==== as otherwise they are too far to the left. This comment applies to
11747 . ==== the use of xmlto plus fop. There's no problem when formatting with
11748 . ==== sdop, with or without the extra indent.
11749 .code
11750   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11751 .endd
11752 where the first item in the list is the empty string.
11753 .next
11754 The item @[] matches any of the local host's interface addresses.
11755 .next
11756 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11757 even if &`net-`& is not specified. There is never any attempt to turn the IP
11758 address into a host name. The most common type of linear search for
11759 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11760 masks. For example:
11761 .code
11762   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11763 .endd
11764 It is of course possible to use other kinds of lookup, and in such a case, you
11765 do need to specify the &`net-`& prefix if you want to specify a specific
11766 address mask, for example:
11767 .code
11768   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11769 .endd
11770 However, unless you are combining a &%match_ip%& condition with others, it is
11771 just as easy to use the fact that a lookup is itself a condition, and write:
11772 .code
11773   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11774 .endd
11775 .endlist ilist
11776
11777 Note that <&'string2'&> is not itself subject to string expansion, unless
11778 Exim was built with the EXPAND_LISTMATCH_RHS option.
11779
11780 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11781
11782 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11783 .cindex "domain list" "in expansion condition"
11784 .cindex "address list" "in expansion condition"
11785 .cindex "local part" "list, in expansion condition"
11786 .cindex "&%match_local_part%& expansion condition"
11787 This condition, together with &%match_address%& and &%match_domain%&, make it
11788 possible to test domain, address, and local part lists within expansions. Each
11789 condition requires two arguments: an item and a list to match. A trivial
11790 example is:
11791 .code
11792 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11793 .endd
11794 In each case, the second argument may contain any of the allowable items for a
11795 list of the appropriate type. Also, because the second argument
11796 is a standard form of list, it is possible to refer to a named list.
11797 Thus, you can use conditions like this:
11798 .code
11799 ${if match_domain{$domain}{+local_domains}{...
11800 .endd
11801 .cindex "&`+caseful`&"
11802 For address lists, the matching starts off caselessly, but the &`+caseful`&
11803 item can be used, as in all address lists, to cause subsequent items to
11804 have their local parts matched casefully. Domains are always matched
11805 caselessly.
11806
11807 Note that <&'string2'&> is not itself subject to string expansion, unless
11808 Exim was built with the EXPAND_LISTMATCH_RHS option.
11809
11810 &*Note*&: Host lists are &'not'& supported in this way. This is because
11811 hosts have two identities: a name and an IP address, and it is not clear
11812 how to specify cleanly how such a test would work. However, IP addresses can be
11813 matched using &%match_ip%&.
11814
11815 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11816 .cindex "PAM authentication"
11817 .cindex "AUTH" "with PAM"
11818 .cindex "Solaris" "PAM support"
11819 .cindex "expansion" "PAM authentication test"
11820 .cindex "&%pam%& expansion condition"
11821 &'Pluggable Authentication Modules'&
11822 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11823 available in the latest releases of Solaris and in some GNU/Linux
11824 distributions. The Exim support, which is intended for use in conjunction with
11825 the SMTP AUTH command, is available only if Exim is compiled with
11826 .code
11827 SUPPORT_PAM=yes
11828 .endd
11829 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11830 in some releases of GNU/Linux &%-ldl%& is also needed.
11831
11832 The argument string is first expanded, and the result must be a
11833 colon-separated list of strings. Leading and trailing white space is ignored.
11834 The PAM module is initialized with the service name &"exim"& and the user name
11835 taken from the first item in the colon-separated data string (<&'string1'&>).
11836 The remaining items in the data string are passed over in response to requests
11837 from the authentication function. In the simple case there will only be one
11838 request, for a password, so the data consists of just two strings.
11839
11840 There can be problems if any of the strings are permitted to contain colon
11841 characters. In the usual way, these have to be doubled to avoid being taken as
11842 separators. If the data is being inserted from a variable, the &%sg%& expansion
11843 item can be used to double any existing colons. For example, the configuration
11844 of a LOGIN authenticator might contain this setting:
11845 .code
11846 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11847 .endd
11848 For a PLAIN authenticator you could use:
11849 .code
11850 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11851 .endd
11852 In some operating systems, PAM authentication can be done only from a process
11853 running as root. Since Exim is running as the Exim user when receiving
11854 messages, this means that PAM cannot be used directly in those systems.
11855 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11856
11857
11858 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11859 .cindex "&'pwcheck'& daemon"
11860 .cindex "Cyrus"
11861 .cindex "expansion" "&'pwcheck'& authentication test"
11862 .cindex "&%pwcheck%& expansion condition"
11863 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11864 This is one way of making it possible for passwords to be checked by a process
11865 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11866 deprecated. Its replacement is &'saslauthd'& (see below).
11867
11868 The pwcheck support is not included in Exim by default. You need to specify
11869 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11870 building Exim. For example:
11871 .code
11872 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11873 .endd
11874 You do not need to install the full Cyrus software suite in order to use
11875 the pwcheck daemon. You can compile and install just the daemon alone
11876 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11877 access to the &_/var/pwcheck_& directory.
11878
11879 The &%pwcheck%& condition takes one argument, which must be the user name and
11880 password, separated by a colon. For example, in a LOGIN authenticator
11881 configuration, you might have this:
11882 .code
11883 server_condition = ${if pwcheck{$auth1:$auth2}}
11884 .endd
11885 Again, for a PLAIN authenticator configuration, this would be:
11886 .code
11887 server_condition = ${if pwcheck{$auth2:$auth3}}
11888 .endd
11889 .vitem &*queue_running*&
11890 .cindex "queue runner" "detecting when delivering from"
11891 .cindex "expansion" "queue runner test"
11892 .cindex "&%queue_running%& expansion condition"
11893 This condition, which has no data, is true during delivery attempts that are
11894 initiated by queue runner processes, and false otherwise.
11895
11896
11897 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11898 .cindex "Radius"
11899 .cindex "expansion" "Radius authentication"
11900 .cindex "&%radius%& expansion condition"
11901 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11902 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11903 the Radius client configuration file in order to build Exim with Radius
11904 support.
11905
11906 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11907 library, using the original API. If you are using release 0.4.0 or later of
11908 this library, you need to set
11909 .code
11910 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11911 .endd
11912 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11913 &%libradius%& library that comes with FreeBSD. To do this, set
11914 .code
11915 RADIUS_LIB_TYPE=RADLIB
11916 .endd
11917 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11918 You may also have to supply a suitable setting in EXTRALIBS so that the
11919 Radius library can be found when Exim is linked.
11920
11921 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11922 Radius client library, which calls the Radius server. The condition is true if
11923 the authentication is successful. For example:
11924 .code
11925 server_condition = ${if radius{<arguments>}}
11926 .endd
11927
11928
11929 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11930         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11931 .cindex "&'saslauthd'& daemon"
11932 .cindex "Cyrus"
11933 .cindex "expansion" "&'saslauthd'& authentication test"
11934 .cindex "&%saslauthd%& expansion condition"
11935 This condition supports user authentication using the Cyrus &'saslauthd'&
11936 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11937 Using this daemon is one way of making it possible for passwords to be checked
11938 by a process that is not running as root.
11939
11940 The saslauthd support is not included in Exim by default. You need to specify
11941 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11942 building Exim. For example:
11943 .code
11944 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11945 .endd
11946 You do not need to install the full Cyrus software suite in order to use
11947 the saslauthd daemon. You can compile and install just the daemon alone
11948 from the Cyrus SASL library.
11949
11950 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11951 two are mandatory. For example:
11952 .code
11953 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11954 .endd
11955 The service and the realm are optional (which is why the arguments are enclosed
11956 in their own set of braces). For details of the meaning of the service and
11957 realm, and how to run the daemon, consult the Cyrus documentation.
11958 .endlist vlist
11959
11960
11961
11962 .section "Combining expansion conditions" "SECID84"
11963 .cindex "expansion" "combining conditions"
11964 Several conditions can be tested at once by combining them using the &%and%&
11965 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11966 conditions on their own, and precede their lists of sub-conditions. Each
11967 sub-condition must be enclosed in braces within the overall braces that contain
11968 the list. No repetition of &%if%& is used.
11969
11970
11971 .vlist
11972 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11973 .cindex "&""or""& expansion condition"
11974 .cindex "expansion" "&""or""& of conditions"
11975 The sub-conditions are evaluated from left to right. The condition is true if
11976 any one of the sub-conditions is true.
11977 For example,
11978 .code
11979 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11980 .endd
11981 When a true sub-condition is found, the following ones are parsed but not
11982 evaluated. If there are several &"match"& sub-conditions the values of the
11983 numeric variables afterwards are taken from the first one that succeeds.
11984
11985 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11986 .cindex "&""and""& expansion condition"
11987 .cindex "expansion" "&""and""& of conditions"
11988 The sub-conditions are evaluated from left to right. The condition is true if
11989 all of the sub-conditions are true. If there are several &"match"&
11990 sub-conditions, the values of the numeric variables afterwards are taken from
11991 the last one. When a false sub-condition is found, the following ones are
11992 parsed but not evaluated.
11993 .endlist
11994 .ecindex IIDexpcond
11995
11996
11997
11998
11999 .section "Expansion variables" "SECTexpvar"
12000 .cindex "expansion" "variables, list of"
12001 This section contains an alphabetical list of all the expansion variables. Some
12002 of them are available only when Exim is compiled with specific options such as
12003 support for TLS or the content scanning extension.
12004
12005 .vlist
12006 .vitem "&$0$&, &$1$&, etc"
12007 .cindex "numerical variables (&$1$& &$2$& etc)"
12008 When a &%match%& expansion condition succeeds, these variables contain the
12009 captured substrings identified by the regular expression during subsequent
12010 processing of the success string of the containing &%if%& expansion item.
12011 In the expansion condition case
12012 they do not retain their values afterwards; in fact, their previous
12013 values are restored at the end of processing an &%if%& item. The numerical
12014 variables may also be set externally by some other matching process which
12015 precedes the expansion of the string. For example, the commands available in
12016 Exim filter files include an &%if%& command with its own regular expression
12017 matching condition.
12018
12019 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12020 Within an acl condition, expansion condition or expansion item
12021 any arguments are copied to these variables,
12022 any unused variables being made empty.
12023
12024 .vitem "&$acl_c...$&"
12025 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12026 can be given any name that starts with &$acl_c$& and is at least six characters
12027 long, but the sixth character must be either a digit or an underscore. For
12028 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12029 variables persist throughout the lifetime of an SMTP connection. They can be
12030 used to pass information between ACLs and between different invocations of the
12031 same ACL. When a message is received, the values of these variables are saved
12032 with the message, and can be accessed by filters, routers, and transports
12033 during subsequent delivery.
12034
12035 .vitem "&$acl_m...$&"
12036 These variables are like the &$acl_c...$& variables, except that their values
12037 are reset after a message has been received. Thus, if several messages are
12038 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12039 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12040 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12041 message is received, the values of these variables are saved with the message,
12042 and can be accessed by filters, routers, and transports during subsequent
12043 delivery.
12044
12045 .vitem &$acl_narg$&
12046 Within an acl condition, expansion condition or expansion item
12047 this variable has the number of arguments.
12048
12049 .vitem &$acl_verify_message$&
12050 .vindex "&$acl_verify_message$&"
12051 After an address verification has failed, this variable contains the failure
12052 message. It retains its value for use in subsequent modifiers. The message can
12053 be preserved by coding like this:
12054 .code
12055 warn !verify = sender
12056      set acl_m0 = $acl_verify_message
12057 .endd
12058 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12059 &%log_message%& modifiers, to include information about the verification
12060 failure.
12061
12062 .vitem &$address_data$&
12063 .vindex "&$address_data$&"
12064 This variable is set by means of the &%address_data%& option in routers. The
12065 value then remains with the address while it is processed by subsequent routers
12066 and eventually a transport. If the transport is handling multiple addresses,
12067 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12068 for more details. &*Note*&: The contents of &$address_data$& are visible in
12069 user filter files.
12070
12071 If &$address_data$& is set when the routers are called from an ACL to verify
12072 a recipient address, the final value is still in the variable for subsequent
12073 conditions and modifiers of the ACL statement. If routing the address caused it
12074 to be redirected to just one address, the child address is also routed as part
12075 of the verification, and in this case the final value of &$address_data$& is
12076 from the child's routing.
12077
12078 If &$address_data$& is set when the routers are called from an ACL to verify a
12079 sender address, the final value is also preserved, but this time in
12080 &$sender_address_data$&, to distinguish it from data from a recipient
12081 address.
12082
12083 In both cases (recipient and sender verification), the value does not persist
12084 after the end of the current ACL statement. If you want to preserve
12085 these values for longer, you can save them in ACL variables.
12086
12087 .vitem &$address_file$&
12088 .vindex "&$address_file$&"
12089 When, as a result of aliasing, forwarding, or filtering, a message is directed
12090 to a specific file, this variable holds the name of the file when the transport
12091 is running. At other times, the variable is empty. For example, using the
12092 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12093 .code
12094 /home/r2d2/savemail
12095 .endd
12096 then when the &(address_file)& transport is running, &$address_file$&
12097 contains the text string &`/home/r2d2/savemail`&.
12098 .cindex "Sieve filter" "value of &$address_file$&"
12099 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12100 then up to the transport configuration to generate an appropriate absolute path
12101 to the relevant file.
12102
12103 .vitem &$address_pipe$&
12104 .vindex "&$address_pipe$&"
12105 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12106 this variable holds the pipe command when the transport is running.
12107
12108 .vitem "&$auth1$& &-- &$auth3$&"
12109 .vindex "&$auth1$&, &$auth2$&, etc"
12110 These variables are used in SMTP authenticators (see chapters
12111 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12112
12113 .vitem &$authenticated_id$&
12114 .cindex "authentication" "id"
12115 .vindex "&$authenticated_id$&"
12116 When a server successfully authenticates a client it may be configured to
12117 preserve some of the authentication information in the variable
12118 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12119 user/password authenticator configuration might preserve the user name for use
12120 in the routers. Note that this is not the same information that is saved in
12121 &$sender_host_authenticated$&.
12122
12123 When a message is submitted locally (that is, not over a TCP connection)
12124 the value of &$authenticated_id$& is normally the login name of the calling
12125 process. However, a trusted user can override this by means of the &%-oMai%&
12126 command line option.
12127 This second case also sets up information used by the
12128 &$authresults$& expansion item.
12129
12130 .vitem &$authenticated_fail_id$&
12131 .cindex "authentication" "fail" "id"
12132 .vindex "&$authenticated_fail_id$&"
12133 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12134 will contain the failed authentication id. If more than one authentication
12135 id is attempted, it will contain only the last one. The variable is
12136 available for processing in the ACL's, generally the quit or notquit ACL.
12137 A message to a local recipient could still be accepted without requiring
12138 authentication, which means this variable could also be visible in all of
12139 the ACL's as well.
12140
12141
12142 .vitem &$authenticated_sender$&
12143 .cindex "sender" "authenticated"
12144 .cindex "authentication" "sender"
12145 .cindex "AUTH" "on MAIL command"
12146 .vindex "&$authenticated_sender$&"
12147 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12148 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12149 described in section &<<SECTauthparamail>>&. Unless the data is the string
12150 &"<>"&, it is set as the authenticated sender of the message, and the value is
12151 available during delivery in the &$authenticated_sender$& variable. If the
12152 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12153
12154 .vindex "&$qualify_domain$&"
12155 When a message is submitted locally (that is, not over a TCP connection), the
12156 value of &$authenticated_sender$& is an address constructed from the login
12157 name of the calling process and &$qualify_domain$&, except that a trusted user
12158 can override this by means of the &%-oMas%& command line option.
12159
12160
12161 .vitem &$authentication_failed$&
12162 .cindex "authentication" "failure"
12163 .vindex "&$authentication_failed$&"
12164 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12165 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12166 possible to distinguish between &"did not try to authenticate"&
12167 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12168 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12169 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12170 negative response to an AUTH command, including (for example) an attempt to use
12171 an undefined mechanism.
12172
12173 .vitem &$av_failed$&
12174 .cindex "content scanning" "AV scanner failure"
12175 This variable is available when Exim is compiled with the content-scanning
12176 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12177 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12178 the ACL malware condition.
12179
12180 .vitem &$body_linecount$&
12181 .cindex "message body" "line count"
12182 .cindex "body of message" "line count"
12183 .vindex "&$body_linecount$&"
12184 When a message is being received or delivered, this variable contains the
12185 number of lines in the message's body. See also &$message_linecount$&.
12186
12187 .vitem &$body_zerocount$&
12188 .cindex "message body" "binary zero count"
12189 .cindex "body of message" "binary zero count"
12190 .cindex "binary zero" "in message body"
12191 .vindex "&$body_zerocount$&"
12192 When a message is being received or delivered, this variable contains the
12193 number of binary zero bytes (ASCII NULs) in the message's body.
12194
12195 .vitem &$bounce_recipient$&
12196 .vindex "&$bounce_recipient$&"
12197 This is set to the recipient address of a bounce message while Exim is creating
12198 it. It is useful if a customized bounce message text file is in use (see
12199 chapter &<<CHAPemsgcust>>&).
12200
12201 .vitem &$bounce_return_size_limit$&
12202 .vindex "&$bounce_return_size_limit$&"
12203 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12204 up to a multiple of 1000. It is useful when a customized error message text
12205 file is in use (see chapter &<<CHAPemsgcust>>&).
12206
12207 .vitem &$caller_gid$&
12208 .cindex "gid (group id)" "caller"
12209 .vindex "&$caller_gid$&"
12210 The real group id under which the process that called Exim was running. This is
12211 not the same as the group id of the originator of a message (see
12212 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12213 incarnation normally contains the Exim gid.
12214
12215 .vitem &$caller_uid$&
12216 .cindex "uid (user id)" "caller"
12217 .vindex "&$caller_uid$&"
12218 The real user id under which the process that called Exim was running. This is
12219 not the same as the user id of the originator of a message (see
12220 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12221 incarnation normally contains the Exim uid.
12222
12223 .vitem &$callout_address$&
12224 .vindex "&$callout_address$&"
12225 After a callout for verification, spamd or malware daemon service, the
12226 address that was connected to.
12227
12228 .vitem &$compile_number$&
12229 .vindex "&$compile_number$&"
12230 The building process for Exim keeps a count of the number
12231 of times it has been compiled. This serves to distinguish different
12232 compilations of the same version of Exim.
12233
12234 .vitem &$config_dir$&
12235 .vindex "&$config_dir$&"
12236 The directory name of the main configuration file. That is, the content of
12237 &$config_file$& with the last component stripped. The value does not
12238 contain the trailing slash. If &$config_file$& does not contain a slash,
12239 &$config_dir$& is ".".
12240
12241 .vitem &$config_file$&
12242 .vindex "&$config_file$&"
12243 The name of the main configuration file Exim is using.
12244
12245 .vitem &$dmarc_domain_policy$& &&&
12246        &$dmarc_status$& &&&
12247        &$dmarc_status_text$& &&&
12248        &$dmarc_used_domains$&
12249 Results of DMARC verification.
12250 For details see section &<<SECDMARC>>&.
12251
12252 .vitem &$dkim_verify_status$&
12253 Results of DKIM verification.
12254 For details see section &<<SECDKIMVFY>>&.
12255
12256 .vitem &$dkim_cur_signer$& &&&
12257        &$dkim_verify_reason$& &&&
12258        &$dkim_domain$& &&&
12259        &$dkim_identity$& &&&
12260        &$dkim_selector$& &&&
12261        &$dkim_algo$& &&&
12262        &$dkim_canon_body$& &&&
12263        &$dkim_canon_headers$& &&&
12264        &$dkim_copiedheaders$& &&&
12265        &$dkim_bodylength$& &&&
12266        &$dkim_created$& &&&
12267        &$dkim_expires$& &&&
12268        &$dkim_headernames$& &&&
12269        &$dkim_key_testing$& &&&
12270        &$dkim_key_nosubdomains$& &&&
12271        &$dkim_key_srvtype$& &&&
12272        &$dkim_key_granularity$& &&&
12273        &$dkim_key_notes$& &&&
12274        &$dkim_key_length$&
12275 These variables are only available within the DKIM ACL.
12276 For details see section &<<SECDKIMVFY>>&.
12277
12278 .vitem &$dkim_signers$&
12279 .vindex &$dkim_signers$&
12280 When a message has been received this variable contains
12281 a colon-separated list of signer domains and identities for the message.
12282 For details see section &<<SECDKIMVFY>>&.
12283
12284 .vitem &$dnslist_domain$& &&&
12285        &$dnslist_matched$& &&&
12286        &$dnslist_text$& &&&
12287        &$dnslist_value$&
12288 .vindex "&$dnslist_domain$&"
12289 .vindex "&$dnslist_matched$&"
12290 .vindex "&$dnslist_text$&"
12291 .vindex "&$dnslist_value$&"
12292 .cindex "black list (DNS)"
12293 When a DNS (black) list lookup succeeds, these variables are set to contain
12294 the following data from the lookup: the list's domain name, the key that was
12295 looked up, the contents of any associated TXT record, and the value from the
12296 main A record. See section &<<SECID204>>& for more details.
12297
12298 .vitem &$domain$&
12299 .vindex "&$domain$&"
12300 When an address is being routed, or delivered on its own, this variable
12301 contains the domain. Uppercase letters in the domain are converted into lower
12302 case for &$domain$&.
12303
12304 Global address rewriting happens when a message is received, so the value of
12305 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12306 is set during user filtering, but not during system filtering, because a
12307 message may have many recipients and the system filter is called just once.
12308
12309 When more than one address is being delivered at once (for example, several
12310 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12311 have the same domain. Transports can be restricted to handling only one domain
12312 at a time if the value of &$domain$& is required at transport time &-- this is
12313 the default for local transports. For further details of the environment in
12314 which local transports are run, see chapter &<<CHAPenvironment>>&.
12315
12316 .oindex "&%delay_warning_condition%&"
12317 At the end of a delivery, if all deferred addresses have the same domain, it is
12318 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12319
12320 The &$domain$& variable is also used in some other circumstances:
12321
12322 .ilist
12323 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12324 the recipient address. The domain of the &'sender'& address is in
12325 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12326 normally set during the running of the MAIL ACL. However, if the sender address
12327 is verified with a callout during the MAIL ACL, the sender domain is placed in
12328 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12329 the &(smtp)& transport.
12330
12331 .next
12332 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12333 &$domain$& contains the domain portion of the address that is being rewritten;
12334 it can be used in the expansion of the replacement address, for example, to
12335 rewrite domains by file lookup.
12336
12337 .next
12338 With one important exception, whenever a domain list is being scanned,
12339 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12340 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12341 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12342 that, in a RCPT ACL, the sender domain list can be dependent on the
12343 recipient domain (which is what is in &$domain$& at this time).
12344
12345 .next
12346 .cindex "ETRN" "value of &$domain$&"
12347 .oindex "&%smtp_etrn_command%&"
12348 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12349 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12350 .endlist
12351
12352 .new
12353 .cindex "tainted data"
12354 If the origin of the data is an incoming message,
12355 the result of expanding this variable is tainted.
12356 See also &$domain_verified$&.
12357 .wen
12358
12359
12360 .vitem &$domain_data$&
12361 .vindex "&$domain_data$&"
12362 When the &%domains%& option on a router matches a domain by
12363 means of a lookup, the data read by the lookup is available during the running
12364 of the router as &$domain_data$&. In addition, if the driver routes the
12365 address to a transport, the value is available in that transport. If the
12366 transport is handling multiple addresses, the value from the first address is
12367 used.
12368
12369 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12370 domain by means of a lookup. The data read by the lookup is available during
12371 the rest of the ACL statement. In all other situations, this variable expands
12372 to nothing.
12373
12374 .vitem &$exim_gid$&
12375 .vindex "&$exim_gid$&"
12376 This variable contains the numerical value of the Exim group id.
12377
12378 .vitem &$exim_path$&
12379 .vindex "&$exim_path$&"
12380 This variable contains the path to the Exim binary.
12381
12382 .vitem &$exim_uid$&
12383 .vindex "&$exim_uid$&"
12384 This variable contains the numerical value of the Exim user id.
12385
12386 .vitem &$exim_version$&
12387 .vindex "&$exim_version$&"
12388 This variable contains the version string of the Exim build.
12389 The first character is a major version number, currently 4.
12390 Then after a dot, the next group of digits is a minor version number.
12391 There may be other characters following the minor version.
12392 This value may be overridden by the &%exim_version%& main config option.
12393
12394 .vitem &$header_$&<&'name'&>
12395 This is not strictly an expansion variable. It is expansion syntax for
12396 inserting the message header line with the given name. Note that the name must
12397 be terminated by colon or white space, because it may contain a wide variety of
12398 characters. Note also that braces must &'not'& be used.
12399 See the full description in section &<<SECTexpansionitems>>& above.
12400
12401 .vitem &$headers_added$&
12402 .vindex "&$headers_added$&"
12403 Within an ACL this variable contains the headers added so far by
12404 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12405 The headers are a newline-separated list.
12406
12407 .vitem &$home$&
12408 .vindex "&$home$&"
12409 When the &%check_local_user%& option is set for a router, the user's home
12410 directory is placed in &$home$& when the check succeeds. In particular, this
12411 means it is set during the running of users' filter files. A router may also
12412 explicitly set a home directory for use by a transport; this can be overridden
12413 by a setting on the transport itself.
12414
12415 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12416 of the environment variable HOME, which is subject to the
12417 &%keep_environment%& and &%add_environment%& main config options.
12418
12419 .vitem &$host$&
12420 .vindex "&$host$&"
12421 If a router assigns an address to a transport (any transport), and passes a
12422 list of hosts with the address, the value of &$host$& when the transport starts
12423 to run is the name of the first host on the list. Note that this applies both
12424 to local and remote transports.
12425
12426 .cindex "transport" "filter"
12427 .cindex "filter" "transport filter"
12428 For the &(smtp)& transport, if there is more than one host, the value of
12429 &$host$& changes as the transport works its way through the list. In
12430 particular, when the &(smtp)& transport is expanding its options for encryption
12431 using TLS, or for specifying a transport filter (see chapter
12432 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12433 is connected.
12434
12435 When used in the client part of an authenticator configuration (see chapter
12436 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12437 client is connected.
12438
12439
12440 .vitem &$host_address$&
12441 .vindex "&$host_address$&"
12442 This variable is set to the remote host's IP address whenever &$host$& is set
12443 for a remote connection. It is also set to the IP address that is being checked
12444 when the &%ignore_target_hosts%& option is being processed.
12445
12446 .vitem &$host_data$&
12447 .vindex "&$host_data$&"
12448 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12449 result of the lookup is made available in the &$host_data$& variable. This
12450 allows you, for example, to do things like this:
12451 .code
12452 deny  hosts = net-lsearch;/some/file
12453 message = $host_data
12454 .endd
12455 .vitem &$host_lookup_deferred$&
12456 .cindex "host name" "lookup, failure of"
12457 .vindex "&$host_lookup_deferred$&"
12458 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12459 message comes from a remote host and there is an attempt to look up the host's
12460 name from its IP address, and the attempt is not successful, one of these
12461 variables is set to &"1"&.
12462
12463 .ilist
12464 If the lookup receives a definite negative response (for example, a DNS lookup
12465 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12466
12467 .next
12468 If there is any kind of problem during the lookup, such that Exim cannot
12469 tell whether or not the host name is defined (for example, a timeout for a DNS
12470 lookup), &$host_lookup_deferred$& is set to &"1"&.
12471 .endlist ilist
12472
12473 Looking up a host's name from its IP address consists of more than just a
12474 single reverse lookup. Exim checks that a forward lookup of at least one of the
12475 names it receives from a reverse lookup yields the original IP address. If this
12476 is not the case, Exim does not accept the looked up name(s), and
12477 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12478 IP address (for example, the existence of a PTR record in the DNS) is not
12479 sufficient on its own for the success of a host name lookup. If the reverse
12480 lookup succeeds, but there is a lookup problem such as a timeout when checking
12481 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12482 &"1"&. See also &$sender_host_name$&.
12483
12484 .cindex authentication "expansion item"
12485 Performing these checks sets up information used by the
12486 &%authresults%& expansion item.
12487
12488
12489 .vitem &$host_lookup_failed$&
12490 .vindex "&$host_lookup_failed$&"
12491 See &$host_lookup_deferred$&.
12492
12493 .vitem &$host_port$&
12494 .vindex "&$host_port$&"
12495 This variable is set to the remote host's TCP port whenever &$host$& is set
12496 for an outbound connection.
12497
12498 .vitem &$initial_cwd$&
12499 .vindex "&$initial_cwd$&
12500 This variable contains the full path name of the initial working
12501 directory of the current Exim process. This may differ from the current
12502 working directory, as Exim changes this to "/" during early startup, and
12503 to &$spool_directory$& later.
12504
12505 .vitem &$inode$&
12506 .vindex "&$inode$&"
12507 The only time this variable is set is while expanding the &%directory_file%&
12508 option in the &(appendfile)& transport. The variable contains the inode number
12509 of the temporary file which is about to be renamed. It can be used to construct
12510 a unique name for the file.
12511
12512 .vitem &$interface_address$&
12513 .vindex "&$interface_address$&"
12514 This is an obsolete name for &$received_ip_address$&.
12515
12516 .vitem &$interface_port$&
12517 .vindex "&$interface_port$&"
12518 This is an obsolete name for &$received_port$&.
12519
12520 .vitem &$item$&
12521 .vindex "&$item$&"
12522 This variable is used during the expansion of &*forall*& and &*forany*&
12523 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12524 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12525 empty.
12526
12527 .vitem &$ldap_dn$&
12528 .vindex "&$ldap_dn$&"
12529 This variable, which is available only when Exim is compiled with LDAP support,
12530 contains the DN from the last entry in the most recently successful LDAP
12531 lookup.
12532
12533 .vitem &$load_average$&
12534 .vindex "&$load_average$&"
12535 This variable contains the system load average, multiplied by 1000 so that it
12536 is an integer. For example, if the load average is 0.21, the value of the
12537 variable is 210. The value is recomputed every time the variable is referenced.
12538
12539 .vitem &$local_part$&
12540 .vindex "&$local_part$&"
12541 When an address is being routed, or delivered on its own, this
12542 variable contains the local part. When a number of addresses are being
12543 delivered together (for example, multiple RCPT commands in an SMTP
12544 session), &$local_part$& is not set.
12545
12546 Global address rewriting happens when a message is received, so the value of
12547 &$local_part$& during routing and delivery is the value after rewriting.
12548 &$local_part$& is set during user filtering, but not during system filtering,
12549 because a message may have many recipients and the system filter is called just
12550 once.
12551
12552 .new
12553 .cindex "tainted data"
12554 If the origin of the data is an incoming message,
12555 the result of expanding this variable is tainted.
12556
12557 &*Warning*&: the content of this variable is usually provided by a potential
12558 attacker.
12559 Consider carefully the implications of using it unvalidated as a name
12560 for file access.
12561 This presents issues for users' &_.forward_& and filter files.
12562 For traditional full user accounts, use &%check_local_users%& and the
12563 &$local_part_verified$& variable rather than this one.
12564 For virtual users, store a suitable pathname component in the database
12565 which is used for account name validation, and use that retrieved value
12566 rather than this variable.
12567 If needed, use a router &%address_data%& or &%set%& option for
12568 the retrieved data.
12569 .wen
12570
12571 .vindex "&$local_part_prefix$&"
12572 .vindex "&$local_part_prefix_v$&"
12573 .vindex "&$local_part_suffix$&"
12574 .vindex "&$local_part_suffix_v$&"
12575 .cindex affix variables
12576 If a local part prefix or suffix has been recognized, it is not included in the
12577 value of &$local_part$& during routing and subsequent delivery. The values of
12578 any prefix or suffix are in &$local_part_prefix$& and
12579 &$local_part_suffix$&, respectively.
12580 .new
12581 If the affix specification included a wildcard then the portion of
12582 the affix matched by the wildcard is in
12583 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate.
12584 .wen
12585
12586 When a message is being delivered to a file, pipe, or autoreply transport as a
12587 result of aliasing or forwarding, &$local_part$& is set to the local part of
12588 the parent address, not to the filename or command (see &$address_file$& and
12589 &$address_pipe$&).
12590
12591 When an ACL is running for a RCPT command, &$local_part$& contains the
12592 local part of the recipient address.
12593
12594 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12595 &$local_part$& contains the local part of the address that is being rewritten;
12596 it can be used in the expansion of the replacement address, for example.
12597
12598 In all cases, all quoting is removed from the local part. For example, for both
12599 the addresses
12600 .code
12601 "abc:xyz"@test.example
12602 abc\:xyz@test.example
12603 .endd
12604 the value of &$local_part$& is
12605 .code
12606 abc:xyz
12607 .endd
12608 If you use &$local_part$& to create another address, you should always wrap it
12609 inside a quoting operator. For example, in a &(redirect)& router you could
12610 have:
12611 .code
12612 data = ${quote_local_part:$local_part}@new.domain.example
12613 .endd
12614 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12615 to process local parts in a case-dependent manner in a router, you can set the
12616 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12617
12618 .vitem &$local_part_data$&
12619 .vindex "&$local_part_data$&"
12620 When the &%local_parts%& option on a router matches a local part by means of a
12621 lookup, the data read by the lookup is available during the running of the
12622 router as &$local_part_data$&. In addition, if the driver routes the address
12623 to a transport, the value is available in that transport. If the transport is
12624 handling multiple addresses, the value from the first address is used.
12625
12626 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12627 matches a local part by means of a lookup. The data read by the lookup is
12628 available during the rest of the ACL statement. In all other situations, this
12629 variable expands to nothing.
12630
12631 .vitem &$local_part_prefix$&
12632 .vindex "&$local_part_prefix$&"
12633 .cindex affix variables
12634 When an address is being routed or delivered, and a
12635 specific prefix for the local part was recognized, it is available in this
12636 variable, having been removed from &$local_part$&.
12637
12638 .new
12639 .vitem &$local_part_prefix_v$&
12640 .vindex "&$local_part_prefix_v$&"
12641 When &$local_part_prefix$& is valid and the prefix match used a wildcard,
12642 the portion matching the wildcard is available in this variable.
12643 .wen
12644
12645 .vitem &$local_part_suffix$&
12646 .vindex "&$local_part_suffix$&"
12647 When an address is being routed or delivered, and a
12648 specific suffix for the local part was recognized, it is available in this
12649 variable, having been removed from &$local_part$&.
12650
12651 .new
12652 .vitem &$local_part_suffix_v$&
12653 .vindex "&$local_part_suffix_v$&"
12654 When &$local_part_suffix$& is valid and the suffix match used a wildcard,
12655 the portion matching the wildcard is available in this variable.
12656 .wen
12657
12658 .new
12659 .vitem &$local_part_verified$&
12660 .vindex "&$local_part_verified$&"
12661 If the router generic option &%check_local_part%& has run successfully,
12662 this variable has the user database version of &$local_part$&.
12663 Such values are not tainted and hence usable for building file names.
12664 .wen
12665
12666 .vitem &$local_scan_data$&
12667 .vindex "&$local_scan_data$&"
12668 This variable contains the text returned by the &[local_scan()]& function when
12669 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12670
12671 .vitem &$local_user_gid$&
12672 .vindex "&$local_user_gid$&"
12673 See &$local_user_uid$&.
12674
12675 .vitem &$local_user_uid$&
12676 .vindex "&$local_user_uid$&"
12677 This variable and &$local_user_gid$& are set to the uid and gid after the
12678 &%check_local_user%& router precondition succeeds. This means that their values
12679 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12680 and &%condition%&), for the &%address_data%& expansion, and for any
12681 router-specific expansions. At all other times, the values in these variables
12682 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12683
12684 .vitem &$localhost_number$&
12685 .vindex "&$localhost_number$&"
12686 This contains the expanded value of the
12687 &%localhost_number%& option. The expansion happens after the main options have
12688 been read.
12689
12690 .vitem &$log_inodes$&
12691 .vindex "&$log_inodes$&"
12692 The number of free inodes in the disk partition where Exim's
12693 log files are being written. The value is recalculated whenever the variable is
12694 referenced. If the relevant file system does not have the concept of inodes,
12695 the value of is -1. See also the &%check_log_inodes%& option.
12696
12697 .vitem &$log_space$&
12698 .vindex "&$log_space$&"
12699 The amount of free space (as a number of kilobytes) in the disk
12700 partition where Exim's log files are being written. The value is recalculated
12701 whenever the variable is referenced. If the operating system does not have the
12702 ability to find the amount of free space (only true for experimental systems),
12703 the space value is -1. See also the &%check_log_space%& option.
12704
12705
12706 .vitem &$lookup_dnssec_authenticated$&
12707 .vindex "&$lookup_dnssec_authenticated$&"
12708 This variable is set after a DNS lookup done by
12709 a dnsdb lookup expansion, dnslookup router or smtp transport.
12710 .cindex "DNS" "DNSSEC"
12711 It will be empty if &(DNSSEC)& was not requested,
12712 &"no"& if the result was not labelled as authenticated data
12713 and &"yes"& if it was.
12714 Results that are labelled as authoritative answer that match
12715 the &%dns_trust_aa%& configuration variable count also
12716 as authenticated data.
12717
12718 .vitem &$mailstore_basename$&
12719 .vindex "&$mailstore_basename$&"
12720 This variable is set only when doing deliveries in &"mailstore"& format in the
12721 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12722 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12723 contains the basename of the files that are being written, that is, the name
12724 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12725 variable is empty.
12726
12727 .vitem &$malware_name$&
12728 .vindex "&$malware_name$&"
12729 This variable is available when Exim is compiled with the
12730 content-scanning extension. It is set to the name of the virus that was found
12731 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12732
12733 .vitem &$max_received_linelength$&
12734 .vindex "&$max_received_linelength$&"
12735 .cindex "maximum" "line length"
12736 .cindex "line length" "maximum"
12737 This variable contains the number of bytes in the longest line that was
12738 received as part of the message, not counting the line termination
12739 character(s).
12740 It is not valid if the &%spool_files_wireformat%& option is used.
12741
12742 .vitem &$message_age$&
12743 .cindex "message" "age of"
12744 .vindex "&$message_age$&"
12745 This variable is set at the start of a delivery attempt to contain the number
12746 of seconds since the message was received. It does not change during a single
12747 delivery attempt.
12748
12749 .vitem &$message_body$&
12750 .cindex "body of message" "expansion variable"
12751 .cindex "message body" "in expansion"
12752 .cindex "binary zero" "in message body"
12753 .vindex "&$message_body$&"
12754 .oindex "&%message_body_visible%&"
12755 This variable contains the initial portion of a message's body while it is
12756 being delivered, and is intended mainly for use in filter files. The maximum
12757 number of characters of the body that are put into the variable is set by the
12758 &%message_body_visible%& configuration option; the default is 500.
12759
12760 .oindex "&%message_body_newlines%&"
12761 By default, newlines are converted into spaces in &$message_body$&, to make it
12762 easier to search for phrases that might be split over a line break. However,
12763 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12764 zeros are always converted into spaces.
12765
12766 .vitem &$message_body_end$&
12767 .cindex "body of message" "expansion variable"
12768 .cindex "message body" "in expansion"
12769 .vindex "&$message_body_end$&"
12770 This variable contains the final portion of a message's
12771 body while it is being delivered. The format and maximum size are as for
12772 &$message_body$&.
12773
12774 .vitem &$message_body_size$&
12775 .cindex "body of message" "size"
12776 .cindex "message body" "size"
12777 .vindex "&$message_body_size$&"
12778 When a message is being delivered, this variable contains the size of the body
12779 in bytes. The count starts from the character after the blank line that
12780 separates the body from the header. Newlines are included in the count. See
12781 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12782
12783 If the spool file is wireformat
12784 (see the &%spool_files_wireformat%& main option)
12785 the CRLF line-terminators are included in the count.
12786
12787 .vitem &$message_exim_id$&
12788 .vindex "&$message_exim_id$&"
12789 When a message is being received or delivered, this variable contains the
12790 unique message id that is generated and used by Exim to identify the message.
12791 An id is not created for a message until after its header has been successfully
12792 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12793 line; it is the local id that Exim assigns to the message, for example:
12794 &`1BXTIK-0001yO-VA`&.
12795
12796 .vitem &$message_headers$&
12797 .vindex &$message_headers$&
12798 This variable contains a concatenation of all the header lines when a message
12799 is being processed, except for lines added by routers or transports. The header
12800 lines are separated by newline characters. Their contents are decoded in the
12801 same way as a header line that is inserted by &%bheader%&.
12802
12803 .vitem &$message_headers_raw$&
12804 .vindex &$message_headers_raw$&
12805 This variable is like &$message_headers$& except that no processing of the
12806 contents of header lines is done.
12807
12808 .vitem &$message_id$&
12809 This is an old name for &$message_exim_id$&. It is now deprecated.
12810
12811 .vitem &$message_linecount$&
12812 .vindex "&$message_linecount$&"
12813 This variable contains the total number of lines in the header and body of the
12814 message. Compare &$body_linecount$&, which is the count for the body only.
12815 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12816 number of lines received. Before delivery happens (that is, before filters,
12817 routers, and transports run) the count is increased to include the
12818 &'Received:'& header line that Exim standardly adds, and also any other header
12819 lines that are added by ACLs. The blank line that separates the message header
12820 from the body is not counted.
12821
12822 As with the special case of &$message_size$&, during the expansion of the
12823 appendfile transport's maildir_tag option in maildir format, the value of
12824 &$message_linecount$& is the precise size of the number of newlines in the
12825 file that has been written (minus one for the blank line between the
12826 header and the body).
12827
12828 Here is an example of the use of this variable in a DATA ACL:
12829 .code
12830 deny message   = Too many lines in message header
12831      condition = \
12832       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12833 .endd
12834 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12835 message has not yet been received.
12836
12837 This variable is not valid if the &%spool_files_wireformat%& option is used.
12838
12839 .vitem &$message_size$&
12840 .cindex "size" "of message"
12841 .cindex "message" "size"
12842 .vindex "&$message_size$&"
12843 When a message is being processed, this variable contains its size in bytes. In
12844 most cases, the size includes those headers that were received with the
12845 message, but not those (such as &'Envelope-to:'&) that are added to individual
12846 deliveries as they are written. However, there is one special case: during the
12847 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12848 doing a delivery in maildir format, the value of &$message_size$& is the
12849 precise size of the file that has been written. See also
12850 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12851
12852 .cindex "RCPT" "value of &$message_size$&"
12853 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12854 contains the size supplied on the MAIL command, or -1 if no size was given. The
12855 value may not, of course, be truthful.
12856
12857 .vitem &$mime_$&&'xxx'&
12858 A number of variables whose names start with &$mime$& are
12859 available when Exim is compiled with the content-scanning extension. For
12860 details, see section &<<SECTscanmimepart>>&.
12861
12862 .vitem "&$n0$& &-- &$n9$&"
12863 These variables are counters that can be incremented by means
12864 of the &%add%& command in filter files.
12865
12866 .vitem &$original_domain$&
12867 .vindex "&$domain$&"
12868 .vindex "&$original_domain$&"
12869 When a top-level address is being processed for delivery, this contains the
12870 same value as &$domain$&. However, if a &"child"& address (for example,
12871 generated by an alias, forward, or filter file) is being processed, this
12872 variable contains the domain of the original address (lower cased). This
12873 differs from &$parent_domain$& only when there is more than one level of
12874 aliasing or forwarding. When more than one address is being delivered in a
12875 single transport run, &$original_domain$& is not set.
12876
12877 If a new address is created by means of a &%deliver%& command in a system
12878 filter, it is set up with an artificial &"parent"& address. This has the local
12879 part &'system-filter'& and the default qualify domain.
12880
12881 .vitem &$original_local_part$&
12882 .vindex "&$local_part$&"
12883 .vindex "&$original_local_part$&"
12884 When a top-level address is being processed for delivery, this contains the
12885 same value as &$local_part$&, unless a prefix or suffix was removed from the
12886 local part, because &$original_local_part$& always contains the full local
12887 part. When a &"child"& address (for example, generated by an alias, forward, or
12888 filter file) is being processed, this variable contains the full local part of
12889 the original address.
12890
12891 If the router that did the redirection processed the local part
12892 case-insensitively, the value in &$original_local_part$& is in lower case.
12893 This variable differs from &$parent_local_part$& only when there is more than
12894 one level of aliasing or forwarding. When more than one address is being
12895 delivered in a single transport run, &$original_local_part$& is not set.
12896
12897 If a new address is created by means of a &%deliver%& command in a system
12898 filter, it is set up with an artificial &"parent"& address. This has the local
12899 part &'system-filter'& and the default qualify domain.
12900
12901 .vitem &$originator_gid$&
12902 .cindex "gid (group id)" "of originating user"
12903 .cindex "sender" "gid"
12904 .vindex "&$caller_gid$&"
12905 .vindex "&$originator_gid$&"
12906 This variable contains the value of &$caller_gid$& that was set when the
12907 message was received. For messages received via the command line, this is the
12908 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12909 normally the gid of the Exim user.
12910
12911 .vitem &$originator_uid$&
12912 .cindex "uid (user id)" "of originating user"
12913 .cindex "sender" "uid"
12914 .vindex "&$caller_uid$&"
12915 .vindex "&$originator_uid$&"
12916 The value of &$caller_uid$& that was set when the message was received. For
12917 messages received via the command line, this is the uid of the sending user.
12918 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12919 user.
12920
12921 .vitem &$parent_domain$&
12922 .vindex "&$parent_domain$&"
12923 This variable is similar to &$original_domain$& (see
12924 above), except that it refers to the immediately preceding parent address.
12925
12926 .vitem &$parent_local_part$&
12927 .vindex "&$parent_local_part$&"
12928 This variable is similar to &$original_local_part$&
12929 (see above), except that it refers to the immediately preceding parent address.
12930
12931 .vitem &$pid$&
12932 .cindex "pid (process id)" "of current process"
12933 .vindex "&$pid$&"
12934 This variable contains the current process id.
12935
12936 .vitem &$pipe_addresses$&
12937 .cindex "filter" "transport filter"
12938 .cindex "transport" "filter"
12939 .vindex "&$pipe_addresses$&"
12940 This is not an expansion variable, but is mentioned here because the string
12941 &`$pipe_addresses`& is handled specially in the command specification for the
12942 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12943 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12944 It cannot be used in general expansion strings, and provokes an &"unknown
12945 variable"& error if encountered.
12946
12947 .vitem &$primary_hostname$&
12948 .vindex "&$primary_hostname$&"
12949 This variable contains the value set by &%primary_hostname%& in the
12950 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12951 a single-component name, Exim calls &[gethostbyname()]& (or
12952 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12953 qualified host name. See also &$smtp_active_hostname$&.
12954
12955
12956 .vitem &$proxy_external_address$& &&&
12957        &$proxy_external_port$& &&&
12958        &$proxy_local_address$& &&&
12959        &$proxy_local_port$& &&&
12960        &$proxy_session$&
12961 These variables are only available when built with Proxy Protocol
12962 or SOCKS5 support.
12963 For details see chapter &<<SECTproxyInbound>>&.
12964
12965 .vitem &$prdr_requested$&
12966 .cindex "PRDR" "variable for"
12967 This variable is set to &"yes"& if PRDR was requested by the client for the
12968 current message, otherwise &"no"&.
12969
12970 .vitem &$prvscheck_address$&
12971 This variable is used in conjunction with the &%prvscheck%& expansion item,
12972 which is described in sections &<<SECTexpansionitems>>& and
12973 &<<SECTverifyPRVS>>&.
12974
12975 .vitem &$prvscheck_keynum$&
12976 This variable is used in conjunction with the &%prvscheck%& expansion item,
12977 which is described in sections &<<SECTexpansionitems>>& and
12978 &<<SECTverifyPRVS>>&.
12979
12980 .vitem &$prvscheck_result$&
12981 This variable is used in conjunction with the &%prvscheck%& expansion item,
12982 which is described in sections &<<SECTexpansionitems>>& and
12983 &<<SECTverifyPRVS>>&.
12984
12985 .vitem &$qualify_domain$&
12986 .vindex "&$qualify_domain$&"
12987 The value set for the &%qualify_domain%& option in the configuration file.
12988
12989 .vitem &$qualify_recipient$&
12990 .vindex "&$qualify_recipient$&"
12991 The value set for the &%qualify_recipient%& option in the configuration file,
12992 or if not set, the value of &$qualify_domain$&.
12993
12994 .vitem &$queue_name$&
12995 .vindex &$queue_name$&
12996 .cindex "named queues" variable
12997 .cindex queues named
12998 The name of the spool queue in use; empty for the default queue.
12999
13000 .vitem &$queue_size$&
13001 .vindex "&$queue_size$&"
13002 .cindex "queue" "size of"
13003 .cindex "spool" "number of messages"
13004 This variable contains the number of messages queued.
13005 It is evaluated on demand, but no more often than once every minute.
13006
13007 .vitem &$r_...$&
13008 .vindex &$r_...$&
13009 .cindex router variables
13010 Values can be placed in these variables by the &%set%& option of a router.
13011 They can be given any name that starts with &$r_$&.
13012 The values persist for the address being handled through subsequent routers
13013 and the eventual transport.
13014
13015 .vitem &$rcpt_count$&
13016 .vindex "&$rcpt_count$&"
13017 When a message is being received by SMTP, this variable contains the number of
13018 RCPT commands received for the current message. If this variable is used in a
13019 RCPT ACL, its value includes the current command.
13020
13021 .vitem &$rcpt_defer_count$&
13022 .vindex "&$rcpt_defer_count$&"
13023 .cindex "4&'xx'& responses" "count of"
13024 When a message is being received by SMTP, this variable contains the number of
13025 RCPT commands in the current message that have previously been rejected with a
13026 temporary (4&'xx'&) response.
13027
13028 .vitem &$rcpt_fail_count$&
13029 .vindex "&$rcpt_fail_count$&"
13030 When a message is being received by SMTP, this variable contains the number of
13031 RCPT commands in the current message that have previously been rejected with a
13032 permanent (5&'xx'&) response.
13033
13034 .vitem &$received_count$&
13035 .vindex "&$received_count$&"
13036 This variable contains the number of &'Received:'& header lines in the message,
13037 including the one added by Exim (so its value is always greater than zero). It
13038 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13039 delivering.
13040
13041 .vitem &$received_for$&
13042 .vindex "&$received_for$&"
13043 If there is only a single recipient address in an incoming message, this
13044 variable contains that address when the &'Received:'& header line is being
13045 built. The value is copied after recipient rewriting has happened, but before
13046 the &[local_scan()]& function is run.
13047
13048 .vitem &$received_ip_address$&
13049 .vindex "&$received_ip_address$&"
13050 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13051 variable is set to the address of the local IP interface, and &$received_port$&
13052 is set to the local port number. (The remote IP address and port are in
13053 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13054 the port value is -1 unless it has been set using the &%-oMi%& command line
13055 option.
13056
13057 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13058 could be used, for example, to make the filename for a TLS certificate depend
13059 on which interface and/or port is being used for the incoming connection. The
13060 values of &$received_ip_address$& and &$received_port$& are saved with any
13061 messages that are received, thus making these variables available at delivery
13062 time.
13063 For outbound connections see &$sending_ip_address$&.
13064
13065 .vitem &$received_port$&
13066 .vindex "&$received_port$&"
13067 See &$received_ip_address$&.
13068
13069 .vitem &$received_protocol$&
13070 .vindex "&$received_protocol$&"
13071 When a message is being processed, this variable contains the name of the
13072 protocol by which it was received. Most of the names used by Exim are defined
13073 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13074 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13075 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13076 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13077 connection and the client was successfully authenticated.
13078
13079 Exim uses the protocol name &"smtps"& for the case when encryption is
13080 automatically set up on connection without the use of STARTTLS (see
13081 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13082 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13083 where the client initially uses EHLO, sets up an encrypted connection using
13084 STARTTLS, and then uses HELO afterwards.
13085
13086 The &%-oMr%& option provides a way of specifying a custom protocol name for
13087 messages that are injected locally by trusted callers. This is commonly used to
13088 identify messages that are being re-injected after some kind of scanning.
13089
13090 .vitem &$received_time$&
13091 .vindex "&$received_time$&"
13092 This variable contains the date and time when the current message was received,
13093 as a number of seconds since the start of the Unix epoch.
13094
13095 .vitem &$recipient_data$&
13096 .vindex "&$recipient_data$&"
13097 This variable is set after an indexing lookup success in an ACL &%recipients%&
13098 condition. It contains the data from the lookup, and the value remains set
13099 until the next &%recipients%& test. Thus, you can do things like this:
13100 .display
13101 &`require recipients  = cdb*@;/some/file`&
13102 &`deny    `&&'some further test involving'& &`$recipient_data`&
13103 .endd
13104 &*Warning*&: This variable is set only when a lookup is used as an indexing
13105 method in the address list, using the semicolon syntax as in the example above.
13106 The variable is not set for a lookup that is used as part of the string
13107 expansion that all such lists undergo before being interpreted.
13108
13109 .vitem &$recipient_verify_failure$&
13110 .vindex "&$recipient_verify_failure$&"
13111 In an ACL, when a recipient verification fails, this variable contains
13112 information about the failure. It is set to one of the following words:
13113
13114 .ilist
13115 &"qualify"&: The address was unqualified (no domain), and the message
13116 was neither local nor came from an exempted host.
13117
13118 .next
13119 &"route"&: Routing failed.
13120
13121 .next
13122 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13123 or before the MAIL command (that is, on initial connection, HELO, or
13124 MAIL).
13125
13126 .next
13127 &"recipient"&: The RCPT command in a callout was rejected.
13128 .next
13129
13130 &"postmaster"&: The postmaster check in a callout was rejected.
13131 .endlist
13132
13133 The main use of this variable is expected to be to distinguish between
13134 rejections of MAIL and rejections of RCPT.
13135
13136 .vitem &$recipients$&
13137 .vindex "&$recipients$&"
13138 This variable contains a list of envelope recipients for a message. A comma and
13139 a space separate the addresses in the replacement text. However, the variable
13140 is not generally available, to prevent exposure of Bcc recipients in
13141 unprivileged users' filter files. You can use &$recipients$& only in these
13142 cases:
13143
13144 .olist
13145 In a system filter file.
13146 .next
13147 In the ACLs associated with the DATA command and with non-SMTP messages, that
13148 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13149 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13150 &%acl_not_smtp_mime%&.
13151 .next
13152 From within a &[local_scan()]& function.
13153 .endlist
13154
13155
13156 .vitem &$recipients_count$&
13157 .vindex "&$recipients_count$&"
13158 When a message is being processed, this variable contains the number of
13159 envelope recipients that came with the message. Duplicates are not excluded
13160 from the count. While a message is being received over SMTP, the number
13161 increases for each accepted recipient. It can be referenced in an ACL.
13162
13163
13164 .vitem &$regex_match_string$&
13165 .vindex "&$regex_match_string$&"
13166 This variable is set to contain the matching regular expression after a
13167 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13168
13169 .vitem "&$regex1$&, &$regex2$&, etc"
13170 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13171 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13172 these variables contain the
13173 captured substrings identified by the regular expression.
13174
13175
13176 .vitem &$reply_address$&
13177 .vindex "&$reply_address$&"
13178 When a message is being processed, this variable contains the contents of the
13179 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13180 contents of the &'From:'& header line. Apart from the removal of leading
13181 white space, the value is not processed in any way. In particular, no RFC 2047
13182 decoding or character code translation takes place.
13183
13184 .vitem &$return_path$&
13185 .vindex "&$return_path$&"
13186 When a message is being delivered, this variable contains the return path &--
13187 the sender field that will be sent as part of the envelope. It is not enclosed
13188 in <> characters. At the start of routing an address, &$return_path$& has the
13189 same value as &$sender_address$&, but if, for example, an incoming message to a
13190 mailing list has been expanded by a router which specifies a different address
13191 for bounce messages, &$return_path$& subsequently contains the new bounce
13192 address, whereas &$sender_address$& always contains the original sender address
13193 that was received with the message. In other words, &$sender_address$& contains
13194 the incoming envelope sender, and &$return_path$& contains the outgoing
13195 envelope sender.
13196
13197 .vitem &$return_size_limit$&
13198 .vindex "&$return_size_limit$&"
13199 This is an obsolete name for &$bounce_return_size_limit$&.
13200
13201 .vitem &$router_name$&
13202 .cindex "router" "name"
13203 .cindex "name" "of router"
13204 .vindex "&$router_name$&"
13205 During the running of a router this variable contains its name.
13206
13207 .vitem &$runrc$&
13208 .cindex "return code" "from &%run%& expansion"
13209 .vindex "&$runrc$&"
13210 This variable contains the return code from a command that is run by the
13211 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13212 assume the order in which option values are expanded, except for those
13213 preconditions whose order of testing is documented. Therefore, you cannot
13214 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13215 another.
13216
13217 .vitem &$self_hostname$&
13218 .oindex "&%self%&" "value of host name"
13219 .vindex "&$self_hostname$&"
13220 When an address is routed to a supposedly remote host that turns out to be the
13221 local host, what happens is controlled by the &%self%& generic router option.
13222 One of its values causes the address to be passed to another router. When this
13223 happens, &$self_hostname$& is set to the name of the local host that the
13224 original router encountered. In other circumstances its contents are null.
13225
13226 .vitem &$sender_address$&
13227 .vindex "&$sender_address$&"
13228 When a message is being processed, this variable contains the sender's address
13229 that was received in the message's envelope. The case of letters in the address
13230 is retained, in both the local part and the domain. For bounce messages, the
13231 value of this variable is the empty string. See also &$return_path$&.
13232
13233 .vitem &$sender_address_data$&
13234 .vindex "&$address_data$&"
13235 .vindex "&$sender_address_data$&"
13236 If &$address_data$& is set when the routers are called from an ACL to verify a
13237 sender address, the final value is preserved in &$sender_address_data$&, to
13238 distinguish it from data from a recipient address. The value does not persist
13239 after the end of the current ACL statement. If you want to preserve it for
13240 longer, you can save it in an ACL variable.
13241
13242 .vitem &$sender_address_domain$&
13243 .vindex "&$sender_address_domain$&"
13244 The domain portion of &$sender_address$&.
13245
13246 .vitem &$sender_address_local_part$&
13247 .vindex "&$sender_address_local_part$&"
13248 The local part portion of &$sender_address$&.
13249
13250 .vitem &$sender_data$&
13251 .vindex "&$sender_data$&"
13252 This variable is set after a lookup success in an ACL &%senders%& condition or
13253 in a router &%senders%& option. It contains the data from the lookup, and the
13254 value remains set until the next &%senders%& test. Thus, you can do things like
13255 this:
13256 .display
13257 &`require senders      = cdb*@;/some/file`&
13258 &`deny    `&&'some further test involving'& &`$sender_data`&
13259 .endd
13260 &*Warning*&: This variable is set only when a lookup is used as an indexing
13261 method in the address list, using the semicolon syntax as in the example above.
13262 The variable is not set for a lookup that is used as part of the string
13263 expansion that all such lists undergo before being interpreted.
13264
13265 .vitem &$sender_fullhost$&
13266 .vindex "&$sender_fullhost$&"
13267 When a message is received from a remote host, this variable contains the host
13268 name and IP address in a single string. It ends with the IP address in square
13269 brackets, followed by a colon and a port number if the logging of ports is
13270 enabled. The format of the rest of the string depends on whether the host
13271 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13272 looking up its IP address. (Looking up the IP address can be forced by the
13273 &%host_lookup%& option, independent of verification.) A plain host name at the
13274 start of the string is a verified host name; if this is not present,
13275 verification either failed or was not requested. A host name in parentheses is
13276 the argument of a HELO or EHLO command. This is omitted if it is identical to
13277 the verified host name or to the host's IP address in square brackets.
13278
13279 .vitem &$sender_helo_dnssec$&
13280 .vindex "&$sender_helo_dnssec$&"
13281 This boolean variable is true if a successful HELO verification was
13282 .cindex "DNS" "DNSSEC"
13283 done using DNS information the resolver library stated was authenticated data.
13284
13285 .vitem &$sender_helo_name$&
13286 .vindex "&$sender_helo_name$&"
13287 When a message is received from a remote host that has issued a HELO or EHLO
13288 command, the argument of that command is placed in this variable. It is also
13289 set if HELO or EHLO is used when a message is received using SMTP locally via
13290 the &%-bs%& or &%-bS%& options.
13291
13292 .vitem &$sender_host_address$&
13293 .vindex "&$sender_host_address$&"
13294 When a message is received from a remote host using SMTP,
13295 this variable contains that
13296 host's IP address. For locally non-SMTP submitted messages, it is empty.
13297
13298 .vitem &$sender_host_authenticated$&
13299 .vindex "&$sender_host_authenticated$&"
13300 This variable contains the name (not the public name) of the authenticator
13301 driver that successfully authenticated the client from which the message was
13302 received. It is empty if there was no successful authentication. See also
13303 &$authenticated_id$&.
13304
13305 .vitem &$sender_host_dnssec$&
13306 .vindex "&$sender_host_dnssec$&"
13307 If an attempt to populate &$sender_host_name$& has been made
13308 (by reference, &%hosts_lookup%& or
13309 otherwise) then this boolean will have been set true if, and only if, the
13310 resolver library states that both
13311 the reverse and forward DNS were authenticated data.  At all
13312 other times, this variable is false.
13313
13314 .cindex "DNS" "DNSSEC"
13315 It is likely that you will need to coerce DNSSEC support on in the resolver
13316 library, by setting:
13317 .code
13318 dns_dnssec_ok = 1
13319 .endd
13320
13321 Exim does not perform DNSSEC validation itself, instead leaving that to a
13322 validating resolver (e.g. unbound, or bind with suitable configuration).
13323
13324 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13325 mechanism in the list, then this variable will be false.
13326
13327 This requires that your system resolver library support EDNS0 (and that
13328 DNSSEC flags exist in the system headers).  If the resolver silently drops
13329 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13330 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13331
13332
13333 .vitem &$sender_host_name$&
13334 .vindex "&$sender_host_name$&"
13335 When a message is received from a remote host, this variable contains the
13336 host's name as obtained by looking up its IP address. For messages received by
13337 other means, this variable is empty.
13338
13339 .vindex "&$host_lookup_failed$&"
13340 If the host name has not previously been looked up, a reference to
13341 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13342 A looked up name is accepted only if it leads back to the original IP address
13343 via a forward lookup. If either the reverse or the forward lookup fails to find
13344 any data, or if the forward lookup does not yield the original IP address,
13345 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13346
13347 .vindex "&$host_lookup_deferred$&"
13348 However, if either of the lookups cannot be completed (for example, there is a
13349 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13350 &$host_lookup_failed$& remains set to &"0"&.
13351
13352 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13353 host name again if there is a subsequent reference to &$sender_host_name$&
13354 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13355 is set to &"1"&.
13356
13357 Exim does not automatically look up every calling host's name. If you want
13358 maximum efficiency, you should arrange your configuration so that it avoids
13359 these lookups altogether. The lookup happens only if one or more of the
13360 following are true:
13361
13362 .ilist
13363 A string containing &$sender_host_name$& is expanded.
13364 .next
13365 The calling host matches the list in &%host_lookup%&. In the default
13366 configuration, this option is set to *, so it must be changed if lookups are
13367 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13368 .next
13369 Exim needs the host name in order to test an item in a host list. The items
13370 that require this are described in sections &<<SECThoslispatnam>>& and
13371 &<<SECThoslispatnamsk>>&.
13372 .next
13373 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13374 In this case, the host name is required to compare with the name quoted in any
13375 EHLO or HELO commands that the client issues.
13376 .next
13377 The remote host issues a EHLO or HELO command that quotes one of the
13378 domains in &%helo_lookup_domains%&. The default value of this option is
13379 . ==== As this is a nested list, any displays it contains must be indented
13380 . ==== as otherwise they are too far to the left.
13381 .code
13382   helo_lookup_domains = @ : @[]
13383 .endd
13384 which causes a lookup if a remote host (incorrectly) gives the server's name or
13385 IP address in an EHLO or HELO command.
13386 .endlist
13387
13388
13389 .vitem &$sender_host_port$&
13390 .vindex "&$sender_host_port$&"
13391 When a message is received from a remote host, this variable contains the port
13392 number that was used on the remote host.
13393
13394 .vitem &$sender_ident$&
13395 .vindex "&$sender_ident$&"
13396 When a message is received from a remote host, this variable contains the
13397 identification received in response to an RFC 1413 request. When a message has
13398 been received locally, this variable contains the login name of the user that
13399 called Exim.
13400
13401 .vitem &$sender_rate_$&&'xxx'&
13402 A number of variables whose names begin &$sender_rate_$& are set as part of the
13403 &%ratelimit%& ACL condition. Details are given in section
13404 &<<SECTratelimiting>>&.
13405
13406 .vitem &$sender_rcvhost$&
13407 .cindex "DNS" "reverse lookup"
13408 .cindex "reverse DNS lookup"
13409 .vindex "&$sender_rcvhost$&"
13410 This is provided specifically for use in &'Received:'& headers. It starts with
13411 either the verified host name (as obtained from a reverse DNS lookup) or, if
13412 there is no verified host name, the IP address in square brackets. After that
13413 there may be text in parentheses. When the first item is a verified host name,
13414 the first thing in the parentheses is the IP address in square brackets,
13415 followed by a colon and a port number if port logging is enabled. When the
13416 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13417 the parentheses.
13418
13419 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13420 was used and its argument was not identical to the real host name or IP
13421 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13422 all three items are present in the parentheses, a newline and tab are inserted
13423 into the string, to improve the formatting of the &'Received:'& header.
13424
13425 .vitem &$sender_verify_failure$&
13426 .vindex "&$sender_verify_failure$&"
13427 In an ACL, when a sender verification fails, this variable contains information
13428 about the failure. The details are the same as for
13429 &$recipient_verify_failure$&.
13430
13431 .vitem &$sending_ip_address$&
13432 .vindex "&$sending_ip_address$&"
13433 This variable is set whenever an outgoing SMTP connection to another host has
13434 been set up. It contains the IP address of the local interface that is being
13435 used. This is useful if a host that has more than one IP address wants to take
13436 on different personalities depending on which one is being used. For incoming
13437 connections, see &$received_ip_address$&.
13438
13439 .vitem &$sending_port$&
13440 .vindex "&$sending_port$&"
13441 This variable is set whenever an outgoing SMTP connection to another host has
13442 been set up. It contains the local port that is being used. For incoming
13443 connections, see &$received_port$&.
13444
13445 .vitem &$smtp_active_hostname$&
13446 .vindex "&$smtp_active_hostname$&"
13447 During an incoming SMTP session, this variable contains the value of the active
13448 host name, as specified by the &%smtp_active_hostname%& option. The value of
13449 &$smtp_active_hostname$& is saved with any message that is received, so its
13450 value can be consulted during routing and delivery.
13451
13452 .vitem &$smtp_command$&
13453 .vindex "&$smtp_command$&"
13454 During the processing of an incoming SMTP command, this variable contains the
13455 entire command. This makes it possible to distinguish between HELO and EHLO in
13456 the HELO ACL, and also to distinguish between commands such as these:
13457 .code
13458 MAIL FROM:<>
13459 MAIL FROM: <>
13460 .endd
13461 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13462 command, the address in &$smtp_command$& is the original address before any
13463 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13464 the address after SMTP-time rewriting.
13465
13466 .vitem &$smtp_command_argument$&
13467 .cindex "SMTP" "command, argument for"
13468 .vindex "&$smtp_command_argument$&"
13469 While an ACL is running to check an SMTP command, this variable contains the
13470 argument, that is, the text that follows the command name, with leading white
13471 space removed. Following the introduction of &$smtp_command$&, this variable is
13472 somewhat redundant, but is retained for backwards compatibility.
13473
13474 .vitem &$smtp_command_history$&
13475 .cindex SMTP "command history"
13476 .vindex "&$smtp_command_history$&"
13477 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13478 received, in time-order left to right.  Only a limited number of commands
13479 are remembered.
13480
13481 .vitem &$smtp_count_at_connection_start$&
13482 .vindex "&$smtp_count_at_connection_start$&"
13483 This variable is set greater than zero only in processes spawned by the Exim
13484 daemon for handling incoming SMTP connections. The name is deliberately long,
13485 in order to emphasize what the contents are. When the daemon accepts a new
13486 connection, it increments this variable. A copy of the variable is passed to
13487 the child process that handles the connection, but its value is fixed, and
13488 never changes. It is only an approximation of how many incoming connections
13489 there actually are, because many other connections may come and go while a
13490 single connection is being processed. When a child process terminates, the
13491 daemon decrements its copy of the variable.
13492
13493 .vitem "&$sn0$& &-- &$sn9$&"
13494 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13495 that were current at the end of the system filter file. This allows a system
13496 filter file to set values that can be tested in users' filter files. For
13497 example, a system filter could set a value indicating how likely it is that a
13498 message is junk mail.
13499
13500 .vitem &$spam_$&&'xxx'&
13501 A number of variables whose names start with &$spam$& are available when Exim
13502 is compiled with the content-scanning extension. For details, see section
13503 &<<SECTscanspamass>>&.
13504
13505 .vitem &$spf_header_comment$& &&&
13506        &$spf_received$& &&&
13507        &$spf_result$& &&&
13508        &$spf_result_guessed$& &&&
13509        &$spf_smtp_comment$&
13510 These variables are only available if Exim is built with SPF support.
13511 For details see section &<<SECSPF>>&.
13512
13513 .vitem &$spool_directory$&
13514 .vindex "&$spool_directory$&"
13515 The name of Exim's spool directory.
13516
13517 .vitem &$spool_inodes$&
13518 .vindex "&$spool_inodes$&"
13519 The number of free inodes in the disk partition where Exim's spool files are
13520 being written. The value is recalculated whenever the variable is referenced.
13521 If the relevant file system does not have the concept of inodes, the value of
13522 is -1. See also the &%check_spool_inodes%& option.
13523
13524 .vitem &$spool_space$&
13525 .vindex "&$spool_space$&"
13526 The amount of free space (as a number of kilobytes) in the disk partition where
13527 Exim's spool files are being written. The value is recalculated whenever the
13528 variable is referenced. If the operating system does not have the ability to
13529 find the amount of free space (only true for experimental systems), the space
13530 value is -1. For example, to check in an ACL that there is at least 50
13531 megabytes free on the spool, you could write:
13532 .code
13533 condition = ${if > {$spool_space}{50000}}
13534 .endd
13535 See also the &%check_spool_space%& option.
13536
13537
13538 .vitem &$thisaddress$&
13539 .vindex "&$thisaddress$&"
13540 This variable is set only during the processing of the &%foranyaddress%&
13541 command in a filter file. Its use is explained in the description of that
13542 command, which can be found in the separate document entitled &'Exim's
13543 interfaces to mail filtering'&.
13544
13545 .vitem &$tls_in_bits$&
13546 .vindex "&$tls_in_bits$&"
13547 Contains an approximation of the TLS cipher's bit-strength
13548 on the inbound connection; the meaning of
13549 this depends upon the TLS implementation used.
13550 If TLS has not been negotiated, the value will be 0.
13551 The value of this is automatically fed into the Cyrus SASL authenticator
13552 when acting as a server, to specify the "external SSF" (a SASL term).
13553
13554 The deprecated &$tls_bits$& variable refers to the inbound side
13555 except when used in the context of an outbound SMTP delivery, when it refers to
13556 the outbound.
13557
13558 .vitem &$tls_out_bits$&
13559 .vindex "&$tls_out_bits$&"
13560 Contains an approximation of the TLS cipher's bit-strength
13561 on an outbound SMTP connection; the meaning of
13562 this depends upon the TLS implementation used.
13563 If TLS has not been negotiated, the value will be 0.
13564
13565 .vitem &$tls_in_ourcert$&
13566 .vindex "&$tls_in_ourcert$&"
13567 .cindex certificate variables
13568 This variable refers to the certificate presented to the peer of an
13569 inbound connection when the message was received.
13570 It is only useful as the argument of a
13571 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13572 or a &%def%& condition.
13573
13574 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13575 when a list of more than one
13576 file is used for &%tls_certificate%&, this variable is not reliable.
13577 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13578
13579 .vitem &$tls_in_peercert$&
13580 .vindex "&$tls_in_peercert$&"
13581 This variable refers to the certificate presented by the peer of an
13582 inbound connection when the message was received.
13583 It is only useful as the argument of a
13584 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13585 or a &%def%& condition.
13586 If certificate verification fails it may refer to a failing chain element
13587 which is not the leaf.
13588
13589 .vitem &$tls_out_ourcert$&
13590 .vindex "&$tls_out_ourcert$&"
13591 This variable refers to the certificate presented to the peer of an
13592 outbound connection.  It is only useful as the argument of a
13593 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13594 or a &%def%& condition.
13595
13596 .vitem &$tls_out_peercert$&
13597 .vindex "&$tls_out_peercert$&"
13598 This variable refers to the certificate presented by the peer of an
13599 outbound connection.  It is only useful as the argument of a
13600 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13601 or a &%def%& condition.
13602 If certificate verification fails it may refer to a failing chain element
13603 which is not the leaf.
13604
13605 .vitem &$tls_in_certificate_verified$&
13606 .vindex "&$tls_in_certificate_verified$&"
13607 This variable is set to &"1"& if a TLS certificate was verified when the
13608 message was received, and &"0"& otherwise.
13609
13610 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13611 except when used in the context of an outbound SMTP delivery, when it refers to
13612 the outbound.
13613
13614 .vitem &$tls_out_certificate_verified$&
13615 .vindex "&$tls_out_certificate_verified$&"
13616 This variable is set to &"1"& if a TLS certificate was verified when an
13617 outbound SMTP connection was made,
13618 and &"0"& otherwise.
13619
13620 .vitem &$tls_in_cipher$&
13621 .vindex "&$tls_in_cipher$&"
13622 .vindex "&$tls_cipher$&"
13623 When a message is received from a remote host over an encrypted SMTP
13624 connection, this variable is set to the cipher suite that was negotiated, for
13625 example DES-CBC3-SHA. In other circumstances, in particular, for message
13626 received over unencrypted connections, the variable is empty. Testing
13627 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13628 non-encrypted connections during ACL processing.
13629
13630 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13631 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13632 becomes the same as &$tls_out_cipher$&.
13633
13634 .vitem &$tls_in_cipher_std$&
13635 .vindex "&$tls_in_cipher_std$&"
13636 As above, but returning the RFC standard name for the cipher suite.
13637
13638 .vitem &$tls_out_cipher$&
13639 .vindex "&$tls_out_cipher$&"
13640 This variable is
13641 cleared before any outgoing SMTP connection is made,
13642 and then set to the outgoing cipher suite if one is negotiated. See chapter
13643 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13644 details of the &(smtp)& transport.
13645
13646 .vitem &$tls_out_cipher_std$&
13647 .vindex "&$tls_out_cipher_std$&"
13648 As above, but returning the RFC standard name for the cipher suite.
13649
13650 .vitem &$tls_out_dane$&
13651 .vindex &$tls_out_dane$&
13652 DANE active status.  See section &<<SECDANE>>&.
13653
13654 .vitem &$tls_in_ocsp$&
13655 .vindex "&$tls_in_ocsp$&"
13656 When a message is received from a remote client connection
13657 the result of any OCSP request from the client is encoded in this variable:
13658 .code
13659 0 OCSP proof was not requested (default value)
13660 1 No response to request
13661 2 Response not verified
13662 3 Verification failed
13663 4 Verification succeeded
13664 .endd
13665
13666 .vitem &$tls_out_ocsp$&
13667 .vindex "&$tls_out_ocsp$&"
13668 When a message is sent to a remote host connection
13669 the result of any OCSP request made is encoded in this variable.
13670 See &$tls_in_ocsp$& for values.
13671
13672 .vitem &$tls_in_peerdn$&
13673 .vindex "&$tls_in_peerdn$&"
13674 .vindex "&$tls_peerdn$&"
13675 .cindex certificate "extracting fields"
13676 When a message is received from a remote host over an encrypted SMTP
13677 connection, and Exim is configured to request a certificate from the client,
13678 the value of the Distinguished Name of the certificate is made available in the
13679 &$tls_in_peerdn$& during subsequent processing.
13680 If certificate verification fails it may refer to a failing chain element
13681 which is not the leaf.
13682
13683 The deprecated &$tls_peerdn$& variable refers to the inbound side
13684 except when used in the context of an outbound SMTP delivery, when it refers to
13685 the outbound.
13686
13687 .vitem &$tls_out_peerdn$&
13688 .vindex "&$tls_out_peerdn$&"
13689 When a message is being delivered to a remote host over an encrypted SMTP
13690 connection, and Exim is configured to request a certificate from the server,
13691 the value of the Distinguished Name of the certificate is made available in the
13692 &$tls_out_peerdn$& during subsequent processing.
13693 If certificate verification fails it may refer to a failing chain element
13694 which is not the leaf.
13695
13696 .vitem &$tls_in_sni$&
13697 .vindex "&$tls_in_sni$&"
13698 .vindex "&$tls_sni$&"
13699 .cindex "TLS" "Server Name Indication"
13700 When a TLS session is being established, if the client sends the Server
13701 Name Indication extension, the value will be placed in this variable.
13702 If the variable appears in &%tls_certificate%& then this option and
13703 some others, described in &<<SECTtlssni>>&,
13704 will be re-expanded early in the TLS session, to permit
13705 a different certificate to be presented (and optionally a different key to be
13706 used) to the client, based upon the value of the SNI extension.
13707
13708 The deprecated &$tls_sni$& variable refers to the inbound side
13709 except when used in the context of an outbound SMTP delivery, when it refers to
13710 the outbound.
13711
13712 .vitem &$tls_out_sni$&
13713 .vindex "&$tls_out_sni$&"
13714 .cindex "TLS" "Server Name Indication"
13715 During outbound
13716 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13717 the transport.
13718
13719 .vitem &$tls_out_tlsa_usage$&
13720 .vindex &$tls_out_tlsa_usage$&
13721 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13722
13723 .vitem &$tls_in_ver$&
13724 .vindex "&$tls_in_ver$&"
13725 When a message is received from a remote host over an encrypted SMTP connection
13726 this variable is set to the protocol version, eg &'TLS1.2'&.
13727
13728 .vitem &$tls_out_ver$&
13729 .vindex "&$tls_out_ver$&"
13730 When a message is being delivered to a remote host over an encrypted SMTP connection
13731 this variable is set to the protocol version.
13732
13733
13734 .vitem &$tod_bsdinbox$&
13735 .vindex "&$tod_bsdinbox$&"
13736 The time of day and the date, in the format required for BSD-style mailbox
13737 files, for example: Thu Oct 17 17:14:09 1995.
13738
13739 .vitem &$tod_epoch$&
13740 .vindex "&$tod_epoch$&"
13741 The time and date as a number of seconds since the start of the Unix epoch.
13742
13743 .vitem &$tod_epoch_l$&
13744 .vindex "&$tod_epoch_l$&"
13745 The time and date as a number of microseconds since the start of the Unix epoch.
13746
13747 .vitem &$tod_full$&
13748 .vindex "&$tod_full$&"
13749 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13750 +0100. The timezone is always given as a numerical offset from UTC, with
13751 positive values used for timezones that are ahead (east) of UTC, and negative
13752 values for those that are behind (west).
13753
13754 .vitem &$tod_log$&
13755 .vindex "&$tod_log$&"
13756 The time and date in the format used for writing Exim's log files, for example:
13757 1995-10-12 15:32:29, but without a timezone.
13758
13759 .vitem &$tod_logfile$&
13760 .vindex "&$tod_logfile$&"
13761 This variable contains the date in the format yyyymmdd. This is the format that
13762 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13763 flag.
13764
13765 .vitem &$tod_zone$&
13766 .vindex "&$tod_zone$&"
13767 This variable contains the numerical value of the local timezone, for example:
13768 -0500.
13769
13770 .vitem &$tod_zulu$&
13771 .vindex "&$tod_zulu$&"
13772 This variable contains the UTC date and time in &"Zulu"& format, as specified
13773 by ISO 8601, for example: 20030221154023Z.
13774
13775 .vitem &$transport_name$&
13776 .cindex "transport" "name"
13777 .cindex "name" "of transport"
13778 .vindex "&$transport_name$&"
13779 During the running of a transport, this variable contains its name.
13780
13781 .vitem &$value$&
13782 .vindex "&$value$&"
13783 This variable contains the result of an expansion lookup, extraction operation,
13784 or external command, as described above. It is also used during a
13785 &*reduce*& expansion.
13786
13787 .vitem &$verify_mode$&
13788 .vindex "&$verify_mode$&"
13789 While a router or transport is being run in verify mode or for cutthrough delivery,
13790 contains "S" for sender-verification or "R" for recipient-verification.
13791 Otherwise, empty.
13792
13793 .vitem &$version_number$&
13794 .vindex "&$version_number$&"
13795 The version number of Exim. Same as &$exim_version$&, may be overridden
13796 by the &%exim_version%& main config option.
13797
13798 .vitem &$warn_message_delay$&
13799 .vindex "&$warn_message_delay$&"
13800 This variable is set only during the creation of a message warning about a
13801 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13802
13803 .vitem &$warn_message_recipients$&
13804 .vindex "&$warn_message_recipients$&"
13805 This variable is set only during the creation of a message warning about a
13806 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13807 .endlist
13808 .ecindex IIDstrexp
13809
13810
13811
13812 . ////////////////////////////////////////////////////////////////////////////
13813 . ////////////////////////////////////////////////////////////////////////////
13814
13815 .chapter "Embedded Perl" "CHAPperl"
13816 .scindex IIDperl "Perl" "calling from Exim"
13817 Exim can be built to include an embedded Perl interpreter. When this is done,
13818 Perl subroutines can be called as part of the string expansion process. To make
13819 use of the Perl support, you need version 5.004 or later of Perl installed on
13820 your system. To include the embedded interpreter in the Exim binary, include
13821 the line
13822 .code
13823 EXIM_PERL = perl.o
13824 .endd
13825 in your &_Local/Makefile_& and then build Exim in the normal way.
13826
13827
13828 .section "Setting up so Perl can be used" "SECID85"
13829 .oindex "&%perl_startup%&"
13830 Access to Perl subroutines is via a global configuration option called
13831 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13832 no &%perl_startup%& option in the Exim configuration file then no Perl
13833 interpreter is started and there is almost no overhead for Exim (since none of
13834 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13835 option then the associated value is taken to be Perl code which is executed in
13836 a newly created Perl interpreter.
13837
13838 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13839 need backslashes before any characters to escape special meanings. The option
13840 should usually be something like
13841 .code
13842 perl_startup = do '/etc/exim.pl'
13843 .endd
13844 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13845 use from Exim. Exim can be configured either to start up a Perl interpreter as
13846 soon as it is entered, or to wait until the first time it is needed. Starting
13847 the interpreter at the beginning ensures that it is done while Exim still has
13848 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13849 fact used in a particular run. Also, note that this does not mean that Exim is
13850 necessarily running as root when Perl is called at a later time. By default,
13851 the interpreter is started only when it is needed, but this can be changed in
13852 two ways:
13853
13854 .ilist
13855 .oindex "&%perl_at_start%&"
13856 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13857 a startup when Exim is entered.
13858 .next
13859 The command line option &%-ps%& also requests a startup when Exim is entered,
13860 overriding the setting of &%perl_at_start%&.
13861 .endlist
13862
13863 There is also a command line option &%-pd%& (for delay) which suppresses the
13864 initial startup, even if &%perl_at_start%& is set.
13865
13866 .ilist
13867 .oindex "&%perl_taintmode%&"
13868 .cindex "Perl" "taintmode"
13869 To provide more security executing Perl code via the embedded Perl
13870 interpreter, the &%perl_taintmode%& option can be set. This enables the
13871 taint mode of the Perl interpreter. You are encouraged to set this
13872 option to a true value. To avoid breaking existing installations, it
13873 defaults to false.
13874
13875
13876 .section "Calling Perl subroutines" "SECID86"
13877 When the configuration file includes a &%perl_startup%& option you can make use
13878 of the string expansion item to call the Perl subroutines that are defined
13879 by the &%perl_startup%& code. The operator is used in any of the following
13880 forms:
13881 .code
13882 ${perl{foo}}
13883 ${perl{foo}{argument}}
13884 ${perl{foo}{argument1}{argument2} ... }
13885 .endd
13886 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13887 arguments may be passed. Passing more than this results in an expansion failure
13888 with an error message of the form
13889 .code
13890 Too many arguments passed to Perl subroutine "foo" (max is 8)
13891 .endd
13892 The return value of the Perl subroutine is evaluated in a scalar context before
13893 it is passed back to Exim to be inserted into the expanded string. If the
13894 return value is &'undef'&, the expansion is forced to fail in the same way as
13895 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13896 by obeying Perl's &%die%& function, the expansion fails with the error message
13897 that was passed to &%die%&.
13898
13899
13900 .section "Calling Exim functions from Perl" "SECID87"
13901 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13902 is available to call back into Exim's string expansion function. For example,
13903 the Perl code
13904 .code
13905 my $lp = Exim::expand_string('$local_part');
13906 .endd
13907 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13908 Note those are single quotes and not double quotes to protect against
13909 &$local_part$& being interpolated as a Perl variable.
13910
13911 If the string expansion is forced to fail by a &"fail"& item, the result of
13912 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13913 expansion string, the Perl call from the original expansion string fails with
13914 an appropriate error message, in the same way as if &%die%& were used.
13915
13916 .cindex "debugging" "from embedded Perl"
13917 .cindex "log" "writing from embedded Perl"
13918 Two other Exim functions are available for use from within Perl code.
13919 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13920 debugging is enabled. If you want a newline at the end, you must supply it.
13921 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13922 timestamp. In this case, you should not supply a terminating newline.
13923
13924
13925 .section "Use of standard output and error by Perl" "SECID88"
13926 .cindex "Perl" "standard output and error"
13927 You should not write to the standard error or output streams from within your
13928 Perl code, as it is not defined how these are set up. In versions of Exim
13929 before 4.50, it is possible for the standard output or error to refer to the
13930 SMTP connection during message reception via the daemon. Writing to this stream
13931 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13932 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13933 avoided, but the output is lost.
13934
13935 .cindex "Perl" "use of &%warn%&"
13936 The Perl &%warn%& statement writes to the standard error stream by default.
13937 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13938 you have no control. When Exim starts up the Perl interpreter, it arranges for
13939 output from the &%warn%& statement to be written to the Exim main log. You can
13940 change this by including appropriate Perl magic somewhere in your Perl code.
13941 For example, to discard &%warn%& output completely, you need this:
13942 .code
13943 $SIG{__WARN__} = sub { };
13944 .endd
13945 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13946 example, the code for the subroutine is empty, so it does nothing, but you can
13947 include any Perl code that you like. The text of the &%warn%& message is passed
13948 as the first subroutine argument.
13949 .ecindex IIDperl
13950
13951
13952 . ////////////////////////////////////////////////////////////////////////////
13953 . ////////////////////////////////////////////////////////////////////////////
13954
13955 .chapter "Starting the daemon and the use of network interfaces" &&&
13956          "CHAPinterfaces" &&&
13957          "Starting the daemon"
13958 .cindex "daemon" "starting"
13959 .cindex "interface" "listening"
13960 .cindex "network interface"
13961 .cindex "interface" "network"
13962 .cindex "IP address" "for listening"
13963 .cindex "daemon" "listening IP addresses"
13964 .cindex "TCP/IP" "setting listening interfaces"
13965 .cindex "TCP/IP" "setting listening ports"
13966 A host that is connected to a TCP/IP network may have one or more physical
13967 hardware network interfaces. Each of these interfaces may be configured as one
13968 or more &"logical"& interfaces, which are the entities that a program actually
13969 works with. Each of these logical interfaces is associated with an IP address.
13970 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13971 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13972 knowledge about the host's interfaces for use in three different circumstances:
13973
13974 .olist
13975 When a listening daemon is started, Exim needs to know which interfaces
13976 and ports to listen on.
13977 .next
13978 When Exim is routing an address, it needs to know which IP addresses
13979 are associated with local interfaces. This is required for the correct
13980 processing of MX lists by removing the local host and others with the
13981 same or higher priority values. Also, Exim needs to detect cases
13982 when an address is routed to an IP address that in fact belongs to the
13983 local host. Unless the &%self%& router option or the &%allow_localhost%&
13984 option of the smtp transport is set (as appropriate), this is treated
13985 as an error situation.
13986 .next
13987 When Exim connects to a remote host, it may need to know which interface to use
13988 for the outgoing connection.
13989 .endlist
13990
13991
13992 Exim's default behaviour is likely to be appropriate in the vast majority
13993 of cases. If your host has only one interface, and you want all its IP
13994 addresses to be treated in the same way, and you are using only the
13995 standard SMTP port, you should not need to take any special action. The
13996 rest of this chapter does not apply to you.
13997
13998 In a more complicated situation you may want to listen only on certain
13999 interfaces, or on different ports, and for this reason there are a number of
14000 options that can be used to influence Exim's behaviour. The rest of this
14001 chapter describes how they operate.
14002
14003 When a message is received over TCP/IP, the interface and port that were
14004 actually used are set in &$received_ip_address$& and &$received_port$&.
14005
14006
14007
14008 .section "Starting a listening daemon" "SECID89"
14009 When a listening daemon is started (by means of the &%-bd%& command line
14010 option), the interfaces and ports on which it listens are controlled by the
14011 following options:
14012
14013 .ilist
14014 &%daemon_smtp_ports%& contains a list of default ports
14015 or service names.
14016 (For backward compatibility, this option can also be specified in the singular.)
14017 .next
14018 &%local_interfaces%& contains list of interface IP addresses on which to
14019 listen. Each item may optionally also specify a port.
14020 .endlist
14021
14022 The default list separator in both cases is a colon, but this can be changed as
14023 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14024 it is usually best to change the separator to avoid having to double all the
14025 colons. For example:
14026 .code
14027 local_interfaces = <; 127.0.0.1 ; \
14028                       192.168.23.65 ; \
14029                       ::1 ; \
14030                       3ffe:ffff:836f::fe86:a061
14031 .endd
14032 There are two different formats for specifying a port along with an IP address
14033 in &%local_interfaces%&:
14034
14035 .olist
14036 The port is added onto the address with a dot separator. For example, to listen
14037 on port 1234 on two different IP addresses:
14038 .code
14039 local_interfaces = <; 192.168.23.65.1234 ; \
14040                       3ffe:ffff:836f::fe86:a061.1234
14041 .endd
14042 .next
14043 The IP address is enclosed in square brackets, and the port is added
14044 with a colon separator, for example:
14045 .code
14046 local_interfaces = <; [192.168.23.65]:1234 ; \
14047                       [3ffe:ffff:836f::fe86:a061]:1234
14048 .endd
14049 .endlist
14050
14051 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14052 default setting contains just one port:
14053 .code
14054 daemon_smtp_ports = smtp
14055 .endd
14056 If more than one port is listed, each interface that does not have its own port
14057 specified listens on all of them. Ports that are listed in
14058 &%daemon_smtp_ports%& can be identified either by name (defined in
14059 &_/etc/services_&) or by number. However, when ports are given with individual
14060 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14061
14062
14063
14064 .section "Special IP listening addresses" "SECID90"
14065 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14066 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14067 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14068 instead of setting up separate listening sockets for each interface. The
14069 default value of &%local_interfaces%& is
14070 .code
14071 local_interfaces = 0.0.0.0
14072 .endd
14073 when Exim is built without IPv6 support; otherwise it is:
14074 .code
14075 local_interfaces = <; ::0 ; 0.0.0.0
14076 .endd
14077 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14078
14079
14080
14081 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14082 The &%-oX%& command line option can be used to override the values of
14083 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14084 instance. Another way of doing this would be to use macros and the &%-D%&
14085 option. However, &%-oX%& can be used by any admin user, whereas modification of
14086 the runtime configuration by &%-D%& is allowed only when the caller is root or
14087 exim.
14088
14089 The value of &%-oX%& is a list of items. The default colon separator can be
14090 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14091 If there are any items that do not
14092 contain dots or colons (that is, are not IP addresses), the value of
14093 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14094 items that do contain dots or colons, the value of &%local_interfaces%& is
14095 replaced by those items. Thus, for example,
14096 .code
14097 -oX 1225
14098 .endd
14099 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14100 whereas
14101 .code
14102 -oX 192.168.34.5.1125
14103 .endd
14104 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14105 (However, since &%local_interfaces%& now contains no items without ports, the
14106 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14107
14108
14109
14110 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14111 .cindex "submissions protocol"
14112 .cindex "ssmtp protocol"
14113 .cindex "smtps protocol"
14114 .cindex "SMTP" "ssmtp protocol"
14115 .cindex "SMTP" "smtps protocol"
14116 Exim supports the use of TLS-on-connect, used by mail clients in the
14117 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14118 For some years, IETF Standards Track documents only blessed the
14119 STARTTLS-based Submission service (port 587) while common practice was to support
14120 the same feature set on port 465, but using TLS-on-connect.
14121 If your installation needs to provide service to mail clients
14122 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14123 the 465 TCP ports.
14124
14125 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14126 service names, connections to those ports must first establish TLS, before
14127 proceeding to the application layer use of the SMTP protocol.
14128
14129 The common use of this option is expected to be
14130 .code
14131 tls_on_connect_ports = 465
14132 .endd
14133 per RFC 8314.
14134 There is also a command line option &%-tls-on-connect%&, which forces all ports
14135 to behave in this way when a daemon is started.
14136
14137 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14138 daemon to listen on those ports. You must still specify them in
14139 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14140 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14141 connections via the daemon.)
14142
14143
14144
14145
14146 .section "IPv6 address scopes" "SECID92"
14147 .cindex "IPv6" "address scopes"
14148 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14149 can, in principle, have the same link-local IPv6 address on different
14150 interfaces. Thus, additional information is needed, over and above the IP
14151 address, to distinguish individual interfaces. A convention of using a
14152 percent sign followed by something (often the interface name) has been
14153 adopted in some cases, leading to addresses like this:
14154 .code
14155 fe80::202:b3ff:fe03:45c1%eth0
14156 .endd
14157 To accommodate this usage, a percent sign followed by an arbitrary string is
14158 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14159 to convert a textual IPv6 address for actual use. This function recognizes the
14160 percent convention in operating systems that support it, and it processes the
14161 address appropriately. Unfortunately, some older libraries have problems with
14162 &[getaddrinfo()]&. If
14163 .code
14164 IPV6_USE_INET_PTON=yes
14165 .endd
14166 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14167 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14168 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14169 function.) Of course, this means that the additional functionality of
14170 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14171
14172 .section "Disabling IPv6" "SECID93"
14173 .cindex "IPv6" "disabling"
14174 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14175 run on a host whose kernel does not support IPv6. The binary will fall back to
14176 using IPv4, but it may waste resources looking up AAAA records, and trying to
14177 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14178 .oindex "&%disable_ipv6%&"
14179 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14180 activities take place. AAAA records are never looked up, and any IPv6 addresses
14181 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14182 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14183 to handle IPv6 literal addresses.
14184
14185 On the other hand, when IPv6 is in use, there may be times when you want to
14186 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14187 option to globally suppress the lookup of AAAA records for specified domains,
14188 and you can use the &%ignore_target_hosts%& generic router option to ignore
14189 IPv6 addresses in an individual router.
14190
14191
14192
14193 .section "Examples of starting a listening daemon" "SECID94"
14194 The default case in an IPv6 environment is
14195 .code
14196 daemon_smtp_ports = smtp
14197 local_interfaces = <; ::0 ; 0.0.0.0
14198 .endd
14199 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14200 Either one or two sockets may be used, depending on the characteristics of
14201 the TCP/IP stack. (This is complicated and messy; for more information,
14202 read the comments in the &_daemon.c_& source file.)
14203
14204 To specify listening on ports 25 and 26 on all interfaces:
14205 .code
14206 daemon_smtp_ports = 25 : 26
14207 .endd
14208 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14209 .code
14210 local_interfaces = <; ::0.25     ; ::0.26 \
14211                       0.0.0.0.25 ; 0.0.0.0.26
14212 .endd
14213 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14214 IPv4 loopback address only:
14215 .code
14216 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14217 .endd
14218 To specify listening on the default port on specific interfaces only:
14219 .code
14220 local_interfaces = 10.0.0.67 : 192.168.34.67
14221 .endd
14222 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14223
14224
14225
14226 .section "Recognizing the local host" "SECTreclocipadd"
14227 The &%local_interfaces%& option is also used when Exim needs to determine
14228 whether or not an IP address refers to the local host. That is, the IP
14229 addresses of all the interfaces on which a daemon is listening are always
14230 treated as local.
14231
14232 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14233 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14234 available interfaces from the operating system, and extracts the relevant
14235 (that is, IPv4 or IPv6) addresses to use for checking.
14236
14237 Some systems set up large numbers of virtual interfaces in order to provide
14238 many virtual web servers. In this situation, you may want to listen for
14239 email on only a few of the available interfaces, but nevertheless treat all
14240 interfaces as local when routing. You can do this by setting
14241 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14242 &"all"& wildcard values. These addresses are recognized as local, but are not
14243 used for listening. Consider this example:
14244 .code
14245 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14246                       192.168.53.235 ; \
14247                       3ffe:2101:12:1:a00:20ff:fe86:a061
14248
14249 extra_local_interfaces = <; ::0 ; 0.0.0.0
14250 .endd
14251 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14252 address, but all available interface addresses are treated as local when
14253 Exim is routing.
14254
14255 In some environments the local host name may be in an MX list, but with an IP
14256 address that is not assigned to any local interface. In other cases it may be
14257 desirable to treat other host names as if they referred to the local host. Both
14258 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14259 This contains host names rather than IP addresses. When a host is referenced
14260 during routing, either via an MX record or directly, it is treated as the local
14261 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14262 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14263
14264
14265
14266 .section "Delivering to a remote host" "SECID95"
14267 Delivery to a remote host is handled by the smtp transport. By default, it
14268 allows the system's TCP/IP functions to choose which interface to use (if
14269 there is more than one) when connecting to a remote host. However, the
14270 &%interface%& option can be set to specify which interface is used. See the
14271 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14272 details.
14273
14274
14275
14276
14277 . ////////////////////////////////////////////////////////////////////////////
14278 . ////////////////////////////////////////////////////////////////////////////
14279
14280 .chapter "Main configuration" "CHAPmainconfig"
14281 .scindex IIDconfima "configuration file" "main section"
14282 .scindex IIDmaiconf "main configuration"
14283 The first part of the runtime configuration file contains three types of item:
14284
14285 .ilist
14286 Macro definitions: These lines start with an upper case letter. See section
14287 &<<SECTmacrodefs>>& for details of macro processing.
14288 .next
14289 Named list definitions: These lines start with one of the words &"domainlist"&,
14290 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14291 section &<<SECTnamedlists>>&.
14292 .next
14293 Main configuration settings: Each setting occupies one line of the file
14294 (with possible continuations). If any setting is preceded by the word
14295 &"hide"&, the &%-bP%& command line option displays its value to admin users
14296 only. See section &<<SECTcos>>& for a description of the syntax of these option
14297 settings.
14298 .endlist
14299
14300 This chapter specifies all the main configuration options, along with their
14301 types and default values. For ease of finding a particular option, they appear
14302 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14303 are now so many options, they are first listed briefly in functional groups, as
14304 an aid to finding the name of the option you are looking for. Some options are
14305 listed in more than one group.
14306
14307 .section "Miscellaneous" "SECID96"
14308 .table2
14309 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14310 .row &%debug_store%&                 "do extra internal checks"
14311 .row &%disable_ipv6%&                "do no IPv6 processing"
14312 .row &%keep_malformed%&              "for broken files &-- should not happen"
14313 .row &%localhost_number%&            "for unique message ids in clusters"
14314 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14315 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14316 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14317 .row &%print_topbitchars%&           "top-bit characters are printing"
14318 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14319 .row &%timezone%&                    "force time zone"
14320 .endtable
14321
14322
14323 .section "Exim parameters" "SECID97"
14324 .table2
14325 .row &%exim_group%&                  "override compiled-in value"
14326 .row &%exim_path%&                   "override compiled-in value"
14327 .row &%exim_user%&                   "override compiled-in value"
14328 .row &%primary_hostname%&            "default from &[uname()]&"
14329 .row &%split_spool_directory%&       "use multiple directories"
14330 .row &%spool_directory%&             "override compiled-in value"
14331 .endtable
14332
14333
14334
14335 .section "Privilege controls" "SECID98"
14336 .table2
14337 .row &%admin_groups%&                "groups that are Exim admin users"
14338 .row &%commandline_checks_require_admin%& "require admin for various checks"
14339 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14340 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14341 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14342 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14343 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14344 .row &%never_users%&                 "do not run deliveries as these"
14345 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14346 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14347 .row &%trusted_groups%&              "groups that are trusted"
14348 .row &%trusted_users%&               "users that are trusted"
14349 .endtable
14350
14351
14352
14353 .section "Logging" "SECID99"
14354 .table2
14355 .row &%event_action%&                "custom logging"
14356 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14357 .row &%log_file_path%&               "override compiled-in value"
14358 .row &%log_selector%&                "set/unset optional logging"
14359 .row &%log_timezone%&                "add timezone to log lines"
14360 .row &%message_logs%&                "create per-message logs"
14361 .row &%preserve_message_logs%&       "after message completion"
14362 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14363 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14364 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14365 .row &%syslog_facility%&             "set syslog &""facility""& field"
14366 .row &%syslog_pid%&                  "pid in syslog lines"
14367 .row &%syslog_processname%&          "set syslog &""ident""& field"
14368 .row &%syslog_timestamp%&            "timestamp syslog lines"
14369 .row &%write_rejectlog%&             "control use of message log"
14370 .endtable
14371
14372
14373
14374 .section "Frozen messages" "SECID100"
14375 .table2
14376 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14377 .row &%freeze_tell%&                 "send message when freezing"
14378 .row &%move_frozen_messages%&        "to another directory"
14379 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14380 .endtable
14381
14382
14383
14384 .section "Data lookups" "SECID101"
14385 .table2
14386 .row &%ibase_servers%&               "InterBase servers"
14387 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14388 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14389 .row &%ldap_cert_file%&              "client cert file for LDAP"
14390 .row &%ldap_cert_key%&               "client key file for LDAP"
14391 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14392 .row &%ldap_default_servers%&        "used if no server in query"
14393 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14394 .row &%ldap_start_tls%&              "require TLS within LDAP"
14395 .row &%ldap_version%&                "set protocol version"
14396 .row &%lookup_open_max%&             "lookup files held open"
14397 .row &%mysql_servers%&               "default MySQL servers"
14398 .row &%oracle_servers%&              "Oracle servers"
14399 .row &%pgsql_servers%&               "default PostgreSQL servers"
14400 .row &%sqlite_lock_timeout%&         "as it says"
14401 .endtable
14402
14403
14404
14405 .section "Message ids" "SECID102"
14406 .table2
14407 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14408 .row &%message_id_header_text%&      "ditto"
14409 .endtable
14410
14411
14412
14413 .section "Embedded Perl Startup" "SECID103"
14414 .table2
14415 .row &%perl_at_start%&               "always start the interpreter"
14416 .row &%perl_startup%&                "code to obey when starting Perl"
14417 .row &%perl_taintmode%&              "enable taint mode in Perl"
14418 .endtable
14419
14420
14421
14422 .section "Daemon" "SECID104"
14423 .table2
14424 .row &%daemon_smtp_ports%&           "default ports"
14425 .row &%daemon_startup_retries%&      "number of times to retry"
14426 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14427 .row &%extra_local_interfaces%&      "not necessarily listened on"
14428 .row &%local_interfaces%&            "on which to listen, with optional ports"
14429 .row &%notifier_socket%&             "override compiled-in value"
14430 .row &%pid_file_path%&               "override compiled-in value"
14431 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14432 .endtable
14433
14434
14435
14436 .section "Resource control" "SECID105"
14437 .table2
14438 .row &%check_log_inodes%&            "before accepting a message"
14439 .row &%check_log_space%&             "before accepting a message"
14440 .row &%check_spool_inodes%&          "before accepting a message"
14441 .row &%check_spool_space%&           "before accepting a message"
14442 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14443 .row &%queue_only_load%&             "queue incoming if load high"
14444 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14445 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14446 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14447 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14448 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14449 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14450 .row &%smtp_accept_max_per_connection%& "messages per connection"
14451 .row &%smtp_accept_max_per_host%&    "connections from one host"
14452 .row &%smtp_accept_queue%&           "queue mail if more connections"
14453 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14454                                            connection"
14455 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14456 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14457 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14458 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14459 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14460 .endtable
14461
14462
14463
14464 .section "Policy controls" "SECID106"
14465 .table2
14466 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14467 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14468 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14469 .row &%acl_smtp_auth%&               "ACL for AUTH"
14470 .row &%acl_smtp_connect%&            "ACL for connection"
14471 .row &%acl_smtp_data%&               "ACL for DATA"
14472 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14473 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14474 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14475 .row &%acl_smtp_expn%&               "ACL for EXPN"
14476 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14477 .row &%acl_smtp_mail%&               "ACL for MAIL"
14478 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14479 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14480 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14481 .row &%acl_smtp_predata%&            "ACL for start of data"
14482 .row &%acl_smtp_quit%&               "ACL for QUIT"
14483 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14484 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14485 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14486 .row &%av_scanner%&                  "specify virus scanner"
14487 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14488                                       words""&"
14489 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14490 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14491 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14492 .row &%header_maxsize%&              "total size of message header"
14493 .row &%header_line_maxsize%&         "individual header line limit"
14494 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14495 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14496 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14497 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14498 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14499 .row &%host_lookup%&                 "host name looked up for these hosts"
14500 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14501 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14502 .row &%host_reject_connection%&      "reject connection from these hosts"
14503 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14504 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14505 .row &%message_size_limit%&          "for all messages"
14506 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14507 .row &%spamd_address%&               "set interface to SpamAssassin"
14508 .row &%strict_acl_vars%&             "object to unset ACL variables"
14509 .endtable
14510
14511
14512
14513 .section "Callout cache" "SECID107"
14514 .table2
14515 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14516                                          item"
14517 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14518                                          item"
14519 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14520 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14521 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14522 .endtable
14523
14524
14525
14526 .section "TLS" "SECID108"
14527 .table2
14528 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14529 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14530 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14531 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14532 .row &%tls_certificate%&             "location of server certificate"
14533 .row &%tls_crl%&                     "certificate revocation list"
14534 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14535 .row &%tls_dhparam%&                 "DH parameters for server"
14536 .row &%tls_eccurve%&                 "EC curve selection for server"
14537 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14538 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14539 .row &%tls_privatekey%&              "location of server private key"
14540 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14541 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14542 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14543 .row &%tls_verify_certificates%&     "expected client certificates"
14544 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14545 .endtable
14546
14547
14548
14549 .section "Local user handling" "SECID109"
14550 .table2
14551 .row &%finduser_retries%&            "useful in NIS environments"
14552 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14553 .row &%gecos_pattern%&               "ditto"
14554 .row &%max_username_length%&         "for systems that truncate"
14555 .row &%unknown_login%&               "used when no login name found"
14556 .row &%unknown_username%&            "ditto"
14557 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14558 .row &%uucp_from_sender%&            "ditto"
14559 .endtable
14560
14561
14562
14563 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14564 .table2
14565 .row &%header_maxsize%&              "total size of message header"
14566 .row &%header_line_maxsize%&         "individual header line limit"
14567 .row &%message_size_limit%&          "applies to all messages"
14568 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14569 .row &%received_header_text%&        "expanded to make &'Received:'&"
14570 .row &%received_headers_max%&        "for mail loop detection"
14571 .row &%recipients_max%&              "limit per message"
14572 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14573 .endtable
14574
14575
14576
14577
14578 .section "Non-SMTP incoming messages" "SECID111"
14579 .table2
14580 .row &%receive_timeout%&             "for non-SMTP messages"
14581 .endtable
14582
14583
14584
14585
14586
14587 .section "Incoming SMTP messages" "SECID112"
14588 See also the &'Policy controls'& section above.
14589
14590 .table2
14591 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14592 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14593 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14594 .row &%host_lookup%&                 "host name looked up for these hosts"
14595 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14596 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14597 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14598 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14599 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14600 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14601 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14602 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14603 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14604 .row &%smtp_accept_max_per_connection%& "messages per connection"
14605 .row &%smtp_accept_max_per_host%&    "connections from one host"
14606 .row &%smtp_accept_queue%&           "queue mail if more connections"
14607 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14608                                            connection"
14609 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14610 .row &%smtp_active_hostname%&        "host name to use in messages"
14611 .row &%smtp_banner%&                 "text for welcome banner"
14612 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14613 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14614 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14615 .row &%smtp_etrn_command%&           "what to run for ETRN"
14616 .row &%smtp_etrn_serialize%&         "only one at once"
14617 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14618 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14619 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14620 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14621 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14622 .row &%smtp_receive_timeout%&        "per command or data line"
14623 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14624 .row &%smtp_return_error_details%&   "give detail on rejections"
14625 .endtable
14626
14627
14628
14629 .section "SMTP extensions" "SECID113"
14630 .table2
14631 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14632 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14633 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14634 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14635 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14636 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14637 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14638 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14639 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14640 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14641 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14642 .endtable
14643
14644
14645
14646 .section "Processing messages" "SECID114"
14647 .table2
14648 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14649 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14650 .row &%allow_utf8_domains%&          "in addresses"
14651 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14652                                       words""&"
14653 .row &%delivery_date_remove%&        "from incoming messages"
14654 .row &%envelope_to_remove%&          "from incoming messages"
14655 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14656 .row &%headers_charset%&             "default for translations"
14657 .row &%qualify_domain%&              "default for senders"
14658 .row &%qualify_recipient%&           "default for recipients"
14659 .row &%return_path_remove%&          "from incoming messages"
14660 .row &%strip_excess_angle_brackets%& "in addresses"
14661 .row &%strip_trailing_dot%&          "at end of addresses"
14662 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14663 .endtable
14664
14665
14666
14667 .section "System filter" "SECID115"
14668 .table2
14669 .row &%system_filter%&               "locate system filter"
14670 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14671                                             directory"
14672 .row &%system_filter_file_transport%& "transport for delivery to a file"
14673 .row &%system_filter_group%&         "group for filter running"
14674 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14675 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14676 .row &%system_filter_user%&          "user for filter running"
14677 .endtable
14678
14679
14680
14681 .section "Routing and delivery" "SECID116"
14682 .table2
14683 .row &%disable_ipv6%&                "do no IPv6 processing"
14684 .row &%dns_again_means_nonexist%&    "for broken domains"
14685 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14686 .row &%dns_dnssec_ok%&               "parameter for resolver"
14687 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14688 .row &%dns_retrans%&                 "parameter for resolver"
14689 .row &%dns_retry%&                   "parameter for resolver"
14690 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14691 .row &%dns_use_edns0%&               "parameter for resolver"
14692 .row &%hold_domains%&                "hold delivery for these domains"
14693 .row &%local_interfaces%&            "for routing checks"
14694 .row &%queue_domains%&               "no immediate delivery for these"
14695 .row &%queue_only%&                  "no immediate delivery at all"
14696 .row &%queue_only_file%&             "no immediate delivery if file exists"
14697 .row &%queue_only_load%&             "no immediate delivery if load is high"
14698 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14699 .row &%queue_only_override%&         "allow command line to override"
14700 .row &%queue_run_in_order%&          "order of arrival"
14701 .row &%queue_run_max%&               "of simultaneous queue runners"
14702 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14703 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14704 .row &%remote_sort_domains%&         "order of remote deliveries"
14705 .row &%retry_data_expire%&           "timeout for retry data"
14706 .row &%retry_interval_max%&          "safety net for retry rules"
14707 .endtable
14708
14709
14710
14711 .section "Bounce and warning messages" "SECID117"
14712 .table2
14713 .row &%bounce_message_file%&         "content of bounce"
14714 .row &%bounce_message_text%&         "content of bounce"
14715 .row &%bounce_return_body%&          "include body if returning message"
14716 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14717 .row &%bounce_return_message%&       "include original message in bounce"
14718 .row &%bounce_return_size_limit%&    "limit on returned message"
14719 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14720 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14721 .row &%errors_copy%&                 "copy bounce messages"
14722 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14723 .row &%delay_warning%&               "time schedule"
14724 .row &%delay_warning_condition%&     "condition for warning messages"
14725 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14726 .row &%smtp_return_error_details%&   "give detail on rejections"
14727 .row &%warn_message_file%&           "content of warning message"
14728 .endtable
14729
14730
14731
14732 .section "Alphabetical list of main options" "SECTalomo"
14733 Those options that undergo string expansion before use are marked with
14734 &dagger;.
14735
14736 .option accept_8bitmime main boolean true
14737 .cindex "8BITMIME"
14738 .cindex "8-bit characters"
14739 .cindex "log" "selectors"
14740 .cindex "log" "8BITMIME"
14741 This option causes Exim to send 8BITMIME in its response to an SMTP
14742 EHLO command, and to accept the BODY= parameter on MAIL commands.
14743 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14744 takes no steps to do anything special with messages received by this route.
14745
14746 Historically Exim kept this option off by default, but the maintainers
14747 feel that in today's Internet, this causes more problems than it solves.
14748 It now defaults to true.
14749 A more detailed analysis of the issues is provided by Dan Bernstein:
14750 .display
14751 &url(https://cr.yp.to/smtp/8bitmime.html)
14752 .endd
14753
14754 To log received 8BITMIME status use
14755 .code
14756 log_selector = +8bitmime
14757 .endd
14758
14759 .option acl_not_smtp main string&!! unset
14760 .cindex "&ACL;" "for non-SMTP messages"
14761 .cindex "non-SMTP messages" "ACLs for"
14762 This option defines the ACL that is run when a non-SMTP message has been
14763 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14764 further details.
14765
14766 .option acl_not_smtp_mime main string&!! unset
14767 This option defines the ACL that is run for individual MIME parts of non-SMTP
14768 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14769 SMTP messages.
14770
14771 .option acl_not_smtp_start main string&!! unset
14772 .cindex "&ACL;" "at start of non-SMTP message"
14773 .cindex "non-SMTP messages" "ACLs for"
14774 This option defines the ACL that is run before Exim starts reading a
14775 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14776
14777 .option acl_smtp_auth main string&!! unset
14778 .cindex "&ACL;" "setting up for SMTP commands"
14779 .cindex "AUTH" "ACL for"
14780 This option defines the ACL that is run when an SMTP AUTH command is
14781 received. See chapter &<<CHAPACL>>& for further details.
14782
14783 .option acl_smtp_connect main string&!! unset
14784 .cindex "&ACL;" "on SMTP connection"
14785 This option defines the ACL that is run when an SMTP connection is received.
14786 See chapter &<<CHAPACL>>& for further details.
14787
14788 .option acl_smtp_data main string&!! unset
14789 .cindex "DATA" "ACL for"
14790 This option defines the ACL that is run after an SMTP DATA command has been
14791 processed and the message itself has been received, but before the final
14792 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14793
14794 .option acl_smtp_data_prdr main string&!! accept
14795 .cindex "PRDR" "ACL for"
14796 .cindex "DATA" "PRDR ACL for"
14797 .cindex "&ACL;" "PRDR-related"
14798 .cindex "&ACL;" "per-user data processing"
14799 This option defines the ACL that,
14800 if the PRDR feature has been negotiated,
14801 is run for each recipient after an SMTP DATA command has been
14802 processed and the message itself has been received, but before the
14803 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14804
14805 .option acl_smtp_dkim main string&!! unset
14806 .cindex DKIM "ACL for"
14807 This option defines the ACL that is run for each DKIM signature
14808 (by default, or as specified in the dkim_verify_signers option)
14809 of a received message.
14810 See section &<<SECDKIMVFY>>& for further details.
14811
14812 .option acl_smtp_etrn main string&!! unset
14813 .cindex "ETRN" "ACL for"
14814 This option defines the ACL that is run when an SMTP ETRN command is
14815 received. See chapter &<<CHAPACL>>& for further details.
14816
14817 .option acl_smtp_expn main string&!! unset
14818 .cindex "EXPN" "ACL for"
14819 This option defines the ACL that is run when an SMTP EXPN command is
14820 received. See chapter &<<CHAPACL>>& for further details.
14821
14822 .option acl_smtp_helo main string&!! unset
14823 .cindex "EHLO" "ACL for"
14824 .cindex "HELO" "ACL for"
14825 This option defines the ACL that is run when an SMTP EHLO or HELO
14826 command is received. See chapter &<<CHAPACL>>& for further details.
14827
14828
14829 .option acl_smtp_mail main string&!! unset
14830 .cindex "MAIL" "ACL for"
14831 This option defines the ACL that is run when an SMTP MAIL command is
14832 received. See chapter &<<CHAPACL>>& for further details.
14833
14834 .option acl_smtp_mailauth main string&!! unset
14835 .cindex "AUTH" "on MAIL command"
14836 This option defines the ACL that is run when there is an AUTH parameter on
14837 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14838 &<<CHAPSMTPAUTH>>& for details of authentication.
14839
14840 .option acl_smtp_mime main string&!! unset
14841 .cindex "MIME content scanning" "ACL for"
14842 This option is available when Exim is built with the content-scanning
14843 extension. It defines the ACL that is run for each MIME part in a message. See
14844 section &<<SECTscanmimepart>>& for details.
14845
14846 .option acl_smtp_notquit main string&!! unset
14847 .cindex "not-QUIT, ACL for"
14848 This option defines the ACL that is run when an SMTP session
14849 ends without a QUIT command being received.
14850 See chapter &<<CHAPACL>>& for further details.
14851
14852 .option acl_smtp_predata main string&!! unset
14853 This option defines the ACL that is run when an SMTP DATA command is
14854 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14855 further details.
14856
14857 .option acl_smtp_quit main string&!! unset
14858 .cindex "QUIT, ACL for"
14859 This option defines the ACL that is run when an SMTP QUIT command is
14860 received. See chapter &<<CHAPACL>>& for further details.
14861
14862 .option acl_smtp_rcpt main string&!! unset
14863 .cindex "RCPT" "ACL for"
14864 This option defines the ACL that is run when an SMTP RCPT command is
14865 received. See chapter &<<CHAPACL>>& for further details.
14866
14867 .option acl_smtp_starttls main string&!! unset
14868 .cindex "STARTTLS, ACL for"
14869 This option defines the ACL that is run when an SMTP STARTTLS command is
14870 received. See chapter &<<CHAPACL>>& for further details.
14871
14872 .option acl_smtp_vrfy main string&!! unset
14873 .cindex "VRFY" "ACL for"
14874 This option defines the ACL that is run when an SMTP VRFY command is
14875 received. See chapter &<<CHAPACL>>& for further details.
14876
14877 .option add_environment main "string list" empty
14878 .cindex "environment" "set values"
14879 This option adds individual environment variables that the
14880 currently linked libraries and programs in child processes may use.
14881 Each list element should be of the form &"name=value"&.
14882
14883 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14884
14885 .option admin_groups main "string list&!!" unset
14886 .cindex "admin user"
14887 This option is expanded just once, at the start of Exim's processing. If the
14888 current group or any of the supplementary groups of an Exim caller is in this
14889 colon-separated list, the caller has admin privileges. If all your system
14890 programmers are in a specific group, for example, you can give them all Exim
14891 admin privileges by putting that group in &%admin_groups%&. However, this does
14892 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14893 To permit this, you have to add individuals to the Exim group.
14894
14895 .option allow_domain_literals main boolean false
14896 .cindex "domain literal"
14897 If this option is set, the RFC 2822 domain literal format is permitted in
14898 email addresses. The option is not set by default, because the domain literal
14899 format is not normally required these days, and few people know about it. It
14900 has, however, been exploited by mail abusers.
14901
14902 Unfortunately, it seems that some DNS black list maintainers are using this
14903 format to report black listing to postmasters. If you want to accept messages
14904 addressed to your hosts by IP address, you need to set
14905 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14906 domains (defined in the named domain list &%local_domains%& in the default
14907 configuration). This &"magic string"& matches the domain literal form of all
14908 the local host's IP addresses.
14909
14910
14911 .option allow_mx_to_ip main boolean false
14912 .cindex "MX record" "pointing to IP address"
14913 It appears that more and more DNS zone administrators are breaking the rules
14914 and putting domain names that look like IP addresses on the right hand side of
14915 MX records. Exim follows the rules and rejects this, giving an error message
14916 that explains the misconfiguration. However, some other MTAs support this
14917 practice, so to avoid &"Why can't Exim do this?"& complaints,
14918 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14919 recommended, except when you have no other choice.
14920
14921 .option allow_utf8_domains main boolean false
14922 .cindex "domain" "UTF-8 characters in"
14923 .cindex "UTF-8" "in domain name"
14924 Lots of discussion is going on about internationalized domain names. One
14925 camp is strongly in favour of just using UTF-8 characters, and it seems
14926 that at least two other MTAs permit this.
14927 This option allows Exim users to experiment if they wish.
14928
14929 If it is set true, Exim's domain parsing function allows valid
14930 UTF-8 multicharacters to appear in domain name components, in addition to
14931 letters, digits, and hyphens.
14932
14933 If Exim is built with internationalization support
14934 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14935 this option can be left as default.
14936 Without that,
14937 if you want to look up such domain names in the DNS, you must also
14938 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14939 suitable setting is:
14940 .code
14941 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14942   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14943 .endd
14944 Alternatively, you can just disable this feature by setting
14945 .code
14946 dns_check_names_pattern =
14947 .endd
14948 That is, set the option to an empty string so that no check is done.
14949
14950
14951 .option auth_advertise_hosts main "host list&!!" *
14952 .cindex "authentication" "advertising"
14953 .cindex "AUTH" "advertising"
14954 If any server authentication mechanisms are configured, Exim advertises them in
14955 response to an EHLO command only if the calling host matches this list.
14956 Otherwise, Exim does not advertise AUTH.
14957 Exim does not accept AUTH commands from clients to which it has not
14958 advertised the availability of AUTH. The advertising of individual
14959 authentication mechanisms can be controlled by the use of the
14960 &%server_advertise_condition%& generic authenticator option on the individual
14961 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14962
14963 Certain mail clients (for example, Netscape) require the user to provide a name
14964 and password for authentication if AUTH is advertised, even though it may
14965 not be needed (the host may accept messages from hosts on its local LAN without
14966 authentication, for example). The &%auth_advertise_hosts%& option can be used
14967 to make these clients more friendly by excluding them from the set of hosts to
14968 which Exim advertises AUTH.
14969
14970 .cindex "AUTH" "advertising when encrypted"
14971 If you want to advertise the availability of AUTH only when the connection
14972 is encrypted using TLS, you can make use of the fact that the value of this
14973 option is expanded, with a setting like this:
14974 .code
14975 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14976 .endd
14977 .vindex "&$tls_in_cipher$&"
14978 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14979 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14980 expansion is *, which matches all hosts.
14981
14982
14983 .option auto_thaw main time 0s
14984 .cindex "thawing messages"
14985 .cindex "unfreezing messages"
14986 If this option is set to a time greater than zero, a queue runner will try a
14987 new delivery attempt on any frozen message, other than a bounce message, if
14988 this much time has passed since it was frozen. This may result in the message
14989 being re-frozen if nothing has changed since the last attempt. It is a way of
14990 saying &"keep on trying, even though there are big problems"&.
14991
14992 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14993 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14994 thought to be very useful any more, and its use should probably be avoided.
14995
14996
14997 .option av_scanner main string "see below"
14998 This option is available if Exim is built with the content-scanning extension.
14999 It specifies which anti-virus scanner to use. The default value is:
15000 .code
15001 sophie:/var/run/sophie
15002 .endd
15003 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15004 before use. See section &<<SECTscanvirus>>& for further details.
15005
15006
15007 .option bi_command main string unset
15008 .oindex "&%-bi%&"
15009 This option supplies the name of a command that is run when Exim is called with
15010 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15011 just the command name, it is not a complete command line. If an argument is
15012 required, it must come from the &%-oA%& command line option.
15013
15014
15015 .option bounce_message_file main string unset
15016 .cindex "bounce message" "customizing"
15017 .cindex "customizing" "bounce message"
15018 This option defines a template file containing paragraphs of text to be used
15019 for constructing bounce messages.  Details of the file's contents are given in
15020 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
15021
15022
15023 .option bounce_message_text main string unset
15024 When this option is set, its contents are included in the default bounce
15025 message immediately after &"This message was created automatically by mail
15026 delivery software."& It is not used if &%bounce_message_file%& is set.
15027
15028 .option bounce_return_body main boolean true
15029 .cindex "bounce message" "including body"
15030 This option controls whether the body of an incoming message is included in a
15031 bounce message when &%bounce_return_message%& is true. The default setting
15032 causes the entire message, both header and body, to be returned (subject to the
15033 value of &%bounce_return_size_limit%&). If this option is false, only the
15034 message header is included. In the case of a non-SMTP message containing an
15035 error that is detected during reception, only those header lines preceding the
15036 point at which the error was detected are returned.
15037 .cindex "bounce message" "including original"
15038
15039 .option bounce_return_linesize_limit main integer 998
15040 .cindex "size" "of bounce lines, limit"
15041 .cindex "bounce message" "line length limit"
15042 .cindex "limit" "bounce message line length"
15043 This option sets a limit in bytes on the line length of messages
15044 that are returned to senders due to delivery problems,
15045 when &%bounce_return_message%& is true.
15046 The default value corresponds to RFC limits.
15047 If the message being returned has lines longer than this value it is
15048 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15049
15050 The option also applies to bounces returned when an error is detected
15051 during reception of a message.
15052 In this case lines from the original are truncated.
15053
15054 The option does not apply to messages generated by an &(autoreply)& transport.
15055
15056
15057 .option bounce_return_message main boolean true
15058 If this option is set false, none of the original message is included in
15059 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15060 &%bounce_return_body%&.
15061
15062
15063 .option bounce_return_size_limit main integer 100K
15064 .cindex "size" "of bounce, limit"
15065 .cindex "bounce message" "size limit"
15066 .cindex "limit" "bounce message size"
15067 This option sets a limit in bytes on the size of messages that are returned to
15068 senders as part of bounce messages when &%bounce_return_message%& is true. The
15069 limit should be less than the value of the global &%message_size_limit%& and of
15070 any &%message_size_limit%& settings on transports, to allow for the bounce text
15071 that Exim generates. If this option is set to zero there is no limit.
15072
15073 When the body of any message that is to be included in a bounce message is
15074 greater than the limit, it is truncated, and a comment pointing this out is
15075 added at the top. The actual cutoff may be greater than the value given, owing
15076 to the use of buffering for transferring the message in chunks (typically 8K in
15077 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15078 messages.
15079
15080 .option bounce_sender_authentication main string unset
15081 .cindex "bounce message" "sender authentication"
15082 .cindex "authentication" "bounce message"
15083 .cindex "AUTH" "on bounce message"
15084 This option provides an authenticated sender address that is sent with any
15085 bounce messages generated by Exim that are sent over an authenticated SMTP
15086 connection. A typical setting might be:
15087 .code
15088 bounce_sender_authentication = mailer-daemon@my.domain.example
15089 .endd
15090 which would cause bounce messages to be sent using the SMTP command:
15091 .code
15092 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15093 .endd
15094 The value of &%bounce_sender_authentication%& must always be a complete email
15095 address.
15096
15097 .option callout_domain_negative_expire main time 3h
15098 .cindex "caching" "callout timeouts"
15099 .cindex "callout" "caching timeouts"
15100 This option specifies the expiry time for negative callout cache data for a
15101 domain. See section &<<SECTcallver>>& for details of callout verification, and
15102 section &<<SECTcallvercache>>& for details of the caching.
15103
15104
15105 .option callout_domain_positive_expire main time 7d
15106 This option specifies the expiry time for positive callout cache data for a
15107 domain. See section &<<SECTcallver>>& for details of callout verification, and
15108 section &<<SECTcallvercache>>& for details of the caching.
15109
15110
15111 .option callout_negative_expire main time 2h
15112 This option specifies the expiry time for negative callout cache data for an
15113 address. See section &<<SECTcallver>>& for details of callout verification, and
15114 section &<<SECTcallvercache>>& for details of the caching.
15115
15116
15117 .option callout_positive_expire main time 24h
15118 This option specifies the expiry time for positive callout cache data for an
15119 address. See section &<<SECTcallver>>& for details of callout verification, and
15120 section &<<SECTcallvercache>>& for details of the caching.
15121
15122
15123 .option callout_random_local_part main string&!! "see below"
15124 This option defines the &"random"& local part that can be used as part of
15125 callout verification. The default value is
15126 .code
15127 $primary_hostname-$tod_epoch-testing
15128 .endd
15129 See section &<<CALLaddparcall>>& for details of how this value is used.
15130
15131
15132 .option check_log_inodes main integer 100
15133 See &%check_spool_space%& below.
15134
15135
15136 .option check_log_space main integer 10M
15137 See &%check_spool_space%& below.
15138
15139 .oindex "&%check_rfc2047_length%&"
15140 .cindex "RFC 2047" "disabling length check"
15141 .option check_rfc2047_length main boolean true
15142 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15143 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15144 word; strings to be encoded that exceed this length are supposed to use
15145 multiple encoded words. By default, Exim does not recognize encoded words that
15146 exceed the maximum length. However, it seems that some software, in violation
15147 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15148 set false, Exim recognizes encoded words of any length.
15149
15150
15151 .option check_spool_inodes main integer 100
15152 See &%check_spool_space%& below.
15153
15154
15155 .option check_spool_space main integer 10M
15156 .cindex "checking disk space"
15157 .cindex "disk space, checking"
15158 .cindex "spool directory" "checking space"
15159 The four &%check_...%& options allow for checking of disk resources before a
15160 message is accepted.
15161
15162 .vindex "&$log_inodes$&"
15163 .vindex "&$log_space$&"
15164 .vindex "&$spool_inodes$&"
15165 .vindex "&$spool_space$&"
15166 When any of these options are nonzero, they apply to all incoming messages. If you
15167 want to apply different checks to different kinds of message, you can do so by
15168 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15169 &$spool_space$& in an ACL with appropriate additional conditions.
15170
15171
15172 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15173 either value is greater than zero, for example:
15174 .code
15175 check_spool_space = 100M
15176 check_spool_inodes = 100
15177 .endd
15178 The spool partition is the one that contains the directory defined by
15179 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15180 transit.
15181
15182 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15183 files are written if either is greater than zero. These should be set only if
15184 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15185
15186 If there is less space or fewer inodes than requested, Exim refuses to accept
15187 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15188 error response to the MAIL command. If ESMTP is in use and there was a
15189 SIZE parameter on the MAIL command, its value is added to the
15190 &%check_spool_space%& value, and the check is performed even if
15191 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15192
15193 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15194 number of kilobytes (though specified in bytes).
15195 If a non-multiple of 1024 is specified, it is rounded up.
15196
15197 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15198 failure a message is written to stderr and Exim exits with a non-zero code, as
15199 it obviously cannot send an error message of any kind.
15200
15201 There is a slight performance penalty for these checks.
15202 Versions of Exim preceding 4.88 had these disabled by default;
15203 high-rate installations confident they will never run out of resources
15204 may wish to deliberately disable them.
15205
15206 .option chunking_advertise_hosts main "host list&!!" *
15207 .cindex CHUNKING advertisement
15208 .cindex "RFC 3030" "CHUNKING"
15209 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15210 these hosts.
15211 Hosts may use the BDAT command as an alternate to DATA.
15212
15213 .option commandline_checks_require_admin main boolean &`false`&
15214 .cindex "restricting access to features"
15215 This option restricts various basic checking features to require an
15216 administrative user.
15217 This affects most of the &%-b*%& options, such as &%-be%&.
15218
15219 .option debug_store main boolean &`false`&
15220 .cindex debugging "memory corruption"
15221 .cindex memory debugging
15222 This option, when true, enables extra checking in Exim's internal memory
15223 management.  For use when a memory corruption issue is being investigated,
15224 it should normally be left as default.
15225
15226 .option daemon_smtp_ports main string &`smtp`&
15227 .cindex "port" "for daemon"
15228 .cindex "TCP/IP" "setting listening ports"
15229 This option specifies one or more default SMTP ports on which the Exim daemon
15230 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15231 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15232
15233 .option daemon_startup_retries main integer 9
15234 .cindex "daemon startup, retrying"
15235 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15236 the daemon at startup when it cannot immediately bind a listening socket
15237 (typically because the socket is already in use): &%daemon_startup_retries%&
15238 defines the number of retries after the first failure, and
15239 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15240
15241 .option daemon_startup_sleep main time 30s
15242 See &%daemon_startup_retries%&.
15243
15244 .option delay_warning main "time list" 24h
15245 .cindex "warning of delay"
15246 .cindex "delay warning, specifying"
15247 .cindex "queue" "delay warning"
15248 When a message is delayed, Exim sends a warning message to the sender at
15249 intervals specified by this option. The data is a colon-separated list of times
15250 after which to send warning messages. If the value of the option is an empty
15251 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15252 message has been in the queue for longer than the last time, the last interval
15253 between the times is used to compute subsequent warning times. For example,
15254 with
15255 .code
15256 delay_warning = 4h:8h:24h
15257 .endd
15258 the first message is sent after 4 hours, the second after 8 hours, and
15259 the third one after 24 hours. After that, messages are sent every 16 hours,
15260 because that is the interval between the last two times on the list. If you set
15261 just one time, it specifies the repeat interval. For example, with:
15262 .code
15263 delay_warning = 6h
15264 .endd
15265 messages are repeated every six hours. To stop warnings after a given time, set
15266 a very large time at the end of the list. For example:
15267 .code
15268 delay_warning = 2h:12h:99d
15269 .endd
15270 Note that the option is only evaluated at the time a delivery attempt fails,
15271 which depends on retry and queue-runner configuration.
15272 Typically retries will be configured more frequently than warning messages.
15273
15274 .option delay_warning_condition main string&!! "see below"
15275 .vindex "&$domain$&"
15276 The string is expanded at the time a warning message might be sent. If all the
15277 deferred addresses have the same domain, it is set in &$domain$& during the
15278 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15279 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15280 &"false"& (the comparison being done caselessly) then the warning message is
15281 not sent. The default is:
15282 .code
15283 delay_warning_condition = ${if or {\
15284   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15285   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15286   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15287   } {no}{yes}}
15288 .endd
15289 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15290 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15291 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15292 &"auto-replied"& in an &'Auto-Submitted:'& header.
15293
15294 .option deliver_drop_privilege main boolean false
15295 .cindex "unprivileged delivery"
15296 .cindex "delivery" "unprivileged"
15297 If this option is set true, Exim drops its root privilege at the start of a
15298 delivery process, and runs as the Exim user throughout. This severely restricts
15299 the kinds of local delivery that are possible, but is viable in certain types
15300 of configuration. There is a discussion about the use of root privilege in
15301 chapter &<<CHAPsecurity>>&.
15302
15303 .option deliver_queue_load_max main fixed-point unset
15304 .cindex "load average"
15305 .cindex "queue runner" "abandoning"
15306 When this option is set, a queue run is abandoned if the system load average
15307 becomes greater than the value of the option. The option has no effect on
15308 ancient operating systems on which Exim cannot determine the load average.
15309 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15310
15311
15312 .option delivery_date_remove main boolean true
15313 .cindex "&'Delivery-date:'& header line"
15314 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15315 message when it is delivered, in exactly the same way as &'Return-path:'& is
15316 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15317 should not be present in incoming messages, and this option causes them to be
15318 removed at the time the message is received, to avoid any problems that might
15319 occur when a delivered message is subsequently sent on to some other recipient.
15320
15321 .option disable_fsync main boolean false
15322 .cindex "&[fsync()]&, disabling"
15323 This option is available only if Exim was built with the compile-time option
15324 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15325 a runtime configuration generates an &"unknown option"& error. You should not
15326 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15327 really, really, really understand what you are doing. &'No pre-compiled
15328 distributions of Exim should ever make this option available.'&
15329
15330 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15331 updated files' data to be written to disc before continuing. Unexpected events
15332 such as crashes and power outages may cause data to be lost or scrambled.
15333 Here be Dragons. &*Beware.*&
15334
15335
15336 .option disable_ipv6 main boolean false
15337 .cindex "IPv6" "disabling"
15338 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15339 activities take place. AAAA records are never looked up, and any IPv6 addresses
15340 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15341 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15342 to handle IPv6 literal addresses.
15343
15344
15345 .new
15346 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15347 .cindex DKIM "selecting signature algorithms"
15348 This option gives a list of hash types which are acceptable in signatures,
15349 .wen
15350 and an order of processing.
15351 Signatures with algorithms not in the list will be ignored.
15352
15353 Acceptable values include:
15354 .code
15355 sha1
15356 sha256
15357 sha512
15358 .endd
15359
15360 Note that the acceptance of sha1 violates RFC 8301.
15361
15362 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15363 This option gives a list of key types which are acceptable in signatures,
15364 and an order of processing.
15365 Signatures with algorithms not in the list will be ignored.
15366
15367 .option dkim_verify_minimal main boolean false
15368 If set to true, verification of signatures will terminate after the
15369 first success.
15370
15371 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15372 .cindex DKIM "controlling calls to the ACL"
15373 This option gives a list of DKIM domains for which the DKIM ACL is run.
15374 It is expanded after the message is received; by default it runs
15375 the ACL once for each signature in the message.
15376 See section &<<SECDKIMVFY>>&.
15377
15378
15379 .option dns_again_means_nonexist main "domain list&!!" unset
15380 .cindex "DNS" "&""try again""& response; overriding"
15381 DNS lookups give a &"try again"& response for the DNS errors
15382 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15383 keep trying to deliver a message, or to give repeated temporary errors to
15384 incoming mail. Sometimes the effect is caused by a badly set up name server and
15385 may persist for a long time. If a domain which exhibits this problem matches
15386 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15387 This option should be used with care. You can make it apply to reverse lookups
15388 by a setting such as this:
15389 .code
15390 dns_again_means_nonexist = *.in-addr.arpa
15391 .endd
15392 This option applies to all DNS lookups that Exim does. It also applies when the
15393 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15394 since these are most likely to be caused by DNS lookup problems. The
15395 &(dnslookup)& router has some options of its own for controlling what happens
15396 when lookups for MX or SRV records give temporary errors. These more specific
15397 options are applied after this global option.
15398
15399 .option dns_check_names_pattern main string "see below"
15400 .cindex "DNS" "pre-check of name syntax"
15401 When this option is set to a non-empty string, it causes Exim to check domain
15402 names for characters that are not allowed in host names before handing them to
15403 the DNS resolver, because some resolvers give temporary errors for names that
15404 contain unusual characters. If a domain name contains any unwanted characters,
15405 a &"not found"& result is forced, and the resolver is not called. The check is
15406 done by matching the domain name against a regular expression, which is the
15407 value of this option. The default pattern is
15408 .code
15409 dns_check_names_pattern = \
15410   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15411 .endd
15412 which permits only letters, digits, slashes, and hyphens in components, but
15413 they must start and end with a letter or digit. Slashes are not, in fact,
15414 permitted in host names, but they are found in certain NS records (which can be
15415 accessed in Exim by using a &%dnsdb%& lookup). If you set
15416 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15417 empty string.
15418
15419 .option dns_csa_search_limit main integer 5
15420 This option controls the depth of parental searching for CSA SRV records in the
15421 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15422
15423 .option dns_csa_use_reverse main boolean true
15424 This option controls whether or not an IP address, given as a CSA domain, is
15425 reversed and looked up in the reverse DNS, as described in more detail in
15426 section &<<SECTverifyCSA>>&.
15427
15428 .option dns_cname_loops main integer 1
15429 .cindex DNS "CNAME following"
15430 This option controls the following of CNAME chains, needed if the resolver does
15431 not do it internally.
15432 As of 2018 most should, and the default can be left.
15433 If you have an ancient one, a value of 10 is likely needed.
15434
15435 The default value of one CNAME-follow is needed
15436 thanks to the observed return for an MX request,
15437 given no MX presence but a CNAME to an A, of the CNAME.
15438
15439
15440 .option dns_dnssec_ok main integer -1
15441 .cindex "DNS" "resolver options"
15442 .cindex "DNS" "DNSSEC"
15443 If this option is set to a non-negative number then Exim will initialise the
15444 DNS resolver library to either use or not use DNSSEC, overriding the system
15445 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15446
15447 If the resolver library does not support DNSSEC then this option has no effect.
15448
15449
15450 .option dns_ipv4_lookup main "domain list&!!" unset
15451 .cindex "IPv6" "DNS lookup for AAAA records"
15452 .cindex "DNS" "IPv6 lookup for AAAA records"
15453 .cindex DNS "IPv6 disabling"
15454 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15455 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15456 (A records) when trying to find IP addresses for hosts, unless the host's
15457 domain matches this list.
15458
15459 This is a fudge to help with name servers that give big delays or otherwise do
15460 not work for the AAAA record type. In due course, when the world's name
15461 servers have all been upgraded, there should be no need for this option.
15462 Note that all lookups, including those done for verification, are affected;
15463 this will result in verify failure for IPv6 connections or ones using names
15464 only valid for IPv6 addresses.
15465
15466
15467 .option dns_retrans main time 0s
15468 .cindex "DNS" "resolver options"
15469 .cindex timeout "dns lookup"
15470 .cindex "DNS" timeout
15471 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15472 retransmission and retry parameters for DNS lookups. Values of zero (the
15473 defaults) leave the system default settings unchanged. The first value is the
15474 time between retries, and the second is the number of retries. It isn't
15475 totally clear exactly how these settings affect the total time a DNS lookup may
15476 take. I haven't found any documentation about timeouts on DNS lookups; these
15477 parameter values are available in the external resolver interface structure,
15478 but nowhere does it seem to describe how they are used or what you might want
15479 to set in them.
15480 See also the &%slow_lookup_log%& option.
15481
15482
15483 .option dns_retry main integer 0
15484 See &%dns_retrans%& above.
15485
15486
15487 .option dns_trust_aa main "domain list&!!" unset
15488 .cindex "DNS" "resolver options"
15489 .cindex "DNS" "DNSSEC"
15490 If this option is set then lookup results marked with the AA bit
15491 (Authoritative Answer) are trusted the same way as if they were
15492 DNSSEC-verified. The authority section's name of the answer must
15493 match with this expanded domain list.
15494
15495 Use this option only if you talk directly to a resolver that is
15496 authoritative for some zones and does not set the AD (Authentic Data)
15497 bit in the answer. Some DNS servers may have an configuration option to
15498 mark the answers from their own zones as verified (they set the AD bit).
15499 Others do not have this option. It is considered as poor practice using
15500 a resolver that is an authoritative server for some zones.
15501
15502 Use this option only if you really have to (e.g. if you want
15503 to use DANE for remote delivery to a server that is listed in the DNS
15504 zones that your resolver is authoritative for).
15505
15506 If the DNS answer packet has the AA bit set and contains resource record
15507 in the answer section, the name of the first NS record appearing in the
15508 authority section is compared against the list. If the answer packet is
15509 authoritative but the answer section is empty, the name of the first SOA
15510 record in the authoritative section is used instead.
15511
15512 .cindex "DNS" "resolver options"
15513 .option dns_use_edns0 main integer -1
15514 .cindex "DNS" "resolver options"
15515 .cindex "DNS" "EDNS0"
15516 .cindex "DNS" "OpenBSD
15517 If this option is set to a non-negative number then Exim will initialise the
15518 DNS resolver library to either use or not use EDNS0 extensions, overriding
15519 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15520 on.
15521
15522 If the resolver library does not support EDNS0 then this option has no effect.
15523
15524 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15525 means that DNSSEC will not work with Exim on that platform either, unless Exim
15526 is linked against an alternative DNS client library.
15527
15528
15529 .option drop_cr main boolean false
15530 This is an obsolete option that is now a no-op. It used to affect the way Exim
15531 handled CR and LF characters in incoming messages. What happens now is
15532 described in section &<<SECTlineendings>>&.
15533
15534 .option dsn_advertise_hosts main "host list&!!" unset
15535 .cindex "bounce messages" "success"
15536 .cindex "DSN" "success"
15537 .cindex "Delivery Status Notification" "success"
15538 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15539 and accepted from, these hosts.
15540 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15541 and RET and ORCPT options on MAIL FROM commands.
15542 A NOTIFY=SUCCESS option requests success-DSN messages.
15543 A NOTIFY= option with no argument requests that no delay or failure DSNs
15544 are sent.
15545
15546 .option dsn_from main "string&!!" "see below"
15547 .cindex "&'From:'& header line" "in bounces"
15548 .cindex "bounce messages" "&'From:'& line, specifying"
15549 This option can be used to vary the contents of &'From:'& header lines in
15550 bounces and other automatically generated messages (&"Delivery Status
15551 Notifications"& &-- hence the name of the option). The default setting is:
15552 .code
15553 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15554 .endd
15555 The value is expanded every time it is needed. If the expansion fails, a
15556 panic is logged, and the default value is used.
15557
15558 .option envelope_to_remove main boolean true
15559 .cindex "&'Envelope-to:'& header line"
15560 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15561 message when it is delivered, in exactly the same way as &'Return-path:'& is
15562 handled. &'Envelope-to:'& records the original recipient address from the
15563 message's envelope that caused the delivery to happen. Such headers should not
15564 be present in incoming messages, and this option causes them to be removed at
15565 the time the message is received, to avoid any problems that might occur when a
15566 delivered message is subsequently sent on to some other recipient.
15567
15568
15569 .option errors_copy main "string list&!!" unset
15570 .cindex "bounce message" "copy to other address"
15571 .cindex "copy of bounce message"
15572 Setting this option causes Exim to send bcc copies of bounce messages that it
15573 generates to other addresses. &*Note*&: This does not apply to bounce messages
15574 coming from elsewhere. The value of the option is a colon-separated list of
15575 items. Each item consists of a pattern, terminated by white space, followed by
15576 a comma-separated list of email addresses. If a pattern contains spaces, it
15577 must be enclosed in double quotes.
15578
15579 Each pattern is processed in the same way as a single item in an address list
15580 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15581 the bounce message, the message is copied to the addresses on the list. The
15582 items are scanned in order, and once a matching one is found, no further items
15583 are examined. For example:
15584 .code
15585 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15586               rqps@mydomain   hostmaster@mydomain.example,\
15587                               postmaster@mydomain.example
15588 .endd
15589 .vindex "&$domain$&"
15590 .vindex "&$local_part$&"
15591 The address list is expanded before use. The expansion variables &$local_part$&
15592 and &$domain$& are set from the original recipient of the error message, and if
15593 there was any wildcard matching in the pattern, the expansion
15594 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15595 variables &$0$&, &$1$&, etc. are set in the normal way.
15596
15597
15598 .option errors_reply_to main string unset
15599 .cindex "bounce message" "&'Reply-to:'& in"
15600 By default, Exim's bounce and delivery warning messages contain the header line
15601 .display
15602 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15603 .endd
15604 .oindex &%quota_warn_message%&
15605 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15606 A warning message that is generated by the &%quota_warn_message%& option in an
15607 &(appendfile)& transport may contain its own &'From:'& header line that
15608 overrides the default.
15609
15610 Experience shows that people reply to bounce messages. If the
15611 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15612 and warning messages. For example:
15613 .code
15614 errors_reply_to = postmaster@my.domain.example
15615 .endd
15616 The value of the option is not expanded. It must specify a valid RFC 2822
15617 address. However, if a warning message that is generated by the
15618 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15619 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15620 not used.
15621
15622
15623 .option event_action main string&!! unset
15624 .cindex events
15625 This option declares a string to be expanded for Exim's events mechanism.
15626 For details see chapter &<<CHAPevents>>&.
15627
15628
15629 .option exim_group main string "compile-time configured"
15630 .cindex "gid (group id)" "Exim's own"
15631 .cindex "Exim group"
15632 This option changes the gid under which Exim runs when it gives up root
15633 privilege. The default value is compiled into the binary. The value of this
15634 option is used only when &%exim_user%& is also set. Unless it consists entirely
15635 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15636 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15637 security issues.
15638
15639
15640 .option exim_path main string "see below"
15641 .cindex "Exim binary, path name"
15642 This option specifies the path name of the Exim binary, which is used when Exim
15643 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15644 the directory configured at compile time by the BIN_DIRECTORY setting. It
15645 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15646 other place.
15647 &*Warning*&: Do not use a macro to define the value of this option, because
15648 you will break those Exim utilities that scan the configuration file to find
15649 where the binary is. (They then use the &%-bP%& option to extract option
15650 settings such as the value of &%spool_directory%&.)
15651
15652
15653 .option exim_user main string "compile-time configured"
15654 .cindex "uid (user id)" "Exim's own"
15655 .cindex "Exim user"
15656 This option changes the uid under which Exim runs when it gives up root
15657 privilege. The default value is compiled into the binary. Ownership of the run
15658 time configuration file and the use of the &%-C%& and &%-D%& command line
15659 options is checked against the values in the binary, not what is set here.
15660
15661 Unless it consists entirely of digits, the string is looked up using
15662 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15663 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15664 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15665
15666
15667 .option exim_version main string "current version"
15668 .cindex "Exim version"
15669 .cindex customizing "version number"
15670 .cindex "version number of Exim" override
15671 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15672 various places.  Use with care; this may fool stupid security scanners.
15673
15674
15675 .option extra_local_interfaces main "string list" unset
15676 This option defines network interfaces that are to be considered local when
15677 routing, but which are not used for listening by the daemon. See section
15678 &<<SECTreclocipadd>>& for details.
15679
15680
15681 . Allow this long option name to split; give it unsplit as a fifth argument
15682 . for the automatic .oindex that is generated by .option.
15683
15684 .option "extract_addresses_remove_arguments" main boolean true &&&
15685          extract_addresses_remove_arguments
15686 .oindex "&%-t%&"
15687 .cindex "command line" "addresses with &%-t%&"
15688 .cindex "Sendmail compatibility" "&%-t%& option"
15689 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15690 are present on the command line when the &%-t%& option is used to build an
15691 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15692 line addresses are removed from the recipients list. This is also how Smail
15693 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15694 command line addresses are added to those obtained from the header lines. When
15695 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15696 argument headers. If it is set false, Exim adds rather than removes argument
15697 addresses.
15698
15699
15700 .option finduser_retries main integer 0
15701 .cindex "NIS, retrying user lookups"
15702 On systems running NIS or other schemes in which user and group information is
15703 distributed from a remote system, there can be times when &[getpwnam()]& and
15704 related functions fail, even when given valid data, because things time out.
15705 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15706 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15707 many extra times to find a user or a group, waiting for one second between
15708 retries.
15709
15710 .cindex "&_/etc/passwd_&" "multiple reading of"
15711 You should not set this option greater than zero if your user information is in
15712 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15713 search the file multiple times for non-existent users, and also cause delay.
15714
15715
15716
15717 .option freeze_tell main "string list, comma separated" unset
15718 .cindex "freezing messages" "sending a message when freezing"
15719 On encountering certain errors, or when configured to do so in a system filter,
15720 ACL, or special router, Exim freezes a message. This means that no further
15721 delivery attempts take place until an administrator thaws the message, or the
15722 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15723 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15724 warning message whenever it freezes something, unless the message it is
15725 freezing is a locally-generated bounce message. (Without this exception there
15726 is the possibility of looping.) The warning message is sent to the addresses
15727 supplied as the comma-separated value of this option. If several of the
15728 message's addresses cause freezing, only a single message is sent. If the
15729 freezing was automatic, the reason(s) for freezing can be found in the message
15730 log. If you configure freezing in a filter or ACL, you must arrange for any
15731 logging that you require.
15732
15733
15734 .option gecos_name main string&!! unset
15735 .cindex "HP-UX"
15736 .cindex "&""gecos""& field, parsing"
15737 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15738 password file to hold other information in addition to users' real names. Exim
15739 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15740 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15741 of the field are used unchanged, except that, if an ampersand is encountered,
15742 it is replaced by the user's login name with the first character forced to
15743 upper case, since this is a convention that is observed on many systems.
15744
15745 When these options are set, &%gecos_pattern%& is treated as a regular
15746 expression that is to be applied to the field (again with && replaced by the
15747 login name), and if it matches, &%gecos_name%& is expanded and used as the
15748 user's name.
15749
15750 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15751 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15752 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15753 name terminates at the first comma, the following can be used:
15754 .code
15755 gecos_pattern = ([^,]*)
15756 gecos_name = $1
15757 .endd
15758
15759 .option gecos_pattern main string unset
15760 See &%gecos_name%& above.
15761
15762
15763 .option gnutls_compat_mode main boolean unset
15764 This option controls whether GnuTLS is used in compatibility mode in an Exim
15765 server. This reduces security slightly, but improves interworking with older
15766 implementations of TLS.
15767
15768
15769 .option gnutls_allow_auto_pkcs11 main boolean unset
15770 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15771 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15772
15773 See
15774 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15775 for documentation.
15776
15777
15778
15779 .option headers_charset main string "see below"
15780 This option sets a default character set for translating from encoded MIME
15781 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15782 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15783 ultimate default is ISO-8859-1. For more details see the description of header
15784 insertions in section &<<SECTexpansionitems>>&.
15785
15786
15787
15788 .option header_maxsize main integer "see below"
15789 .cindex "header section" "maximum size of"
15790 .cindex "limit" "size of message header section"
15791 This option controls the overall maximum size of a message's header
15792 section. The default is the value of HEADER_MAXSIZE in
15793 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15794 sections are rejected.
15795
15796
15797 .option header_line_maxsize main integer 0
15798 .cindex "header lines" "maximum size of"
15799 .cindex "limit" "size of one header line"
15800 This option limits the length of any individual header line in a message, after
15801 all the continuations have been joined together. Messages with individual
15802 header lines that are longer than the limit are rejected. The default value of
15803 zero means &"no limit"&.
15804
15805
15806
15807
15808 .option helo_accept_junk_hosts main "host list&!!" unset
15809 .cindex "HELO" "accepting junk data"
15810 .cindex "EHLO" "accepting junk data"
15811 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15812 mail, and gives an error response for invalid data. Unfortunately, there are
15813 some SMTP clients that send syntactic junk. They can be accommodated by setting
15814 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15815 if you want to do semantic checking.
15816 See also &%helo_allow_chars%& for a way of extending the permitted character
15817 set.
15818
15819
15820 .option helo_allow_chars main string unset
15821 .cindex "HELO" "underscores in"
15822 .cindex "EHLO" "underscores in"
15823 .cindex "underscore in EHLO/HELO"
15824 This option can be set to a string of rogue characters that are permitted in
15825 all EHLO and HELO names in addition to the standard letters, digits,
15826 hyphens, and dots. If you really must allow underscores, you can set
15827 .code
15828 helo_allow_chars = _
15829 .endd
15830 Note that the value is one string, not a list.
15831
15832
15833 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15834 .cindex "HELO" "forcing reverse lookup"
15835 .cindex "EHLO" "forcing reverse lookup"
15836 If the domain given by a client in a HELO or EHLO command matches this
15837 list, a reverse lookup is done in order to establish the host's true name. The
15838 default forces a lookup if the client host gives the server's name or any of
15839 its IP addresses (in brackets), something that broken clients have been seen to
15840 do.
15841
15842
15843 .option helo_try_verify_hosts main "host list&!!" unset
15844 .cindex "HELO verifying" "optional"
15845 .cindex "EHLO" "verifying, optional"
15846 By default, Exim just checks the syntax of HELO and EHLO commands (see
15847 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15848 to do more extensive checking of the data supplied by these commands. The ACL
15849 condition &`verify = helo`& is provided to make this possible.
15850 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15851 to force the check to occur. From release 4.53 onwards, this is no longer
15852 necessary. If the check has not been done before &`verify = helo`& is
15853 encountered, it is done at that time. Consequently, this option is obsolete.
15854 Its specification is retained here for backwards compatibility.
15855
15856 When an EHLO or HELO command is received, if the calling host matches
15857 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15858 EHLO command either:
15859
15860 .ilist
15861 is an IP literal matching the calling address of the host, or
15862 .next
15863 .cindex "DNS" "reverse lookup"
15864 .cindex "reverse DNS lookup"
15865 matches the host name that Exim obtains by doing a reverse lookup of the
15866 calling host address, or
15867 .next
15868 when looked up in DNS yields the calling host address.
15869 .endlist
15870
15871 However, the EHLO or HELO command is not rejected if any of the checks
15872 fail. Processing continues, but the result of the check is remembered, and can
15873 be detected later in an ACL by the &`verify = helo`& condition.
15874
15875 If DNS was used for successful verification, the variable
15876 .cindex "DNS" "DNSSEC"
15877 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15878
15879 .option helo_verify_hosts main "host list&!!" unset
15880 .cindex "HELO verifying" "mandatory"
15881 .cindex "EHLO" "verifying, mandatory"
15882 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15883 backwards compatibility. For hosts that match this option, Exim checks the host
15884 name given in the HELO or EHLO in the same way as for
15885 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15886 rejected with a 550 error, and entries are written to the main and reject logs.
15887 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15888 error.
15889
15890 .option hold_domains main "domain list&!!" unset
15891 .cindex "domain" "delaying delivery"
15892 .cindex "delivery" "delaying certain domains"
15893 This option allows mail for particular domains to be held in the queue
15894 manually. The option is overridden if a message delivery is forced with the
15895 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15896 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15897 item in &%hold_domains%&, no routing or delivery for that address is done, and
15898 it is deferred every time the message is looked at.
15899
15900 This option is intended as a temporary operational measure for delaying the
15901 delivery of mail while some problem is being sorted out, or some new
15902 configuration tested. If you just want to delay the processing of some
15903 domains until a queue run occurs, you should use &%queue_domains%& or
15904 &%queue_smtp_domains%&, not &%hold_domains%&.
15905
15906 A setting of &%hold_domains%& does not override Exim's code for removing
15907 messages from the queue if they have been there longer than the longest retry
15908 time in any retry rule. If you want to hold messages for longer than the normal
15909 retry times, insert a dummy retry rule with a long retry time.
15910
15911
15912 .option host_lookup main "host list&!!" unset
15913 .cindex "host name" "lookup, forcing"
15914 Exim does not look up the name of a calling host from its IP address unless it
15915 is required to compare against some host list, or the host matches
15916 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15917 option (which normally contains IP addresses rather than host names). The
15918 default configuration file contains
15919 .code
15920 host_lookup = *
15921 .endd
15922 which causes a lookup to happen for all hosts. If the expense of these lookups
15923 is felt to be too great, the setting can be changed or removed.
15924
15925 After a successful reverse lookup, Exim does a forward lookup on the name it
15926 has obtained, to verify that it yields the IP address that it started with. If
15927 this check fails, Exim behaves as if the name lookup failed.
15928
15929 .vindex "&$host_lookup_failed$&"
15930 .vindex "&$sender_host_name$&"
15931 After any kind of failure, the host name (in &$sender_host_name$&) remains
15932 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15933 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15934 &`verify = reverse_host_lookup`& in ACLs.
15935
15936
15937 .option host_lookup_order main "string list" &`bydns:byaddr`&
15938 This option specifies the order of different lookup methods when Exim is trying
15939 to find a host name from an IP address. The default is to do a DNS lookup
15940 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15941 if that fails. You can change the order of these lookups, or omit one entirely,
15942 if you want.
15943
15944 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15945 multiple PTR records in the DNS and the IP address is not listed in
15946 &_/etc/hosts_&. Different operating systems give different results in this
15947 case. That is why the default tries a DNS lookup first.
15948
15949
15950
15951 .option host_reject_connection main "host list&!!" unset
15952 .cindex "host" "rejecting connections from"
15953 If this option is set, incoming SMTP calls from the hosts listed are rejected
15954 as soon as the connection is made.
15955 This option is obsolete, and retained only for backward compatibility, because
15956 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15957 connections immediately.
15958
15959 The ability to give an immediate rejection (either by this option or using an
15960 ACL) is provided for use in unusual cases. Many hosts will just try again,
15961 sometimes without much delay. Normally, it is better to use an ACL to reject
15962 incoming messages at a later stage, such as after RCPT commands. See
15963 chapter &<<CHAPACL>>&.
15964
15965
15966 .option hosts_connection_nolog main "host list&!!" unset
15967 .cindex "host" "not logging connections from"
15968 This option defines a list of hosts for which connection logging does not
15969 happen, even though the &%smtp_connection%& log selector is set. For example,
15970 you might want not to log SMTP connections from local processes, or from
15971 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15972 the daemon; you should therefore strive to restrict its value to a short inline
15973 list of IP addresses and networks. To disable logging SMTP connections from
15974 local processes, you must create a host list with an empty item. For example:
15975 .code
15976 hosts_connection_nolog = :
15977 .endd
15978 If the &%smtp_connection%& log selector is not set, this option has no effect.
15979
15980
15981
15982 .option hosts_proxy main "host list&!!" unset
15983 .cindex proxy "proxy protocol"
15984 This option enables use of Proxy Protocol proxies for incoming
15985 connections.  For details see section &<<SECTproxyInbound>>&.
15986
15987
15988 .option hosts_treat_as_local main "domain list&!!" unset
15989 .cindex "local host" "domains treated as"
15990 .cindex "host" "treated as local"
15991 If this option is set, any host names that match the domain list are treated as
15992 if they were the local host when Exim is scanning host lists obtained from MX
15993 records
15994 or other sources. Note that the value of this option is a domain list, not a
15995 host list, because it is always used to check host names, not IP addresses.
15996
15997 This option also applies when Exim is matching the special items
15998 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15999 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16000 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16001 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16002 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16003 interfaces and recognizing the local host.
16004
16005
16006 .option ibase_servers main "string list" unset
16007 .cindex "InterBase" "server list"
16008 This option provides a list of InterBase servers and associated connection data,
16009 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16010 The option is available only if Exim has been built with InterBase support.
16011
16012
16013
16014 .option ignore_bounce_errors_after main time 10w
16015 .cindex "bounce message" "discarding"
16016 .cindex "discarding bounce message"
16017 This option affects the processing of bounce messages that cannot be delivered,
16018 that is, those that suffer a permanent delivery failure. (Bounce messages that
16019 suffer temporary delivery failures are of course retried in the usual way.)
16020
16021 After a permanent delivery failure, bounce messages are frozen,
16022 because there is no sender to whom they can be returned. When a frozen bounce
16023 message has been in the queue for more than the given time, it is unfrozen at
16024 the next queue run, and a further delivery is attempted. If delivery fails
16025 again, the bounce message is discarded. This makes it possible to keep failed
16026 bounce messages around for a shorter time than the normal maximum retry time
16027 for frozen messages. For example,
16028 .code
16029 ignore_bounce_errors_after = 12h
16030 .endd
16031 retries failed bounce message deliveries after 12 hours, discarding any further
16032 failures. If the value of this option is set to a zero time period, bounce
16033 failures are discarded immediately. Setting a very long time (as in the default
16034 value) has the effect of disabling this option. For ways of automatically
16035 dealing with other kinds of frozen message, see &%auto_thaw%& and
16036 &%timeout_frozen_after%&.
16037
16038
16039 .option ignore_fromline_hosts main "host list&!!" unset
16040 .cindex "&""From""& line"
16041 .cindex "UUCP" "&""From""& line"
16042 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16043 the headers of a message. By default this is treated as the start of the
16044 message's body, which means that any following headers are not recognized as
16045 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16046 match those hosts that insist on sending it. If the sender is actually a local
16047 process rather than a remote host, and is using &%-bs%& to inject the messages,
16048 &%ignore_fromline_local%& must be set to achieve this effect.
16049
16050
16051 .option ignore_fromline_local main boolean false
16052 See &%ignore_fromline_hosts%& above.
16053
16054 .option keep_environment main "string list" unset
16055 .cindex "environment" "values from"
16056 This option contains a string list of environment variables to keep.
16057 You have to trust these variables or you have to be sure that
16058 these variables do not impose any security risk. Keep in mind that
16059 during the startup phase Exim is running with an effective UID 0 in most
16060 installations. As the default value is an empty list, the default
16061 environment for using libraries, running embedded Perl code, or running
16062 external binaries is empty, and does not not even contain PATH or HOME.
16063
16064 Actually the list is interpreted as a list of patterns
16065 (&<<SECTlistexpand>>&), except that it is not expanded first.
16066
16067 WARNING: Macro substitution is still done first, so having a macro
16068 FOO and having FOO_HOME in your &%keep_environment%& option may have
16069 unexpected results. You may work around this using a regular expression
16070 that does not match the macro name: ^[F]OO_HOME$.
16071
16072 Current versions of Exim issue a warning during startup if you do not mention
16073 &%keep_environment%& in your runtime configuration file and if your
16074 current environment is not empty. Future versions may not issue that warning
16075 anymore.
16076
16077 See the &%add_environment%& main config option for a way to set
16078 environment variables to a fixed value.  The environment for &(pipe)&
16079 transports is handled separately, see section &<<SECTpipeenv>>& for
16080 details.
16081
16082
16083 .option keep_malformed main time 4d
16084 This option specifies the length of time to keep messages whose spool files
16085 have been corrupted in some way. This should, of course, never happen. At the
16086 next attempt to deliver such a message, it gets removed. The incident is
16087 logged.
16088
16089
16090 .option ldap_ca_cert_dir main string unset
16091 .cindex "LDAP", "TLS CA certificate directory"
16092 .cindex certificate "directory for LDAP"
16093 This option indicates which directory contains CA certificates for verifying
16094 a TLS certificate presented by an LDAP server.
16095 While Exim does not provide a default value, your SSL library may.
16096 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16097 and constrained to be a directory.
16098
16099
16100 .option ldap_ca_cert_file main string unset
16101 .cindex "LDAP", "TLS CA certificate file"
16102 .cindex certificate "file for LDAP"
16103 This option indicates which file contains CA certificates for verifying
16104 a TLS certificate presented by an LDAP server.
16105 While Exim does not provide a default value, your SSL library may.
16106 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16107 and constrained to be a file.
16108
16109
16110 .option ldap_cert_file main string unset
16111 .cindex "LDAP" "TLS client certificate file"
16112 .cindex certificate "file for LDAP"
16113 This option indicates which file contains an TLS client certificate which
16114 Exim should present to the LDAP server during TLS negotiation.
16115 Should be used together with &%ldap_cert_key%&.
16116
16117
16118 .option ldap_cert_key main string unset
16119 .cindex "LDAP" "TLS client key file"
16120 .cindex certificate "key for LDAP"
16121 This option indicates which file contains the secret/private key to use
16122 to prove identity to the LDAP server during TLS negotiation.
16123 Should be used together with &%ldap_cert_file%&, which contains the
16124 identity to be proven.
16125
16126
16127 .option ldap_cipher_suite main string unset
16128 .cindex "LDAP" "TLS cipher suite"
16129 This controls the TLS cipher-suite negotiation during TLS negotiation with
16130 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16131 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16132
16133
16134 .option ldap_default_servers main "string list" unset
16135 .cindex "LDAP" "default servers"
16136 This option provides a list of LDAP servers which are tried in turn when an
16137 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16138 details of LDAP queries. This option is available only when Exim has been built
16139 with LDAP support.
16140
16141
16142 .option ldap_require_cert main string unset.
16143 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16144 This should be one of the values "hard", "demand", "allow", "try" or "never".
16145 A value other than one of these is interpreted as "never".
16146 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16147 Although Exim does not set a default, the LDAP library probably defaults
16148 to hard/demand.
16149
16150
16151 .option ldap_start_tls main boolean false
16152 .cindex "LDAP" "whether or not to negotiate TLS"
16153 If set, Exim will attempt to negotiate TLS with the LDAP server when
16154 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16155 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16156 of SSL-on-connect.
16157 In the event of failure to negotiate TLS, the action taken is controlled
16158 by &%ldap_require_cert%&.
16159 This option is ignored for &`ldapi`& connections.
16160
16161
16162 .option ldap_version main integer unset
16163 .cindex "LDAP" "protocol version, forcing"
16164 This option can be used to force Exim to set a specific protocol version for
16165 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16166 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16167 the LDAP headers; otherwise it is 2. This option is available only when Exim
16168 has been built with LDAP support.
16169
16170
16171
16172 .option local_from_check main boolean true
16173 .cindex "&'Sender:'& header line" "disabling addition of"
16174 .cindex "&'From:'& header line" "disabling checking of"
16175 When a message is submitted locally (that is, not over a TCP/IP connection) by
16176 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16177 checks that the &'From:'& header line matches the login of the calling user and
16178 the domain specified by &%qualify_domain%&.
16179
16180 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16181 locally submitted message is automatically qualified by Exim, unless the
16182 &%-bnq%& command line option is used.
16183
16184 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16185 on the local part. If the &'From:'& header line does not match, Exim adds a
16186 &'Sender:'& header with an address constructed from the calling user's login
16187 and the default qualify domain.
16188
16189 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16190 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16191 &'Sender:'& header lines supplied by untrusted users, you must also set
16192 &%local_sender_retain%& to be true.
16193
16194 .cindex "envelope from"
16195 .cindex "envelope sender"
16196 These options affect only the header lines in the message. The envelope sender
16197 is still forced to be the login id at the qualify domain unless
16198 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16199
16200 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16201 request similar header line checking. See section &<<SECTthesenhea>>&, which
16202 has more details about &'Sender:'& processing.
16203
16204
16205
16206
16207 .option local_from_prefix main string unset
16208 When Exim checks the &'From:'& header line of locally submitted messages for
16209 matching the login id (see &%local_from_check%& above), it can be configured to
16210 ignore certain prefixes and suffixes in the local part of the address. This is
16211 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16212 appropriate lists, in the same form as the &%local_part_prefix%& and
16213 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16214 example, if
16215 .code
16216 local_from_prefix = *-
16217 .endd
16218 is set, a &'From:'& line containing
16219 .code
16220 From: anything-user@your.domain.example
16221 .endd
16222 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16223 matches the actual sender address that is constructed from the login name and
16224 qualify domain.
16225
16226
16227 .option local_from_suffix main string unset
16228 See &%local_from_prefix%& above.
16229
16230
16231 .option local_interfaces main "string list" "see below"
16232 This option controls which network interfaces are used by the daemon for
16233 listening; they are also used to identify the local host when routing. Chapter
16234 &<<CHAPinterfaces>>& contains a full description of this option and the related
16235 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16236 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16237 &%local_interfaces%& is
16238 .code
16239 local_interfaces = 0.0.0.0
16240 .endd
16241 when Exim is built without IPv6 support; otherwise it is
16242 .code
16243 local_interfaces = <; ::0 ; 0.0.0.0
16244 .endd
16245
16246 .option local_scan_timeout main time 5m
16247 .cindex "timeout" "for &[local_scan()]& function"
16248 .cindex "&[local_scan()]& function" "timeout"
16249 This timeout applies to the &[local_scan()]& function (see chapter
16250 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16251 the incoming message is rejected with a temporary error if it is an SMTP
16252 message. For a non-SMTP message, the message is dropped and Exim ends with a
16253 non-zero code. The incident is logged on the main and reject logs.
16254
16255
16256
16257 .option local_sender_retain main boolean false
16258 .cindex "&'Sender:'& header line" "retaining from local submission"
16259 When a message is submitted locally (that is, not over a TCP/IP connection) by
16260 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16261 do not want this to happen, you must set &%local_sender_retain%&, and you must
16262 also set &%local_from_check%& to be false (Exim will complain if you do not).
16263 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16264 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16265
16266
16267
16268
16269 .option localhost_number main string&!! unset
16270 .cindex "host" "locally unique number for"
16271 .cindex "message ids" "with multiple hosts"
16272 .vindex "&$localhost_number$&"
16273 Exim's message ids are normally unique only within the local host. If
16274 uniqueness among a set of hosts is required, each host must set a different
16275 value for the &%localhost_number%& option. The string is expanded immediately
16276 after reading the configuration file (so that a number can be computed from the
16277 host name, for example) and the result of the expansion must be a number in the
16278 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16279 systems). This is available in subsequent string expansions via the variable
16280 &$localhost_number$&. When &%localhost_number is set%&, the final two
16281 characters of the message id, instead of just being a fractional part of the
16282 time, are computed from the time and the local host number as described in
16283 section &<<SECTmessiden>>&.
16284
16285
16286
16287 .option log_file_path main "string list&!!" "set at compile time"
16288 .cindex "log" "file path for"
16289 This option sets the path which is used to determine the names of Exim's log
16290 files, or indicates that logging is to be to syslog, or both. It is expanded
16291 when Exim is entered, so it can, for example, contain a reference to the host
16292 name. If no specific path is set for the log files at compile or runtime,
16293 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16294 they are written in a sub-directory called &_log_& in Exim's spool directory.
16295 A path must start with a slash.
16296 To send to syslog, use the word &"syslog"&.
16297 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16298 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16299 used. If this string is fixed at your installation (contains no expansion
16300 variables) it is recommended that you do not set this option in the
16301 configuration file, but instead supply the path using LOG_FILE_PATH in
16302 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16303 early on &-- in particular, failure to read the configuration file.
16304
16305
16306 .option log_selector main string unset
16307 .cindex "log" "selectors"
16308 This option can be used to reduce or increase the number of things that Exim
16309 writes to its log files. Its argument is made up of names preceded by plus or
16310 minus characters. For example:
16311 .code
16312 log_selector = +arguments -retry_defer
16313 .endd
16314 A list of possible names and what they control is given in the chapter on
16315 logging, in section &<<SECTlogselector>>&.
16316
16317
16318 .option log_timezone main boolean false
16319 .cindex "log" "timezone for entries"
16320 .vindex "&$tod_log$&"
16321 .vindex "&$tod_zone$&"
16322 By default, the timestamps on log lines are in local time without the
16323 timezone. This means that if your timezone changes twice a year, the timestamps
16324 in log lines are ambiguous for an hour when the clocks go back. One way of
16325 avoiding this problem is to set the timezone to UTC. An alternative is to set
16326 &%log_timezone%& true. This turns on the addition of the timezone offset to
16327 timestamps in log lines. Turning on this option can add quite a lot to the size
16328 of log files because each line is extended by 6 characters. Note that the
16329 &$tod_log$& variable contains the log timestamp without the zone, but there is
16330 another variable called &$tod_zone$& that contains just the timezone offset.
16331
16332
16333 .option lookup_open_max main integer 25
16334 .cindex "too many open files"
16335 .cindex "open files, too many"
16336 .cindex "file" "too many open"
16337 .cindex "lookup" "maximum open files"
16338 .cindex "limit" "open files for lookups"
16339 This option limits the number of simultaneously open files for single-key
16340 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16341 Exim normally keeps these files open during routing, because often the same
16342 file is required several times. If the limit is reached, Exim closes the least
16343 recently used file. Note that if you are using the &'ndbm'& library, it
16344 actually opens two files for each logical DBM database, though it still counts
16345 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16346 open files"& errors with NDBM, you need to reduce the value of
16347 &%lookup_open_max%&.
16348
16349
16350 .option max_username_length main integer 0
16351 .cindex "length of login name"
16352 .cindex "user name" "maximum length"
16353 .cindex "limit" "user name length"
16354 Some operating systems are broken in that they truncate long arguments to
16355 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16356 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16357 an argument that is longer behaves as if &[getpwnam()]& failed.
16358
16359
16360 .option message_body_newlines main bool false
16361 .cindex "message body" "newlines in variables"
16362 .cindex "newline" "in message body variables"
16363 .vindex "&$message_body$&"
16364 .vindex "&$message_body_end$&"
16365 By default, newlines in the message body are replaced by spaces when setting
16366 the &$message_body$& and &$message_body_end$& expansion variables. If this
16367 option is set true, this no longer happens.
16368
16369
16370 .option message_body_visible main integer 500
16371 .cindex "body of message" "visible size"
16372 .cindex "message body" "visible size"
16373 .vindex "&$message_body$&"
16374 .vindex "&$message_body_end$&"
16375 This option specifies how much of a message's body is to be included in the
16376 &$message_body$& and &$message_body_end$& expansion variables.
16377
16378
16379 .option message_id_header_domain main string&!! unset
16380 .cindex "&'Message-ID:'& header line"
16381 If this option is set, the string is expanded and used as the right hand side
16382 (domain) of the &'Message-ID:'& header that Exim creates if a
16383 locally-originated incoming message does not have one. &"Locally-originated"&
16384 means &"not received over TCP/IP."&
16385 Otherwise, the primary host name is used.
16386 Only letters, digits, dot and hyphen are accepted; any other characters are
16387 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16388 empty string, the option is ignored.
16389
16390
16391 .option message_id_header_text main string&!! unset
16392 If this variable is set, the string is expanded and used to augment the text of
16393 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16394 message does not have one. The text of this header is required by RFC 2822 to
16395 take the form of an address. By default, Exim uses its internal message id as
16396 the local part, and the primary host name as the domain. If this option is set,
16397 it is expanded, and provided the expansion is not forced to fail, and does not
16398 yield an empty string, the result is inserted into the header immediately
16399 before the @, separated from the internal message id by a dot. Any characters
16400 that are illegal in an address are automatically converted into hyphens. This
16401 means that variables such as &$tod_log$& can be used, because the spaces and
16402 colons will become hyphens.
16403
16404
16405 .option message_logs main boolean true
16406 .cindex "message logs" "disabling"
16407 .cindex "log" "message log; disabling"
16408 If this option is turned off, per-message log files are not created in the
16409 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16410 Exim, by reducing the number of files involved in handling a message from a
16411 minimum of four (header spool file, body spool file, delivery journal, and
16412 per-message log) to three. The other major I/O activity is Exim's main log,
16413 which is not affected by this option.
16414
16415
16416 .option message_size_limit main string&!! 50M
16417 .cindex "message" "size limit"
16418 .cindex "limit" "message size"
16419 .cindex "size" "of message, limit"
16420 This option limits the maximum size of message that Exim will process. The
16421 value is expanded for each incoming connection so, for example, it can be made
16422 to depend on the IP address of the remote host for messages arriving via
16423 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16424 optionally followed by K or M.
16425
16426 &*Note*&: This limit cannot be made to depend on a message's sender or any
16427 other properties of an individual message, because it has to be advertised in
16428 the server's response to EHLO. String expansion failure causes a temporary
16429 error. A value of zero means no limit, but its use is not recommended. See also
16430 &%bounce_return_size_limit%&.
16431
16432 Incoming SMTP messages are failed with a 552 error if the limit is
16433 exceeded; locally-generated messages either get a stderr message or a delivery
16434 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16435 an oversized message is logged in both the main and the reject logs. See also
16436 the generic transport option &%message_size_limit%&, which limits the size of
16437 message that an individual transport can process.
16438
16439 If you use a virus-scanner and set this option to to a value larger than the
16440 maximum size that your virus-scanner is configured to support, you may get
16441 failures triggered by large mails.  The right size to configure for the
16442 virus-scanner depends upon what data is passed and the options in use but it's
16443 probably safest to just set it to a little larger than this value.  E.g., with a
16444 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16445 some problems may result.
16446
16447 A value of 0 will disable size limit checking; Exim will still advertise the
16448 SIZE extension in an EHLO response, but without a limit, so as to permit
16449 SMTP clients to still indicate the message size along with the MAIL verb.
16450
16451
16452 .option move_frozen_messages main boolean false
16453 .cindex "frozen messages" "moving"
16454 This option, which is available only if Exim has been built with the setting
16455 .code
16456 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16457 .endd
16458 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16459 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16460 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16461 standard utilities for handling such moved messages, and they do not show up in
16462 lists generated by &%-bp%& or by the Exim monitor.
16463
16464
16465 .option mua_wrapper main boolean false
16466 Setting this option true causes Exim to run in a very restrictive mode in which
16467 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16468 contains a full description of this facility.
16469
16470
16471
16472 .option mysql_servers main "string list" unset
16473 .cindex "MySQL" "server list"
16474 This option provides a list of MySQL servers and associated connection data, to
16475 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16476 option is available only if Exim has been built with MySQL support.
16477
16478
16479 .option never_users main "string list&!!" unset
16480 This option is expanded just once, at the start of Exim's processing. Local
16481 message deliveries are normally run in processes that are setuid to the
16482 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16483 It is usually desirable to prevent any deliveries from running as root, as a
16484 safety precaution.
16485
16486 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16487 list of users that must not be used for local deliveries. This list is fixed in
16488 the binary and cannot be overridden by the configuration file. By default, it
16489 contains just the single user name &"root"&. The &%never_users%& runtime option
16490 can be used to add more users to the fixed list.
16491
16492 If a message is to be delivered as one of the users on the fixed list or the
16493 &%never_users%& list, an error occurs, and delivery is deferred. A common
16494 example is
16495 .code
16496 never_users = root:daemon:bin
16497 .endd
16498 Including root is redundant if it is also on the fixed list, but it does no
16499 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16500 transport driver.
16501
16502
16503 .new
16504 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16505 This option gives the name for a unix-domain socket on which the daemon
16506 listens for work and information-requests.
16507 Only installations running multiple daemons sharing a spool directory
16508 should need to modify the default.
16509
16510 The option is expanded before use.
16511 If the platform supports Linux-style abstract socket names, the result
16512 is used with a nul byte prefixed.
16513 Otherwise, it should be a full path name and use a directory accessible
16514 to Exim.
16515
16516 If the Exim command line uses a &%-oX%& option and does not use &%-oP%&
16517 then a notifier socket is not created.
16518 .wen
16519
16520
16521 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16522 .cindex "OpenSSL "compatibility options"
16523 This option allows an administrator to adjust the SSL options applied
16524 by OpenSSL to connections.  It is given as a space-separated list of items,
16525 each one to be +added or -subtracted from the current value.
16526
16527 This option is only available if Exim is built against OpenSSL.  The values
16528 available for this option vary according to the age of your OpenSSL install.
16529 The &"all"& value controls a subset of flags which are available, typically
16530 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16531 list the values known on your system and Exim should support all the
16532 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16533 names lose the leading &"SSL_OP_"& and are lower-cased.
16534
16535 Note that adjusting the options can have severe impact upon the security of
16536 SSL as used by Exim.  It is possible to disable safety checks and shoot
16537 yourself in the foot in various unpleasant ways.  This option should not be
16538 adjusted lightly.  An unrecognised item will be detected at startup, by
16539 invoking Exim with the &%-bV%& flag.
16540
16541 The option affects Exim operating both as a server and as a client.
16542
16543 Historical note: prior to release 4.80, Exim defaulted this value to
16544 "+dont_insert_empty_fragments", which may still be needed for compatibility
16545 with some clients, but which lowers security by increasing exposure to
16546 some now infamous attacks.
16547
16548 Examples:
16549 .code
16550 # Make both old MS and old Eudora happy:
16551 openssl_options = -all +microsoft_big_sslv3_buffer \
16552                        +dont_insert_empty_fragments
16553
16554 # Disable older protocol versions:
16555 openssl_options = +no_sslv2 +no_sslv3
16556 .endd
16557
16558 Possible options may include:
16559 .ilist
16560 &`all`&
16561 .next
16562 &`allow_unsafe_legacy_renegotiation`&
16563 .next
16564 &`cipher_server_preference`&
16565 .next
16566 &`dont_insert_empty_fragments`&
16567 .next
16568 &`ephemeral_rsa`&
16569 .next
16570 &`legacy_server_connect`&
16571 .next
16572 &`microsoft_big_sslv3_buffer`&
16573 .next
16574 &`microsoft_sess_id_bug`&
16575 .next
16576 &`msie_sslv2_rsa_padding`&
16577 .next
16578 &`netscape_challenge_bug`&
16579 .next
16580 &`netscape_reuse_cipher_change_bug`&
16581 .next
16582 &`no_compression`&
16583 .next
16584 &`no_session_resumption_on_renegotiation`&
16585 .next
16586 &`no_sslv2`&
16587 .next
16588 &`no_sslv3`&
16589 .next
16590 &`no_ticket`&
16591 .next
16592 &`no_tlsv1`&
16593 .next
16594 &`no_tlsv1_1`&
16595 .next
16596 &`no_tlsv1_2`&
16597 .next
16598 &`safari_ecdhe_ecdsa_bug`&
16599 .next
16600 &`single_dh_use`&
16601 .next
16602 &`single_ecdh_use`&
16603 .next
16604 &`ssleay_080_client_dh_bug`&
16605 .next
16606 &`sslref2_reuse_cert_type_bug`&
16607 .next
16608 &`tls_block_padding_bug`&
16609 .next
16610 &`tls_d5_bug`&
16611 .next
16612 &`tls_rollback_bug`&
16613 .endlist
16614
16615 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16616 all clients connecting using the MacOS SecureTransport TLS facility prior
16617 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16618 to negotiate TLS then this option value might help, provided that your OpenSSL
16619 release is new enough to contain this work-around.  This may be a situation
16620 where you have to upgrade OpenSSL to get buggy clients working.
16621
16622
16623 .option oracle_servers main "string list" unset
16624 .cindex "Oracle" "server list"
16625 This option provides a list of Oracle servers and associated connection data,
16626 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16627 The option is available only if Exim has been built with Oracle support.
16628
16629
16630 .option percent_hack_domains main "domain list&!!" unset
16631 .cindex "&""percent hack""&"
16632 .cindex "source routing" "in email address"
16633 .cindex "address" "source-routed"
16634 The &"percent hack"& is the convention whereby a local part containing a
16635 percent sign is re-interpreted as a new email address, with the percent
16636 replaced by @. This is sometimes called &"source routing"&, though that term is
16637 also applied to RFC 2822 addresses that begin with an @ character. If this
16638 option is set, Exim implements the percent facility for those domains listed,
16639 but no others. This happens before an incoming SMTP address is tested against
16640 an ACL.
16641
16642 &*Warning*&: The &"percent hack"& has often been abused by people who are
16643 trying to get round relaying restrictions. For this reason, it is best avoided
16644 if at all possible. Unfortunately, a number of less security-conscious MTAs
16645 implement it unconditionally. If you are running Exim on a gateway host, and
16646 routing mail through to internal MTAs without processing the local parts, it is
16647 a good idea to reject recipient addresses with percent characters in their
16648 local parts. Exim's default configuration does this.
16649
16650
16651 .option perl_at_start main boolean false
16652 .cindex "Perl"
16653 This option is available only when Exim is built with an embedded Perl
16654 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16655
16656
16657 .option perl_startup main string unset
16658 .cindex "Perl"
16659 This option is available only when Exim is built with an embedded Perl
16660 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16661
16662 .option perl_taintmode main boolean false
16663 .cindex "Perl"
16664 This option enables the taint mode of the embedded Perl interpreter.
16665
16666
16667 .option pgsql_servers main "string list" unset
16668 .cindex "PostgreSQL lookup type" "server list"
16669 This option provides a list of PostgreSQL servers and associated connection
16670 data, to be used in conjunction with &(pgsql)& lookups (see section
16671 &<<SECID72>>&). The option is available only if Exim has been built with
16672 PostgreSQL support.
16673
16674
16675 .option pid_file_path main string&!! "set at compile time"
16676 .cindex "daemon" "pid file path"
16677 .cindex "pid file, path for"
16678 This option sets the name of the file to which the Exim daemon writes its
16679 process id. The string is expanded, so it can contain, for example, references
16680 to the host name:
16681 .code
16682 pid_file_path = /var/log/$primary_hostname/exim.pid
16683 .endd
16684 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16685 spool directory.
16686 The value set by the option can be overridden by the &%-oP%& command line
16687 option. A pid file is not written if a &"non-standard"& daemon is run by means
16688 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16689
16690
16691 .option pipelining_advertise_hosts main "host list&!!" *
16692 .cindex "PIPELINING" "suppressing advertising"
16693 This option can be used to suppress the advertisement of the SMTP
16694 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16695 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16696 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16697 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16698 that clients will use it; &"out of order"& commands that are &"expected"& do
16699 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16700
16701 .option pipelining_connect_advertise_hosts main "host list&!!" *
16702 .cindex "pipelining" "early connection"
16703 .cindex "pipelining" PIPE_CONNECT
16704 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16705 this option controls which hosts the facility is advertised to
16706 and from which pipeline early-connection (before MAIL) SMTP
16707 commands are acceptable.
16708 When used, the pipelining saves on roundtrip times.
16709
16710 See also the &%hosts_pipe_connect%& smtp transport option.
16711
16712 Currently the option name &"X_PIPE_CONNECT"& is used.
16713
16714
16715 .option prdr_enable main boolean false
16716 .cindex "PRDR" "enabling on server"
16717 This option can be used to enable the Per-Recipient Data Response extension
16718 to SMTP, defined by Eric Hall.
16719 If the option is set, PRDR is advertised by Exim when operating as a server.
16720 If the client requests PRDR, and more than one recipient, for a message
16721 an additional ACL is called for each recipient after the message content
16722 is received.  See section &<<SECTPRDRACL>>&.
16723
16724 .option preserve_message_logs main boolean false
16725 .cindex "message logs" "preserving"
16726 If this option is set, message log files are not deleted when messages are
16727 completed. Instead, they are moved to a sub-directory of the spool directory
16728 called &_msglog.OLD_&, where they remain available for statistical or debugging
16729 purposes. This is a dangerous option to set on systems with any appreciable
16730 volume of mail. Use with care!
16731
16732
16733 .option primary_hostname main string "see below"
16734 .cindex "name" "of local host"
16735 .cindex "host" "name of local"
16736 .cindex "local host" "name of"
16737 .vindex "&$primary_hostname$&"
16738 This specifies the name of the current host. It is used in the default EHLO or
16739 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16740 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16741 The value is also used by default in some SMTP response messages from an Exim
16742 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16743
16744 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16745 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16746 contains only one component, Exim passes it to &[gethostbyname()]& (or
16747 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16748 version. The variable &$primary_hostname$& contains the host name, whether set
16749 explicitly by this option, or defaulted.
16750
16751
16752 .option print_topbitchars main boolean false
16753 .cindex "printing characters"
16754 .cindex "8-bit characters"
16755 By default, Exim considers only those characters whose codes lie in the range
16756 32&--126 to be printing characters. In a number of circumstances (for example,
16757 when writing log entries) non-printing characters are converted into escape
16758 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16759 is set, code values of 128 and above are also considered to be printing
16760 characters.
16761
16762 This option also affects the header syntax checks performed by the
16763 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16764 the user's full name when constructing From: and Sender: addresses (as
16765 described in section &<<SECTconstr>>&). Setting this option can cause
16766 Exim to generate eight bit message headers that do not conform to the
16767 standards.
16768
16769
16770 .option process_log_path main string unset
16771 .cindex "process log path"
16772 .cindex "log" "process log"
16773 .cindex "&'exiwhat'&"
16774 This option sets the name of the file to which an Exim process writes its
16775 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16776 utility script. If this option is unset, the file called &_exim-process.info_&
16777 in Exim's spool directory is used. The ability to specify the name explicitly
16778 can be useful in environments where two different Exims are running, using
16779 different spool directories.
16780
16781
16782 .option prod_requires_admin main boolean true
16783 .cindex "restricting access to features"
16784 .oindex "&%-M%&"
16785 .oindex "&%-R%&"
16786 .oindex "&%-q%&"
16787 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16788 admin user unless &%prod_requires_admin%& is set false. See also
16789 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16790
16791
16792 .option qualify_domain main string "see below"
16793 .cindex "domain" "for qualifying addresses"
16794 .cindex "address" "qualification"
16795 This option specifies the domain name that is added to any envelope sender
16796 addresses that do not have a domain qualification. It also applies to
16797 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16798 are accepted by default only for locally-generated messages. Qualification is
16799 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16800 locally-generated messages, unless the &%-bnq%& command line option is used.
16801
16802 Messages from external sources must always contain fully qualified addresses,
16803 unless the sending host matches &%sender_unqualified_hosts%& or
16804 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16805 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16806 necessary. Internally, Exim always works with fully qualified envelope
16807 addresses. If &%qualify_domain%& is not set, it defaults to the
16808 &%primary_hostname%& value.
16809
16810
16811 .option qualify_recipient main string "see below"
16812 This option allows you to specify a different domain for qualifying recipient
16813 addresses to the one that is used for senders. See &%qualify_domain%& above.
16814
16815
16816
16817 .option queue_domains main "domain list&!!" unset
16818 .cindex "domain" "specifying non-immediate delivery"
16819 .cindex "queueing incoming messages"
16820 .cindex "message" "queueing certain domains"
16821 This option lists domains for which immediate delivery is not required.
16822 A delivery process is started whenever a message is received, but only those
16823 domains that do not match are processed. All other deliveries wait until the
16824 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16825
16826
16827 .option queue_list_requires_admin main boolean true
16828 .cindex "restricting access to features"
16829 .oindex "&%-bp%&"
16830 The &%-bp%& command-line option, which lists the messages that are on the
16831 queue, requires the caller to be an admin user unless
16832 &%queue_list_requires_admin%& is set false.
16833 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16834
16835
16836 .option queue_only main boolean false
16837 .cindex "queueing incoming messages"
16838 .cindex "message" "queueing unconditionally"
16839 If &%queue_only%& is set, a delivery process is not automatically started
16840 whenever a message is received. Instead, the message waits in the queue for the
16841 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16842 delivered immediately when certain conditions (such as heavy load) occur.
16843
16844 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16845 and &%-odi%& command line options override &%queue_only%& unless
16846 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16847 &%queue_only_load%&, and &%smtp_accept_queue%&.
16848
16849
16850 .option queue_only_file main string unset
16851 .cindex "queueing incoming messages"
16852 .cindex "message" "queueing by file existence"
16853 This option can be set to a colon-separated list of absolute path names, each
16854 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16855 it tests for the existence of each listed path using a call to &[stat()]&. For
16856 each path that exists, the corresponding queueing option is set.
16857 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16858 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16859 .code
16860 queue_only_file = smtp/some/file
16861 .endd
16862 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16863 &_/some/file_& exists.
16864
16865
16866 .option queue_only_load main fixed-point unset
16867 .cindex "load average"
16868 .cindex "queueing incoming messages"
16869 .cindex "message" "queueing by load"
16870 If the system load average is higher than this value, incoming messages from
16871 all sources are queued, and no automatic deliveries are started. If this
16872 happens during local or remote SMTP input, all subsequent messages received on
16873 the same SMTP connection are queued by default, whatever happens to the load in
16874 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16875 false.
16876
16877 Deliveries will subsequently be performed by queue runner processes. This
16878 option has no effect on ancient operating systems on which Exim cannot
16879 determine the load average. See also &%deliver_queue_load_max%& and
16880 &%smtp_load_reserve%&.
16881
16882
16883 .option queue_only_load_latch main boolean true
16884 .cindex "load average" "re-evaluating per message"
16885 When this option is true (the default), once one message has been queued
16886 because the load average is higher than the value set by &%queue_only_load%&,
16887 all subsequent messages received on the same SMTP connection are also queued.
16888 This is a deliberate choice; even though the load average may fall below the
16889 threshold, it doesn't seem right to deliver later messages on the same
16890 connection when not delivering earlier ones. However, there are special
16891 circumstances such as very long-lived connections from scanning appliances
16892 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16893 should be set false. This causes the value of the load average to be
16894 re-evaluated for each message.
16895
16896
16897 .option queue_only_override main boolean true
16898 .cindex "queueing incoming messages"
16899 When this option is true, the &%-od%&&'x'& command line options override the
16900 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16901 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16902 to override; they are accepted, but ignored.
16903
16904
16905 .option queue_run_in_order main boolean false
16906 .cindex "queue runner" "processing messages in order"
16907 If this option is set, queue runs happen in order of message arrival instead of
16908 in an arbitrary order. For this to happen, a complete list of the entire queue
16909 must be set up before the deliveries start. When the queue is all held in a
16910 single directory (the default), a single list is created for both the ordered
16911 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16912 single list is not created when &%queue_run_in_order%& is false. In this case,
16913 the sub-directories are processed one at a time (in a random order), and this
16914 avoids setting up one huge list for the whole queue. Thus, setting
16915 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16916 when the queue is large, because of the extra work in setting up the single,
16917 large list. In most situations, &%queue_run_in_order%& should not be set.
16918
16919
16920
16921 .option queue_run_max main integer&!! 5
16922 .cindex "queue runner" "maximum number of"
16923 This controls the maximum number of queue runner processes that an Exim daemon
16924 can run simultaneously. This does not mean that it starts them all at once,
16925 but rather that if the maximum number are still running when the time comes to
16926 start another one, it refrains from starting another one. This can happen with
16927 very large queues and/or very sluggish deliveries. This option does not,
16928 however, interlock with other processes, so additional queue runners can be
16929 started by other means, or by killing and restarting the daemon.
16930
16931 Setting this option to zero does not suppress queue runs; rather, it disables
16932 the limit, allowing any number of simultaneous queue runner processes to be
16933 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16934 the daemon's command line.
16935
16936 .cindex queues named
16937 .cindex "named queues" "resource limit"
16938 To set limits for different named queues use
16939 an expansion depending on the &$queue_name$& variable.
16940
16941 .option queue_smtp_domains main "domain list&!!" unset
16942 .cindex "queueing incoming messages"
16943 .cindex "message" "queueing remote deliveries"
16944 .cindex "first pass routing"
16945 When this option is set, a delivery process is started whenever a message is
16946 received, routing is performed, and local deliveries take place.
16947 However, if any SMTP deliveries are required for domains that match
16948 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16949 message waits in the queue for the next queue run. Since routing of the message
16950 has taken place, Exim knows to which remote hosts it must be delivered, and so
16951 when the queue run happens, multiple messages for the same host are delivered
16952 over a single SMTP connection. The &%-odqs%& command line option causes all
16953 SMTP deliveries to be queued in this way, and is equivalent to setting
16954 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16955 &%queue_domains%&.
16956
16957
16958 .option receive_timeout main time 0s
16959 .cindex "timeout" "for non-SMTP input"
16960 This option sets the timeout for accepting a non-SMTP message, that is, the
16961 maximum time that Exim waits when reading a message on the standard input. If
16962 the value is zero, it will wait forever. This setting is overridden by the
16963 &%-or%& command line option. The timeout for incoming SMTP messages is
16964 controlled by &%smtp_receive_timeout%&.
16965
16966 .option received_header_text main string&!! "see below"
16967 .cindex "customizing" "&'Received:'& header"
16968 .cindex "&'Received:'& header line" "customizing"
16969 This string defines the contents of the &'Received:'& message header that is
16970 added to each message, except for the timestamp, which is automatically added
16971 on at the end (preceded by a semicolon). The string is expanded each time it is
16972 used. If the expansion yields an empty string, no &'Received:'& header line is
16973 added to the message. Otherwise, the string should start with the text
16974 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16975 header lines.
16976 The default setting is:
16977
16978 .code
16979 received_header_text = Received: \
16980   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16981     {${if def:sender_ident \
16982       {from ${quote_local_part:$sender_ident} }}\
16983         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16984   by $primary_hostname \
16985   ${if def:received_protocol {with $received_protocol }}\
16986   ${if def:tls_ver           { ($tls_ver)}}\
16987   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16988   (Exim $version_number)\n\t\
16989   ${if def:sender_address \
16990   {(envelope-from <$sender_address>)\n\t}}\
16991   id $message_exim_id\
16992   ${if def:received_for {\n\tfor $received_for}}
16993 .endd
16994
16995 The reference to the TLS cipher is omitted when Exim is built without TLS
16996 support. The use of conditional expansions ensures that this works for both
16997 locally generated messages and messages received from remote hosts, giving
16998 header lines such as the following:
16999 .code
17000 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17001 by marley.carol.example with esmtp (Exim 4.00)
17002 (envelope-from <bob@carol.example>)
17003 id 16IOWa-00019l-00
17004 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17005 Received: by scrooge.carol.example with local (Exim 4.00)
17006 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17007 .endd
17008 Until the body of the message has been received, the timestamp is the time when
17009 the message started to be received. Once the body has arrived, and all policy
17010 checks have taken place, the timestamp is updated to the time at which the
17011 message was accepted.
17012
17013
17014 .option received_headers_max main integer 30
17015 .cindex "loop" "prevention"
17016 .cindex "mail loop prevention"
17017 .cindex "&'Received:'& header line" "counting"
17018 When a message is to be delivered, the number of &'Received:'& headers is
17019 counted, and if it is greater than this parameter, a mail loop is assumed to
17020 have occurred, the delivery is abandoned, and an error message is generated.
17021 This applies to both local and remote deliveries.
17022
17023
17024 .option recipient_unqualified_hosts main "host list&!!" unset
17025 .cindex "unqualified addresses"
17026 .cindex "host" "unqualified addresses from"
17027 This option lists those hosts from which Exim is prepared to accept unqualified
17028 recipient addresses in message envelopes. The addresses are made fully
17029 qualified by the addition of the &%qualify_recipient%& value. This option also
17030 affects message header lines. Exim does not reject unqualified recipient
17031 addresses in headers, but it qualifies them only if the message came from a
17032 host that matches &%recipient_unqualified_hosts%&,
17033 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17034 option was not set.
17035
17036
17037 .option recipients_max main integer 0
17038 .cindex "limit" "number of recipients"
17039 .cindex "recipient" "maximum number"
17040 If this option is set greater than zero, it specifies the maximum number of
17041 original recipients for any message. Additional recipients that are generated
17042 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17043 all recipients over the limit; earlier recipients are delivered as normal.
17044 Non-SMTP messages with too many recipients are failed, and no deliveries are
17045 done.
17046
17047 .cindex "RCPT" "maximum number of incoming"
17048 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17049 RCPT commands in a single message.
17050
17051
17052 .option recipients_max_reject main boolean false
17053 If this option is set true, Exim rejects SMTP messages containing too many
17054 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17055 error to the eventual DATA command. Otherwise (the default) it gives a 452
17056 error to the surplus RCPT commands and accepts the message on behalf of the
17057 initial set of recipients. The remote server should then re-send the message
17058 for the remaining recipients at a later time.
17059
17060
17061 .option remote_max_parallel main integer 2
17062 .cindex "delivery" "parallelism for remote"
17063 This option controls parallel delivery of one message to a number of remote
17064 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17065 does all the remote deliveries for a message one by one. Otherwise, if a single
17066 message has to be delivered to more than one remote host, or if several copies
17067 have to be sent to the same remote host, up to &%remote_max_parallel%&
17068 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17069 deliveries are required, the maximum number of processes are started, and as
17070 each one finishes, another is begun. The order of starting processes is the
17071 same as if sequential delivery were being done, and can be controlled by the
17072 &%remote_sort_domains%& option. If parallel delivery takes place while running
17073 with debugging turned on, the debugging output from each delivery process is
17074 tagged with its process id.
17075
17076 This option controls only the maximum number of parallel deliveries for one
17077 message in one Exim delivery process. Because Exim has no central queue
17078 manager, there is no way of controlling the total number of simultaneous
17079 deliveries if the configuration allows a delivery attempt as soon as a message
17080 is received.
17081
17082 .cindex "number of deliveries"
17083 .cindex "delivery" "maximum number of"
17084 If you want to control the total number of deliveries on the system, you
17085 need to set the &%queue_only%& option. This ensures that all incoming messages
17086 are added to the queue without starting a delivery process. Then set up an Exim
17087 daemon to start queue runner processes at appropriate intervals (probably
17088 fairly often, for example, every minute), and limit the total number of queue
17089 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17090 delivers only one message at a time, the maximum number of deliveries that can
17091 then take place at once is &%queue_run_max%& multiplied by
17092 &%remote_max_parallel%&.
17093
17094 If it is purely remote deliveries you want to control, use
17095 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17096 doing the SMTP routing before queueing, so that several messages for the same
17097 host will eventually get delivered down the same connection.
17098
17099
17100 .option remote_sort_domains main "domain list&!!" unset
17101 .cindex "sorting remote deliveries"
17102 .cindex "delivery" "sorting remote"
17103 When there are a number of remote deliveries for a message, they are sorted by
17104 domain into the order given by this list. For example,
17105 .code
17106 remote_sort_domains = *.cam.ac.uk:*.uk
17107 .endd
17108 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17109 then to those in the &%uk%& domain, then to any others.
17110
17111
17112 .option retry_data_expire main time 7d
17113 .cindex "hints database" "data expiry"
17114 This option sets a &"use before"& time on retry information in Exim's hints
17115 database. Any older retry data is ignored. This means that, for example, once a
17116 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17117 past failures.
17118
17119
17120 .option retry_interval_max main time 24h
17121 .cindex "retry" "limit on interval"
17122 .cindex "limit" "on retry interval"
17123 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17124 intervals between delivery attempts for messages that cannot be delivered
17125 straight away. This option sets an overall limit to the length of time between
17126 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17127 the default value.
17128
17129
17130 .option return_path_remove main boolean true
17131 .cindex "&'Return-path:'& header line" "removing"
17132 RFC 2821, section 4.4, states that an SMTP server must insert a
17133 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17134 The &'Return-path:'& header preserves the sender address as received in the
17135 MAIL command. This description implies that this header should not be present
17136 in an incoming message. If &%return_path_remove%& is true, any existing
17137 &'Return-path:'& headers are removed from messages at the time they are
17138 received. Exim's transports have options for adding &'Return-path:'& headers at
17139 the time of delivery. They are normally used only for final local deliveries.
17140
17141
17142 .option return_size_limit main integer 100K
17143 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17144
17145
17146 .option rfc1413_hosts main "host list&!!" @[]
17147 .cindex "RFC 1413"
17148 .cindex "host" "for RFC 1413 calls"
17149 RFC 1413 identification calls are made to any client host which matches
17150 an item in the list.
17151 The default value specifies just this host, being any local interface
17152 for the system.
17153
17154 .option rfc1413_query_timeout main time 0s
17155 .cindex "RFC 1413" "query timeout"
17156 .cindex "timeout" "for RFC 1413 call"
17157 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17158 no RFC 1413 calls are ever made.
17159
17160
17161 .option sender_unqualified_hosts main "host list&!!" unset
17162 .cindex "unqualified addresses"
17163 .cindex "host" "unqualified addresses from"
17164 This option lists those hosts from which Exim is prepared to accept unqualified
17165 sender addresses. The addresses are made fully qualified by the addition of
17166 &%qualify_domain%&. This option also affects message header lines. Exim does
17167 not reject unqualified addresses in headers that contain sender addresses, but
17168 it qualifies them only if the message came from a host that matches
17169 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17170 using TCP/IP), and the &%-bnq%& option was not set.
17171
17172
17173 .option slow_lookup_log main integer 0
17174 .cindex "logging" "slow lookups"
17175 .cindex "dns" "logging slow lookups"
17176 This option controls logging of slow lookups.
17177 If the value is nonzero it is taken as a number of milliseconds
17178 and lookups taking longer than this are logged.
17179 Currently this applies only to DNS lookups.
17180
17181
17182
17183 .option smtp_accept_keepalive main boolean true
17184 .cindex "keepalive" "on incoming connection"
17185 This option controls the setting of the SO_KEEPALIVE option on incoming
17186 TCP/IP socket connections. When set, it causes the kernel to probe idle
17187 connections periodically, by sending packets with &"old"& sequence numbers. The
17188 other end of the connection should send an acknowledgment if the connection is
17189 still okay or a reset if the connection has been aborted. The reason for doing
17190 this is that it has the beneficial effect of freeing up certain types of
17191 connection that can get stuck when the remote host is disconnected without
17192 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17193 hours to detect unreachable hosts.
17194
17195
17196
17197 .option smtp_accept_max main integer 20
17198 .cindex "limit" "incoming SMTP connections"
17199 .cindex "SMTP" "incoming connection count"
17200 .cindex "inetd"
17201 This option specifies the maximum number of simultaneous incoming SMTP calls
17202 that Exim will accept. It applies only to the listening daemon; there is no
17203 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17204 value is set to zero, no limit is applied. However, it is required to be
17205 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17206 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17207
17208 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17209 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17210 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17211 and &%smtp_load_reserve%& are then checked before accepting the connection.
17212
17213
17214 .option smtp_accept_max_nonmail main integer 10
17215 .cindex "limit" "non-mail SMTP commands"
17216 .cindex "SMTP" "limiting non-mail commands"
17217 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17218 the connection if there are too many. This option defines &"too many"&. The
17219 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17220 client looping sending EHLO, for example. The check is applied only if the
17221 client host matches &%smtp_accept_max_nonmail_hosts%&.
17222
17223 When a new message is expected, one occurrence of RSET is not counted. This
17224 allows a client to send one RSET between messages (this is not necessary,
17225 but some clients do it). Exim also allows one uncounted occurrence of HELO
17226 or EHLO, and one occurrence of STARTTLS between messages. After
17227 starting up a TLS session, another EHLO is expected, and so it too is not
17228 counted. The first occurrence of AUTH in a connection, or immediately
17229 following STARTTLS is not counted. Otherwise, all commands other than
17230 MAIL, RCPT, DATA, and QUIT are counted.
17231
17232
17233 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17234 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17235 check by setting this option. The default value makes it apply to all hosts. By
17236 changing the value, you can exclude any badly-behaved hosts that you have to
17237 live with.
17238
17239
17240 . Allow this long option name to split; give it unsplit as a fifth argument
17241 . for the automatic .oindex that is generated by .option.
17242 . We insert " &~&~" which is both pretty nasty visually and results in
17243 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17244 . zero-width-space, which would be nicer visually and results in (at least)
17245 . html that Firefox will split on when it's forced to reflow (rather than
17246 . inserting a horizontal scrollbar).  However, the text is still not
17247 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17248 . the option name to split.
17249
17250 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17251          smtp_accept_max_per_connection
17252 .cindex "SMTP" "limiting incoming message count"
17253 .cindex "limit" "messages per SMTP connection"
17254 The value of this option limits the number of MAIL commands that Exim is
17255 prepared to accept over a single SMTP connection, whether or not each command
17256 results in the transfer of a message. After the limit is reached, a 421
17257 response is given to subsequent MAIL commands. This limit is a safety
17258 precaution against a client that goes mad (incidents of this type have been
17259 seen).
17260
17261
17262 .option smtp_accept_max_per_host main string&!! unset
17263 .cindex "limit" "SMTP connections from one host"
17264 .cindex "host" "limiting SMTP connections from"
17265 This option restricts the number of simultaneous IP connections from a single
17266 host (strictly, from a single IP address) to the Exim daemon. The option is
17267 expanded, to enable different limits to be applied to different hosts by
17268 reference to &$sender_host_address$&. Once the limit is reached, additional
17269 connection attempts from the same host are rejected with error code 421. This
17270 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17271 of zero imposes no limit. If this option is set greater than zero, it is
17272 required that &%smtp_accept_max%& be non-zero.
17273
17274 &*Warning*&: When setting this option you should not use any expansion
17275 constructions that take an appreciable amount of time. The expansion and test
17276 happen in the main daemon loop, in order to reject additional connections
17277 without forking additional processes (otherwise a denial-of-service attack
17278 could cause a vast number or processes to be created). While the daemon is
17279 doing this processing, it cannot accept any other incoming connections.
17280
17281
17282
17283 .option smtp_accept_queue main integer 0
17284 .cindex "SMTP" "incoming connection count"
17285 .cindex "queueing incoming messages"
17286 .cindex "message" "queueing by SMTP connection count"
17287 If the number of simultaneous incoming SMTP connections being handled via the
17288 listening daemon exceeds this value, messages received by SMTP are just placed
17289 in the queue; no delivery processes are started automatically. The count is
17290 fixed at the start of an SMTP connection. It cannot be updated in the
17291 subprocess that receives messages, and so the queueing or not queueing applies
17292 to all messages received in the same connection.
17293
17294 A value of zero implies no limit, and clearly any non-zero value is useful only
17295 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17296 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17297 various &%-od%&&'x'& command line options.
17298
17299
17300 . See the comment on smtp_accept_max_per_connection
17301
17302 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17303          smtp_accept_queue_per_connection
17304 .cindex "queueing incoming messages"
17305 .cindex "message" "queueing by message count"
17306 This option limits the number of delivery processes that Exim starts
17307 automatically when receiving messages via SMTP, whether via the daemon or by
17308 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17309 and the number of messages received in a single SMTP session exceeds this
17310 number, subsequent messages are placed in the queue, but no delivery processes
17311 are started. This helps to limit the number of Exim processes when a server
17312 restarts after downtime and there is a lot of mail waiting for it on other
17313 systems. On large systems, the default should probably be increased, and on
17314 dial-in client systems it should probably be set to zero (that is, disabled).
17315
17316
17317 .option smtp_accept_reserve main integer 0
17318 .cindex "SMTP" "incoming call count"
17319 .cindex "host" "reserved"
17320 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17321 number of SMTP connections that are reserved for connections from the hosts
17322 that are specified in &%smtp_reserve_hosts%&. The value set in
17323 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17324 restricted to this number of connections; the option specifies a minimum number
17325 of connection slots for them, not a maximum. It is a guarantee that this group
17326 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17327 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17328 individual host.
17329
17330 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17331 set to 5, once there are 45 active connections (from any hosts), new
17332 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17333 provided the other criteria for acceptance are met.
17334
17335
17336 .option smtp_active_hostname main string&!! unset
17337 .cindex "host" "name in SMTP responses"
17338 .cindex "SMTP" "host name in responses"
17339 .vindex "&$primary_hostname$&"
17340 This option is provided for multi-homed servers that want to masquerade as
17341 several different hosts. At the start of an incoming SMTP connection, its value
17342 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17343 responses. For example, it is used as domain name in the response to an
17344 incoming HELO or EHLO command.
17345
17346 .vindex "&$smtp_active_hostname$&"
17347 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17348 is saved with any messages that are received. It is therefore available for use
17349 in routers and transports when the message is later delivered.
17350
17351 If this option is unset, or if its expansion is forced to fail, or if the
17352 expansion results in an empty string, the value of &$primary_hostname$& is
17353 used. Other expansion failures cause a message to be written to the main and
17354 panic logs, and the SMTP command receives a temporary error. Typically, the
17355 value of &%smtp_active_hostname%& depends on the incoming interface address.
17356 For example:
17357 .code
17358 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17359   {cox.mydomain}{box.mydomain}}
17360 .endd
17361
17362 Although &$smtp_active_hostname$& is primarily concerned with incoming
17363 messages, it is also used as the default for HELO commands in callout
17364 verification if there is no remote transport from which to obtain a
17365 &%helo_data%& value.
17366
17367 .option smtp_banner main string&!! "see below"
17368 .cindex "SMTP" "welcome banner"
17369 .cindex "banner for SMTP"
17370 .cindex "welcome banner for SMTP"
17371 .cindex "customizing" "SMTP banner"
17372 This string, which is expanded every time it is used, is output as the initial
17373 positive response to an SMTP connection. The default setting is:
17374 .code
17375 smtp_banner = $smtp_active_hostname ESMTP Exim \
17376   $version_number $tod_full
17377 .endd
17378 Failure to expand the string causes a panic error. If you want to create a
17379 multiline response to the initial SMTP connection, use &"\n"& in the string at
17380 appropriate points, but not at the end. Note that the 220 code is not included
17381 in this string. Exim adds it automatically (several times in the case of a
17382 multiline response).
17383
17384
17385 .option smtp_check_spool_space main boolean true
17386 .cindex "checking disk space"
17387 .cindex "disk space, checking"
17388 .cindex "spool directory" "checking space"
17389 When this option is set, if an incoming SMTP session encounters the SIZE
17390 option on a MAIL command, it checks that there is enough space in the
17391 spool directory's partition to accept a message of that size, while still
17392 leaving free the amount specified by &%check_spool_space%& (even if that value
17393 is zero). If there isn't enough space, a temporary error code is returned.
17394
17395
17396 .option smtp_connect_backlog main integer 20
17397 .cindex "connection backlog"
17398 .cindex "SMTP" "connection backlog"
17399 .cindex "backlog of connections"
17400 This option specifies a maximum number of waiting SMTP connections. Exim passes
17401 this value to the TCP/IP system when it sets up its listener. Once this number
17402 of connections are waiting for the daemon's attention, subsequent connection
17403 attempts are refused at the TCP/IP level. At least, that is what the manuals
17404 say; in some circumstances such connection attempts have been observed to time
17405 out instead. For large systems it is probably a good idea to increase the
17406 value (to 50, say). It also gives some protection against denial-of-service
17407 attacks by SYN flooding.
17408
17409
17410 .option smtp_enforce_sync main boolean true
17411 .cindex "SMTP" "synchronization checking"
17412 .cindex "synchronization checking in SMTP"
17413 The SMTP protocol specification requires the client to wait for a response from
17414 the server at certain points in the dialogue. Without PIPELINING these
17415 synchronization points are after every command; with PIPELINING they are
17416 fewer, but they still exist.
17417
17418 Some spamming sites send out a complete set of SMTP commands without waiting
17419 for any response. Exim protects against this by rejecting a message if the
17420 client has sent further input when it should not have. The error response &"554
17421 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17422 for this error cannot be perfect because of transmission delays (unexpected
17423 input may be on its way but not yet received when Exim checks). However, it
17424 does detect many instances.
17425
17426 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17427 If you want to disable the check selectively (for example, only for certain
17428 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17429 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17430
17431
17432
17433 .option smtp_etrn_command main string&!! unset
17434 .cindex "ETRN" "command to be run"
17435 .vindex "&$domain$&"
17436 If this option is set, the given command is run whenever an SMTP ETRN
17437 command is received from a host that is permitted to issue such commands (see
17438 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17439 are independently expanded. The expansion variable &$domain$& is set to the
17440 argument of the ETRN command, and no syntax checking is done on it. For
17441 example:
17442 .code
17443 smtp_etrn_command = /etc/etrn_command $domain \
17444                     $sender_host_address
17445 .endd
17446 .new
17447 If the option is not set, the argument for the ETRN command must
17448 be a &'#'& followed by an address string.
17449 In this case an &'exim -R <string>'& command is used;
17450 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17451 .wen
17452
17453 A new process is created to run the command, but Exim does not wait for it to
17454 complete. Consequently, its status cannot be checked. If the command cannot be
17455 run, a line is written to the panic log, but the ETRN caller still receives
17456 a 250 success response. Exim is normally running under its own uid when
17457 receiving SMTP, so it is not possible for it to change the uid before running
17458 the command.
17459
17460
17461 .option smtp_etrn_serialize main boolean true
17462 .cindex "ETRN" "serializing"
17463 When this option is set, it prevents the simultaneous execution of more than
17464 one identical command as a result of ETRN in an SMTP connection. See
17465 section &<<SECTETRN>>& for details.
17466
17467
17468 .option smtp_load_reserve main fixed-point unset
17469 .cindex "load average"
17470 If the system load average ever gets higher than this, incoming SMTP calls are
17471 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17472 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17473 the load is over the limit. The option has no effect on ancient operating
17474 systems on which Exim cannot determine the load average. See also
17475 &%deliver_queue_load_max%& and &%queue_only_load%&.
17476
17477
17478
17479 .option smtp_max_synprot_errors main integer 3
17480 .cindex "SMTP" "limiting syntax and protocol errors"
17481 .cindex "limit" "SMTP syntax and protocol errors"
17482 Exim rejects SMTP commands that contain syntax or protocol errors. In
17483 particular, a syntactically invalid email address, as in this command:
17484 .code
17485 RCPT TO:<abc xyz@a.b.c>
17486 .endd
17487 causes immediate rejection of the command, before any other tests are done.
17488 (The ACL cannot be run if there is no valid address to set up for it.) An
17489 example of a protocol error is receiving RCPT before MAIL. If there are
17490 too many syntax or protocol errors in one SMTP session, the connection is
17491 dropped. The limit is set by this option.
17492
17493 .cindex "PIPELINING" "expected errors"
17494 When the PIPELINING extension to SMTP is in use, some protocol errors are
17495 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17496 Exim assumes that PIPELINING will be used if it advertises it (see
17497 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17498 not count towards the limit.
17499
17500
17501
17502 .option smtp_max_unknown_commands main integer 3
17503 .cindex "SMTP" "limiting unknown commands"
17504 .cindex "limit" "unknown SMTP commands"
17505 If there are too many unrecognized commands in an incoming SMTP session, an
17506 Exim server drops the connection. This is a defence against some kinds of abuse
17507 that subvert web
17508 clients
17509 into making connections to SMTP ports; in these circumstances, a number of
17510 non-SMTP command lines are sent first.
17511
17512
17513
17514 .option smtp_ratelimit_hosts main "host list&!!" unset
17515 .cindex "SMTP" "rate limiting"
17516 .cindex "limit" "rate of message arrival"
17517 .cindex "RCPT" "rate limiting"
17518 Some sites find it helpful to be able to limit the rate at which certain hosts
17519 can send them messages, and the rate at which an individual message can specify
17520 recipients.
17521
17522 Exim has two rate-limiting facilities. This section describes the older
17523 facility, which can limit rates within a single connection. The newer
17524 &%ratelimit%& ACL condition can limit rates across all connections. See section
17525 &<<SECTratelimiting>>& for details of the newer facility.
17526
17527 When a host matches &%smtp_ratelimit_hosts%&, the values of
17528 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17529 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17530 respectively. Each option, if set, must contain a set of four comma-separated
17531 values:
17532
17533 .ilist
17534 A threshold, before which there is no rate limiting.
17535 .next
17536 An initial time delay. Unlike other times in Exim, numbers with decimal
17537 fractional parts are allowed here.
17538 .next
17539 A factor by which to increase the delay each time.
17540 .next
17541 A maximum value for the delay. This should normally be less than 5 minutes,
17542 because after that time, the client is liable to timeout the SMTP command.
17543 .endlist
17544
17545 For example, these settings have been used successfully at the site which
17546 first suggested this feature, for controlling mail from their customers:
17547 .code
17548 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17549 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17550 .endd
17551 The first setting specifies delays that are applied to MAIL commands after
17552 two have been received over a single connection. The initial delay is 0.5
17553 seconds, increasing by a factor of 1.05 each time. The second setting applies
17554 delays to RCPT commands when more than four occur in a single message.
17555
17556
17557 .option smtp_ratelimit_mail main string unset
17558 See &%smtp_ratelimit_hosts%& above.
17559
17560
17561 .option smtp_ratelimit_rcpt main string unset
17562 See &%smtp_ratelimit_hosts%& above.
17563
17564
17565 .option smtp_receive_timeout main time&!! 5m
17566 .cindex "timeout" "for SMTP input"
17567 .cindex "SMTP" "input timeout"
17568 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17569 input, including batch SMTP. If a line of input (either an SMTP command or a
17570 data line) is not received within this time, the SMTP connection is dropped and
17571 the message is abandoned.
17572 A line is written to the log containing one of the following messages:
17573 .code
17574 SMTP command timeout on connection from...
17575 SMTP data timeout on connection from...
17576 .endd
17577 The former means that Exim was expecting to read an SMTP command; the latter
17578 means that it was in the DATA phase, reading the contents of a message.
17579
17580 If the first character of the option is a &"$"& the option is
17581 expanded before use and may depend on
17582 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17583
17584
17585 .oindex "&%-os%&"
17586 The value set by this option can be overridden by the
17587 &%-os%& command-line option. A setting of zero time disables the timeout, but
17588 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17589 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17590 timeout is controlled by &%receive_timeout%& and &%-or%&.
17591
17592
17593 .option smtp_reserve_hosts main "host list&!!" unset
17594 This option defines hosts for which SMTP connections are reserved; see
17595 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17596
17597
17598 .option smtp_return_error_details main boolean false
17599 .cindex "SMTP" "details policy failures"
17600 .cindex "policy control" "rejection, returning details"
17601 In the default state, Exim uses bland messages such as
17602 &"Administrative prohibition"& when it rejects SMTP commands for policy
17603 reasons. Many sysadmins like this because it gives away little information
17604 to spammers. However, some other sysadmins who are applying strict checking
17605 policies want to give out much fuller information about failures. Setting
17606 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17607 example, instead of &"Administrative prohibition"&, it might give:
17608 .code
17609 550-Rejected after DATA: '>' missing at end of address:
17610 550 failing address in "From" header is: <user@dom.ain
17611 .endd
17612
17613
17614 .option smtputf8_advertise_hosts main "host list&!!" *
17615 .cindex "SMTPUTF8" "advertising"
17616 When Exim is built with support for internationalised mail names,
17617 the availability thereof is advertised in
17618 response to EHLO only to those client hosts that match this option. See
17619 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17620
17621
17622 .option spamd_address main string "127.0.0.1 783"
17623 This option is available when Exim is compiled with the content-scanning
17624 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17625 See section &<<SECTscanspamass>>& for more details.
17626
17627
17628
17629 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17630 This option is available when Exim is compiled with SPF support.
17631 See section &<<SECSPF>>& for more details.
17632
17633
17634
17635 .option split_spool_directory main boolean false
17636 .cindex "multiple spool directories"
17637 .cindex "spool directory" "split"
17638 .cindex "directories, multiple"
17639 If this option is set, it causes Exim to split its input directory into 62
17640 subdirectories, each with a single alphanumeric character as its name. The
17641 sixth character of the message id is used to allocate messages to
17642 subdirectories; this is the least significant base-62 digit of the time of
17643 arrival of the message.
17644
17645 Splitting up the spool in this way may provide better performance on systems
17646 where there are long mail queues, by reducing the number of files in any one
17647 directory. The msglog directory is also split up in a similar way to the input
17648 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17649 are still placed in the single directory &_msglog.OLD_&.
17650
17651 It is not necessary to take any special action for existing messages when
17652 changing &%split_spool_directory%&. Exim notices messages that are in the
17653 &"wrong"& place, and continues to process them. If the option is turned off
17654 after a period of being on, the subdirectories will eventually empty and be
17655 automatically deleted.
17656
17657 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17658 changes. Instead of creating a list of all messages in the queue, and then
17659 trying to deliver each one, in turn, it constructs a list of those in one
17660 sub-directory and tries to deliver them, before moving on to the next
17661 sub-directory. The sub-directories are processed in a random order. This
17662 spreads out the scanning of the input directories, and uses less memory. It is
17663 particularly beneficial when there are lots of messages in the queue. However,
17664 if &%queue_run_in_order%& is set, none of this new processing happens. The
17665 entire queue has to be scanned and sorted before any deliveries can start.
17666
17667
17668 .option spool_directory main string&!! "set at compile time"
17669 .cindex "spool directory" "path to"
17670 This defines the directory in which Exim keeps its spool, that is, the messages
17671 it is waiting to deliver. The default value is taken from the compile-time
17672 configuration setting, if there is one. If not, this option must be set. The
17673 string is expanded, so it can contain, for example, a reference to
17674 &$primary_hostname$&.
17675
17676 If the spool directory name is fixed on your installation, it is recommended
17677 that you set it at build time rather than from this option, particularly if the
17678 log files are being written to the spool directory (see &%log_file_path%&).
17679 Otherwise log files cannot be used for errors that are detected early on, such
17680 as failures in the configuration file.
17681
17682 By using this option to override the compiled-in path, it is possible to run
17683 tests of Exim without using the standard spool.
17684
17685 .option spool_wireformat main boolean false
17686 .cindex "spool directory" "file formats"
17687 If this option is set, Exim may for some messages use an alternative format
17688 for data-files in the spool which matches the wire format.
17689 Doing this permits more efficient message reception and transmission.
17690 Currently it is only done for messages received using the ESMTP CHUNKING
17691 option.
17692
17693 The following variables will not have useful values:
17694 .code
17695 $max_received_linelength
17696 $body_linecount
17697 $body_zerocount
17698 .endd
17699
17700 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17701 and any external programs which are passed a reference to a message data file
17702 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17703 will need to be aware of the different formats potentially available.
17704
17705 Using any of the ACL conditions noted will negate the reception benefit
17706 (as a Unix-mbox-format file is constructed for them).
17707 The transmission benefit is maintained.
17708
17709 .option sqlite_lock_timeout main time 5s
17710 .cindex "sqlite lookup type" "lock timeout"
17711 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17712 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17713
17714 .option strict_acl_vars main boolean false
17715 .cindex "&ACL;" "variables, handling unset"
17716 This option controls what happens if a syntactically valid but undefined ACL
17717 variable is referenced. If it is false (the default), an empty string
17718 is substituted; if it is true, an error is generated. See section
17719 &<<SECTaclvariables>>& for details of ACL variables.
17720
17721 .option strip_excess_angle_brackets main boolean false
17722 .cindex "angle brackets, excess"
17723 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17724 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17725 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17726 passed on to another MTA, the excess angle brackets are not passed on. If this
17727 option is not set, multiple pairs of angle brackets cause a syntax error.
17728
17729
17730 .option strip_trailing_dot main boolean false
17731 .cindex "trailing dot on domain"
17732 .cindex "dot" "trailing on domain"
17733 If this option is set, a trailing dot at the end of a domain in an address is
17734 ignored. If this is in the envelope and the message is passed on to another
17735 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17736 domain causes a syntax error.
17737 However, addresses in header lines are checked only when an ACL requests header
17738 syntax checking.
17739
17740
17741 .option syslog_duplication main boolean true
17742 .cindex "syslog" "duplicate log lines; suppressing"
17743 When Exim is logging to syslog, it writes the log lines for its three
17744 separate logs at different syslog priorities so that they can in principle
17745 be separated on the logging hosts. Some installations do not require this
17746 separation, and in those cases, the duplication of certain log lines is a
17747 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17748 particular log line is written to syslog. For lines that normally go to
17749 both the main log and the reject log, the reject log version (possibly
17750 containing message header lines) is written, at LOG_NOTICE priority.
17751 Lines that normally go to both the main and the panic log are written at
17752 the LOG_ALERT priority.
17753
17754
17755 .option syslog_facility main string unset
17756 .cindex "syslog" "facility; setting"
17757 This option sets the syslog &"facility"& name, used when Exim is logging to
17758 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17759 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17760 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17761 details of Exim's logging.
17762
17763
17764 .option syslog_pid main boolean true
17765 .cindex "syslog" "pid"
17766 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17767 omitted when these lines are sent to syslog. (Syslog normally prefixes
17768 the log lines with the PID of the logging process automatically.) You need
17769 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17770 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17771
17772
17773
17774 .option syslog_processname main string &`exim`&
17775 .cindex "syslog" "process name; setting"
17776 This option sets the syslog &"ident"& name, used when Exim is logging to
17777 syslog. The value must be no longer than 32 characters. See chapter
17778 &<<CHAPlog>>& for details of Exim's logging.
17779
17780
17781
17782 .option syslog_timestamp main boolean true
17783 .cindex "syslog" "timestamps"
17784 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17785 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17786 details of Exim's logging.
17787
17788
17789 .option system_filter main string&!! unset
17790 .cindex "filter" "system filter"
17791 .cindex "system filter" "specifying"
17792 .cindex "Sieve filter" "not available for system filter"
17793 This option specifies an Exim filter file that is applied to all messages at
17794 the start of each delivery attempt, before any routing is done. System filters
17795 must be Exim filters; they cannot be Sieve filters. If the system filter
17796 generates any deliveries to files or pipes, or any new mail messages, the
17797 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17798 which transports are to be used. Details of this facility are given in chapter
17799 &<<CHAPsystemfilter>>&.
17800 A forced expansion failure results in no filter operation.
17801
17802
17803 .option system_filter_directory_transport main string&!! unset
17804 .vindex "&$address_file$&"
17805 This sets the name of the transport driver that is to be used when the
17806 &%save%& command in a system message filter specifies a path ending in &"/"&,
17807 implying delivery of each message into a separate file in some directory.
17808 During the delivery, the variable &$address_file$& contains the path name.
17809
17810
17811 .option system_filter_file_transport main string&!! unset
17812 .cindex "file" "transport for system filter"
17813 This sets the name of the transport driver that is to be used when the &%save%&
17814 command in a system message filter specifies a path not ending in &"/"&. During
17815 the delivery, the variable &$address_file$& contains the path name.
17816
17817 .option system_filter_group main string unset
17818 .cindex "gid (group id)" "system filter"
17819 This option is used only when &%system_filter_user%& is also set. It sets the
17820 gid under which the system filter is run, overriding any gid that is associated
17821 with the user. The value may be numerical or symbolic.
17822
17823 .option system_filter_pipe_transport main string&!! unset
17824 .cindex "&(pipe)& transport" "for system filter"
17825 .vindex "&$address_pipe$&"
17826 This specifies the transport driver that is to be used when a &%pipe%& command
17827 is used in a system filter. During the delivery, the variable &$address_pipe$&
17828 contains the pipe command.
17829
17830
17831 .option system_filter_reply_transport main string&!! unset
17832 .cindex "&(autoreply)& transport" "for system filter"
17833 This specifies the transport driver that is to be used when a &%mail%& command
17834 is used in a system filter.
17835
17836
17837 .option system_filter_user main string unset
17838 .cindex "uid (user id)" "system filter"
17839 If this option is set to root, the system filter is run in the main Exim
17840 delivery process, as root.  Otherwise, the system filter runs in a separate
17841 process, as the given user, defaulting to the Exim run-time user.
17842 Unless the string consists entirely of digits, it
17843 is looked up in the password data. Failure to find the named user causes a
17844 configuration error. The gid is either taken from the password data, or
17845 specified by &%system_filter_group%&. When the uid is specified numerically,
17846 &%system_filter_group%& is required to be set.
17847
17848 If the system filter generates any pipe, file, or reply deliveries, the uid
17849 under which the filter is run is used when transporting them, unless a
17850 transport option overrides.
17851
17852
17853 .option tcp_nodelay main boolean true
17854 .cindex "daemon" "TCP_NODELAY on sockets"
17855 .cindex "Nagle algorithm"
17856 .cindex "TCP_NODELAY on listening sockets"
17857 If this option is set false, it stops the Exim daemon setting the
17858 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17859 turns off the &"Nagle algorithm"&, which is a way of improving network
17860 performance in interactive (character-by-character) situations. Turning it off
17861 should improve Exim's performance a bit, so that is what happens by default.
17862 However, it appears that some broken clients cannot cope, and time out. Hence
17863 this option. It affects only those sockets that are set up for listening by the
17864 daemon. Sockets created by the smtp transport for delivering mail always set
17865 TCP_NODELAY.
17866
17867
17868 .option timeout_frozen_after main time 0s
17869 .cindex "frozen messages" "timing out"
17870 .cindex "timeout" "frozen messages"
17871 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17872 message of any kind that has been in the queue for longer than the given time
17873 is automatically cancelled at the next queue run. If the frozen message is a
17874 bounce message, it is just discarded; otherwise, a bounce is sent to the
17875 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17876 If you want to timeout frozen bounce messages earlier than other kinds of
17877 frozen message, see &%ignore_bounce_errors_after%&.
17878
17879 &*Note:*& the default value of zero means no timeouts; with this setting,
17880 frozen messages remain in the queue forever (except for any frozen bounce
17881 messages that are released by &%ignore_bounce_errors_after%&).
17882
17883
17884 .option timezone main string unset
17885 .cindex "timezone, setting"
17886 .cindex "environment" "values from"
17887 The value of &%timezone%& is used to set the environment variable TZ while
17888 running Exim (if it is different on entry). This ensures that all timestamps
17889 created by Exim are in the required timezone. If you want all your timestamps
17890 to be in UTC (aka GMT) you should set
17891 .code
17892 timezone = UTC
17893 .endd
17894 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17895 or, if that is not set, from the value of the TZ environment variable when Exim
17896 is built. If &%timezone%& is set to the empty string, either at build or run
17897 time, any existing TZ variable is removed from the environment when Exim
17898 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17899 unfortunately not all, operating systems.
17900
17901
17902 .option tls_advertise_hosts main "host list&!!" *
17903 .cindex "TLS" "advertising"
17904 .cindex "encryption" "on SMTP connection"
17905 .cindex "SMTP" "encrypted connection"
17906 When Exim is built with support for TLS encrypted connections, the availability
17907 of the STARTTLS command to set up an encrypted session is advertised in
17908 response to EHLO only to those client hosts that match this option. See
17909 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17910 Note that the default value requires that a certificate be supplied
17911 using the &%tls_certificate%& option.  If TLS support for incoming connections
17912 is not required the &%tls_advertise_hosts%& option should be set empty.
17913
17914
17915 .option tls_certificate main string list&!! unset
17916 .cindex "TLS" "server certificate; location of"
17917 .cindex "certificate" "server, location of"
17918 The value of this option is expanded, and must then be a list of absolute paths to
17919 files which contain the server's certificates (in PEM format).
17920 Commonly only one file is needed.
17921 The server's private key is also
17922 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17923 &<<CHAPTLS>>& for further details.
17924
17925 &*Note*&: The certificates defined by this option are used only when Exim is
17926 receiving incoming messages as a server. If you want to supply certificates for
17927 use when sending messages as a client, you must set the &%tls_certificate%&
17928 option in the relevant &(smtp)& transport.
17929
17930 &*Note*&: If you use filenames based on IP addresses, change the list
17931 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17932
17933 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17934 when a list of more than one
17935 file is used, the &$tls_in_ourcert$& variable is unreliable.
17936 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17937
17938 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17939 if the OpenSSL build supports TLS extensions and the TLS client sends the
17940 Server Name Indication extension, then this option and others documented in
17941 &<<SECTtlssni>>& will be re-expanded.
17942
17943 If this option is unset or empty a fresh self-signed certificate will be
17944 generated for every connection.
17945
17946 .option tls_crl main string&!! unset
17947 .cindex "TLS" "server certificate revocation list"
17948 .cindex "certificate" "revocation list for server"
17949 This option specifies a certificate revocation list. The expanded value must
17950 be the name of a file that contains CRLs in PEM format.
17951
17952 Under OpenSSL the option can specify a directory with CRL files.
17953
17954 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17955 for each signing element of the certificate chain (i.e. all but the leaf).
17956 For the file variant this can be multiple PEM blocks in the one file.
17957
17958 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17959
17960
17961 .option tls_dh_max_bits main integer 2236
17962 .cindex "TLS" "D-H bit count"
17963 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17964 the chosen TLS library.  That value might prove to be too high for
17965 interoperability.  This option provides a maximum clamp on the value
17966 suggested, trading off security for interoperability.
17967
17968 The value must be at least 1024.
17969
17970 The value 2236 was chosen because, at time of adding the option, it was the
17971 hard-coded maximum value supported by the NSS cryptographic library, as used
17972 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17973
17974 If you prefer more security and are willing to break some clients, raise this
17975 number.
17976
17977 Note that the value passed to GnuTLS for *generating* a new prime may be a
17978 little less than this figure, because GnuTLS is inexact and may produce a
17979 larger prime than requested.
17980
17981
17982 .option tls_dhparam main string&!! unset
17983 .cindex "TLS" "D-H parameters for server"
17984 The value of this option is expanded and indicates the source of DH parameters
17985 to be used by Exim.
17986
17987 This option is ignored for GnuTLS version 3.6.0 and later.
17988 The library manages parameter negotiation internally.
17989
17990 &*Note: The Exim Maintainers strongly recommend,
17991 for other TLS library versions,
17992 using a filename with site-generated
17993 local DH parameters*&, which has been supported across all versions of Exim.  The
17994 other specific constants available are a fallback so that even when
17995 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17996
17997 If &%tls_dhparam%& is a filename starting with a &`/`&,
17998 then it names a file from which DH
17999 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18000 PKCS#3 representation of the DH prime.  If the file does not exist, for
18001 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18002 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18003 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18004 and treated as though the &%tls_dhparam%& were set to "none".
18005
18006 If this option expands to the string "none", then no DH parameters will be
18007 loaded by Exim.
18008
18009 If this option expands to the string "historic" and Exim is using GnuTLS, then
18010 Exim will attempt to load a file from inside the spool directory.  If the file
18011 does not exist, Exim will attempt to create it.
18012 See section &<<SECTgnutlsparam>>& for further details.
18013
18014 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18015 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18016
18017 In older versions of Exim the default was the 2048 bit prime described in section
18018 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18019 in IKE is assigned number 23.
18020
18021 Otherwise, the option must expand to the name used by Exim for any of a number
18022 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18023 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18024 the number used by IKE, or "default" which corresponds to
18025 &`exim.dev.20160529.3`&.
18026
18027 The available standard primes are:
18028 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18029 &`ike1`&, &`ike2`&, &`ike5`&,
18030 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18031 &`ike22`&, &`ike23`& and &`ike24`&.
18032
18033 The available additional primes are:
18034 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18035
18036 Some of these will be too small to be accepted by clients.
18037 Some may be too large to be accepted by clients.
18038 The open cryptographic community has suspicions about the integrity of some
18039 of the later IKE values, which led into RFC7919 providing new fixed constants
18040 (the "ffdhe" identifiers).
18041
18042 At this point, all of the "ike" values should be considered obsolete;
18043 they're still in Exim to avoid breaking unusual configurations, but are
18044 candidates for removal the next time we have backwards-incompatible changes.
18045
18046 The TLS protocol does not negotiate an acceptable size for this; clients tend
18047 to hard-drop connections if what is offered by the server is unacceptable,
18048 whether too large or too small, and there's no provision for the client to
18049 tell the server what these constraints are.  Thus, as a server operator, you
18050 need to make an educated guess as to what is most likely to work for your
18051 userbase.
18052
18053 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18054 is most likely to maximise interoperability.  The upper bound comes from
18055 applications using the Mozilla Network Security Services (NSS) library, which
18056 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18057 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18058 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18059 acceptable bound from 1024 to 2048.
18060
18061
18062 .option tls_eccurve main string&!! &`auto`&
18063 .cindex TLS "EC cryptography"
18064 This option selects a EC curve for use by Exim when used with OpenSSL.
18065 It has no effect when Exim is used with GnuTLS.
18066
18067 After expansion it must contain a valid EC curve parameter, such as
18068 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18069 for valid selections.
18070
18071 For OpenSSL versions before (and not including) 1.0.2, the string
18072 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18073 &`auto`& tells the library to choose.
18074
18075 If the option expands to an empty string, no EC curves will be enabled.
18076
18077
18078 .option tls_ocsp_file main string&!! unset
18079 .cindex TLS "certificate status"
18080 .cindex TLS "OCSP proof file"
18081 This option
18082 must if set expand to the absolute path to a file which contains a current
18083 status proof for the server's certificate, as obtained from the
18084 Certificate Authority.
18085
18086 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18087 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18088
18089 For OpenSSL 1.1.0 or later, and
18090 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18091 of files, to match a list given for the &%tls_certificate%& option.
18092 The ordering of the two lists must match.
18093 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18094
18095 The file(s) should be in DER format,
18096 except for GnuTLS 3.6.3 or later
18097 or for OpenSSL,
18098 when an optional filetype prefix can be used.
18099 The prefix must be one of "DER" or "PEM", followed by
18100 a single space.  If one is used it sets the format for subsequent
18101 files in the list; the initial format is DER.
18102 If multiple proofs are wanted, for multiple chain elements
18103 (this only works under TLS1.3)
18104 they must be coded as a combined OCSP response.
18105
18106 Although GnuTLS will accept PEM files with multiple separate
18107 PEM blobs (ie. separate OCSP responses), it sends them in the
18108 TLS Certificate record interleaved with the certificates of the chain;
18109 although a GnuTLS client is happy with that, an OpenSSL client is not.
18110
18111 .option tls_on_connect_ports main "string list" unset
18112 .cindex SSMTP
18113 .cindex SMTPS
18114 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18115 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18116 set up without waiting for the client to issue a STARTTLS command. For
18117 further details, see section &<<SECTsupobssmt>>&.
18118
18119
18120
18121 .option tls_privatekey main string list&!! unset
18122 .cindex "TLS" "server private key; location of"
18123 The value of this option is expanded, and must then be a list of absolute paths to
18124 files which contains the server's private keys.
18125 If this option is unset, or if
18126 the expansion is forced to fail, or the result is an empty string, the private
18127 key is assumed to be in the same file as the server's certificates. See chapter
18128 &<<CHAPTLS>>& for further details.
18129
18130 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18131
18132
18133 .option tls_remember_esmtp main boolean false
18134 .cindex "TLS" "esmtp state; remembering"
18135 .cindex "TLS" "broken clients"
18136 If this option is set true, Exim violates the RFCs by remembering that it is in
18137 &"esmtp"& state after successfully negotiating a TLS session. This provides
18138 support for broken clients that fail to send a new EHLO after starting a
18139 TLS session.
18140
18141
18142 .option tls_require_ciphers main string&!! unset
18143 .cindex "TLS" "requiring specific ciphers"
18144 .cindex "cipher" "requiring specific"
18145 This option controls which ciphers can be used for incoming TLS connections.
18146 The &(smtp)& transport has an option of the same name for controlling outgoing
18147 connections. This option is expanded for each connection, so can be varied for
18148 different clients if required. The value of this option must be a list of
18149 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18150 in somewhat different ways. If GnuTLS is being used, the client controls the
18151 preference order of the available ciphers. Details are given in sections
18152 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18153
18154
18155 .option tls_try_verify_hosts main "host list&!!" unset
18156 .cindex "TLS" "client certificate verification"
18157 .cindex "certificate" "verification of client"
18158 See &%tls_verify_hosts%& below.
18159
18160
18161 .option tls_verify_certificates main string&!! system
18162 .cindex "TLS" "client certificate verification"
18163 .cindex "certificate" "verification of client"
18164 The value of this option is expanded, and must then be either the
18165 word "system"
18166 or the absolute path to
18167 a file or directory containing permitted certificates for clients that
18168 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18169
18170 The "system" value for the option will use a
18171 system default location compiled into the SSL library.
18172 This is not available for GnuTLS versions preceding 3.0.20,
18173 and will be taken as empty; an explicit location
18174 must be specified.
18175
18176 The use of a directory for the option value is not available for GnuTLS versions
18177 preceding 3.3.6 and a single file must be used.
18178
18179 With OpenSSL the certificates specified
18180 explicitly
18181 either by file or directory
18182 are added to those given by the system default location.
18183
18184 These certificates should be for the certificate authorities trusted, rather
18185 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18186 the value is a file then the certificates are sent by Exim as a server to
18187 connecting clients, defining the list of accepted certificate authorities.
18188 Thus the values defined should be considered public data.  To avoid this,
18189 use the explicit directory version.
18190
18191 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18192
18193 A forced expansion failure or setting to an empty string is equivalent to
18194 being unset.
18195
18196
18197 .option tls_verify_hosts main "host list&!!" unset
18198 .cindex "TLS" "client certificate verification"
18199 .cindex "certificate" "verification of client"
18200 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18201 certificates from clients. The expected certificates are defined by
18202 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18203 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18204 &%tls_verify_certificates%& is not set.
18205
18206 Any client that matches &%tls_verify_hosts%& is constrained by
18207 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18208 present one of the listed certificates. If it does not, the connection is
18209 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18210 the host to use TLS. It can still send SMTP commands through unencrypted
18211 connections. Forcing a client to use TLS has to be done separately using an
18212 ACL to reject inappropriate commands when the connection is not encrypted.
18213
18214 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18215 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18216 certificate and checks it against &%tls_verify_certificates%&, but does not
18217 abort the connection if there is no certificate or if it does not match. This
18218 state can be detected in an ACL, which makes it possible to implement policies
18219 such as &"accept for relay only if a verified certificate has been received,
18220 but accept for local delivery if encrypted, even without a verified
18221 certificate"&.
18222
18223 Client hosts that match neither of these lists are not asked to present
18224 certificates.
18225
18226
18227 .option trusted_groups main "string list&!!" unset
18228 .cindex "trusted groups"
18229 .cindex "groups" "trusted"
18230 This option is expanded just once, at the start of Exim's processing. If this
18231 option is set, any process that is running in one of the listed groups, or
18232 which has one of them as a supplementary group, is trusted. The groups can be
18233 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18234 details of what trusted callers are permitted to do. If neither
18235 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18236 are trusted.
18237
18238 .option trusted_users main "string list&!!" unset
18239 .cindex "trusted users"
18240 .cindex "user" "trusted"
18241 This option is expanded just once, at the start of Exim's processing. If this
18242 option is set, any process that is running as one of the listed users is
18243 trusted. The users can be specified numerically or by name. See section
18244 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18245 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18246 Exim user are trusted.
18247
18248 .option unknown_login main string&!! unset
18249 .cindex "uid (user id)" "unknown caller"
18250 .vindex "&$caller_uid$&"
18251 This is a specialized feature for use in unusual configurations. By default, if
18252 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18253 gives up. The &%unknown_login%& option can be used to set a login name to be
18254 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18255 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18256 is used for the user's real name (gecos field), unless this has been set by the
18257 &%-F%& option.
18258
18259 .option unknown_username main string unset
18260 See &%unknown_login%&.
18261
18262 .option untrusted_set_sender main "address list&!!" unset
18263 .cindex "trusted users"
18264 .cindex "sender" "setting by untrusted user"
18265 .cindex "untrusted user setting sender"
18266 .cindex "user" "untrusted setting sender"
18267 .cindex "envelope from"
18268 .cindex "envelope sender"
18269 When an untrusted user submits a message to Exim using the standard input, Exim
18270 normally creates an envelope sender address from the user's login and the
18271 default qualification domain. Data from the &%-f%& option (for setting envelope
18272 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18273 is used) is ignored.
18274
18275 However, untrusted users are permitted to set an empty envelope sender address,
18276 to declare that a message should never generate any bounces. For example:
18277 .code
18278 exim -f '<>' user@domain.example
18279 .endd
18280 .vindex "&$sender_ident$&"
18281 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18282 other envelope sender addresses in a controlled way. When it is set, untrusted
18283 users are allowed to set envelope sender addresses that match any of the
18284 patterns in the list. Like all address lists, the string is expanded. The
18285 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18286 users to setting senders that start with their login ids
18287 followed by a hyphen
18288 by a setting like this:
18289 .code
18290 untrusted_set_sender = ^$sender_ident-
18291 .endd
18292 If you want to allow untrusted users to set envelope sender addresses without
18293 restriction, you can use
18294 .code
18295 untrusted_set_sender = *
18296 .endd
18297 The &%untrusted_set_sender%& option applies to all forms of local input, but
18298 only to the setting of the envelope sender. It does not permit untrusted users
18299 to use the other options which trusted user can use to override message
18300 parameters. Furthermore, it does not stop Exim from removing an existing
18301 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18302 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18303 overriding these actions. The handling of the &'Sender:'& header is also
18304 described in section &<<SECTthesenhea>>&.
18305
18306 The log line for a message's arrival shows the envelope sender following
18307 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18308 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18309 envelope sender address, the user's login is shown in parentheses after the
18310 sender address.
18311
18312
18313 .option uucp_from_pattern main string "see below"
18314 .cindex "&""From""& line"
18315 .cindex "UUCP" "&""From""& line"
18316 Some applications that pass messages to an MTA via a command line interface use
18317 an initial line starting with &"From&~"& to pass the envelope sender. In
18318 particular, this is used by UUCP software. Exim recognizes such a line by means
18319 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18320 matches, the sender address is constructed by expanding the contents of
18321 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18322 default pattern recognizes lines in the following two forms:
18323 .code
18324 From ph10 Fri Jan  5 12:35 GMT 1996
18325 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18326 .endd
18327 The pattern can be seen by running
18328 .code
18329 exim -bP uucp_from_pattern
18330 .endd
18331 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18332 year in the second case. The first word after &"From&~"& is matched in the
18333 regular expression by a parenthesized subpattern. The default value for
18334 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18335 (&"ph10"& in the example above) as the message's sender. See also
18336 &%ignore_fromline_hosts%&.
18337
18338
18339 .option uucp_from_sender main string&!! &`$1`&
18340 See &%uucp_from_pattern%& above.
18341
18342
18343 .option warn_message_file main string unset
18344 .cindex "warning of delay" "customizing the message"
18345 .cindex "customizing" "warning message"
18346 This option defines a template file containing paragraphs of text to be used
18347 for constructing the warning message which is sent by Exim when a message has
18348 been in the queue for a specified amount of time, as specified by
18349 &%delay_warning%&. Details of the file's contents are given in chapter
18350 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18351
18352
18353 .option write_rejectlog main boolean true
18354 .cindex "reject log" "disabling"
18355 If this option is set false, Exim no longer writes anything to the reject log.
18356 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18357 .ecindex IIDconfima
18358 .ecindex IIDmaiconf
18359
18360
18361
18362
18363 . ////////////////////////////////////////////////////////////////////////////
18364 . ////////////////////////////////////////////////////////////////////////////
18365
18366 .chapter "Generic options for routers" "CHAProutergeneric"
18367 .scindex IIDgenoprou1 "options" "generic; for routers"
18368 .scindex IIDgenoprou2 "generic options" "router"
18369 This chapter describes the generic options that apply to all routers.
18370 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18371
18372 For a general description of how a router operates, see sections
18373 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18374 which the preconditions are tested. The order of expansion of the options that
18375 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18376 &%headers_remove%&, &%transport%&.
18377
18378
18379
18380 .option address_data routers string&!! unset
18381 .cindex "router" "data attached to address"
18382 The string is expanded just before the router is run, that is, after all the
18383 precondition tests have succeeded. If the expansion is forced to fail, the
18384 router declines, the value of &%address_data%& remains unchanged, and the
18385 &%more%& option controls what happens next. Other expansion failures cause
18386 delivery of the address to be deferred.
18387
18388 .vindex "&$address_data$&"
18389 When the expansion succeeds, the value is retained with the address, and can be
18390 accessed using the variable &$address_data$& in the current router, subsequent
18391 routers, and the eventual transport.
18392
18393 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18394 that runs a user's filter file, the contents of &$address_data$& are accessible
18395 in the filter. This is not normally a problem, because such data is usually
18396 either not confidential or it &"belongs"& to the current user, but if you do
18397 put confidential data into &$address_data$& you need to remember this point.
18398
18399 Even if the router declines or passes, the value of &$address_data$& remains
18400 with the address, though it can be changed by another &%address_data%& setting
18401 on a subsequent router. If a router generates child addresses, the value of
18402 &$address_data$& propagates to them. This also applies to the special kind of
18403 &"child"& that is generated by a router with the &%unseen%& option.
18404
18405 The idea of &%address_data%& is that you can use it to look up a lot of data
18406 for the address once, and then pick out parts of the data later. For example,
18407 you could use a single LDAP lookup to return a string of the form
18408 .code
18409 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18410 .endd
18411 In the transport you could pick out the mailbox by a setting such as
18412 .code
18413 file = ${extract{mailbox}{$address_data}}
18414 .endd
18415 This makes the configuration file less messy, and also reduces the number of
18416 lookups (though Exim does cache lookups).
18417
18418 See also the &%set%& option below.
18419
18420 .vindex "&$sender_address_data$&"
18421 .vindex "&$address_data$&"
18422 The &%address_data%& facility is also useful as a means of passing information
18423 from one router to another, and from a router to a transport. In addition, if
18424 &$address_data$& is set by a router when verifying a recipient address from an
18425 ACL, it remains available for use in the rest of the ACL statement. After
18426 verifying a sender, the value is transferred to &$sender_address_data$&.
18427
18428
18429
18430 .option address_test routers&!? boolean true
18431 .oindex "&%-bt%&"
18432 .cindex "router" "skipping when address testing"
18433 If this option is set false, the router is skipped when routing is being tested
18434 by means of the &%-bt%& command line option. This can be a convenience when
18435 your first router sends messages to an external scanner, because it saves you
18436 having to set the &"already scanned"& indicator when testing real address
18437 routing.
18438
18439
18440
18441 .option cannot_route_message routers string&!! unset
18442 .cindex "router" "customizing &""cannot route""& message"
18443 .cindex "customizing" "&""cannot route""& message"
18444 This option specifies a text message that is used when an address cannot be
18445 routed because Exim has run out of routers. The default message is
18446 &"Unrouteable address"&. This option is useful only on routers that have
18447 &%more%& set false, or on the very last router in a configuration, because the
18448 value that is used is taken from the last router that is considered. This
18449 includes a router that is skipped because its preconditions are not met, as
18450 well as a router that declines. For example, using the default configuration,
18451 you could put:
18452 .code
18453 cannot_route_message = Remote domain not found in DNS
18454 .endd
18455 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18456 and
18457 .code
18458 cannot_route_message = Unknown local user
18459 .endd
18460 on the final router that checks for local users. If string expansion fails for
18461 this option, the default message is used. Unless the expansion failure was
18462 explicitly forced, a message about the failure is written to the main and panic
18463 logs, in addition to the normal message about the routing failure.
18464
18465
18466 .option caseful_local_part routers boolean false
18467 .cindex "case of local parts"
18468 .cindex "router" "case of local parts"
18469 By default, routers handle the local parts of addresses in a case-insensitive
18470 manner, though the actual case is preserved for transmission with the message.
18471 If you want the case of letters to be significant in a router, you must set
18472 this option true. For individual router options that contain address or local
18473 part lists (for example, &%local_parts%&), case-sensitive matching can be
18474 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18475 more details.
18476
18477 .vindex "&$local_part$&"
18478 .vindex "&$original_local_part$&"
18479 .vindex "&$parent_local_part$&"
18480 The value of the &$local_part$& variable is forced to lower case while a
18481 router is running unless &%caseful_local_part%& is set. When a router assigns
18482 an address to a transport, the value of &$local_part$& when the transport runs
18483 is the same as it was in the router. Similarly, when a router generates child
18484 addresses by aliasing or forwarding, the values of &$original_local_part$&
18485 and &$parent_local_part$& are those that were used by the redirecting router.
18486
18487 This option applies to the processing of an address by a router. When a
18488 recipient address is being processed in an ACL, there is a separate &%control%&
18489 modifier that can be used to specify case-sensitive processing within the ACL
18490 (see section &<<SECTcontrols>>&).
18491
18492
18493
18494 .option check_local_user routers&!? boolean false
18495 .cindex "local user, checking in router"
18496 .cindex "router" "checking for local user"
18497 .cindex "&_/etc/passwd_&"
18498 .vindex "&$home$&"
18499 When this option is true, Exim checks that the local part of the recipient
18500 address (with affixes removed if relevant) is the name of an account on the
18501 local system. The check is done by calling the &[getpwnam()]& function rather
18502 than trying to read &_/etc/passwd_& directly. This means that other methods of
18503 holding password data (such as NIS) are supported. If the local part is a local
18504 user, &$home$& is set from the password data, and can be tested in other
18505 preconditions that are evaluated after this one (the order of evaluation is
18506 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18507 overridden by &%router_home_directory%&. If the local part is not a local user,
18508 the router is skipped.
18509
18510 If you want to check that the local part is either the name of a local user
18511 or matches something else, you cannot combine &%check_local_user%& with a
18512 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18513 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18514 setting to achieve this. For example:
18515 .code
18516 local_parts = passwd;$local_part : lsearch;/etc/other/users
18517 .endd
18518 Note, however, that the side effects of &%check_local_user%& (such as setting
18519 up a home directory) do not occur when a &(passwd)& lookup is used in a
18520 &%local_parts%& (or any other) precondition.
18521
18522
18523
18524 .option condition routers&!? string&!! unset
18525 .cindex "router" "customized precondition"
18526 This option specifies a general precondition test that has to succeed for the
18527 router to be called. The &%condition%& option is the last precondition to be
18528 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18529 result is a forced failure, or an empty string, or one of the strings &"0"& or
18530 &"no"& or &"false"& (checked without regard to the case of the letters), the
18531 router is skipped, and the address is offered to the next one.
18532
18533 If the result is any other value, the router is run (as this is the last
18534 precondition to be evaluated, all the other preconditions must be true).
18535
18536 This option is unusual in that multiple &%condition%& options may be present.
18537 All &%condition%& options must succeed.
18538
18539 The &%condition%& option provides a means of applying custom conditions to the
18540 running of routers. Note that in the case of a simple conditional expansion,
18541 the default expansion values are exactly what is wanted. For example:
18542 .code
18543 condition = ${if >{$message_age}{600}}
18544 .endd
18545 Because of the default behaviour of the string expansion, this is equivalent to
18546 .code
18547 condition = ${if >{$message_age}{600}{true}{}}
18548 .endd
18549
18550 A multiple condition example, which succeeds:
18551 .code
18552 condition = ${if >{$message_age}{600}}
18553 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18554 condition = foobar
18555 .endd
18556
18557 If the expansion fails (other than forced failure) delivery is deferred. Some
18558 of the other precondition options are common special cases that could in fact
18559 be specified using &%condition%&.
18560
18561 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18562 are far older, and use one set of semantics.  ACLs are newer and when
18563 they were created, the ACL &%condition%& process was given far stricter
18564 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18565 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18566 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18567 Router rules processing behavior.
18568
18569 This is best illustrated in an example:
18570 .code
18571 # If used in an ACL condition will fail with a syntax error, but
18572 # in a router condition any extra characters are treated as a string
18573
18574 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18575 true {yes} {no}}
18576
18577 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18578  {yes} {no}}
18579 .endd
18580 In each example above, the &%if%& statement actually ends after
18581 &"{google.com}}"&.  Since no true or false braces were defined, the
18582 default &%if%& behavior is to return a boolean true or a null answer
18583 (which evaluates to false). The rest of the line is then treated as a
18584 string. So the first example resulted in the boolean answer &"true"&
18585 with the string &" {yes} {no}}"& appended to it. The second example
18586 resulted in the null output (indicating false) with the string
18587 &" {yes} {no}}"& appended to it.
18588
18589 In fact you can put excess forward braces in too.  In the router
18590 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18591 mean something, like after a &"$"& or when required as part of a
18592 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18593 string characters.
18594
18595 Thus, in a Router, the above expansion strings will both always evaluate
18596 true, as the result of expansion is a non-empty string which doesn't
18597 match an explicit false value.  This can be tricky to debug.  By
18598 contrast, in an ACL either of those strings will always result in an
18599 expansion error because the result doesn't look sufficiently boolean.
18600
18601
18602 .option debug_print routers string&!! unset
18603 .cindex "testing" "variables in drivers"
18604 If this option is set and debugging is enabled (see the &%-d%& command line
18605 option) or in address-testing mode (see the &%-bt%& command line option),
18606 the string is expanded and included in the debugging output.
18607 If expansion of the string fails, the error message is written to the debugging
18608 output, and Exim carries on processing.
18609 This option is provided to help with checking out the values of variables and
18610 so on when debugging router configurations. For example, if a &%condition%&
18611 option appears not to be working, &%debug_print%& can be used to output the
18612 variables it references. The output happens after checks for &%domains%&,
18613 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18614 are tested. A newline is added to the text if it does not end with one.
18615 The variable &$router_name$& contains the name of the router.
18616
18617
18618
18619 .option disable_logging routers boolean false
18620 If this option is set true, nothing is logged for any routing errors
18621 or for any deliveries caused by this router. You should not set this option
18622 unless you really, really know what you are doing. See also the generic
18623 transport option of the same name.
18624
18625 .option dnssec_request_domains routers "domain list&!!" *
18626 .cindex "MX record" "security"
18627 .cindex "DNSSEC" "MX lookup"
18628 .cindex "security" "MX lookup"
18629 .cindex "DNS" "DNSSEC"
18630 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18631 the dnssec request bit set.
18632 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18633
18634 .option dnssec_require_domains routers "domain list&!!" unset
18635 .cindex "MX record" "security"
18636 .cindex "DNSSEC" "MX lookup"
18637 .cindex "security" "MX lookup"
18638 .cindex "DNS" "DNSSEC"
18639 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18640 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18641 (AD bit) set will be ignored and logged as a host-lookup failure.
18642 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18643
18644
18645 .option domains routers&!? "domain list&!!" unset
18646 .cindex "router" "restricting to specific domains"
18647 .vindex "&$domain_data$&"
18648 If this option is set, the router is skipped unless the current domain matches
18649 the list. If the match is achieved by means of a file lookup, the data that the
18650 lookup returned for the domain is placed in &$domain_data$& for use in string
18651 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18652 a list of the order in which preconditions are evaluated.
18653
18654
18655
18656 .option driver routers string unset
18657 This option must always be set. It specifies which of the available routers is
18658 to be used.
18659
18660
18661 .option dsn_lasthop routers boolean false
18662 .cindex "DSN" "success"
18663 .cindex "Delivery Status Notification" "success"
18664 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18665 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18666 instead send a success DSN as if the next hop does not support DSN.
18667 Not effective on redirect routers.
18668
18669
18670
18671 .option errors_to routers string&!! unset
18672 .cindex "envelope from"
18673 .cindex "envelope sender"
18674 .cindex "router" "changing address for errors"
18675 If a router successfully handles an address, it may assign the address to a
18676 transport for delivery or it may generate child addresses. In both cases, if
18677 there is a delivery problem during later processing, the resulting bounce
18678 message is sent to the address that results from expanding this string,
18679 provided that the address verifies successfully. The &%errors_to%& option is
18680 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18681
18682 The &%errors_to%& setting associated with an address can be overridden if it
18683 subsequently passes through other routers that have their own &%errors_to%&
18684 settings, or if the message is delivered by a transport with a &%return_path%&
18685 setting.
18686
18687 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18688 the expansion fails to verify, the errors address associated with the incoming
18689 address is used. At top level, this is the envelope sender. A non-forced
18690 expansion failure causes delivery to be deferred.
18691
18692 If an address for which &%errors_to%& has been set ends up being delivered over
18693 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18694 any bounces that are generated by other MTAs on the delivery route are also
18695 sent there. You can set &%errors_to%& to the empty string by either of these
18696 settings:
18697 .code
18698 errors_to =
18699 errors_to = ""
18700 .endd
18701 An expansion item that yields an empty string has the same effect. If you do
18702 this, a locally detected delivery error for addresses processed by this router
18703 no longer gives rise to a bounce message; the error is discarded. If the
18704 address is delivered to a remote host, the return path is set to &`<>`&, unless
18705 overridden by the &%return_path%& option on the transport.
18706
18707 .vindex "&$address_data$&"
18708 If for some reason you want to discard local errors, but use a non-empty
18709 MAIL command for remote delivery, you can preserve the original return
18710 path in &$address_data$& in the router, and reinstate it in the transport by
18711 setting &%return_path%&.
18712
18713 The most common use of &%errors_to%& is to direct mailing list bounces to the
18714 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18715 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18716
18717
18718
18719 .option expn routers&!? boolean true
18720 .cindex "address" "testing"
18721 .cindex "testing" "addresses"
18722 .cindex "EXPN" "router skipping"
18723 .cindex "router" "skipping for EXPN"
18724 If this option is turned off, the router is skipped when testing an address
18725 as a result of processing an SMTP EXPN command. You might, for example,
18726 want to turn it off on a router for users' &_.forward_& files, while leaving it
18727 on for the system alias file.
18728 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18729 are evaluated.
18730
18731 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18732 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18733 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18734
18735
18736
18737 .option fail_verify routers boolean false
18738 .cindex "router" "forcing verification failure"
18739 Setting this option has the effect of setting both &%fail_verify_sender%& and
18740 &%fail_verify_recipient%& to the same value.
18741
18742
18743
18744 .option fail_verify_recipient routers boolean false
18745 If this option is true and an address is accepted by this router when
18746 verifying a recipient, verification fails.
18747
18748
18749
18750 .option fail_verify_sender routers boolean false
18751 If this option is true and an address is accepted by this router when
18752 verifying a sender, verification fails.
18753
18754
18755
18756 .option fallback_hosts routers "string list" unset
18757 .cindex "router" "fallback hosts"
18758 .cindex "fallback" "hosts specified on router"
18759 String expansion is not applied to this option. The argument must be a
18760 colon-separated list of host names or IP addresses. The list separator can be
18761 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18762 each name or address. In fact, the format of each item is exactly the same as
18763 defined for the list of hosts in a &(manualroute)& router (see section
18764 &<<SECTformatonehostitem>>&).
18765
18766 If a router queues an address for a remote transport, this host list is
18767 associated with the address, and used instead of the transport's fallback host
18768 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18769 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18770 transport for further details.
18771
18772
18773 .option group routers string&!! "see below"
18774 .cindex "gid (group id)" "local delivery"
18775 .cindex "local transports" "uid and gid"
18776 .cindex "transport" "local"
18777 .cindex "router" "setting group"
18778 When a router queues an address for a transport, and the transport does not
18779 specify a group, the group given here is used when running the delivery
18780 process.
18781 The group may be specified numerically or by name. If expansion fails, the
18782 error is logged and delivery is deferred.
18783 The default is unset, unless &%check_local_user%& is set, when the default
18784 is taken from the password information. See also &%initgroups%& and &%user%&
18785 and the discussion in chapter &<<CHAPenvironment>>&.
18786
18787
18788
18789 .option headers_add routers list&!! unset
18790 .cindex "header lines" "adding"
18791 .cindex "router" "adding header lines"
18792 This option specifies a list of text headers,
18793 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18794 that is associated with any addresses that are accepted by the router.
18795 Each item is separately expanded, at routing time.  However, this
18796 option has no effect when an address is just being verified. The way in which
18797 the text is used to add header lines at transport time is described in section
18798 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18799 message is in the process of being transported. This means that references to
18800 header lines in string expansions in the transport's configuration do not
18801 &"see"& the added header lines.
18802
18803 The &%headers_add%& option is expanded after &%errors_to%&, but before
18804 &%headers_remove%& and &%transport%&. If an item is empty, or if
18805 an item expansion is forced to fail, the item has no effect. Other expansion
18806 failures are treated as configuration errors.
18807
18808 Unlike most options, &%headers_add%& can be specified multiple times
18809 for a router; all listed headers are added.
18810
18811 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18812 router that has the &%one_time%& option set.
18813
18814 .cindex "duplicate addresses"
18815 .oindex "&%unseen%&"
18816 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18817 additions are deleted when the address is passed on to subsequent routers.
18818 For a &%redirect%& router, if a generated address is the same as the incoming
18819 address, this can lead to duplicate addresses with different header
18820 modifications. Exim does not do duplicate deliveries (except, in certain
18821 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18822 which of the duplicates is discarded, so this ambiguous situation should be
18823 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18824
18825
18826
18827 .option headers_remove routers list&!! unset
18828 .cindex "header lines" "removing"
18829 .cindex "router" "removing header lines"
18830 This option specifies a list of text headers,
18831 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18832 that is associated with any addresses that are accepted by the router.
18833 However, the option has no effect when an address is just being verified.
18834 Each list item is separately expanded, at transport time.
18835 .new
18836 If an item ends in *, it will match any header with the given prefix.
18837 .wen
18838 The way in which
18839 the text is used to remove header lines at transport time is described in
18840 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18841 the message is in the process of being transported. This means that references
18842 to header lines in string expansions in the transport's configuration still
18843 &"see"& the original header lines.
18844
18845 The &%headers_remove%& option is handled after &%errors_to%& and
18846 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18847 the item has no effect. Other expansion failures are treated as configuration
18848 errors.
18849
18850 Unlike most options, &%headers_remove%& can be specified multiple times
18851 for a router; all listed headers are removed.
18852
18853 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18854 router that has the &%one_time%& option set.
18855
18856 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18857 removal requests are deleted when the address is passed on to subsequent
18858 routers, and this can lead to problems with duplicates -- see the similar
18859 warning for &%headers_add%& above.
18860
18861 &*Warning 3*&: Because of the separate expansion of the list items,
18862 items that contain a list separator must have it doubled.
18863 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18864
18865
18866
18867 .option ignore_target_hosts routers "host list&!!" unset
18868 .cindex "IP address" "discarding"
18869 .cindex "router" "discarding IP addresses"
18870 Although this option is a host list, it should normally contain IP address
18871 entries rather than names. If any host that is looked up by the router has an
18872 IP address that matches an item in this list, Exim behaves as if that IP
18873 address did not exist. This option allows you to cope with rogue DNS entries
18874 like
18875 .code
18876 remote.domain.example.  A  127.0.0.1
18877 .endd
18878 by setting
18879 .code
18880 ignore_target_hosts = 127.0.0.1
18881 .endd
18882 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18883 discarded in this way, the router declines. In a conventional configuration, an
18884 attempt to mail to such a domain would normally provoke the &"unrouteable
18885 domain"& error, and an attempt to verify an address in the domain would fail.
18886 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18887 router declines if presented with one of the listed addresses.
18888
18889 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18890 means of the first or the second of the following settings, respectively:
18891 .code
18892 ignore_target_hosts = 0.0.0.0/0
18893 ignore_target_hosts = <; 0::0/0
18894 .endd
18895 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18896 in the second line matches all IPv6 addresses.
18897
18898 This option may also be useful for ignoring link-local and site-local IPv6
18899 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18900 is expanded before use as a list, it is possible to make it dependent on the
18901 domain that is being routed.
18902
18903 .vindex "&$host_address$&"
18904 During its expansion, &$host_address$& is set to the IP address that is being
18905 checked.
18906
18907 .option initgroups routers boolean false
18908 .cindex "additional groups"
18909 .cindex "groups" "additional"
18910 .cindex "local transports" "uid and gid"
18911 .cindex "transport" "local"
18912 If the router queues an address for a transport, and this option is true, and
18913 the uid supplied by the router is not overridden by the transport, the
18914 &[initgroups()]& function is called when running the transport to ensure that
18915 any additional groups associated with the uid are set up. See also &%group%&
18916 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18917
18918
18919
18920 .option local_part_prefix routers&!? "string list" unset
18921 .cindex affix "router precondition"
18922 .cindex "router" "prefix for local part"
18923 .cindex "prefix" "for local part, used in router"
18924 If this option is set, the router is skipped unless the local part starts with
18925 one of the given strings, or &%local_part_prefix_optional%& is true. See
18926 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18927 evaluated.
18928
18929 The list is scanned from left to right, and the first prefix that matches is
18930 used. A limited form of wildcard is available; if the prefix begins with an
18931 asterisk, it matches the longest possible sequence of arbitrary characters at
18932 the start of the local part. An asterisk should therefore always be followed by
18933 some character that does not occur in normal local parts.
18934 .cindex "multiple mailboxes"
18935 .cindex "mailbox" "multiple"
18936 Wildcarding can be used to set up multiple user mailboxes, as described in
18937 section &<<SECTmulbox>>&.
18938
18939 .vindex "&$local_part$&"
18940 .vindex "&$local_part_prefix$&"
18941 During the testing of the &%local_parts%& option, and while the router is
18942 running, the prefix is removed from the local part, and is available in the
18943 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18944 the router accepts the address, this remains true during subsequent delivery by
18945 a transport. In particular, the local part that is transmitted in the RCPT
18946 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18947 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18948 the relevant transport.
18949
18950 .new
18951 .vindex &$local_part_prefix_v$&
18952 If wildcarding (above) was used then the part of the prefix matching the
18953 wildcard is available in &$local_part_prefix_v$&.
18954 .wen
18955
18956 When an address is being verified, &%local_part_prefix%& affects only the
18957 behaviour of the router. If the callout feature of verification is in use, this
18958 means that the full address, including the prefix, will be used during the
18959 callout.
18960
18961 The prefix facility is commonly used to handle local parts of the form
18962 &%owner-something%&. Another common use is to support local parts of the form
18963 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18964 to tell a user their forwarding is broken &-- by placing a router like this one
18965 immediately before the router that handles &_.forward_& files:
18966 .code
18967 real_localuser:
18968   driver = accept
18969   local_part_prefix = real-
18970   check_local_user
18971   transport = local_delivery
18972 .endd
18973 For security, it would probably be a good idea to restrict the use of this
18974 router to locally-generated messages, using a condition such as this:
18975 .code
18976   condition = ${if match {$sender_host_address}\
18977                          {\N^(|127\.0\.0\.1)$\N}}
18978 .endd
18979
18980 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18981 both conditions must be met if not optional. Care must be taken if wildcards
18982 are used in both a prefix and a suffix on the same router. Different
18983 separator characters must be used to avoid ambiguity.
18984
18985
18986 .option local_part_prefix_optional routers boolean false
18987 See &%local_part_prefix%& above.
18988
18989
18990
18991 .option local_part_suffix routers&!? "string list" unset
18992 .cindex "router" "suffix for local part"
18993 .cindex "suffix for local part" "used in router"
18994 This option operates in the same way as &%local_part_prefix%&, except that the
18995 local part must end (rather than start) with the given string, the
18996 &%local_part_suffix_optional%& option determines whether the suffix is
18997 mandatory, and the wildcard * character, if present, must be the last
18998 character of the suffix. This option facility is commonly used to handle local
18999 parts of the form &%something-request%& and multiple user mailboxes of the form
19000 &%username-foo%&.
19001
19002
19003 .option local_part_suffix_optional routers boolean false
19004 See &%local_part_suffix%& above.
19005
19006
19007
19008 .option local_parts routers&!? "local part list&!!" unset
19009 .cindex "router" "restricting to specific local parts"
19010 .cindex "local part" "checking in router"
19011 The router is run only if the local part of the address matches the list.
19012 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19013 are evaluated, and
19014 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19015 string is expanded, it is possible to make it depend on the domain, for
19016 example:
19017 .code
19018 local_parts = dbm;/usr/local/specials/$domain
19019 .endd
19020 .vindex "&$local_part_data$&"
19021 If the match is achieved by a lookup, the data that the lookup returned
19022 for the local part is placed in the variable &$local_part_data$& for use in
19023 expansions of the router's private options. You might use this option, for
19024 example, if you have a large number of local virtual domains, and you want to
19025 send all postmaster mail to the same place without having to set up an alias in
19026 each virtual domain:
19027 .code
19028 postmaster:
19029   driver = redirect
19030   local_parts = postmaster
19031   data = postmaster@real.domain.example
19032 .endd
19033
19034
19035 .option log_as_local routers boolean "see below"
19036 .cindex "log" "delivery line"
19037 .cindex "delivery" "log line format"
19038 Exim has two logging styles for delivery, the idea being to make local
19039 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19040 recipient address is given just as the local part, without a domain. The use of
19041 this style is controlled by this option. It defaults to true for the &(accept)&
19042 router, and false for all the others. This option applies only when a
19043 router assigns an address to a transport. It has no effect on routers that
19044 redirect addresses.
19045
19046
19047
19048 .option more routers boolean&!! true
19049 The result of string expansion for this option must be a valid boolean value,
19050 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19051 result causes an error, and delivery is deferred. If the expansion is forced to
19052 fail, the default value for the option (true) is used. Other failures cause
19053 delivery to be deferred.
19054
19055 If this option is set false, and the router declines to handle the address, no
19056 further routers are tried, routing fails, and the address is bounced.
19057 .oindex "&%self%&"
19058 However, if the router explicitly passes an address to the following router by
19059 means of the setting
19060 .code
19061 self = pass
19062 .endd
19063 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19064 does not affect the behaviour if one of the precondition tests fails. In that
19065 case, the address is always passed to the next router.
19066
19067 Note that &%address_data%& is not considered to be a precondition. If its
19068 expansion is forced to fail, the router declines, and the value of &%more%&
19069 controls what happens next.
19070
19071
19072 .option pass_on_timeout routers boolean false
19073 .cindex "timeout" "of router"
19074 .cindex "router" "timeout"
19075 If a router times out during a host lookup, it normally causes deferral of the
19076 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19077 router, overriding &%no_more%&. This may be helpful for systems that are
19078 intermittently connected to the Internet, or those that want to pass to a smart
19079 host any messages that cannot immediately be delivered.
19080
19081 There are occasional other temporary errors that can occur while doing DNS
19082 lookups. They are treated in the same way as a timeout, and this option
19083 applies to all of them.
19084
19085
19086
19087 .option pass_router routers string unset
19088 .cindex "router" "go to after &""pass""&"
19089 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19090 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19091 routing to continue, and overriding a false setting of &%more%&. When one of
19092 these routers returns &"pass"&, the address is normally handed on to the next
19093 router in sequence. This can be changed by setting &%pass_router%& to the name
19094 of another router. However (unlike &%redirect_router%&) the named router must
19095 be below the current router, to avoid loops. Note that this option applies only
19096 to the special case of &"pass"&. It does not apply when a router returns
19097 &"decline"& because it cannot handle an address.
19098
19099
19100
19101 .option redirect_router routers string unset
19102 .cindex "router" "start at after redirection"
19103 Sometimes an administrator knows that it is pointless to reprocess addresses
19104 generated from alias or forward files with the same router again. For
19105 example, if an alias file translates real names into login ids there is no
19106 point searching the alias file a second time, especially if it is a large file.
19107
19108 The &%redirect_router%& option can be set to the name of any router instance.
19109 It causes the routing of any generated addresses to start at the named router
19110 instead of at the first router. This option has no effect if the router in
19111 which it is set does not generate new addresses.
19112
19113
19114
19115 .option require_files routers&!? "string list&!!" unset
19116 .cindex "file" "requiring for router"
19117 .cindex "router" "requiring file existence"
19118 This option provides a general mechanism for predicating the running of a
19119 router on the existence or non-existence of certain files or directories.
19120 Before running a router, as one of its precondition tests, Exim works its way
19121 through the &%require_files%& list, expanding each item separately.
19122
19123 Because the list is split before expansion, any colons in expansion items must
19124 be doubled, or the facility for using a different list separator must be used
19125 (&<<SECTlistsepchange>>&).
19126 If any expansion is forced to fail, the item is ignored. Other expansion
19127 failures cause routing of the address to be deferred.
19128
19129 If any expanded string is empty, it is ignored. Otherwise, except as described
19130 below, each string must be a fully qualified file path, optionally preceded by
19131 &"!"&. The paths are passed to the &[stat()]& function to test for the
19132 existence of the files or directories. The router is skipped if any paths not
19133 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19134
19135 .cindex "NFS"
19136 If &[stat()]& cannot determine whether a file exists or not, delivery of
19137 the message is deferred. This can happen when NFS-mounted filesystems are
19138 unavailable.
19139
19140 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19141 options, so you cannot use it to check for the existence of a file in which to
19142 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19143 full list of the order in which preconditions are evaluated.) However, as
19144 these options are all expanded, you can use the &%exists%& expansion condition
19145 to make such tests. The &%require_files%& option is intended for checking files
19146 that the router may be going to use internally, or which are needed by a
19147 transport (e.g., &_.procmailrc_&).
19148
19149 During delivery, the &[stat()]& function is run as root, but there is a
19150 facility for some checking of the accessibility of a file by another user.
19151 This is not a proper permissions check, but just a &"rough"& check that
19152 operates as follows:
19153
19154 If an item in a &%require_files%& list does not contain any forward slash
19155 characters, it is taken to be the user (and optional group, separated by a
19156 comma) to be checked for subsequent files in the list. If no group is specified
19157 but the user is specified symbolically, the gid associated with the uid is
19158 used. For example:
19159 .code
19160 require_files = mail:/some/file
19161 require_files = $local_part:$home/.procmailrc
19162 .endd
19163 If a user or group name in a &%require_files%& list does not exist, the
19164 &%require_files%& condition fails.
19165
19166 Exim performs the check by scanning along the components of the file path, and
19167 checking the access for the given uid and gid. It checks for &"x"& access on
19168 directories, and &"r"& access on the final file. Note that this means that file
19169 access control lists, if the operating system has them, are ignored.
19170
19171 &*Warning 1*&: When the router is being run to verify addresses for an
19172 incoming SMTP message, Exim is not running as root, but under its own uid. This
19173 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19174 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19175 user is not permitted to read one of the directories on the file's path.
19176
19177 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19178 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19179 without root access. In this case, if a check for access by a particular user
19180 is requested, Exim creates a subprocess that runs as that user, and tries the
19181 check again in that process.
19182
19183 The default action for handling an unresolved EACCES is to consider it to
19184 be caused by a configuration error, and routing is deferred because the
19185 existence or non-existence of the file cannot be determined. However, in some
19186 circumstances it may be desirable to treat this condition as if the file did
19187 not exist. If the filename (or the exclamation mark that precedes the filename
19188 for non-existence) is preceded by a plus sign, the EACCES error is treated
19189 as if the file did not exist. For example:
19190 .code
19191 require_files = +/some/file
19192 .endd
19193 If the router is not an essential part of verification (for example, it
19194 handles users' &_.forward_& files), another solution is to set the &%verify%&
19195 option false so that the router is skipped when verifying.
19196
19197
19198
19199 .option retry_use_local_part routers boolean "see below"
19200 .cindex "hints database" "retry keys"
19201 .cindex "local part" "in retry keys"
19202 When a delivery suffers a temporary routing failure, a retry record is created
19203 in Exim's hints database. For addresses whose routing depends only on the
19204 domain, the key for the retry record should not involve the local part, but for
19205 other addresses, both the domain and the local part should be included.
19206 Usually, remote routing is of the former kind, and local routing is of the
19207 latter kind.
19208
19209 This option controls whether the local part is used to form the key for retry
19210 hints for addresses that suffer temporary errors while being handled by this
19211 router. The default value is true for any router that has any of
19212 &%check_local_user%&,
19213 &%local_parts%&,
19214 &%condition%&,
19215 &%local_part_prefix%&,
19216 &%local_part_suffix%&,
19217 &%senders%& or
19218 &%require_files%&
19219 set, and false otherwise. Note that this option does not apply to hints keys
19220 for transport delays; they are controlled by a generic transport option of the
19221 same name.
19222
19223 Failing to set this option when it is needed
19224 (because a remote router handles only some of the local-parts for a domain)
19225 can result in incorrect error messages being generated.
19226
19227 The setting of &%retry_use_local_part%& applies only to the router on which it
19228 appears. If the router generates child addresses, they are routed
19229 independently; this setting does not become attached to them.
19230
19231
19232
19233 .option router_home_directory routers string&!! unset
19234 .cindex "router" "home directory for"
19235 .cindex "home directory" "for router"
19236 .vindex "&$home$&"
19237 This option sets a home directory for use while the router is running. (Compare
19238 &%transport_home_directory%&, which sets a home directory for later
19239 transporting.) In particular, if used on a &(redirect)& router, this option
19240 sets a value for &$home$& while a filter is running. The value is expanded;
19241 forced expansion failure causes the option to be ignored &-- other failures
19242 cause the router to defer.
19243
19244 Expansion of &%router_home_directory%& happens immediately after the
19245 &%check_local_user%& test (if configured), before any further expansions take
19246 place.
19247 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19248 are evaluated.)
19249 While the router is running, &%router_home_directory%& overrides the value of
19250 &$home$& that came from &%check_local_user%&.
19251
19252 When a router accepts an address and assigns it to a local transport (including
19253 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19254 delivery), the home directory setting for the transport is taken from the first
19255 of these values that is set:
19256
19257 .ilist
19258 The &%home_directory%& option on the transport;
19259 .next
19260 The &%transport_home_directory%& option on the router;
19261 .next
19262 The password data if &%check_local_user%& is set on the router;
19263 .next
19264 The &%router_home_directory%& option on the router.
19265 .endlist
19266
19267 In other words, &%router_home_directory%& overrides the password data for the
19268 router, but not for the transport.
19269
19270
19271
19272 .option self routers string freeze
19273 .cindex "MX record" "pointing to local host"
19274 .cindex "local host" "MX pointing to"
19275 This option applies to those routers that use a recipient address to find a
19276 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19277 and &(manualroute)& routers.
19278 Certain configurations of the &(queryprogram)& router can also specify a list
19279 of remote hosts.
19280 Usually such routers are configured to send the message to a remote host via an
19281 &(smtp)& transport. The &%self%& option specifies what happens when the first
19282 host on the list turns out to be the local host.
19283 The way in which Exim checks for the local host is described in section
19284 &<<SECTreclocipadd>>&.
19285
19286 Normally this situation indicates either an error in Exim's configuration (for
19287 example, the router should be configured not to process this domain), or an
19288 error in the DNS (for example, the MX should not point to this host). For this
19289 reason, the default action is to log the incident, defer the address, and
19290 freeze the message. The following alternatives are provided for use in special
19291 cases:
19292
19293 .vlist
19294 .vitem &%defer%&
19295 Delivery of the message is tried again later, but the message is not frozen.
19296
19297 .vitem "&%reroute%&: <&'domain'&>"
19298 The domain is changed to the given domain, and the address is passed back to
19299 be reprocessed by the routers. No rewriting of headers takes place. This
19300 behaviour is essentially a redirection.
19301
19302 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19303 The domain is changed to the given domain, and the address is passed back to be
19304 reprocessed by the routers. Any headers that contain the original domain are
19305 rewritten.
19306
19307 .vitem &%pass%&
19308 .oindex "&%more%&"
19309 .vindex "&$self_hostname$&"
19310 The router passes the address to the next router, or to the router named in the
19311 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19312 subsequent routing and delivery, the variable &$self_hostname$& contains the
19313 name of the local host that the router encountered. This can be used to
19314 distinguish between different cases for hosts with multiple names. The
19315 combination
19316 .code
19317 self = pass
19318 no_more
19319 .endd
19320 ensures that only those addresses that routed to the local host are passed on.
19321 Without &%no_more%&, addresses that were declined for other reasons would also
19322 be passed to the next router.
19323
19324 .vitem &%fail%&
19325 Delivery fails and an error report is generated.
19326
19327 .vitem &%send%&
19328 .cindex "local host" "sending to"
19329 The anomaly is ignored and the address is queued for the transport. This
19330 setting should be used with extreme caution. For an &(smtp)& transport, it
19331 makes sense only in cases where the program that is listening on the SMTP port
19332 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19333 different configuration file that handles the domain in another way.
19334 .endlist
19335
19336
19337
19338 .option senders routers&!? "address list&!!" unset
19339 .cindex "router" "checking senders"
19340 If this option is set, the router is skipped unless the message's sender
19341 address matches something on the list.
19342 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19343 are evaluated.
19344
19345 There are issues concerning verification when the running of routers is
19346 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19347 setting, it sets the sender to the null string. When using the &%-bt%& option
19348 to check a configuration file, it is necessary also to use the &%-f%& option to
19349 set an appropriate sender. For incoming mail, the sender is unset when
19350 verifying the sender, but is available when verifying any recipients. If the
19351 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19352 matters.
19353
19354
19355 .option set routers "string list" unset
19356 .cindex router variables
19357 This option may be used multiple times on a router;
19358 because of this the list aspect is mostly irrelevant.
19359 The list separator is a semicolon but can be changed in the
19360 usual way.
19361
19362 Each list-element given must be of the form &"name = value"&
19363 and the names used must start with the string &"r_"&.
19364 Values containing a list-separator should have them doubled.
19365 When a router runs, the strings are evaluated in order,
19366 to create variables which are added to the set associated with
19367 the address.
19368 The variable is set with the expansion of the value.
19369 The variables can be used by the router options
19370 (not including any preconditions)
19371 and by the transport.
19372 Later definitions of a given named variable will override former ones.
19373 Variable use is via the usual &$r_...$& syntax.
19374
19375 This is similar to the &%address_data%& option, except that
19376 many independent variables can be used, with choice of naming.
19377
19378
19379 .option translate_ip_address routers string&!! unset
19380 .cindex "IP address" "translating"
19381 .cindex "packet radio"
19382 .cindex "router" "IP address translation"
19383 There exist some rare networking situations (for example, packet radio) where
19384 it is helpful to be able to translate IP addresses generated by normal routing
19385 mechanisms into other IP addresses, thus performing a kind of manual IP
19386 routing. This should be done only if the normal IP routing of the TCP/IP stack
19387 is inadequate or broken. Because this is an extremely uncommon requirement, the
19388 code to support this option is not included in the Exim binary unless
19389 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19390
19391 .vindex "&$host_address$&"
19392 The &%translate_ip_address%& string is expanded for every IP address generated
19393 by the router, with the generated address set in &$host_address$&. If the
19394 expansion is forced to fail, no action is taken.
19395 For any other expansion error, delivery of the message is deferred.
19396 If the result of the expansion is an IP address, that replaces the original
19397 address; otherwise the result is assumed to be a host name &-- this is looked
19398 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19399 produce one or more replacement IP addresses. For example, to subvert all IP
19400 addresses in some specific networks, this could be added to a router:
19401 .code
19402 translate_ip_address = \
19403   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19404     {$value}fail}}
19405 .endd
19406 The file would contain lines like
19407 .code
19408 10.2.3.128/26    some.host
19409 10.8.4.34/26     10.44.8.15
19410 .endd
19411 You should not make use of this facility unless you really understand what you
19412 are doing.
19413
19414
19415
19416 .option transport routers string&!! unset
19417 This option specifies the transport to be used when a router accepts an address
19418 and sets it up for delivery. A transport is never needed if a router is used
19419 only for verification. The value of the option is expanded at routing time,
19420 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19421 and result must be the name of one of the configured transports. If it is not,
19422 delivery is deferred.
19423
19424 The &%transport%& option is not used by the &(redirect)& router, but it does
19425 have some private options that set up transports for pipe and file deliveries
19426 (see chapter &<<CHAPredirect>>&).
19427
19428
19429
19430 .option transport_current_directory routers string&!! unset
19431 .cindex "current directory for local transport"
19432 This option associates a current directory with any address that is routed
19433 to a local transport. This can happen either because a transport is
19434 explicitly configured for the router, or because it generates a delivery to a
19435 file or a pipe. During the delivery process (that is, at transport time), this
19436 option string is expanded and is set as the current directory, unless
19437 overridden by a setting on the transport.
19438 If the expansion fails for any reason, including forced failure, an error is
19439 logged, and delivery is deferred.
19440 See chapter &<<CHAPenvironment>>& for details of the local delivery
19441 environment.
19442
19443
19444
19445
19446 .option transport_home_directory routers string&!! "see below"
19447 .cindex "home directory" "for local transport"
19448 This option associates a home directory with any address that is routed to a
19449 local transport. This can happen either because a transport is explicitly
19450 configured for the router, or because it generates a delivery to a file or a
19451 pipe. During the delivery process (that is, at transport time), the option
19452 string is expanded and is set as the home directory, unless overridden by a
19453 setting of &%home_directory%& on the transport.
19454 If the expansion fails for any reason, including forced failure, an error is
19455 logged, and delivery is deferred.
19456
19457 If the transport does not specify a home directory, and
19458 &%transport_home_directory%& is not set for the router, the home directory for
19459 the transport is taken from the password data if &%check_local_user%& is set for
19460 the router. Otherwise it is taken from &%router_home_directory%& if that option
19461 is set; if not, no home directory is set for the transport.
19462
19463 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19464 environment.
19465
19466
19467
19468
19469 .option unseen routers boolean&!! false
19470 .cindex "router" "carrying on after success"
19471 The result of string expansion for this option must be a valid boolean value,
19472 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19473 result causes an error, and delivery is deferred. If the expansion is forced to
19474 fail, the default value for the option (false) is used. Other failures cause
19475 delivery to be deferred.
19476
19477 When this option is set true, routing does not cease if the router accepts the
19478 address. Instead, a copy of the incoming address is passed to the next router,
19479 overriding a false setting of &%more%&. There is little point in setting
19480 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19481 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19482 sometimes true and sometimes false).
19483
19484 .cindex "copy of message (&%unseen%& option)"
19485 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19486 qualifier in filter files. It can be used to cause copies of messages to be
19487 delivered to some other destination, while also carrying out a normal delivery.
19488 In effect, the current address is made into a &"parent"& that has two children
19489 &-- one that is delivered as specified by this router, and a clone that goes on
19490 to be routed further. For this reason, &%unseen%& may not be combined with the
19491 &%one_time%& option in a &(redirect)& router.
19492
19493 &*Warning*&: Header lines added to the address (or specified for removal) by
19494 this router or by previous routers affect the &"unseen"& copy of the message
19495 only. The clone that continues to be processed by further routers starts with
19496 no added headers and none specified for removal. For a &%redirect%& router, if
19497 a generated address is the same as the incoming address, this can lead to
19498 duplicate addresses with different header modifications. Exim does not do
19499 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19500 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19501 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19502 &%redirect%& router may be of help.
19503
19504 Unlike the handling of header modifications, any data that was set by the
19505 &%address_data%& option in the current or previous routers &'is'& passed on to
19506 subsequent routers.
19507
19508
19509 .option user routers string&!! "see below"
19510 .cindex "uid (user id)" "local delivery"
19511 .cindex "local transports" "uid and gid"
19512 .cindex "transport" "local"
19513 .cindex "router" "user for filter processing"
19514 .cindex "filter" "user for processing"
19515 When a router queues an address for a transport, and the transport does not
19516 specify a user, the user given here is used when running the delivery process.
19517 The user may be specified numerically or by name. If expansion fails, the
19518 error is logged and delivery is deferred.
19519 This user is also used by the &(redirect)& router when running a filter file.
19520 The default is unset, except when &%check_local_user%& is set. In this case,
19521 the default is taken from the password information. If the user is specified as
19522 a name, and &%group%& is not set, the group associated with the user is used.
19523 See also &%initgroups%& and &%group%& and the discussion in chapter
19524 &<<CHAPenvironment>>&.
19525
19526
19527
19528 .option verify routers&!? boolean true
19529 Setting this option has the effect of setting &%verify_sender%& and
19530 &%verify_recipient%& to the same value.
19531
19532
19533 .option verify_only routers&!? boolean false
19534 .cindex "EXPN" "with &%verify_only%&"
19535 .oindex "&%-bv%&"
19536 .cindex "router" "used only when verifying"
19537 If this option is set, the router is used only when verifying an address,
19538 delivering in cutthrough mode or
19539 testing with the &%-bv%& option, not when actually doing a delivery, testing
19540 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19541 restricted to verifying only senders or recipients by means of
19542 &%verify_sender%& and &%verify_recipient%&.
19543
19544 &*Warning*&: When the router is being run to verify addresses for an incoming
19545 SMTP message, Exim is not running as root, but under its own uid. If the router
19546 accesses any files, you need to make sure that they are accessible to the Exim
19547 user or group.
19548
19549
19550 .option verify_recipient routers&!? boolean true
19551 If this option is false, the router is skipped when verifying recipient
19552 addresses,
19553 delivering in cutthrough mode
19554 or testing recipient verification using &%-bv%&.
19555 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19556 are evaluated.
19557 See also the &$verify_mode$& variable.
19558
19559
19560 .option verify_sender routers&!? boolean true
19561 If this option is false, the router is skipped when verifying sender addresses
19562 or testing sender verification using &%-bvs%&.
19563 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19564 are evaluated.
19565 See also the &$verify_mode$& variable.
19566 .ecindex IIDgenoprou1
19567 .ecindex IIDgenoprou2
19568
19569
19570
19571
19572
19573
19574 . ////////////////////////////////////////////////////////////////////////////
19575 . ////////////////////////////////////////////////////////////////////////////
19576
19577 .chapter "The accept router" "CHID4"
19578 .cindex "&(accept)& router"
19579 .cindex "routers" "&(accept)&"
19580 The &(accept)& router has no private options of its own. Unless it is being
19581 used purely for verification (see &%verify_only%&) a transport is required to
19582 be defined by the generic &%transport%& option. If the preconditions that are
19583 specified by generic options are met, the router accepts the address and queues
19584 it for the given transport. The most common use of this router is for setting
19585 up deliveries to local mailboxes. For example:
19586 .code
19587 localusers:
19588   driver = accept
19589   domains = mydomain.example
19590   check_local_user
19591   transport = local_delivery
19592 .endd
19593 The &%domains%& condition in this example checks the domain of the address, and
19594 &%check_local_user%& checks that the local part is the login of a local user.
19595 When both preconditions are met, the &(accept)& router runs, and queues the
19596 address for the &(local_delivery)& transport.
19597
19598
19599
19600
19601
19602
19603 . ////////////////////////////////////////////////////////////////////////////
19604 . ////////////////////////////////////////////////////////////////////////////
19605
19606 .chapter "The dnslookup router" "CHAPdnslookup"
19607 .scindex IIDdnsrou1 "&(dnslookup)& router"
19608 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19609 The &(dnslookup)& router looks up the hosts that handle mail for the
19610 recipient's domain in the DNS. A transport must always be set for this router,
19611 unless &%verify_only%& is set.
19612
19613 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19614 SRV records. If none are found, or if SRV support is not configured,
19615 MX records are looked up. If no MX records exist, address records are sought.
19616 However, &%mx_domains%& can be set to disable the direct use of address
19617 records.
19618
19619 MX records of equal priority are sorted by Exim into a random order. Exim then
19620 looks for address records for the host names obtained from MX or SRV records.
19621 When a host has more than one IP address, they are sorted into a random order,
19622 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19623 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19624 generic option, the router declines.
19625
19626 Unless they have the highest priority (lowest MX value), MX records that point
19627 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19628 are discarded, together with any other MX records of equal or lower priority.
19629
19630 .cindex "MX record" "pointing to local host"
19631 .cindex "local host" "MX pointing to"
19632 .oindex "&%self%&" "in &(dnslookup)& router"
19633 If the host pointed to by the highest priority MX record, or looked up as an
19634 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19635 happens is controlled by the generic &%self%& option.
19636
19637
19638 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19639 There have been problems with DNS servers when SRV records are looked up.
19640 Some misbehaving servers return a DNS error or timeout when a non-existent
19641 SRV record is sought. Similar problems have in the past been reported for
19642 MX records. The global &%dns_again_means_nonexist%& option can help with this
19643 problem, but it is heavy-handed because it is a global option.
19644
19645 For this reason, there are two options, &%srv_fail_domains%& and
19646 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19647 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19648 an attempt to look up an SRV or MX record causes one of these results, and the
19649 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19650 such record"&. In the case of an SRV lookup, this means that the router
19651 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19652 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19653 case routing fails.
19654
19655
19656 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19657 .cindex "&(dnslookup)& router" "declines"
19658 There are a few cases where a &(dnslookup)& router will decline to accept
19659 an address; if such a router is expected to handle "all remaining non-local
19660 domains", then it is important to set &%no_more%&.
19661
19662 The router will defer rather than decline if the domain
19663 is found in the &%fail_defer_domains%& router option.
19664
19665 Reasons for a &(dnslookup)& router to decline currently include:
19666 .ilist
19667 The domain does not exist in DNS
19668 .next
19669 The domain exists but the MX record's host part is just "."; this is a common
19670 convention (borrowed from SRV) used to indicate that there is no such service
19671 for this domain and to not fall back to trying A/AAAA records.
19672 .next
19673 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19674 .next
19675 MX record points to a non-existent host.
19676 .next
19677 MX record points to an IP address and the main section option
19678 &%allow_mx_to_ip%& is not set.
19679 .next
19680 MX records exist and point to valid hosts, but all hosts resolve only to
19681 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19682 .next
19683 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19684 &%dns_check_names_pattern%& for handling one variant of this)
19685 .next
19686 &%check_secondary_mx%& is set on this router but the local host can
19687 not be found in the MX records (see below)
19688 .endlist
19689
19690
19691
19692
19693 .section "Private options for dnslookup" "SECID118"
19694 .cindex "options" "&(dnslookup)& router"
19695 The private options for the &(dnslookup)& router are as follows:
19696
19697 .option check_secondary_mx dnslookup boolean false
19698 .cindex "MX record" "checking for secondary"
19699 If this option is set, the router declines unless the local host is found in
19700 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19701 process domains for which the local host is a secondary mail exchanger
19702 differently to other domains. The way in which Exim decides whether a host is
19703 the local host is described in section &<<SECTreclocipadd>>&.
19704
19705
19706 .option check_srv dnslookup string&!! unset
19707 .cindex "SRV record" "enabling use of"
19708 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19709 addition to MX and address records. The support is disabled by default. To
19710 enable SRV support, set the &%check_srv%& option to the name of the service
19711 required. For example,
19712 .code
19713 check_srv = smtp
19714 .endd
19715 looks for SRV records that refer to the normal smtp service. The option is
19716 expanded, so the service name can vary from message to message or address
19717 to address. This might be helpful if SRV records are being used for a
19718 submission service. If the expansion is forced to fail, the &%check_srv%&
19719 option is ignored, and the router proceeds to look for MX records in the
19720 normal way.
19721
19722 When the expansion succeeds, the router searches first for SRV records for
19723 the given service (it assumes TCP protocol). A single SRV record with a
19724 host name that consists of just a single dot indicates &"no such service for
19725 this domain"&; if this is encountered, the router declines. If other kinds of
19726 SRV record are found, they are used to construct a host list for delivery
19727 according to the rules of RFC 2782. MX records are not sought in this case.
19728
19729 When no SRV records are found, MX records (and address records) are sought in
19730 the traditional way. In other words, SRV records take precedence over MX
19731 records, just as MX records take precedence over address records. Note that
19732 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19733 defined it. It is apparently believed that MX records are sufficient for email
19734 and that SRV records should not be used for this purpose. However, SRV records
19735 have an additional &"weight"& feature which some people might find useful when
19736 trying to split an SMTP load between hosts of different power.
19737
19738 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19739 when there is a DNS lookup error.
19740
19741
19742
19743
19744 .option fail_defer_domains dnslookup "domain list&!!" unset
19745 .cindex "MX record" "not found"
19746 DNS lookups for domains matching &%fail_defer_domains%&
19747 which find no matching record will cause the router to defer
19748 rather than the default behaviour of decline.
19749 This maybe be useful for queueing messages for a newly created
19750 domain while the DNS configuration is not ready.
19751 However, it will result in any message with mistyped domains
19752 also being queued.
19753
19754
19755 .option ipv4_only "string&!!" unset
19756 .cindex IPv6 disabling
19757 .cindex DNS "IPv6 disabling"
19758 The string is expanded, and if the result is anything but a forced failure,
19759 or an empty string, or one of the strings “0” or “no” or “false”
19760 (checked without regard to the case of the letters),
19761 only A records are used.
19762
19763 .option ipv4_prefer "string&!!" unset
19764 .cindex IPv4 preference
19765 .cindex DNS "IPv4 preference"
19766 The string is expanded, and if the result is anything but a forced failure,
19767 or an empty string, or one of the strings “0” or “no” or “false”
19768 (checked without regard to the case of the letters),
19769 A records are sorted before AAAA records (inverting the default).
19770
19771 .option mx_domains dnslookup "domain list&!!" unset
19772 .cindex "MX record" "required to exist"
19773 .cindex "SRV record" "required to exist"
19774 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19775 record in order to be recognized. (The name of this option could be improved.)
19776 For example, if all the mail hosts in &'fict.example'& are known to have MX
19777 records, except for those in &'discworld.fict.example'&, you could use this
19778 setting:
19779 .code
19780 mx_domains = ! *.discworld.fict.example : *.fict.example
19781 .endd
19782 This specifies that messages addressed to a domain that matches the list but
19783 has no MX record should be bounced immediately instead of being routed using
19784 the address record.
19785
19786
19787 .option mx_fail_domains dnslookup "domain list&!!" unset
19788 If the DNS lookup for MX records for one of the domains in this list causes a
19789 DNS lookup error, Exim behaves as if no MX records were found. See section
19790 &<<SECTprowitdnsloo>>& for more discussion.
19791
19792
19793
19794
19795 .option qualify_single dnslookup boolean true
19796 .cindex "DNS" "resolver options"
19797 .cindex "DNS" "qualifying single-component names"
19798 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19799 lookups. Typically, but not standardly, this causes the resolver to qualify
19800 single-component names with the default domain. For example, on a machine
19801 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19802 &'thesaurus.ref.example'& inside the resolver. For details of what your
19803 resolver actually does, consult your man pages for &'resolver'& and
19804 &'resolv.conf'&.
19805
19806
19807
19808 .option rewrite_headers dnslookup boolean true
19809 .cindex "rewriting" "header lines"
19810 .cindex "header lines" "rewriting"
19811 If the domain name in the address that is being processed is not fully
19812 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19813 an address is specified as &'dormouse@teaparty'&, the domain might be
19814 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19815 occur as a result of setting the &%widen_domains%& option. If
19816 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19817 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19818 header lines of the message are rewritten with the full domain name.
19819
19820 This option should be turned off only when it is known that no message is
19821 ever going to be sent outside an environment where the abbreviation makes
19822 sense.
19823
19824 When an MX record is looked up in the DNS and matches a wildcard record, name
19825 servers normally return a record containing the name that has been looked up,
19826 making it impossible to detect whether a wildcard was present or not. However,
19827 some name servers have recently been seen to return the wildcard entry. If the
19828 name returned by a DNS lookup begins with an asterisk, it is not used for
19829 header rewriting.
19830
19831
19832 .option same_domain_copy_routing dnslookup boolean false
19833 .cindex "address" "copying routing"
19834 Addresses with the same domain are normally routed by the &(dnslookup)& router
19835 to the same list of hosts. However, this cannot be presumed, because the router
19836 options and preconditions may refer to the local part of the address. By
19837 default, therefore, Exim routes each address in a message independently. DNS
19838 servers run caches, so repeated DNS lookups are not normally expensive, and in
19839 any case, personal messages rarely have more than a few recipients.
19840
19841 If you are running mailing lists with large numbers of subscribers at the same
19842 domain, and you are using a &(dnslookup)& router which is independent of the
19843 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19844 lookups for identical domains in one message. In this case, when &(dnslookup)&
19845 routes an address to a remote transport, any other unrouted addresses in the
19846 message that have the same domain are automatically given the same routing
19847 without processing them independently,
19848 provided the following conditions are met:
19849
19850 .ilist
19851 No router that processed the address specified &%headers_add%& or
19852 &%headers_remove%&.
19853 .next
19854 The router did not change the address in any way, for example, by &"widening"&
19855 the domain.
19856 .endlist
19857
19858
19859
19860
19861 .option search_parents dnslookup boolean false
19862 .cindex "DNS" "resolver options"
19863 When this option is true, the resolver option RES_DNSRCH is set for DNS
19864 lookups. This is different from the &%qualify_single%& option in that it
19865 applies to domains containing dots. Typically, but not standardly, it causes
19866 the resolver to search for the name in the current domain and in parent
19867 domains. For example, on a machine in the &'fict.example'& domain, if looking
19868 up &'teaparty.wonderland'& failed, the resolver would try
19869 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19870 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19871
19872 Setting this option true can cause problems in domains that have a wildcard MX
19873 record, because any domain that does not have its own MX record matches the
19874 local wildcard.
19875
19876
19877
19878 .option srv_fail_domains dnslookup "domain list&!!" unset
19879 If the DNS lookup for SRV records for one of the domains in this list causes a
19880 DNS lookup error, Exim behaves as if no SRV records were found. See section
19881 &<<SECTprowitdnsloo>>& for more discussion.
19882
19883
19884
19885
19886 .option widen_domains dnslookup "string list" unset
19887 .cindex "domain" "partial; widening"
19888 If a DNS lookup fails and this option is set, each of its strings in turn is
19889 added onto the end of the domain, and the lookup is tried again. For example,
19890 if
19891 .code
19892 widen_domains = fict.example:ref.example
19893 .endd
19894 is set and a lookup of &'klingon.dictionary'& fails,
19895 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19896 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19897 and &%search_parents%& options can cause some widening to be undertaken inside
19898 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19899 when verifying, unless &%rewrite_headers%& is false (not the default).
19900
19901
19902 .section "Effect of qualify_single and search_parents" "SECID119"
19903 When a domain from an envelope recipient is changed by the resolver as a result
19904 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19905 corresponding address in the message's header lines unless &%rewrite_headers%&
19906 is set false. Exim then re-routes the address, using the full domain.
19907
19908 These two options affect only the DNS lookup that takes place inside the router
19909 for the domain of the address that is being routed. They do not affect lookups
19910 such as that implied by
19911 .code
19912 domains = @mx_any
19913 .endd
19914 that may happen while processing a router precondition before the router is
19915 entered. No widening ever takes place for these lookups.
19916 .ecindex IIDdnsrou1
19917 .ecindex IIDdnsrou2
19918
19919
19920
19921
19922
19923
19924
19925
19926
19927 . ////////////////////////////////////////////////////////////////////////////
19928 . ////////////////////////////////////////////////////////////////////////////
19929
19930 .chapter "The ipliteral router" "CHID5"
19931 .cindex "&(ipliteral)& router"
19932 .cindex "domain literal" "routing"
19933 .cindex "routers" "&(ipliteral)&"
19934 This router has no private options. Unless it is being used purely for
19935 verification (see &%verify_only%&) a transport is required to be defined by the
19936 generic &%transport%& option. The router accepts the address if its domain part
19937 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19938 router handles the address
19939 .code
19940 root@[192.168.1.1]
19941 .endd
19942 by setting up delivery to the host with that IP address. IPv4 domain literals
19943 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19944 are similar, but the address is preceded by &`ipv6:`&. For example:
19945 .code
19946 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19947 .endd
19948 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19949 grounds that sooner or later somebody will try it.
19950
19951 .oindex "&%self%&" "in &(ipliteral)& router"
19952 If the IP address matches something in &%ignore_target_hosts%&, the router
19953 declines. If an IP literal turns out to refer to the local host, the generic
19954 &%self%& option determines what happens.
19955
19956 The RFCs require support for domain literals; however, their use is
19957 controversial in today's Internet. If you want to use this router, you must
19958 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19959 Exim will not recognize the domain literal syntax in addresses.
19960
19961
19962
19963 . ////////////////////////////////////////////////////////////////////////////
19964 . ////////////////////////////////////////////////////////////////////////////
19965
19966 .chapter "The iplookup router" "CHID6"
19967 .cindex "&(iplookup)& router"
19968 .cindex "routers" "&(iplookup)&"
19969 The &(iplookup)& router was written to fulfil a specific requirement in
19970 Cambridge University (which in fact no longer exists). For this reason, it is
19971 not included in the binary of Exim by default. If you want to include it, you
19972 must set
19973 .code
19974 ROUTER_IPLOOKUP=yes
19975 .endd
19976 in your &_Local/Makefile_& configuration file.
19977
19978 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19979 connection to one or more specific hosts. The host can then return the same or
19980 a different address &-- in effect rewriting the recipient address in the
19981 message's envelope. The new address is then passed on to subsequent routers. If
19982 this process fails, the address can be passed on to other routers, or delivery
19983 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19984 must not be specified for it.
19985
19986 .cindex "options" "&(iplookup)& router"
19987 .option hosts iplookup string unset
19988 This option must be supplied. Its value is a colon-separated list of host
19989 names. The hosts are looked up using &[gethostbyname()]&
19990 (or &[getipnodebyname()]& when available)
19991 and are tried in order until one responds to the query. If none respond, what
19992 happens is controlled by &%optional%&.
19993
19994
19995 .option optional iplookup boolean false
19996 If &%optional%& is true, if no response is obtained from any host, the address
19997 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19998 delivery to the address is deferred.
19999
20000
20001 .option port iplookup integer 0
20002 .cindex "port" "&(iplookup)& router"
20003 This option must be supplied. It specifies the port number for the TCP or UDP
20004 call.
20005
20006
20007 .option protocol iplookup string udp
20008 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20009 protocols is to be used.
20010
20011
20012 .option query iplookup string&!! "see below"
20013 This defines the content of the query that is sent to the remote hosts. The
20014 default value is:
20015 .code
20016 $local_part@$domain $local_part@$domain
20017 .endd
20018 The repetition serves as a way of checking that a response is to the correct
20019 query in the default case (see &%response_pattern%& below).
20020
20021
20022 .option reroute iplookup string&!! unset
20023 If this option is not set, the rerouted address is precisely the byte string
20024 returned by the remote host, up to the first white space, if any. If set, the
20025 string is expanded to form the rerouted address. It can include parts matched
20026 in the response by &%response_pattern%& by means of numeric variables such as
20027 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20028 whether or not a pattern is in use. In all cases, the rerouted address must end
20029 up in the form &'local_part@domain'&.
20030
20031
20032 .option response_pattern iplookup string unset
20033 This option can be set to a regular expression that is applied to the string
20034 returned from the remote host. If the pattern does not match the response, the
20035 router declines. If &%response_pattern%& is not set, no checking of the
20036 response is done, unless the query was defaulted, in which case there is a
20037 check that the text returned after the first white space is the original
20038 address. This checks that the answer that has been received is in response to
20039 the correct question. For example, if the response is just a new domain, the
20040 following could be used:
20041 .code
20042 response_pattern = ^([^@]+)$
20043 reroute = $local_part@$1
20044 .endd
20045
20046 .option timeout iplookup time 5s
20047 This specifies the amount of time to wait for a response from the remote
20048 machine. The same timeout is used for the &[connect()]& function for a TCP
20049 call. It does not apply to UDP.
20050
20051
20052
20053
20054 . ////////////////////////////////////////////////////////////////////////////
20055 . ////////////////////////////////////////////////////////////////////////////
20056
20057 .chapter "The manualroute router" "CHID7"
20058 .scindex IIDmanrou1 "&(manualroute)& router"
20059 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20060 .cindex "domain" "manually routing"
20061 The &(manualroute)& router is so-called because it provides a way of manually
20062 routing an address according to its domain. It is mainly used when you want to
20063 route addresses to remote hosts according to your own rules, bypassing the
20064 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20065 route to local transports, a facility that may be useful if you want to save
20066 messages for dial-in hosts in local files.
20067
20068 The &(manualroute)& router compares a list of domain patterns with the domain
20069 it is trying to route. If there is no match, the router declines. Each pattern
20070 has associated with it a list of hosts and some other optional data, which may
20071 include a transport. The combination of a pattern and its data is called a
20072 &"routing rule"&. For patterns that do not have an associated transport, the
20073 generic &%transport%& option must specify a transport, unless the router is
20074 being used purely for verification (see &%verify_only%&).
20075
20076 .vindex "&$host$&"
20077 In the case of verification, matching the domain pattern is sufficient for the
20078 router to accept the address. When actually routing an address for delivery,
20079 an address that matches a domain pattern is queued for the associated
20080 transport. If the transport is not a local one, a host list must be associated
20081 with the pattern; IP addresses are looked up for the hosts, and these are
20082 passed to the transport along with the mail address. For local transports, a
20083 host list is optional. If it is present, it is passed in &$host$& as a single
20084 text string.
20085
20086 The list of routing rules can be provided as an inline string in
20087 &%route_list%&, or the data can be obtained by looking up the domain in a file
20088 or database by setting &%route_data%&. Only one of these settings may appear in
20089 any one instance of &(manualroute)&. The format of routing rules is described
20090 below, following the list of private options.
20091
20092
20093 .section "Private options for manualroute" "SECTprioptman"
20094
20095 .cindex "options" "&(manualroute)& router"
20096 The private options for the &(manualroute)& router are as follows:
20097
20098 .option host_all_ignored manualroute string defer
20099 See &%host_find_failed%&.
20100
20101 .option host_find_failed manualroute string freeze
20102 This option controls what happens when &(manualroute)& tries to find an IP
20103 address for a host, and the host does not exist. The option can be set to one
20104 of the following values:
20105 .code
20106 decline
20107 defer
20108 fail
20109 freeze
20110 ignore
20111 pass
20112 .endd
20113 The default (&"freeze"&) assumes that this state is a serious configuration
20114 error. The difference between &"pass"& and &"decline"& is that the former
20115 forces the address to be passed to the next router (or the router defined by
20116 &%pass_router%&),
20117 .oindex "&%more%&"
20118 overriding &%no_more%&, whereas the latter passes the address to the next
20119 router only if &%more%& is true.
20120
20121 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20122 cannot be found. If all the hosts in the list are ignored, the behaviour is
20123 controlled by the &%host_all_ignored%& option. This takes the same values
20124 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20125
20126 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20127 state; if a host lookup gets a temporary error, delivery is deferred unless the
20128 generic &%pass_on_timeout%& option is set.
20129
20130
20131 .option hosts_randomize manualroute boolean false
20132 .cindex "randomized host list"
20133 .cindex "host" "list of; randomized"
20134 If this option is set, the order of the items in a host list in a routing rule
20135 is randomized each time the list is used, unless an option in the routing rule
20136 overrides (see below). Randomizing the order of a host list can be used to do
20137 crude load sharing. However, if more than one mail address is routed by the
20138 same router to the same host list, the host lists are considered to be the same
20139 (even though they may be randomized into different orders) for the purpose of
20140 deciding whether to batch the deliveries into a single SMTP transaction.
20141
20142 When &%hosts_randomize%& is true, a host list may be split
20143 into groups whose order is separately randomized. This makes it possible to
20144 set up MX-like behaviour. The boundaries between groups are indicated by an
20145 item that is just &`+`& in the host list. For example:
20146 .code
20147 route_list = * host1:host2:host3:+:host4:host5
20148 .endd
20149 The order of the first three hosts and the order of the last two hosts is
20150 randomized for each use, but the first three always end up before the last two.
20151 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20152 randomized host list is passed to an &(smtp)& transport that also has
20153 &%hosts_randomize set%&, the list is not re-randomized.
20154
20155
20156 .option route_data manualroute string&!! unset
20157 If this option is set, it must expand to yield the data part of a routing rule.
20158 Typically, the expansion string includes a lookup based on the domain. For
20159 example:
20160 .code
20161 route_data = ${lookup{$domain}dbm{/etc/routes}}
20162 .endd
20163 If the expansion is forced to fail, or the result is an empty string, the
20164 router declines. Other kinds of expansion failure cause delivery to be
20165 deferred.
20166
20167
20168 .option route_list manualroute "string list" unset
20169 This string is a list of routing rules, in the form defined below. Note that,
20170 unlike most string lists, the items are separated by semicolons. This is so
20171 that they may contain colon-separated host lists.
20172
20173
20174 .option same_domain_copy_routing manualroute boolean false
20175 .cindex "address" "copying routing"
20176 Addresses with the same domain are normally routed by the &(manualroute)&
20177 router to the same list of hosts. However, this cannot be presumed, because the
20178 router options and preconditions may refer to the local part of the address. By
20179 default, therefore, Exim routes each address in a message independently. DNS
20180 servers run caches, so repeated DNS lookups are not normally expensive, and in
20181 any case, personal messages rarely have more than a few recipients.
20182
20183 If you are running mailing lists with large numbers of subscribers at the same
20184 domain, and you are using a &(manualroute)& router which is independent of the
20185 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20186 lookups for identical domains in one message. In this case, when
20187 &(manualroute)& routes an address to a remote transport, any other unrouted
20188 addresses in the message that have the same domain are automatically given the
20189 same routing without processing them independently. However, this is only done
20190 if &%headers_add%& and &%headers_remove%& are unset.
20191
20192
20193
20194
20195 .section "Routing rules in route_list" "SECID120"
20196 The value of &%route_list%& is a string consisting of a sequence of routing
20197 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20198 entered as two semicolons. Alternatively, the list separator can be changed as
20199 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20200 Empty rules are ignored. The format of each rule is
20201 .display
20202 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20203 .endd
20204 The following example contains two rules, each with a simple domain pattern and
20205 no options:
20206 .code
20207 route_list = \
20208   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20209   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20210 .endd
20211 The three parts of a rule are separated by white space. The pattern and the
20212 list of hosts can be enclosed in quotes if necessary, and if they are, the
20213 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20214 single domain pattern, which is the only mandatory item in the rule. The
20215 pattern is in the same format as one item in a domain list (see section
20216 &<<SECTdomainlist>>&),
20217 except that it may not be the name of an interpolated file.
20218 That is, it may be wildcarded, or a regular expression, or a file or database
20219 lookup (with semicolons doubled, because of the use of semicolon as a separator
20220 in a &%route_list%&).
20221
20222 The rules in &%route_list%& are searched in order until one of the patterns
20223 matches the domain that is being routed. The list of hosts and then options are
20224 then used as described below. If there is no match, the router declines. When
20225 &%route_list%& is set, &%route_data%& must not be set.
20226
20227
20228
20229 .section "Routing rules in route_data" "SECID121"
20230 The use of &%route_list%& is convenient when there are only a small number of
20231 routing rules. For larger numbers, it is easier to use a file or database to
20232 hold the routing information, and use the &%route_data%& option instead.
20233 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20234 Most commonly, &%route_data%& is set as a string that contains an
20235 expansion lookup. For example, suppose we place two routing rules in a file
20236 like this:
20237 .code
20238 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20239 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20240 .endd
20241 This data can be accessed by setting
20242 .code
20243 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20244 .endd
20245 Failure of the lookup results in an empty string, causing the router to
20246 decline. However, you do not have to use a lookup in &%route_data%&. The only
20247 requirement is that the result of expanding the string is a list of hosts,
20248 possibly followed by options, separated by white space. The list of hosts must
20249 be enclosed in quotes if it contains white space.
20250
20251
20252
20253
20254 .section "Format of the list of hosts" "SECID122"
20255 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20256 always separately expanded before use. If the expansion fails, the router
20257 declines. The result of the expansion must be a colon-separated list of names
20258 and/or IP addresses, optionally also including ports.
20259 If the list is written with spaces, it must be protected with quotes.
20260 The format of each item
20261 in the list is described in the next section. The list separator can be changed
20262 as described in section &<<SECTlistsepchange>>&.
20263
20264 If the list of hosts was obtained from a &%route_list%& item, the following
20265 variables are set during its expansion:
20266
20267 .ilist
20268 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20269 If the domain was matched against a regular expression, the numeric variables
20270 &$1$&, &$2$&, etc. may be set. For example:
20271 .code
20272 route_list = ^domain(\d+)   host-$1.text.example
20273 .endd
20274 .next
20275 &$0$& is always set to the entire domain.
20276 .next
20277 &$1$& is also set when partial matching is done in a file lookup.
20278
20279 .next
20280 .vindex "&$value$&"
20281 If the pattern that matched the domain was a lookup item, the data that was
20282 looked up is available in the expansion variable &$value$&. For example:
20283 .code
20284 route_list = lsearch;;/some/file.routes  $value
20285 .endd
20286 .endlist
20287
20288 Note the doubling of the semicolon in the pattern that is necessary because
20289 semicolon is the default route list separator.
20290
20291
20292
20293 .section "Format of one host item" "SECTformatonehostitem"
20294 Each item in the list of hosts can be either a host name or an IP address,
20295 optionally with an attached port number, or it can be a single "+"
20296 (see &%hosts_randomize%&).
20297 When no port is given, an IP address
20298 is not enclosed in brackets. When a port is specified, it overrides the port
20299 specification on the transport. The port is separated from the name or address
20300 by a colon. This leads to some complications:
20301
20302 .ilist
20303 Because colon is the default separator for the list of hosts, either
20304 the colon that specifies a port must be doubled, or the list separator must
20305 be changed. The following two examples have the same effect:
20306 .code
20307 route_list = * "host1.tld::1225 : host2.tld::1226"
20308 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20309 .endd
20310 .next
20311 When IPv6 addresses are involved, it gets worse, because they contain
20312 colons of their own. To make this case easier, it is permitted to
20313 enclose an IP address (either v4 or v6) in square brackets if a port
20314 number follows. For example:
20315 .code
20316 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20317 .endd
20318 .endlist
20319
20320 .section "How the list of hosts is used" "SECThostshowused"
20321 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20322 the hosts is tried, in the order specified, when carrying out the SMTP
20323 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20324 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20325 transport.
20326
20327 Hosts may be listed by name or by IP address. An unadorned name in the list of
20328 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20329 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20330 records in the DNS. For example:
20331 .code
20332 route_list = *  x.y.z:p.q.r/MX:e.f.g
20333 .endd
20334 If this feature is used with a port specifier, the port must come last. For
20335 example:
20336 .code
20337 route_list = *  dom1.tld/mx::1225
20338 .endd
20339 If the &%hosts_randomize%& option is set, the order of the items in the list is
20340 randomized before any lookups are done. Exim then scans the list; for any name
20341 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20342 be an interface on the local host and the item is not the first in the list,
20343 Exim discards it and any subsequent items. If it is the first item, what
20344 happens is controlled by the
20345 .oindex "&%self%&" "in &(manualroute)& router"
20346 &%self%& option of the router.
20347
20348 A name on the list that is followed by &`/MX`& is replaced with the list of
20349 hosts obtained by looking up MX records for the name. This is always a DNS
20350 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20351 below) are not relevant here. The order of these hosts is determined by the
20352 preference values in the MX records, according to the usual rules. Because
20353 randomizing happens before the MX lookup, it does not affect the order that is
20354 defined by MX preferences.
20355
20356 If the local host is present in the sublist obtained from MX records, but is
20357 not the most preferred host in that list, it and any equally or less
20358 preferred hosts are removed before the sublist is inserted into the main list.
20359
20360 If the local host is the most preferred host in the MX list, what happens
20361 depends on where in the original list of hosts the &`/MX`& item appears. If it
20362 is not the first item (that is, there are previous hosts in the main list),
20363 Exim discards this name and any subsequent items in the main list.
20364
20365 If the MX item is first in the list of hosts, and the local host is the
20366 most preferred host, what happens is controlled by the &%self%& option of the
20367 router.
20368
20369 DNS failures when lookup up the MX records are treated in the same way as DNS
20370 failures when looking up IP addresses: &%pass_on_timeout%& and
20371 &%host_find_failed%& are used when relevant.
20372
20373 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20374 whether obtained from an MX lookup or not.
20375
20376
20377
20378 .section "How the options are used" "SECThowoptused"
20379 The options are a sequence of words, space-separated.
20380 One of the words can be the name of a transport; this overrides the
20381 &%transport%& option on the router for this particular routing rule only. The
20382 other words (if present) control randomization of the list of hosts on a
20383 per-rule basis, and how the IP addresses of the hosts are to be found when
20384 routing to a remote transport. These options are as follows:
20385
20386 .ilist
20387 &%randomize%&: randomize the order of the hosts in this list, overriding the
20388 setting of &%hosts_randomize%& for this routing rule only.
20389 .next
20390 &%no_randomize%&: do not randomize the order of the hosts in this list,
20391 overriding the setting of &%hosts_randomize%& for this routing rule only.
20392 .next
20393 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20394 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20395 also look in &_/etc/hosts_& or other sources of information.
20396 .next
20397 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20398 no address records are found. If there is a temporary DNS error (such as a
20399 timeout), delivery is deferred.
20400 .next
20401 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20402 .next
20403 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20404 .endlist
20405
20406 For example:
20407 .code
20408 route_list = domain1  host1:host2:host3  randomize bydns;\
20409              domain2  host4:host5
20410 .endd
20411 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20412 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20413 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20414 or &[gethostbyname()]&, and the result of the lookup is the result of that
20415 call.
20416
20417 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20418 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20419 instead of TRY_AGAIN. That is why the default action is to try a DNS
20420 lookup first. Only if that gives a definite &"no such host"& is the local
20421 function called.
20422
20423 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20424 inadvertent constraint that a transport name as an option had to be the last
20425 option specified.
20426
20427
20428
20429 If no IP address for a host can be found, what happens is controlled by the
20430 &%host_find_failed%& option.
20431
20432 .vindex "&$host$&"
20433 When an address is routed to a local transport, IP addresses are not looked up.
20434 The host list is passed to the transport in the &$host$& variable.
20435
20436
20437
20438 .section "Manualroute examples" "SECID123"
20439 In some of the examples that follow, the presence of the &%remote_smtp%&
20440 transport, as defined in the default configuration file, is assumed:
20441
20442 .ilist
20443 .cindex "smart host" "example router"
20444 The &(manualroute)& router can be used to forward all external mail to a
20445 &'smart host'&. If you have set up, in the main part of the configuration, a
20446 named domain list that contains your local domains, for example:
20447 .code
20448 domainlist local_domains = my.domain.example
20449 .endd
20450 You can arrange for all other domains to be routed to a smart host by making
20451 your first router something like this:
20452 .code
20453 smart_route:
20454   driver = manualroute
20455   domains = !+local_domains
20456   transport = remote_smtp
20457   route_list = * smarthost.ref.example
20458 .endd
20459 This causes all non-local addresses to be sent to the single host
20460 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20461 they are tried in order
20462 (but you can use &%hosts_randomize%& to vary the order each time).
20463 Another way of configuring the same thing is this:
20464 .code
20465 smart_route:
20466   driver = manualroute
20467   transport = remote_smtp
20468   route_list = !+local_domains  smarthost.ref.example
20469 .endd
20470 There is no difference in behaviour between these two routers as they stand.
20471 However, they behave differently if &%no_more%& is added to them. In the first
20472 example, the router is skipped if the domain does not match the &%domains%&
20473 precondition; the following router is always tried. If the router runs, it
20474 always matches the domain and so can never decline. Therefore, &%no_more%&
20475 would have no effect. In the second case, the router is never skipped; it
20476 always runs. However, if it doesn't match the domain, it declines. In this case
20477 &%no_more%& would prevent subsequent routers from running.
20478
20479 .next
20480 .cindex "mail hub example"
20481 A &'mail hub'& is a host which receives mail for a number of domains via MX
20482 records in the DNS and delivers it via its own private routing mechanism. Often
20483 the final destinations are behind a firewall, with the mail hub being the one
20484 machine that can connect to machines both inside and outside the firewall. The
20485 &(manualroute)& router is usually used on a mail hub to route incoming messages
20486 to the correct hosts. For a small number of domains, the routing can be inline,
20487 using the &%route_list%& option, but for a larger number a file or database
20488 lookup is easier to manage.
20489
20490 If the domain names are in fact the names of the machines to which the mail is
20491 to be sent by the mail hub, the configuration can be quite simple. For
20492 example:
20493 .code
20494 hub_route:
20495   driver = manualroute
20496   transport = remote_smtp
20497   route_list = *.rhodes.tvs.example  $domain
20498 .endd
20499 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20500 whose names are the same as the mail domains. A similar approach can be taken
20501 if the host name can be obtained from the domain name by a string manipulation
20502 that the expansion facilities can handle. Otherwise, a lookup based on the
20503 domain can be used to find the host:
20504 .code
20505 through_firewall:
20506   driver = manualroute
20507   transport = remote_smtp
20508   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20509 .endd
20510 The result of the lookup must be the name or IP address of the host (or
20511 hosts) to which the address is to be routed. If the lookup fails, the route
20512 data is empty, causing the router to decline. The address then passes to the
20513 next router.
20514
20515 .next
20516 .cindex "batched SMTP output example"
20517 .cindex "SMTP" "batched outgoing; example"
20518 You can use &(manualroute)& to deliver messages to pipes or files in batched
20519 SMTP format for onward transportation by some other means. This is one way of
20520 storing mail for a dial-up host when it is not connected. The route list entry
20521 can be as simple as a single domain name in a configuration like this:
20522 .code
20523 save_in_file:
20524   driver = manualroute
20525   transport = batchsmtp_appendfile
20526   route_list = saved.domain.example
20527 .endd
20528 though often a pattern is used to pick up more than one domain. If there are
20529 several domains or groups of domains with different transport requirements,
20530 different transports can be listed in the routing information:
20531 .code
20532 save_in_file:
20533   driver = manualroute
20534   route_list = \
20535     *.saved.domain1.example  $domain  batch_appendfile; \
20536     *.saved.domain2.example  \
20537       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20538       batch_pipe
20539 .endd
20540 .vindex "&$domain$&"
20541 .vindex "&$host$&"
20542 The first of these just passes the domain in the &$host$& variable, which
20543 doesn't achieve much (since it is also in &$domain$&), but the second does a
20544 file lookup to find a value to pass, causing the router to decline to handle
20545 the address if the lookup fails.
20546
20547 .next
20548 .cindex "UUCP" "example of router for"
20549 Routing mail directly to UUCP software is a specific case of the use of
20550 &(manualroute)& in a gateway to another mail environment. This is an example of
20551 one way it can be done:
20552 .code
20553 # Transport
20554 uucp:
20555   driver = pipe
20556   user = nobody
20557   command = /usr/local/bin/uux -r - \
20558     ${substr_-5:$host}!rmail ${local_part}
20559   return_fail_output = true
20560
20561 # Router
20562 uucphost:
20563   transport = uucp
20564   driver = manualroute
20565   route_data = \
20566     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20567 .endd
20568 The file &_/usr/local/exim/uucphosts_& contains entries like
20569 .code
20570 darksite.ethereal.example:           darksite.UUCP
20571 .endd
20572 It can be set up more simply without adding and removing &".UUCP"& but this way
20573 makes clear the distinction between the domain name
20574 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20575 .endlist
20576 .ecindex IIDmanrou1
20577 .ecindex IIDmanrou2
20578
20579
20580
20581
20582
20583
20584
20585
20586 . ////////////////////////////////////////////////////////////////////////////
20587 . ////////////////////////////////////////////////////////////////////////////
20588
20589 .chapter "The queryprogram router" "CHAPdriverlast"
20590 .scindex IIDquerou1 "&(queryprogram)& router"
20591 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20592 .cindex "routing" "by external program"
20593 The &(queryprogram)& router routes an address by running an external command
20594 and acting on its output. This is an expensive way to route, and is intended
20595 mainly for use in lightly-loaded systems, or for performing experiments.
20596 However, if it is possible to use the precondition options (&%domains%&,
20597 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20598 be used in special cases, even on a busy host. There are the following private
20599 options:
20600 .cindex "options" "&(queryprogram)& router"
20601
20602 .option command queryprogram string&!! unset
20603 This option must be set. It specifies the command that is to be run. The
20604 command is split up into a command name and arguments, and then each is
20605 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20606 &<<CHAPpipetransport>>&).
20607
20608
20609 .option command_group queryprogram string unset
20610 .cindex "gid (group id)" "in &(queryprogram)& router"
20611 This option specifies a gid to be set when running the command while routing an
20612 address for deliver. It must be set if &%command_user%& specifies a numerical
20613 uid. If it begins with a digit, it is interpreted as the numerical value of the
20614 gid. Otherwise it is looked up using &[getgrnam()]&.
20615
20616
20617 .option command_user queryprogram string unset
20618 .cindex "uid (user id)" "for &(queryprogram)&"
20619 This option must be set. It specifies the uid which is set when running the
20620 command while routing an address for delivery. If the value begins with a digit,
20621 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20622 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20623 not set, a value for the gid also.
20624
20625 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20626 root, which it does during a normal delivery in a conventional configuration.
20627 However, when an address is being verified during message reception, Exim is
20628 usually running as the Exim user, not as root. If the &(queryprogram)& router
20629 is called from a non-root process, Exim cannot change uid or gid before running
20630 the command. In this circumstance the command runs under the current uid and
20631 gid.
20632
20633
20634 .option current_directory queryprogram string /
20635 This option specifies an absolute path which is made the current directory
20636 before running the command.
20637
20638
20639 .option timeout queryprogram time 1h
20640 If the command does not complete within the timeout period, its process group
20641 is killed and the message is frozen. A value of zero time specifies no
20642 timeout.
20643
20644
20645 The standard output of the command is connected to a pipe, which is read when
20646 the command terminates. It should consist of a single line of output,
20647 containing up to five fields, separated by white space. The maximum length of
20648 the line is 1023 characters. Longer lines are silently truncated. The first
20649 field is one of the following words (case-insensitive):
20650
20651 .ilist
20652 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20653 below).
20654 .next
20655 &'Decline'&: the router declines; pass the address to the next router, unless
20656 &%no_more%& is set.
20657 .next
20658 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20659 subsequent text on the line is an error message. If the router is run as part
20660 of address verification during an incoming SMTP message, the message is
20661 included in the SMTP response.
20662 .next
20663 &'Defer'&: routing could not be completed at this time; try again later. Any
20664 subsequent text on the line is an error message which is logged. It is not
20665 included in any SMTP response.
20666 .next
20667 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20668 .next
20669 &'Pass'&: pass the address to the next router (or the router specified by
20670 &%pass_router%&), overriding &%no_more%&.
20671 .next
20672 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20673 new addresses, which are routed independently, starting with the first router,
20674 or the router specified by &%redirect_router%&, if set.
20675 .endlist
20676
20677 When the first word is &'accept'&, the remainder of the line consists of a
20678 number of keyed data values, as follows (split into two lines here, to fit on
20679 the page):
20680 .code
20681 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20682 LOOKUP=byname|bydns DATA=<text>
20683 .endd
20684 The data items can be given in any order, and all are optional. If no transport
20685 is included, the transport specified by the generic &%transport%& option is
20686 used. The list of hosts and the lookup type are needed only if the transport is
20687 an &(smtp)& transport that does not itself supply a list of hosts.
20688
20689 The format of the list of hosts is the same as for the &(manualroute)& router.
20690 As well as host names and IP addresses with optional port numbers, as described
20691 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20692 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20693 (see section &<<SECThostshowused>>&).
20694
20695 If the lookup type is not specified, Exim behaves as follows when trying to
20696 find an IP address for each host: First, a DNS lookup is done. If this yields
20697 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20698 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20699 result of the lookup is the result of that call.
20700
20701 .vindex "&$address_data$&"
20702 If the DATA field is set, its value is placed in the &$address_data$&
20703 variable. For example, this return line
20704 .code
20705 accept hosts=x1.y.example:x2.y.example data="rule1"
20706 .endd
20707 routes the address to the default transport, passing a list of two hosts. When
20708 the transport runs, the string &"rule1"& is in &$address_data$&.
20709 .ecindex IIDquerou1
20710 .ecindex IIDquerou2
20711
20712
20713
20714
20715 . ////////////////////////////////////////////////////////////////////////////
20716 . ////////////////////////////////////////////////////////////////////////////
20717
20718 .chapter "The redirect router" "CHAPredirect"
20719 .scindex IIDredrou1 "&(redirect)& router"
20720 .scindex IIDredrou2 "routers" "&(redirect)&"
20721 .cindex "alias file" "in a &(redirect)& router"
20722 .cindex "address redirection" "&(redirect)& router"
20723 The &(redirect)& router handles several kinds of address redirection. Its most
20724 common uses are for resolving local part aliases from a central alias file
20725 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20726 files, but it has many other potential uses. The incoming address can be
20727 redirected in several different ways:
20728
20729 .ilist
20730 It can be replaced by one or more new addresses which are themselves routed
20731 independently.
20732 .next
20733 It can be routed to be delivered to a given file or directory.
20734 .next
20735 It can be routed to be delivered to a specified pipe command.
20736 .next
20737 It can cause an automatic reply to be generated.
20738 .next
20739 It can be forced to fail, optionally with a custom error message.
20740 .next
20741 It can be temporarily deferred, optionally with a custom message.
20742 .next
20743 It can be discarded.
20744 .endlist
20745
20746 The generic &%transport%& option must not be set for &(redirect)& routers.
20747 However, there are some private options which define transports for delivery to
20748 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20749 &%pipe_transport%& and &%reply_transport%& descriptions below.
20750
20751 If success DSNs have been requested
20752 .cindex "DSN" "success"
20753 .cindex "Delivery Status Notification" "success"
20754 redirection triggers one and the DSN options are not passed any further.
20755
20756
20757
20758 .section "Redirection data" "SECID124"
20759 The router operates by interpreting a text string which it obtains either by
20760 expanding the contents of the &%data%& option, or by reading the entire
20761 contents of a file whose name is given in the &%file%& option. These two
20762 options are mutually exclusive. The first is commonly used for handling system
20763 aliases, in a configuration like this:
20764 .code
20765 system_aliases:
20766   driver = redirect
20767   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20768 .endd
20769 If the lookup fails, the expanded string in this example is empty. When the
20770 expansion of &%data%& results in an empty string, the router declines. A forced
20771 expansion failure also causes the router to decline; other expansion failures
20772 cause delivery to be deferred.
20773
20774 A configuration using &%file%& is commonly used for handling users'
20775 &_.forward_& files, like this:
20776 .code
20777 userforward:
20778   driver = redirect
20779   check_local_user
20780   file = $home/.forward
20781   no_verify
20782 .endd
20783 If the file does not exist, or causes no action to be taken (for example, it is
20784 empty or consists only of comments), the router declines. &*Warning*&: This
20785 is not the case when the file contains syntactically valid items that happen to
20786 yield empty addresses, for example, items containing only RFC 2822 address
20787 comments.
20788
20789 .new
20790 .cindex "tainted data" "in filenames"
20791 .cindex redirect "tainted data"
20792 Tainted data may not be used for a filename.
20793
20794 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20795 directly for redirection,
20796 as they are provided by a potential attacker.
20797 In the examples above, &$local_part$& is used for looking up data held locally
20798 on the system, and not used directly (the second example derives &$home$& via
20799 the passsword file or database, using &$local_part$&).
20800 .wen
20801
20802
20803
20804 .section "Forward files and address verification" "SECID125"
20805 .cindex "address redirection" "while verifying"
20806 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20807 &_.forward_& files, as in the example above. There are two reasons for this:
20808
20809 .ilist
20810 When Exim is receiving an incoming SMTP message from a remote host, it is
20811 running under the Exim uid, not as root. Exim is unable to change uid to read
20812 the file as the user, and it may not be able to read it as the Exim user. So in
20813 practice the router may not be able to operate.
20814 .next
20815 However, even when the router can operate, the existence of a &_.forward_& file
20816 is unimportant when verifying an address. What should be checked is whether the
20817 local part is a valid user name or not. Cutting out the redirection processing
20818 saves some resources.
20819 .endlist
20820
20821
20822
20823
20824
20825
20826 .section "Interpreting redirection data" "SECID126"
20827 .cindex "Sieve filter" "specifying in redirection data"
20828 .cindex "filter" "specifying in redirection data"
20829 The contents of the data string, whether obtained from &%data%& or &%file%&,
20830 can be interpreted in two different ways:
20831
20832 .ilist
20833 If the &%allow_filter%& option is set true, and the data begins with the text
20834 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20835 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20836 respectively. Details of the syntax and semantics of filter files are described
20837 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20838 document is intended for use by end users.
20839 .next
20840 Otherwise, the data must be a comma-separated list of redirection items, as
20841 described in the next section.
20842 .endlist
20843
20844 When a message is redirected to a file (a &"mail folder"&), the filename given
20845 in a non-filter redirection list must always be an absolute path. A filter may
20846 generate a relative path &-- how this is handled depends on the transport's
20847 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20848 for the &(appendfile)& transport.
20849
20850
20851
20852 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20853 .cindex "address redirection" "non-filter list items"
20854 When the redirection data is not an Exim or Sieve filter, for example, if it
20855 comes from a conventional alias or forward file, it consists of a list of
20856 addresses, filenames, pipe commands, or certain special items (see section
20857 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20858 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20859 depending on their default values. The items in the list are separated by
20860 commas or newlines.
20861 If a comma is required in an item, the entire item must be enclosed in double
20862 quotes.
20863
20864 Lines starting with a # character are comments, and are ignored, and # may
20865 also appear following a comma, in which case everything between the # and the
20866 next newline character is ignored.
20867
20868 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20869 double quotes are retained because some forms of mail address require their use
20870 (but never to enclose the entire address). In the following description,
20871 &"item"& refers to what remains after any surrounding double quotes have been
20872 removed.
20873
20874 .vindex "&$local_part$&"
20875 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20876 and the expansion contains a reference to &$local_part$&, you should make use
20877 of the &%quote_local_part%& expansion operator, in case the local part contains
20878 special characters. For example, to redirect all mail for the domain
20879 &'obsolete.example'&, retaining the existing local part, you could use this
20880 setting:
20881 .code
20882 data = ${quote_local_part:$local_part}@newdomain.example
20883 .endd
20884
20885
20886 .section "Redirecting to a local mailbox" "SECTredlocmai"
20887 .cindex "routing" "loops in"
20888 .cindex "loop" "while routing, avoidance of"
20889 .cindex "address redirection" "to local mailbox"
20890 A redirection item may safely be the same as the address currently under
20891 consideration. This does not cause a routing loop, because a router is
20892 automatically skipped if any ancestor of the address that is being processed
20893 is the same as the current address and was processed by the current router.
20894 Such an address is therefore passed to the following routers, so it is handled
20895 as if there were no redirection. When making this loop-avoidance test, the
20896 complete local part, including any prefix or suffix, is used.
20897
20898 .cindex "address redirection" "local part without domain"
20899 Specifying the same local part without a domain is a common usage in personal
20900 filter files when the user wants to have messages delivered to the local
20901 mailbox and also forwarded elsewhere. For example, the user whose login is
20902 &'cleo'& might have a &_.forward_& file containing this:
20903 .code
20904 cleo, cleopatra@egypt.example
20905 .endd
20906 .cindex "backslash in alias file"
20907 .cindex "alias file" "backslash in"
20908 For compatibility with other MTAs, such unqualified local parts may be
20909 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20910 it does make a difference if more than one domain is being handled
20911 synonymously.
20912
20913 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20914 2822 address that does not include a domain, the item is qualified using the
20915 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20916 addresses are qualified using the value in &%qualify_recipient%&, but you can
20917 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20918
20919 Care must be taken if there are alias names for local users.
20920 Consider an MTA handling a single local domain where the system alias file
20921 contains:
20922 .code
20923 Sam.Reman: spqr
20924 .endd
20925 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20926 messages in the local mailbox, and also forward copies elsewhere. He creates
20927 this forward file:
20928 .code
20929 Sam.Reman, spqr@reme.elsewhere.example
20930 .endd
20931 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20932 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20933 second time round, because it has previously routed it,
20934 and the following routers presumably cannot handle the alias. The forward file
20935 should really contain
20936 .code
20937 spqr, spqr@reme.elsewhere.example
20938 .endd
20939 but because this is such a common error, the &%check_ancestor%& option (see
20940 below) exists to provide a way to get round it. This is normally set on a
20941 &(redirect)& router that is handling users' &_.forward_& files.
20942
20943
20944
20945 .section "Special items in redirection lists" "SECTspecitredli"
20946 In addition to addresses, the following types of item may appear in redirection
20947 lists (that is, in non-filter redirection data):
20948
20949 .ilist
20950 .cindex "pipe" "in redirection list"
20951 .cindex "address redirection" "to pipe"
20952 An item is treated as a pipe command if it begins with &"|"& and does not parse
20953 as a valid RFC 2822 address that includes a domain. A transport for running the
20954 command must be specified by the &%pipe_transport%& option.
20955 Normally, either the router or the transport specifies a user and a group under
20956 which to run the delivery. The default is to use the Exim user and group.
20957
20958 Single or double quotes can be used for enclosing the individual arguments of
20959 the pipe command; no interpretation of escapes is done for single quotes. If
20960 the command contains a comma character, it is necessary to put the whole item
20961 in double quotes, for example:
20962 .code
20963 "|/some/command ready,steady,go"
20964 .endd
20965 since items in redirection lists are terminated by commas. Do not, however,
20966 quote just the command. An item such as
20967 .code
20968 |"/some/command ready,steady,go"
20969 .endd
20970 is interpreted as a pipe with a rather strange command name, and no arguments.
20971
20972 Note that the above example assumes that the text comes from a lookup source
20973 of some sort, so that the quotes are part of the data.  If composing a
20974 redirect router with a &%data%& option directly specifying this command, the
20975 quotes will be used by the configuration parser to define the extent of one
20976 string, but will not be passed down into the redirect router itself.  There
20977 are two main approaches to get around this: escape quotes to be part of the
20978 data itself, or avoid using this mechanism and instead create a custom
20979 transport with the &%command%& option set and reference that transport from
20980 an &%accept%& router.
20981
20982 .next
20983 .cindex "file" "in redirection list"
20984 .cindex "address redirection" "to file"
20985 An item is interpreted as a path name if it begins with &"/"& and does not
20986 parse as a valid RFC 2822 address that includes a domain. For example,
20987 .code
20988 /home/world/minbari
20989 .endd
20990 is treated as a filename, but
20991 .code
20992 /s=molari/o=babylon/@x400gate.way
20993 .endd
20994 is treated as an address. For a filename, a transport must be specified using
20995 the &%file_transport%& option. However, if the generated path name ends with a
20996 forward slash character, it is interpreted as a directory name rather than a
20997 filename, and &%directory_transport%& is used instead.
20998
20999 Normally, either the router or the transport specifies a user and a group under
21000 which to run the delivery. The default is to use the Exim user and group.
21001
21002 .cindex "&_/dev/null_&"
21003 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21004 bypassed at a high level, and the log entry shows &"**bypassed**"&
21005 instead of a transport name. In this case the user and group are not used.
21006
21007 .next
21008 .cindex "included address list"
21009 .cindex "address redirection" "included external list"
21010 If an item is of the form
21011 .code
21012 :include:<path name>
21013 .endd
21014 a list of further items is taken from the given file and included at that
21015 point. &*Note*&: Such a file can not be a filter file; it is just an
21016 out-of-line addition to the list. The items in the included list are separated
21017 by commas or newlines and are not subject to expansion. If this is the first
21018 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21019 the alias name. This example is incorrect:
21020 .code
21021 list1    :include:/opt/lists/list1
21022 .endd
21023 It must be given as
21024 .code
21025 list1:   :include:/opt/lists/list1
21026 .endd
21027 .new
21028 .cindex "tainted data" "in filenames"
21029 .cindex redirect "tainted data"
21030 Tainted data may not be used for a filename.
21031 .wen
21032 .next
21033 .cindex "address redirection" "to black hole"
21034 .cindex "delivery" "discard"
21035 .cindex "delivery" "blackhole"
21036 .cindex "black hole"
21037 .cindex "abandoning mail"
21038 Sometimes you want to throw away mail to a particular local part.  Making the
21039 &%data%& option expand to an empty string does not work, because that causes
21040 the router to decline. Instead, the alias item
21041 .code
21042 :blackhole:
21043 .endd
21044 can be used. It does what its name implies. No delivery is
21045 done, and no error message is generated. This has the same effect as specifying
21046 &_/dev/null_& as a destination, but it can be independently disabled.
21047
21048 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21049 delivery is done for the original local part, even if other redirection items
21050 are present. If you are generating a multi-item list (for example, by reading a
21051 database) and need the ability to provide a no-op item, you must use
21052 &_/dev/null_&.
21053
21054 .next
21055 .cindex "delivery" "forcing failure"
21056 .cindex "delivery" "forcing deferral"
21057 .cindex "failing delivery" "forcing"
21058 .cindex "deferred delivery, forcing"
21059 .cindex "customizing" "failure message"
21060 An attempt to deliver a particular address can be deferred or forced to fail by
21061 redirection items of the form
21062 .code
21063 :defer:
21064 :fail:
21065 .endd
21066 respectively. When a redirection list contains such an item, it applies
21067 to the entire redirection; any other items in the list are ignored. Any
21068 text following &':fail:'& or &':defer:'& is placed in the error text
21069 associated with the failure. For example, an alias file might contain:
21070 .code
21071 X.Employee:  :fail: Gone away, no forwarding address
21072 .endd
21073 In the case of an address that is being verified from an ACL or as the subject
21074 of a
21075 .cindex "VRFY" "error text, display of"
21076 VRFY command, the text is included in the SMTP error response by
21077 default.
21078 .cindex "EXPN" "error text, display of"
21079 The text is not included in the response to an EXPN command. In non-SMTP cases
21080 the text is included in the error message that Exim generates.
21081
21082 .cindex "SMTP" "error codes"
21083 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21084 &':fail:'&. However, if the message starts with three digits followed by a
21085 space, optionally followed by an extended code of the form &'n.n.n'&, also
21086 followed by a space, and the very first digit is the same as the default error
21087 code, the code from the message is used instead. If the very first digit is
21088 incorrect, a panic error is logged, and the default code is used. You can
21089 suppress the use of the supplied code in a redirect router by setting the
21090 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21091 ignored.
21092
21093 .vindex "&$acl_verify_message$&"
21094 In an ACL, an explicitly provided message overrides the default, but the
21095 default message is available in the variable &$acl_verify_message$& and can
21096 therefore be included in a custom message if this is desired.
21097
21098 Normally the error text is the rest of the redirection list &-- a comma does
21099 not terminate it &-- but a newline does act as a terminator. Newlines are not
21100 normally present in alias expansions. In &(lsearch)& lookups they are removed
21101 as part of the continuation process, but they may exist in other kinds of
21102 lookup and in &':include:'& files.
21103
21104 During routing for message delivery (as opposed to verification), a redirection
21105 containing &':fail:'& causes an immediate failure of the incoming address,
21106 whereas &':defer:'& causes the message to remain in the queue so that a
21107 subsequent delivery attempt can happen at a later time. If an address is
21108 deferred for too long, it will ultimately fail, because the normal retry
21109 rules still apply.
21110
21111 .next
21112 .cindex "alias file" "exception to default"
21113 Sometimes it is useful to use a single-key search type with a default (see
21114 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21115 for exceptions to the default. These can be handled by aliasing them to
21116 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21117 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21118 results in an empty redirection list has the same effect.
21119 .endlist
21120
21121
21122 .section "Duplicate addresses" "SECTdupaddr"
21123 .cindex "duplicate addresses"
21124 .cindex "address duplicate, discarding"
21125 .cindex "pipe" "duplicated"
21126 Exim removes duplicate addresses from the list to which it is delivering, so as
21127 to deliver just one copy to each address. This does not apply to deliveries
21128 routed to pipes by different immediate parent addresses, but an indirect
21129 aliasing scheme of the type
21130 .code
21131 pipe:       |/some/command $local_part
21132 localpart1: pipe
21133 localpart2: pipe
21134 .endd
21135 does not work with a message that is addressed to both local parts, because
21136 when the second is aliased to the intermediate local part &"pipe"& it gets
21137 discarded as being the same as a previously handled address. However, a scheme
21138 such as
21139 .code
21140 localpart1: |/some/command $local_part
21141 localpart2: |/some/command $local_part
21142 .endd
21143 does result in two different pipe deliveries, because the immediate parents of
21144 the pipes are distinct.
21145
21146
21147
21148 .section "Repeated redirection expansion" "SECID128"
21149 .cindex "repeated redirection expansion"
21150 .cindex "address redirection" "repeated for each delivery attempt"
21151 When a message cannot be delivered to all of its recipients immediately,
21152 leading to two or more delivery attempts, redirection expansion is carried out
21153 afresh each time for those addresses whose children were not all previously
21154 delivered. If redirection is being used as a mailing list, this can lead to new
21155 members of the list receiving copies of old messages. The &%one_time%& option
21156 can be used to avoid this.
21157
21158
21159 .section "Errors in redirection lists" "SECID129"
21160 .cindex "address redirection" "errors"
21161 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21162 error is skipped, and an entry is written to the main log. This may be useful
21163 for mailing lists that are automatically managed. Otherwise, if an error is
21164 detected while generating the list of new addresses, the original address is
21165 deferred. See also &%syntax_errors_to%&.
21166
21167
21168
21169 .section "Private options for the redirect router" "SECID130"
21170
21171 .cindex "options" "&(redirect)& router"
21172 The private options for the &(redirect)& router are as follows:
21173
21174
21175 .option allow_defer redirect boolean false
21176 Setting this option allows the use of &':defer:'& in non-filter redirection
21177 data, or the &%defer%& command in an Exim filter file.
21178
21179
21180 .option allow_fail redirect boolean false
21181 .cindex "failing delivery" "from filter"
21182 If this option is true, the &':fail:'& item can be used in a redirection list,
21183 and the &%fail%& command may be used in an Exim filter file.
21184
21185
21186 .option allow_filter redirect boolean false
21187 .cindex "filter" "enabling use of"
21188 .cindex "Sieve filter" "enabling use of"
21189 Setting this option allows Exim to interpret redirection data that starts with
21190 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21191 are some features of Exim filter files that some administrators may wish to
21192 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21193
21194 It is also possible to lock out Exim filters or Sieve filters while allowing
21195 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21196
21197
21198 The filter is run using the uid and gid set by the generic &%user%& and
21199 &%group%& options. These take their defaults from the password data if
21200 &%check_local_user%& is set, so in the normal case of users' personal filter
21201 files, the filter is run as the relevant user. When &%allow_filter%& is set
21202 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21203
21204
21205
21206 .option allow_freeze redirect boolean false
21207 .cindex "freezing messages" "allowing in filter"
21208 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21209 This command is more normally encountered in system filters, and is disabled by
21210 default for redirection filters because it isn't something you usually want to
21211 let ordinary users do.
21212
21213
21214
21215 .option check_ancestor redirect boolean false
21216 This option is concerned with handling generated addresses that are the same
21217 as some address in the list of redirection ancestors of the current address.
21218 Although it is turned off by default in the code, it is set in the default
21219 configuration file for handling users' &_.forward_& files. It is recommended
21220 for this use of the &(redirect)& router.
21221
21222 When &%check_ancestor%& is set, if a generated address (including the domain)
21223 is the same as any ancestor of the current address, it is replaced by a copy of
21224 the current address. This helps in the case where local part A is aliased to B,
21225 and B has a &_.forward_& file pointing back to A. For example, within a single
21226 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21227 &_&~jb/.forward_& contains:
21228 .code
21229 \Joe.Bloggs, <other item(s)>
21230 .endd
21231 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21232 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21233 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21234 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21235 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21236 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21237 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21238 original address. See also the &%repeat_use%& option below.
21239
21240
21241 .option check_group redirect boolean "see below"
21242 When the &%file%& option is used, the group owner of the file is checked only
21243 when this option is set. The permitted groups are those listed in the
21244 &%owngroups%& option, together with the user's default group if
21245 &%check_local_user%& is set. If the file has the wrong group, routing is
21246 deferred. The default setting for this option is true if &%check_local_user%&
21247 is set and the &%modemask%& option permits the group write bit, or if the
21248 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21249
21250
21251
21252 .option check_owner redirect boolean "see below"
21253 When the &%file%& option is used, the owner of the file is checked only when
21254 this option is set. If &%check_local_user%& is set, the local user is
21255 permitted; otherwise the owner must be one of those listed in the &%owners%&
21256 option. The default value for this option is true if &%check_local_user%& or
21257 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21258
21259
21260 .option data redirect string&!! unset
21261 This option is mutually exclusive with &%file%&. One or other of them must be
21262 set, but not both. The contents of &%data%& are expanded, and then used as the
21263 list of forwarding items, or as a set of filtering instructions. If the
21264 expansion is forced to fail, or the result is an empty string or a string that
21265 has no effect (consists entirely of comments), the router declines.
21266
21267 When filtering instructions are used, the string must begin with &"#Exim
21268 filter"&, and all comments in the string, including this initial one, must be
21269 terminated with newline characters. For example:
21270 .code
21271 data = #Exim filter\n\
21272        if $h_to: contains Exim then save $home/mail/exim endif
21273 .endd
21274 If you are reading the data from a database where newlines cannot be included,
21275 you can use the &${sg}$& expansion item to turn the escape string of your
21276 choice into a newline.
21277
21278
21279 .option directory_transport redirect string&!! unset
21280 A &(redirect)& router sets up a direct delivery to a directory when a path name
21281 ending with a slash is specified as a new &"address"&. The transport used is
21282 specified by this option, which, after expansion, must be the name of a
21283 configured transport. This should normally be an &(appendfile)& transport.
21284
21285
21286 .option file redirect string&!! unset
21287 This option specifies the name of a file that contains the redirection data. It
21288 is mutually exclusive with the &%data%& option. The string is expanded before
21289 use; if the expansion is forced to fail, the router declines. Other expansion
21290 failures cause delivery to be deferred. The result of a successful expansion
21291 must be an absolute path. The entire file is read and used as the redirection
21292 data. If the data is an empty string or a string that has no effect (consists
21293 entirely of comments), the router declines.
21294
21295 .cindex "NFS" "checking for file existence"
21296 If the attempt to open the file fails with a &"does not exist"& error, Exim
21297 runs a check on the containing directory,
21298 unless &%ignore_enotdir%& is true (see below).
21299 If the directory does not appear to exist, delivery is deferred. This can
21300 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21301 is a mount problem. If the containing directory does exist, but the file does
21302 not, the router declines.
21303
21304
21305 .option file_transport redirect string&!! unset
21306 .vindex "&$address_file$&"
21307 A &(redirect)& router sets up a direct delivery to a file when a path name not
21308 ending in a slash is specified as a new &"address"&. The transport used is
21309 specified by this option, which, after expansion, must be the name of a
21310 configured transport. This should normally be an &(appendfile)& transport. When
21311 it is running, the filename is in &$address_file$&.
21312
21313
21314 .option filter_prepend_home redirect boolean true
21315 When this option is true, if a &(save)& command in an Exim filter specifies a
21316 relative path, and &$home$& is defined, it is automatically prepended to the
21317 relative path. If this option is set false, this action does not happen. The
21318 relative path is then passed to the transport unmodified.
21319
21320
21321 .option forbid_blackhole redirect boolean false
21322 .cindex "restricting access to features"
21323 .cindex "filter" "locking out certain features"
21324 If this option is true, the &':blackhole:'& item may not appear in a
21325 redirection list.
21326
21327
21328 .option forbid_exim_filter redirect boolean false
21329 .cindex "restricting access to features"
21330 .cindex "filter" "locking out certain features"
21331 If this option is set true, only Sieve filters are permitted when
21332 &%allow_filter%& is true.
21333
21334
21335
21336
21337 .option forbid_file redirect boolean false
21338 .cindex "restricting access to features"
21339 .cindex "delivery" "to file; forbidding"
21340 .cindex "filter" "locking out certain features"
21341 .cindex "Sieve filter" "forbidding delivery to a file"
21342 .cindex "Sieve filter" "&""keep""& facility; disabling"
21343 If this option is true, this router may not generate a new address that
21344 specifies delivery to a local file or directory, either from a filter or from a
21345 conventional forward file. This option is forced to be true if &%one_time%& is
21346 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21347 locks out the Sieve's &"keep"& facility.
21348
21349
21350 .option forbid_filter_dlfunc redirect boolean false
21351 .cindex "restricting access to features"
21352 .cindex "filter" "locking out certain features"
21353 If this option is true, string expansions in Exim filters are not allowed to
21354 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21355 functions.
21356
21357 .option forbid_filter_existstest redirect boolean false
21358 .cindex "restricting access to features"
21359 .cindex "filter" "locking out certain features"
21360 .cindex "expansion" "statting a file"
21361 If this option is true, string expansions in Exim filters are not allowed to
21362 make use of the &%exists%& condition or the &%stat%& expansion item.
21363
21364 .option forbid_filter_logwrite redirect boolean false
21365 .cindex "restricting access to features"
21366 .cindex "filter" "locking out certain features"
21367 If this option is true, use of the logging facility in Exim filters is not
21368 permitted. Logging is in any case available only if the filter is being run
21369 under some unprivileged uid (which is normally the case for ordinary users'
21370 &_.forward_& files).
21371
21372
21373 .option forbid_filter_lookup redirect boolean false
21374 .cindex "restricting access to features"
21375 .cindex "filter" "locking out certain features"
21376 If this option is true, string expansions in Exim filter files are not allowed
21377 to make use of &%lookup%& items.
21378
21379
21380 .option forbid_filter_perl redirect boolean false
21381 .cindex "restricting access to features"
21382 .cindex "filter" "locking out certain features"
21383 This option has an effect only if Exim is built with embedded Perl support. If
21384 it is true, string expansions in Exim filter files are not allowed to make use
21385 of the embedded Perl support.
21386
21387
21388 .option forbid_filter_readfile redirect boolean false
21389 .cindex "restricting access to features"
21390 .cindex "filter" "locking out certain features"
21391 If this option is true, string expansions in Exim filter files are not allowed
21392 to make use of &%readfile%& items.
21393
21394
21395 .option forbid_filter_readsocket redirect boolean false
21396 .cindex "restricting access to features"
21397 .cindex "filter" "locking out certain features"
21398 If this option is true, string expansions in Exim filter files are not allowed
21399 to make use of &%readsocket%& items.
21400
21401
21402 .option forbid_filter_reply redirect boolean false
21403 .cindex "restricting access to features"
21404 .cindex "filter" "locking out certain features"
21405 If this option is true, this router may not generate an automatic reply
21406 message. Automatic replies can be generated only from Exim or Sieve filter
21407 files, not from traditional forward files. This option is forced to be true if
21408 &%one_time%& is set.
21409
21410
21411 .option forbid_filter_run redirect boolean false
21412 .cindex "restricting access to features"
21413 .cindex "filter" "locking out certain features"
21414 If this option is true, string expansions in Exim filter files are not allowed
21415 to make use of &%run%& items.
21416
21417
21418 .option forbid_include redirect boolean false
21419 .cindex "restricting access to features"
21420 .cindex "filter" "locking out certain features"
21421 If this option is true, items of the form
21422 .code
21423 :include:<path name>
21424 .endd
21425 are not permitted in non-filter redirection lists.
21426
21427
21428 .option forbid_pipe redirect boolean false
21429 .cindex "restricting access to features"
21430 .cindex "filter" "locking out certain features"
21431 .cindex "delivery" "to pipe; forbidding"
21432 If this option is true, this router may not generate a new address which
21433 specifies delivery to a pipe, either from an Exim filter or from a conventional
21434 forward file. This option is forced to be true if &%one_time%& is set.
21435
21436
21437 .option forbid_sieve_filter redirect boolean false
21438 .cindex "restricting access to features"
21439 .cindex "filter" "locking out certain features"
21440 If this option is set true, only Exim filters are permitted when
21441 &%allow_filter%& is true.
21442
21443
21444 .cindex "SMTP" "error codes"
21445 .option forbid_smtp_code redirect boolean false
21446 If this option is set true, any SMTP error codes that are present at the start
21447 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21448 the default codes (451 and 550, respectively) are always used.
21449
21450
21451
21452
21453 .option hide_child_in_errmsg redirect boolean false
21454 .cindex "bounce message" "redirection details; suppressing"
21455 If this option is true, it prevents Exim from quoting a child address if it
21456 generates a bounce or delay message for it. Instead it says &"an address
21457 generated from <&'the top level address'&>"&. Of course, this applies only to
21458 bounces generated locally. If a message is forwarded to another host, &'its'&
21459 bounce may well quote the generated address.
21460
21461
21462 .option ignore_eacces redirect boolean false
21463 .cindex "EACCES"
21464 If this option is set and an attempt to open a redirection file yields the
21465 EACCES error (permission denied), the &(redirect)& router behaves as if the
21466 file did not exist.
21467
21468
21469 .option ignore_enotdir redirect boolean false
21470 .cindex "ENOTDIR"
21471 If this option is set and an attempt to open a redirection file yields the
21472 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21473 router behaves as if the file did not exist.
21474
21475 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21476 router that has the &%file%& option set discovers that the file does not exist
21477 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21478 against unmounted NFS directories. If the parent can not be statted, delivery
21479 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21480 is set, because that option tells Exim to ignore &"something on the path is not
21481 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21482 that some operating systems give ENOENT where others give ENOTDIR.
21483
21484
21485
21486 .option include_directory redirect string unset
21487 If this option is set, the path names of any &':include:'& items in a
21488 redirection list must start with this directory.
21489
21490
21491 .option modemask redirect "octal integer" 022
21492 This specifies mode bits which must not be set for a file specified by the
21493 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21494
21495
21496 .option one_time redirect boolean false
21497 .cindex "one-time aliasing/forwarding expansion"
21498 .cindex "alias file" "one-time expansion"
21499 .cindex "forward file" "one-time expansion"
21500 .cindex "mailing lists" "one-time expansion"
21501 .cindex "address redirection" "one-time expansion"
21502 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21503 files each time it tries to deliver a message causes a problem when one or more
21504 of the generated addresses fails be delivered at the first attempt. The problem
21505 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21506 but of what happens when the redirection list changes during the time that the
21507 message is on Exim's queue. This is particularly true in the case of mailing
21508 lists, where new subscribers might receive copies of messages that were posted
21509 before they subscribed.
21510
21511 If &%one_time%& is set and any addresses generated by the router fail to
21512 deliver at the first attempt, the failing addresses are added to the message as
21513 &"top level"& addresses, and the parent address that generated them is marked
21514 &"delivered"&. Thus, redirection does not happen again at the next delivery
21515 attempt.
21516
21517 &*Warning 1*&: Any header line addition or removal that is specified by this
21518 router would be lost if delivery did not succeed at the first attempt. For this
21519 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21520 permitted when &%one_time%& is set.
21521
21522 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21523 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21524 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21525
21526 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21527 &%one_time%&.
21528
21529 The original top-level address is remembered with each of the generated
21530 addresses, and is output in any log messages. However, any intermediate parent
21531 addresses are not recorded. This makes a difference to the log only if
21532 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21533 typically be used for mailing lists, where there is normally just one level of
21534 expansion.
21535
21536
21537 .option owners redirect "string list" unset
21538 .cindex "ownership" "alias file"
21539 .cindex "ownership" "forward file"
21540 .cindex "alias file" "ownership"
21541 .cindex "forward file" "ownership"
21542 This specifies a list of permitted owners for the file specified by &%file%&.
21543 This list is in addition to the local user when &%check_local_user%& is set.
21544 See &%check_owner%& above.
21545
21546
21547 .option owngroups redirect "string list" unset
21548 This specifies a list of permitted groups for the file specified by &%file%&.
21549 The list is in addition to the local user's primary group when
21550 &%check_local_user%& is set. See &%check_group%& above.
21551
21552
21553 .option pipe_transport redirect string&!! unset
21554 .vindex "&$address_pipe$&"
21555 A &(redirect)& router sets up a direct delivery to a pipe when a string
21556 starting with a vertical bar character is specified as a new &"address"&. The
21557 transport used is specified by this option, which, after expansion, must be the
21558 name of a configured transport. This should normally be a &(pipe)& transport.
21559 When the transport is run, the pipe command is in &$address_pipe$&.
21560
21561
21562 .option qualify_domain redirect string&!! unset
21563 .vindex "&$qualify_recipient$&"
21564 If this option is set, and an unqualified address (one without a domain) is
21565 generated, and that address would normally be qualified by the global setting
21566 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21567 expanding this string. If the expansion fails, the router declines. If you want
21568 to revert to the default, you can have the expansion generate
21569 &$qualify_recipient$&.
21570
21571 This option applies to all unqualified addresses generated by Exim filters,
21572 but for traditional &_.forward_& files, it applies only to addresses that are
21573 not preceded by a backslash. Sieve filters cannot generate unqualified
21574 addresses.
21575
21576 .option qualify_preserve_domain redirect boolean false
21577 .cindex "domain" "in redirection; preserving"
21578 .cindex "preserving domain in redirection"
21579 .cindex "address redirection" "domain; preserving"
21580 If this option is set, the router's local &%qualify_domain%& option must not be
21581 set (a configuration error occurs if it is). If an unqualified address (one
21582 without a domain) is generated, it is qualified with the domain of the parent
21583 address (the immediately preceding ancestor) instead of the global
21584 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21585 this applies whether or not the address is preceded by a backslash.
21586
21587
21588 .option repeat_use redirect boolean true
21589 If this option is set false, the router is skipped for a child address that has
21590 any ancestor that was routed by this router. This test happens before any of
21591 the other preconditions are tested. Exim's default anti-looping rules skip
21592 only when the ancestor is the same as the current address. See also
21593 &%check_ancestor%& above and the generic &%redirect_router%& option.
21594
21595
21596 .option reply_transport redirect string&!! unset
21597 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21598 &%vacation%& command is used in a filter file. The transport used is specified
21599 by this option, which, after expansion, must be the name of a configured
21600 transport. This should normally be an &(autoreply)& transport. Other transports
21601 are unlikely to do anything sensible or useful.
21602
21603
21604 .option rewrite redirect boolean true
21605 .cindex "address redirection" "disabling rewriting"
21606 If this option is set false, addresses generated by the router are not
21607 subject to address rewriting. Otherwise, they are treated like new addresses
21608 and are rewritten according to the global rewriting rules.
21609
21610
21611 .option sieve_subaddress redirect string&!! unset
21612 The value of this option is passed to a Sieve filter to specify the
21613 :subaddress part of an address.
21614
21615 .option sieve_useraddress redirect string&!! unset
21616 The value of this option is passed to a Sieve filter to specify the :user part
21617 of an address. However, if it is unset, the entire original local part
21618 (including any prefix or suffix) is used for :user.
21619
21620
21621 .option sieve_vacation_directory redirect string&!! unset
21622 .cindex "Sieve filter" "vacation directory"
21623 To enable the &"vacation"& extension for Sieve filters, you must set
21624 &%sieve_vacation_directory%& to the directory where vacation databases are held
21625 (do not put anything else in that directory), and ensure that the
21626 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21627 needs their own directory; Exim will create it if necessary.
21628
21629
21630
21631 .option skip_syntax_errors redirect boolean false
21632 .cindex "forward file" "broken"
21633 .cindex "address redirection" "broken files"
21634 .cindex "alias file" "broken"
21635 .cindex "broken alias or forward files"
21636 .cindex "ignoring faulty addresses"
21637 .cindex "skipping faulty addresses"
21638 .cindex "error" "skipping bad syntax"
21639 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21640 non-filter redirection data are skipped, and each failing address is logged. If
21641 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21642 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21643 are expanded and placed at the head of the error message generated by
21644 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21645 be the same address as the generic &%errors_to%& option. The
21646 &%skip_syntax_errors%& option is often used when handling mailing lists.
21647
21648 If all the addresses in a redirection list are skipped because of syntax
21649 errors, the router declines to handle the original address, and it is passed to
21650 the following routers.
21651
21652 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21653 error in the filter causes filtering to be abandoned without any action being
21654 taken. The incident is logged, and the router declines to handle the address,
21655 so it is passed to the following routers.
21656
21657 .cindex "Sieve filter" "syntax errors in"
21658 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21659 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21660 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21661
21662 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21663 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21664 option, used with an address that does not get redirected, can be used to
21665 notify users of these errors, by means of a router like this:
21666 .code
21667 userforward:
21668   driver = redirect
21669   allow_filter
21670   check_local_user
21671   file = $home/.forward
21672   file_transport = address_file
21673   pipe_transport = address_pipe
21674   reply_transport = address_reply
21675   no_verify
21676   skip_syntax_errors
21677   syntax_errors_to = real-$local_part@$domain
21678   syntax_errors_text = \
21679    This is an automatically generated message. An error has\n\
21680    been found in your .forward file. Details of the error are\n\
21681    reported below. While this error persists, you will receive\n\
21682    a copy of this message for every message that is addressed\n\
21683    to you. If your .forward file is a filter file, or if it is\n\
21684    a non-filter file containing no valid forwarding addresses,\n\
21685    a copy of each incoming message will be put in your normal\n\
21686    mailbox. If a non-filter file contains at least one valid\n\
21687    forwarding address, forwarding to the valid addresses will\n\
21688    happen, and those will be the only deliveries that occur.
21689 .endd
21690 You also need a router to ensure that local addresses that are prefixed by
21691 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21692 put this immediately before the &(userforward)& router:
21693 .code
21694 real_localuser:
21695   driver = accept
21696   check_local_user
21697   local_part_prefix = real-
21698   transport = local_delivery
21699 .endd
21700 For security, it would probably be a good idea to restrict the use of this
21701 router to locally-generated messages, using a condition such as this:
21702 .code
21703   condition = ${if match {$sender_host_address}\
21704                          {\N^(|127\.0\.0\.1)$\N}}
21705 .endd
21706
21707
21708 .option syntax_errors_text redirect string&!! unset
21709 See &%skip_syntax_errors%& above.
21710
21711
21712 .option syntax_errors_to redirect string unset
21713 See &%skip_syntax_errors%& above.
21714 .ecindex IIDredrou1
21715 .ecindex IIDredrou2
21716
21717
21718
21719
21720
21721
21722 . ////////////////////////////////////////////////////////////////////////////
21723 . ////////////////////////////////////////////////////////////////////////////
21724
21725 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21726          "Environment for local transports"
21727 .scindex IIDenvlotra1 "local transports" "environment for"
21728 .scindex IIDenvlotra2 "environment" "local transports"
21729 .scindex IIDenvlotra3 "transport" "local; environment for"
21730 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21731 transport can be thought of as similar to a pipe.) Exim always runs transports
21732 in subprocesses, under specified uids and gids. Typical deliveries to local
21733 mailboxes run under the uid and gid of the local user.
21734
21735 Exim also sets a specific current directory while running the transport; for
21736 some transports a home directory setting is also relevant. The &(pipe)&
21737 transport is the only one that sets up environment variables; see section
21738 &<<SECTpipeenv>>& for details.
21739
21740 The values used for the uid, gid, and the directories may come from several
21741 different places. In many cases, the router that handles the address associates
21742 settings with that address as a result of its &%check_local_user%&, &%group%&,
21743 or &%user%& options. However, values may also be given in the transport's own
21744 configuration, and these override anything that comes from the router.
21745
21746
21747
21748 .section "Concurrent deliveries" "SECID131"
21749 .cindex "concurrent deliveries"
21750 .cindex "simultaneous deliveries"
21751 If two different messages for the same local recipient arrive more or less
21752 simultaneously, the two delivery processes are likely to run concurrently. When
21753 the &(appendfile)& transport is used to write to a file, Exim applies locking
21754 rules to stop concurrent processes from writing to the same file at the same
21755 time.
21756
21757 However, when you use a &(pipe)& transport, it is up to you to arrange any
21758 locking that is needed. Here is a silly example:
21759 .code
21760 my_transport:
21761   driver = pipe
21762   command = /bin/sh -c 'cat >>/some/file'
21763 .endd
21764 This is supposed to write the message at the end of the file. However, if two
21765 messages arrive at the same time, the file will be scrambled. You can use the
21766 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21767 file using the same algorithm that Exim itself uses.
21768
21769
21770
21771
21772 .section "Uids and gids" "SECTenvuidgid"
21773 .cindex "local transports" "uid and gid"
21774 .cindex "transport" "local; uid and gid"
21775 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21776 overrides any group that the router set in the address, even if &%user%& is not
21777 set for the transport. This makes it possible, for example, to run local mail
21778 delivery under the uid of the recipient (set by the router), but in a special
21779 group (set by the transport). For example:
21780 .code
21781 # Routers ...
21782 # User/group are set by check_local_user in this router
21783 local_users:
21784   driver = accept
21785   check_local_user
21786   transport = group_delivery
21787
21788 # Transports ...
21789 # This transport overrides the group
21790 group_delivery:
21791   driver = appendfile
21792   file = /var/spool/mail/$local_part
21793   group = mail
21794 .endd
21795 If &%user%& is set for a transport, its value overrides what is set in the
21796 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21797 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21798 set.
21799
21800 .oindex "&%initgroups%&"
21801 When the uid is taken from the transport's configuration, the &[initgroups()]&
21802 function is called for the groups associated with that uid if the
21803 &%initgroups%& option is set for the transport. When the uid is not specified
21804 by the transport, but is associated with the address by a router, the option
21805 for calling &[initgroups()]& is taken from the router configuration.
21806
21807 .cindex "&(pipe)& transport" "uid for"
21808 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21809 is set and &%user%& is not set, the uid of the process that called Exim to
21810 receive the message is used, and if &%group%& is not set, the corresponding
21811 original gid is also used.
21812
21813 This is the detailed preference order for obtaining a gid; the first of the
21814 following that is set is used:
21815
21816 .ilist
21817 A &%group%& setting of the transport;
21818 .next
21819 A &%group%& setting of the router;
21820 .next
21821 A gid associated with a user setting of the router, either as a result of
21822 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21823 .next
21824 The group associated with a non-numeric &%user%& setting of the transport;
21825 .next
21826 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21827 the uid is the creator's uid;
21828 .next
21829 The Exim gid if the Exim uid is being used as a default.
21830 .endlist
21831
21832 If, for example, the user is specified numerically on the router and there are
21833 no group settings, no gid is available. In this situation, an error occurs.
21834 This is different for the uid, for which there always is an ultimate default.
21835 The first of the following that is set is used:
21836
21837 .ilist
21838 A &%user%& setting of the transport;
21839 .next
21840 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21841 .next
21842 A &%user%& setting of the router;
21843 .next
21844 A &%check_local_user%& setting of the router;
21845 .next
21846 The Exim uid.
21847 .endlist
21848
21849 Of course, an error will still occur if the uid that is chosen is on the
21850 &%never_users%& list.
21851
21852
21853
21854
21855
21856 .section "Current and home directories" "SECID132"
21857 .cindex "current directory for local transport"
21858 .cindex "home directory" "for local transport"
21859 .cindex "transport" "local; home directory for"
21860 .cindex "transport" "local; current directory for"
21861 Routers may set current and home directories for local transports by means of
21862 the &%transport_current_directory%& and &%transport_home_directory%& options.
21863 However, if the transport's &%current_directory%& or &%home_directory%& options
21864 are set, they override the router's values. In detail, the home directory
21865 for a local transport is taken from the first of these values that is set:
21866
21867 .ilist
21868 The &%home_directory%& option on the transport;
21869 .next
21870 The &%transport_home_directory%& option on the router;
21871 .next
21872 The password data if &%check_local_user%& is set on the router;
21873 .next
21874 The &%router_home_directory%& option on the router.
21875 .endlist
21876
21877 The current directory is taken from the first of these values that is set:
21878
21879 .ilist
21880 The &%current_directory%& option on the transport;
21881 .next
21882 The &%transport_current_directory%& option on the router.
21883 .endlist
21884
21885
21886 If neither the router nor the transport sets a current directory, Exim uses the
21887 value of the home directory, if it is set. Otherwise it sets the current
21888 directory to &_/_& before running a local transport.
21889
21890
21891
21892 .section "Expansion variables derived from the address" "SECID133"
21893 .vindex "&$domain$&"
21894 .vindex "&$local_part$&"
21895 .vindex "&$original_domain$&"
21896 Normally a local delivery is handling a single address, and in that case the
21897 variables such as &$domain$& and &$local_part$& are set during local
21898 deliveries. However, in some circumstances more than one address may be handled
21899 at once (for example, while writing batch SMTP for onward transmission by some
21900 other means). In this case, the variables associated with the local part are
21901 never set, &$domain$& is set only if all the addresses have the same domain,
21902 and &$original_domain$& is never set.
21903 .ecindex IIDenvlotra1
21904 .ecindex IIDenvlotra2
21905 .ecindex IIDenvlotra3
21906
21907
21908
21909
21910
21911
21912
21913 . ////////////////////////////////////////////////////////////////////////////
21914 . ////////////////////////////////////////////////////////////////////////////
21915
21916 .chapter "Generic options for transports" "CHAPtransportgeneric"
21917 .scindex IIDgenoptra1 "generic options" "transport"
21918 .scindex IIDgenoptra2 "options" "generic; for transports"
21919 .scindex IIDgenoptra3 "transport" "generic options for"
21920 The following generic options apply to all transports:
21921
21922
21923 .option body_only transports boolean false
21924 .cindex "transport" "body only"
21925 .cindex "message" "transporting body only"
21926 .cindex "body of message" "transporting"
21927 If this option is set, the message's headers are not transported. It is
21928 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21929 or &(pipe)& transports, the settings of &%message_prefix%& and
21930 &%message_suffix%& should be checked, because this option does not
21931 automatically suppress them.
21932
21933
21934 .option current_directory transports string&!! unset
21935 .cindex "transport" "current directory for"
21936 This specifies the current directory that is to be set while running the
21937 transport, overriding any value that may have been set by the router.
21938 If the expansion fails for any reason, including forced failure, an error is
21939 logged, and delivery is deferred.
21940
21941
21942 .option disable_logging transports boolean false
21943 If this option is set true, nothing is logged for any
21944 deliveries by the transport or for any
21945 transport errors. You should not set this option unless you really, really know
21946 what you are doing.
21947
21948
21949 .option debug_print transports string&!! unset
21950 .cindex "testing" "variables in drivers"
21951 If this option is set and debugging is enabled (see the &%-d%& command line
21952 option), the string is expanded and included in the debugging output when the
21953 transport is run.
21954 If expansion of the string fails, the error message is written to the debugging
21955 output, and Exim carries on processing.
21956 This facility is provided to help with checking out the values of variables and
21957 so on when debugging driver configurations. For example, if a &%headers_add%&
21958 option is not working properly, &%debug_print%& could be used to output the
21959 variables it references. A newline is added to the text if it does not end with
21960 one.
21961 The variables &$transport_name$& and &$router_name$& contain the name of the
21962 transport and the router that called it.
21963
21964 .option delivery_date_add transports boolean false
21965 .cindex "&'Delivery-date:'& header line"
21966 If this option is true, a &'Delivery-date:'& header is added to the message.
21967 This gives the actual time the delivery was made. As this is not a standard
21968 header, Exim has a configuration option (&%delivery_date_remove%&) which
21969 requests its removal from incoming messages, so that delivered messages can
21970 safely be resent to other recipients.
21971
21972
21973 .option driver transports string unset
21974 This specifies which of the available transport drivers is to be used.
21975 There is no default, and this option must be set for every transport.
21976
21977
21978 .option envelope_to_add transports boolean false
21979 .cindex "&'Envelope-to:'& header line"
21980 If this option is true, an &'Envelope-to:'& header is added to the message.
21981 This gives the original address(es) in the incoming envelope that caused this
21982 delivery to happen. More than one address may be present if the transport is
21983 configured to handle several addresses at once, or if more than one original
21984 address was redirected to the same final address. As this is not a standard
21985 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21986 its removal from incoming messages, so that delivered messages can safely be
21987 resent to other recipients.
21988
21989
21990 .option event_action transports string&!! unset
21991 .cindex events
21992 This option declares a string to be expanded for Exim's events mechanism.
21993 For details see chapter &<<CHAPevents>>&.
21994
21995
21996 .option group transports string&!! "Exim group"
21997 .cindex "transport" "group; specifying"
21998 This option specifies a gid for running the transport process, overriding any
21999 value that the router supplies, and also overriding any value associated with
22000 &%user%& (see below).
22001
22002
22003 .option headers_add transports list&!! unset
22004 .cindex "header lines" "adding in transport"
22005 .cindex "transport" "header lines; adding"
22006 This option specifies a list of text headers,
22007 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22008 which are (separately) expanded and added to the header
22009 portion of a message as it is transported, as described in section
22010 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22011 routers. If the result of the expansion is an empty string, or if the expansion
22012 is forced to fail, no action is taken. Other expansion failures are treated as
22013 errors and cause the delivery to be deferred.
22014
22015 Unlike most options, &%headers_add%& can be specified multiple times
22016 for a transport; all listed headers are added.
22017
22018
22019 .option headers_only transports boolean false
22020 .cindex "transport" "header lines only"
22021 .cindex "message" "transporting headers only"
22022 .cindex "header lines" "transporting"
22023 If this option is set, the message's body is not transported. It is mutually
22024 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22025 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22026 checked, since this option does not automatically suppress them.
22027
22028
22029 .option headers_remove transports list&!! unset
22030 .cindex "header lines" "removing"
22031 .cindex "transport" "header lines; removing"
22032 This option specifies a list of text headers,
22033 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22034 to be removed from the message.
22035 However, the option has no effect when an address is just being verified.
22036 Each list item is separately expanded.
22037 If the result of the expansion is an empty string, or if the expansion
22038 is forced to fail, no action is taken. Other expansion failures are treated as
22039 errors and cause the delivery to be deferred.
22040 .new
22041 If an item ends in *, it will match any header with the given prefix.
22042 .wen
22043
22044 Matching headers are omitted from the message as it is transported, as described
22045 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22046 routers.
22047
22048 Unlike most options, &%headers_remove%& can be specified multiple times
22049 for a transport; all listed headers are removed.
22050
22051 &*Warning*&: Because of the separate expansion of the list items,
22052 items that contain a list separator must have it doubled.
22053 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22054
22055
22056
22057 .option headers_rewrite transports string unset
22058 .cindex "transport" "header lines; rewriting"
22059 .cindex "rewriting" "at transport time"
22060 This option allows addresses in header lines to be rewritten at transport time,
22061 that is, as the message is being copied to its destination. The contents of the
22062 option are a colon-separated list of rewriting rules. Each rule is in exactly
22063 the same form as one of the general rewriting rules that are applied when a
22064 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22065 example,
22066 .code
22067 headers_rewrite = a@b c@d f : \
22068                   x@y w@z
22069 .endd
22070 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22071 &'w@z'& in all address-bearing header lines. The rules are applied to the
22072 header lines just before they are written out at transport time, so they affect
22073 only those copies of the message that pass through the transport. However, only
22074 the message's original header lines, and any that were added by a system
22075 filter, are rewritten. If a router or transport adds header lines, they are not
22076 affected by this option. These rewriting rules are &'not'& applied to the
22077 envelope. You can change the return path using &%return_path%&, but you cannot
22078 change envelope recipients at this time.
22079
22080
22081 .option home_directory transports string&!! unset
22082 .cindex "transport" "home directory for"
22083 .vindex "&$home$&"
22084 This option specifies a home directory setting for a local transport,
22085 overriding any value that may be set by the router. The home directory is
22086 placed in &$home$& while expanding the transport's private options. It is also
22087 used as the current directory if no current directory is set by the
22088 &%current_directory%& option on the transport or the
22089 &%transport_current_directory%& option on the router. If the expansion fails
22090 for any reason, including forced failure, an error is logged, and delivery is
22091 deferred.
22092
22093
22094 .option initgroups transports boolean false
22095 .cindex "additional groups"
22096 .cindex "groups" "additional"
22097 .cindex "transport" "group; additional"
22098 If this option is true and the uid for the delivery process is provided by the
22099 transport, the &[initgroups()]& function is called when running the transport
22100 to ensure that any additional groups associated with the uid are set up.
22101
22102
22103 .option max_parallel transports integer&!! unset
22104 .cindex limit "transport parallelism"
22105 .cindex transport "parallel processes"
22106 .cindex transport "concurrency limit"
22107 .cindex "delivery" "parallelism for transport"
22108 If this option is set and expands to an integer greater than zero
22109 it limits the number of concurrent runs of the transport.
22110 The control does not apply to shadow transports.
22111
22112 .cindex "hints database" "transport concurrency control"
22113 Exim implements this control by means of a hints database in which a record is
22114 incremented whenever a transport process is being created. The record
22115 is decremented and possibly removed when the process terminates.
22116 Obviously there is scope for
22117 records to get left lying around if there is a system or program crash. To
22118 guard against this, Exim ignores any records that are more than six hours old.
22119
22120 If you use this option, you should also arrange to delete the
22121 relevant hints database whenever your system reboots. The names of the files
22122 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22123 may be one or two files, depending on the type of DBM in use. The same files
22124 are used for ETRN and smtp transport serialization.
22125
22126
22127 .option message_size_limit transports string&!! 0
22128 .cindex "limit" "message size per transport"
22129 .cindex "size" "of message, limit"
22130 .cindex "transport" "message size; limiting"
22131 This option controls the size of messages passed through the transport. It is
22132 expanded before use; the result of the expansion must be a sequence of decimal
22133 digits, optionally followed by K or M. If the expansion fails for any reason,
22134 including forced failure, or if the result is not of the required form,
22135 delivery is deferred. If the value is greater than zero and the size of a
22136 message exceeds this limit, the address is failed. If there is any chance that
22137 the resulting bounce message could be routed to the same transport, you should
22138 ensure that &%return_size_limit%& is less than the transport's
22139 &%message_size_limit%&, as otherwise the bounce message will fail to get
22140 delivered.
22141
22142
22143
22144 .option rcpt_include_affixes transports boolean false
22145 .cindex "prefix" "for local part, including in envelope"
22146 .cindex "suffix for local part" "including in envelope"
22147 .cindex "local part" "prefix"
22148 .cindex "local part" "suffix"
22149 When this option is false (the default), and an address that has had any
22150 affixes (prefixes or suffixes) removed from the local part is delivered by any
22151 form of SMTP or LMTP, the affixes are not included. For example, if a router
22152 that contains
22153 .code
22154 local_part_prefix = *-
22155 .endd
22156 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22157 is delivered with
22158 .code
22159 RCPT TO:<xyz@some.domain>
22160 .endd
22161 This is also the case when an ACL-time callout is being used to verify a
22162 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22163 whole local part is included in the RCPT command. This option applies to BSMTP
22164 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22165 &(lmtp)& and &(smtp)& transports.
22166
22167
22168 .option retry_use_local_part transports boolean "see below"
22169 .cindex "hints database" "retry keys"
22170 When a delivery suffers a temporary failure, a retry record is created
22171 in Exim's hints database. For remote deliveries, the key for the retry record
22172 is based on the name and/or IP address of the failing remote host. For local
22173 deliveries, the key is normally the entire address, including both the local
22174 part and the domain. This is suitable for most common cases of local delivery
22175 temporary failure &-- for example, exceeding a mailbox quota should delay only
22176 deliveries to that mailbox, not to the whole domain.
22177
22178 However, in some special cases you may want to treat a temporary local delivery
22179 as a failure associated with the domain, and not with a particular local part.
22180 (For example, if you are storing all mail for some domain in files.) You can do
22181 this by setting &%retry_use_local_part%& false.
22182
22183 For all the local transports, its default value is true. For remote transports,
22184 the default value is false for tidiness, but changing the value has no effect
22185 on a remote transport in the current implementation.
22186
22187
22188 .option return_path transports string&!! unset
22189 .cindex "envelope sender"
22190 .cindex "envelope from"
22191 .cindex "transport" "return path; changing"
22192 .cindex "return path" "changing in transport"
22193 If this option is set, the string is expanded at transport time and replaces
22194 the existing return path (envelope sender) value in the copy of the message
22195 that is being delivered. An empty return path is permitted. This feature is
22196 designed for remote deliveries, where the value of this option is used in the
22197 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22198 only effect is to change the address that is placed in the &'Return-path:'&
22199 header line, if one is added to the message (see the next option).
22200
22201 &*Note:*& A changed return path is not logged unless you add
22202 &%return_path_on_delivery%& to the log selector.
22203
22204 .vindex "&$return_path$&"
22205 The expansion can refer to the existing value via &$return_path$&. This is
22206 either the message's envelope sender, or an address set by the
22207 &%errors_to%& option on a router. If the expansion is forced to fail, no
22208 replacement occurs; if it fails for another reason, delivery is deferred. This
22209 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22210 section &<<SECTverp>>&.
22211
22212 &*Note*&: If a delivery error is detected locally, including the case when a
22213 remote server rejects a message at SMTP time, the bounce message is not sent to
22214 the value of this option. It is sent to the previously set errors address.
22215 This defaults to the incoming sender address, but can be changed by setting
22216 &%errors_to%& in a router.
22217
22218
22219
22220 .option return_path_add transports boolean false
22221 .cindex "&'Return-path:'& header line"
22222 If this option is true, a &'Return-path:'& header is added to the message.
22223 Although the return path is normally available in the prefix line of BSD
22224 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22225 have easy access to it.
22226
22227 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22228 the delivery SMTP server makes the final delivery"&. This implies that this
22229 header should not be present in incoming messages. Exim has a configuration
22230 option, &%return_path_remove%&, which requests removal of this header from
22231 incoming messages, so that delivered messages can safely be resent to other
22232 recipients.
22233
22234
22235 .option shadow_condition transports string&!! unset
22236 See &%shadow_transport%& below.
22237
22238
22239 .option shadow_transport transports string unset
22240 .cindex "shadow transport"
22241 .cindex "transport" "shadow"
22242 A local transport may set the &%shadow_transport%& option to the name of
22243 another local transport. Shadow remote transports are not supported.
22244
22245 Whenever a delivery to the main transport succeeds, and either
22246 &%shadow_condition%& is unset, or its expansion does not result in the empty
22247 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22248 passed to the shadow transport, with the same delivery address or addresses. If
22249 expansion fails, no action is taken except that non-forced expansion failures
22250 cause a log line to be written.
22251
22252 The result of the shadow transport is discarded and does not affect the
22253 subsequent processing of the message. Only a single level of shadowing is
22254 provided; the &%shadow_transport%& option is ignored on any transport when it
22255 is running as a shadow. Options concerned with output from pipes are also
22256 ignored. The log line for the successful delivery has an item added on the end,
22257 of the form
22258 .code
22259 ST=<shadow transport name>
22260 .endd
22261 If the shadow transport did not succeed, the error message is put in
22262 parentheses afterwards. Shadow transports can be used for a number of different
22263 purposes, including keeping more detailed log information than Exim normally
22264 provides, and implementing automatic acknowledgment policies based on message
22265 headers that some sites insist on.
22266
22267
22268 .option transport_filter transports string&!! unset
22269 .cindex "transport" "filter"
22270 .cindex "filter" "transport filter"
22271 This option sets up a filtering (in the Unix shell sense) process for messages
22272 at transport time. It should not be confused with mail filtering as set up by
22273 individual users or via a system filter.
22274 If unset, or expanding to an empty string, no filtering is done.
22275
22276 When the message is about to be written out, the command specified by
22277 &%transport_filter%& is started up in a separate, parallel process, and
22278 the entire message, including the header lines, is passed to it on its standard
22279 input (this in fact is done from a third process, to avoid deadlock). The
22280 command must be specified as an absolute path.
22281
22282 The lines of the message that are written to the transport filter are
22283 terminated by newline (&"\n"&). The message is passed to the filter before any
22284 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22285 lines beginning with a dot, and also before any processing implied by the
22286 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22287 &(pipe)& transports.
22288
22289 The standard error for the filter process is set to the same destination as its
22290 standard output; this is read and written to the message's ultimate
22291 destination. The process that writes the message to the filter, the
22292 filter itself, and the original process that reads the result and delivers it
22293 are all run in parallel, like a shell pipeline.
22294
22295 The filter can perform any transformations it likes, but of course should take
22296 care not to break RFC 2822 syntax. Exim does not check the result, except to
22297 test for a final newline when SMTP is in use. All messages transmitted over
22298 SMTP must end with a newline, so Exim supplies one if it is missing.
22299
22300 .cindex "content scanning" "per user"
22301 A transport filter can be used to provide content-scanning on a per-user basis
22302 at delivery time if the only required effect of the scan is to modify the
22303 message. For example, a content scan could insert a new header line containing
22304 a spam score. This could be interpreted by a filter in the user's MUA. It is
22305 not possible to discard a message at this stage.
22306
22307 .cindex "SMTP" "SIZE"
22308 A problem might arise if the filter increases the size of a message that is
22309 being sent down an SMTP connection. If the receiving SMTP server has indicated
22310 support for the SIZE parameter, Exim will have sent the size of the message
22311 at the start of the SMTP session. If what is actually sent is substantially
22312 more, the server might reject the message. This can be worked round by setting
22313 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22314 additions to the message, or to disable the use of SIZE altogether.
22315
22316 .vindex "&$pipe_addresses$&"
22317 The value of the &%transport_filter%& option is the command string for starting
22318 the filter, which is run directly from Exim, not under a shell. The string is
22319 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22320 Exim breaks it up into arguments and then expands each argument separately (see
22321 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22322 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22323 of arguments, one for each address that applies to this delivery. (This isn't
22324 an ideal name for this feature here, but as it was already implemented for the
22325 &(pipe)& transport, it seemed sensible not to change it.)
22326
22327 .vindex "&$host$&"
22328 .vindex "&$host_address$&"
22329 The expansion variables &$host$& and &$host_address$& are available when the
22330 transport is a remote one. They contain the name and IP address of the host to
22331 which the message is being sent. For example:
22332 .code
22333 transport_filter = /some/directory/transport-filter.pl \
22334   $host $host_address $sender_address $pipe_addresses
22335 .endd
22336
22337 Two problems arise if you want to use more complicated expansion items to
22338 generate transport filter commands, both of which due to the fact that the
22339 command is split up &'before'& expansion.
22340 .ilist
22341 If an expansion item contains white space, you must quote it, so that it is all
22342 part of the same command item. If the entire option setting is one such
22343 expansion item, you have to take care what kind of quoting you use. For
22344 example:
22345 .code
22346 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22347 .endd
22348 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22349 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22350 stripped by Exim when it read the option's value. When the value is used, if
22351 the single quotes were missing, the line would be split into two items,
22352 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22353 Exim tried to expand the first one.
22354 .next
22355 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22356 expansion cannot generate multiple arguments, or a command name followed by
22357 arguments. Consider this example:
22358 .code
22359 transport_filter = ${lookup{$host}lsearch{/a/file}\
22360                     {$value}{/bin/cat}}
22361 .endd
22362 The result of the lookup is interpreted as the name of the command, even
22363 if it contains white space. The simplest way round this is to use a shell:
22364 .code
22365 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22366                                {$value}{/bin/cat}}
22367 .endd
22368 .endlist
22369
22370 The filter process is run under the same uid and gid as the normal delivery.
22371 For remote deliveries this is the Exim uid/gid by default. The command should
22372 normally yield a zero return code. Transport filters are not supposed to fail.
22373 A non-zero code is taken to mean that the transport filter encountered some
22374 serious problem. Delivery of the message is deferred; the message remains on
22375 the queue and is tried again later. It is not possible to cause a message to be
22376 bounced from a transport filter.
22377
22378 If a transport filter is set on an autoreply transport, the original message is
22379 passed through the filter as it is being copied into the newly generated
22380 message, which happens if the &%return_message%& option is set.
22381
22382
22383 .option transport_filter_timeout transports time 5m
22384 .cindex "transport" "filter, timeout"
22385 When Exim is reading the output of a transport filter, it applies a timeout
22386 that can be set by this option. Exceeding the timeout is normally treated as a
22387 temporary delivery failure. However, if a transport filter is used with a
22388 &(pipe)& transport, a timeout in the transport filter is treated in the same
22389 way as a timeout in the pipe command itself. By default, a timeout is a hard
22390 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22391 becomes a temporary error.
22392
22393
22394 .option user transports string&!! "Exim user"
22395 .cindex "uid (user id)" "local delivery"
22396 .cindex "transport" "user, specifying"
22397 This option specifies the user under whose uid the delivery process is to be
22398 run, overriding any uid that may have been set by the router. If the user is
22399 given as a name, the uid is looked up from the password data, and the
22400 associated group is taken as the value of the gid to be used if the &%group%&
22401 option is not set.
22402
22403 For deliveries that use local transports, a user and group are normally
22404 specified explicitly or implicitly (for example, as a result of
22405 &%check_local_user%&) by the router or transport.
22406
22407 .cindex "hints database" "access by remote transport"
22408 For remote transports, you should leave this option unset unless you really are
22409 sure you know what you are doing. When a remote transport is running, it needs
22410 to be able to access Exim's hints databases, because each host may have its own
22411 retry data.
22412 .ecindex IIDgenoptra1
22413 .ecindex IIDgenoptra2
22414 .ecindex IIDgenoptra3
22415
22416
22417
22418
22419
22420
22421 . ////////////////////////////////////////////////////////////////////////////
22422 . ////////////////////////////////////////////////////////////////////////////
22423
22424 .chapter "Address batching in local transports" "CHAPbatching" &&&
22425          "Address batching"
22426 .cindex "transport" "local; address batching in"
22427 The only remote transport (&(smtp)&) is normally configured to handle more than
22428 one address at a time, so that when several addresses are routed to the same
22429 remote host, just one copy of the message is sent. Local transports, however,
22430 normally handle one address at a time. That is, a separate instance of the
22431 transport is run for each address that is routed to the transport. A separate
22432 copy of the message is delivered each time.
22433
22434 .cindex "batched local delivery"
22435 .oindex "&%batch_max%&"
22436 .oindex "&%batch_id%&"
22437 In special cases, it may be desirable to handle several addresses at once in a
22438 local transport, for example:
22439
22440 .ilist
22441 In an &(appendfile)& transport, when storing messages in files for later
22442 delivery by some other means, a single copy of the message with multiple
22443 recipients saves space.
22444 .next
22445 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22446 a single copy saves time, and is the normal way LMTP is expected to work.
22447 .next
22448 In a &(pipe)& transport, when passing the message
22449 to a scanner program or
22450 to some other delivery mechanism such as UUCP, multiple recipients may be
22451 acceptable.
22452 .endlist
22453
22454 These three local transports all have the same options for controlling multiple
22455 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22456 repeating the information for each transport, these options are described here.
22457
22458 The &%batch_max%& option specifies the maximum number of addresses that can be
22459 delivered together in a single run of the transport. Its default value is one
22460 (no batching). When more than one address is routed to a transport that has a
22461 &%batch_max%& value greater than one, the addresses are delivered in a batch
22462 (that is, in a single run of the transport with multiple recipients), subject
22463 to certain conditions:
22464
22465 .ilist
22466 .vindex "&$local_part$&"
22467 If any of the transport's options contain a reference to &$local_part$&, no
22468 batching is possible.
22469 .next
22470 .vindex "&$domain$&"
22471 If any of the transport's options contain a reference to &$domain$&, only
22472 addresses with the same domain are batched.
22473 .next
22474 .cindex "customizing" "batching condition"
22475 If &%batch_id%& is set, it is expanded for each address, and only those
22476 addresses with the same expanded value are batched. This allows you to specify
22477 customized batching conditions. Failure of the expansion for any reason,
22478 including forced failure, disables batching, but it does not stop the delivery
22479 from taking place.
22480 .next
22481 Batched addresses must also have the same errors address (where to send
22482 delivery errors), the same header additions and removals, the same user and
22483 group for the transport, and if a host list is present, the first host must
22484 be the same.
22485 .endlist
22486
22487 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22488 both when the file or pipe command is specified in the transport, and when it
22489 is specified by a &(redirect)& router, but all the batched addresses must of
22490 course be routed to the same file or pipe command. These two transports have an
22491 option called &%use_bsmtp%&, which causes them to deliver the message in
22492 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22493 &%check_string%& and &%escape_string%& options are forced to the values
22494 .code
22495 check_string = "."
22496 escape_string = ".."
22497 .endd
22498 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22499 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22500 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22501
22502 .cindex "&'Envelope-to:'& header line"
22503 If the generic &%envelope_to_add%& option is set for a batching transport, the
22504 &'Envelope-to:'& header that is added to the message contains all the addresses
22505 that are being processed together. If you are using a batching &(appendfile)&
22506 transport without &%use_bsmtp%&, the only way to preserve the recipient
22507 addresses is to set the &%envelope_to_add%& option.
22508
22509 .cindex "&(pipe)& transport" "with multiple addresses"
22510 .vindex "&$pipe_addresses$&"
22511 If you are using a &(pipe)& transport without BSMTP, and setting the
22512 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22513 the command. This is not a true variable; it is a bit of magic that causes each
22514 of the recipient addresses to be inserted into the command as a separate
22515 argument. This provides a way of accessing all the addresses that are being
22516 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22517 are specified by a &(redirect)& router.
22518
22519
22520
22521
22522 . ////////////////////////////////////////////////////////////////////////////
22523 . ////////////////////////////////////////////////////////////////////////////
22524
22525 .chapter "The appendfile transport" "CHAPappendfile"
22526 .scindex IIDapptra1 "&(appendfile)& transport"
22527 .scindex IIDapptra2 "transports" "&(appendfile)&"
22528 .cindex "directory creation"
22529 .cindex "creating directories"
22530 The &(appendfile)& transport delivers a message by appending it to an existing
22531 file, or by creating an entirely new file in a specified directory. Single
22532 files to which messages are appended can be in the traditional Unix mailbox
22533 format, or optionally in the MBX format supported by the Pine MUA and
22534 University of Washington IMAP daemon, &'inter alia'&. When each message is
22535 being delivered as a separate file, &"maildir"& format can optionally be used
22536 to give added protection against failures that happen part-way through the
22537 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22538 supported. For all file formats, Exim attempts to create as many levels of
22539 directory as necessary, provided that &%create_directory%& is set.
22540
22541 The code for the optional formats is not included in the Exim binary by
22542 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22543 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22544 included.
22545
22546 .cindex "quota" "system"
22547 Exim recognizes system quota errors, and generates an appropriate message. Exim
22548 also supports its own quota control within the transport, for use when the
22549 system facility is unavailable or cannot be used for some reason.
22550
22551 If there is an error while appending to a file (for example, quota exceeded or
22552 partition filled), Exim attempts to reset the file's length and last
22553 modification time back to what they were before. If there is an error while
22554 creating an entirely new file, the new file is removed.
22555
22556 Before appending to a file, a number of security checks are made, and the
22557 file is locked. A detailed description is given below, after the list of
22558 private options.
22559
22560 The &(appendfile)& transport is most commonly used for local deliveries to
22561 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22562 putting messages into files for remote delivery by some means other than Exim.
22563 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22564 option).
22565
22566
22567
22568 .section "The file and directory options" "SECTfildiropt"
22569 The &%file%& option specifies a single file, to which the message is appended;
22570 the &%directory%& option specifies a directory, in which a new file containing
22571 the message is created. Only one of these two options can be set, and for
22572 normal deliveries to mailboxes, one of them &'must'& be set.
22573
22574 .vindex "&$address_file$&"
22575 .vindex "&$local_part$&"
22576 However, &(appendfile)& is also used for delivering messages to files or
22577 directories whose names (or parts of names) are obtained from alias,
22578 forwarding, or filtering operations (for example, a &%save%& command in a
22579 user's Exim filter). When such a transport is running, &$local_part$& contains
22580 the local part that was aliased or forwarded, and &$address_file$& contains the
22581 name (or partial name) of the file or directory generated by the redirection
22582 operation. There are two cases:
22583
22584 .ilist
22585 If neither &%file%& nor &%directory%& is set, the redirection operation
22586 must specify an absolute path (one that begins with &`/`&). This is the most
22587 common case when users with local accounts use filtering to sort mail into
22588 different folders. See for example, the &(address_file)& transport in the
22589 default configuration. If the path ends with a slash, it is assumed to be the
22590 name of a directory. A delivery to a directory can also be forced by setting
22591 &%maildir_format%& or &%mailstore_format%&.
22592 .next
22593 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22594 used to determine the file or directory name for the delivery. Normally, the
22595 contents of &$address_file$& are used in some way in the string expansion.
22596 .endlist
22597 .new
22598 .cindex "tainted data" "in filenames"
22599 .cindex appendfile "tainted data"
22600 Tainted data may not be used for a file or directory name.
22601 This means that, for instance, &$local_part$& cannot be used directly
22602 as a component of a path.  It can however be used as the key for a lookup
22603 which returns a path (or component).
22604 .wen
22605
22606
22607 .cindex "Sieve filter" "configuring &(appendfile)&"
22608 .cindex "Sieve filter" "relative mailbox path handling"
22609 As an example of the second case, consider an environment where users do not
22610 have home directories. They may be permitted to use Exim filter commands of the
22611 form:
22612 .code
22613 save folder23
22614 .endd
22615 or Sieve filter commands of the form:
22616 .code
22617 require "fileinto";
22618 fileinto "folder23";
22619 .endd
22620 In this situation, the expansion of &%file%& or &%directory%& in the transport
22621 must transform the relative path into an appropriate absolute filename. In the
22622 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22623 is used as a result of a &"keep"& action in the filter. This example shows one
22624 way of handling this requirement:
22625 .code
22626 file = ${if eq{$address_file}{inbox} \
22627             {/var/mail/$local_part} \
22628             {${if eq{${substr_0_1:$address_file}}{/} \
22629                   {$address_file} \
22630                   {$home/mail/$address_file} \
22631             }} \
22632        }
22633 .endd
22634 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22635 location, absolute paths are used without change, and other folders are in the
22636 &_mail_& directory within the home directory.
22637
22638 &*Note 1*&: While processing an Exim filter, a relative path such as
22639 &_folder23_& is turned into an absolute path if a home directory is known to
22640 the router. In particular, this is the case if &%check_local_user%& is set. If
22641 you want to prevent this happening at routing time, you can set
22642 &%router_home_directory%& empty. This forces the router to pass the relative
22643 path to the transport.
22644
22645 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22646 the &%file%& or &%directory%& option is still used if it is set.
22647
22648
22649
22650
22651 .section "Private options for appendfile" "SECID134"
22652 .cindex "options" "&(appendfile)& transport"
22653
22654
22655
22656 .option allow_fifo appendfile boolean false
22657 .cindex "fifo (named pipe)"
22658 .cindex "named pipe (fifo)"
22659 .cindex "pipe" "named (fifo)"
22660 Setting this option permits delivery to named pipes (FIFOs) as well as to
22661 regular files. If no process is reading the named pipe at delivery time, the
22662 delivery is deferred.
22663
22664
22665 .option allow_symlink appendfile boolean false
22666 .cindex "symbolic link" "to mailbox"
22667 .cindex "mailbox" "symbolic link"
22668 By default, &(appendfile)& will not deliver if the path name for the file is
22669 that of a symbolic link. Setting this option relaxes that constraint, but there
22670 are security issues involved in the use of symbolic links. Be sure you know
22671 what you are doing if you set this. Details of exactly what this option affects
22672 are included in the discussion which follows this list of options.
22673
22674
22675 .option batch_id appendfile string&!! unset
22676 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22677 However, batching is automatically disabled for &(appendfile)& deliveries that
22678 happen as a result of forwarding or aliasing or other redirection directly to a
22679 file.
22680
22681
22682 .option batch_max appendfile integer 1
22683 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22684
22685
22686 .option check_group appendfile boolean false
22687 When this option is set, the group owner of the file defined by the &%file%&
22688 option is checked to see that it is the same as the group under which the
22689 delivery process is running. The default setting is false because the default
22690 file mode is 0600, which means that the group is irrelevant.
22691
22692
22693 .option check_owner appendfile boolean true
22694 When this option is set, the owner of the file defined by the &%file%& option
22695 is checked to ensure that it is the same as the user under which the delivery
22696 process is running.
22697
22698
22699 .option check_string appendfile string "see below"
22700 .cindex "&""From""& line"
22701 As &(appendfile)& writes the message, the start of each line is tested for
22702 matching &%check_string%&, and if it does, the initial matching characters are
22703 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22704 a literal string, not a regular expression, and the case of any letters it
22705 contains is significant.
22706
22707 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22708 are forced to &"."& and &".."& respectively, and any settings in the
22709 configuration are ignored. Otherwise, they default to &"From&~"& and
22710 &">From&~"& when the &%file%& option is set, and unset when any of the
22711 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22712
22713 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22714 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22715 &"From&~"& indicates the start of a new message. All four options need changing
22716 if another format is used. For example, to deliver to mailboxes in MMDF format:
22717 .cindex "MMDF format mailbox"
22718 .cindex "mailbox" "MMDF format"
22719 .code
22720 check_string = "\1\1\1\1\n"
22721 escape_string = "\1\1\1\1 \n"
22722 message_prefix = "\1\1\1\1\n"
22723 message_suffix = "\1\1\1\1\n"
22724 .endd
22725 .option create_directory appendfile boolean true
22726 .cindex "directory creation"
22727 When this option is true, Exim attempts to create any missing superior
22728 directories for the file that it is about to write. A created directory's mode
22729 is given by the &%directory_mode%& option.
22730
22731 The group ownership of a newly created directory is highly dependent on the
22732 operating system (and possibly the file system) that is being used. For
22733 example, in Solaris, if the parent directory has the setgid bit set, its group
22734 is propagated to the child; if not, the currently set group is used. However,
22735 in FreeBSD, the parent's group is always used.
22736
22737
22738
22739 .option create_file appendfile string anywhere
22740 This option constrains the location of files and directories that are created
22741 by this transport. It applies to files defined by the &%file%& option and
22742 directories defined by the &%directory%& option. In the case of maildir
22743 delivery, it applies to the top level directory, not the maildir directories
22744 beneath.
22745
22746 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22747 &"belowhome"&. In the second and third cases, a home directory must have been
22748 set for the transport. This option is not useful when an explicit filename is
22749 given for normal mailbox deliveries. It is intended for the case when filenames
22750 are generated from users' &_.forward_& files. These are usually handled
22751 by an &(appendfile)& transport called &%address_file%&. See also
22752 &%file_must_exist%&.
22753
22754
22755 .option directory appendfile string&!! unset
22756 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22757 or &%directory%& must be set, unless the delivery is the direct result of a
22758 redirection (see section &<<SECTfildiropt>>&).
22759
22760 When &%directory%& is set, the string is expanded, and the message is delivered
22761 into a new file or files in or below the given directory, instead of being
22762 appended to a single mailbox file. A number of different formats are provided
22763 (see &%maildir_format%& and &%mailstore_format%&), and see section
22764 &<<SECTopdir>>& for further details of this form of delivery.
22765
22766
22767 .option directory_file appendfile string&!! "see below"
22768 .cindex "base62"
22769 .vindex "&$inode$&"
22770 When &%directory%& is set, but neither &%maildir_format%& nor
22771 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22772 whose name is obtained by expanding this string. The default value is:
22773 .code
22774 q${base62:$tod_epoch}-$inode
22775 .endd
22776 This generates a unique name from the current time, in base 62 form, and the
22777 inode of the file. The variable &$inode$& is available only when expanding this
22778 option.
22779
22780
22781 .option directory_mode appendfile "octal integer" 0700
22782 If &(appendfile)& creates any directories as a result of the
22783 &%create_directory%& option, their mode is specified by this option.
22784
22785
22786 .option escape_string appendfile string "see description"
22787 See &%check_string%& above.
22788
22789
22790 .option file appendfile string&!! unset
22791 This option is mutually exclusive with the &%directory%& option, but one of
22792 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22793 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22794 specifies a single file, to which the message is appended. One or more of
22795 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22796 &%file%&.
22797
22798 .cindex "NFS" "lock file"
22799 .cindex "locking files"
22800 .cindex "lock files"
22801 If you are using more than one host to deliver over NFS into the same
22802 mailboxes, you should always use lock files.
22803
22804 The string value is expanded for each delivery, and must yield an absolute
22805 path. The most common settings of this option are variations on one of these
22806 examples:
22807 .code
22808 file = /var/spool/mail/$local_part
22809 file = /home/$local_part/inbox
22810 file = $home/inbox
22811 .endd
22812 .cindex "&""sticky""& bit"
22813 In the first example, all deliveries are done into the same directory. If Exim
22814 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22815 create a file in the directory, so the &"sticky"& bit must be turned on for
22816 deliveries to be possible, or alternatively the &%group%& option can be used to
22817 run the delivery under a group id which has write access to the directory.
22818
22819
22820
22821 .option file_format appendfile string unset
22822 .cindex "file" "mailbox; checking existing format"
22823 This option requests the transport to check the format of an existing file
22824 before adding to it. The check consists of matching a specific string at the
22825 start of the file. The value of the option consists of an even number of
22826 colon-separated strings. The first of each pair is the test string, and the
22827 second is the name of a transport. If the transport associated with a matched
22828 string is not the current transport, control is passed over to the other
22829 transport. For example, suppose the standard &(local_delivery)& transport has
22830 this added to it:
22831 .code
22832 file_format = "From       : local_delivery :\
22833                \1\1\1\1\n : local_mmdf_delivery"
22834 .endd
22835 Mailboxes that begin with &"From"& are still handled by this transport, but if
22836 a mailbox begins with four binary ones followed by a newline, control is passed
22837 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22838 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22839 is assumed to match the current transport. If the start of a mailbox doesn't
22840 match any string, or if the transport named for a given string is not defined,
22841 delivery is deferred.
22842
22843
22844 .option file_must_exist appendfile boolean false
22845 If this option is true, the file specified by the &%file%& option must exist.
22846 A temporary error occurs if it does not, causing delivery to be deferred.
22847 If this option is false, the file is created if it does not exist.
22848
22849
22850 .option lock_fcntl_timeout appendfile time 0s
22851 .cindex "timeout" "mailbox locking"
22852 .cindex "mailbox" "locking, blocking and non-blocking"
22853 .cindex "locking files"
22854 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22855 when locking an open mailbox file. If the call fails, the delivery process
22856 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22857 Non-blocking calls are used so that the file is not kept open during the wait
22858 for the lock; the reason for this is to make it as safe as possible for
22859 deliveries over NFS in the case when processes might be accessing an NFS
22860 mailbox without using a lock file. This should not be done, but
22861 misunderstandings and hence misconfigurations are not unknown.
22862
22863 On a busy system, however, the performance of a non-blocking lock approach is
22864 not as good as using a blocking lock with a timeout. In this case, the waiting
22865 is done inside the system call, and Exim's delivery process acquires the lock
22866 and can proceed as soon as the previous lock holder releases it.
22867
22868 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22869 timeout, are used. There may still be some retrying: the maximum number of
22870 retries is
22871 .code
22872 (lock_retries * lock_interval) / lock_fcntl_timeout
22873 .endd
22874 rounded up to the next whole number. In other words, the total time during
22875 which &(appendfile)& is trying to get a lock is roughly the same, unless
22876 &%lock_fcntl_timeout%& is set very large.
22877
22878 You should consider setting this option if you are getting a lot of delayed
22879 local deliveries because of errors of the form
22880 .code
22881 failed to lock mailbox /some/file (fcntl)
22882 .endd
22883
22884 .option lock_flock_timeout appendfile time 0s
22885 This timeout applies to file locking when using &[flock()]& (see
22886 &%use_flock%&); the timeout operates in a similar manner to
22887 &%lock_fcntl_timeout%&.
22888
22889
22890 .option lock_interval appendfile time 3s
22891 This specifies the time to wait between attempts to lock the file. See below
22892 for details of locking.
22893
22894
22895 .option lock_retries appendfile integer 10
22896 This specifies the maximum number of attempts to lock the file. A value of zero
22897 is treated as 1. See below for details of locking.
22898
22899
22900 .option lockfile_mode appendfile "octal integer" 0600
22901 This specifies the mode of the created lock file, when a lock file is being
22902 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22903
22904
22905 .option lockfile_timeout appendfile time 30m
22906 .cindex "timeout" "mailbox locking"
22907 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22908 exists and is older than this value, it is assumed to have been left behind by
22909 accident, and Exim attempts to remove it.
22910
22911
22912 .option mailbox_filecount appendfile string&!! unset
22913 .cindex "mailbox" "specifying size of"
22914 .cindex "size" "of mailbox"
22915 If this option is set, it is expanded, and the result is taken as the current
22916 number of files in the mailbox. It must be a decimal number, optionally
22917 followed by K or M. This provides a way of obtaining this information from an
22918 external source that maintains the data.
22919
22920
22921 .option mailbox_size appendfile string&!! unset
22922 .cindex "mailbox" "specifying size of"
22923 .cindex "size" "of mailbox"
22924 If this option is set, it is expanded, and the result is taken as the current
22925 size the mailbox. It must be a decimal number, optionally followed by K or M.
22926 This provides a way of obtaining this information from an external source that
22927 maintains the data. This is likely to be helpful for maildir deliveries where
22928 it is computationally expensive to compute the size of a mailbox.
22929
22930
22931
22932 .option maildir_format appendfile boolean false
22933 .cindex "maildir format" "specifying"
22934 If this option is set with the &%directory%& option, the delivery is into a new
22935 file, in the &"maildir"& format that is used by other mail software. When the
22936 transport is activated directly from a &(redirect)& router (for example, the
22937 &(address_file)& transport in the default configuration), setting
22938 &%maildir_format%& causes the path received from the router to be treated as a
22939 directory, whether or not it ends with &`/`&. This option is available only if
22940 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22941 &<<SECTmaildirdelivery>>& below for further details.
22942
22943
22944 .option maildir_quota_directory_regex appendfile string "See below"
22945 .cindex "maildir format" "quota; directories included in"
22946 .cindex "quota" "maildir; directories included in"
22947 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22948 a regular expression for specifying directories, relative to the quota
22949 directory (see &%quota_directory%&), that should be included in the quota
22950 calculation. The default value is:
22951 .code
22952 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22953 .endd
22954 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22955 (directories whose names begin with a dot). If you want to exclude the
22956 &_Trash_&
22957 folder from the count (as some sites do), you need to change this setting to
22958 .code
22959 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22960 .endd
22961 This uses a negative lookahead in the regular expression to exclude the
22962 directory whose name is &_.Trash_&. When a directory is excluded from quota
22963 calculations, quota processing is bypassed for any messages that are delivered
22964 directly into that directory.
22965
22966
22967 .option maildir_retries appendfile integer 10
22968 This option specifies the number of times to retry when writing a file in
22969 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22970
22971
22972 .option maildir_tag appendfile string&!! unset
22973 This option applies only to deliveries in maildir format, and is described in
22974 section &<<SECTmaildirdelivery>>& below.
22975
22976
22977 .option maildir_use_size_file appendfile&!! boolean false
22978 .cindex "maildir format" "&_maildirsize_& file"
22979 The result of string expansion for this option must be a valid boolean value.
22980 If it is true, it enables support for &_maildirsize_& files. Exim
22981 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22982 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22983 value is zero. See &%maildir_quota_directory_regex%& above and section
22984 &<<SECTmaildirdelivery>>& below for further details.
22985
22986 .option maildirfolder_create_regex appendfile string unset
22987 .cindex "maildir format" "&_maildirfolder_& file"
22988 .cindex "&_maildirfolder_&, creating"
22989 The value of this option is a regular expression. If it is unset, it has no
22990 effect. Otherwise, before a maildir delivery takes place, the pattern is
22991 matched against the name of the maildir directory, that is, the directory
22992 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22993 delivery. If there is a match, Exim checks for the existence of a file called
22994 &_maildirfolder_& in the directory, and creates it if it does not exist.
22995 See section &<<SECTmaildirdelivery>>& for more details.
22996
22997
22998 .option mailstore_format appendfile boolean false
22999 .cindex "mailstore format" "specifying"
23000 If this option is set with the &%directory%& option, the delivery is into two
23001 new files in  &"mailstore"& format. The option is available only if
23002 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23003 below for further details.
23004
23005
23006 .option mailstore_prefix appendfile string&!! unset
23007 This option applies only to deliveries in mailstore format, and is described in
23008 section &<<SECTopdir>>& below.
23009
23010
23011 .option mailstore_suffix appendfile string&!! unset
23012 This option applies only to deliveries in mailstore format, and is described in
23013 section &<<SECTopdir>>& below.
23014
23015
23016 .option mbx_format appendfile boolean false
23017 .cindex "locking files"
23018 .cindex "file" "locking"
23019 .cindex "file" "MBX format"
23020 .cindex "MBX format, specifying"
23021 This option is available only if Exim has been compiled with SUPPORT_MBX
23022 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23023 the message is appended to the mailbox file in MBX format instead of
23024 traditional Unix format. This format is supported by Pine4 and its associated
23025 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23026
23027 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23028 automatically changed by the use of &%mbx_format%&. They should normally be set
23029 empty when using MBX format, so this option almost always appears in this
23030 combination:
23031 .code
23032 mbx_format = true
23033 message_prefix =
23034 message_suffix =
23035 .endd
23036 If none of the locking options are mentioned in the configuration,
23037 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23038 is possible to specify the other kinds of locking with &%mbx_format%&, but
23039 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23040 interworks with &'c-client'&, providing for shared access to the mailbox. It
23041 should not be used if any program that does not use this form of locking is
23042 going to access the mailbox, nor should it be used if the mailbox file is NFS
23043 mounted, because it works only when the mailbox is accessed from a single host.
23044
23045 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23046 the standard version of &'c-client'&, because as long as it has a mailbox open
23047 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23048 append messages to it.
23049
23050
23051 .option message_prefix appendfile string&!! "see below"
23052 .cindex "&""From""& line"
23053 The string specified here is expanded and output at the start of every message.
23054 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23055 in which case it is:
23056 .code
23057 message_prefix = "From ${if def:return_path{$return_path}\
23058   {MAILER-DAEMON}} $tod_bsdinbox\n"
23059 .endd
23060 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23061 &`\n`& to &`\r\n`& in &%message_prefix%&.
23062
23063 .option message_suffix appendfile string&!! "see below"
23064 The string specified here is expanded and output at the end of every message.
23065 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23066 in which case it is a single newline character. The suffix can be suppressed by
23067 setting
23068 .code
23069 message_suffix =
23070 .endd
23071 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23072 &`\n`& to &`\r\n`& in &%message_suffix%&.
23073
23074 .option mode appendfile "octal integer" 0600
23075 If the output file is created, it is given this mode. If it already exists and
23076 has wider permissions, they are reduced to this mode. If it has narrower
23077 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23078 if the delivery is the result of a &%save%& command in a filter file specifying
23079 a particular mode, the mode of the output file is always forced to take that
23080 value, and this option is ignored.
23081
23082
23083 .option mode_fail_narrower appendfile boolean true
23084 This option applies in the case when an existing mailbox file has a narrower
23085 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23086 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23087 continues with the delivery attempt, using the existing mode of the file.
23088
23089
23090 .option notify_comsat appendfile boolean false
23091 If this option is true, the &'comsat'& daemon is notified after every
23092 successful delivery to a user mailbox. This is the daemon that notifies logged
23093 on users about incoming mail.
23094
23095
23096 .option quota appendfile string&!! unset
23097 .cindex "quota" "imposed by Exim"
23098 This option imposes a limit on the size of the file to which Exim is appending,
23099 or to the total space used in the directory tree when the &%directory%& option
23100 is set. In the latter case, computation of the space used is expensive, because
23101 all the files in the directory (and any sub-directories) have to be
23102 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23103 &%maildir_use_size_file%& for ways to avoid this in environments where users
23104 have no shell access to their mailboxes).
23105
23106 As there is no interlock against two simultaneous deliveries into a
23107 multi-file mailbox, it is possible for the quota to be overrun in this case.
23108 For single-file mailboxes, of course, an interlock is a necessity.
23109
23110 A file's size is taken as its &'used'& value. Because of blocking effects, this
23111 may be a lot less than the actual amount of disk space allocated to the file.
23112 If the sizes of a number of files are being added up, the rounding effect can
23113 become quite noticeable, especially on systems that have large block sizes.
23114 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23115 the obvious value which users understand most easily.
23116
23117 The value of the option is expanded, and must then be a numerical value
23118 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23119 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23120 and further option modifiers. If Exim is running on a system with
23121 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23122 be handled.
23123
23124 The option modifier &%no_check%& can be used to force delivery even if the over
23125 quota condition is met. The quota gets updated as usual.
23126
23127 &*Note*&: A value of zero is interpreted as &"no quota"&.
23128
23129 The expansion happens while Exim is running as root, before it changes uid for
23130 the delivery. This means that files that are inaccessible to the end user can
23131 be used to hold quota values that are looked up in the expansion. When delivery
23132 fails because this quota is exceeded, the handling of the error is as for
23133 system quota failures.
23134
23135 By default, Exim's quota checking mimics system quotas, and restricts the
23136 mailbox to the specified maximum size, though the value is not accurate to the
23137 last byte, owing to separator lines and additional headers that may get added
23138 during message delivery. When a mailbox is nearly full, large messages may get
23139 refused even though small ones are accepted, because the size of the current
23140 message is added to the quota when the check is made. This behaviour can be
23141 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23142 for exceeding the quota does not include the current message. Thus, deliveries
23143 continue until the quota has been exceeded; thereafter, no further messages are
23144 delivered. See also &%quota_warn_threshold%&.
23145
23146
23147 .option quota_directory appendfile string&!! unset
23148 This option defines the directory to check for quota purposes when delivering
23149 into individual files. The default is the delivery directory, or, if a file
23150 called &_maildirfolder_& exists in a maildir directory, the parent of the
23151 delivery directory.
23152
23153
23154 .option quota_filecount appendfile string&!! 0
23155 This option applies when the &%directory%& option is set. It limits the total
23156 number of files in the directory (compare the inode limit in system quotas). It
23157 can only be used if &%quota%& is also set. The value is expanded; an expansion
23158 failure causes delivery to be deferred. A value of zero is interpreted as
23159 &"no quota"&.
23160
23161 The option modifier &%no_check%& can be used to force delivery even if the over
23162 quota condition is met. The quota gets updated as usual.
23163
23164 .option quota_is_inclusive appendfile boolean true
23165 See &%quota%& above.
23166
23167
23168 .option quota_size_regex appendfile string unset
23169 This option applies when one of the delivery modes that writes a separate file
23170 for each message is being used. When Exim wants to find the size of one of
23171 these files in order to test the quota, it first checks &%quota_size_regex%&.
23172 If this is set to a regular expression that matches the filename, and it
23173 captures one string, that string is interpreted as a representation of the
23174 file's size. The value of &%quota_size_regex%& is not expanded.
23175
23176 This feature is useful only when users have no shell access to their mailboxes
23177 &-- otherwise they could defeat the quota simply by renaming the files. This
23178 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23179 the file length to the filename. For example:
23180 .code
23181 maildir_tag = ,S=$message_size
23182 quota_size_regex = ,S=(\d+)
23183 .endd
23184 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23185 number of lines in the message.
23186
23187 The regular expression should not assume that the length is at the end of the
23188 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23189 sometimes add other information onto the ends of message filenames.
23190
23191 Section &<<SECID136>>& contains further information.
23192
23193 This option should not be used when other message-handling software
23194 may duplicate messages by making hardlinks to the files.  When that is done Exim
23195 will count the message size once for each filename, in contrast with the actual
23196 disk usage.  When the option is not set, calculating total usage requires
23197 a system-call per file to get the size; the number of links is then available also
23198 as is used to adjust the effective size.
23199
23200
23201 .option quota_warn_message appendfile string&!! "see below"
23202 See below for the use of this option. If it is not set when
23203 &%quota_warn_threshold%& is set, it defaults to
23204 .code
23205 quota_warn_message = "\
23206   To: $local_part@$domain\n\
23207   Subject: Your mailbox\n\n\
23208   This message is automatically created \
23209   by mail delivery software.\n\n\
23210   The size of your mailbox has exceeded \
23211   a warning threshold that is\n\
23212   set by the system administrator.\n"
23213 .endd
23214
23215
23216 .option quota_warn_threshold appendfile string&!! 0
23217 .cindex "quota" "warning threshold"
23218 .cindex "mailbox" "size warning"
23219 .cindex "size" "of mailbox"
23220 This option is expanded in the same way as &%quota%& (see above). If the
23221 resulting value is greater than zero, and delivery of the message causes the
23222 size of the file or total space in the directory tree to cross the given
23223 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23224 may be specified as a percentage of it by following the value with a percent
23225 sign. For example:
23226 .code
23227 quota = 10M
23228 quota_warn_threshold = 75%
23229 .endd
23230 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23231 percent sign is ignored.
23232
23233 The warning message itself is specified by the &%quota_warn_message%& option,
23234 and it must start with a &'To:'& header line containing the recipient(s) of the
23235 warning message. These do not necessarily have to include the recipient(s) of
23236 the original message. A &'Subject:'& line should also normally be supplied. You
23237 can include any other header lines that you want. If you do not include a
23238 &'From:'& line, the default is:
23239 .code
23240 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23241 .endd
23242 .oindex &%errors_reply_to%&
23243 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23244 option.
23245
23246 The &%quota%& option does not have to be set in order to use this option; they
23247 are independent of one another except when the threshold is specified as a
23248 percentage.
23249
23250
23251 .option use_bsmtp appendfile boolean false
23252 .cindex "envelope from"
23253 .cindex "envelope sender"
23254 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23255 format, with the envelope sender and recipient(s) included as SMTP commands. If
23256 you want to include a leading HELO command with such messages, you can do
23257 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23258 for details of batch SMTP.
23259
23260
23261 .option use_crlf appendfile boolean false
23262 .cindex "carriage return"
23263 .cindex "linefeed"
23264 This option causes lines to be terminated with the two-character CRLF sequence
23265 (carriage return, linefeed) instead of just a linefeed character. In the case
23266 of batched SMTP, the byte sequence written to the file is then an exact image
23267 of what would be sent down a real SMTP connection.
23268
23269 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23270 (which are used to supply the traditional &"From&~"& and blank line separators
23271 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23272 carriage return characters if these are needed. In cases where these options
23273 have non-empty defaults, the values end with a single linefeed, so they must be
23274 changed to end with &`\r\n`& if &%use_crlf%& is set.
23275
23276
23277 .option use_fcntl_lock appendfile boolean "see below"
23278 This option controls the use of the &[fcntl()]& function to lock a file for
23279 exclusive use when a message is being appended. It is set by default unless
23280 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23281 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23282 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23283
23284
23285 .option use_flock_lock appendfile boolean false
23286 This option is provided to support the use of &[flock()]& for file locking, for
23287 the few situations where it is needed. Most modern operating systems support
23288 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23289 each other. Exim uses &[fcntl()]& locking by default.
23290
23291 This option is required only if you are using an operating system where
23292 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23293 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23294 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23295
23296 .cindex "Solaris" "&[flock()]& support"
23297 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23298 have it (and some, I think, provide a not quite right version built on top of
23299 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23300 the ability to use it, and any attempt to do so will cause a configuration
23301 error.
23302
23303 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23304 is just being mapped onto &[fcntl()]& by the OS).
23305
23306
23307 .option use_lockfile appendfile boolean "see below"
23308 If this option is turned off, Exim does not attempt to create a lock file when
23309 appending to a mailbox file. In this situation, the only locking is by
23310 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23311 sure that every MUA that is ever going to look at your users' mailboxes uses
23312 &[fcntl()]& rather than a lock file, and even then only when you are not
23313 delivering over NFS from more than one host.
23314
23315 .cindex "NFS" "lock file"
23316 In order to append to an NFS file safely from more than one host, it is
23317 necessary to take out a lock &'before'& opening the file, and the lock file
23318 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23319 file corruption.
23320
23321 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23322 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23323 except when &%mbx_format%& is set.
23324
23325
23326 .option use_mbx_lock appendfile boolean "see below"
23327 This option is available only if Exim has been compiled with SUPPORT_MBX
23328 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23329 locking rules be used. It is set by default if &%mbx_format%& is set and none
23330 of the locking options are mentioned in the configuration. The locking rules
23331 are the same as are used by the &'c-client'& library that underlies Pine and
23332 the IMAP4 and POP daemons that come with it (see the discussion below). The
23333 rules allow for shared access to the mailbox. However, this kind of locking
23334 does not work when the mailbox is NFS mounted.
23335
23336 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23337 &%use_flock_lock%& to control what kind of locking is used in implementing the
23338 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23339 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23340
23341
23342
23343
23344 .section "Operational details for appending" "SECTopappend"
23345 .cindex "appending to a file"
23346 .cindex "file" "appending"
23347 Before appending to a file, the following preparations are made:
23348
23349 .ilist
23350 If the name of the file is &_/dev/null_&, no action is taken, and a success
23351 return is given.
23352
23353 .next
23354 .cindex "directory creation"
23355 If any directories on the file's path are missing, Exim creates them if the
23356 &%create_directory%& option is set. A created directory's mode is given by the
23357 &%directory_mode%& option.
23358
23359 .next
23360 If &%file_format%& is set, the format of an existing file is checked. If this
23361 indicates that a different transport should be used, control is passed to that
23362 transport.
23363
23364 .next
23365 .cindex "file" "locking"
23366 .cindex "locking files"
23367 .cindex "NFS" "lock file"
23368 If &%use_lockfile%& is set, a lock file is built in a way that will work
23369 reliably over NFS, as follows:
23370
23371 .olist
23372 Create a &"hitching post"& file whose name is that of the lock file with the
23373 current time, primary host name, and process id added, by opening for writing
23374 as a new file. If this fails with an access error, delivery is deferred.
23375 .next
23376 Close the hitching post file, and hard link it to the lock filename.
23377 .next
23378 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23379 Unlink the hitching post name.
23380 .next
23381 Otherwise, use &[stat()]& to get information about the hitching post file, and
23382 then unlink hitching post name. If the number of links is exactly two, creation
23383 of the lock file succeeded but something (for example, an NFS server crash and
23384 restart) caused this fact not to be communicated to the &[link()]& call.
23385 .next
23386 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23387 up to &%lock_retries%& times. However, since any program that writes to a
23388 mailbox should complete its task very quickly, it is reasonable to time out old
23389 lock files that are normally the result of user agent and system crashes. If an
23390 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23391 it before trying again.
23392 .endlist olist
23393
23394 .next
23395 A call is made to &[lstat()]& to discover whether the main file exists, and if
23396 so, what its characteristics are. If &[lstat()]& fails for any reason other
23397 than non-existence, delivery is deferred.
23398
23399 .next
23400 .cindex "symbolic link" "to mailbox"
23401 .cindex "mailbox" "symbolic link"
23402 If the file does exist and is a symbolic link, delivery is deferred, unless the
23403 &%allow_symlink%& option is set, in which case the ownership of the link is
23404 checked, and then &[stat()]& is called to find out about the real file, which
23405 is then subjected to the checks below. The check on the top-level link
23406 ownership prevents one user creating a link for another's mailbox in a sticky
23407 directory, though allowing symbolic links in this case is definitely not a good
23408 idea. If there is a chain of symbolic links, the intermediate ones are not
23409 checked.
23410
23411 .next
23412 If the file already exists but is not a regular file, or if the file's owner
23413 and group (if the group is being checked &-- see &%check_group%& above) are
23414 different from the user and group under which the delivery is running,
23415 delivery is deferred.
23416
23417 .next
23418 If the file's permissions are more generous than specified, they are reduced.
23419 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23420 is set false, in which case the delivery is tried using the existing
23421 permissions.
23422
23423 .next
23424 The file's inode number is saved, and the file is then opened for appending.
23425 If this fails because the file has vanished, &(appendfile)& behaves as if it
23426 hadn't existed (see below). For any other failures, delivery is deferred.
23427
23428 .next
23429 If the file is opened successfully, check that the inode number hasn't
23430 changed, that it is still a regular file, and that the owner and permissions
23431 have not changed. If anything is wrong, defer delivery and freeze the message.
23432
23433 .next
23434 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23435 option is set. Otherwise, check that the file is being created in a permitted
23436 directory if the &%create_file%& option is set (deferring on failure), and then
23437 open for writing as a new file, with the O_EXCL and O_CREAT options,
23438 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23439 set). In this case, which can happen if the link points to a non-existent file,
23440 the file is opened for writing using O_CREAT but not O_EXCL, because
23441 that prevents link following.
23442
23443 .next
23444 .cindex "loop" "while file testing"
23445 If opening fails because the file exists, obey the tests given above for
23446 existing files. However, to avoid looping in a situation where the file is
23447 being continuously created and destroyed, the exists/not-exists loop is broken
23448 after 10 repetitions, and the message is then frozen.
23449
23450 .next
23451 If opening fails with any other error, defer delivery.
23452
23453 .next
23454 .cindex "file" "locking"
23455 .cindex "locking files"
23456 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23457 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23458 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23459 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23460 file, and an exclusive lock on the file whose name is
23461 .code
23462 /tmp/.<device-number>.<inode-number>
23463 .endd
23464 using the device and inode numbers of the open mailbox file, in accordance with
23465 the MBX locking rules. This file is created with a mode that is specified by
23466 the &%lockfile_mode%& option.
23467
23468 If Exim fails to lock the file, there are two possible courses of action,
23469 depending on the value of the locking timeout. This is obtained from
23470 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23471
23472 If the timeout value is zero, the file is closed, Exim waits for
23473 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23474 to lock it again. This happens up to &%lock_retries%& times, after which the
23475 delivery is deferred.
23476
23477 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23478 &[flock()]& are used (with the given timeout), so there has already been some
23479 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23480 immediately. It retries up to
23481 .code
23482 (lock_retries * lock_interval) / <timeout>
23483 .endd
23484 times (rounded up).
23485 .endlist
23486
23487 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23488 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23489
23490
23491 .section "Operational details for delivery to a new file" "SECTopdir"
23492 .cindex "delivery" "to single file"
23493 .cindex "&""From""& line"
23494 When the &%directory%& option is set instead of &%file%&, each message is
23495 delivered into a newly-created file or set of files. When &(appendfile)& is
23496 activated directly from a &(redirect)& router, neither &%file%& nor
23497 &%directory%& is normally set, because the path for delivery is supplied by the
23498 router. (See for example, the &(address_file)& transport in the default
23499 configuration.) In this case, delivery is to a new file if either the path name
23500 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23501
23502 No locking is required while writing the message to a new file, so the various
23503 locking options of the transport are ignored. The &"From"& line that by default
23504 separates messages in a single file is not normally needed, nor is the escaping
23505 of message lines that start with &"From"&, and there is no need to ensure a
23506 newline at the end of each message. Consequently, the default values for
23507 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23508 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23509
23510 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23511 the files in the delivery directory by default. However, you can specify a
23512 different directory by setting &%quota_directory%&. Also, for maildir
23513 deliveries (see below) the &_maildirfolder_& convention is honoured.
23514
23515
23516 .cindex "maildir format"
23517 .cindex "mailstore format"
23518 There are three different ways in which delivery to individual files can be
23519 done, controlled by the settings of the &%maildir_format%& and
23520 &%mailstore_format%& options. Note that code to support maildir or mailstore
23521 formats is not included in the binary unless SUPPORT_MAILDIR or
23522 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23523
23524 .cindex "directory creation"
23525 In all three cases an attempt is made to create the directory and any necessary
23526 sub-directories if they do not exist, provided that the &%create_directory%&
23527 option is set (the default). The location of a created directory can be
23528 constrained by setting &%create_file%&. A created directory's mode is given by
23529 the &%directory_mode%& option. If creation fails, or if the
23530 &%create_directory%& option is not set when creation is required, delivery is
23531 deferred.
23532
23533
23534
23535 .section "Maildir delivery" "SECTmaildirdelivery"
23536 .cindex "maildir format" "description of"
23537 If the &%maildir_format%& option is true, Exim delivers each message by writing
23538 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23539 directory that is defined by the &%directory%& option (the &"delivery
23540 directory"&). If the delivery is successful, the file is renamed into the
23541 &_new_& subdirectory.
23542
23543 In the filename, <&'stime'&> is the current time of day in seconds, and
23544 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23545 Exim checks that the time-of-day clock has moved on by at least one microsecond
23546 before terminating the delivery process. This guarantees uniqueness for the
23547 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23548 opening it. If any response other than ENOENT (does not exist) is given,
23549 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23550
23551 Before Exim carries out a maildir delivery, it ensures that subdirectories
23552 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23553 do not exist, Exim tries to create them and any superior directories in their
23554 path, subject to the &%create_directory%& and &%create_file%& options. If the
23555 &%maildirfolder_create_regex%& option is set, and the regular expression it
23556 contains matches the delivery directory, Exim also ensures that a file called
23557 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23558 &_maildirfolder_& file cannot be created, delivery is deferred.
23559
23560 These features make it possible to use Exim to create all the necessary files
23561 and directories in a maildir mailbox, including subdirectories for maildir++
23562 folders. Consider this example:
23563 .code
23564 maildir_format = true
23565 directory = /var/mail/$local_part\
23566            ${if eq{$local_part_suffix}{}{}\
23567            {/.${substr_1:$local_part_suffix}}}
23568 maildirfolder_create_regex = /\.[^/]+$
23569 .endd
23570 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23571 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23572 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23573 not match this name, so Exim will not look for or create the file
23574 &_/var/mail/pimbo/maildirfolder_&, though it will create
23575 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23576
23577 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23578 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23579 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23580 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23581 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23582
23583 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23584 not inadvertently match the toplevel maildir directory, because a
23585 &_maildirfolder_& file at top level would completely break quota calculations.
23586
23587 .cindex "quota" "in maildir delivery"
23588 .cindex "maildir++"
23589 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23590 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23591 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23592 Exim assumes the directory is a maildir++ folder directory, which is one level
23593 down from the user's top level mailbox directory. This causes it to start at
23594 the parent directory instead of the current directory when calculating the
23595 amount of space used.
23596
23597 One problem with delivering into a multi-file mailbox is that it is
23598 computationally expensive to compute the size of the mailbox for quota
23599 checking. Various approaches have been taken to reduce the amount of work
23600 needed. The next two sections describe two of them. A third alternative is to
23601 use some external process for maintaining the size data, and use the expansion
23602 of the &%mailbox_size%& option as a way of importing it into Exim.
23603
23604
23605
23606
23607 .section "Using tags to record message sizes" "SECID135"
23608 If &%maildir_tag%& is set, the string is expanded for each delivery.
23609 When the maildir file is renamed into the &_new_& sub-directory, the
23610 tag is added to its name. However, if adding the tag takes the length of the
23611 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23612 the tag is dropped and the maildir file is created with no tag.
23613
23614
23615 .vindex "&$message_size$&"
23616 Tags can be used to encode the size of files in their names; see
23617 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23618 happens after the message has been written. The value of the &$message_size$&
23619 variable is set to the number of bytes actually written. If the expansion is
23620 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23621 be deferred. The expanded tag may contain any printing characters except &"/"&.
23622 Non-printing characters in the string are ignored; if the resulting string is
23623 empty, it is ignored. If it starts with an alphanumeric character, a leading
23624 colon is inserted; this default has not proven to be the path that popular
23625 maildir implementations have chosen (but changing it in Exim would break
23626 backwards compatibility).
23627
23628 For one common implementation, you might set:
23629 .code
23630 maildir_tag = ,S=${message_size}
23631 .endd
23632 but you should check the documentation of the other software to be sure.
23633
23634 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23635 as this allows Exim to extract the size from your tag, instead of having to
23636 &[stat()]& each message file.
23637
23638
23639 .section "Using a maildirsize file" "SECID136"
23640 .cindex "quota" "in maildir delivery"
23641 .cindex "maildir format" "&_maildirsize_& file"
23642 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23643 storing quota and message size information in a file called &_maildirsize_&
23644 within the toplevel maildir directory. If this file does not exist, Exim
23645 creates it, setting the quota from the &%quota%& option of the transport. If
23646 the maildir directory itself does not exist, it is created before any attempt
23647 to write a &_maildirsize_& file.
23648
23649 The &_maildirsize_& file is used to hold information about the sizes of
23650 messages in the maildir, thus speeding up quota calculations. The quota value
23651 in the file is just a cache; if the quota is changed in the transport, the new
23652 value overrides the cached value when the next message is delivered. The cache
23653 is maintained for the benefit of other programs that access the maildir and
23654 need to know the quota.
23655
23656 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23657 file is maintained (with a zero quota setting), but no quota is imposed.
23658
23659 A regular expression is available for controlling which directories in the
23660 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23661 See the description of the &%maildir_quota_directory_regex%& option above for
23662 details.
23663
23664
23665 .section "Mailstore delivery" "SECID137"
23666 .cindex "mailstore format" "description of"
23667 If the &%mailstore_format%& option is true, each message is written as two
23668 files in the given directory. A unique base name is constructed from the
23669 message id and the current delivery process, and the files that are written use
23670 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23671 contains the message's envelope, and the &_.msg_& file contains the message
23672 itself. The base name is placed in the variable &$mailstore_basename$&.
23673
23674 During delivery, the envelope is first written to a file with the suffix
23675 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23676 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23677 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23678 file before accessing either of them. An alternative approach is to wait for
23679 the absence of a &_.tmp_& file.
23680
23681 The envelope file starts with any text defined by the &%mailstore_prefix%&
23682 option, expanded and terminated by a newline if there isn't one. Then follows
23683 the sender address on one line, then all the recipient addresses, one per line.
23684 There can be more than one recipient only if the &%batch_max%& option is set
23685 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23686 appended to the file, followed by a newline if it does not end with one.
23687
23688 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23689 failure, it is ignored. Other expansion errors are treated as serious
23690 configuration errors, and delivery is deferred. The variable
23691 &$mailstore_basename$& is available for use during these expansions.
23692
23693
23694 .section "Non-special new file delivery" "SECID138"
23695 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23696 file is created directly in the named directory. For example, when delivering
23697 messages into files in batched SMTP format for later delivery to some host (see
23698 section &<<SECTbatchSMTP>>&), a setting such as
23699 .code
23700 directory = /var/bsmtp/$host
23701 .endd
23702 might be used. A message is written to a file with a temporary name, which is
23703 then renamed when the delivery is complete. The final name is obtained by
23704 expanding the contents of the &%directory_file%& option.
23705 .ecindex IIDapptra1
23706 .ecindex IIDapptra2
23707
23708
23709
23710
23711
23712
23713 . ////////////////////////////////////////////////////////////////////////////
23714 . ////////////////////////////////////////////////////////////////////////////
23715
23716 .chapter "The autoreply transport" "CHID8"
23717 .scindex IIDauttra1 "transports" "&(autoreply)&"
23718 .scindex IIDauttra2 "&(autoreply)& transport"
23719 The &(autoreply)& transport is not a true transport in that it does not cause
23720 the message to be transmitted. Instead, it generates a new mail message as an
23721 automatic reply to the incoming message. &'References:'& and
23722 &'Auto-Submitted:'& header lines are included. These are constructed according
23723 to the rules in RFCs 2822 and 3834, respectively.
23724
23725 If the router that passes the message to this transport does not have the
23726 &%unseen%& option set, the original message (for the current recipient) is not
23727 delivered anywhere. However, when the &%unseen%& option is set on the router
23728 that passes the message to this transport, routing of the address continues, so
23729 another router can set up a normal message delivery.
23730
23731
23732 The &(autoreply)& transport is usually run as the result of mail filtering, a
23733 &"vacation"& message being the standard example. However, it can also be run
23734 directly from a router like any other transport. To reduce the possibility of
23735 message cascades, messages created by the &(autoreply)& transport always have
23736 empty envelope sender addresses, like bounce messages.
23737
23738 The parameters of the message to be sent can be specified in the configuration
23739 by options described below. However, these are used only when the address
23740 passed to the transport does not contain its own reply information. When the
23741 transport is run as a consequence of a
23742 &%mail%&
23743 or &%vacation%& command in a filter file, the parameters of the message are
23744 supplied by the filter, and passed with the address. The transport's options
23745 that define the message are then ignored (so they are not usually set in this
23746 case). The message is specified entirely by the filter or by the transport; it
23747 is never built from a mixture of options. However, the &%file_optional%&,
23748 &%mode%&, and &%return_message%& options apply in all cases.
23749
23750 &(Autoreply)& is implemented as a local transport. When used as a result of a
23751 command in a user's filter file, &(autoreply)& normally runs under the uid and
23752 gid of the user, and with appropriate current and home directories (see chapter
23753 &<<CHAPenvironment>>&).
23754
23755 There is a subtle difference between routing a message to a &(pipe)& transport
23756 that generates some text to be returned to the sender, and routing it to an
23757 &(autoreply)& transport. This difference is noticeable only if more than one
23758 address from the same message is so handled. In the case of a pipe, the
23759 separate outputs from the different addresses are gathered up and returned to
23760 the sender in a single message, whereas if &(autoreply)& is used, a separate
23761 message is generated for each address that is passed to it.
23762
23763 Non-printing characters are not permitted in the header lines generated for the
23764 message that &(autoreply)& creates, with the exception of newlines that are
23765 immediately followed by white space. If any non-printing characters are found,
23766 the transport defers.
23767 Whether characters with the top bit set count as printing characters or not is
23768 controlled by the &%print_topbitchars%& global option.
23769
23770 If any of the generic options for manipulating headers (for example,
23771 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23772 of the original message that is included in the generated message when
23773 &%return_message%& is set. They do not apply to the generated message itself.
23774
23775 .vindex "&$sender_address$&"
23776 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23777 the message, indicating that there were no recipients, it does not treat this
23778 as an error. This means that autoreplies sent to &$sender_address$& when this
23779 is empty (because the incoming message is a bounce message) do not cause
23780 problems. They are just discarded.
23781
23782
23783
23784 .section "Private options for autoreply" "SECID139"
23785 .cindex "options" "&(autoreply)& transport"
23786
23787 .option bcc autoreply string&!! unset
23788 This specifies the addresses that are to receive &"blind carbon copies"& of the
23789 message when the message is specified by the transport.
23790
23791
23792 .option cc autoreply string&!! unset
23793 This specifies recipients of the message and the contents of the &'Cc:'& header
23794 when the message is specified by the transport.
23795
23796
23797 .option file autoreply string&!! unset
23798 The contents of the file are sent as the body of the message when the message
23799 is specified by the transport. If both &%file%& and &%text%& are set, the text
23800 string comes first.
23801
23802
23803 .option file_expand autoreply boolean false
23804 If this is set, the contents of the file named by the &%file%& option are
23805 subjected to string expansion as they are added to the message.
23806
23807
23808 .option file_optional autoreply boolean false
23809 If this option is true, no error is generated if the file named by the &%file%&
23810 option or passed with the address does not exist or cannot be read.
23811
23812
23813 .option from autoreply string&!! unset
23814 This specifies the contents of the &'From:'& header when the message is
23815 specified by the transport.
23816
23817
23818 .option headers autoreply string&!! unset
23819 This specifies additional RFC 2822 headers that are to be added to the message
23820 when the message is specified by the transport. Several can be given by using
23821 &"\n"& to separate them. There is no check on the format.
23822
23823
23824 .option log autoreply string&!! unset
23825 This option names a file in which a record of every message sent is logged when
23826 the message is specified by the transport.
23827
23828
23829 .option mode autoreply "octal integer" 0600
23830 If either the log file or the &"once"& file has to be created, this mode is
23831 used.
23832
23833
23834 .option never_mail autoreply "address list&!!" unset
23835 If any run of the transport creates a message with a recipient that matches any
23836 item in the list, that recipient is quietly discarded. If all recipients are
23837 discarded, no message is created. This applies both when the recipients are
23838 generated by a filter and when they are specified in the transport.
23839
23840
23841
23842 .option once autoreply string&!! unset
23843 This option names a file or DBM database in which a record of each &'To:'&
23844 recipient is kept when the message is specified by the transport. &*Note*&:
23845 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23846
23847 If &%once%& is unset, or is set to an empty string, the message is always sent.
23848 By default, if &%once%& is set to a non-empty filename, the message
23849 is not sent if a potential recipient is already listed in the database.
23850 However, if the &%once_repeat%& option specifies a time greater than zero, the
23851 message is sent if that much time has elapsed since a message was last sent to
23852 this recipient. A setting of zero time for &%once_repeat%& (the default)
23853 prevents a message from being sent a second time &-- in this case, zero means
23854 infinity.
23855
23856 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23857 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23858 greater than zero, it changes the way Exim implements the &%once%& option.
23859 Instead of using a DBM file to record every recipient it sends to, it uses a
23860 regular file, whose size will never get larger than the given value.
23861
23862 In the file, Exim keeps a linear list of recipient addresses and the times at
23863 which they were sent messages. If the file is full when a new address needs to
23864 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23865 means that a given recipient may receive multiple messages, but at
23866 unpredictable intervals that depend on the rate of turnover of addresses in the
23867 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23868
23869
23870 .option once_file_size autoreply integer 0
23871 See &%once%& above.
23872
23873
23874 .option once_repeat autoreply time&!! 0s
23875 See &%once%& above.
23876 After expansion, the value of this option must be a valid time value.
23877
23878
23879 .option reply_to autoreply string&!! unset
23880 This specifies the contents of the &'Reply-To:'& header when the message is
23881 specified by the transport.
23882
23883
23884 .option return_message autoreply boolean false
23885 If this is set, a copy of the original message is returned with the new
23886 message, subject to the maximum size set in the &%return_size_limit%& global
23887 configuration option.
23888
23889
23890 .option subject autoreply string&!! unset
23891 This specifies the contents of the &'Subject:'& header when the message is
23892 specified by the transport. It is tempting to quote the original subject in
23893 automatic responses. For example:
23894 .code
23895 subject = Re: $h_subject:
23896 .endd
23897 There is a danger in doing this, however. It may allow a third party to
23898 subscribe your users to an opt-in mailing list, provided that the list accepts
23899 bounce messages as subscription confirmations. Well-managed lists require a
23900 non-bounce message to confirm a subscription, so the danger is relatively
23901 small.
23902
23903
23904
23905 .option text autoreply string&!! unset
23906 This specifies a single string to be used as the body of the message when the
23907 message is specified by the transport. If both &%text%& and &%file%& are set,
23908 the text comes first.
23909
23910
23911 .option to autoreply string&!! unset
23912 This specifies recipients of the message and the contents of the &'To:'& header
23913 when the message is specified by the transport.
23914 .ecindex IIDauttra1
23915 .ecindex IIDauttra2
23916
23917
23918
23919
23920 . ////////////////////////////////////////////////////////////////////////////
23921 . ////////////////////////////////////////////////////////////////////////////
23922
23923 .chapter "The lmtp transport" "CHAPLMTP"
23924 .cindex "transports" "&(lmtp)&"
23925 .cindex "&(lmtp)& transport"
23926 .cindex "LMTP" "over a pipe"
23927 .cindex "LMTP" "over a socket"
23928 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23929 specified command
23930 or by interacting with a Unix domain socket.
23931 This transport is something of a cross between the &(pipe)& and &(smtp)&
23932 transports. Exim also has support for using LMTP over TCP/IP; this is
23933 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23934 to be of minority interest, the default build-time configure in &_src/EDITME_&
23935 has it commented out. You need to ensure that
23936 .code
23937 TRANSPORT_LMTP=yes
23938 .endd
23939 .cindex "options" "&(lmtp)& transport"
23940 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23941 included in the Exim binary. The private options of the &(lmtp)& transport are
23942 as follows:
23943
23944 .option batch_id lmtp string&!! unset
23945 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23946
23947
23948 .option batch_max lmtp integer 1
23949 This limits the number of addresses that can be handled in a single delivery.
23950 Most LMTP servers can handle several addresses at once, so it is normally a
23951 good idea to increase this value. See the description of local delivery
23952 batching in chapter &<<CHAPbatching>>&.
23953
23954
23955 .option command lmtp string&!! unset
23956 This option must be set if &%socket%& is not set. The string is a command which
23957 is run in a separate process. It is split up into a command name and list of
23958 arguments, each of which is separately expanded (so expansion cannot change the
23959 number of arguments). The command is run directly, not via a shell. The message
23960 is passed to the new process using the standard input and output to operate the
23961 LMTP protocol.
23962
23963 .option ignore_quota lmtp boolean false
23964 .cindex "LMTP" "ignoring quota errors"
23965 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23966 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23967 in its response to the LHLO command.
23968
23969 .option socket lmtp string&!! unset
23970 This option must be set if &%command%& is not set. The result of expansion must
23971 be the name of a Unix domain socket. The transport connects to the socket and
23972 delivers the message to it using the LMTP protocol.
23973
23974
23975 .option timeout lmtp time 5m
23976 The transport is aborted if the created process or Unix domain socket does not
23977 respond to LMTP commands or message input within this timeout. Delivery
23978 is deferred, and will be tried again later. Here is an example of a typical
23979 LMTP transport:
23980 .code
23981 lmtp:
23982   driver = lmtp
23983   command = /some/local/lmtp/delivery/program
23984   batch_max = 20
23985   user = exim
23986 .endd
23987 This delivers up to 20 addresses at a time, in a mixture of domains if
23988 necessary, running as the user &'exim'&.
23989
23990
23991
23992 . ////////////////////////////////////////////////////////////////////////////
23993 . ////////////////////////////////////////////////////////////////////////////
23994
23995 .chapter "The pipe transport" "CHAPpipetransport"
23996 .scindex IIDpiptra1 "transports" "&(pipe)&"
23997 .scindex IIDpiptra2 "&(pipe)& transport"
23998 The &(pipe)& transport is used to deliver messages via a pipe to a command
23999 running in another process. One example is the use of &(pipe)& as a
24000 pseudo-remote transport for passing messages to some other delivery mechanism
24001 (such as UUCP). Another is the use by individual users to automatically process
24002 their incoming messages. The &(pipe)& transport can be used in one of the
24003 following ways:
24004
24005 .ilist
24006 .vindex "&$local_part$&"
24007 A router routes one address to a transport in the normal way, and the
24008 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24009 contains the local part of the address (as usual), and the command that is run
24010 is specified by the &%command%& option on the transport.
24011 .next
24012 .vindex "&$pipe_addresses$&"
24013 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24014 transport can handle more than one address in a single run. In this case, when
24015 more than one address is routed to the transport, &$local_part$& is not set
24016 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24017 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24018 that are routed to the transport.
24019 .next
24020 .vindex "&$address_pipe$&"
24021 A router redirects an address directly to a pipe command (for example, from an
24022 alias or forward file). In this case, &$address_pipe$& contains the text of the
24023 pipe command, and the &%command%& option on the transport is ignored unless
24024 &%force_command%& is set. If only one address is being transported
24025 (&%batch_max%& is not greater than one, or only one address was redirected to
24026 this pipe command), &$local_part$& contains the local part that was redirected.
24027 .endlist
24028
24029
24030 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24031 deliver messages over pipes using the LMTP interactive protocol. This is
24032 implemented by the &(lmtp)& transport.
24033
24034 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24035 &_.forward_& file, the command runs under the uid and gid of that user. In
24036 other cases, the uid and gid have to be specified explicitly, either on the
24037 transport or on the router that handles the address. Current and &"home"&
24038 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24039 details of the local delivery environment and chapter &<<CHAPbatching>>&
24040 for a discussion of local delivery batching.
24041
24042 .new
24043 .cindex "tainted data" "in pipe command"
24044 .cindex pipe "tainted data"
24045 Tainted data may not be used for the command name.
24046 .wen
24047
24048
24049 .section "Concurrent delivery" "SECID140"
24050 If two messages arrive at almost the same time, and both are routed to a pipe
24051 delivery, the two pipe transports may be run concurrently. You must ensure that
24052 any pipe commands you set up are robust against this happening. If the commands
24053 write to a file, the &%exim_lock%& utility might be of use.
24054 Alternatively the &%max_parallel%& option could be used with a value
24055 of "1" to enforce serialization.
24056
24057
24058
24059
24060 .section "Returned status and data" "SECID141"
24061 .cindex "&(pipe)& transport" "returned data"
24062 If the command exits with a non-zero return code, the delivery is deemed to
24063 have failed, unless either the &%ignore_status%& option is set (in which case
24064 the return code is treated as zero), or the return code is one of those listed
24065 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24066 later"&. In this case, delivery is deferred. Details of a permanent failure are
24067 logged, but are not included in the bounce message, which merely contains
24068 &"local delivery failed"&.
24069
24070 If the command exits on a signal and the &%freeze_signal%& option is set then
24071 the message will be frozen in the queue. If that option is not set, a bounce
24072 will be sent as normal.
24073
24074 If the return code is greater than 128 and the command being run is a shell
24075 script, it normally means that the script was terminated by a signal whose
24076 value is the return code minus 128. The &%freeze_signal%& option does not
24077 apply in this case.
24078
24079 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24080 return code is set to 127. This is the value that a shell returns if it is
24081 asked to run a non-existent command. The wording for the log line suggests that
24082 a non-existent command may be the problem.
24083
24084 The &%return_output%& option can affect the result of a pipe delivery. If it is
24085 set and the command produces any output on its standard output or standard
24086 error streams, the command is considered to have failed, even if it gave a zero
24087 return code or if &%ignore_status%& is set. The output from the command is
24088 included as part of the bounce message. The &%return_fail_output%& option is
24089 similar, except that output is returned only when the command exits with a
24090 failure return code, that is, a value other than zero or a code that matches
24091 &%temp_errors%&.
24092
24093
24094
24095 .section "How the command is run" "SECThowcommandrun"
24096 .cindex "&(pipe)& transport" "path for command"
24097 The command line is (by default) broken down into a command name and arguments
24098 by the &(pipe)& transport itself. The &%allow_commands%& and
24099 &%restrict_to_path%& options can be used to restrict the commands that may be
24100 run.
24101
24102 .cindex "quoting" "in pipe command"
24103 Unquoted arguments are delimited by white space. If an argument appears in
24104 double quotes, backslash is interpreted as an escape character in the usual
24105 way. If an argument appears in single quotes, no escaping is done.
24106
24107 String expansion is applied to the command line except when it comes from a
24108 traditional &_.forward_& file (commands from a filter file are expanded). The
24109 expansion is applied to each argument in turn rather than to the whole line.
24110 For this reason, any string expansion item that contains white space must be
24111 quoted so as to be contained within a single argument. A setting such as
24112 .code
24113 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24114 .endd
24115 will not work, because the expansion item gets split between several
24116 arguments. You have to write
24117 .code
24118 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24119 .endd
24120 to ensure that it is all in one argument. The expansion is done in this way,
24121 argument by argument, so that the number of arguments cannot be changed as a
24122 result of expansion, and quotes or backslashes in inserted variables do not
24123 interact with external quoting. However, this leads to problems if you want to
24124 generate multiple arguments (or the command name plus arguments) from a single
24125 expansion. In this situation, the simplest solution is to use a shell. For
24126 example:
24127 .code
24128 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24129 .endd
24130
24131 .cindex "transport" "filter"
24132 .cindex "filter" "transport filter"
24133 .vindex "&$pipe_addresses$&"
24134 Special handling takes place when an argument consists of precisely the text
24135 &`$pipe_addresses`& (no quotes).
24136 This is not a general expansion variable; the only
24137 place this string is recognized is when it appears as an argument for a pipe or
24138 transport filter command. It causes each address that is being handled to be
24139 inserted in the argument list at that point &'as a separate argument'&. This
24140 avoids any problems with spaces or shell metacharacters, and is of use when a
24141 &(pipe)& transport is handling groups of addresses in a batch.
24142
24143 If &%force_command%& is enabled on the transport, special handling takes place
24144 for an argument that consists of precisely the text &`$address_pipe`&.  It
24145 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24146 argument is inserted in the argument list at that point
24147 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24148 the only item in the argument; in fact, if it were then &%force_command%&
24149 should behave as a no-op.  Rather, it should be used to adjust the command
24150 run while preserving the argument vector separation.
24151
24152 After splitting up into arguments and expansion, the resulting command is run
24153 in a subprocess directly from the transport, &'not'& under a shell. The
24154 message that is being delivered is supplied on the standard input, and the
24155 standard output and standard error are both connected to a single pipe that is
24156 read by Exim. The &%max_output%& option controls how much output the command
24157 may produce, and the &%return_output%& and &%return_fail_output%& options
24158 control what is done with it.
24159
24160 Not running the command under a shell (by default) lessens the security risks
24161 in cases when a command from a user's filter file is built out of data that was
24162 taken from an incoming message. If a shell is required, it can of course be
24163 explicitly specified as the command to be run. However, there are circumstances
24164 where existing commands (for example, in &_.forward_& files) expect to be run
24165 under a shell and cannot easily be modified. To allow for these cases, there is
24166 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24167 works. Instead of breaking up the command line as just described, it expands it
24168 as a single string and passes the result to &_/bin/sh_&. The
24169 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24170 with &%use_shell%&, and the whole mechanism is inherently less secure.
24171
24172
24173
24174 .section "Environment variables" "SECTpipeenv"
24175 .cindex "&(pipe)& transport" "environment for command"
24176 .cindex "environment" "&(pipe)& transport"
24177 The environment variables listed below are set up when the command is invoked.
24178 This list is a compromise for maximum compatibility with other MTAs. Note that
24179 the &%environment%& option can be used to add additional variables to this
24180 environment. The environment for the &(pipe)& transport is not subject
24181 to the &%add_environment%& and &%keep_environment%& main config options.
24182 .display
24183 &`DOMAIN            `&   the domain of the address
24184 &`HOME              `&   the home directory, if set
24185 &`HOST              `&   the host name when called from a router (see below)
24186 &`LOCAL_PART        `&   see below
24187 &`LOCAL_PART_PREFIX `&   see below
24188 &`LOCAL_PART_SUFFIX `&   see below
24189 &`LOGNAME           `&   see below
24190 &`MESSAGE_ID        `&   Exim's local ID for the message
24191 &`PATH              `&   as specified by the &%path%& option below
24192 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24193 &`RECIPIENT         `&   the complete recipient address
24194 &`SENDER            `&   the sender of the message (empty if a bounce)
24195 &`SHELL             `&   &`/bin/sh`&
24196 &`TZ                `&   the value of the &%timezone%& option, if set
24197 &`USER              `&   see below
24198 .endd
24199 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24200 router, LOCAL_PART is set to the local part of the address. When it is
24201 called as a result of a forward or alias expansion, LOCAL_PART is set to
24202 the local part of the address that was expanded. In both cases, any affixes are
24203 removed from the local part, and made available in LOCAL_PART_PREFIX and
24204 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24205 same value as LOCAL_PART for compatibility with other MTAs.
24206
24207 .cindex "HOST"
24208 HOST is set only when a &(pipe)& transport is called from a router that
24209 associates hosts with an address, typically when using &(pipe)& as a
24210 pseudo-remote transport. HOST is set to the first host name specified by
24211 the router.
24212
24213 .cindex "HOME"
24214 If the transport's generic &%home_directory%& option is set, its value is used
24215 for the HOME environment variable. Otherwise, a home directory may be set
24216 by the router's &%transport_home_directory%& option, which defaults to the
24217 user's home directory if &%check_local_user%& is set.
24218
24219
24220 .section "Private options for pipe" "SECID142"
24221 .cindex "options" "&(pipe)& transport"
24222
24223
24224
24225 .option allow_commands pipe "string list&!!" unset
24226 .cindex "&(pipe)& transport" "permitted commands"
24227 The string is expanded, and is then interpreted as a colon-separated list of
24228 permitted commands. If &%restrict_to_path%& is not set, the only commands
24229 permitted are those in the &%allow_commands%& list. They need not be absolute
24230 paths; the &%path%& option is still used for relative paths. If
24231 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24232 in the &%allow_commands%& list, or a name without any slashes that is found on
24233 the path. In other words, if neither &%allow_commands%& nor
24234 &%restrict_to_path%& is set, there is no restriction on the command, but
24235 otherwise only commands that are permitted by one or the other are allowed. For
24236 example, if
24237 .code
24238 allow_commands = /usr/bin/vacation
24239 .endd
24240 and &%restrict_to_path%& is not set, the only permitted command is
24241 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24242 &%use_shell%& is set.
24243
24244
24245 .option batch_id pipe string&!! unset
24246 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24247
24248
24249 .option batch_max pipe integer 1
24250 This limits the number of addresses that can be handled in a single delivery.
24251 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24252
24253
24254 .option check_string pipe string unset
24255 As &(pipe)& writes the message, the start of each line is tested for matching
24256 &%check_string%&, and if it does, the initial matching characters are replaced
24257 by the contents of &%escape_string%&, provided both are set. The value of
24258 &%check_string%& is a literal string, not a regular expression, and the case of
24259 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24260 of &%check_string%& and &%escape_string%& are forced to values that implement
24261 the SMTP escaping protocol. Any settings made in the configuration file are
24262 ignored.
24263
24264
24265 .option command pipe string&!! unset
24266 This option need not be set when &(pipe)& is being used to deliver to pipes
24267 obtained directly from address redirections. In other cases, the option must be
24268 set, to provide a command to be run. It need not yield an absolute path (see
24269 the &%path%& option below). The command is split up into separate arguments by
24270 Exim, and each argument is separately expanded, as described in section
24271 &<<SECThowcommandrun>>& above.
24272
24273
24274 .option environment pipe string&!! unset
24275 .cindex "&(pipe)& transport" "environment for command"
24276 .cindex "environment" "&(pipe)& transport"
24277 This option is used to add additional variables to the environment in which the
24278 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24279 a string which is expanded, and then interpreted as a colon-separated list of
24280 environment settings of the form <&'name'&>=<&'value'&>.
24281
24282
24283 .option escape_string pipe string unset
24284 See &%check_string%& above.
24285
24286
24287 .option freeze_exec_fail pipe boolean false
24288 .cindex "exec failure"
24289 .cindex "failure of exec"
24290 .cindex "&(pipe)& transport" "failure of exec"
24291 Failure to exec the command in a pipe transport is by default treated like
24292 any other failure while running the command. However, if &%freeze_exec_fail%&
24293 is set, failure to exec is treated specially, and causes the message to be
24294 frozen, whatever the setting of &%ignore_status%&.
24295
24296
24297 .option freeze_signal pipe boolean false
24298 .cindex "signal exit"
24299 .cindex "&(pipe)& transport", "signal exit"
24300 Normally if the process run by a command in a pipe transport exits on a signal,
24301 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24302 frozen in Exim's queue instead.
24303
24304
24305 .option force_command pipe boolean false
24306 .cindex "force command"
24307 .cindex "&(pipe)& transport", "force command"
24308 Normally when a router redirects an address directly to a pipe command
24309 the &%command%& option on the transport is ignored.  If &%force_command%&
24310 is set, the &%command%& option will used. This is especially
24311 useful for forcing a wrapper or additional argument to be added to the
24312 command. For example:
24313 .code
24314 command = /usr/bin/remote_exec myhost -- $address_pipe
24315 force_command
24316 .endd
24317
24318 Note that &$address_pipe$& is handled specially in &%command%& when
24319 &%force_command%& is set, expanding out to the original argument vector as
24320 separate items, similarly to a Unix shell &`"$@"`& construct.
24321
24322
24323 .option ignore_status pipe boolean false
24324 If this option is true, the status returned by the subprocess that is set up to
24325 run the command is ignored, and Exim behaves as if zero had been returned.
24326 Otherwise, a non-zero status or termination by signal causes an error return
24327 from the transport unless the status value is one of those listed in
24328 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24329
24330 &*Note*&: This option does not apply to timeouts, which do not return a status.
24331 See the &%timeout_defer%& option for how timeouts are handled.
24332
24333
24334 .option log_defer_output pipe boolean false
24335 .cindex "&(pipe)& transport" "logging output"
24336 If this option is set, and the status returned by the command is
24337 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24338 and any output was produced on stdout or stderr, the first line of it is
24339 written to the main log.
24340
24341
24342 .option log_fail_output pipe boolean false
24343 If this option is set, and the command returns any output on stdout or
24344 stderr, and also ends with a return code that is neither zero nor one of
24345 the return codes listed in &%temp_errors%& (that is, the delivery
24346 failed), the first line of output is written to the main log. This
24347 option and &%log_output%& are mutually exclusive.  Only one of them may
24348 be set.
24349
24350
24351 .option log_output pipe boolean false
24352 If this option is set and the command returns any output on stdout or
24353 stderr, the first line of output is written to the main log, whatever
24354 the return code. This option and &%log_fail_output%& are mutually
24355 exclusive. Only one of them may be set.
24356
24357
24358 .option max_output pipe integer 20K
24359 This specifies the maximum amount of output that the command may produce on its
24360 standard output and standard error file combined. If the limit is exceeded, the
24361 process running the command is killed. This is intended as a safety measure to
24362 catch runaway processes. The limit is applied independently of the settings of
24363 the options that control what is done with such output (for example,
24364 &%return_output%&). Because of buffering effects, the amount of output may
24365 exceed the limit by a small amount before Exim notices.
24366
24367
24368 .option message_prefix pipe string&!! "see below"
24369 The string specified here is expanded and output at the start of every message.
24370 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24371 .code
24372 message_prefix = \
24373   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24374   ${tod_bsdinbox}\n
24375 .endd
24376 .cindex "Cyrus"
24377 .cindex "&%tmail%&"
24378 .cindex "&""From""& line"
24379 This is required by the commonly used &_/usr/bin/vacation_& program.
24380 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24381 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24382 setting
24383 .code
24384 message_prefix =
24385 .endd
24386 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24387 &`\n`& to &`\r\n`& in &%message_prefix%&.
24388
24389
24390 .option message_suffix pipe string&!! "see below"
24391 The string specified here is expanded and output at the end of every message.
24392 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24393 The suffix can be suppressed by setting
24394 .code
24395 message_suffix =
24396 .endd
24397 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24398 &`\n`& to &`\r\n`& in &%message_suffix%&.
24399
24400
24401 .option path pipe string&!! "/bin:/usr/bin"
24402 This option is expanded and
24403 specifies the string that is set up in the PATH environment
24404 variable of the subprocess.
24405 If the &%command%& option does not yield an absolute path name, the command is
24406 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24407 apply to a command specified as a transport filter.
24408
24409
24410 .option permit_coredump pipe boolean false
24411 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24412 a core-dump of a pipe command, enable this command.  This enables core-dumps
24413 during delivery and affects both the Exim binary and the pipe command run.
24414 It is recommended that this option remain off unless and until you have a need
24415 for it and that this only be enabled when needed, as the risk of excessive
24416 resource consumption can be quite high.  Note also that Exim is typically
24417 installed as a setuid binary and most operating systems will inhibit coredumps
24418 of these by default, so further OS-specific action may be required.
24419
24420
24421 .option pipe_as_creator pipe boolean false
24422 .cindex "uid (user id)" "local delivery"
24423 If the generic &%user%& option is not set and this option is true, the delivery
24424 process is run under the uid that was in force when Exim was originally called
24425 to accept the message. If the group id is not otherwise set (via the generic
24426 &%group%& option), the gid that was in force when Exim was originally called to
24427 accept the message is used.
24428
24429
24430 .option restrict_to_path pipe boolean false
24431 When this option is set, any command name not listed in &%allow_commands%& must
24432 contain no slashes. The command is searched for only in the directories listed
24433 in the &%path%& option. This option is intended for use in the case when a pipe
24434 command has been generated from a user's &_.forward_& file. This is usually
24435 handled by a &(pipe)& transport called &%address_pipe%&.
24436
24437
24438 .option return_fail_output pipe boolean false
24439 If this option is true, and the command produced any output and ended with a
24440 return code other than zero or one of the codes listed in &%temp_errors%& (that
24441 is, the delivery failed), the output is returned in the bounce message.
24442 However, if the message has a null sender (that is, it is itself a bounce
24443 message), output from the command is discarded. This option and
24444 &%return_output%& are mutually exclusive. Only one of them may be set.
24445
24446
24447
24448 .option return_output pipe boolean false
24449 If this option is true, and the command produced any output, the delivery is
24450 deemed to have failed whatever the return code from the command, and the output
24451 is returned in the bounce message. Otherwise, the output is just discarded.
24452 However, if the message has a null sender (that is, it is a bounce message),
24453 output from the command is always discarded, whatever the setting of this
24454 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24455 of them may be set.
24456
24457
24458
24459 .option temp_errors pipe "string list" "see below"
24460 .cindex "&(pipe)& transport" "temporary failure"
24461 This option contains either a colon-separated list of numbers, or a single
24462 asterisk. If &%ignore_status%& is false
24463 and &%return_output%& is not set,
24464 and the command exits with a non-zero return code, the failure is treated as
24465 temporary and the delivery is deferred if the return code matches one of the
24466 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24467 codes are treated as permanent errors. The default setting contains the codes
24468 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24469 compiled on a system that does not define these macros, it assumes values of 75
24470 and 73, respectively.
24471
24472
24473 .option timeout pipe time 1h
24474 If the command fails to complete within this time, it is killed. This normally
24475 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24476 specifies no timeout. In order to ensure that any subprocesses created by the
24477 command are also killed, Exim makes the initial process a process group leader,
24478 and kills the whole process group on a timeout. However, this can be defeated
24479 if one of the processes starts a new process group.
24480
24481 .option timeout_defer pipe boolean false
24482 A timeout in a &(pipe)& transport, either in the command that the transport
24483 runs, or in a transport filter that is associated with it, is by default
24484 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24485 is set true, both kinds of timeout become temporary errors, causing the
24486 delivery to be deferred.
24487
24488 .option umask pipe "octal integer" 022
24489 This specifies the umask setting for the subprocess that runs the command.
24490
24491
24492 .option use_bsmtp pipe boolean false
24493 .cindex "envelope sender"
24494 If this option is set true, the &(pipe)& transport writes messages in &"batch
24495 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24496 commands. If you want to include a leading HELO command with such messages,
24497 you can do so by setting the &%message_prefix%& option. See section
24498 &<<SECTbatchSMTP>>& for details of batch SMTP.
24499
24500 .option use_classresources pipe boolean false
24501 .cindex "class resources (BSD)"
24502 This option is available only when Exim is running on FreeBSD, NetBSD, or
24503 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24504 resource limits when a &(pipe)& transport is run to perform a delivery. The
24505 limits for the uid under which the pipe is to run are obtained from the login
24506 class database.
24507
24508
24509 .option use_crlf pipe boolean false
24510 .cindex "carriage return"
24511 .cindex "linefeed"
24512 This option causes lines to be terminated with the two-character CRLF sequence
24513 (carriage return, linefeed) instead of just a linefeed character. In the case
24514 of batched SMTP, the byte sequence written to the pipe is then an exact image
24515 of what would be sent down a real SMTP connection.
24516
24517 The contents of the &%message_prefix%& and &%message_suffix%& options are
24518 written verbatim, so must contain their own carriage return characters if these
24519 are needed. When &%use_bsmtp%& is not set, the default values for both
24520 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24521 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24522
24523
24524 .option use_shell pipe boolean false
24525 .vindex "&$pipe_addresses$&"
24526 If this option is set, it causes the command to be passed to &_/bin/sh_&
24527 instead of being run directly from the transport, as described in section
24528 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24529 where the command is expected to be run under a shell and cannot easily be
24530 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24531 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24532 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24533 its &%-c%& option.
24534
24535
24536
24537 .section "Using an external local delivery agent" "SECID143"
24538 .cindex "local delivery" "using an external agent"
24539 .cindex "&'procmail'&"
24540 .cindex "external local delivery"
24541 .cindex "delivery" "&'procmail'&"
24542 .cindex "delivery" "by external agent"
24543 The &(pipe)& transport can be used to pass all messages that require local
24544 delivery to a separate local delivery agent such as &%procmail%&. When doing
24545 this, care must be taken to ensure that the pipe is run under an appropriate
24546 uid and gid. In some configurations one wants this to be a uid that is trusted
24547 by the delivery agent to supply the correct sender of the message. It may be
24548 necessary to recompile or reconfigure the delivery agent so that it trusts an
24549 appropriate user. The following is an example transport and router
24550 configuration for &%procmail%&:
24551 .code
24552 # transport
24553 procmail_pipe:
24554   driver = pipe
24555   command = /usr/local/bin/procmail -d $local_part
24556   return_path_add
24557   delivery_date_add
24558   envelope_to_add
24559   check_string = "From "
24560   escape_string = ">From "
24561   umask = 077
24562   user = $local_part
24563   group = mail
24564
24565 # router
24566 procmail:
24567   driver = accept
24568   check_local_user
24569   transport = procmail_pipe
24570 .endd
24571 In this example, the pipe is run as the local user, but with the group set to
24572 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24573 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24574 user to supply a correct sender address. If you do not specify either a
24575 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24576 home directory is the user's home directory by default.
24577
24578 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24579 .code
24580 IFS=" "
24581 .endd
24582 as shown in some &%procmail%& documentation, because Exim does not by default
24583 use a shell to run pipe commands.
24584
24585 .cindex "Cyrus"
24586 The next example shows a transport and a router for a system where local
24587 deliveries are handled by the Cyrus IMAP server.
24588 .code
24589 # transport
24590 local_delivery_cyrus:
24591   driver = pipe
24592   command = /usr/cyrus/bin/deliver \
24593             -m ${substr_1:$local_part_suffix} -- $local_part
24594   user = cyrus
24595   group = mail
24596   return_output
24597   log_output
24598   message_prefix =
24599   message_suffix =
24600
24601 # router
24602 local_user_cyrus:
24603   driver = accept
24604   check_local_user
24605   local_part_suffix = .*
24606   transport = local_delivery_cyrus
24607 .endd
24608 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24609 &%return_output%& to cause any text written by Cyrus to be returned to the
24610 sender.
24611 .ecindex IIDpiptra1
24612 .ecindex IIDpiptra2
24613
24614
24615 . ////////////////////////////////////////////////////////////////////////////
24616 . ////////////////////////////////////////////////////////////////////////////
24617
24618 .chapter "The smtp transport" "CHAPsmtptrans"
24619 .scindex IIDsmttra1 "transports" "&(smtp)&"
24620 .scindex IIDsmttra2 "&(smtp)& transport"
24621 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24622 or LMTP protocol. The list of hosts to try can either be taken from the address
24623 that is being processed (having been set up by the router), or specified
24624 explicitly for the transport. Timeout and retry processing (see chapter
24625 &<<CHAPretry>>&) is applied to each IP address independently.
24626
24627
24628 .section "Multiple messages on a single connection" "SECID144"
24629 The sending of multiple messages over a single TCP/IP connection can arise in
24630 two ways:
24631
24632 .ilist
24633 If a message contains more than &%max_rcpt%& (see below) addresses that are
24634 routed to the same host, more than one copy of the message has to be sent to
24635 that host. In this situation, multiple copies may be sent in a single run of
24636 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24637 does when it has too many addresses to send in one message also depends on the
24638 value of the global &%remote_max_parallel%& option. Details are given in
24639 section &<<SECToutSMTPTCP>>&.)
24640 .next
24641 .cindex "hints database" "remembering routing"
24642 When a message has been successfully delivered over a TCP/IP connection, Exim
24643 looks in its hints database to see if there are any other messages awaiting a
24644 connection to the same host. If there are, a new delivery process is started
24645 for one of them, and the current TCP/IP connection is passed on to it. The new
24646 process may in turn send multiple copies and possibly create yet another
24647 process.
24648 .endlist
24649
24650
24651 For each copy sent over the same TCP/IP connection, a sequence counter is
24652 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24653 no further messages are sent over that connection.
24654
24655
24656
24657 .section "Use of the $host and $host_address variables" "SECID145"
24658 .vindex "&$host$&"
24659 .vindex "&$host_address$&"
24660 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24661 &$host_address$& are the name and IP address of the first host on the host list
24662 passed by the router. However, when the transport is about to connect to a
24663 specific host, and while it is connected to that host, &$host$& and
24664 &$host_address$& are set to the values for that host. These are the values
24665 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24666 &%serialize_hosts%&, and the various TLS options are expanded.
24667
24668
24669 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24670 .vindex &$tls_bits$&
24671 .vindex &$tls_cipher$&
24672 .vindex &$tls_peerdn$&
24673 .vindex &$tls_sni$&
24674 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24675 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24676 are the values that were set when the message was received.
24677 These are the values that are used for options that are expanded before any
24678 SMTP connections are made. Just before each connection is made, these four
24679 variables are emptied. If TLS is subsequently started, they are set to the
24680 appropriate values for the outgoing connection, and these are the values that
24681 are in force when any authenticators are run and when the
24682 &%authenticated_sender%& option is expanded.
24683
24684 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24685 and will be removed in a future release.
24686
24687
24688 .section "Private options for smtp" "SECID146"
24689 .cindex "options" "&(smtp)& transport"
24690 The private options of the &(smtp)& transport are as follows:
24691
24692
24693 .option address_retry_include_sender smtp boolean true
24694 .cindex "4&'xx'& responses" "retrying after"
24695 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24696 is the combination of sender and recipient that is delayed in subsequent queue
24697 runs until the retry time is reached. You can delay the recipient without
24698 reference to the sender (which is what earlier versions of Exim did), by
24699 setting &%address_retry_include_sender%& false. However, this can lead to
24700 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24701
24702 .option allow_localhost smtp boolean false
24703 .cindex "local host" "sending to"
24704 .cindex "fallback" "hosts specified on transport"
24705 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24706 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24707 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24708 the delivery anyway. This should be used only in special cases when the
24709 configuration ensures that no looping will result (for example, a differently
24710 configured Exim is listening on the port to which the message is sent).
24711
24712
24713 .option authenticated_sender smtp string&!! unset
24714 .cindex "Cyrus"
24715 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24716 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24717 overriding any existing authenticated sender value. If the string expansion is
24718 forced to fail, the option is ignored. Other expansion failures cause delivery
24719 to be deferred. If the result of expansion is an empty string, that is also
24720 ignored.
24721
24722 The expansion happens after the outgoing connection has been made and TLS
24723 started, if required. This means that the &$host$&, &$host_address$&,
24724 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24725 particular connection.
24726
24727 If the SMTP session is not authenticated, the expansion of
24728 &%authenticated_sender%& still happens (and can cause the delivery to be
24729 deferred if it fails), but no AUTH= item is added to MAIL commands
24730 unless &%authenticated_sender_force%& is true.
24731
24732 This option allows you to use the &(smtp)& transport in LMTP mode to
24733 deliver mail to Cyrus IMAP and provide the proper local part as the
24734 &"authenticated sender"&, via a setting such as:
24735 .code
24736 authenticated_sender = $local_part
24737 .endd
24738 This removes the need for IMAP subfolders to be assigned special ACLs to
24739 allow direct delivery to those subfolders.
24740
24741 Because of expected uses such as that just described for Cyrus (when no
24742 domain is involved), there is no checking on the syntax of the provided
24743 value.
24744
24745
24746 .option authenticated_sender_force smtp boolean false
24747 If this option is set true, the &%authenticated_sender%& option's value
24748 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24749 authenticated as a client.
24750
24751
24752 .option command_timeout smtp time 5m
24753 This sets a timeout for receiving a response to an SMTP command that has been
24754 sent out. It is also used when waiting for the initial banner line from the
24755 remote host. Its value must not be zero.
24756
24757
24758 .option connect_timeout smtp time 5m
24759 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24760 to a remote host. A setting of zero allows the system timeout (typically
24761 several minutes) to act. To have any effect, the value of this option must be
24762 less than the system timeout. However, it has been observed that on some
24763 systems there is no system timeout, which is why the default value for this
24764 option is 5 minutes, a value recommended by RFC 1123.
24765
24766
24767 .option connection_max_messages smtp integer 500
24768 .cindex "SMTP" "passed connection"
24769 .cindex "SMTP" "multiple deliveries"
24770 .cindex "multiple SMTP deliveries"
24771 This controls the maximum number of separate message deliveries that are sent
24772 over a single TCP/IP connection. If the value is zero, there is no limit.
24773 For testing purposes, this value can be overridden by the &%-oB%& command line
24774 option.
24775
24776
24777 .option dane_require_tls_ciphers smtp string&!! unset
24778 .cindex "TLS" "requiring specific ciphers for DANE"
24779 .cindex "cipher" "requiring specific"
24780 .cindex DANE "TLS ciphers"
24781 This option may be used to override &%tls_require_ciphers%& for connections
24782 where DANE has been determined to be in effect.
24783 If not set, then &%tls_require_ciphers%& will be used.
24784 Normal SMTP delivery is not able to make strong demands of TLS cipher
24785 configuration, because delivery will fall back to plaintext.  Once DANE has
24786 been determined to be in effect, there is no plaintext fallback and making the
24787 TLS cipherlist configuration stronger will increase security, rather than
24788 counter-intuitively decreasing it.
24789 If the option expands to be empty or is forced to fail, then it will
24790 be treated as unset and &%tls_require_ciphers%& will be used instead.
24791
24792
24793 .option data_timeout smtp time 5m
24794 This sets a timeout for the transmission of each block in the data portion of
24795 the message. As a result, the overall timeout for a message depends on the size
24796 of the message. Its value must not be zero. See also &%final_timeout%&.
24797
24798
24799 .option dkim_canon smtp string&!! unset
24800 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24801 .option dkim_domain smtp string list&!! unset
24802 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24803 .option dkim_hash smtp string&!! sha256
24804 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24805 .option dkim_identity smtp string&!! unset
24806 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24807 .option dkim_private_key smtp string&!! unset
24808 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24809 .option dkim_selector smtp string&!! unset
24810 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24811 .option dkim_strict smtp string&!! unset
24812 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24813 .option dkim_sign_headers smtp string&!! "per RFC"
24814 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24815 .option dkim_timestamps smtp string&!! unset
24816 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24817
24818
24819 .option delay_after_cutoff smtp boolean true
24820 .cindex "final cutoff" "retries, controlling"
24821 .cindex retry "final cutoff"
24822 This option controls what happens when all remote IP addresses for a given
24823 domain have been inaccessible for so long that they have passed their retry
24824 cutoff times.
24825
24826 In the default state, if the next retry time has not been reached for any of
24827 them, the address is bounced without trying any deliveries. In other words,
24828 Exim delays retrying an IP address after the final cutoff time until a new
24829 retry time is reached, and can therefore bounce an address without ever trying
24830 a delivery, when machines have been down for a long time. Some people are
24831 unhappy at this prospect, so...
24832
24833 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24834 addresses are past their final cutoff time, Exim tries to deliver to those
24835 IP addresses that have not been tried since the message arrived. If there are
24836 none, of if they all fail, the address is bounced. In other words, it does not
24837 delay when a new message arrives, but immediately tries those expired IP
24838 addresses that haven't been tried since the message arrived. If there is a
24839 continuous stream of messages for the dead hosts, unsetting
24840 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24841 to them.
24842
24843
24844 .option dns_qualify_single smtp boolean true
24845 If the &%hosts%& or &%fallback_hosts%& option is being used,
24846 and the &%gethostbyname%& option is false,
24847 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24848 in chapter &<<CHAPdnslookup>>& for more details.
24849
24850
24851 .option dns_search_parents smtp boolean false
24852 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24853 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24854 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24855 details.
24856
24857
24858 .option dnssec_request_domains smtp "domain list&!!" *
24859 .cindex "MX record" "security"
24860 .cindex "DNSSEC" "MX lookup"
24861 .cindex "security" "MX lookup"
24862 .cindex "DNS" "DNSSEC"
24863 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24864 the dnssec request bit set. Setting this transport option is only useful if the
24865 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24866 router option.
24867
24868
24869
24870 .option dnssec_require_domains smtp "domain list&!!" unset
24871 .cindex "MX record" "security"
24872 .cindex "DNSSEC" "MX lookup"
24873 .cindex "security" "MX lookup"
24874 .cindex "DNS" "DNSSEC"
24875 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24876 the dnssec request bit set.  Setting this transport option is only
24877 useful if the transport overrides or sets the host names. See the
24878 &%dnssec_require_domains%& router option.
24879
24880
24881
24882 .option dscp smtp string&!! unset
24883 .cindex "DCSP" "outbound"
24884 This option causes the DSCP value associated with a socket to be set to one
24885 of a number of fixed strings or to numeric value.
24886 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24887 Common values include &`throughput`&, &`mincost`&, and on newer systems
24888 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24889
24890 The outbound packets from Exim will be marked with this value in the header
24891 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24892 that these values will have any effect, not be stripped by networking
24893 equipment, or do much of anything without cooperation with your Network
24894 Engineer and those of all network operators between the source and destination.
24895
24896
24897 .option fallback_hosts smtp "string list" unset
24898 .cindex "fallback" "hosts specified on transport"
24899 String expansion is not applied to this option. The argument must be a
24900 colon-separated list of host names or IP addresses, optionally also including
24901 port numbers, though the separator can be changed, as described in section
24902 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24903 item in a &%route_list%& setting for the &(manualroute)& router, as described
24904 in section &<<SECTformatonehostitem>>&.
24905
24906 Fallback hosts can also be specified on routers, which associate them with the
24907 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24908 &%fallback_hosts%& specified on the transport is used only if the address does
24909 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24910 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24911 However, &%hosts_randomize%& does apply to fallback host lists.
24912
24913 If Exim is unable to deliver to any of the hosts for a particular address, and
24914 the errors are not permanent rejections, the address is put on a separate
24915 transport queue with its host list replaced by the fallback hosts, unless the
24916 address was routed via MX records and the current host was in the original MX
24917 list. In that situation, the fallback host list is not used.
24918
24919 Once normal deliveries are complete, the fallback queue is delivered by
24920 re-running the same transports with the new host lists. If several failing
24921 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24922 copy of the message is sent.
24923
24924 The resolution of the host names on the fallback list is controlled by the
24925 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24926 both to cases when the host list comes with the address and when it is taken
24927 from &%hosts%&. This option provides a &"use a smart host only if delivery
24928 fails"& facility.
24929
24930
24931 .option final_timeout smtp time 10m
24932 This is the timeout that applies while waiting for the response to the final
24933 line containing just &"."& that terminates a message. Its value must not be
24934 zero.
24935
24936 .option gethostbyname smtp boolean false
24937 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24938 being used, names are looked up using &[gethostbyname()]&
24939 (or &[getipnodebyname()]& when available)
24940 instead of using the DNS. Of course, that function may in fact use the DNS, but
24941 it may also consult other sources of information such as &_/etc/hosts_&.
24942
24943 .option gnutls_compat_mode smtp boolean unset
24944 This option controls whether GnuTLS is used in compatibility mode in an Exim
24945 server. This reduces security slightly, but improves interworking with older
24946 implementations of TLS.
24947
24948 .option helo_data smtp string&!! "see below"
24949 .cindex "HELO" "argument, setting"
24950 .cindex "EHLO" "argument, setting"
24951 .cindex "LHLO argument setting"
24952 The value of this option is expanded after a connection to a another host has
24953 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24954 command that starts the outgoing SMTP or LMTP session. The default value of the
24955 option is:
24956 .code
24957 $primary_hostname
24958 .endd
24959 During the expansion, the variables &$host$& and &$host_address$& are set to
24960 the identity of the remote host, and the variables &$sending_ip_address$& and
24961 &$sending_port$& are set to the local IP address and port number that are being
24962 used. These variables can be used to generate different values for different
24963 servers or different local IP addresses. For example, if you want the string
24964 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24965 interface address, you could use this:
24966 .code
24967 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24968   {$primary_hostname}}
24969 .endd
24970 The use of &%helo_data%& applies both to sending messages and when doing
24971 callouts.
24972
24973 .option hosts smtp "string list&!!" unset
24974 Hosts are associated with an address by a router such as &(dnslookup)&, which
24975 finds the hosts by looking up the address domain in the DNS, or by
24976 &(manualroute)&, which has lists of hosts in its configuration. However,
24977 email addresses can be passed to the &(smtp)& transport by any router, and not
24978 all of them can provide an associated list of hosts.
24979
24980 The &%hosts%& option specifies a list of hosts to be used if the address being
24981 processed does not have any hosts associated with it. The hosts specified by
24982 &%hosts%& are also used, whether or not the address has its own hosts, if
24983 &%hosts_override%& is set.
24984
24985 The string is first expanded, before being interpreted as a colon-separated
24986 list of host names or IP addresses, possibly including port numbers. The
24987 separator may be changed to something other than colon, as described in section
24988 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24989 item in a &%route_list%& setting for the &(manualroute)& router, as described
24990 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24991 of the &(manualroute)& router is not available here.
24992
24993 If the expansion fails, delivery is deferred. Unless the failure was caused by
24994 the inability to complete a lookup, the error is logged to the panic log as
24995 well as the main log. Host names are looked up either by searching directly for
24996 address records in the DNS or by calling &[gethostbyname()]& (or
24997 &[getipnodebyname()]& when available), depending on the setting of the
24998 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24999 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25000 address are used.
25001
25002 During delivery, the hosts are tried in order, subject to their retry status,
25003 unless &%hosts_randomize%& is set.
25004
25005
25006 .option hosts_avoid_esmtp smtp "host list&!!" unset
25007 .cindex "ESMTP, avoiding use of"
25008 .cindex "HELO" "forcing use of"
25009 .cindex "EHLO" "avoiding use of"
25010 .cindex "PIPELINING" "avoiding the use of"
25011 This option is for use with broken hosts that announce ESMTP facilities (for
25012 example, PIPELINING) and then fail to implement them properly. When a host
25013 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25014 start of the SMTP session. This means that it cannot use any of the ESMTP
25015 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25016
25017
25018 .option hosts_avoid_pipelining smtp "host list&!!" unset
25019 .cindex "PIPELINING" "avoiding the use of"
25020 Exim will not use the SMTP PIPELINING extension when delivering to any host
25021 that matches this list, even if the server host advertises PIPELINING support.
25022
25023 .option hosts_pipe_connect smtp "host list&!!" unset
25024 .cindex "pipelining" "early connection"
25025 .cindex "pipelining" PIPE_CONNECT
25026 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25027 this option controls which to hosts the facility watched for
25028 and recorded, and used for subsequent connections.
25029
25030 The retry hints database is used for the record,
25031 and records are subject to the &%retry_data_expire%& option.
25032 When used, the pipelining saves on roundtrip times.
25033 It also turns SMTP into a client-first protocol
25034 so combines well with TCP Fast Open.
25035
25036 See also the &%pipelining_connect_advertise_hosts%& main option.
25037
25038 Note:
25039 When the facility is used, the transport &%helo_data%& option
25040 will be expanded before the &$sending_ip_address$& variable
25041 is filled in.
25042 A check is made for the use of that variable, without the
25043 presence of a &"def:"& test on it, but suitably complex coding
25044 can avoid the check and produce unexpected results.
25045 You have been warned.
25046
25047
25048 .option hosts_avoid_tls smtp "host list&!!" unset
25049 .cindex "TLS" "avoiding for certain hosts"
25050 Exim will not try to start a TLS session when delivering to any host that
25051 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25052
25053 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25054 .cindex "TLS" "avoiding for certain hosts"
25055 Exim will not try to start a TLS session for a verify callout,
25056 or when delivering in cutthrough mode,
25057 to any host that matches this list.
25058
25059
25060 .option hosts_max_try smtp integer 5
25061 .cindex "host" "maximum number to try"
25062 .cindex "limit" "number of hosts tried"
25063 .cindex "limit" "number of MX tried"
25064 .cindex "MX record" "maximum tried"
25065 This option limits the number of IP addresses that are tried for any one
25066 delivery in cases where there are temporary delivery errors. Section
25067 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25068
25069
25070 .option hosts_max_try_hardlimit smtp integer 50
25071 This is an additional check on the maximum number of IP addresses that Exim
25072 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25073 why it exists.
25074
25075
25076
25077 .option hosts_nopass_tls smtp "host list&!!" unset
25078 .cindex "TLS" "passing connection"
25079 .cindex "multiple SMTP deliveries"
25080 .cindex "TLS" "multiple message deliveries"
25081 For any host that matches this list, a connection on which a TLS session has
25082 been started will not be passed to a new delivery process for sending another
25083 message on the same connection. See section &<<SECTmulmessam>>& for an
25084 explanation of when this might be needed.
25085
25086 .option hosts_noproxy_tls smtp "host list&!!" unset
25087 .cindex "TLS" "passing connection"
25088 .cindex "multiple SMTP deliveries"
25089 .cindex "TLS" "multiple message deliveries"
25090 For any host that matches this list, a TLS session which has
25091 been started will not be passed to a new delivery process for sending another
25092 message on the same session.
25093
25094 The traditional implementation closes down TLS and re-starts it in the new
25095 process, on the same open TCP connection, for each successive message
25096 sent.  If permitted by this option a pipe to to the new process is set up
25097 instead, and the original process maintains the TLS connection and proxies
25098 the SMTP connection from and to the new process and any subsequents.
25099 The new process has no access to TLS information, so cannot include it in
25100 logging.
25101
25102
25103
25104 .option hosts_override smtp boolean false
25105 If this option is set and the &%hosts%& option is also set, any hosts that are
25106 attached to the address are ignored, and instead the hosts specified by the
25107 &%hosts%& option are always used. This option does not apply to
25108 &%fallback_hosts%&.
25109
25110
25111 .option hosts_randomize smtp boolean false
25112 .cindex "randomized host list"
25113 .cindex "host" "list of; randomized"
25114 .cindex "fallback" "randomized hosts"
25115 If this option is set, and either the list of hosts is taken from the
25116 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25117 were not obtained from MX records (this includes fallback hosts from the
25118 router), and were not randomized by the router, the order of trying the hosts
25119 is randomized each time the transport runs. Randomizing the order of a host
25120 list can be used to do crude load sharing.
25121
25122 When &%hosts_randomize%& is true, a host list may be split into groups whose
25123 order is separately randomized. This makes it possible to set up MX-like
25124 behaviour. The boundaries between groups are indicated by an item that is just
25125 &`+`& in the host list. For example:
25126 .code
25127 hosts = host1:host2:host3:+:host4:host5
25128 .endd
25129 The order of the first three hosts and the order of the last two hosts is
25130 randomized for each use, but the first three always end up before the last two.
25131 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25132
25133 .option hosts_require_auth smtp "host list&!!" unset
25134 .cindex "authentication" "required by client"
25135 This option provides a list of servers for which authentication must succeed
25136 before Exim will try to transfer a message. If authentication fails for
25137 servers which are not in this list, Exim tries to send unauthenticated. If
25138 authentication fails for one of these servers, delivery is deferred. This
25139 temporary error is detectable in the retry rules, so it can be turned into a
25140 hard failure if required. See also &%hosts_try_auth%&, and chapter
25141 &<<CHAPSMTPAUTH>>& for details of authentication.
25142
25143
25144 .option hosts_request_ocsp smtp "host list&!!" *
25145 .cindex "TLS" "requiring for certain servers"
25146 Exim will request a Certificate Status on a
25147 TLS session for any host that matches this list.
25148 &%tls_verify_certificates%& should also be set for the transport.
25149
25150 .option hosts_require_dane smtp "host list&!!" unset
25151 .cindex DANE "transport options"
25152 .cindex DANE "requiring for certain servers"
25153 If built with DANE support, Exim  will require that a DNSSEC-validated
25154 TLSA record is present for any host matching the list,
25155 and that a DANE-verified TLS connection is made. See
25156 the &%dnssec_request_domains%& router and transport options.
25157 There will be no fallback to in-clear communication.
25158 See section &<<SECDANE>>&.
25159
25160 .option hosts_require_ocsp smtp "host list&!!" unset
25161 .cindex "TLS" "requiring for certain servers"
25162 Exim will request, and check for a valid Certificate Status being given, on a
25163 TLS session for any host that matches this list.
25164 &%tls_verify_certificates%& should also be set for the transport.
25165
25166 .option hosts_require_tls smtp "host list&!!" unset
25167 .cindex "TLS" "requiring for certain servers"
25168 Exim will insist on using a TLS session when delivering to any host that
25169 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25170 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25171 incoming messages, use an appropriate ACL.
25172
25173 .option hosts_try_auth smtp "host list&!!" unset
25174 .cindex "authentication" "optional in client"
25175 This option provides a list of servers to which, provided they announce
25176 authentication support, Exim will attempt to authenticate as a client when it
25177 connects. If authentication fails, Exim will try to transfer the message
25178 unauthenticated. See also &%hosts_require_auth%&, and chapter
25179 &<<CHAPSMTPAUTH>>& for details of authentication.
25180
25181 .option hosts_try_chunking smtp "host list&!!" *
25182 .cindex CHUNKING "enabling, in client"
25183 .cindex BDAT "SMTP command"
25184 .cindex "RFC 3030" "CHUNKING"
25185 This option provides a list of servers to which, provided they announce
25186 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25187 .new
25188 Unless DKIM signing is being done,
25189 .wen
25190 BDAT will not be used in conjunction with a transport filter.
25191
25192 .option hosts_try_dane smtp "host list&!!" *
25193 .cindex DANE "transport options"
25194 .cindex DANE "attempting for certain servers"
25195 If built with DANE support, Exim  will require that a DNSSEC-validated
25196 TLSA record is present for any host matching the list,
25197 and that a DANE-verified TLS connection is made. See
25198 the &%dnssec_request_domains%& router and transport options.
25199 There will be no fallback to in-clear communication.
25200 See section &<<SECDANE>>&.
25201
25202 .option hosts_try_fastopen smtp "host list&!!" *
25203 .cindex "fast open, TCP" "enabling, in client"
25204 .cindex "TCP Fast Open" "enabling, in client"
25205 .cindex "RFC 7413" "TCP Fast Open"
25206 This option provides a list of servers to which, provided
25207 the facility is supported by this system, Exim will attempt to
25208 perform a TCP Fast Open.
25209 No data is sent on the SYN segment but, if the remote server also
25210 supports the facility, it can send its SMTP banner immediately after
25211 the SYN,ACK segment.  This can save up to one round-trip time.
25212
25213 The facility is only active for previously-contacted servers,
25214 as the initiator must present a cookie in the SYN segment.
25215
25216 On (at least some) current Linux distributions the facility must be enabled
25217 in the kernel by the sysadmin before the support is usable.
25218 There is no option for control of the server side; if the system supports
25219 it it is always enabled.  Note that lengthy operations in the connect ACL,
25220 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25221
25222 .option hosts_try_prdr smtp "host list&!!" *
25223 .cindex "PRDR" "enabling, optional in client"
25224 This option provides a list of servers to which, provided they announce
25225 PRDR support, Exim will attempt to negotiate PRDR
25226 for multi-recipient messages.
25227 The option can usually be left as default.
25228
25229 .option interface smtp "string list&!!" unset
25230 .cindex "bind IP address"
25231 .cindex "IP address" "binding"
25232 .vindex "&$host$&"
25233 .vindex "&$host_address$&"
25234 This option specifies which interface to bind to when making an outgoing SMTP
25235 call. The value is an IP address, not an interface name such as
25236 &`eth0`&. Do not confuse this with the interface address that was used when a
25237 message was received, which is in &$received_ip_address$&, formerly known as
25238 &$interface_address$&. The name was changed to minimize confusion with the
25239 outgoing interface address. There is no variable that contains an outgoing
25240 interface address because, unless it is set by this option, its value is
25241 unknown.
25242
25243 During the expansion of the &%interface%& option the variables &$host$& and
25244 &$host_address$& refer to the host to which a connection is about to be made
25245 during the expansion of the string. Forced expansion failure, or an empty
25246 string result causes the option to be ignored. Otherwise, after expansion, the
25247 string must be a list of IP addresses, colon-separated by default, but the
25248 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25249 For example:
25250 .code
25251 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25252 .endd
25253 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25254 connection. If none of them are the correct type, the option is ignored. If
25255 &%interface%& is not set, or is ignored, the system's IP functions choose which
25256 interface to use if the host has more than one.
25257
25258
25259 .option keepalive smtp boolean true
25260 .cindex "keepalive" "on outgoing connection"
25261 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25262 connections. When set, it causes the kernel to probe idle connections
25263 periodically, by sending packets with &"old"& sequence numbers. The other end
25264 of the connection should send a acknowledgment if the connection is still okay
25265 or a reset if the connection has been aborted. The reason for doing this is
25266 that it has the beneficial effect of freeing up certain types of connection
25267 that can get stuck when the remote host is disconnected without tidying up the
25268 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25269 unreachable hosts.
25270
25271
25272 .option lmtp_ignore_quota smtp boolean false
25273 .cindex "LMTP" "ignoring quota errors"
25274 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25275 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25276 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25277
25278 .option max_rcpt smtp integer 100
25279 .cindex "RCPT" "maximum number of outgoing"
25280 This option limits the number of RCPT commands that are sent in a single
25281 SMTP message transaction. Each set of addresses is treated independently, and
25282 so can cause parallel connections to the same host if &%remote_max_parallel%&
25283 permits this.
25284
25285
25286 .option multi_domain smtp boolean&!! true
25287 .vindex "&$domain$&"
25288 When this option is set, the &(smtp)& transport can handle a number of
25289 addresses containing a mixture of different domains provided they all resolve
25290 to the same list of hosts. Turning the option off restricts the transport to
25291 handling only one domain at a time. This is useful if you want to use
25292 &$domain$& in an expansion for the transport, because it is set only when there
25293 is a single domain involved in a remote delivery.
25294
25295 It is expanded per-address and can depend on any of
25296 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25297 &$host$&, &$host_address$& and &$host_port$&.
25298
25299 .option port smtp string&!! "see below"
25300 .cindex "port" "sending TCP/IP"
25301 .cindex "TCP/IP" "setting outgoing port"
25302 This option specifies the TCP/IP port on the server to which Exim connects.
25303 &*Note:*& Do not confuse this with the port that was used when a message was
25304 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25305 The name was changed to minimize confusion with the outgoing port. There is no
25306 variable that contains an outgoing port.
25307
25308 If the value of this option begins with a digit it is taken as a port number;
25309 otherwise it is looked up using &[getservbyname()]&. The default value is
25310 normally &"smtp"&,
25311 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25312 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25313 If the expansion fails, or if a port number cannot be found, delivery
25314 is deferred.
25315
25316 Note that at least one Linux distribution has been seen failing
25317 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25318
25319
25320
25321 .option protocol smtp string smtp
25322 .cindex "LMTP" "over TCP/IP"
25323 .cindex "ssmtp protocol" "outbound"
25324 .cindex "TLS" "SSL-on-connect outbound"
25325 .vindex "&$port$&"
25326 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25327 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25328 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25329 deliveries into closed message stores. Exim also has support for running LMTP
25330 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25331
25332 If this option is set to &"smtps"&, the default value for the &%port%& option
25333 changes to &"smtps"&, and the transport initiates TLS immediately after
25334 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25335 The Internet standards bodies used to strongly discourage use of this mode,
25336 but as of RFC 8314 it is perferred over STARTTLS for message submission
25337 (as distinct from MTA-MTA communication).
25338
25339
25340 .option retry_include_ip_address smtp boolean&!! true
25341 Exim normally includes both the host name and the IP address in the key it
25342 constructs for indexing retry data after a temporary delivery failure. This
25343 means that when one of several IP addresses for a host is failing, it gets
25344 tried periodically (controlled by the retry rules), but use of the other IP
25345 addresses is not affected.
25346
25347 However, in some dialup environments hosts are assigned a different IP address
25348 each time they connect. In this situation the use of the IP address as part of
25349 the retry key leads to undesirable behaviour. Setting this option false causes
25350 Exim to use only the host name.
25351 Since it is expanded it can be made to depend on the host or domain.
25352
25353
25354 .option serialize_hosts smtp "host list&!!" unset
25355 .cindex "serializing connections"
25356 .cindex "host" "serializing connections"
25357 Because Exim operates in a distributed manner, if several messages for the same
25358 host arrive at around the same time, more than one simultaneous connection to
25359 the remote host can occur. This is not usually a problem except when there is a
25360 slow link between the hosts. In that situation it may be helpful to restrict
25361 Exim to one connection at a time. This can be done by setting
25362 &%serialize_hosts%& to match the relevant hosts.
25363
25364 .cindex "hints database" "serializing deliveries to a host"
25365 Exim implements serialization by means of a hints database in which a record is
25366 written whenever a process connects to one of the restricted hosts. The record
25367 is deleted when the connection is completed. Obviously there is scope for
25368 records to get left lying around if there is a system or program crash. To
25369 guard against this, Exim ignores any records that are more than six hours old.
25370
25371 If you set up this kind of serialization, you should also arrange to delete the
25372 relevant hints database whenever your system reboots. The names of the files
25373 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25374 may be one or two files, depending on the type of DBM in use. The same files
25375 are used for ETRN serialization.
25376
25377 See also the &%max_parallel%& generic transport option.
25378
25379
25380 .option size_addition smtp integer 1024
25381 .cindex "SMTP" "SIZE"
25382 .cindex "message" "size issue for transport filter"
25383 .cindex "size" "of message"
25384 .cindex "transport" "filter"
25385 .cindex "filter" "transport filter"
25386 If a remote SMTP server indicates that it supports the SIZE option of the
25387 MAIL command, Exim uses this to pass over the message size at the start of
25388 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25389 sends, to allow for headers and other text that may be added during delivery by
25390 configuration options or in a transport filter. It may be necessary to increase
25391 this if a lot of text is added to messages.
25392
25393 Alternatively, if the value of &%size_addition%& is set negative, it disables
25394 the use of the SIZE option altogether.
25395
25396
25397 .option socks_proxy smtp string&!! unset
25398 .cindex proxy SOCKS
25399 This option enables use of SOCKS proxies for connections made by the
25400 transport.  For details see section &<<SECTproxySOCKS>>&.
25401
25402
25403 .option tls_certificate smtp string&!! unset
25404 .cindex "TLS" "client certificate, location of"
25405 .cindex "certificate" "client, location of"
25406 .vindex "&$host$&"
25407 .vindex "&$host_address$&"
25408 The value of this option must be the absolute path to a file which contains the
25409 client's certificate, for possible use when sending a message over an encrypted
25410 connection. The values of &$host$& and &$host_address$& are set to the name and
25411 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25412 details of TLS.
25413
25414 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25415 certificate when sending messages as a client. The global option of the same
25416 name specifies the certificate for Exim as a server; it is not automatically
25417 assumed that the same certificate should be used when Exim is operating as a
25418 client.
25419
25420
25421 .option tls_crl smtp string&!! unset
25422 .cindex "TLS" "client certificate revocation list"
25423 .cindex "certificate" "revocation list for client"
25424 This option specifies a certificate revocation list. The expanded value must
25425 be the name of a file that contains a CRL in PEM format.
25426
25427
25428 .option tls_dh_min_bits smtp integer 1024
25429 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25430 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25431 key agreement is negotiated, the server will provide a large prime number
25432 for use.  This option establishes the minimum acceptable size of that number.
25433 If the parameter offered by the server is too small, then the TLS handshake
25434 will fail.
25435
25436 Only supported when using GnuTLS.
25437
25438
25439 .option tls_privatekey smtp string&!! unset
25440 .cindex "TLS" "client private key, location of"
25441 .vindex "&$host$&"
25442 .vindex "&$host_address$&"
25443 The value of this option must be the absolute path to a file which contains the
25444 client's private key. This is used when sending a message over an encrypted
25445 connection using a client certificate. The values of &$host$& and
25446 &$host_address$& are set to the name and address of the server during the
25447 expansion. If this option is unset, or the expansion is forced to fail, or the
25448 result is an empty string, the private key is assumed to be in the same file as
25449 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25450
25451
25452 .option tls_require_ciphers smtp string&!! unset
25453 .cindex "TLS" "requiring specific ciphers"
25454 .cindex "cipher" "requiring specific"
25455 .vindex "&$host$&"
25456 .vindex "&$host_address$&"
25457 The value of this option must be a list of permitted cipher suites, for use
25458 when setting up an outgoing encrypted connection. (There is a global option of
25459 the same name for controlling incoming connections.) The values of &$host$& and
25460 &$host_address$& are set to the name and address of the server during the
25461 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25462 is used in different ways by OpenSSL and GnuTLS (see sections
25463 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25464 ciphers is a preference order.
25465
25466
25467
25468 .option tls_sni smtp string&!! unset
25469 .cindex "TLS" "Server Name Indication"
25470 .vindex "&$tls_sni$&"
25471 If this option is set then it sets the $tls_out_sni variable and causes any
25472 TLS session to pass this value as the Server Name Indication extension to
25473 the remote side, which can be used by the remote side to select an appropriate
25474 certificate and private key for the session.
25475
25476 See &<<SECTtlssni>>& for more information.
25477
25478 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25479 TLS extensions.
25480
25481
25482
25483
25484 .option tls_tempfail_tryclear smtp boolean true
25485 .cindex "4&'xx'& responses" "to STARTTLS"
25486 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25487 setting up a TLS session, this option determines whether or not Exim should try
25488 to deliver the message unencrypted. If it is set false, delivery to the
25489 current host is deferred; if there are other hosts, they are tried. If this
25490 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25491 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25492 TLS negotiation fails, Exim closes the current connection (because it is in an
25493 unknown state), opens a new one to the same host, and then tries the delivery
25494 in clear.
25495
25496
25497 .option tls_try_verify_hosts smtp "host list&!!" *
25498 .cindex "TLS" "server certificate verification"
25499 .cindex "certificate" "verification of server"
25500 This option gives a list of hosts for which, on encrypted connections,
25501 certificate verification will be tried but need not succeed.
25502 The &%tls_verify_certificates%& option must also be set.
25503 Note that unless the host is in this list
25504 TLS connections will be denied to hosts using self-signed certificates
25505 when &%tls_verify_certificates%& is matched.
25506 The &$tls_out_certificate_verified$& variable is set when
25507 certificate verification succeeds.
25508
25509
25510 .option tls_verify_cert_hostnames smtp "host list&!!" *
25511 .cindex "TLS" "server certificate hostname verification"
25512 .cindex "certificate" "verification of server"
25513 This option give a list of hosts for which,
25514 while verifying the server certificate,
25515 checks will be included on the host name
25516 (note that this will generally be the result of a DNS MX lookup)
25517 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25518 limited to being the initial component of a 3-or-more component FQDN.
25519
25520 There is no equivalent checking on client certificates.
25521
25522
25523 .option tls_verify_certificates smtp string&!! system
25524 .cindex "TLS" "server certificate verification"
25525 .cindex "certificate" "verification of server"
25526 .vindex "&$host$&"
25527 .vindex "&$host_address$&"
25528 The value of this option must be either the
25529 word "system"
25530 or the absolute path to
25531 a file or directory containing permitted certificates for servers,
25532 for use when setting up an encrypted connection.
25533
25534 The "system" value for the option will use a location compiled into the SSL library.
25535 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25536 is taken as empty and an explicit location
25537 must be specified.
25538
25539 The use of a directory for the option value is not available for GnuTLS versions
25540 preceding 3.3.6 and a single file must be used.
25541
25542 With OpenSSL the certificates specified
25543 explicitly
25544 either by file or directory
25545 are added to those given by the system default location.
25546
25547 The values of &$host$& and
25548 &$host_address$& are set to the name and address of the server during the
25549 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25550
25551 For back-compatibility,
25552 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25553 (a single-colon empty list counts as being set)
25554 and certificate verification fails the TLS connection is closed.
25555
25556
25557 .option tls_verify_hosts smtp "host list&!!" unset
25558 .cindex "TLS" "server certificate verification"
25559 .cindex "certificate" "verification of server"
25560 This option gives a list of hosts for which, on encrypted connections,
25561 certificate verification must succeed.
25562 The &%tls_verify_certificates%& option must also be set.
25563 If both this option and &%tls_try_verify_hosts%& are unset
25564 operation is as if this option selected all hosts.
25565
25566 .option utf8_downconvert smtp integer!! unset
25567 .cindex utf8 "address downconversion"
25568 .cindex i18n "utf8 address downconversion"
25569 If built with internationalization support,
25570 this option controls conversion of UTF-8 in message addresses
25571 to a-label form.
25572 For details see section &<<SECTi18nMTA>>&.
25573
25574
25575
25576
25577 .section "How the limits for the number of hosts to try are used" &&&
25578          "SECTvalhosmax"
25579 .cindex "host" "maximum number to try"
25580 .cindex "limit" "hosts; maximum number tried"
25581 There are two options that are concerned with the number of hosts that are
25582 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25583 &%hosts_max_try_hardlimit%&.
25584
25585
25586 The &%hosts_max_try%& option limits the number of hosts that are tried
25587 for a single delivery. However, despite the term &"host"& in its name, the
25588 option actually applies to each IP address independently. In other words, a
25589 multihomed host is treated as several independent hosts, just as it is for
25590 retrying.
25591
25592 Many of the larger ISPs have multiple MX records which often point to
25593 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25594 created as a result of routing one of these domains.
25595
25596 Trying every single IP address on such a long list does not seem sensible; if
25597 several at the top of the list fail, it is reasonable to assume there is some
25598 problem that is likely to affect all of them. Roughly speaking, the value of
25599 &%hosts_max_try%& is the maximum number that are tried before deferring the
25600 delivery. However, the logic cannot be quite that simple.
25601
25602 Firstly, IP addresses that are skipped because their retry times have not
25603 arrived do not count, and in addition, addresses that are past their retry
25604 limits are also not counted, even when they are tried. This means that when
25605 some IP addresses are past their retry limits, more than the value of
25606 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25607 that all IP addresses are considered before timing out an email address (but
25608 see below for an exception).
25609
25610 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25611 list to see if there is a subsequent host with a different (higher valued) MX.
25612 If there is, that host is considered next, and the current IP address is used
25613 but not counted. This behaviour helps in the case of a domain with a retry rule
25614 that hardly ever delays any hosts, as is now explained:
25615
25616 Consider the case of a long list of hosts with one MX value, and a few with a
25617 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25618 hosts at the top of the list are tried at first. With the default retry rule,
25619 which specifies increasing retry times, the higher MX hosts are eventually
25620 tried when those at the top of the list are skipped because they have not
25621 reached their retry times.
25622
25623 However, it is common practice to put a fixed short retry time on domains for
25624 large ISPs, on the grounds that their servers are rarely down for very long.
25625 Unfortunately, these are exactly the domains that tend to resolve to long lists
25626 of hosts. The short retry time means that the lowest MX hosts are tried every
25627 time. The attempts may be in a different order because of random sorting, but
25628 without the special MX check, the higher MX hosts would never be tried until
25629 all the lower MX hosts had timed out (which might be several days), because
25630 there are always some lower MX hosts that have reached their retry times. With
25631 the special check, Exim considers at least one IP address from each MX value at
25632 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25633 reached.
25634
25635 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25636 particular, Exim normally eventually tries all the IP addresses before timing
25637 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25638 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25639 been set up with hundreds of IP addresses for some domains. It can
25640 take a very long time indeed for an address to time out in these cases.
25641
25642 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25643 Exim never tries more than this number of IP addresses; if it hits this limit
25644 and they are all timed out, the email address is bounced, even though not all
25645 possible IP addresses have been tried.
25646 .ecindex IIDsmttra1
25647 .ecindex IIDsmttra2
25648
25649
25650
25651
25652
25653 . ////////////////////////////////////////////////////////////////////////////
25654 . ////////////////////////////////////////////////////////////////////////////
25655
25656 .chapter "Address rewriting" "CHAPrewrite"
25657 .scindex IIDaddrew "rewriting" "addresses"
25658 There are some circumstances in which Exim automatically rewrites domains in
25659 addresses. The two most common are when an address is given without a domain
25660 (referred to as an &"unqualified address"&) or when an address contains an
25661 abbreviated domain that is expanded by DNS lookup.
25662
25663 Unqualified envelope addresses are accepted only for locally submitted
25664 messages, or for messages that are received from hosts matching
25665 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25666 appropriate. Unqualified addresses in header lines are qualified if they are in
25667 locally submitted messages, or messages from hosts that are permitted to send
25668 unqualified envelope addresses. Otherwise, unqualified addresses in header
25669 lines are neither qualified nor rewritten.
25670
25671 One situation in which Exim does &'not'& automatically rewrite a domain is
25672 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25673 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25674 do this. The new RFCs do not contain this suggestion.
25675
25676
25677 .section "Explicitly configured address rewriting" "SECID147"
25678 This chapter describes the rewriting rules that can be used in the
25679 main rewrite section of the configuration file, and also in the generic
25680 &%headers_rewrite%& option that can be set on any transport.
25681
25682 Some people believe that configured address rewriting is a Mortal Sin.
25683 Others believe that life is not possible without it. Exim provides the
25684 facility; you do not have to use it.
25685
25686 The main rewriting rules that appear in the &"rewrite"& section of the
25687 configuration file are applied to addresses in incoming messages, both envelope
25688 addresses and addresses in header lines. Each rule specifies the types of
25689 address to which it applies.
25690
25691 Whether or not addresses in header lines are rewritten depends on the origin of
25692 the headers and the type of rewriting. Global rewriting, that is, rewriting
25693 rules from the rewrite section of the configuration file, is applied only to
25694 those headers that were received with the message. Header lines that are added
25695 by ACLs or by a system filter or by individual routers or transports (which
25696 are specific to individual recipient addresses) are not rewritten by the global
25697 rules.
25698
25699 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25700 applies all headers except those added by routers and transports. That is, as
25701 well as the headers that were received with the message, it also applies to
25702 headers that were added by an ACL or a system filter.
25703
25704
25705 In general, rewriting addresses from your own system or domain has some
25706 legitimacy. Rewriting other addresses should be done only with great care and
25707 in special circumstances. The author of Exim believes that rewriting should be
25708 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25709 Although it can sometimes be used as a routing tool, this is very strongly
25710 discouraged.
25711
25712 There are two commonly encountered circumstances where rewriting is used, as
25713 illustrated by these examples:
25714
25715 .ilist
25716 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25717 exchange mail with each other behind a firewall, but there is only a single
25718 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25719 &'hitch.fict.example'& when sending mail off-site.
25720 .next
25721 A host rewrites the local parts of its own users so that, for example,
25722 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25723 .endlist
25724
25725
25726
25727 .section "When does rewriting happen?" "SECID148"
25728 .cindex "rewriting" "timing of"
25729 .cindex "&ACL;" "rewriting addresses in"
25730 Configured address rewriting can take place at several different stages of a
25731 message's processing.
25732
25733 .vindex "&$sender_address$&"
25734 At the start of an ACL for MAIL, the sender address may have been rewritten
25735 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25736 ordinary rewrite rules have yet been applied. If, however, the sender address
25737 is verified in the ACL, it is rewritten before verification, and remains
25738 rewritten thereafter. The subsequent value of &$sender_address$& is the
25739 rewritten address. This also applies if sender verification happens in a
25740 RCPT ACL. Otherwise, when the sender address is not verified, it is
25741 rewritten as soon as a message's header lines have been received.
25742
25743 .vindex "&$domain$&"
25744 .vindex "&$local_part$&"
25745 Similarly, at the start of an ACL for RCPT, the current recipient's address
25746 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25747 rewrite rules have yet been applied to it. However, the behaviour is different
25748 from the sender address when a recipient is verified. The address is rewritten
25749 for the verification, but the rewriting is not remembered at this stage. The
25750 value of &$local_part$& and &$domain$& after verification are always the same
25751 as they were before (that is, they contain the unrewritten &-- except for
25752 SMTP-time rewriting &-- address).
25753
25754 As soon as a message's header lines have been received, all the envelope
25755 recipient addresses are permanently rewritten, and rewriting is also applied to
25756 the addresses in the header lines (if configured). This happens before adding
25757 any header lines that were specified in MAIL or RCPT ACLs, and
25758 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25759 before the DATA ACL and &[local_scan()]& functions are run.
25760
25761 When an address is being routed, either for delivery or for verification,
25762 rewriting is applied immediately to child addresses that are generated by
25763 redirection, unless &%no_rewrite%& is set on the router.
25764
25765 .cindex "envelope from"
25766 .cindex "envelope sender" "rewriting at transport time"
25767 .cindex "rewriting" "at transport time"
25768 .cindex "header lines" "rewriting at transport time"
25769 At transport time, additional rewriting of addresses in header lines can be
25770 specified by setting the generic &%headers_rewrite%& option on a transport.
25771 This option contains rules that are identical in form to those in the rewrite
25772 section of the configuration file. They are applied to the original message
25773 header lines and any that were added by ACLs or a system filter. They are not
25774 applied to header lines that are added by routers or the transport.
25775
25776 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25777 transport option. However, it is not possible to rewrite envelope recipients at
25778 transport time.
25779
25780
25781
25782
25783 .section "Testing the rewriting rules that apply on input" "SECID149"
25784 .cindex "rewriting" "testing"
25785 .cindex "testing" "rewriting"
25786 Exim's input rewriting configuration appears in a part of the runtime
25787 configuration file headed by &"begin rewrite"&. It can be tested by the
25788 &%-brw%& command line option. This takes an address (which can be a full RFC
25789 2822 address) as its argument. The output is a list of how the address would be
25790 transformed by the rewriting rules for each of the different places it might
25791 appear in an incoming message, that is, for each different header and for the
25792 envelope sender and recipient fields. For example,
25793 .code
25794 exim -brw ph10@exim.workshop.example
25795 .endd
25796 might produce the output
25797 .code
25798 sender: Philip.Hazel@exim.workshop.example
25799 from: Philip.Hazel@exim.workshop.example
25800 to: ph10@exim.workshop.example
25801 cc: ph10@exim.workshop.example
25802 bcc: ph10@exim.workshop.example
25803 reply-to: Philip.Hazel@exim.workshop.example
25804 env-from: Philip.Hazel@exim.workshop.example
25805 env-to: ph10@exim.workshop.example
25806 .endd
25807 which shows that rewriting has been set up for that address when used in any of
25808 the source fields, but not when it appears as a recipient address. At the
25809 present time, there is no equivalent way of testing rewriting rules that are
25810 set for a particular transport.
25811
25812
25813 .section "Rewriting rules" "SECID150"
25814 .cindex "rewriting" "rules"
25815 The rewrite section of the configuration file consists of lines of rewriting
25816 rules in the form
25817 .display
25818 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25819 .endd
25820 Rewriting rules that are specified for the &%headers_rewrite%& generic
25821 transport option are given as a colon-separated list. Each item in the list
25822 takes the same form as a line in the main rewriting configuration (except that
25823 any colons must be doubled, of course).
25824
25825 The formats of source patterns and replacement strings are described below.
25826 Each is terminated by white space, unless enclosed in double quotes, in which
25827 case normal quoting conventions apply inside the quotes. The flags are single
25828 characters which may appear in any order. Spaces and tabs between them are
25829 ignored.
25830
25831 For each address that could potentially be rewritten, the rules are scanned in
25832 order, and replacements for the address from earlier rules can themselves be
25833 replaced by later rules (but see the &"q"& and &"R"& flags).
25834
25835 The order in which addresses are rewritten is undefined, may change between
25836 releases, and must not be relied on, with one exception: when a message is
25837 received, the envelope sender is always rewritten first, before any header
25838 lines are rewritten. For example, the replacement string for a rewrite of an
25839 address in &'To:'& must not assume that the message's address in &'From:'& has
25840 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25841 that the envelope sender has already been rewritten.
25842
25843 .vindex "&$domain$&"
25844 .vindex "&$local_part$&"
25845 The variables &$local_part$& and &$domain$& can be used in the replacement
25846 string to refer to the address that is being rewritten. Note that lookup-driven
25847 rewriting can be done by a rule of the form
25848 .code
25849 *@*   ${lookup ...
25850 .endd
25851 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25852 refer to the address that is being rewritten.
25853
25854
25855 .section "Rewriting patterns" "SECID151"
25856 .cindex "rewriting" "patterns"
25857 .cindex "address list" "in a rewriting pattern"
25858 The source pattern in a rewriting rule is any item which may appear in an
25859 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25860 single-item address list, which means that it is expanded before being tested
25861 against the address. As always, if you use a regular expression as a pattern,
25862 you must take care to escape dollar and backslash characters, or use the &`\N`&
25863 facility to suppress string expansion within the regular expression.
25864
25865 Domains in patterns should be given in lower case. Local parts in patterns are
25866 case-sensitive. If you want to do case-insensitive matching of local parts, you
25867 can use a regular expression that starts with &`^(?i)`&.
25868
25869 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25870 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25871 depending on the type of match which occurred. These can be used in the
25872 replacement string to insert portions of the incoming address. &$0$& always
25873 refers to the complete incoming address. When a regular expression is used, the
25874 numerical variables are set from its capturing subexpressions. For other types
25875 of pattern they are set as follows:
25876
25877 .ilist
25878 If a local part or domain starts with an asterisk, the numerical variables
25879 refer to the character strings matched by asterisks, with &$1$& associated with
25880 the first asterisk, and &$2$& with the second, if present. For example, if the
25881 pattern
25882 .code
25883 *queen@*.fict.example
25884 .endd
25885 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25886 .code
25887 $0 = hearts-queen@wonderland.fict.example
25888 $1 = hearts-
25889 $2 = wonderland
25890 .endd
25891 Note that if the local part does not start with an asterisk, but the domain
25892 does, it is &$1$& that contains the wild part of the domain.
25893
25894 .next
25895 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25896 of the domain are placed in the next available numerical variables. Suppose,
25897 for example, that the address &'foo@bar.baz.example'& is processed by a
25898 rewriting rule of the form
25899 .display
25900 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25901 .endd
25902 and the key in the file that matches the domain is &`*.baz.example`&. Then
25903 .code
25904 $1 = foo
25905 $2 = bar
25906 $3 = baz.example
25907 .endd
25908 If the address &'foo@baz.example'& is looked up, this matches the same
25909 wildcard file entry, and in this case &$2$& is set to the empty string, but
25910 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25911 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25912 whole domain. For non-partial domain lookups, no numerical variables are set.
25913 .endlist
25914
25915
25916 .section "Rewriting replacements" "SECID152"
25917 .cindex "rewriting" "replacements"
25918 If the replacement string for a rule is a single asterisk, addresses that
25919 match the pattern and the flags are &'not'& rewritten, and no subsequent
25920 rewriting rules are scanned. For example,
25921 .code
25922 hatta@lookingglass.fict.example  *  f
25923 .endd
25924 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25925 &'From:'& headers.
25926
25927 .vindex "&$domain$&"
25928 .vindex "&$local_part$&"
25929 If the replacement string is not a single asterisk, it is expanded, and must
25930 yield a fully qualified address. Within the expansion, the variables
25931 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25932 Any letters they contain retain their original case &-- they are not lower
25933 cased. The numerical variables are set up according to the type of pattern that
25934 matched the address, as described above. If the expansion is forced to fail by
25935 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25936 current rule is abandoned, but subsequent rules may take effect. Any other
25937 expansion failure causes the entire rewriting operation to be abandoned, and an
25938 entry written to the panic log.
25939
25940
25941
25942 .section "Rewriting flags" "SECID153"
25943 There are three different kinds of flag that may appear on rewriting rules:
25944
25945 .ilist
25946 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25947 c, f, h, r, s, t.
25948 .next
25949 A flag that specifies rewriting at SMTP time: S.
25950 .next
25951 Flags that control the rewriting process: Q, q, R, w.
25952 .endlist
25953
25954 For rules that are part of the &%headers_rewrite%& generic transport option,
25955 E, F, T, and S are not permitted.
25956
25957
25958
25959 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25960          "SECID154"
25961 .cindex "rewriting" "flags"
25962 If none of the following flag letters, nor the &"S"& flag (see section
25963 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25964 and to both the sender and recipient fields of the envelope, whereas a
25965 transport-time rewriting rule just applies to all headers. Otherwise, the
25966 rewriting rule is skipped unless the relevant addresses are being processed.
25967 .display
25968 &`E`&       rewrite all envelope fields
25969 &`F`&       rewrite the envelope From field
25970 &`T`&       rewrite the envelope To field
25971 &`b`&       rewrite the &'Bcc:'& header
25972 &`c`&       rewrite the &'Cc:'& header
25973 &`f`&       rewrite the &'From:'& header
25974 &`h`&       rewrite all headers
25975 &`r`&       rewrite the &'Reply-To:'& header
25976 &`s`&       rewrite the &'Sender:'& header
25977 &`t`&       rewrite the &'To:'& header
25978 .endd
25979 "All headers" means all of the headers listed above that can be selected
25980 individually, plus their &'Resent-'& versions. It does not include
25981 other headers such as &'Subject:'& etc.
25982
25983 You should be particularly careful about rewriting &'Sender:'& headers, and
25984 restrict this to special known cases in your own domains.
25985
25986
25987 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25988 .cindex "SMTP" "rewriting malformed addresses"
25989 .cindex "RCPT" "rewriting argument of"
25990 .cindex "MAIL" "rewriting argument of"
25991 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25992 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25993 before any other processing; even before syntax checking. The pattern is
25994 required to be a regular expression, and it is matched against the whole of the
25995 data for the command, including any surrounding angle brackets.
25996
25997 .vindex "&$domain$&"
25998 .vindex "&$local_part$&"
25999 This form of rewrite rule allows for the handling of addresses that are not
26000 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26001 input). Because the input is not required to be a syntactically valid address,
26002 the variables &$local_part$& and &$domain$& are not available during the
26003 expansion of the replacement string. The result of rewriting replaces the
26004 original address in the MAIL or RCPT command.
26005
26006
26007 .section "Flags controlling the rewriting process" "SECID155"
26008 There are four flags which control the way the rewriting process works. These
26009 take effect only when a rule is invoked, that is, when the address is of the
26010 correct type (matches the flags) and matches the pattern:
26011
26012 .ilist
26013 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26014 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26015 absence of &"Q"& the rewritten address must always include a domain.
26016 .next
26017 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26018 even if no rewriting actually takes place because of a &"fail"& in the
26019 expansion. The &"q"& flag is not effective if the address is of the wrong type
26020 (does not match the flags) or does not match the pattern.
26021 .next
26022 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26023 address, up to ten times. It can be combined with the &"q"& flag, to stop
26024 rewriting once it fails to match (after at least one successful rewrite).
26025 .next
26026 .cindex "rewriting" "whole addresses"
26027 When an address in a header is rewritten, the rewriting normally applies only
26028 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26029 left unchanged. For example, rewriting might change
26030 .code
26031 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26032 .endd
26033 into
26034 .code
26035 From: Ford Prefect <prefectf@hitch.fict.example>
26036 .endd
26037 .cindex "RFC 2047"
26038 Sometimes there is a need to replace the whole address item, and this can be
26039 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26040 causes an address in a header line to be rewritten, the entire address is
26041 replaced, not just the working part. The replacement must be a complete RFC
26042 2822 address, including the angle brackets if necessary. If text outside angle
26043 brackets contains a character whose value is greater than 126 or less than 32
26044 (except for tab), the text is encoded according to RFC 2047. The character set
26045 is taken from &%headers_charset%&, which gets its default at build time.
26046
26047 When the &"w"& flag is set on a rule that causes an envelope address to be
26048 rewritten, all but the working part of the replacement address is discarded.
26049 .endlist
26050
26051
26052 .section "Rewriting examples" "SECID156"
26053 Here is an example of the two common rewriting paradigms:
26054 .code
26055 *@*.hitch.fict.example  $1@hitch.fict.example
26056 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26057                      {$value}fail}@hitch.fict.example bctfrF
26058 .endd
26059 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26060 the string expansion to fail if the lookup does not succeed. In this context it
26061 has the effect of leaving the original address unchanged, but Exim goes on to
26062 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26063 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26064 explicitly, which would cause the rewritten address to be the same as before,
26065 at the cost of a small bit of processing. Not supplying either of these is an
26066 error, since the rewritten address would then contain no local part.
26067
26068 The first example above replaces the domain with a superior, more general
26069 domain. This may not be desirable for certain local parts. If the rule
26070 .code
26071 root@*.hitch.fict.example  *
26072 .endd
26073 were inserted before the first rule, rewriting would be suppressed for the
26074 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26075
26076 Rewriting can be made conditional on a number of tests, by making use of
26077 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26078 messages that originate outside the local host:
26079 .code
26080 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26081                          {$1@hitch.fict.example}fail}"
26082 .endd
26083 The replacement string is quoted in this example because it contains white
26084 space.
26085
26086 .cindex "rewriting" "bang paths"
26087 .cindex "bang paths" "rewriting"
26088 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26089 an address it treats it as an unqualified local part which it qualifies with
26090 the local qualification domain (if the source of the message is local or if the
26091 remote host is permitted to send unqualified addresses). Rewriting can
26092 sometimes be used to handle simple bang paths with a fixed number of
26093 components. For example, the rule
26094 .code
26095 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26096 .endd
26097 rewrites a two-component bang path &'host.name!user'& as the domain address
26098 &'user@host.name'&. However, there is a security implication in using this as
26099 a global rewriting rule for envelope addresses. It can provide a backdoor
26100 method for using your system as a relay, because the incoming addresses appear
26101 to be local. If the bang path addresses are received via SMTP, it is safer to
26102 use the &"S"& flag to rewrite them as they are received, so that relay checking
26103 can be done on the rewritten addresses.
26104 .ecindex IIDaddrew
26105
26106
26107
26108
26109
26110 . ////////////////////////////////////////////////////////////////////////////
26111 . ////////////////////////////////////////////////////////////////////////////
26112
26113 .chapter "Retry configuration" "CHAPretry"
26114 .scindex IIDretconf1 "retry" "configuration, description of"
26115 .scindex IIDregconf2 "configuration file" "retry section"
26116 The &"retry"& section of the runtime configuration file contains a list of
26117 retry rules that control how often Exim tries to deliver messages that cannot
26118 be delivered at the first attempt. If there are no retry rules (the section is
26119 empty or not present), there are no retries. In this situation, temporary
26120 errors are treated as permanent. The default configuration contains a single,
26121 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26122 line option can be used to test which retry rule will be used for a given
26123 address, domain and error.
26124
26125 The most common cause of retries is temporary failure to deliver to a remote
26126 host because the host is down, or inaccessible because of a network problem.
26127 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26128 address) basis, not on a per-message basis. Thus, if one message has recently
26129 been delayed, delivery of a new message to the same host is not immediately
26130 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26131 log selector is set, the message
26132 .cindex "retry" "time not reached"
26133 &"retry time not reached"& is written to the main log whenever a delivery is
26134 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26135 the handling of errors during remote deliveries.
26136
26137 Retry processing applies to routing as well as to delivering, except as covered
26138 in the next paragraph. The retry rules do not distinguish between these
26139 actions. It is not possible, for example, to specify different behaviour for
26140 failures to route the domain &'snark.fict.example'& and failures to deliver to
26141 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26142 added complication, so did not implement it. However, although they share the
26143 same retry rule, the actual retry times for routing and transporting a given
26144 domain are maintained independently.
26145
26146 When a delivery is not part of a queue run (typically an immediate delivery on
26147 receipt of a message), the routers are always run, and local deliveries are
26148 always attempted, even if retry times are set for them. This makes for better
26149 behaviour if one particular message is causing problems (for example, causing
26150 quota overflow, or provoking an error in a filter file). If such a delivery
26151 suffers a temporary failure, the retry data is updated as normal, and
26152 subsequent delivery attempts from queue runs occur only when the retry time for
26153 the local address is reached.
26154
26155 .section "Changing retry rules" "SECID157"
26156 If you change the retry rules in your configuration, you should consider
26157 whether or not to delete the retry data that is stored in Exim's spool area in
26158 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26159 always safe; that is why they are called &"hints"&.
26160
26161 The hints retry data contains suggested retry times based on the previous
26162 rules. In the case of a long-running problem with a remote host, it might
26163 record the fact that the host has timed out. If your new rules increase the
26164 timeout time for such a host, you should definitely remove the old retry data
26165 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26166 messages that it should now be retaining.
26167
26168
26169
26170 .section "Format of retry rules" "SECID158"
26171 .cindex "retry" "rules"
26172 Each retry rule occupies one line and consists of three or four parts,
26173 separated by white space: a pattern, an error name, an optional list of sender
26174 addresses, and a list of retry parameters. The pattern and sender lists must be
26175 enclosed in double quotes if they contain white space. The rules are searched
26176 in order until one is found where the pattern, error name, and sender list (if
26177 present) match the failing host or address, the error that occurred, and the
26178 message's sender, respectively.
26179
26180
26181 The pattern is any single item that may appear in an address list (see section
26182 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26183 which means that it is expanded before being tested against the address that
26184 has been delayed. A negated address list item is permitted. Address
26185 list processing treats a plain domain name as if it were preceded by &"*@"&,
26186 which makes it possible for many retry rules to start with just a domain. For
26187 example,
26188 .code
26189 lookingglass.fict.example        *  F,24h,30m;
26190 .endd
26191 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26192 whereas
26193 .code
26194 alice@lookingglass.fict.example  *  F,24h,30m;
26195 .endd
26196 applies only to temporary failures involving the local part &%alice%&.
26197 In practice, almost all rules start with a domain name pattern without a local
26198 part.
26199
26200 .cindex "regular expressions" "in retry rules"
26201 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26202 must match a complete address, not just a domain, because that is how regular
26203 expressions work in address lists.
26204 .display
26205 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26206 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26207 .endd
26208
26209
26210 .section "Choosing which retry rule to use for address errors" "SECID159"
26211 When Exim is looking for a retry rule after a routing attempt has failed (for
26212 example, after a DNS timeout), each line in the retry configuration is tested
26213 against the complete address only if &%retry_use_local_part%& is set for the
26214 router. Otherwise, only the domain is used, except when matching against a
26215 regular expression, when the local part of the address is replaced with &"*"&.
26216 A domain on its own can match a domain pattern, or a pattern that starts with
26217 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26218 &%check_local_user%& is true, and false for other routers.
26219
26220 Similarly, when Exim is looking for a retry rule after a local delivery has
26221 failed (for example, after a mailbox full error), each line in the retry
26222 configuration is tested against the complete address only if
26223 &%retry_use_local_part%& is set for the transport (it defaults true for all
26224 local transports).
26225
26226 .cindex "4&'xx'& responses" "retry rules for"
26227 However, when Exim is looking for a retry rule after a remote delivery attempt
26228 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26229 whole address is always used as the key when searching the retry rules. The
26230 rule that is found is used to create a retry time for the combination of the
26231 failing address and the message's sender. It is the combination of sender and
26232 recipient that is delayed in subsequent queue runs until its retry time is
26233 reached. You can delay the recipient without regard to the sender by setting
26234 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26235 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26236 commands.
26237
26238
26239
26240 .section "Choosing which retry rule to use for host and message errors" &&&
26241          "SECID160"
26242 For a temporary error that is not related to an individual address (for
26243 example, a connection timeout), each line in the retry configuration is checked
26244 twice. First, the name of the remote host is used as a domain name (preceded by
26245 &"*@"& when matching a regular expression). If this does not match the line,
26246 the domain from the email address is tried in a similar fashion. For example,
26247 suppose the MX records for &'a.b.c.example'& are
26248 .code
26249 a.b.c.example  MX  5  x.y.z.example
26250                MX  6  p.q.r.example
26251                MX  7  m.n.o.example
26252 .endd
26253 and the retry rules are
26254 .code
26255 p.q.r.example    *      F,24h,30m;
26256 a.b.c.example    *      F,4d,45m;
26257 .endd
26258 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26259 first rule matches neither the host nor the domain, so Exim looks at the second
26260 rule. This does not match the host, but it does match the domain, so it is used
26261 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26262 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26263 first retry rule is used, because it matches the host.
26264
26265 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26266 first rule to determine retry times, but for all the other hosts for the domain
26267 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26268 routing to &'a.b.c.example'& suffers a temporary failure.
26269
26270 &*Note*&: The host name is used when matching the patterns, not its IP address.
26271 However, if a message is routed directly to an IP address without the use of a
26272 host name, for example, if a &(manualroute)& router contains a setting such as:
26273 .code
26274 route_list = *.a.example  192.168.34.23
26275 .endd
26276 then the &"host name"& that is used when searching for a retry rule is the
26277 textual form of the IP address.
26278
26279 .section "Retry rules for specific errors" "SECID161"
26280 .cindex "retry" "specific errors; specifying"
26281 The second field in a retry rule is the name of a particular error, or an
26282 asterisk, which matches any error. The errors that can be tested for are:
26283
26284 .vlist
26285 .vitem &%auth_failed%&
26286 Authentication failed when trying to send to a host in the
26287 &%hosts_require_auth%& list in an &(smtp)& transport.
26288
26289 .vitem &%data_4xx%&
26290 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26291 after the command, or after sending the message's data.
26292
26293 .vitem &%mail_4xx%&
26294 A 4&'xx'& error was received for an outgoing MAIL command.
26295
26296 .vitem &%rcpt_4xx%&
26297 A 4&'xx'& error was received for an outgoing RCPT command.
26298 .endlist
26299
26300 For the three 4&'xx'& errors, either the first or both of the x's can be given
26301 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26302 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26303 and have retries every ten minutes with a one-hour timeout, you could set up a
26304 retry rule of this form:
26305 .code
26306 the.domain.name  rcpt_452   F,1h,10m
26307 .endd
26308 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26309 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26310
26311 .vlist
26312 .vitem &%lost_connection%&
26313 A server unexpectedly closed the SMTP connection. There may, of course,
26314 legitimate reasons for this (host died, network died), but if it repeats a lot
26315 for the same host, it indicates something odd.
26316
26317 .vitem &%lookup%&
26318 A DNS lookup for a host failed.
26319 Note that a &%dnslookup%& router will need to have matched
26320 its &%fail_defer_domains%& option for this retry type to be usable.
26321 Also note that a &%manualroute%& router will probably need
26322 its &%host_find_failed%& option set to &%defer%&.
26323
26324 .vitem &%refused_MX%&
26325 A connection to a host obtained from an MX record was refused.
26326
26327 .vitem &%refused_A%&
26328 A connection to a host not obtained from an MX record was refused.
26329
26330 .vitem &%refused%&
26331 A connection was refused.
26332
26333 .vitem &%timeout_connect_MX%&
26334 A connection attempt to a host obtained from an MX record timed out.
26335
26336 .vitem &%timeout_connect_A%&
26337 A connection attempt to a host not obtained from an MX record timed out.
26338
26339 .vitem &%timeout_connect%&
26340 A connection attempt timed out.
26341
26342 .vitem &%timeout_MX%&
26343 There was a timeout while connecting or during an SMTP session with a host
26344 obtained from an MX record.
26345
26346 .vitem &%timeout_A%&
26347 There was a timeout while connecting or during an SMTP session with a host not
26348 obtained from an MX record.
26349
26350 .vitem &%timeout%&
26351 There was a timeout while connecting or during an SMTP session.
26352
26353 .vitem &%tls_required%&
26354 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26355 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26356 to STARTTLS, or there was a problem setting up the TLS connection.
26357
26358 .vitem &%quota%&
26359 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26360 transport.
26361
26362 .vitem &%quota_%&<&'time'&>
26363 .cindex "quota" "error testing in retry rule"
26364 .cindex "retry" "quota error testing"
26365 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26366 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26367 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26368 for four days.
26369 .endlist
26370
26371 .cindex "mailbox" "time of last read"
26372 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26373 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26374 it should be based on the last time that the user accessed the mailbox.
26375 However, it is not always possible to determine this. Exim uses the following
26376 heuristic rules:
26377
26378 .ilist
26379 If the mailbox is a single file, the time of last access (the &"atime"&) is
26380 used. As no new messages are being delivered (because the mailbox is over
26381 quota), Exim does not access the file, so this is the time of last user access.
26382 .next
26383 .cindex "maildir format" "time of last read"
26384 For a maildir delivery, the time of last modification of the &_new_&
26385 subdirectory is used. As the mailbox is over quota, no new files are created in
26386 the &_new_& subdirectory, because no new messages are being delivered. Any
26387 change to the &_new_& subdirectory is therefore assumed to be the result of an
26388 MUA moving a new message to the &_cur_& directory when it is first read. The
26389 time that is used is therefore the last time that the user read a new message.
26390 .next
26391 For other kinds of multi-file mailbox, the time of last access cannot be
26392 obtained, so a retry rule that uses this type of error field is never matched.
26393 .endlist
26394
26395 The quota errors apply both to system-enforced quotas and to Exim's own quota
26396 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26397 when a local delivery is deferred because a partition is full (the ENOSPC
26398 error).
26399
26400
26401
26402 .section "Retry rules for specified senders" "SECID162"
26403 .cindex "retry" "rules; sender-specific"
26404 You can specify retry rules that apply only when the failing message has a
26405 specific sender. In particular, this can be used to define retry rules that
26406 apply only to bounce messages. The third item in a retry rule can be of this
26407 form:
26408 .display
26409 &`senders=`&<&'address list'&>
26410 .endd
26411 The retry timings themselves are then the fourth item. For example:
26412 .code
26413 *   rcpt_4xx   senders=:   F,1h,30m
26414 .endd
26415 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26416 host. If the address list contains white space, it must be enclosed in quotes.
26417 For example:
26418 .code
26419 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26420 .endd
26421 &*Warning*&: This facility can be unhelpful if it is used for host errors
26422 (which do not depend on the recipient). The reason is that the sender is used
26423 only to match the retry rule. Once the rule has been found for a host error,
26424 its contents are used to set a retry time for the host, and this will apply to
26425 all messages, not just those with specific senders.
26426
26427 When testing retry rules using &%-brt%&, you can supply a sender using the
26428 &%-f%& command line option, like this:
26429 .code
26430 exim -f "" -brt user@dom.ain
26431 .endd
26432 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26433 list is never matched.
26434
26435
26436
26437
26438
26439 .section "Retry parameters" "SECID163"
26440 .cindex "retry" "parameters in rules"
26441 The third (or fourth, if a senders list is present) field in a retry rule is a
26442 sequence of retry parameter sets, separated by semicolons. Each set consists of
26443 .display
26444 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26445 .endd
26446 The letter identifies the algorithm for computing a new retry time; the cutoff
26447 time is the time beyond which this algorithm no longer applies, and the
26448 arguments vary the algorithm's action. The cutoff time is measured from the
26449 time that the first failure for the domain (combined with the local part if
26450 relevant) was detected, not from the time the message was received.
26451
26452 .cindex "retry" "algorithms"
26453 .cindex "retry" "fixed intervals"
26454 .cindex "retry" "increasing intervals"
26455 .cindex "retry" "random intervals"
26456 The available algorithms are:
26457
26458 .ilist
26459 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26460 the interval.
26461 .next
26462 &'G'&: retry at geometrically increasing intervals. The first argument
26463 specifies a starting value for the interval, and the second a multiplier, which
26464 is used to increase the size of the interval at each retry.
26465 .next
26466 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26467 retry, the previous interval is multiplied by the factor in order to get a
26468 maximum for the next interval. The minimum interval is the first argument of
26469 the parameter, and an actual interval is chosen randomly between them. Such a
26470 rule has been found to be helpful in cluster configurations when all the
26471 members of the cluster restart at once, and may therefore synchronize their
26472 queue processing times.
26473 .endlist
26474
26475 When computing the next retry time, the algorithm definitions are scanned in
26476 order until one whose cutoff time has not yet passed is reached. This is then
26477 used to compute a new retry time that is later than the current time. In the
26478 case of fixed interval retries, this simply means adding the interval to the
26479 current time. For geometrically increasing intervals, retry intervals are
26480 computed from the rule's parameters until one that is greater than the previous
26481 interval is found. The main configuration variable
26482 .cindex "limit" "retry interval"
26483 .cindex "retry" "interval, maximum"
26484 .oindex "&%retry_interval_max%&"
26485 &%retry_interval_max%& limits the maximum interval between retries. It
26486 cannot be set greater than &`24h`&, which is its default value.
26487
26488 A single remote domain may have a number of hosts associated with it, and each
26489 host may have more than one IP address. Retry algorithms are selected on the
26490 basis of the domain name, but are applied to each IP address independently. If,
26491 for example, a host has two IP addresses and one is unusable, Exim will
26492 generate retry times for it and will not try to use it until its next retry
26493 time comes. Thus the good IP address is likely to be tried first most of the
26494 time.
26495
26496 .cindex "hints database" "use for retrying"
26497 Retry times are hints rather than promises. Exim does not make any attempt to
26498 run deliveries exactly at the computed times. Instead, a queue runner process
26499 starts delivery processes for delayed messages periodically, and these attempt
26500 new deliveries only for those addresses that have passed their next retry time.
26501 If a new message arrives for a deferred address, an immediate delivery attempt
26502 occurs only if the address has passed its retry time. In the absence of new
26503 messages, the minimum time between retries is the interval between queue runner
26504 processes. There is not much point in setting retry times of five minutes if
26505 your queue runners happen only once an hour, unless there are a significant
26506 number of incoming messages (which might be the case on a system that is
26507 sending everything to a smart host, for example).
26508
26509 The data in the retry hints database can be inspected by using the
26510 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26511 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26512 &'exinext'& utility script can be used to find out what the next retry times
26513 are for the hosts associated with a particular mail domain, and also for local
26514 deliveries that have been deferred.
26515
26516
26517 .section "Retry rule examples" "SECID164"
26518 Here are some example retry rules:
26519 .code
26520 alice@wonderland.fict.example quota_5d  F,7d,3h
26521 wonderland.fict.example       quota_5d
26522 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26523 lookingglass.fict.example     *         F,24h,30m;
26524 *                 refused_A   F,2h,20m;
26525 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26526 .endd
26527 The first rule sets up special handling for mail to
26528 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26529 mailbox has not been read for at least 5 days. Retries continue every three
26530 hours for 7 days. The second rule handles over-quota errors for all other local
26531 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26532 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26533 fail are bounced immediately if the mailbox has not been read for at least 5
26534 days.
26535
26536 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26537 happen every 15 minutes for an hour, then with geometrically increasing
26538 intervals until two days have passed since a delivery first failed. After the
26539 first hour there is a delay of one hour, then two hours, then four hours, and
26540 so on (this is a rather extreme example).
26541
26542 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26543 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26544 all other domains, with special action for connection refusal from hosts that
26545 were not obtained from an MX record.
26546
26547 The final rule in a retry configuration should always have asterisks in the
26548 first two fields so as to provide a general catch-all for any addresses that do
26549 not have their own special handling. This example tries every 15 minutes for 2
26550 hours, then with intervals starting at one hour and increasing by a factor of
26551 1.5 up to 16 hours, then every 8 hours up to 5 days.
26552
26553
26554
26555 .section "Timeout of retry data" "SECID165"
26556 .cindex "timeout" "of retry data"
26557 .oindex "&%retry_data_expire%&"
26558 .cindex "hints database" "data expiry"
26559 .cindex "retry" "timeout of data"
26560 Exim timestamps the data that it writes to its retry hints database. When it
26561 consults the data during a delivery it ignores any that is older than the value
26562 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26563 been tried for 7 days, Exim will try to deliver to it immediately a message
26564 arrives, and if that fails, it will calculate a retry time as if it were
26565 failing for the first time.
26566
26567 This improves the behaviour for messages routed to rarely-used hosts such as MX
26568 backups. If such a host was down at one time, and happens to be down again when
26569 Exim tries a month later, using the old retry data would imply that it had been
26570 down all the time, which is not a justified assumption.
26571
26572 If a host really is permanently dead, this behaviour causes a burst of retries
26573 every now and again, but only if messages routed to it are rare. If there is a
26574 message at least once every 7 days the retry data never expires.
26575
26576
26577
26578
26579 .section "Long-term failures" "SECID166"
26580 .cindex "delivery failure, long-term"
26581 .cindex "retry" "after long-term failure"
26582 Special processing happens when an email address has been failing for so long
26583 that the cutoff time for the last algorithm is reached. For example, using the
26584 default retry rule:
26585 .code
26586 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26587 .endd
26588 the cutoff time is four days. Reaching the retry cutoff is independent of how
26589 long any specific message has been failing; it is the length of continuous
26590 failure for the recipient address that counts.
26591
26592 When the cutoff time is reached for a local delivery, or for all the IP
26593 addresses associated with a remote delivery, a subsequent delivery failure
26594 causes Exim to give up on the address, and a bounce message is generated.
26595 In order to cater for new messages that use the failing address, a next retry
26596 time is still computed from the final algorithm, and is used as follows:
26597
26598 For local deliveries, one delivery attempt is always made for any subsequent
26599 messages. If this delivery fails, the address fails immediately. The
26600 post-cutoff retry time is not used.
26601
26602 .cindex "final cutoff" "retries, controlling"
26603 .cindex retry "final cutoff"
26604 If the delivery is remote, there are two possibilities, controlled by the
26605 .oindex "&%delay_after_cutoff%&"
26606 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26607 default. Until the post-cutoff retry time for one of the IP addresses,
26608 as set by the &%retry_data_expire%& option, is
26609 reached, the failing email address is bounced immediately, without a delivery
26610 attempt taking place. After that time, one new delivery attempt is made to
26611 those IP addresses that are past their retry times, and if that still fails,
26612 the address is bounced and new retry times are computed.
26613
26614 In other words, when all the hosts for a given email address have been failing
26615 for a long time, Exim bounces rather then defers until one of the hosts' retry
26616 times is reached. Then it tries once, and bounces if that attempt fails. This
26617 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26618 to a broken destination, but if the host does recover, Exim will eventually
26619 notice.
26620
26621 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26622 addresses are past their final cutoff time, Exim tries to deliver to those IP
26623 addresses that have not been tried since the message arrived. If there are
26624 no suitable IP addresses, or if they all fail, the address is bounced. In other
26625 words, it does not delay when a new message arrives, but tries the expired
26626 addresses immediately, unless they have been tried since the message arrived.
26627 If there is a continuous stream of messages for the failing domains, setting
26628 &%delay_after_cutoff%& false means that there will be many more attempts to
26629 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26630 true.
26631
26632 .section "Deliveries that work intermittently" "SECID167"
26633 .cindex "retry" "intermittently working deliveries"
26634 Some additional logic is needed to cope with cases where a host is
26635 intermittently available, or when a message has some attribute that prevents
26636 its delivery when others to the same address get through. In this situation,
26637 because some messages are successfully delivered, the &"retry clock"& for the
26638 host or address keeps getting reset by the successful deliveries, and so
26639 failing messages remain in the queue for ever because the cutoff time is never
26640 reached.
26641
26642 Two exceptional actions are applied to prevent this happening. The first
26643 applies to errors that are related to a message rather than a remote host.
26644 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26645 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26646 commands, and quota failures. For this type of error, if a message's arrival
26647 time is earlier than the &"first failed"& time for the error, the earlier time
26648 is used when scanning the retry rules to decide when to try next and when to
26649 time out the address.
26650
26651 The exceptional second action applies in all cases. If a message has been on
26652 the queue for longer than the cutoff time of any applicable retry rule for a
26653 given address, a delivery is attempted for that address, even if it is not yet
26654 time, and if this delivery fails, the address is timed out. A new retry time is
26655 not computed in this case, so that other messages for the same address are
26656 considered immediately.
26657 .ecindex IIDretconf1
26658 .ecindex IIDregconf2
26659
26660
26661
26662
26663
26664
26665 . ////////////////////////////////////////////////////////////////////////////
26666 . ////////////////////////////////////////////////////////////////////////////
26667
26668 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26669 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26670 .scindex IIDauthconf2 "authentication"
26671 The &"authenticators"& section of Exim's runtime configuration is concerned
26672 with SMTP authentication. This facility is an extension to the SMTP protocol,
26673 described in RFC 2554, which allows a client SMTP host to authenticate itself
26674 to a server. This is a common way for a server to recognize clients that are
26675 permitted to use it as a relay. SMTP authentication is not of relevance to the
26676 transfer of mail between servers that have no managerial connection with each
26677 other.
26678
26679 .cindex "AUTH" "description of"
26680 Very briefly, the way SMTP authentication works is as follows:
26681
26682 .ilist
26683 The server advertises a number of authentication &'mechanisms'& in response to
26684 the client's EHLO command.
26685 .next
26686 The client issues an AUTH command, naming a specific mechanism. The command
26687 may, optionally, contain some authentication data.
26688 .next
26689 The server may issue one or more &'challenges'&, to which the client must send
26690 appropriate responses. In simple authentication mechanisms, the challenges are
26691 just prompts for user names and passwords. The server does not have to issue
26692 any challenges &-- in some mechanisms the relevant data may all be transmitted
26693 with the AUTH command.
26694 .next
26695 The server either accepts or denies authentication.
26696 .next
26697 If authentication succeeds, the client may optionally make use of the AUTH
26698 option on the MAIL command to pass an authenticated sender in subsequent
26699 mail transactions. Authentication lasts for the remainder of the SMTP
26700 connection.
26701 .next
26702 If authentication fails, the client may give up, or it may try a different
26703 authentication mechanism, or it may try transferring mail over the
26704 unauthenticated connection.
26705 .endlist
26706
26707 If you are setting up a client, and want to know which authentication
26708 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26709 SMTP port) on the server, and issue an EHLO command. The response to this
26710 includes the list of supported mechanisms. For example:
26711 .display
26712 &`$ `&&*&`telnet server.example 25`&*&
26713 &`Trying 192.168.34.25...`&
26714 &`Connected to server.example.`&
26715 &`Escape character is &#x0027;^]&#x0027;.`&
26716 &`220 server.example ESMTP Exim 4.20 ...`&
26717 &*&`ehlo client.example`&*&
26718 &`250-server.example Hello client.example [10.8.4.5]`&
26719 &`250-SIZE 52428800`&
26720 &`250-PIPELINING`&
26721 &`250-AUTH PLAIN`&
26722 &`250 HELP`&
26723 .endd
26724 The second-last line of this example output shows that the server supports
26725 authentication using the PLAIN mechanism. In Exim, the different authentication
26726 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26727 routers and transports, which authenticators are included in the binary is
26728 controlled by build-time definitions. The following are currently available,
26729 included by setting
26730 .code
26731 AUTH_CRAM_MD5=yes
26732 AUTH_CYRUS_SASL=yes
26733 AUTH_DOVECOT=yes
26734 AUTH_EXTERNAL=yes
26735 AUTH_GSASL=yes
26736 AUTH_HEIMDAL_GSSAPI=yes
26737 AUTH_PLAINTEXT=yes
26738 AUTH_SPA=yes
26739 AUTH_TLS=yes
26740 .endd
26741 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26742 authentication mechanism (RFC 2195), and the second provides an interface to
26743 the Cyrus SASL authentication library.
26744 The third is an interface to Dovecot's authentication system, delegating the
26745 work via a socket interface.
26746 The fourth provides for negotiation of authentication done via non-SMTP means,
26747 as defined by RFC 4422 Appendix A.
26748 The fifth provides an interface to the GNU SASL authentication library, which
26749 provides mechanisms but typically not data sources.
26750 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26751 supporting setting a server keytab.
26752 The seventh can be configured to support
26753 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26754 not formally documented, but used by several MUAs.
26755 The eighth authenticator
26756 supports Microsoft's &'Secure Password Authentication'& mechanism.
26757 The last is an Exim authenticator but not an SMTP one;
26758 instead it can use information from a TLS negotiation.
26759
26760 The authenticators are configured using the same syntax as other drivers (see
26761 section &<<SECTfordricon>>&). If no authenticators are required, no
26762 authentication section need be present in the configuration file. Each
26763 authenticator can in principle have both server and client functions. When Exim
26764 is receiving SMTP mail, it is acting as a server; when it is sending out
26765 messages over SMTP, it is acting as a client. Authenticator configuration
26766 options are provided for use in both these circumstances.
26767
26768 To make it clear which options apply to which situation, the prefixes
26769 &%server_%& and &%client_%& are used on option names that are specific to
26770 either the server or the client function, respectively. Server and client
26771 functions are disabled if none of their options are set. If an authenticator is
26772 to be used for both server and client functions, a single definition, using
26773 both sets of options, is required. For example:
26774 .code
26775 cram:
26776   driver = cram_md5
26777   public_name = CRAM-MD5
26778   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26779   client_name = ph10
26780   client_secret = secret2
26781 .endd
26782 The &%server_%& option is used when Exim is acting as a server, and the
26783 &%client_%& options when it is acting as a client.
26784
26785 Descriptions of the individual authenticators are given in subsequent chapters.
26786 The remainder of this chapter covers the generic options for the
26787 authenticators, followed by general discussion of the way authentication works
26788 in Exim.
26789
26790 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26791 per-mechanism basis.  Please read carefully to determine which variables hold
26792 account labels such as usercodes and which hold passwords or other
26793 authenticating data.
26794
26795 Note that some mechanisms support two different identifiers for accounts: the
26796 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26797 and &'authz'& are commonly encountered.  The American spelling is standard here.
26798 Conceptually, authentication data such as passwords are tied to the identifier
26799 used to authenticate; servers may have rules to permit one user to act as a
26800 second user, so that after login the session is treated as though that second
26801 user had logged in.  That second user is the &'authorization id'&.  A robust
26802 configuration might confirm that the &'authz'& field is empty or matches the
26803 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26804 as verified data, the &'authz'& as an unverified request which the server might
26805 choose to honour.
26806
26807 A &'realm'& is a text string, typically a domain name, presented by a server
26808 to a client to help it select an account and credentials to use.  In some
26809 mechanisms, the client and server provably agree on the realm, but clients
26810 typically can not treat the realm as secure data to be blindly trusted.
26811
26812
26813
26814 .section "Generic options for authenticators" "SECID168"
26815 .cindex "authentication" "generic options"
26816 .cindex "options" "generic; for authenticators"
26817
26818 .option client_condition authenticators string&!! unset
26819 When Exim is authenticating as a client, it skips any authenticator whose
26820 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26821 used, for example, to skip plain text authenticators when the connection is not
26822 encrypted by a setting such as:
26823 .code
26824 client_condition = ${if !eq{$tls_out_cipher}{}}
26825 .endd
26826
26827
26828 .option client_set_id authenticators string&!! unset
26829 When client authentication succeeds, this condition is expanded; the
26830 result is used in the log lines for outbound messages.
26831 Typically it will be the user name used for authentication.
26832
26833
26834 .option driver authenticators string unset
26835 This option must always be set. It specifies which of the available
26836 authenticators is to be used.
26837
26838
26839 .option public_name authenticators string unset
26840 This option specifies the name of the authentication mechanism that the driver
26841 implements, and by which it is known to the outside world. These names should
26842 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26843 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26844 defaults to the driver's instance name.
26845
26846
26847 .option server_advertise_condition authenticators string&!! unset
26848 When a server is about to advertise an authentication mechanism, the condition
26849 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26850 mechanism is not advertised.
26851 If the expansion fails, the mechanism is not advertised. If the failure was not
26852 forced, and was not caused by a lookup defer, the incident is logged.
26853 See section &<<SECTauthexiser>>& below for further discussion.
26854
26855
26856 .option server_condition authenticators string&!! unset
26857 This option must be set for a &%plaintext%& server authenticator, where it
26858 is used directly to control authentication. See section &<<SECTplainserver>>&
26859 for details.
26860
26861 For the &(gsasl)& authenticator, this option is required for various
26862 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26863
26864 For the other authenticators, &%server_condition%& can be used as an additional
26865 authentication or authorization mechanism that is applied after the other
26866 authenticator conditions succeed. If it is set, it is expanded when the
26867 authenticator would otherwise return a success code. If the expansion is forced
26868 to fail, authentication fails. Any other expansion failure causes a temporary
26869 error code to be returned. If the result of a successful expansion is an empty
26870 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26871 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26872 other result, a temporary error code is returned, with the expanded string as
26873 the error text.
26874
26875
26876 .option server_debug_print authenticators string&!! unset
26877 If this option is set and authentication debugging is enabled (see the &%-d%&
26878 command line option), the string is expanded and included in the debugging
26879 output when the authenticator is run as a server. This can help with checking
26880 out the values of variables.
26881 If expansion of the string fails, the error message is written to the debugging
26882 output, and Exim carries on processing.
26883
26884
26885 .option server_set_id authenticators string&!! unset
26886 .vindex "&$authenticated_id$&"
26887 .vindex "&$authenticated_fail_id$&"
26888 When an Exim server successfully authenticates a client, this string is
26889 expanded using data from the authentication, and preserved for any incoming
26890 messages in the variable &$authenticated_id$&. It is also included in the log
26891 lines for incoming messages. For example, a user/password authenticator
26892 configuration might preserve the user name that was used to authenticate, and
26893 refer to it subsequently during delivery of the message.
26894 On a failing authentication the expansion result is instead saved in
26895 the &$authenticated_fail_id$& variable.
26896 If expansion fails, the option is ignored.
26897
26898
26899 .option server_mail_auth_condition authenticators string&!! unset
26900 This option allows a server to discard authenticated sender addresses supplied
26901 as part of MAIL commands in SMTP connections that are authenticated by the
26902 driver on which &%server_mail_auth_condition%& is set. The option is not used
26903 as part of the authentication process; instead its (unexpanded) value is
26904 remembered for later use.
26905 How it is used is described in the following section.
26906
26907
26908
26909
26910
26911 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26912 .cindex "authentication" "sender; authenticated"
26913 .cindex "AUTH" "on MAIL command"
26914 When a client supplied an AUTH= item on a MAIL command, Exim applies
26915 the following checks before accepting it as the authenticated sender of the
26916 message:
26917
26918 .ilist
26919 If the connection is not using extended SMTP (that is, HELO was used rather
26920 than EHLO), the use of AUTH= is a syntax error.
26921 .next
26922 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26923 .next
26924 .vindex "&$authenticated_sender$&"
26925 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26926 running, the value of &$authenticated_sender$& is set to the value obtained
26927 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26928 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26929 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26930 given for the MAIL command.
26931 .next
26932 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26933 is accepted and placed in &$authenticated_sender$& only if the client has
26934 authenticated.
26935 .next
26936 If the AUTH= value was accepted by either of the two previous rules, and
26937 the client has authenticated, and the authenticator has a setting for the
26938 &%server_mail_auth_condition%&, the condition is checked at this point. The
26939 valued that was saved from the authenticator is expanded. If the expansion
26940 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26941 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26942 the value of &$authenticated_sender$& is retained and passed on with the
26943 message.
26944 .endlist
26945
26946
26947 When &$authenticated_sender$& is set for a message, it is passed on to other
26948 hosts to which Exim authenticates as a client. Do not confuse this value with
26949 &$authenticated_id$&, which is a string obtained from the authentication
26950 process, and which is not usually a complete email address.
26951
26952 .vindex "&$sender_address$&"
26953 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26954 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26955 therefore make use of &$authenticated_sender$&. The converse is not true: the
26956 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26957 ACL is run.
26958
26959
26960
26961 .section "Authentication on an Exim server" "SECTauthexiser"
26962 .cindex "authentication" "on an Exim server"
26963 When Exim receives an EHLO command, it advertises the public names of those
26964 authenticators that are configured as servers, subject to the following
26965 conditions:
26966
26967 .ilist
26968 The client host must match &%auth_advertise_hosts%& (default *).
26969 .next
26970 It the &%server_advertise_condition%& option is set, its expansion must not
26971 yield the empty string, &"0"&, &"no"&, or &"false"&.
26972 .endlist
26973
26974 The order in which the authenticators are defined controls the order in which
26975 the mechanisms are advertised.
26976
26977 Some mail clients (for example, some versions of Netscape) require the user to
26978 provide a name and password for authentication whenever AUTH is advertised,
26979 even though authentication may not in fact be needed (for example, Exim may be
26980 set up to allow unconditional relaying from the client by an IP address check).
26981 You can make such clients more friendly by not advertising AUTH to them.
26982 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26983 that runs for RCPT) to relay without authentication, you should set
26984 .code
26985 auth_advertise_hosts = ! 10.9.8.0/24
26986 .endd
26987 so that no authentication mechanisms are advertised to them.
26988
26989 The &%server_advertise_condition%& controls the advertisement of individual
26990 authentication mechanisms. For example, it can be used to restrict the
26991 advertisement of a particular mechanism to encrypted connections, by a setting
26992 such as:
26993 .code
26994 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26995 .endd
26996 .vindex "&$tls_in_cipher$&"
26997 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26998 yields &"yes"&, which allows the advertisement to happen.
26999
27000 When an Exim server receives an AUTH command from a client, it rejects it
27001 immediately if AUTH was not advertised in response to an earlier EHLO
27002 command. This is the case if
27003
27004 .ilist
27005 The client host does not match &%auth_advertise_hosts%&; or
27006 .next
27007 No authenticators are configured with server options; or
27008 .next
27009 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27010 server authenticators.
27011 .endlist
27012
27013
27014 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27015 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27016 AUTH is accepted from any client host.
27017
27018 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27019 server authentication mechanism that was advertised in response to EHLO and
27020 that matches the one named in the AUTH command. If it finds one, it runs
27021 the appropriate authentication protocol, and authentication either succeeds or
27022 fails. If there is no matching advertised mechanism, the AUTH command is
27023 rejected with a 504 error.
27024
27025 .vindex "&$received_protocol$&"
27026 .vindex "&$sender_host_authenticated$&"
27027 When a message is received from an authenticated host, the value of
27028 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27029 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27030 public name) of the authenticator driver that successfully authenticated the
27031 client from which the message was received. This variable is empty if there was
27032 no successful authentication.
27033
27034 .cindex authentication "expansion item"
27035 Successful authentication sets up information used by the
27036 &%authresults%& expansion item.
27037
27038
27039
27040
27041 .section "Testing server authentication" "SECID169"
27042 .cindex "authentication" "testing a server"
27043 .cindex "AUTH" "testing a server"
27044 .cindex "base64 encoding" "creating authentication test data"
27045 Exim's &%-bh%& option can be useful for testing server authentication
27046 configurations. The data for the AUTH command has to be sent using base64
27047 encoding. A quick way to produce such data for testing is the following Perl
27048 script:
27049 .code
27050 use MIME::Base64;
27051 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27052 .endd
27053 .cindex "binary zero" "in authentication data"
27054 This interprets its argument as a Perl string, and then encodes it. The
27055 interpretation as a Perl string allows binary zeros, which are required for
27056 some kinds of authentication, to be included in the data. For example, a
27057 command line to run this script on such data might be
27058 .code
27059 encode '\0user\0password'
27060 .endd
27061 Note the use of single quotes to prevent the shell interpreting the
27062 backslashes, so that they can be interpreted by Perl to specify characters
27063 whose code value is zero.
27064
27065 &*Warning 1*&: If either of the user or password strings starts with an octal
27066 digit, you must use three zeros instead of one after the leading backslash. If
27067 you do not, the octal digit that starts your string will be incorrectly
27068 interpreted as part of the code for the first character.
27069
27070 &*Warning 2*&: If there are characters in the strings that Perl interprets
27071 specially, you must use a Perl escape to prevent them being misinterpreted. For
27072 example, a command such as
27073 .code
27074 encode '\0user@domain.com\0pas$$word'
27075 .endd
27076 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27077
27078 If you have the &%mimencode%& command installed, another way to do produce
27079 base64-encoded strings is to run the command
27080 .code
27081 echo -e -n `\0user\0password' | mimencode
27082 .endd
27083 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27084 in the argument, and the &%-n%& option specifies no newline at the end of its
27085 output. However, not all versions of &%echo%& recognize these options, so you
27086 should check your version before relying on this suggestion.
27087
27088
27089
27090 .section "Authentication by an Exim client" "SECID170"
27091 .cindex "authentication" "on an Exim client"
27092 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27093 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27094 announces support for authentication, and the host matches an entry in either
27095 of these options, Exim (as a client) tries to authenticate as follows:
27096
27097 .ilist
27098 For each authenticator that is configured as a client, in the order in which
27099 they are defined in the configuration, it searches the authentication
27100 mechanisms announced by the server for one whose name matches the public name
27101 of the authenticator.
27102 .next
27103 .vindex "&$host$&"
27104 .vindex "&$host_address$&"
27105 When it finds one that matches, it runs the authenticator's client code. The
27106 variables &$host$& and &$host_address$& are available for any string expansions
27107 that the client might do. They are set to the server's name and IP address. If
27108 any expansion is forced to fail, the authentication attempt is abandoned, and
27109 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27110 delivery to be deferred.
27111 .next
27112 If the result of the authentication attempt is a temporary error or a timeout,
27113 Exim abandons trying to send the message to the host for the moment. It will
27114 try again later. If there are any backup hosts available, they are tried in the
27115 usual way.
27116 .next
27117 If the response to authentication is a permanent error (5&'xx'& code), Exim
27118 carries on searching the list of authenticators and tries another one if
27119 possible. If all authentication attempts give permanent errors, or if there are
27120 no attempts because no mechanisms match (or option expansions force failure),
27121 what happens depends on whether the host matches &%hosts_require_auth%& or
27122 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27123 delivery is deferred. The error can be detected in the retry rules, and thereby
27124 turned into a permanent error if you wish. In the second case, Exim tries to
27125 deliver the message unauthenticated.
27126 .endlist
27127
27128 Note that the hostlist test for whether to do authentication can be
27129 confused if name-IP lookups change between the time the peer is decided
27130 upon and the time that the transport runs.  For example, with a manualroute
27131 router given a host name, and with DNS "round-robin" used by that name: if
27132 the local resolver cache times out between the router and the transport
27133 running, the transport may get an IP for the name for its authentication
27134 check which does not match the connection peer IP.
27135 No authentication will then be done, despite the names being identical.
27136
27137 For such cases use a separate transport which always authenticates.
27138
27139 .cindex "AUTH" "on MAIL command"
27140 When Exim has authenticated itself to a remote server, it adds the AUTH
27141 parameter to the MAIL commands it sends, if it has an authenticated sender for
27142 the message. If the message came from a remote host, the authenticated sender
27143 is the one that was receiving on an incoming MAIL command, provided that the
27144 incoming connection was authenticated and the &%server_mail_auth%& condition
27145 allowed the authenticated sender to be retained. If a local process calls Exim
27146 to send a message, the sender address that is built from the login name and
27147 &%qualify_domain%& is treated as authenticated. However, if the
27148 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27149 the authenticated sender that was received with the message.
27150 .ecindex IIDauthconf1
27151 .ecindex IIDauthconf2
27152
27153
27154
27155
27156
27157
27158 . ////////////////////////////////////////////////////////////////////////////
27159 . ////////////////////////////////////////////////////////////////////////////
27160
27161 .chapter "The plaintext authenticator" "CHAPplaintext"
27162 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27163 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27164 The &(plaintext)& authenticator can be configured to support the PLAIN and
27165 LOGIN authentication mechanisms, both of which transfer authentication data as
27166 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27167 security risk; you are strongly advised to insist on the use of SMTP encryption
27168 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27169 use unencrypted plain text, you should not use the same passwords for SMTP
27170 connections as you do for login accounts.
27171
27172 .section "Avoiding cleartext use" "SECTplain_TLS"
27173 The following generic option settings will disable &(plaintext)& authenticators when
27174 TLS is not being used:
27175 .code
27176   server_advertise_condition = ${if def:tls_in_cipher }
27177   client_condition =           ${if def:tls_out_cipher}
27178 .endd
27179
27180 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27181 but is still vulnerable to a Man In The Middle attack unless certificates
27182 (including their names) have been properly verified.
27183
27184 .section "Plaintext server options" "SECID171"
27185 .cindex "options" "&(plaintext)& authenticator (server)"
27186 When configured as a server, &(plaintext)& uses the following options:
27187
27188 .option server_condition authenticators string&!! unset
27189 This is actually a global authentication option, but it must be set in order to
27190 configure the &(plaintext)& driver as a server. Its use is described below.
27191
27192 .option server_prompts plaintext "string list&!!" unset
27193 The contents of this option, after expansion, must be a colon-separated list of
27194 prompt strings. If expansion fails, a temporary authentication rejection is
27195 given.
27196
27197 .section "Using plaintext in a server" "SECTplainserver"
27198 .cindex "AUTH" "in &(plaintext)& authenticator"
27199 .cindex "binary zero" "in &(plaintext)& authenticator"
27200 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27201         "in &(plaintext)& authenticator"
27202 .vindex "&$auth1$&, &$auth2$&, etc"
27203 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27204
27205 When running as a server, &(plaintext)& performs the authentication test by
27206 expanding a string. The data sent by the client with the AUTH command, or in
27207 response to subsequent prompts, is base64 encoded, and so may contain any byte
27208 values when decoded. If any data is supplied with the command, it is treated as
27209 a list of strings, separated by NULs (binary zeros), the first three of which
27210 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27211 (neither LOGIN nor PLAIN uses more than three strings).
27212
27213 For compatibility with previous releases of Exim, the values are also placed in
27214 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27215 variables for this purpose is now deprecated, as it can lead to confusion in
27216 string expansions that also use them for other things.
27217
27218 If there are more strings in &%server_prompts%& than the number of strings
27219 supplied with the AUTH command, the remaining prompts are used to obtain more
27220 data. Each response from the client may be a list of NUL-separated strings.
27221
27222 .vindex "&$authenticated_id$&"
27223 Once a sufficient number of data strings have been received,
27224 &%server_condition%& is expanded. If the expansion is forced to fail,
27225 authentication fails. Any other expansion failure causes a temporary error code
27226 to be returned. If the result of a successful expansion is an empty string,
27227 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27228 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27229 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27230 For any other result, a temporary error code is returned, with the expanded
27231 string as the error text.
27232
27233 &*Warning*&: If you use a lookup in the expansion to find the user's
27234 password, be sure to make the authentication fail if the user is unknown.
27235 There are good and bad examples at the end of the next section.
27236
27237
27238
27239 .section "The PLAIN authentication mechanism" "SECID172"
27240 .cindex "PLAIN authentication mechanism"
27241 .cindex authentication PLAIN
27242 .cindex "binary zero" "in &(plaintext)& authenticator"
27243 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27244 sent as one item of data (that is, one combined string containing two NUL
27245 separators). The data is sent either as part of the AUTH command, or
27246 subsequently in response to an empty prompt from the server.
27247
27248 The second and third strings are a user name and a corresponding password.
27249 Using a single fixed user name and password as an example, this could be
27250 configured as follows:
27251 .code
27252 fixed_plain:
27253   driver = plaintext
27254   public_name = PLAIN
27255   server_prompts = :
27256   server_condition = \
27257     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27258   server_set_id = $auth2
27259 .endd
27260 Note that the default result strings from &%if%& (&"true"& or an empty string)
27261 are exactly what we want here, so they need not be specified. Obviously, if the
27262 password contains expansion-significant characters such as dollar, backslash,
27263 or closing brace, they have to be escaped.
27264
27265 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27266 the end of a string list are ignored). If all the data comes as part of the
27267 AUTH command, as is commonly the case, the prompt is not used. This
27268 authenticator is advertised in the response to EHLO as
27269 .code
27270 250-AUTH PLAIN
27271 .endd
27272 and a client host can authenticate itself by sending the command
27273 .code
27274 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27275 .endd
27276 As this contains three strings (more than the number of prompts), no further
27277 data is required from the client. Alternatively, the client may just send
27278 .code
27279 AUTH PLAIN
27280 .endd
27281 to initiate authentication, in which case the server replies with an empty
27282 prompt. The client must respond with the combined data string.
27283
27284 The data string is base64 encoded, as required by the RFC. This example,
27285 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27286 represents a zero byte. This is split up into three strings, the first of which
27287 is empty. The &%server_condition%& option in the authenticator checks that the
27288 second two are &`username`& and &`mysecret`& respectively.
27289
27290 Having just one fixed user name and password, as in this example, is not very
27291 realistic, though for a small organization with only a handful of
27292 authenticating clients it could make sense.
27293
27294 A more sophisticated instance of this authenticator could use the user name in
27295 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27296 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27297 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27298 This is an incorrect example:
27299 .code
27300 server_condition = \
27301   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27302 .endd
27303 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27304 which it then compares to the supplied password (&$auth3$&). Why is this example
27305 incorrect? It works fine for existing users, but consider what happens if a
27306 non-existent user name is given. The lookup fails, but as no success/failure
27307 strings are given for the lookup, it yields an empty string. Thus, to defeat
27308 the authentication, all a client has to do is to supply a non-existent user
27309 name and an empty password. The correct way of writing this test is:
27310 .code
27311 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27312   {${if eq{$value}{$auth3}}} {false}}
27313 .endd
27314 In this case, if the lookup succeeds, the result is checked; if the lookup
27315 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27316 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27317 always fails if its second argument is empty. However, the second way of
27318 writing the test makes the logic clearer.
27319
27320
27321 .section "The LOGIN authentication mechanism" "SECID173"
27322 .cindex "LOGIN authentication mechanism"
27323 .cindex authentication LOGIN
27324 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27325 in a number of programs. No data is sent with the AUTH command. Instead, a
27326 user name and password are supplied separately, in response to prompts. The
27327 plaintext authenticator can be configured to support this as in this example:
27328 .code
27329 fixed_login:
27330   driver = plaintext
27331   public_name = LOGIN
27332   server_prompts = User Name : Password
27333   server_condition = \
27334     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27335   server_set_id = $auth1
27336 .endd
27337 Because of the way plaintext operates, this authenticator accepts data supplied
27338 with the AUTH command (in contravention of the specification of LOGIN), but
27339 if the client does not supply it (as is the case for LOGIN clients), the prompt
27340 strings are used to obtain two data items.
27341
27342 Some clients are very particular about the precise text of the prompts. For
27343 example, Outlook Express is reported to recognize only &"Username:"& and
27344 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27345 strings. It uses the &%ldapauth%& expansion condition to check the user
27346 name and password by binding to an LDAP server:
27347 .code
27348 login:
27349   driver = plaintext
27350   public_name = LOGIN
27351   server_prompts = Username:: : Password::
27352   server_condition = ${if and{{ \
27353     !eq{}{$auth1} }{ \
27354     ldapauth{\
27355       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27356       pass=${quote:$auth2} \
27357       ldap://ldap.example.org/} }} }
27358   server_set_id = uid=$auth1,ou=people,o=example.org
27359 .endd
27360 We have to check that the username is not empty before using it, because LDAP
27361 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27362 operator to correctly quote the DN for authentication. However, the basic
27363 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27364 correct one to use for the password, because quoting is needed only to make
27365 the password conform to the Exim syntax. At the LDAP level, the password is an
27366 uninterpreted string.
27367
27368
27369 .section "Support for different kinds of authentication" "SECID174"
27370 A number of string expansion features are provided for the purpose of
27371 interfacing to different ways of user authentication. These include checking
27372 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27373 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27374 &<<SECTexpcond>>&.
27375
27376
27377
27378
27379 .section "Using plaintext in a client" "SECID175"
27380 .cindex "options" "&(plaintext)& authenticator (client)"
27381 The &(plaintext)& authenticator has two client options:
27382
27383 .option client_ignore_invalid_base64 plaintext boolean false
27384 If the client receives a server prompt that is not a valid base64 string,
27385 authentication is abandoned by default. However, if this option is set true,
27386 the error in the challenge is ignored and the client sends the response as
27387 usual.
27388
27389 .option client_send plaintext string&!! unset
27390 The string is a colon-separated list of authentication data strings. Each
27391 string is independently expanded before being sent to the server. The first
27392 string is sent with the AUTH command; any more strings are sent in response
27393 to prompts from the server. Before each string is expanded, the value of the
27394 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27395 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27396 way. Thus, the prompt that is received in response to sending the first string
27397 (with the AUTH command) can be used in the expansion of the second string, and
27398 so on. If an invalid base64 string is received when
27399 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27400 &$auth$&<&'n'&> variable.
27401
27402 &*Note*&: You cannot use expansion to create multiple strings, because
27403 splitting takes priority and happens first.
27404
27405 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27406 the data, further processing is applied to each string before it is sent. If
27407 there are any single circumflex characters in the string, they are converted to
27408 NULs. Should an actual circumflex be required as data, it must be doubled in
27409 the string.
27410
27411 This is an example of a client configuration that implements the PLAIN
27412 authentication mechanism with a fixed user name and password:
27413 .code
27414 fixed_plain:
27415   driver = plaintext
27416   public_name = PLAIN
27417   client_send = ^username^mysecret
27418 .endd
27419 The lack of colons means that the entire text is sent with the AUTH
27420 command, with the circumflex characters converted to NULs. A similar example
27421 that uses the LOGIN mechanism is:
27422 .code
27423 fixed_login:
27424   driver = plaintext
27425   public_name = LOGIN
27426   client_send = : username : mysecret
27427 .endd
27428 The initial colon means that the first string is empty, so no data is sent with
27429 the AUTH command itself. The remaining strings are sent in response to
27430 prompts.
27431 .ecindex IIDplaiauth1
27432 .ecindex IIDplaiauth2
27433
27434
27435
27436
27437 . ////////////////////////////////////////////////////////////////////////////
27438 . ////////////////////////////////////////////////////////////////////////////
27439
27440 .chapter "The cram_md5 authenticator" "CHID9"
27441 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27442 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27443 .cindex "CRAM-MD5 authentication mechanism"
27444 .cindex authentication CRAM-MD5
27445 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27446 sends a challenge string to the client, and the response consists of a user
27447 name and the CRAM-MD5 digest of the challenge string combined with a secret
27448 string (password) which is known to both server and client. Thus, the secret
27449 is not sent over the network as plain text, which makes this authenticator more
27450 secure than &(plaintext)&. However, the downside is that the secret has to be
27451 available in plain text at either end.
27452
27453
27454 .section "Using cram_md5 as a server" "SECID176"
27455 .cindex "options" "&(cram_md5)& authenticator (server)"
27456 This authenticator has one server option, which must be set to configure the
27457 authenticator as a server:
27458
27459 .option server_secret cram_md5 string&!! unset
27460 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27461 When the server receives the client's response, the user name is placed in
27462 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27463 obtain the password for that user. The server then computes the CRAM-MD5 digest
27464 that the client should have sent, and checks that it received the correct
27465 string. If the expansion of &%server_secret%& is forced to fail, authentication
27466 fails. If the expansion fails for some other reason, a temporary error code is
27467 returned to the client.
27468
27469 For compatibility with previous releases of Exim, the user name is also placed
27470 in &$1$&. However, the use of this variables for this purpose is now
27471 deprecated, as it can lead to confusion in string expansions that also use
27472 numeric variables for other things.
27473
27474 For example, the following authenticator checks that the user name given by the
27475 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27476 user name, authentication fails.
27477 .code
27478 fixed_cram:
27479   driver = cram_md5
27480   public_name = CRAM-MD5
27481   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27482   server_set_id = $auth1
27483 .endd
27484 .vindex "&$authenticated_id$&"
27485 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27486 name in &$authenticated_id$&. A more typical configuration might look up the
27487 secret string in a file, using the user name as the key. For example:
27488 .code
27489 lookup_cram:
27490   driver = cram_md5
27491   public_name = CRAM-MD5
27492   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27493                   {$value}fail}
27494   server_set_id = $auth1
27495 .endd
27496 Note that this expansion explicitly forces failure if the lookup fails
27497 because &$auth1$& contains an unknown user name.
27498
27499 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27500 using the relevant libraries, you need to know the realm to specify in the
27501 lookup and then ask for the &"userPassword"& attribute for that user in that
27502 realm, with:
27503 .code
27504 cyrusless_crammd5:
27505   driver = cram_md5
27506   public_name = CRAM-MD5
27507   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27508                   dbmjz{/etc/sasldb2}{$value}fail}
27509   server_set_id = $auth1
27510 .endd
27511
27512 .section "Using cram_md5 as a client" "SECID177"
27513 .cindex "options" "&(cram_md5)& authenticator (client)"
27514 When used as a client, the &(cram_md5)& authenticator has two options:
27515
27516
27517
27518 .option client_name cram_md5 string&!! "the primary host name"
27519 This string is expanded, and the result used as the user name data when
27520 computing the response to the server's challenge.
27521
27522
27523 .option client_secret cram_md5 string&!! unset
27524 This option must be set for the authenticator to work as a client. Its value is
27525 expanded and the result used as the secret string when computing the response.
27526
27527
27528 .vindex "&$host$&"
27529 .vindex "&$host_address$&"
27530 Different user names and secrets can be used for different servers by referring
27531 to &$host$& or &$host_address$& in the options. Forced failure of either
27532 expansion string is treated as an indication that this authenticator is not
27533 prepared to handle this case. Exim moves on to the next configured client
27534 authenticator. Any other expansion failure causes Exim to give up trying to
27535 send the message to the current server.
27536
27537 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27538 strings, is:
27539 .code
27540 fixed_cram:
27541   driver = cram_md5
27542   public_name = CRAM-MD5
27543   client_name = ph10
27544   client_secret = secret
27545 .endd
27546 .ecindex IIDcramauth1
27547 .ecindex IIDcramauth2
27548
27549
27550
27551 . ////////////////////////////////////////////////////////////////////////////
27552 . ////////////////////////////////////////////////////////////////////////////
27553
27554 .chapter "The cyrus_sasl authenticator" "CHID10"
27555 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27556 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27557 .cindex "Cyrus" "SASL library"
27558 .cindex "Kerberos"
27559 The code for this authenticator was provided by Matthew Byng-Maddick while
27560 at A L Digital Ltd.
27561
27562 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27563 library implementation of the RFC 2222 (&"Simple Authentication and Security
27564 Layer"&). This library supports a number of authentication mechanisms,
27565 including PLAIN and LOGIN, but also several others that Exim does not support
27566 directly. In particular, there is support for Kerberos authentication.
27567
27568 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27569 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27570 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27571 name of the driver to determine which mechanism to support.
27572
27573 Where access to some kind of secret file is required, for example, in GSSAPI
27574 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27575 user, and that the Cyrus SASL library has no way of escalating privileges
27576 by default. You may also find you need to set environment variables,
27577 depending on the driver you are using.
27578
27579 The application name provided by Exim is &"exim"&, so various SASL options may
27580 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27581 Kerberos, note that because of limitations in the GSSAPI interface,
27582 changing the server keytab might need to be communicated down to the Kerberos
27583 layer independently. The mechanism for doing so is dependent upon the Kerberos
27584 implementation.
27585
27586 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27587 may be set to point to an alternative keytab file. Exim will pass this
27588 variable through from its own inherited environment when started as root or the
27589 Exim user. The keytab file needs to be readable by the Exim user.
27590 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27591 environment variable.  In practice, for those releases, the Cyrus authenticator
27592 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27593 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27594
27595
27596 .section "Using cyrus_sasl as a server" "SECID178"
27597 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27598 (on a successful authentication) into &$auth1$&. For compatibility with
27599 previous releases of Exim, the username is also placed in &$1$&. However, the
27600 use of this variable for this purpose is now deprecated, as it can lead to
27601 confusion in string expansions that also use numeric variables for other
27602 things.
27603
27604
27605 .option server_hostname cyrus_sasl string&!! "see below"
27606 This option selects the hostname that is used when communicating with the
27607 library. The default value is &`$primary_hostname`&. It is up to the underlying
27608 SASL plug-in what it does with this data.
27609
27610
27611 .option server_mech cyrus_sasl string "see below"
27612 This option selects the authentication mechanism this driver should use. The
27613 default is the value of the generic &%public_name%& option. This option allows
27614 you to use a different underlying mechanism from the advertised name. For
27615 example:
27616 .code
27617 sasl:
27618   driver = cyrus_sasl
27619   public_name = X-ANYTHING
27620   server_mech = CRAM-MD5
27621   server_set_id = $auth1
27622 .endd
27623
27624 .option server_realm cyrus_sasl string&!! unset
27625 This specifies the SASL realm that the server claims to be in.
27626
27627
27628 .option server_service cyrus_sasl string &`smtp`&
27629 This is the SASL service that the server claims to implement.
27630
27631
27632 For straightforward cases, you do not need to set any of the authenticator's
27633 private options. All you need to do is to specify an appropriate mechanism as
27634 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27635 PLAIN, you could have two authenticators as follows:
27636 .code
27637 sasl_cram_md5:
27638   driver = cyrus_sasl
27639   public_name = CRAM-MD5
27640   server_set_id = $auth1
27641
27642 sasl_plain:
27643   driver = cyrus_sasl
27644   public_name = PLAIN
27645   server_set_id = $auth2
27646 .endd
27647 Cyrus SASL does implement the LOGIN authentication method, even though it is
27648 not a standard method. It is disabled by default in the source distribution,
27649 but it is present in many binary distributions.
27650 .ecindex IIDcyrauth1
27651 .ecindex IIDcyrauth2
27652
27653
27654
27655
27656 . ////////////////////////////////////////////////////////////////////////////
27657 . ////////////////////////////////////////////////////////////////////////////
27658 .chapter "The dovecot authenticator" "CHAPdovecot"
27659 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27660 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27661 This authenticator is an interface to the authentication facility of the
27662 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27663 Note that Dovecot must be configured to use auth-client not auth-userdb.
27664 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27665 to use the same mechanisms for SMTP authentication. This is a server
27666 authenticator only. There is only one option:
27667
27668 .option server_socket dovecot string unset
27669
27670 This option must specify the UNIX socket that is the interface to Dovecot
27671 authentication. The &%public_name%& option must specify an authentication
27672 mechanism that Dovecot is configured to support. You can have several
27673 authenticators for different mechanisms. For example:
27674 .code
27675 dovecot_plain:
27676   driver = dovecot
27677   public_name = PLAIN
27678   server_socket = /var/run/dovecot/auth-client
27679   server_set_id = $auth1
27680
27681 dovecot_ntlm:
27682   driver = dovecot
27683   public_name = NTLM
27684   server_socket = /var/run/dovecot/auth-client
27685   server_set_id = $auth1
27686 .endd
27687 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27688 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27689 option is passed in the Dovecot authentication command. If, for a TLS
27690 connection, a client certificate has been verified, the &"valid-client-cert"&
27691 option is passed. When authentication succeeds, the identity of the user
27692 who authenticated is placed in &$auth1$&.
27693
27694 .new
27695 The Dovecot configuration to match the above wil look
27696 something like:
27697 .code
27698 conf.d/10-master.conf :-
27699
27700 service auth {
27701 ...
27702 #SASL
27703   unix_listener auth-client {
27704     mode = 0660
27705     user = mail
27706   }
27707 ...
27708 }
27709
27710 conf.d/10-auth.conf :-
27711
27712 auth_mechanisms = plain login ntlm
27713 .endd
27714 .wen
27715
27716 .ecindex IIDdcotauth1
27717 .ecindex IIDdcotauth2
27718
27719
27720 . ////////////////////////////////////////////////////////////////////////////
27721 . ////////////////////////////////////////////////////////////////////////////
27722 .chapter "The gsasl authenticator" "CHAPgsasl"
27723 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27724 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27725 .cindex "authentication" "GNU SASL"
27726 .cindex "authentication" "SASL"
27727 .cindex "authentication" "EXTERNAL"
27728 .cindex "authentication" "ANONYMOUS"
27729 .cindex "authentication" "PLAIN"
27730 .cindex "authentication" "LOGIN"
27731 .cindex "authentication" "DIGEST-MD5"
27732 .cindex "authentication" "CRAM-MD5"
27733 .cindex "authentication" "SCRAM family"
27734 The &(gsasl)& authenticator provides integration for the GNU SASL
27735 library and the mechanisms it provides.  This is new as of the 4.80 release
27736 and there are a few areas where the library does not let Exim smoothly
27737 scale to handle future authentication mechanisms, so no guarantee can be
27738 made that any particular new authentication mechanism will be supported
27739 without code changes in Exim.
27740
27741 .new
27742 The library is expected to add support in an upcoming
27743 realease for the SCRAM-SHA-256 method.
27744 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27745 when this happens.
27746
27747
27748 .option client_authz gsasl string&!! unset
27749 This option can be used to supply an &'authorization id'&
27750 which is different to the &'authentication_id'& provided
27751 by &%client_username%& option.
27752 If unset or (after expansion) empty it is not used,
27753 which is the common case.
27754
27755 .option client_channelbinding gsasl boolean false
27756 See &%server_channelbinding%& below.
27757
27758 .option client_password gsasl string&!! unset
27759 This option is exapanded before use, and should result in
27760 the password to be used, in clear.
27761
27762 .option client_username gsasl string&!! unset
27763 This option is exapanded before use, and should result in
27764 the account name to be used.
27765 .wen
27766
27767 .new
27768 .option client_spassword gsasl string&!! unset
27769 If a SCRAM mechanism is being used and this option is set
27770 it is used in preference to &%client_password%&.
27771 The value after expansion should be
27772 a 40 (for SHA-1) or 64 (for SHA-256) character string
27773 with the PBKDF2-prepared password, hex-encoded.
27774 Note that this value will depend on the salt and iteration-count
27775 supplied by the server.
27776 .wen
27777
27778
27779
27780 .option server_channelbinding gsasl boolean false
27781 Do not set this true and rely on the properties
27782 without consulting a cryptographic engineer.
27783
27784 Some authentication mechanisms are able to use external context at both ends
27785 of the session to bind the authentication to that context, and fail the
27786 authentication process if that context differs.  Specifically, some TLS
27787 ciphersuites can provide identifying information about the cryptographic
27788 context.
27789
27790 This should have meant that certificate identity and verification becomes a
27791 non-issue, as a man-in-the-middle attack will cause the correct client and
27792 server to see different identifiers and authentication will fail.
27793
27794 .new
27795 This is
27796 only usable by mechanisms which support "channel binding"; at time of
27797 writing, that's the SCRAM family.
27798 When using this feature the "-PLUS" variants of the method names need to be used.
27799 .wen
27800
27801 This defaults off to ensure smooth upgrade across Exim releases, in case
27802 this option causes some clients to start failing.  Some future release
27803 of Exim might have switched the default to be true.
27804
27805 However, Channel Binding in TLS has proven to be vulnerable in current versions.
27806 Do not plan to rely upon this feature for security, ever, without consulting
27807 with a subject matter expert (a cryptographic engineer).
27808
27809
27810 .option server_hostname gsasl string&!! "see below"
27811 This option selects the hostname that is used when communicating with the
27812 library. The default value is &`$primary_hostname`&.
27813 Some mechanisms will use this data.
27814
27815
27816 .option server_mech gsasl string "see below"
27817 This option selects the authentication mechanism this driver should use. The
27818 default is the value of the generic &%public_name%& option. This option allows
27819 you to use a different underlying mechanism from the advertised name. For
27820 example:
27821 .code
27822 sasl:
27823   driver = gsasl
27824   public_name = X-ANYTHING
27825   server_mech = CRAM-MD5
27826   server_set_id = $auth1
27827 .endd
27828
27829
27830 .option server_password gsasl string&!! unset
27831 Various mechanisms need access to the cleartext password on the server, so
27832 that proof-of-possession can be demonstrated on the wire, without sending
27833 the password itself.
27834
27835 The data available for lookup varies per mechanism.
27836 In all cases, &$auth1$& is set to the &'authentication id'&.
27837 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27838 if available, else the empty string.
27839 The &$auth3$& variable will always be the &'realm'& if available,
27840 else the empty string.
27841
27842 A forced failure will cause authentication to defer.
27843
27844 If using this option, it may make sense to set the &%server_condition%&
27845 option to be simply "true".
27846
27847
27848 .option server_realm gsasl string&!! unset
27849 This specifies the SASL realm that the server claims to be in.
27850 Some mechanisms will use this data.
27851
27852
27853 .option server_scram_iter gsasl string&!! 4096
27854 This option provides data for the SCRAM family of mechanisms.
27855 .new
27856 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27857 when this option is expanded.
27858
27859 The result of expansion should be a decimal number,
27860 and represents both a lower-bound on the security, and
27861 a compute cost factor imposed on the client
27862 (if it does not cache results, or the server changes
27863 either the iteration count or the salt).
27864 A minimum value of 4096 is required by the standards
27865 for all current SCRAM mechanism variants.
27866 .wen
27867
27868 .option server_scram_salt gsasl string&!! unset
27869 This option provides data for the SCRAM family of mechanisms.
27870 .new
27871 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27872 when this option is expanded.
27873 The value should be a base64-encoded string,
27874 of random data typically 4-to-16 bytes long.
27875 If unset or empty after expansion the library will provides a value for the
27876 protocol conversation.
27877 .wen
27878
27879
27880 .new
27881 .option server_key gsasl string&!! unset
27882 .option server_skey gsasl string&!! unset
27883 These options can be used for the SCRAM family of mechanisms
27884 to provide stored information related to a password,
27885 the storage of which is preferable to plaintext.
27886
27887 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
27888 &%server_skey%& is StoredKey.
27889
27890 They are only available for version 1.9.0 (or later) of the gsasl library.
27891 When this is so, the macros
27892 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
27893 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
27894 will be defined.
27895
27896 The &$authN$& variables are available when these options are expanded.
27897
27898 If set, the results of expansion should for each
27899 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
27900 of base64-coded data, and will be used in preference to the
27901 &%server_password%& option.
27902 If unset or not of the right length, &%server_password%& will be used.
27903
27904 The libgsasl library release includes a utility &'gsasl'& which can be used
27905 to generate these values.
27906 .wen
27907
27908
27909 .option server_service gsasl string &`smtp`&
27910 This is the SASL service that the server claims to implement.
27911 Some mechanisms will use this data.
27912
27913
27914 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27915 .vindex "&$auth1$&, &$auth2$&, etc"
27916 These may be set when evaluating specific options, as detailed above.
27917 They will also be set when evaluating &%server_condition%&.
27918
27919 Unless otherwise stated below, the &(gsasl)& integration will use the following
27920 meanings for these variables:
27921
27922 .ilist
27923 .vindex "&$auth1$&"
27924 &$auth1$&: the &'authentication id'&
27925 .next
27926 .vindex "&$auth2$&"
27927 &$auth2$&: the &'authorization id'&
27928 .next
27929 .vindex "&$auth3$&"
27930 &$auth3$&: the &'realm'&
27931 .endlist
27932
27933 On a per-mechanism basis:
27934
27935 .ilist
27936 .cindex "authentication" "EXTERNAL"
27937 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27938 the &%server_condition%& option must be present.
27939 .next
27940 .cindex "authentication" "ANONYMOUS"
27941 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27942 the &%server_condition%& option must be present.
27943 .next
27944 .cindex "authentication" "GSSAPI"
27945 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27946 &$auth2$& will be set to the &'authorization id'&,
27947 the &%server_condition%& option must be present.
27948 .endlist
27949
27950 An &'anonymous token'& is something passed along as an unauthenticated
27951 identifier; this is analogous to FTP anonymous authentication passing an
27952 email address, or software-identifier@, as the "password".
27953
27954
27955 An example showing the password having the realm specified in the callback
27956 and demonstrating a Cyrus SASL to GSASL migration approach is:
27957 .code
27958 gsasl_cyrusless_crammd5:
27959   driver = gsasl
27960   public_name = CRAM-MD5
27961   server_realm = imap.example.org
27962   server_password = ${lookup{$auth1:$auth3:userPassword}\
27963                     dbmjz{/etc/sasldb2}{$value}fail}
27964   server_set_id = ${quote:$auth1}
27965   server_condition = yes
27966 .endd
27967
27968
27969 . ////////////////////////////////////////////////////////////////////////////
27970 . ////////////////////////////////////////////////////////////////////////////
27971
27972 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27973 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27974 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27975 .cindex "authentication" "GSSAPI"
27976 .cindex "authentication" "Kerberos"
27977 The &(heimdal_gssapi)& authenticator provides server integration for the
27978 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27979 reliably.
27980
27981 .option server_hostname heimdal_gssapi string&!! "see below"
27982 This option selects the hostname that is used, with &%server_service%&,
27983 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27984 identifier.  The default value is &`$primary_hostname`&.
27985
27986 .option server_keytab heimdal_gssapi string&!! unset
27987 If set, then Heimdal will not use the system default keytab (typically
27988 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27989 The value should be a pathname, with no &"file:"& prefix.
27990
27991 .option server_service heimdal_gssapi string&!! "smtp"
27992 This option specifies the service identifier used, in conjunction with
27993 &%server_hostname%&, for building the identifier for finding credentials
27994 from the keytab.
27995
27996
27997 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27998 Beware that these variables will typically include a realm, thus will appear
27999 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28000 not verified, so a malicious client can set it to anything.
28001
28002 The &$auth1$& field should be safely trustable as a value from the Key
28003 Distribution Center.  Note that these are not quite email addresses.
28004 Each identifier is for a role, and so the left-hand-side may include a
28005 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28006
28007 .vindex "&$auth1$&, &$auth2$&, etc"
28008 .ilist
28009 .vindex "&$auth1$&"
28010 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28011 .next
28012 .vindex "&$auth2$&"
28013 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28014 authentication.  If that was empty, this will also be set to the
28015 GSS Display Name.
28016 .endlist
28017
28018
28019 . ////////////////////////////////////////////////////////////////////////////
28020 . ////////////////////////////////////////////////////////////////////////////
28021
28022 .chapter "The spa authenticator" "CHAPspa"
28023 .scindex IIDspaauth1 "&(spa)& authenticator"
28024 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28025 .cindex "authentication" "Microsoft Secure Password"
28026 .cindex "authentication" "NTLM"
28027 .cindex "Microsoft Secure Password Authentication"
28028 .cindex "NTLM authentication"
28029 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28030 Password Authentication'& mechanism,
28031 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28032 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28033 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28034 server side was subsequently contributed by Tom Kistner. The mechanism works as
28035 follows:
28036
28037 .ilist
28038 After the AUTH command has been accepted, the client sends an SPA
28039 authentication request based on the user name and optional domain.
28040 .next
28041 The server sends back a challenge.
28042 .next
28043 The client builds a challenge response which makes use of the user's password
28044 and sends it to the server, which then accepts or rejects it.
28045 .endlist
28046
28047 Encryption is used to protect the password in transit.
28048
28049
28050
28051 .section "Using spa as a server" "SECID179"
28052 .cindex "options" "&(spa)& authenticator (server)"
28053 The &(spa)& authenticator has just one server option:
28054
28055 .option server_password spa string&!! unset
28056 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28057 This option is expanded, and the result must be the cleartext password for the
28058 authenticating user, whose name is at this point in &$auth1$&. For
28059 compatibility with previous releases of Exim, the user name is also placed in
28060 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28061 it can lead to confusion in string expansions that also use numeric variables
28062 for other things. For example:
28063 .code
28064 spa:
28065   driver = spa
28066   public_name = NTLM
28067   server_password = \
28068     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28069 .endd
28070 If the expansion is forced to fail, authentication fails. Any other expansion
28071 failure causes a temporary error code to be returned.
28072
28073
28074
28075
28076
28077 .section "Using spa as a client" "SECID180"
28078 .cindex "options" "&(spa)& authenticator (client)"
28079 The &(spa)& authenticator has the following client options:
28080
28081
28082
28083 .option client_domain spa string&!! unset
28084 This option specifies an optional domain for the authentication.
28085
28086
28087 .option client_password spa string&!! unset
28088 This option specifies the user's password, and must be set.
28089
28090
28091 .option client_username spa string&!! unset
28092 This option specifies the user name, and must be set. Here is an example of a
28093 configuration of this authenticator for use with the mail servers at
28094 &'msn.com'&:
28095 .code
28096 msn:
28097   driver = spa
28098   public_name = MSN
28099   client_username = msn/msn_username
28100   client_password = msn_plaintext_password
28101   client_domain = DOMAIN_OR_UNSET
28102 .endd
28103 .ecindex IIDspaauth1
28104 .ecindex IIDspaauth2
28105
28106
28107
28108
28109
28110 . ////////////////////////////////////////////////////////////////////////////
28111 . ////////////////////////////////////////////////////////////////////////////
28112
28113 .chapter "The external authenticator" "CHAPexternauth"
28114 .scindex IIDexternauth1 "&(external)& authenticator"
28115 .scindex IIDexternauth2 "authenticators" "&(external)&"
28116 .cindex "authentication" "Client Certificate"
28117 .cindex "authentication" "X509"
28118 .cindex "Certificate-based authentication"
28119 The &(external)& authenticator provides support for
28120 authentication based on non-SMTP information.
28121 The specification is in RFC 4422 Appendix A
28122 (&url(https://tools.ietf.org/html/rfc4422)).
28123 It is only a transport and negotiation mechanism;
28124 the process of authentication is entirely controlled
28125 by the server configuration.
28126
28127 The client presents an identity in-clear.
28128 It is probably wise for a server to only advertise,
28129 and for clients to only attempt,
28130 this authentication method on a secure (eg. under TLS) connection.
28131
28132 One possible use, compatible with the
28133 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28134 is for using X509 client certificates.
28135
28136 It thus overlaps in function with the TLS authenticator
28137 (see &<<CHAPtlsauth>>&)
28138 but is a full SMTP SASL authenticator
28139 rather than being implicit for TLS-connection carried
28140 client certificates only.
28141
28142 The examples and discussion in this chapter assume that
28143 client-certificate authentication is being done.
28144
28145 The client must present a certificate,
28146 for which it must have been requested via the
28147 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28148 (see &<<CHAPTLS>>&).
28149 For authentication to be effective the certificate should be
28150 verifiable against a trust-anchor certificate known to the server.
28151
28152 .section "External options" "SECTexternsoptions"
28153 .cindex "options" "&(external)& authenticator (server)"
28154 The &(external)& authenticator has two server options:
28155
28156 .option server_param2 external string&!! unset
28157 .option server_param3 external string&!! unset
28158 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28159 These options are expanded before the &%server_condition%& option
28160 and the result are placed in &$auth2$& and &$auth3$& resectively.
28161 If the expansion is forced to fail, authentication fails. Any other expansion
28162 failure causes a temporary error code to be returned.
28163
28164 They can be used to clarify the coding of a complex &%server_condition%&.
28165
28166 .section "Using external in a server" "SECTexternserver"
28167 .cindex "AUTH" "in &(external)& authenticator"
28168 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28169         "in &(external)& authenticator"
28170 .vindex "&$auth1$&, &$auth2$&, etc"
28171 .cindex "base64 encoding" "in &(external)& authenticator"
28172
28173 When running as a server, &(external)& performs the authentication test by
28174 expanding a string. The data sent by the client with the AUTH command, or in
28175 response to subsequent prompts, is base64 encoded, and so may contain any byte
28176 values when decoded. The decoded value is treated as
28177 an identity for authentication and
28178 placed in the expansion variable &$auth1$&.
28179
28180 For compatibility with previous releases of Exim, the value is also placed in
28181 the expansion variable &$1$&. However, the use of this
28182 variable for this purpose is now deprecated, as it can lead to confusion in
28183 string expansions that also use them for other things.
28184
28185 .vindex "&$authenticated_id$&"
28186 Once an identity has been received,
28187 &%server_condition%& is expanded. If the expansion is forced to fail,
28188 authentication fails. Any other expansion failure causes a temporary error code
28189 to be returned. If the result of a successful expansion is an empty string,
28190 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28191 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28192 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28193 For any other result, a temporary error code is returned, with the expanded
28194 string as the error text.
28195
28196 Example:
28197 .code
28198 ext_ccert_san_mail:
28199   driver =            external
28200   public_name =       EXTERNAL
28201
28202   server_advertise_condition = $tls_in_certificate_verified
28203   server_param2 =     ${certextract {subj_altname,mail,>:} \
28204                                     {$tls_in_peercert}}
28205   server_condition =  ${if forany {$auth2} \
28206                             {eq {$item}{$auth1}}}
28207   server_set_id =     $auth1
28208 .endd
28209 This accepts a client certificate that is verifiable against any
28210 of your configured trust-anchors
28211 (which usually means the full set of public CAs)
28212 and which has a mail-SAN matching the claimed identity sent by the client.
28213
28214 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28215 The account name is therefore guessable by an opponent.
28216 TLS 1.3 protects both server and client certificates, and is not vulnerable
28217 in this way.
28218
28219
28220 .section "Using external in a client" "SECTexternclient"
28221 .cindex "options" "&(external)& authenticator (client)"
28222 The &(external)& authenticator has one client option:
28223
28224 .option client_send external string&!! unset
28225 This option is expanded and sent with the AUTH command as the
28226 identity being asserted.
28227
28228 Example:
28229 .code
28230 ext_ccert:
28231   driver =      external
28232   public_name = EXTERNAL
28233
28234   client_condition = ${if !eq{$tls_out_cipher}{}}
28235   client_send = myaccount@smarthost.example.net
28236 .endd
28237
28238
28239 .ecindex IIDexternauth1
28240 .ecindex IIDexternauth2
28241
28242
28243
28244
28245
28246 . ////////////////////////////////////////////////////////////////////////////
28247 . ////////////////////////////////////////////////////////////////////////////
28248
28249 .chapter "The tls authenticator" "CHAPtlsauth"
28250 .scindex IIDtlsauth1 "&(tls)& authenticator"
28251 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28252 .cindex "authentication" "Client Certificate"
28253 .cindex "authentication" "X509"
28254 .cindex "Certificate-based authentication"
28255 The &(tls)& authenticator provides server support for
28256 authentication based on client certificates.
28257
28258 It is not an SMTP authentication mechanism and is not
28259 advertised by the server as part of the SMTP EHLO response.
28260 It is an Exim authenticator in the sense that it affects
28261 the protocol element of the log line, can be tested for
28262 by the &%authenticated%& ACL condition, and can set
28263 the &$authenticated_id$& variable.
28264
28265 The client must present a verifiable certificate,
28266 for which it must have been requested via the
28267 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28268 (see &<<CHAPTLS>>&).
28269
28270 If an authenticator of this type is configured it is
28271 run before any SMTP-level communication is done,
28272 and can authenticate the connection.
28273 If it does, SMTP authentication is not offered.
28274
28275 A maximum of one authenticator of this type may be present.
28276
28277
28278 .cindex "options" "&(tls)& authenticator (server)"
28279 The &(tls)& authenticator has three server options:
28280
28281 .option server_param1 tls string&!! unset
28282 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28283 This option is expanded after the TLS negotiation and
28284 the result is placed in &$auth1$&.
28285 If the expansion is forced to fail, authentication fails. Any other expansion
28286 failure causes a temporary error code to be returned.
28287
28288 .option server_param2 tls string&!! unset
28289 .option server_param3 tls string&!! unset
28290 As above, for &$auth2$& and &$auth3$&.
28291
28292 &%server_param1%& may also be spelled &%server_param%&.
28293
28294
28295 Example:
28296 .code
28297 tls:
28298   driver = tls
28299   server_param1 =     ${certextract {subj_altname,mail,>:} \
28300                                     {$tls_in_peercert}}
28301   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28302                                  {forany {$auth1} \
28303                             {!= {0} \
28304                                 {${lookup ldap{ldap:///\
28305                          mailname=${quote_ldap_dn:${lc:$item}},\
28306                          ou=users,LDAP_DC?mailid} {$value}{0} \
28307                        }    }  } }}}
28308   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28309 .endd
28310 This accepts a client certificate that is verifiable against any
28311 of your configured trust-anchors
28312 (which usually means the full set of public CAs)
28313 and which has a SAN with a good account name.
28314
28315 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28316 The account name is therefore guessable by an opponent.
28317 TLS 1.3 protects both server and client certificates, and is not vulnerable
28318 in this way.
28319 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28320
28321 . An alternative might use
28322 . .code
28323 .   server_param1 = ${sha256:$tls_in_peercert}
28324 . .endd
28325 . to require one of a set of specific certs that define a given account
28326 . (the verification is still required, but mostly irrelevant).
28327 . This would help for per-device use.
28328 .
28329 . However, for the future we really need support for checking a
28330 . user cert in LDAP - which probably wants a base-64 DER.
28331
28332 .ecindex IIDtlsauth1
28333 .ecindex IIDtlsauth2
28334
28335
28336 Note that because authentication is traditionally an SMTP operation,
28337 the &%authenticated%& ACL condition cannot be used in
28338 a connect- or helo-ACL.
28339
28340
28341
28342 . ////////////////////////////////////////////////////////////////////////////
28343 . ////////////////////////////////////////////////////////////////////////////
28344
28345 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28346          "Encrypted SMTP connections"
28347 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28348 .scindex IIDencsmtp2 "SMTP" "encryption"
28349 .cindex "TLS" "on SMTP connection"
28350 .cindex "OpenSSL"
28351 .cindex "GnuTLS"
28352 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28353 Sockets Layer), is implemented by making use of the OpenSSL library or the
28354 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28355 cryptographic code in the Exim distribution itself for implementing TLS. In
28356 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28357 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28358 You also need to understand the basic concepts of encryption at a managerial
28359 level, and in particular, the way that public keys, private keys, and
28360 certificates are used.
28361
28362 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28363 connection is established, the client issues a STARTTLS command. If the
28364 server accepts this, the client and the server negotiate an encryption
28365 mechanism. If the negotiation succeeds, the data that subsequently passes
28366 between them is encrypted.
28367
28368 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28369 and if so, what cipher suite is in use, whether the client supplied a
28370 certificate, and whether or not that certificate was verified. This makes it
28371 possible for an Exim server to deny or accept certain commands based on the
28372 encryption state.
28373
28374 &*Warning*&: Certain types of firewall and certain anti-virus products can
28375 disrupt TLS connections. You need to turn off SMTP scanning for these products
28376 in order to get TLS to work.
28377
28378
28379
28380 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28381          "SECID284"
28382 .cindex "submissions protocol"
28383 .cindex "ssmtp protocol"
28384 .cindex "smtps protocol"
28385 .cindex "SMTP" "submissions protocol"
28386 .cindex "SMTP" "ssmtp protocol"
28387 .cindex "SMTP" "smtps protocol"
28388 The history of port numbers for TLS in SMTP is a little messy and has been
28389 contentious.  As of RFC 8314, the common practice of using the historically
28390 allocated port 465 for "email submission but with TLS immediately upon connect
28391 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28392 by them in preference to STARTTLS.
28393
28394 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28395 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28396 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28397
28398 This approach was, for a while, officially abandoned when encrypted SMTP was
28399 standardized, but many clients kept using it, even as the TCP port number was
28400 reassigned for other use.
28401 Thus you may encounter guidance claiming that you shouldn't enable use of
28402 this port.
28403 In practice, a number of mail-clients have only ever supported submissions,
28404 not submission with STARTTLS upgrade.
28405 Ideally, offer both submission (587) and submissions (465) service.
28406
28407 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28408 global option. Its value must be a list of port numbers;
28409 the most common use is expected to be:
28410 .code
28411 tls_on_connect_ports = 465
28412 .endd
28413 The port numbers specified by this option apply to all SMTP connections, both
28414 via the daemon and via &'inetd'&. You still need to specify all the ports that
28415 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28416 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28417 an extra port &-- rather, it specifies different behaviour on a port that is
28418 defined elsewhere.
28419
28420 There is also a &%-tls-on-connect%& command line option. This overrides
28421 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28422
28423
28424
28425
28426
28427
28428 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28429 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28430 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28431 To build Exim to use OpenSSL you need to set
28432 .code
28433 USE_OPENSSL=yes
28434 .endd
28435 in Local/Makefile.
28436
28437 To build Exim to use GnuTLS, you need to set
28438 .code
28439 USE_GNUTLS=yes
28440 .endd
28441 in Local/Makefile.
28442
28443 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28444 include files and libraries for GnuTLS can be found.
28445
28446 There are some differences in usage when using GnuTLS instead of OpenSSL:
28447
28448 .ilist
28449 The &%tls_verify_certificates%& option
28450 cannot be the path of a directory
28451 for GnuTLS versions before 3.3.6
28452 (for later versions, or OpenSSL, it can be either).
28453 .next
28454 The default value for &%tls_dhparam%& differs for historical reasons.
28455 .next
28456 .vindex "&$tls_in_peerdn$&"
28457 .vindex "&$tls_out_peerdn$&"
28458 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28459 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28460 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28461 .next
28462 OpenSSL identifies cipher suites using hyphens as separators, for example:
28463 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28464 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28465 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28466 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28467 to handle its own older variants) when processing lists of cipher suites in the
28468 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28469 option).
28470 .next
28471 The &%tls_require_ciphers%& options operate differently, as described in the
28472 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28473 .next
28474 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28475 When using OpenSSL, this option is ignored.
28476 (If an API is found to let OpenSSL be configured in this way,
28477 let the Exim Maintainers know and we'll likely use it).
28478 .next
28479 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28480 main option, it must be ordered to match the &%tls_certificate%& list.
28481 .next
28482 Some other recently added features may only be available in one or the other.
28483 This should be documented with the feature.  If the documentation does not
28484 explicitly state that the feature is infeasible in the other TLS
28485 implementation, then patches are welcome.
28486 .endlist
28487
28488
28489 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28490 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28491 an explicit path; if the latter, then the text about generation still applies,
28492 but not the chosen filename.
28493 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28494 See the documentation of &%tls_dhparam%& for more information.
28495
28496 GnuTLS uses D-H parameters that may take a substantial amount of time
28497 to compute. It is unreasonable to re-compute them for every TLS session.
28498 Therefore, Exim keeps this data in a file in its spool directory, called
28499 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28500 of bits requested.
28501 The file is owned by the Exim user and is readable only by
28502 its owner. Every Exim process that start up GnuTLS reads the D-H
28503 parameters from this file. If the file does not exist, the first Exim process
28504 that needs it computes the data and writes it to a temporary file which is
28505 renamed once it is complete. It does not matter if several Exim processes do
28506 this simultaneously (apart from wasting a few resources). Once a file is in
28507 place, new Exim processes immediately start using it.
28508
28509 For maximum security, the parameters that are stored in this file should be
28510 recalculated periodically, the frequency depending on your paranoia level.
28511 If you are avoiding using the fixed D-H primes published in RFCs, then you
28512 are concerned about some advanced attacks and will wish to do this; if you do
28513 not regenerate then you might as well stick to the standard primes.
28514
28515 Arranging this is easy in principle; just delete the file when you want new
28516 values to be computed. However, there may be a problem. The calculation of new
28517 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28518 If the system is not very active, &_/dev/random_& may delay returning data
28519 until enough randomness (entropy) is available. This may cause Exim to hang for
28520 a substantial amount of time, causing timeouts on incoming connections.
28521
28522 The solution is to generate the parameters externally to Exim. They are stored
28523 in &_gnutls-params-N_& in PEM format, which means that they can be
28524 generated externally using the &(certtool)& command that is part of GnuTLS.
28525
28526 To replace the parameters with new ones, instead of deleting the file
28527 and letting Exim re-create it, you can generate new parameters using
28528 &(certtool)& and, when this has been done, replace Exim's cache file by
28529 renaming. The relevant commands are something like this:
28530 .code
28531 # ls
28532 [ look for file; assume gnutls-params-2236 is the most recent ]
28533 # rm -f new-params
28534 # touch new-params
28535 # chown exim:exim new-params
28536 # chmod 0600 new-params
28537 # certtool --generate-dh-params --bits 2236 >>new-params
28538 # openssl dhparam -noout -text -in new-params | head
28539 [ check the first line, make sure it's not more than 2236;
28540   if it is, then go back to the start ("rm") and repeat
28541   until the size generated is at most the size requested ]
28542 # chmod 0400 new-params
28543 # mv new-params gnutls-params-2236
28544 .endd
28545 If Exim never has to generate the parameters itself, the possibility of
28546 stalling is removed.
28547
28548 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28549 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28550 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28551 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28552 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28553 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28554 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28555 which applies to all D-H usage, client or server.  If the value returned by
28556 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28557 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28558 limit, which is still much higher than Exim historically used.
28559
28560 The filename and bits used will change as the GnuTLS maintainers change the
28561 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28562 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28563 2432 bits, while NSS is limited to 2236 bits.
28564
28565 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28566 increase the chance of the generated prime actually being within acceptable
28567 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28568 procedure above.  There is no sane procedure available to Exim to double-check
28569 the size of the generated prime, so it might still be too large.
28570
28571
28572 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28573 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28574 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28575 There is a function in the OpenSSL library that can be passed a list of cipher
28576 suites before the cipher negotiation takes place. This specifies which ciphers
28577 are acceptable for TLS versions prior to 1.3.
28578 The list is colon separated and may contain names like
28579 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28580 directly to this function call.
28581 Many systems will install the OpenSSL manual-pages, so you may have
28582 &'ciphers(1)'& available to you.
28583 The following quotation from the OpenSSL
28584 documentation specifies what forms of item are allowed in the cipher string:
28585
28586 .ilist
28587 It can consist of a single cipher suite such as RC4-SHA.
28588 .next
28589 It can represent a list of cipher suites containing a certain algorithm,
28590 or cipher suites of a certain type. For example SHA1 represents all
28591 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28592 SSL v3 algorithms.
28593 .next
28594 Lists of cipher suites can be combined in a single cipher string using
28595 the + character. This is used as a logical and operation. For example
28596 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28597 algorithms.
28598 .endlist
28599
28600 Each cipher string can be optionally preceded by one of the characters &`!`&,
28601 &`-`& or &`+`&.
28602 .ilist
28603 If &`!`& is used, the ciphers are permanently deleted from the list. The
28604 ciphers deleted can never reappear in the list even if they are explicitly
28605 stated.
28606 .next
28607 If &`-`& is used, the ciphers are deleted from the list, but some or all
28608 of the ciphers can be added again by later options.
28609 .next
28610 If &`+`& is used, the ciphers are moved to the end of the list. This
28611 option does not add any new ciphers; it just moves matching existing ones.
28612 .endlist
28613
28614 If none of these characters is present, the string is interpreted as
28615 a list of ciphers to be appended to the current preference list. If the list
28616 includes any ciphers already present they will be ignored: that is, they will
28617 not be moved to the end of the list.
28618 .endlist
28619
28620 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28621 string:
28622 .code
28623 # note single-quotes to get ! past any shell history expansion
28624 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28625 .endd
28626
28627 This example will let the library defaults be permitted on the MX port, where
28628 there's probably no identity verification anyway, but ups the ante on the
28629 submission ports where the administrator might have some influence on the
28630 choice of clients used:
28631 .code
28632 # OpenSSL variant; see man ciphers(1)
28633 tls_require_ciphers = ${if =={$received_port}{25}\
28634                            {DEFAULT}\
28635                            {HIGH:!MD5:!SHA1}}
28636 .endd
28637
28638 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28639 .code
28640 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28641 .endd
28642
28643 For TLS version 1.3 the control available is less fine-grained
28644 and Exim does not provide access to it at present.
28645 The value of the &%tls_require_ciphers%& option is ignored when
28646 TLS version 1.3 is negotiated.
28647
28648 As of writing the library default cipher suite list for TLSv1.3 is
28649 .code
28650 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28651 .endd
28652
28653
28654 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28655          "SECTreqciphgnu"
28656 .cindex "GnuTLS" "specifying parameters for"
28657 .cindex "TLS" "specifying ciphers (GnuTLS)"
28658 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28659 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28660 .cindex "TLS" "specifying protocols (GnuTLS)"
28661 .cindex "TLS" "specifying priority string (GnuTLS)"
28662 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28663 The GnuTLS library allows the caller to provide a "priority string", documented
28664 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28665 ciphersuite specification in OpenSSL.
28666
28667 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28668 and controls both protocols and ciphers.
28669
28670 The &%tls_require_ciphers%& option is available both as an global option,
28671 controlling how Exim behaves as a server, and also as an option of the
28672 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28673 the value is string expanded.  The resulting string is not an Exim list and
28674 the string is given to the GnuTLS library, so that Exim does not need to be
28675 aware of future feature enhancements of GnuTLS.
28676
28677 Documentation of the strings accepted may be found in the GnuTLS manual, under
28678 "Priority strings".  This is online as
28679 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28680 but beware that this relates to GnuTLS 3, which may be newer than the version
28681 installed on your system.  If you are using GnuTLS 3,
28682 then the example code
28683 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28684 on that site can be used to test a given string.
28685
28686 For example:
28687 .code
28688 # Disable older versions of protocols
28689 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28690 .endd
28691
28692 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28693 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28694 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28695
28696 This example will let the library defaults be permitted on the MX port, where
28697 there's probably no identity verification anyway, and lowers security further
28698 by increasing compatibility; but this ups the ante on the submission ports
28699 where the administrator might have some influence on the choice of clients
28700 used:
28701 .code
28702 # GnuTLS variant
28703 tls_require_ciphers = ${if =={$received_port}{25}\
28704                            {NORMAL:%COMPAT}\
28705                            {SECURE128}}
28706 .endd
28707
28708
28709 .section "Configuring an Exim server to use TLS" "SECID182"
28710 .cindex "TLS" "configuring an Exim server"
28711 When Exim has been built with TLS support, it advertises the availability of
28712 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28713 but not to any others. The default value of this option is *, which means
28714 that STARTTLS is always advertised.  Set it to blank to never advertise;
28715 this is reasonable for systems that want to use TLS only as a client.
28716
28717 If STARTTLS is to be used you
28718 need to set some other options in order to make TLS available.
28719
28720 If a client issues a STARTTLS command and there is some configuration
28721 problem in the server, the command is rejected with a 454 error. If the client
28722 persists in trying to issue SMTP commands, all except QUIT are rejected
28723 with the error
28724 .code
28725 554 Security failure
28726 .endd
28727 If a STARTTLS command is issued within an existing TLS session, it is
28728 rejected with a 554 error code.
28729
28730 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28731 must be set to match some hosts. The default is * which matches all hosts.
28732
28733 If this is all you do, TLS encryption will be enabled but not authentication -
28734 meaning that the peer has no assurance it is actually you he is talking to.
28735 You gain protection from a passive sniffer listening on the wire but not
28736 from someone able to intercept the communication.
28737
28738 Further protection requires some further configuration at the server end.
28739
28740 To make TLS work you need to set, in the server,
28741 .code
28742 tls_certificate = /some/file/name
28743 tls_privatekey = /some/file/name
28744 .endd
28745 These options are, in fact, expanded strings, so you can make them depend on
28746 the identity of the client that is connected if you wish. The first file
28747 contains the server's X509 certificate, and the second contains the private key
28748 that goes with it. These files need to be
28749 PEM format and readable by the Exim user, and must
28750 always be given as full path names.
28751 The key must not be password-protected.
28752 They can be the same file if both the
28753 certificate and the key are contained within it. If &%tls_privatekey%& is not
28754 set, or if its expansion is forced to fail or results in an empty string, this
28755 is assumed to be the case. The certificate file may also contain intermediate
28756 certificates that need to be sent to the client to enable it to authenticate
28757 the server's certificate.
28758
28759 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28760 colon-separated lists of file paths.  Ciphers using given authentication
28761 algorithms require the presence of a suitable certificate to supply the
28762 public-key.  The server selects among the certificates to present to the
28763 client depending on the selected cipher, hence the priority ordering for
28764 ciphers will affect which certificate is used.
28765
28766 If you do not understand about certificates and keys, please try to find a
28767 source of this background information, which is not Exim-specific. (There are a
28768 few comments below in section &<<SECTcerandall>>&.)
28769
28770 &*Note*&: These options do not apply when Exim is operating as a client &--
28771 they apply only in the case of a server. If you need to use a certificate in an
28772 Exim client, you must set the options of the same names in an &(smtp)&
28773 transport.
28774
28775 With just these options, an Exim server will be able to use TLS. It does not
28776 require the client to have a certificate (but see below for how to insist on
28777 this). There is one other option that may be needed in other situations. If
28778 .code
28779 tls_dhparam = /some/file/name
28780 .endd
28781 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28782 with the parameters contained in the file.
28783 Set this to &`none`& to disable use of DH entirely, by making no prime
28784 available:
28785 .code
28786 tls_dhparam = none
28787 .endd
28788 This may also be set to a string identifying a standard prime to be used for
28789 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28790 used is &`ike23`&.  There are a few standard primes available, see the
28791 documentation for &%tls_dhparam%& for the complete list.
28792
28793 See the command
28794 .code
28795 openssl dhparam
28796 .endd
28797 for a way of generating file data.
28798
28799 The strings supplied for these three options are expanded every time a client
28800 host connects. It is therefore possible to use different certificates and keys
28801 for different hosts, if you so wish, by making use of the client's IP address
28802 in &$sender_host_address$& to control the expansion. If a string expansion is
28803 forced to fail, Exim behaves as if the option is not set.
28804
28805 .cindex "cipher" "logging"
28806 .cindex "log" "TLS cipher"
28807 .vindex "&$tls_in_cipher$&"
28808 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28809 an incoming TLS connection. It is included in the &'Received:'& header of an
28810 incoming message (by default &-- you can, of course, change this), and it is
28811 also included in the log line that records a message's arrival, keyed by
28812 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28813 condition can be used to test for specific cipher suites in ACLs.
28814
28815 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28816 can check the name of the cipher suite and vary their actions accordingly. The
28817 cipher suite names vary, depending on which TLS library is being used. For
28818 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28819 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28820 documentation for more details.
28821
28822 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28823 (again depending on the &%tls_cipher%& log selector).
28824
28825
28826 .section "Requesting and verifying client certificates" "SECID183"
28827 .cindex "certificate" "verification of client"
28828 .cindex "TLS" "client certificate verification"
28829 If you want an Exim server to request a certificate when negotiating a TLS
28830 session with a client, you must set either &%tls_verify_hosts%& or
28831 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28832 apply to all TLS connections. For any host that matches one of these options,
28833 Exim requests a certificate as part of the setup of the TLS session. The
28834 contents of the certificate are verified by comparing it with a list of
28835 expected trust-anchors or certificates.
28836 These may be the system default set (depending on library version),
28837 an explicit file or,
28838 depending on library version, a directory, identified by
28839 &%tls_verify_certificates%&.
28840
28841 A file can contain multiple certificates, concatenated end to end. If a
28842 directory is used
28843 (OpenSSL only),
28844 each certificate must be in a separate file, with a name (or a symbolic link)
28845 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28846 certificate. You can compute the relevant hash by running the command
28847 .code
28848 openssl x509 -hash -noout -in /cert/file
28849 .endd
28850 where &_/cert/file_& contains a single certificate.
28851
28852 There is no checking of names of the client against the certificate
28853 Subject Name or Subject Alternate Names.
28854
28855 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28856 what happens if the client does not supply a certificate, or if the certificate
28857 does not match any of the certificates in the collection named by
28858 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28859 attempt to set up a TLS session is aborted, and the incoming connection is
28860 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28861 session continues. ACLs that run for subsequent SMTP commands can detect the
28862 fact that no certificate was verified, and vary their actions accordingly. For
28863 example, you can insist on a certificate before accepting a message for
28864 relaying, but not when the message is destined for local delivery.
28865
28866 .vindex "&$tls_in_peerdn$&"
28867 When a client supplies a certificate (whether it verifies or not), the value of
28868 the Distinguished Name of the certificate is made available in the variable
28869 &$tls_in_peerdn$& during subsequent processing of the message.
28870
28871 .cindex "log" "distinguished name"
28872 Because it is often a long text string, it is not included in the log line or
28873 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28874 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28875 &%received_header_text%& to change the &'Received:'& header. When no
28876 certificate is supplied, &$tls_in_peerdn$& is empty.
28877
28878
28879 .section "Revoked certificates" "SECID184"
28880 .cindex "TLS" "revoked certificates"
28881 .cindex "revocation list"
28882 .cindex "certificate" "revocation list"
28883 .cindex "OCSP" "stapling"
28884 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28885 certificates are revoked. If you have such a list, you can pass it to an Exim
28886 server using the global option called &%tls_crl%& and to an Exim client using
28887 an identically named option for the &(smtp)& transport. In each case, the value
28888 of the option is expanded and must then be the name of a file that contains a
28889 CRL in PEM format.
28890 The downside is that clients have to periodically re-download a potentially huge
28891 file from every certificate authority they know of.
28892
28893 The way with most moving parts at query time is Online Certificate
28894 Status Protocol (OCSP), where the client verifies the certificate
28895 against an OCSP server run by the CA.  This lets the CA track all
28896 usage of the certs.  It requires running software with access to the
28897 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28898 is based on HTTP and can be proxied accordingly.
28899
28900 The only widespread OCSP server implementation (known to this writer)
28901 comes as part of OpenSSL and aborts on an invalid request, such as
28902 connecting to the port and then disconnecting.  This requires
28903 re-entering the passphrase each time some random client does this.
28904
28905 The third way is OCSP Stapling; in this, the server using a certificate
28906 issued by the CA periodically requests an OCSP proof of validity from
28907 the OCSP server, then serves it up inline as part of the TLS
28908 negotiation.   This approach adds no extra round trips, does not let the
28909 CA track users, scales well with number of certs issued by the CA and is
28910 resilient to temporary OCSP server failures, as long as the server
28911 starts retrying to fetch an OCSP proof some time before its current
28912 proof expires.  The downside is that it requires server support.
28913
28914 Unless Exim is built with the support disabled,
28915 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28916 support for OCSP stapling is included.
28917
28918 There is a global option called &%tls_ocsp_file%&.
28919 The file specified therein is expected to be in DER format, and contain
28920 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28921 option will be re-expanded for SNI, if the &%tls_certificate%& option
28922 contains &`tls_in_sni`&, as per other TLS options.
28923
28924 Exim does not at this time implement any support for fetching a new OCSP
28925 proof.  The burden is on the administrator to handle this, outside of
28926 Exim.  The file specified should be replaced atomically, so that the
28927 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28928 on each connection, so a new file will be handled transparently on the
28929 next connection.
28930
28931 When built with OpenSSL Exim will check for a valid next update timestamp
28932 in the OCSP proof; if not present, or if the proof has expired, it will be
28933 ignored.
28934
28935 For the client to be able to verify the stapled OCSP the server must
28936 also supply, in its stapled information, any intermediate
28937 certificates for the chain leading to the OCSP proof from the signer
28938 of the server certificate.  There may be zero or one such. These
28939 intermediate certificates should be added to the server OCSP stapling
28940 file named by &%tls_ocsp_file%&.
28941
28942 Note that the proof only covers the terminal server certificate,
28943 not any of the chain from CA to it.
28944
28945 There is no current way to staple a proof for a client certificate.
28946
28947 .code
28948   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28949   OCSP server is supplied.  The server URL may be included in the
28950   server certificate, if the CA is helpful.
28951
28952   One failure mode seen was the OCSP Signer cert expiring before the end
28953   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28954   noted this as invalid overall, but the re-fetch script did not.
28955 .endd
28956
28957
28958
28959
28960 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28961 .cindex "cipher" "logging"
28962 .cindex "log" "TLS cipher"
28963 .cindex "log" "distinguished name"
28964 .cindex "TLS" "configuring an Exim client"
28965 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28966 deliveries as well as to incoming, the latter one causing logging of the
28967 server certificate's DN. The remaining client configuration for TLS is all
28968 within the &(smtp)& transport.
28969
28970 It is not necessary to set any options to have TLS work in the &(smtp)&
28971 transport. If Exim is built with TLS support, and TLS is advertised by a
28972 server, the &(smtp)& transport always tries to start a TLS session. However,
28973 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28974 transport) to a list of server hosts for which TLS should not be used.
28975
28976 If you do not want Exim to attempt to send messages unencrypted when an attempt
28977 to set up an encrypted connection fails in any way, you can set
28978 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28979 those hosts, delivery is always deferred if an encrypted connection cannot be
28980 set up. If there are any other hosts for the address, they are tried in the
28981 usual way.
28982
28983 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28984 the message unencrypted. It always does this if the response to STARTTLS is
28985 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28986 session after a success response code, what happens is controlled by the
28987 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28988 delivery to this host is deferred, and other hosts (if available) are tried. If
28989 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28990 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28991 negotiation fails, Exim closes the current connection (because it is in an
28992 unknown state), opens a new one to the same host, and then tries the delivery
28993 unencrypted.
28994
28995 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28996 transport provide the client with a certificate, which is passed to the server
28997 if it requests it. If the server is Exim, it will request a certificate only if
28998 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28999
29000 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29001 for client use (they are usable for server use).
29002 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29003 in failed connections.
29004
29005 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29006 specifies a collection of expected server certificates.
29007 These may be
29008 the system default set (depending on library version),
29009 a file,
29010 or (depending on library version) a directory.
29011 The client verifies the server's certificate
29012 against this collection, taking into account any revoked certificates that are
29013 in the list defined by &%tls_crl%&.
29014 Failure to verify fails the TLS connection unless either of the
29015 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29016
29017 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29018 certificate verification to the listed servers.  Verification either must
29019 or need not succeed respectively.
29020
29021 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29022 checks are made: that the host name (the one in the DNS A record)
29023 is valid for the certificate.
29024 The option defaults to always checking.
29025
29026 The &(smtp)& transport has two OCSP-related options:
29027 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29028 is requested and required for the connection to proceed.  The default
29029 value is empty.
29030 &%hosts_request_ocsp%&; a host-list for which (additionally)
29031 a Certificate Status is requested (but not necessarily verified).  The default
29032 value is "*" meaning that requests are made unless configured
29033 otherwise.
29034
29035 The host(s) should also be in &%hosts_require_tls%&, and
29036 &%tls_verify_certificates%& configured for the transport,
29037 for OCSP to be relevant.
29038
29039 If
29040 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29041 list of permitted cipher suites. If either of these checks fails, delivery to
29042 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29043 alternative hosts, if any.
29044
29045  &*Note*&:
29046 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29047 is operating as a client. Exim does not assume that a server certificate (set
29048 by the global options of the same name) should also be used when operating as a
29049 client.
29050
29051 .vindex "&$host$&"
29052 .vindex "&$host_address$&"
29053 All the TLS options in the &(smtp)& transport are expanded before use, with
29054 &$host$& and &$host_address$& containing the name and address of the server to
29055 which the client is connected. Forced failure of an expansion causes Exim to
29056 behave as if the relevant option were unset.
29057
29058 .vindex &$tls_out_bits$&
29059 .vindex &$tls_out_cipher$&
29060 .vindex &$tls_out_peerdn$&
29061 .vindex &$tls_out_sni$&
29062 Before an SMTP connection is established, the
29063 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29064 variables are emptied. (Until the first connection, they contain the values
29065 that were set when the message was received.) If STARTTLS is subsequently
29066 successfully obeyed, these variables are set to the relevant values for the
29067 outgoing connection.
29068
29069
29070
29071 .section "Use of TLS Server Name Indication" "SECTtlssni"
29072 .cindex "TLS" "Server Name Indication"
29073 .vindex "&$tls_in_sni$&"
29074 .oindex "&%tls_in_sni%&"
29075 With TLS1.0 or above, there is an extension mechanism by which extra
29076 information can be included at various points in the protocol.  One of these
29077 extensions, documented in RFC 6066 (and before that RFC 4366) is
29078 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29079 client in the initial handshake, so that the server can examine the servername
29080 within and possibly choose to use different certificates and keys (and more)
29081 for this session.
29082
29083 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29084 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29085 address.
29086
29087 With SMTP to MX, there are the same problems here as in choosing the identity
29088 against which to validate a certificate: you can't rely on insecure DNS to
29089 provide the identity which you then cryptographically verify.  So this will
29090 be of limited use in that environment.
29091
29092 With SMTP to Submission, there is a well-defined hostname which clients are
29093 connecting to and can validate certificates against.  Thus clients &*can*&
29094 choose to include this information in the TLS negotiation.  If this becomes
29095 wide-spread, then hosters can choose to present different certificates to
29096 different clients.  Or even negotiate different cipher suites.
29097
29098 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29099 if not empty, will be sent on a TLS session as part of the handshake.  There's
29100 nothing more to it.  Choosing a sensible value not derived insecurely is the
29101 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29102 for the lifetime of the client connection (including during authentication).
29103
29104 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29105 received from a client.
29106 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29107
29108 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29109 option (prior to expansion) then the following options will be re-expanded
29110 during TLS session handshake, to permit alternative values to be chosen:
29111
29112 .ilist
29113 &%tls_certificate%&
29114 .next
29115 &%tls_crl%&
29116 .next
29117 &%tls_privatekey%&
29118 .next
29119 &%tls_verify_certificates%&
29120 .next
29121 &%tls_ocsp_file%&
29122 .endlist
29123
29124 Great care should be taken to deal with matters of case, various injection
29125 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29126 can always be referenced; it is important to remember that &$tls_in_sni$& is
29127 arbitrary unverified data provided prior to authentication.
29128 Further, the initial certificate is loaded before SNI has arrived, so
29129 an expansion for &%tls_certificate%& must have a default which is used
29130 when &$tls_in_sni$& is empty.
29131
29132 The Exim developers are proceeding cautiously and so far no other TLS options
29133 are re-expanded.
29134
29135 When Exim is built against OpenSSL, OpenSSL must have been built with support
29136 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29137 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29138 see &`-servername`& in the output, then OpenSSL has support.
29139
29140 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29141 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29142 built, then you have SNI support).
29143
29144
29145
29146 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29147          "SECTmulmessam"
29148 .cindex "multiple SMTP deliveries with TLS"
29149 .cindex "TLS" "multiple message deliveries"
29150 Exim sends multiple messages down the same TCP/IP connection by starting up
29151 an entirely new delivery process for each message, passing the socket from
29152 one process to the next. This implementation does not fit well with the use
29153 of TLS, because there is quite a lot of state information associated with a TLS
29154 connection, not just a socket identification. Passing all the state information
29155 to a new process is not feasible. Consequently, for sending using TLS Exim
29156 starts an additional proxy process for handling the encryption, piping the
29157 unencrypted data stream from and to the delivery processes.
29158
29159 An older mode of operation can be enabled on a per-host basis by the
29160 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29161 this list the proxy process described above is not used; instead Exim
29162 shuts down an existing TLS session being run by the delivery process
29163 before passing the socket to a new process. The new process may then
29164 try to start a new TLS session, and if successful, may try to re-authenticate
29165 if AUTH is in use, before sending the next message.
29166
29167 The RFC is not clear as to whether or not an SMTP session continues in clear
29168 after TLS has been shut down, or whether TLS may be restarted again later, as
29169 just described. However, if the server is Exim, this shutdown and
29170 reinitialization works. It is not known which (if any) other servers operate
29171 successfully if the client closes a TLS session and continues with unencrypted
29172 SMTP, but there are certainly some that do not work. For such servers, Exim
29173 should not pass the socket to another process, because the failure of the
29174 subsequent attempt to use it would cause Exim to record a temporary host error,
29175 and delay other deliveries to that host.
29176
29177 To test for this case, Exim sends an EHLO command to the server after
29178 closing down the TLS session. If this fails in any way, the connection is
29179 closed instead of being passed to a new delivery process, but no retry
29180 information is recorded.
29181
29182 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29183 &(smtp)& transport to match those hosts for which Exim should not pass
29184 connections to new processes if TLS has been used.
29185
29186
29187
29188
29189 .section "Certificates and all that" "SECTcerandall"
29190 .cindex "certificate" "references to discussion"
29191 In order to understand fully how TLS works, you need to know about
29192 certificates, certificate signing, and certificate authorities.
29193 This is a large topic and an introductory guide is unsuitable for the Exim
29194 reference manual, so instead we provide pointers to existing documentation.
29195
29196 The Apache web-server was for a long time the canonical guide, so their
29197 documentation is a good place to start; their SSL module's Introduction
29198 document is currently at
29199 .display
29200 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29201 .endd
29202 and their FAQ is at
29203 .display
29204 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29205 .endd
29206
29207 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29208 0-201-61598-3) in 2001, contains both introductory and more in-depth
29209 descriptions.
29210 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29211 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29212 Ivan is the author of the popular TLS testing tools at
29213 &url(https://www.ssllabs.com/).
29214
29215
29216 .section "Certificate chains" "SECID186"
29217 The file named by &%tls_certificate%& may contain more than one
29218 certificate. This is useful in the case where the certificate that is being
29219 sent is validated by an intermediate certificate which the other end does
29220 not have. Multiple certificates must be in the correct order in the file.
29221 First the host's certificate itself, then the first intermediate
29222 certificate to validate the issuer of the host certificate, then the next
29223 intermediate certificate to validate the issuer of the first intermediate
29224 certificate, and so on, until finally (optionally) the root certificate.
29225 The root certificate must already be trusted by the recipient for
29226 validation to succeed, of course, but if it's not preinstalled, sending the
29227 root certificate along with the rest makes it available for the user to
29228 install if the receiving end is a client MUA that can interact with a user.
29229
29230 Note that certificates using MD5 are unlikely to work on today's Internet;
29231 even if your libraries allow loading them for use in Exim when acting as a
29232 server, increasingly clients will not accept such certificates.  The error
29233 diagnostics in such a case can be frustratingly vague.
29234
29235
29236
29237 .section "Self-signed certificates" "SECID187"
29238 .cindex "certificate" "self-signed"
29239 You can create a self-signed certificate using the &'req'& command provided
29240 with OpenSSL, like this:
29241 . ==== Do not shorten the duration here without reading and considering
29242 . ==== the text below.  Please leave it at 9999 days.
29243 .code
29244 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29245             -days 9999 -nodes
29246 .endd
29247 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29248 delimited and so can be identified independently. The &%-days%& option
29249 specifies a period for which the certificate is valid. The &%-nodes%& option is
29250 important: if you do not set it, the key is encrypted with a passphrase
29251 that you are prompted for, and any use that is made of the key causes more
29252 prompting for the passphrase. This is not helpful if you are going to use
29253 this certificate and key in an MTA, where prompting is not possible.
29254
29255 . ==== I expect to still be working 26 years from now.  The less technical
29256 . ==== debt I create, in terms of storing up trouble for my later years, the
29257 . ==== happier I will be then.  We really have reached the point where we
29258 . ==== should start, at the very least, provoking thought and making folks
29259 . ==== pause before proceeding, instead of leaving all the fixes until two
29260 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29261 . ==== -pdp, 2012
29262 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29263 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29264 the above command might produce a date in the past.  Think carefully about
29265 the lifetime of the systems you're deploying, and either reduce the duration
29266 of the certificate or reconsider your platform deployment.  (At time of
29267 writing, reducing the duration is the most likely choice, but the inexorable
29268 progression of time takes us steadily towards an era where this will not
29269 be a sensible resolution).
29270
29271 A self-signed certificate made in this way is sufficient for testing, and
29272 may be adequate for all your requirements if you are mainly interested in
29273 encrypting transfers, and not in secure identification.
29274
29275 However, many clients require that the certificate presented by the server be a
29276 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29277 certificate. In this situation, the self-signed certificate described above
29278 must be installed on the client host as a trusted root &'certification
29279 authority'& (CA), and the certificate used by Exim must be a user certificate
29280 signed with that self-signed certificate.
29281
29282 For information on creating self-signed CA certificates and using them to sign
29283 user certificates, see the &'General implementation overview'& chapter of the
29284 Open-source PKI book, available online at
29285 &url(https://sourceforge.net/projects/ospkibook/).
29286 .ecindex IIDencsmtp1
29287 .ecindex IIDencsmtp2
29288
29289
29290
29291 .section DANE "SECDANE"
29292 .cindex DANE
29293 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29294 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29295 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29296 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29297 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29298 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29299
29300 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29301 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29302 by (a) is thought to be smaller than that of the set of root CAs.
29303
29304 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29305 fail to pass on a server's STARTTLS.
29306
29307 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29308 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29309 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29310
29311 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29312 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29313 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29314 DNSSEC.
29315 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29316 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29317
29318 There are no changes to Exim specific to server-side operation of DANE.
29319 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29320 in &_Local/Makefile_&.
29321 If it has been included, the macro "_HAVE_DANE" will be defined.
29322
29323 A TLSA record consist of 4 fields, the "Certificate Usage", the
29324 "Selector", the "Matching type", and the "Certificate Association Data".
29325 For a detailed description of the TLSA record see
29326 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29327
29328 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29329 These are the "Trust Anchor" and "End Entity" variants.
29330 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29331 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29332 this is appropriate for a single system, using a self-signed certificate.
29333 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29334 well-known one.
29335 A private CA at simplest is just a self-signed certificate (with certain
29336 attributes) which is used to sign server certificates, but running one securely
29337 does require careful arrangement.
29338 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29339 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29340 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29341 all of which point to a single TLSA record.
29342 DANE-TA and DANE-EE can both be used together.
29343
29344 Our recommendation is to use DANE with a certificate from a public CA,
29345 because this enables a variety of strategies for remote clients to verify
29346 your certificate.
29347 You can then publish information both via DANE and another technology,
29348 "MTA-STS", described below.
29349
29350 When you use DANE-TA to publish trust anchor information, you ask entities
29351 outside your administrative control to trust the Certificate Authority for
29352 connections to you.
29353 If using a private CA then you should expect others to still apply the
29354 technical criteria they'd use for a public CA to your certificates.
29355 In particular, you should probably try to follow current best practices for CA
29356 operation around hash algorithms and key sizes.
29357 Do not expect other organizations to lower their security expectations just
29358 because a particular profile might be reasonable for your own internal use.
29359
29360 When this text was last updated, this in practice means to avoid use of SHA-1
29361 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29362 than 4096, for interoperability); to use keyUsage fields correctly; to use
29363 random serial numbers.
29364 The list of requirements is subject to change as best practices evolve.
29365 If you're not already using a private CA, or it doesn't meet these
29366 requirements, then we encourage you to avoid all these issues and use a public
29367 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29368
29369 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29370 a "Matching Type" (3rd) field of SHA2-512(2).
29371
29372 For the "Certificate Authority Data" (4th) field, commands like
29373
29374 .code
29375   openssl x509 -pubkey -noout <certificate.pem \
29376   | openssl rsa -outform der -pubin 2>/dev/null \
29377   | openssl sha512 \
29378   | awk '{print $2}'
29379 .endd
29380
29381 are workable to create a hash of the certificate's public key.
29382
29383 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29384
29385 .code
29386   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29387 .endd
29388
29389 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29390 is useful for quickly generating TLSA records.
29391
29392
29393 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29394
29395 The Certificate issued by the CA published in the DANE-TA model should be
29396 issued using a strong hash algorithm.
29397 Exim, and importantly various other MTAs sending to you, will not
29398 re-enable hash algorithms which have been disabled by default in TLS
29399 libraries.
29400 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29401 interoperability (and probably the maximum too, in 2018).
29402
29403 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29404 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29405 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29406
29407 .code
29408   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29409                                  {= {4}{$tls_out_tlsa_usage}} } \
29410                          {*}{}}
29411 .endd
29412
29413 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29414 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29415 found. If the definition of &%hosts_request_ocsp%& includes the
29416 string "tls_out_tlsa_usage", they are re-expanded in time to
29417 control the OCSP request.
29418
29419 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29420 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29421
29422
29423 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29424 and &%dane_require_tls_ciphers%&.
29425 The &"require"& variant will result in failure if the target host is not
29426 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29427 the &%dnssec_request_domains%& router or transport option.
29428
29429 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29430
29431 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29432 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29433 will be required for the host.  If it does not, the host will not
29434 be used; there is no fallback to non-DANE or non-TLS.
29435
29436 If DANE is requested and usable, then the TLS cipher list configuration
29437 prefers to use the option &%dane_require_tls_ciphers%& and falls
29438 back to &%tls_require_ciphers%& only if that is unset.
29439 This lets you configure "decent crypto" for DANE and "better than nothing
29440 crypto" as the default.  Note though that while GnuTLS lets the string control
29441 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29442 limited to ciphersuite constraints.
29443
29444 If DANE is requested and useable (see above) the following transport options are ignored:
29445 .code
29446   hosts_require_tls
29447   tls_verify_hosts
29448   tls_try_verify_hosts
29449   tls_verify_certificates
29450   tls_crl
29451   tls_verify_cert_hostnames
29452 .endd
29453
29454 If DANE is not usable, whether requested or not, and CA-anchored
29455 verification evaluation is wanted, the above variables should be set appropriately.
29456
29457 The router and transport option &%dnssec_request_domains%& must not be
29458 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29459
29460 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29461
29462 There is a new variable &$tls_out_dane$& which will have "yes" if
29463 verification succeeded using DANE and "no" otherwise (only useful
29464 in combination with events; see &<<CHAPevents>>&),
29465 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29466
29467 .cindex DANE reporting
29468 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29469 to achieve DANE-verified connection, if one was either requested and offered, or
29470 required.  This is intended to support TLS-reporting as defined in
29471 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29472 The &$event_data$& will be one of the Result Types defined in
29473 Section 4.3 of that document.
29474
29475 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29476
29477 DANE is specified in published RFCs and decouples certificate authority trust
29478 selection from a "race to the bottom" of "you must trust everything for mail
29479 to get through".  There is an alternative technology called MTA-STS, which
29480 instead publishes MX trust anchor information on an HTTPS website.  At the
29481 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29482 Exim has no support for MTA-STS as a client, but Exim mail server operators
29483 can choose to publish information describing their TLS configuration using
29484 MTA-STS to let those clients who do use that protocol derive trust
29485 information.
29486
29487 The MTA-STS design requires a certificate from a public Certificate Authority
29488 which is recognized by clients sending to you.
29489 That selection of which CAs are trusted by others is outside your control.
29490
29491 The most interoperable course of action is probably to use
29492 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29493 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29494 records for DANE clients (such as Exim and Postfix) and to publish anchor
29495 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29496 domain itself (with caveats around occasionally broken MTA-STS because of
29497 incompatible specification changes prior to reaching RFC status).
29498
29499
29500
29501 . ////////////////////////////////////////////////////////////////////////////
29502 . ////////////////////////////////////////////////////////////////////////////
29503
29504 .chapter "Access control lists" "CHAPACL"
29505 .scindex IIDacl "&ACL;" "description"
29506 .cindex "control of incoming mail"
29507 .cindex "message" "controlling incoming"
29508 .cindex "policy control" "access control lists"
29509 Access Control Lists (ACLs) are defined in a separate section of the runtime
29510 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29511 name, terminated by a colon. Here is a complete ACL section that contains just
29512 one very small ACL:
29513 .code
29514 begin acl
29515 small_acl:
29516   accept   hosts = one.host.only
29517 .endd
29518 You can have as many lists as you like in the ACL section, and the order in
29519 which they appear does not matter. The lists are self-terminating.
29520
29521 The majority of ACLs are used to control Exim's behaviour when it receives
29522 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29523 when a local process submits a message using SMTP by specifying the &%-bs%&
29524 option. The most common use is for controlling which recipients are accepted
29525 in incoming messages. In addition, you can define an ACL that is used to check
29526 local non-SMTP messages. The default configuration file contains an example of
29527 a realistic ACL for checking RCPT commands. This is discussed in chapter
29528 &<<CHAPdefconfil>>&.
29529
29530
29531 .section "Testing ACLs" "SECID188"
29532 The &%-bh%& command line option provides a way of testing your ACL
29533 configuration locally by running a fake SMTP session with which you interact.
29534
29535
29536 .section "Specifying when ACLs are used" "SECID189"
29537 .cindex "&ACL;" "options for specifying"
29538 In order to cause an ACL to be used, you have to name it in one of the relevant
29539 options in the main part of the configuration. These options are:
29540 .cindex "AUTH" "ACL for"
29541 .cindex "DATA" "ACLs for"
29542 .cindex "ETRN" "ACL for"
29543 .cindex "EXPN" "ACL for"
29544 .cindex "HELO" "ACL for"
29545 .cindex "EHLO" "ACL for"
29546 .cindex "DKIM" "ACL for"
29547 .cindex "MAIL" "ACL for"
29548 .cindex "QUIT, ACL for"
29549 .cindex "RCPT" "ACL for"
29550 .cindex "STARTTLS, ACL for"
29551 .cindex "VRFY" "ACL for"
29552 .cindex "SMTP" "connection, ACL for"
29553 .cindex "non-SMTP messages" "ACLs for"
29554 .cindex "MIME content scanning" "ACL for"
29555 .cindex "PRDR" "ACL for"
29556
29557 .table2 140pt
29558 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29559 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29560 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29561 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29562 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29563 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29564 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29565 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29566 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29567 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29568 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29569 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29570 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29571 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29572 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29573 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29574 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29575 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29576 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29577 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29578 .endtable
29579
29580 For example, if you set
29581 .code
29582 acl_smtp_rcpt = small_acl
29583 .endd
29584 the little ACL defined above is used whenever Exim receives a RCPT command
29585 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29586 done when RCPT commands arrive. A rejection of RCPT should cause the
29587 sending MTA to give up on the recipient address contained in the RCPT
29588 command, whereas rejection at other times may cause the client MTA to keep on
29589 trying to deliver the message. It is therefore recommended that you do as much
29590 testing as possible at RCPT time.
29591
29592
29593 .section "The non-SMTP ACLs" "SECID190"
29594 .cindex "non-SMTP messages" "ACLs for"
29595 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29596 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29597 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29598 the state of the SMTP connection such as encryption and authentication) are not
29599 relevant and are forbidden in these ACLs. However, the sender and recipients
29600 are known, so the &%senders%& and &%sender_domains%& conditions and the
29601 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29602 &$authenticated_sender$& are also available. You can specify added header lines
29603 in any of these ACLs.
29604
29605 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29606 non-SMTP message, before any of the message has been read. (This is the
29607 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29608 batched SMTP input, it runs after the DATA command has been reached. The
29609 result of this ACL is ignored; it cannot be used to reject a message. If you
29610 really need to, you could set a value in an ACL variable here and reject based
29611 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29612 controls, and in particular, it can be used to set
29613 .code
29614 control = suppress_local_fixups
29615 .endd
29616 This cannot be used in the other non-SMTP ACLs because by the time they are
29617 run, it is too late.
29618
29619 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29620 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29621
29622 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29623 kind of rejection is treated as permanent, because there is no way of sending a
29624 temporary error for these kinds of message.
29625
29626
29627 .section "The SMTP connect ACL" "SECID191"
29628 .cindex "SMTP" "connection, ACL for"
29629 .oindex &%smtp_banner%&
29630 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29631 session, after the test specified by &%host_reject_connection%& (which is now
29632 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29633 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29634 the message override the banner message that is otherwise specified by the
29635 &%smtp_banner%& option.
29636
29637
29638 .section "The EHLO/HELO ACL" "SECID192"
29639 .cindex "EHLO" "ACL for"
29640 .cindex "HELO" "ACL for"
29641 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29642 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29643 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29644 Note that a client may issue more than one EHLO or HELO command in an SMTP
29645 session, and indeed is required to issue a new EHLO or HELO after successfully
29646 setting up encryption following a STARTTLS command.
29647
29648 Note also that a deny neither forces the client to go away nor means that
29649 mail will be refused on the connection.  Consider checking for
29650 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29651
29652 If the command is accepted by an &%accept%& verb that has a &%message%&
29653 modifier, the message may not contain more than one line (it will be truncated
29654 at the first newline and a panic logged if it does). Such a message cannot
29655 affect the EHLO options that are listed on the second and subsequent lines of
29656 an EHLO response.
29657
29658
29659 .section "The DATA ACLs" "SECID193"
29660 .cindex "DATA" "ACLs for"
29661 Two ACLs are associated with the DATA command, because it is two-stage
29662 command, with two responses being sent to the client.
29663 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29664 is obeyed. This gives you control after all the RCPT commands, but before
29665 the message itself is received. It offers the opportunity to give a negative
29666 response to the DATA command before the data is transmitted. Header lines
29667 added by MAIL or RCPT ACLs are not visible at this time, but any that
29668 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29669
29670 You cannot test the contents of the message, for example, to verify addresses
29671 in the headers, at RCPT time or when the DATA command is received. Such
29672 tests have to appear in the ACL that is run after the message itself has been
29673 received, before the final response to the DATA command is sent. This is
29674 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29675 associated with the DATA command.
29676
29677 .cindex CHUNKING "BDAT command"
29678 .cindex BDAT "SMTP command"
29679 .cindex "RFC 3030" CHUNKING
29680 If CHUNKING was advertised and a BDAT command sequence is received,
29681 the &%acl_smtp_predata%& ACL is not run.
29682 . XXX why not?  It should be possible, for the first BDAT.
29683 The &%acl_smtp_data%& is run after the last BDAT command and all of
29684 the data specified is received.
29685
29686 For both of these ACLs, it is not possible to reject individual recipients. An
29687 error response rejects the entire message. Unfortunately, it is known that some
29688 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29689 before or after the data) correctly &-- they keep the message on their queues
29690 and try again later, but that is their problem, though it does waste some of
29691 your resources.
29692
29693 The &%acl_smtp_data%& ACL is run after
29694 the &%acl_smtp_data_prdr%&,
29695 the &%acl_smtp_dkim%&
29696 and the &%acl_smtp_mime%& ACLs.
29697
29698 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29699 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29700 enabled (which is the default).
29701
29702 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29703 received, and is executed for each DKIM signature found in a message.  If not
29704 otherwise specified, the default action is to accept.
29705
29706 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29707
29708 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29709
29710
29711 .section "The SMTP MIME ACL" "SECID194"
29712 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29713 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29714
29715 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29716
29717
29718 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29719 .cindex "PRDR" "ACL for"
29720 .oindex "&%prdr_enable%&"
29721 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29722 with PRDR support enabled (which is the default).
29723 It becomes active only when the PRDR feature is negotiated between
29724 client and server for a message, and more than one recipient
29725 has been accepted.
29726
29727 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29728 has been received, and is executed once for each recipient of the message
29729 with &$local_part$& and &$domain$& valid.
29730 The test may accept, defer or deny for individual recipients.
29731 The &%acl_smtp_data%& will still be called after this ACL and
29732 can reject the message overall, even if this ACL has accepted it
29733 for some or all recipients.
29734
29735 PRDR may be used to support per-user content filtering.  Without it
29736 one must defer any recipient after the first that has a different
29737 content-filter configuration.  With PRDR, the RCPT-time check
29738 .cindex "PRDR" "variable for"
29739 for this can be disabled when the variable &$prdr_requested$&
29740 is &"yes"&.
29741 Any required difference in behaviour of the main DATA-time
29742 ACL should however depend on the PRDR-time ACL having run, as Exim
29743 will avoid doing so in some situations (e.g. single-recipient mails).
29744
29745 See also the &%prdr_enable%& global option
29746 and the &%hosts_try_prdr%& smtp transport option.
29747
29748 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29749 If the ACL is not defined, processing completes as if
29750 the feature was not requested by the client.
29751
29752 .section "The QUIT ACL" "SECTQUITACL"
29753 .cindex "QUIT, ACL for"
29754 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29755 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29756 does not in fact control any access.
29757 For this reason, it may only accept
29758 or warn as its final result.
29759
29760 This ACL can be used for tasks such as custom logging at the end of an SMTP
29761 session. For example, you can use ACL variables in other ACLs to count
29762 messages, recipients, etc., and log the totals at QUIT time using one or
29763 more &%logwrite%& modifiers on a &%warn%& verb.
29764
29765 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29766 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29767
29768 You do not need to have a final &%accept%&, but if you do, you can use a
29769 &%message%& modifier to specify custom text that is sent as part of the 221
29770 response to QUIT.
29771
29772 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29773 failure (for example, failure to open a log file, or when Exim is bombing out
29774 because it has detected an unrecoverable error), all SMTP commands from the
29775 client are given temporary error responses until QUIT is received or the
29776 connection is closed. In these special cases, the QUIT ACL does not run.
29777
29778
29779 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29780 .vindex &$acl_smtp_notquit$&
29781 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29782 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29783 trouble, such as being unable to write to its log files, this ACL is not run,
29784 because it might try to do things (such as write to log files) that make the
29785 situation even worse.
29786
29787 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29788 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29789 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29790 and &%warn%&.
29791
29792 .vindex &$smtp_notquit_reason$&
29793 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29794 to a string that indicates the reason for the termination of the SMTP
29795 connection. The possible values are:
29796 .table2
29797 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29798 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29799 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29800 .irow &`connection-lost`&          "The SMTP connection has been lost"
29801 .irow &`data-timeout`&             "Timeout while reading message data"
29802 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29803 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29804 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29805 .irow &`synchronization-error`&    "SMTP synchronization error"
29806 .irow &`tls-failed`&               "TLS failed to start"
29807 .endtable
29808 In most cases when an SMTP connection is closed without having received QUIT,
29809 Exim sends an SMTP response message before actually closing the connection.
29810 With the exception of the &`acl-drop`& case, the default message can be
29811 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29812 &%drop%& verb in another ACL, it is the message from the other ACL that is
29813 used.
29814
29815
29816 .section "Finding an ACL to use" "SECID195"
29817 .cindex "&ACL;" "finding which to use"
29818 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29819 you can use different ACLs in different circumstances. For example,
29820 .code
29821 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29822                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29823 .endd
29824 In the default configuration file there are some example settings for
29825 providing an RFC 4409 message &"submission"& service on port 587 and
29826 an RFC 8314 &"submissions"& service on port 465. You can use a string
29827 expansion like this to choose an ACL for MUAs on these ports which is
29828 more appropriate for this purpose than the default ACL on port 25.
29829
29830 The expanded string does not have to be the name of an ACL in the
29831 configuration file; there are other possibilities. Having expanded the
29832 string, Exim searches for an ACL as follows:
29833
29834 .ilist
29835 If the string begins with a slash, Exim uses it as a filename, and reads its
29836 contents as an ACL. The lines are processed in the same way as lines in the
29837 Exim configuration file. In particular, continuation lines are supported, blank
29838 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29839 If the file does not exist or cannot be read, an error occurs (typically
29840 causing a temporary failure of whatever caused the ACL to be run). For example:
29841 .code
29842 acl_smtp_data = /etc/acls/\
29843   ${lookup{$sender_host_address}lsearch\
29844   {/etc/acllist}{$value}{default}}
29845 .endd
29846 This looks up an ACL file to use on the basis of the host's IP address, falling
29847 back to a default if the lookup fails. If an ACL is successfully read from a
29848 file, it is retained in memory for the duration of the Exim process, so that it
29849 can be re-used without having to re-read the file.
29850 .next
29851 If the string does not start with a slash, and does not contain any spaces,
29852 Exim searches the ACL section of the configuration for an ACL whose name
29853 matches the string.
29854 .next
29855 If no named ACL is found, or if the string contains spaces, Exim parses
29856 the string as an inline ACL. This can save typing in cases where you just
29857 want to have something like
29858 .code
29859 acl_smtp_vrfy = accept
29860 .endd
29861 in order to allow free use of the VRFY command. Such a string may contain
29862 newlines; it is processed in the same way as an ACL that is read from a file.
29863 .endlist
29864
29865
29866
29867
29868 .section "ACL return codes" "SECID196"
29869 .cindex "&ACL;" "return codes"
29870 Except for the QUIT ACL, which does not affect the SMTP return code (see
29871 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29872 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29873 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29874 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29875 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29876 This also causes a 4&'xx'& return code.
29877
29878 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29879 &"deny"&, because there is no mechanism for passing temporary errors to the
29880 submitters of non-SMTP messages.
29881
29882
29883 ACLs that are relevant to message reception may also return &"discard"&. This
29884 has the effect of &"accept"&, but causes either the entire message or an
29885 individual recipient address to be discarded. In other words, it is a
29886 blackholing facility. Use it with care.
29887
29888 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29889 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29890 RCPT ACL is to discard just the one recipient address. If there are no
29891 recipients left when the message's data is received, the DATA ACL is not
29892 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29893 remaining recipients. The &"discard"& return is not permitted for the
29894 &%acl_smtp_predata%& ACL.
29895
29896 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29897 is done on the address and the result determines the SMTP response.
29898
29899
29900 .cindex "&[local_scan()]& function" "when all recipients discarded"
29901 The &[local_scan()]& function is always run, even if there are no remaining
29902 recipients; it may create new recipients.
29903
29904
29905
29906 .section "Unset ACL options" "SECID197"
29907 .cindex "&ACL;" "unset options"
29908 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29909 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29910 not defined at all. For any defined ACL, the default action when control
29911 reaches the end of the ACL statements is &"deny"&.
29912
29913 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29914 these two are ACLs that are used only for their side effects. They cannot be
29915 used to accept or reject anything.
29916
29917 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29918 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29919 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29920 when the ACL is not defined is &"accept"&.
29921
29922 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29923 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29924 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29925 messages over an SMTP connection. For an example, see the ACL in the default
29926 configuration file.
29927
29928
29929
29930
29931 .section "Data for message ACLs" "SECID198"
29932 .cindex "&ACL;" "data for message ACL"
29933 .vindex &$domain$&
29934 .vindex &$local_part$&
29935 .vindex &$sender_address$&
29936 .vindex &$sender_host_address$&
29937 .vindex &$smtp_command$&
29938 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29939 that contain information about the host and the message's sender (for example,
29940 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29941 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29942 &$local_part$& are set from the argument address. The entire SMTP command
29943 is available in &$smtp_command$&.
29944
29945 When an ACL for the AUTH parameter of MAIL is running, the variables that
29946 contain information about the host are set, but &$sender_address$& is not yet
29947 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29948 how it is used.
29949
29950 .vindex "&$message_size$&"
29951 The &$message_size$& variable is set to the value of the SIZE parameter on
29952 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29953 that parameter is not given. The value is updated to the true message size by
29954 the time the final DATA ACL is run (after the message data has been
29955 received).
29956
29957 .vindex "&$rcpt_count$&"
29958 .vindex "&$recipients_count$&"
29959 The &$rcpt_count$& variable increases by one for each RCPT command received.
29960 The &$recipients_count$& variable increases by one each time a RCPT command is
29961 accepted, so while an ACL for RCPT is being processed, it contains the number
29962 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29963 &$rcpt_count$& contains the total number of RCPT commands, and
29964 &$recipients_count$& contains the total number of accepted recipients.
29965
29966
29967
29968
29969
29970 .section "Data for non-message ACLs" "SECTdatfornon"
29971 .cindex "&ACL;" "data for non-message ACL"
29972 .vindex &$smtp_command_argument$&
29973 .vindex &$smtp_command$&
29974 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29975 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29976 and the entire SMTP command is available in &$smtp_command$&.
29977 These variables can be tested using a &%condition%& condition. For example,
29978 here is an ACL for use with AUTH, which insists that either the session is
29979 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29980 does not permit authentication methods that use cleartext passwords on
29981 unencrypted connections.
29982 .code
29983 acl_check_auth:
29984   accept encrypted = *
29985   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29986                      {CRAM-MD5}}
29987   deny   message   = TLS encryption or CRAM-MD5 required
29988 .endd
29989 (Another way of applying this restriction is to arrange for the authenticators
29990 that use cleartext passwords not to be advertised when the connection is not
29991 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29992 option to do this.)
29993
29994
29995
29996 .section "Format of an ACL" "SECID199"
29997 .cindex "&ACL;" "format of"
29998 .cindex "&ACL;" "verbs, definition of"
29999 An individual ACL consists of a number of statements. Each statement starts
30000 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30001 Modifiers can change the way the verb operates, define error and log messages,
30002 set variables, insert delays, and vary the processing of accepted messages.
30003
30004 If all the conditions are met, the verb is obeyed. The same condition may be
30005 used (with different arguments) more than once in the same statement. This
30006 provides a means of specifying an &"and"& conjunction between conditions. For
30007 example:
30008 .code
30009 deny  dnslists = list1.example
30010       dnslists = list2.example
30011 .endd
30012 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30013 the conditions and modifiers when it reaches a condition that fails. What
30014 happens then depends on the verb (and in one case, on a special modifier). Not
30015 all the conditions make sense at every testing point. For example, you cannot
30016 test a sender address in the ACL that is run for a VRFY command.
30017
30018
30019 .section "ACL verbs" "SECID200"
30020 The ACL verbs are as follows:
30021
30022 .ilist
30023 .cindex "&%accept%& ACL verb"
30024 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30025 of the conditions are not met, what happens depends on whether &%endpass%&
30026 appears among the conditions (for syntax see below). If the failing condition
30027 is before &%endpass%&, control is passed to the next ACL statement; if it is
30028 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30029 check a RCPT command:
30030 .code
30031 accept domains = +local_domains
30032        endpass
30033        verify = recipient
30034 .endd
30035 If the recipient domain does not match the &%domains%& condition, control
30036 passes to the next statement. If it does match, the recipient is verified, and
30037 the command is accepted if verification succeeds. However, if verification
30038 fails, the ACL yields &"deny"&, because the failing condition is after
30039 &%endpass%&.
30040
30041 The &%endpass%& feature has turned out to be confusing to many people, so its
30042 use is not recommended nowadays. It is always possible to rewrite an ACL so
30043 that &%endpass%& is not needed, and it is no longer used in the default
30044 configuration.
30045
30046 .cindex "&%message%& ACL modifier" "with &%accept%&"
30047 If a &%message%& modifier appears on an &%accept%& statement, its action
30048 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30049 (when an &%accept%& verb either accepts or passes control to the next
30050 statement), &%message%& can be used to vary the message that is sent when an
30051 SMTP command is accepted. For example, in a RCPT ACL you could have:
30052 .display
30053 &`accept  `&<&'some conditions'&>
30054 &`        message = OK, I will allow you through today`&
30055 .endd
30056 You can specify an SMTP response code, optionally followed by an &"extended
30057 response code"& at the start of the message, but the first digit must be the
30058 same as would be sent by default, which is 2 for an &%accept%& verb.
30059
30060 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30061 an error message that is used when access is denied. This behaviour is retained
30062 for backward compatibility, but current &"best practice"& is to avoid the use
30063 of &%endpass%&.
30064
30065
30066 .next
30067 .cindex "&%defer%& ACL verb"
30068 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30069 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30070 &%defer%& is the same as &%deny%&, because there is no way of sending a
30071 temporary error. For a RCPT command, &%defer%& is much the same as using a
30072 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30073 be used in any ACL, and even for a recipient it might be a simpler approach.
30074
30075
30076 .next
30077 .cindex "&%deny%& ACL verb"
30078 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30079 the conditions are not met, control is passed to the next ACL statement. For
30080 example,
30081 .code
30082 deny dnslists = blackholes.mail-abuse.org
30083 .endd
30084 rejects commands from hosts that are on a DNS black list.
30085
30086
30087 .next
30088 .cindex "&%discard%& ACL verb"
30089 &%discard%&: This verb behaves like &%accept%&, except that it returns
30090 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30091 that are concerned with receiving messages. When all the conditions are true,
30092 the sending entity receives a &"success"& response. However, &%discard%& causes
30093 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30094 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30095 message's recipients are discarded. Recipients that are discarded before DATA
30096 do not appear in the log line when the &%received_recipients%& log selector is set.
30097
30098 If the &%log_message%& modifier is set when &%discard%& operates,
30099 its contents are added to the line that is automatically written to the log.
30100 The &%message%& modifier operates exactly as it does for &%accept%&.
30101
30102
30103 .next
30104 .cindex "&%drop%& ACL verb"
30105 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30106 forcibly closed after the 5&'xx'& error message has been sent. For example:
30107 .code
30108 drop   message   = I don't take more than 20 RCPTs
30109        condition = ${if > {$rcpt_count}{20}}
30110 .endd
30111 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30112 The connection is always dropped after sending a 550 response.
30113
30114 .next
30115 .cindex "&%require%& ACL verb"
30116 &%require%&: If all the conditions are met, control is passed to the next ACL
30117 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30118 example, when checking a RCPT command,
30119 .code
30120 require message = Sender did not verify
30121         verify  = sender
30122 .endd
30123 passes control to subsequent statements only if the message's sender can be
30124 verified. Otherwise, it rejects the command. Note the positioning of the
30125 &%message%& modifier, before the &%verify%& condition. The reason for this is
30126 discussed in section &<<SECTcondmodproc>>&.
30127
30128 .next
30129 .cindex "&%warn%& ACL verb"
30130 &%warn%&: If all the conditions are true, a line specified by the
30131 &%log_message%& modifier is written to Exim's main log. Control always passes
30132 to the next ACL statement. If any condition is false, the log line is not
30133 written. If an identical log line is requested several times in the same
30134 message, only one copy is actually written to the log. If you want to force
30135 duplicates to be written, use the &%logwrite%& modifier instead.
30136
30137 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30138 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30139 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30140 first failing condition. There is more about adding header lines in section
30141 &<<SECTaddheadacl>>&.
30142
30143 If any condition on a &%warn%& statement cannot be completed (that is, there is
30144 some sort of defer), the log line specified by &%log_message%& is not written.
30145 This does not include the case of a forced failure from a lookup, which
30146 is considered to be a successful completion. After a defer, no further
30147 conditions or modifiers in the &%warn%& statement are processed. The incident
30148 is logged, and the ACL continues to be processed, from the next statement
30149 onwards.
30150
30151
30152 .vindex "&$acl_verify_message$&"
30153 When one of the &%warn%& conditions is an address verification that fails, the
30154 text of the verification failure message is in &$acl_verify_message$&. If you
30155 want this logged, you must set it up explicitly. For example:
30156 .code
30157 warn   !verify = sender
30158        log_message = sender verify failed: $acl_verify_message
30159 .endd
30160 .endlist
30161
30162 At the end of each ACL there is an implicit unconditional &%deny%&.
30163
30164 As you can see from the examples above, the conditions and modifiers are
30165 written one to a line, with the first one on the same line as the verb, and
30166 subsequent ones on following lines. If you have a very long condition, you can
30167 continue it onto several physical lines by the usual backslash continuation
30168 mechanism. It is conventional to align the conditions vertically.
30169
30170
30171
30172 .section "ACL variables" "SECTaclvariables"
30173 .cindex "&ACL;" "variables"
30174 There are some special variables that can be set during ACL processing. They
30175 can be used to pass information between different ACLs, different invocations
30176 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30177 transports, and filters that are used to deliver a message. The names of these
30178 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30179 an underscore, but the remainder of the name can be any sequence of
30180 alphanumeric characters and underscores that you choose. There is no limit on
30181 the number of ACL variables. The two sets act as follows:
30182 .ilist
30183 The values of those variables whose names begin with &$acl_c$& persist
30184 throughout an SMTP connection. They are never reset. Thus, a value that is set
30185 while receiving one message is still available when receiving the next message
30186 on the same SMTP connection.
30187 .next
30188 The values of those variables whose names begin with &$acl_m$& persist only
30189 while a message is being received. They are reset afterwards. They are also
30190 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30191 .endlist
30192
30193 When a message is accepted, the current values of all the ACL variables are
30194 preserved with the message and are subsequently made available at delivery
30195 time. The ACL variables are set by a modifier called &%set%&. For example:
30196 .code
30197 accept hosts = whatever
30198        set acl_m4 = some value
30199 accept authenticated = *
30200        set acl_c_auth = yes
30201 .endd
30202 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30203 be set. If you want to set a variable without taking any action, you can use a
30204 &%warn%& verb without any other modifiers or conditions.
30205
30206 .oindex &%strict_acl_vars%&
30207 What happens if a syntactically valid but undefined ACL variable is
30208 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30209 false (the default), an empty string is substituted; if it is true, an
30210 error is generated.
30211
30212 Versions of Exim before 4.64 have a limited set of numbered variables, but
30213 their names are compatible, so there is no problem with upgrading.
30214
30215
30216 .section "Condition and modifier processing" "SECTcondmodproc"
30217 .cindex "&ACL;" "conditions; processing"
30218 .cindex "&ACL;" "modifiers; processing"
30219 An exclamation mark preceding a condition negates its result. For example:
30220 .code
30221 deny   domains = *.dom.example
30222       !verify  = recipient
30223 .endd
30224 causes the ACL to return &"deny"& if the recipient domain ends in
30225 &'dom.example'& and the recipient address cannot be verified. Sometimes
30226 negation can be used on the right-hand side of a condition. For example, these
30227 two statements are equivalent:
30228 .code
30229 deny  hosts = !192.168.3.4
30230 deny !hosts =  192.168.3.4
30231 .endd
30232 However, for many conditions (&%verify%& being a good example), only left-hand
30233 side negation of the whole condition is possible.
30234
30235 The arguments of conditions and modifiers are expanded. A forced failure
30236 of an expansion causes a condition to be ignored, that is, it behaves as if the
30237 condition is true. Consider these two statements:
30238 .code
30239 accept  senders = ${lookup{$host_name}lsearch\
30240                   {/some/file}{$value}fail}
30241 accept  senders = ${lookup{$host_name}lsearch\
30242                   {/some/file}{$value}{}}
30243 .endd
30244 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30245 the returned list is searched, but if the lookup fails the behaviour is
30246 different in the two cases. The &%fail%& in the first statement causes the
30247 condition to be ignored, leaving no further conditions. The &%accept%& verb
30248 therefore succeeds. The second statement, however, generates an empty list when
30249 the lookup fails. No sender can match an empty list, so the condition fails,
30250 and therefore the &%accept%& also fails.
30251
30252 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30253 specify actions that are taken as the conditions for a statement are checked;
30254 others specify text for messages that are used when access is denied or a
30255 warning is generated. The &%control%& modifier affects the way an incoming
30256 message is handled.
30257
30258 The positioning of the modifiers in an ACL statement is important, because the
30259 processing of a verb ceases as soon as its outcome is known. Only those
30260 modifiers that have already been encountered will take effect. For example,
30261 consider this use of the &%message%& modifier:
30262 .code
30263 require message = Can't verify sender
30264         verify  = sender
30265         message = Can't verify recipient
30266         verify  = recipient
30267         message = This message cannot be used
30268 .endd
30269 If sender verification fails, Exim knows that the result of the statement is
30270 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30271 so its text is used as the error message. If sender verification succeeds, but
30272 recipient verification fails, the second message is used. If recipient
30273 verification succeeds, the third message becomes &"current"&, but is never used
30274 because there are no more conditions to cause failure.
30275
30276 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30277 modifier that is used, because all the conditions must be true for rejection to
30278 happen. Specifying more than one &%message%& modifier does not make sense, and
30279 the message can even be specified after all the conditions. For example:
30280 .code
30281 deny   hosts = ...
30282       !senders = *@my.domain.example
30283        message = Invalid sender from client host
30284 .endd
30285 The &"deny"& result does not happen until the end of the statement is reached,
30286 by which time Exim has set up the message.
30287
30288
30289
30290 .section "ACL modifiers" "SECTACLmodi"
30291 .cindex "&ACL;" "modifiers; list of"
30292 The ACL modifiers are as follows:
30293
30294 .vlist
30295 .vitem &*add_header*&&~=&~<&'text'&>
30296 This modifier specifies one or more header lines that are to be added to an
30297 incoming message, assuming, of course, that the message is ultimately
30298 accepted. For details, see section &<<SECTaddheadacl>>&.
30299
30300 .vitem &*continue*&&~=&~<&'text'&>
30301 .cindex "&%continue%& ACL modifier"
30302 .cindex "database" "updating in ACL"
30303 This modifier does nothing of itself, and processing of the ACL always
30304 continues with the next condition or modifier. The value of &%continue%& is in
30305 the side effects of expanding its argument. Typically this could be used to
30306 update a database. It is really just a syntactic tidiness, to avoid having to
30307 write rather ugly lines like this:
30308 .display
30309 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30310 .endd
30311 Instead, all you need is
30312 .display
30313 &`continue = `&<&'some expansion'&>
30314 .endd
30315
30316 .vitem &*control*&&~=&~<&'text'&>
30317 .cindex "&%control%& ACL modifier"
30318 This modifier affects the subsequent processing of the SMTP connection or of an
30319 incoming message that is accepted. The effect of the first type of control
30320 lasts for the duration of the connection, whereas the effect of the second type
30321 lasts only until the current message has been received. The message-specific
30322 controls always apply to the whole message, not to individual recipients,
30323 even if the &%control%& modifier appears in a RCPT ACL.
30324
30325 As there are now quite a few controls that can be applied, they are described
30326 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30327 in several different ways. For example:
30328
30329 . ==== As this is a nested list, any displays it contains must be indented
30330 . ==== as otherwise they are too far to the left. That comment applies only
30331 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30332 . ==== way.
30333
30334 .ilist
30335 It can be at the end of an &%accept%& statement:
30336 .code
30337     accept  ...some conditions
30338             control = queue
30339 .endd
30340 In this case, the control is applied when this statement yields &"accept"&, in
30341 other words, when the conditions are all true.
30342
30343 .next
30344 It can be in the middle of an &%accept%& statement:
30345 .code
30346     accept  ...some conditions...
30347             control = queue
30348             ...some more conditions...
30349 .endd
30350 If the first set of conditions are true, the control is applied, even if the
30351 statement does not accept because one of the second set of conditions is false.
30352 In this case, some subsequent statement must yield &"accept"& for the control
30353 to be relevant.
30354
30355 .next
30356 It can be used with &%warn%& to apply the control, leaving the
30357 decision about accepting or denying to a subsequent verb. For
30358 example:
30359 .code
30360     warn    ...some conditions...
30361             control = freeze
30362     accept  ...
30363 .endd
30364 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30365 &%logwrite%&, so it does not add anything to the message and does not write a
30366 log entry.
30367
30368 .next
30369 If you want to apply a control unconditionally, you can use it with a
30370 &%require%& verb. For example:
30371 .code
30372     require  control = no_multiline_responses
30373 .endd
30374 .endlist
30375
30376 .vitem &*delay*&&~=&~<&'time'&>
30377 .cindex "&%delay%& ACL modifier"
30378 .oindex "&%-bh%&"
30379 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30380 the time interval before proceeding. However, when testing Exim using the
30381 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30382 output instead). The time is given in the usual Exim notation, and the delay
30383 happens as soon as the modifier is processed. In an SMTP session, pending
30384 output is flushed before the delay is imposed.
30385
30386 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30387 example:
30388 .code
30389 deny    ...some conditions...
30390         delay = 30s
30391 .endd
30392 The delay happens if all the conditions are true, before the statement returns
30393 &"deny"&. Compare this with:
30394 .code
30395 deny    delay = 30s
30396         ...some conditions...
30397 .endd
30398 which waits for 30s before processing the conditions. The &%delay%& modifier
30399 can also be used with &%warn%& and together with &%control%&:
30400 .code
30401 warn    ...some conditions...
30402         delay = 2m
30403         control = freeze
30404 accept  ...
30405 .endd
30406
30407 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30408 responses to several commands are no longer buffered and sent in one packet (as
30409 they would normally be) because all output is flushed before imposing the
30410 delay. This optimization is disabled so that a number of small delays do not
30411 appear to the client as one large aggregated delay that might provoke an
30412 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30413 using a &%control%& modifier to set &%no_delay_flush%&.
30414
30415
30416 .vitem &*endpass*&
30417 .cindex "&%endpass%& ACL modifier"
30418 This modifier, which has no argument, is recognized only in &%accept%& and
30419 &%discard%& statements. It marks the boundary between the conditions whose
30420 failure causes control to pass to the next statement, and the conditions whose
30421 failure causes the ACL to return &"deny"&. This concept has proved to be
30422 confusing to some people, so the use of &%endpass%& is no longer recommended as
30423 &"best practice"&. See the description of &%accept%& above for more details.
30424
30425
30426 .vitem &*log_message*&&~=&~<&'text'&>
30427 .cindex "&%log_message%& ACL modifier"
30428 This modifier sets up a message that is used as part of the log message if the
30429 ACL denies access or a &%warn%& statement's conditions are true. For example:
30430 .code
30431 require log_message = wrong cipher suite $tls_in_cipher
30432         encrypted   = DES-CBC3-SHA
30433 .endd
30434 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30435 example:
30436 .display
30437 &`discard `&<&'some conditions'&>
30438 &`        log_message = Discarded $local_part@$domain because...`&
30439 .endd
30440 When access is denied, &%log_message%& adds to any underlying error message
30441 that may exist because of a condition failure. For example, while verifying a
30442 recipient address, a &':fail:'& redirection might have already set up a
30443 message.
30444
30445 The message may be defined before the conditions to which it applies, because
30446 the string expansion does not happen until Exim decides that access is to be
30447 denied. This means that any variables that are set by the condition are
30448 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30449 variables are set after a DNS black list lookup succeeds. If the expansion of
30450 &%log_message%& fails, or if the result is an empty string, the modifier is
30451 ignored.
30452
30453 .vindex "&$acl_verify_message$&"
30454 If you want to use a &%warn%& statement to log the result of an address
30455 verification, you can use &$acl_verify_message$& to include the verification
30456 error message.
30457
30458 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30459 the start of the logged message. If the same warning log message is requested
30460 more than once while receiving  a single email message, only one copy is
30461 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30462 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30463 is logged for a successful &%warn%& statement.
30464
30465 If &%log_message%& is not present and there is no underlying error message (for
30466 example, from the failure of address verification), but &%message%& is present,
30467 the &%message%& text is used for logging rejections. However, if any text for
30468 logging contains newlines, only the first line is logged. In the absence of
30469 both &%log_message%& and &%message%&, a default built-in message is used for
30470 logging rejections.
30471
30472
30473 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30474 .cindex "&%log_reject_target%& ACL modifier"
30475 .cindex "logging in ACL" "specifying which log"
30476 This modifier makes it possible to specify which logs are used for messages
30477 about ACL rejections. Its argument is a colon-separated list of words that can
30478 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30479 may be empty, in which case a rejection is not logged at all. For example, this
30480 ACL fragment writes no logging information when access is denied:
30481 .display
30482 &`deny `&<&'some conditions'&>
30483 &`     log_reject_target =`&
30484 .endd
30485 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30486 permanent and temporary rejections. Its effect lasts for the rest of the
30487 current ACL.
30488
30489
30490 .vitem &*logwrite*&&~=&~<&'text'&>
30491 .cindex "&%logwrite%& ACL modifier"
30492 .cindex "logging in ACL" "immediate"
30493 This modifier writes a message to a log file as soon as it is encountered when
30494 processing an ACL. (Compare &%log_message%&, which, except in the case of
30495 &%warn%& and &%discard%&, is used only if the ACL statement denies
30496 access.) The &%logwrite%& modifier can be used to log special incidents in
30497 ACLs. For example:
30498 .display
30499 &`accept `&<&'some special conditions'&>
30500 &`       control  = freeze`&
30501 &`       logwrite = froze message because ...`&
30502 .endd
30503 By default, the message is written to the main log. However, it may begin
30504 with a colon, followed by a comma-separated list of log names, and then
30505 another colon, to specify exactly which logs are to be written. For
30506 example:
30507 .code
30508 logwrite = :main,reject: text for main and reject logs
30509 logwrite = :panic: text for panic log only
30510 .endd
30511
30512
30513 .vitem &*message*&&~=&~<&'text'&>
30514 .cindex "&%message%& ACL modifier"
30515 This modifier sets up a text string that is expanded and used as a response
30516 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30517 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30518 there is some complication if &%endpass%& is involved; see the description of
30519 &%accept%& for details.)
30520
30521 The expansion of the message happens at the time Exim decides that the ACL is
30522 to end, not at the time it processes &%message%&. If the expansion fails, or
30523 generates an empty string, the modifier is ignored. Here is an example where
30524 &%message%& must be specified first, because the ACL ends with a rejection if
30525 the &%hosts%& condition fails:
30526 .code
30527 require  message = Host not recognized
30528          hosts = 10.0.0.0/8
30529 .endd
30530 (Once a condition has failed, no further conditions or modifiers are
30531 processed.)
30532
30533 .cindex "SMTP" "error codes"
30534 .oindex "&%smtp_banner%&
30535 For ACLs that are triggered by SMTP commands, the message is returned as part
30536 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30537 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30538 is accepted. In the case of the connect ACL, accepting with a message modifier
30539 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30540 accept message may not contain more than one line (otherwise it will be
30541 truncated at the first newline and a panic logged), and it cannot affect the
30542 EHLO options.
30543
30544 When SMTP is involved, the message may begin with an overriding response code,
30545 consisting of three digits optionally followed by an &"extended response code"&
30546 of the form &'n.n.n'&, each code being followed by a space. For example:
30547 .code
30548 deny  message = 599 1.2.3 Host not welcome
30549       hosts = 192.168.34.0/24
30550 .endd
30551 The first digit of the supplied response code must be the same as would be sent
30552 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30553 access, but for the predata ACL, note that the default success code is 354, not
30554 2&'xx'&.
30555
30556 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30557 the message modifier cannot override the 221 response code.
30558
30559 The text in a &%message%& modifier is literal; any quotes are taken as
30560 literals, but because the string is expanded, backslash escapes are processed
30561 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30562 response.
30563
30564 .vindex "&$acl_verify_message$&"
30565 For ACLs that are called by an &%acl =%& ACL condition, the message is
30566 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30567
30568 If &%message%& is used on a statement that verifies an address, the message
30569 specified overrides any message that is generated by the verification process.
30570 However, the original message is available in the variable
30571 &$acl_verify_message$&, so you can incorporate it into your message if you
30572 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30573 routers to be passed back as part of the SMTP response, you should either not
30574 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30575
30576 For compatibility with previous releases of Exim, a &%message%& modifier that
30577 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30578 modifier, but this usage is now deprecated. However, &%message%& acts only when
30579 all the conditions are true, wherever it appears in an ACL command, whereas
30580 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30581 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30582 effect.
30583
30584
30585 .vitem &*queue*&&~=&~<&'text'&>
30586 .cindex "&%queue%& ACL modifier"
30587 .cindex "named queues" "selecting in ACL"
30588 This modifier specifies the use of a named queue for spool files
30589 for the message.
30590 It can only be used before the message is received (i.e. not in
30591 the DATA ACL).
30592 This could be used, for example, for known high-volume burst sources
30593 of traffic, or for quarantine of messages.
30594 Separate queue-runner processes will be needed for named queues.
30595 If the text after expansion is empty, the default queue is used.
30596
30597
30598 .vitem &*remove_header*&&~=&~<&'text'&>
30599 This modifier specifies one or more header names in a colon-separated list
30600  that are to be removed from an incoming message, assuming, of course, that
30601 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30602
30603
30604 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30605 .cindex "&%set%& ACL modifier"
30606 This modifier puts a value into one of the ACL variables (see section
30607 &<<SECTaclvariables>>&).
30608
30609
30610 .vitem &*udpsend*&&~=&~<&'parameters'&>
30611 .cindex "UDP communications"
30612 This modifier sends a UDP packet, for purposes such as statistics
30613 collection or behaviour monitoring. The parameters are expanded, and
30614 the result of the expansion must be a colon-separated list consisting
30615 of a destination server, port number, and the packet contents. The
30616 server can be specified as a host name or IPv4 or IPv6 address. The
30617 separator can be changed with the usual angle bracket syntax. For
30618 example, you might want to collect information on which hosts connect
30619 when:
30620 .code
30621 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30622              $tod_zulu $sender_host_address
30623 .endd
30624 .endlist
30625
30626
30627
30628
30629 .section "Use of the control modifier" "SECTcontrols"
30630 .cindex "&%control%& ACL modifier"
30631 The &%control%& modifier supports the following settings:
30632
30633 .vlist
30634 .vitem &*control&~=&~allow_auth_unadvertised*&
30635 This modifier allows a client host to use the SMTP AUTH command even when it
30636 has not been advertised in response to EHLO. Furthermore, because there are
30637 apparently some really broken clients that do this, Exim will accept AUTH after
30638 HELO (rather than EHLO) when this control is set. It should be used only if you
30639 really need it, and you should limit its use to those broken clients that do
30640 not work without it. For example:
30641 .code
30642 warn hosts   = 192.168.34.25
30643      control = allow_auth_unadvertised
30644 .endd
30645 Normally, when an Exim server receives an AUTH command, it checks the name of
30646 the authentication mechanism that is given in the command to ensure that it
30647 matches an advertised mechanism. When this control is set, the check that a
30648 mechanism has been advertised is bypassed. Any configured mechanism can be used
30649 by the client. This control is permitted only in the connection and HELO ACLs.
30650
30651
30652 .vitem &*control&~=&~caseful_local_part*& &&&
30653        &*control&~=&~caselower_local_part*&
30654 .cindex "&ACL;" "case of local part in"
30655 .cindex "case of local parts"
30656 .vindex "&$local_part$&"
30657 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30658 (that is, during RCPT processing). By default, the contents of &$local_part$&
30659 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30660 any uppercase letters in the original local part are restored in &$local_part$&
30661 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30662 is encountered.
30663
30664 These controls affect only the current recipient. Moreover, they apply only to
30665 local part handling that takes place directly in the ACL (for example, as a key
30666 in lookups). If a test to verify the recipient is obeyed, the case-related
30667 handling of the local part during the verification is controlled by the router
30668 configuration (see the &%caseful_local_part%& generic router option).
30669
30670 This facility could be used, for example, to add a spam score to local parts
30671 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30672 spam score:
30673 .code
30674 warn  control = caseful_local_part
30675       set acl_m4 = ${eval:\
30676                      $acl_m4 + \
30677                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30678                     }
30679       control = caselower_local_part
30680 .endd
30681 Notice that we put back the lower cased version afterwards, assuming that
30682 is what is wanted for subsequent tests.
30683
30684
30685 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30686 .cindex "&ACL;" "cutthrough routing"
30687 .cindex "cutthrough" "requesting"
30688 This option requests delivery be attempted while the item is being received.
30689
30690 The option is usable in the RCPT ACL.
30691 If enabled for a message received via smtp and routed to an smtp transport,
30692 and only one transport, interface, destination host and port combination
30693 is used for all recipients of the message,
30694 then the delivery connection is made while the receiving connection is open
30695 and data is copied from one to the other.
30696
30697 An attempt to set this option for any recipient but the first
30698 for a mail will be quietly ignored.
30699 If a recipient-verify callout
30700 (with use_sender)
30701 connection is subsequently
30702 requested in the same ACL it is held open and used for
30703 any subsequent recipients and the data,
30704 otherwise one is made after the initial RCPT ACL completes.
30705
30706 Note that routers are used in verify mode,
30707 and cannot depend on content of received headers.
30708 Note also that headers cannot be
30709 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30710 Headers may be modified by routers (subject to the above) and transports.
30711 The &'Received-By:'& header is generated as soon as the body reception starts,
30712 rather than the traditional time after the full message is received;
30713 this will affect the timestamp.
30714
30715 All the usual ACLs are called; if one results in the message being
30716 rejected, all effort spent in delivery (including the costs on
30717 the ultimate destination) will be wasted.
30718 Note that in the case of data-time ACLs this includes the entire
30719 message body.
30720
30721 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30722 of outgoing messages is done, because it sends data to the ultimate destination
30723 before the entire message has been received from the source.
30724 It is not supported for messages received with the SMTP PRDR
30725 or CHUNKING
30726 options in use.
30727
30728 Should the ultimate destination system positively accept or reject the mail,
30729 a corresponding indication is given to the source system and nothing is queued.
30730 If the item is successfully delivered in cutthrough mode
30731 the delivery log lines are tagged with ">>" rather than "=>" and appear
30732 before the acceptance "<=" line.
30733
30734 If there is a temporary error the item is queued for later delivery in the
30735 usual fashion.
30736 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30737 to the control; the default value is &"spool"& and the alternate value
30738 &"pass"& copies an SMTP defer response from the target back to the initiator
30739 and does not queue the message.
30740 Note that this is independent of any recipient verify conditions in the ACL.
30741
30742 Delivery in this mode avoids the generation of a bounce mail to a
30743 (possibly faked)
30744 sender when the destination system is doing content-scan based rejection.
30745
30746
30747 .vitem &*control&~=&~debug/*&<&'options'&>
30748 .cindex "&ACL;" "enabling debug logging"
30749 .cindex "debugging" "enabling from an ACL"
30750 This control turns on debug logging, almost as though Exim had been invoked
30751 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30752 by default called &'debuglog'&.
30753 The filename can be adjusted with the &'tag'& option, which
30754 may access any variables already defined.  The logging may be adjusted with
30755 the &'opts'& option, which takes the same values as the &`-d`& command-line
30756 option.
30757 Logging started this way may be stopped, and the file removed,
30758 with the &'kill'& option.
30759 Some examples (which depend on variables that don't exist in all
30760 contexts):
30761 .code
30762       control = debug
30763       control = debug/tag=.$sender_host_address
30764       control = debug/opts=+expand+acl
30765       control = debug/tag=.$message_exim_id/opts=+expand
30766       control = debug/kill
30767 .endd
30768
30769
30770 .vitem &*control&~=&~dkim_disable_verify*&
30771 .cindex "disable DKIM verify"
30772 .cindex "DKIM" "disable verify"
30773 This control turns off DKIM verification processing entirely.  For details on
30774 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30775
30776
30777 .vitem &*control&~=&~dmarc_disable_verify*&
30778 .cindex "disable DMARC verify"
30779 .cindex "DMARC" "disable verify"
30780 This control turns off DMARC verification processing entirely.  For details on
30781 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30782
30783
30784 .vitem &*control&~=&~dscp/*&<&'value'&>
30785 .cindex "&ACL;" "setting DSCP value"
30786 .cindex "DSCP" "inbound"
30787 This option causes the DSCP value associated with the socket for the inbound
30788 connection to be adjusted to a given value, given as one of a number of fixed
30789 strings or to numeric value.
30790 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30791 Common values include &`throughput`&, &`mincost`&, and on newer systems
30792 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30793
30794 The outbound packets from Exim will be marked with this value in the header
30795 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30796 that these values will have any effect, not be stripped by networking
30797 equipment, or do much of anything without cooperation with your Network
30798 Engineer and those of all network operators between the source and destination.
30799
30800
30801 .vitem &*control&~=&~enforce_sync*& &&&
30802        &*control&~=&~no_enforce_sync*&
30803 .cindex "SMTP" "synchronization checking"
30804 .cindex "synchronization checking in SMTP"
30805 These controls make it possible to be selective about when SMTP synchronization
30806 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30807 state of the switch (it is true by default). See the description of this option
30808 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30809
30810 The effect of these two controls lasts for the remainder of the SMTP
30811 connection. They can appear in any ACL except the one for the non-SMTP
30812 messages. The most straightforward place to put them is in the ACL defined by
30813 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30814 before the first synchronization check. The expected use is to turn off the
30815 synchronization checks for badly-behaved hosts that you nevertheless need to
30816 work with.
30817
30818
30819 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30820 .cindex "fake defer"
30821 .cindex "defer, fake"
30822 This control works in exactly the same way as &%fakereject%& (described below)
30823 except that it causes an SMTP 450 response after the message data instead of a
30824 550 response. You must take care when using &%fakedefer%& because it causes the
30825 messages to be duplicated when the sender retries. Therefore, you should not
30826 use &%fakedefer%& if the message is to be delivered normally.
30827
30828 .vitem &*control&~=&~fakereject/*&<&'message'&>
30829 .cindex "fake rejection"
30830 .cindex "rejection, fake"
30831 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30832 words, only when an SMTP message is being received. If Exim accepts the
30833 message, instead the final 250 response, a 550 rejection message is sent.
30834 However, Exim proceeds to deliver the message as normal. The control applies
30835 only to the current message, not to any subsequent ones that may be received in
30836 the same SMTP connection.
30837
30838 The text for the 550 response is taken from the &%control%& modifier. If no
30839 message is supplied, the following is used:
30840 .code
30841 550-Your message has been rejected but is being
30842 550-kept for evaluation.
30843 550-If it was a legitimate message, it may still be
30844 550 delivered to the target recipient(s).
30845 .endd
30846 This facility should be used with extreme caution.
30847
30848 .vitem &*control&~=&~freeze*&
30849 .cindex "frozen messages" "forcing in ACL"
30850 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30851 other words, only when a message is being received. If the message is accepted,
30852 it is placed on Exim's queue and frozen. The control applies only to the
30853 current message, not to any subsequent ones that may be received in the same
30854 SMTP connection.
30855
30856 This modifier can optionally be followed by &`/no_tell`&. If the global option
30857 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30858 is told about the freezing), provided all the &*control=freeze*& modifiers that
30859 are obeyed for the current message have the &`/no_tell`& option.
30860
30861 .vitem &*control&~=&~no_delay_flush*&
30862 .cindex "SMTP" "output flushing, disabling for delay"
30863 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30864 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30865 use. This control, as long as it is encountered before the &%delay%& modifier,
30866 disables such output flushing.
30867
30868 .vitem &*control&~=&~no_callout_flush*&
30869 .cindex "SMTP" "output flushing, disabling for callout"
30870 Exim normally flushes SMTP output before performing a callout in an ACL, to
30871 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30872 use. This control, as long as it is encountered before the &%verify%& condition
30873 that causes the callout, disables such output flushing.
30874
30875 .vitem &*control&~=&~no_mbox_unspool*&
30876 This control is available when Exim is compiled with the content scanning
30877 extension. Content scanning may require a copy of the current message, or parts
30878 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30879 or spam scanner. Normally, such copies are deleted when they are no longer
30880 needed. If this control is set, the copies are not deleted. The control applies
30881 only to the current message, not to any subsequent ones that may be received in
30882 the same SMTP connection. It is provided for debugging purposes and is unlikely
30883 to be useful in production.
30884
30885 .vitem &*control&~=&~no_multiline_responses*&
30886 .cindex "multiline responses, suppressing"
30887 This control is permitted for any ACL except the one for non-SMTP messages.
30888 It seems that there are broken clients in use that cannot handle multiline
30889 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30890
30891 If this control is set, multiline SMTP responses from ACL rejections are
30892 suppressed. One way of doing this would have been to put out these responses as
30893 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30894 (&"use multiline responses for more"& it says &-- ha!), and some of the
30895 responses might get close to that. So this facility, which is after all only a
30896 sop to broken clients, is implemented by doing two very easy things:
30897
30898 .ilist
30899 Extra information that is normally output as part of a rejection caused by
30900 sender verification failure is omitted. Only the final line (typically &"sender
30901 verification failed"&) is sent.
30902 .next
30903 If a &%message%& modifier supplies a multiline response, only the first
30904 line is output.
30905 .endlist
30906
30907 The setting of the switch can, of course, be made conditional on the
30908 calling host. Its effect lasts until the end of the SMTP connection.
30909
30910 .vitem &*control&~=&~no_pipelining*&
30911 .cindex "PIPELINING" "suppressing advertising"
30912 This control turns off the advertising of the PIPELINING extension to SMTP in
30913 the current session. To be useful, it must be obeyed before Exim sends its
30914 response to an EHLO command. Therefore, it should normally appear in an ACL
30915 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30916 &%pipelining_advertise_hosts%&.
30917
30918 .new
30919 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
30920        &*control&~=&~queue_only*&
30921 .oindex "&%queue%&"
30922 .oindex "&%queue_only%&"
30923 .cindex "queueing incoming messages"
30924 .cindex queueing "forcing in ACL"
30925 .cindex "first pass routing"
30926 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30927 other words, only when a message is being received. If the message is accepted,
30928 it is placed on Exim's queue and left there for delivery by a subsequent queue
30929 runner.
30930 If used with no options set,
30931 no immediate delivery process is started. In other words, it has the
30932 effect as the &%queue_only%& global option or &'-odq'& command-line option.
30933
30934 If the &'first_pass_route'& option is given then
30935 the behaviour is like the command-line &'-oqds'& option;
30936 a delivery process is started which stops short of making
30937 any SMTP delivery.  The benefit is that the hints database will be updated for
30938 the message being waiting for a specific host, and a later queue run will be
30939 able to send all such messages on a single connection.
30940
30941 The control only applies to the current message, not to any subsequent ones that
30942  may be received in the same SMTP connection.
30943 .wen
30944
30945 .vitem &*control&~=&~submission/*&<&'options'&>
30946 .cindex "message" "submission"
30947 .cindex "submission mode"
30948 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30949 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30950 the current message is a submission from a local MUA. In this case, Exim
30951 operates in &"submission mode"&, and applies certain fixups to the message if
30952 necessary. For example, it adds a &'Date:'& header line if one is not present.
30953 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30954 late (the message has already been created).
30955
30956 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30957 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30958 submission mode; the available options for this control are described there.
30959 The control applies only to the current message, not to any subsequent ones
30960 that may be received in the same SMTP connection.
30961
30962 .vitem &*control&~=&~suppress_local_fixups*&
30963 .cindex "submission fixups, suppressing"
30964 This control applies to locally submitted (non TCP/IP) messages, and is the
30965 complement of &`control = submission`&. It disables the fixups that are
30966 normally applied to locally-submitted messages. Specifically:
30967
30968 .ilist
30969 Any &'Sender:'& header line is left alone (in this respect, it is a
30970 dynamic version of &%local_sender_retain%&).
30971 .next
30972 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30973 .next
30974 There is no check that &'From:'& corresponds to the actual sender.
30975 .endlist ilist
30976
30977 This control may be useful when a remotely-originated message is accepted,
30978 passed to some scanning program, and then re-submitted for delivery. It can be
30979 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30980 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30981 data is read.
30982
30983 &*Note:*& This control applies only to the current message, not to any others
30984 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30985
30986 .vitem &*control&~=&~utf8_downconvert*&
30987 This control enables conversion of UTF-8 in message addresses
30988 to a-label form.
30989 For details see section &<<SECTi18nMTA>>&.
30990 .endlist vlist
30991
30992
30993 .section "Summary of message fixup control" "SECTsummesfix"
30994 All four possibilities for message fixups can be specified:
30995
30996 .ilist
30997 Locally submitted, fixups applied: the default.
30998 .next
30999 Locally submitted, no fixups applied: use
31000 &`control = suppress_local_fixups`&.
31001 .next
31002 Remotely submitted, no fixups applied: the default.
31003 .next
31004 Remotely submitted, fixups applied: use &`control = submission`&.
31005 .endlist
31006
31007
31008
31009 .section "Adding header lines in ACLs" "SECTaddheadacl"
31010 .cindex "header lines" "adding in an ACL"
31011 .cindex "header lines" "position of added lines"
31012 .cindex "&%add_header%& ACL modifier"
31013 The &%add_header%& modifier can be used to add one or more extra header lines
31014 to an incoming message, as in this example:
31015 .code
31016 warn dnslists = sbl.spamhaus.org : \
31017                 dialup.mail-abuse.org
31018      add_header = X-blacklisted-at: $dnslist_domain
31019 .endd
31020 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31021 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31022 receiving a message). The message must ultimately be accepted for
31023 &%add_header%& to have any significant effect. You can use &%add_header%& with
31024 any ACL verb, including &%deny%& (though this is potentially useful only in a
31025 RCPT ACL).
31026
31027 Headers will not be added to the message if the modifier is used in
31028 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31029
31030 Leading and trailing newlines are removed from
31031 the data for the &%add_header%& modifier; if it then
31032 contains one or more newlines that
31033 are not followed by a space or a tab, it is assumed to contain multiple header
31034 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31035 front of any line that is not a valid header line.
31036
31037 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31038 They are added to the message before processing the DATA and MIME ACLs.
31039 However, if an identical header line is requested more than once, only one copy
31040 is actually added to the message. Further header lines may be accumulated
31041 during the DATA and MIME ACLs, after which they are added to the message, again
31042 with duplicates suppressed. Thus, it is possible to add two identical header
31043 lines to an SMTP message, but only if one is added before DATA and one after.
31044 In the case of non-SMTP messages, new headers are accumulated during the
31045 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31046 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31047 are included in the entry that is written to the reject log.
31048
31049 .cindex "header lines" "added; visibility of"
31050 Header lines are not visible in string expansions
31051 of message headers
31052 until they are added to the
31053 message. It follows that header lines defined in the MAIL, RCPT, and predata
31054 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31055 header lines that are added by the DATA or MIME ACLs are not visible in those
31056 ACLs. Because of this restriction, you cannot use header lines as a way of
31057 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31058 this, you can use ACL variables, as described in section
31059 &<<SECTaclvariables>>&.
31060
31061 The list of headers yet to be added is given by the &%$headers_added%& variable.
31062
31063 The &%add_header%& modifier acts immediately as it is encountered during the
31064 processing of an ACL. Notice the difference between these two cases:
31065 .display
31066 &`accept add_header = ADDED: some text`&
31067 &`       `&<&'some condition'&>
31068
31069 &`accept `&<&'some condition'&>
31070 &`       add_header = ADDED: some text`&
31071 .endd
31072 In the first case, the header line is always added, whether or not the
31073 condition is true. In the second case, the header line is added only if the
31074 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31075 ACL statement. All those that are encountered before a condition fails are
31076 honoured.
31077
31078 .cindex "&%warn%& ACL verb"
31079 For compatibility with previous versions of Exim, a &%message%& modifier for a
31080 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31081 effect only if all the conditions are true, even if it appears before some of
31082 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31083 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31084 are present on a &%warn%& verb, both are processed according to their
31085 specifications.
31086
31087 By default, new header lines are added to a message at the end of the existing
31088 header lines. However, you can specify that any particular header line should
31089 be added right at the start (before all the &'Received:'& lines), immediately
31090 after the first block of &'Received:'& lines, or immediately before any line
31091 that is not a &'Received:'& or &'Resent-something:'& header.
31092
31093 This is done by specifying &":at_start:"&, &":after_received:"&, or
31094 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31095 header line, respectively. (Header text cannot start with a colon, as there has
31096 to be a header name first.) For example:
31097 .code
31098 warn add_header = \
31099        :after_received:X-My-Header: something or other...
31100 .endd
31101 If more than one header line is supplied in a single &%add_header%& modifier,
31102 each one is treated independently and can therefore be placed differently. If
31103 you add more than one line at the start, or after the Received: block, they end
31104 up in reverse order.
31105
31106 &*Warning*&: This facility currently applies only to header lines that are
31107 added in an ACL. It does NOT work for header lines that are added in a
31108 system filter or in a router or transport.
31109
31110
31111
31112 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31113 .cindex "header lines" "removing in an ACL"
31114 .cindex "header lines" "position of removed lines"
31115 .cindex "&%remove_header%& ACL modifier"
31116 The &%remove_header%& modifier can be used to remove one or more header lines
31117 from an incoming message, as in this example:
31118 .code
31119 warn   message        = Remove internal headers
31120        remove_header  = x-route-mail1 : x-route-mail2
31121 .endd
31122 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31123 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31124 receiving a message). The message must ultimately be accepted for
31125 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31126 with any ACL verb, including &%deny%&, though this is really not useful for
31127 any verb that doesn't result in a delivered message.
31128
31129 Headers will not be removed from the message if the modifier is used in
31130 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31131
31132 More than one header can be removed at the same time by using a colon separated
31133 list of header names. The header matching is case insensitive. Wildcards are
31134 not permitted, nor is list expansion performed, so you cannot use hostlists to
31135 create a list of headers, however both connection and message variable expansion
31136 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31137 .code
31138 warn   hosts           = +internal_hosts
31139        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31140 warn   message         = Remove internal headers
31141        remove_header   = $acl_c_ihdrs
31142 .endd
31143 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31144 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31145 If multiple header lines match, all are removed.
31146 There is no harm in attempting to remove the same header twice nor in removing
31147 a non-existent header. Further header lines to be removed may be accumulated
31148 during the DATA and MIME ACLs, after which they are removed from the message,
31149 if present. In the case of non-SMTP messages, headers to be removed are
31150 accumulated during the non-SMTP ACLs, and are removed from the message after
31151 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31152 ACL, there really is no effect because there is no logging of what headers
31153 would have been removed.
31154
31155 .cindex "header lines" "removed; visibility of"
31156 Header lines are not visible in string expansions until the DATA phase when it
31157 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31158 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31159 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31160 this restriction, you cannot use header lines as a way of controlling data
31161 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31162 you should instead use ACL variables, as described in section
31163 &<<SECTaclvariables>>&.
31164
31165 The &%remove_header%& modifier acts immediately as it is encountered during the
31166 processing of an ACL. Notice the difference between these two cases:
31167 .display
31168 &`accept remove_header = X-Internal`&
31169 &`       `&<&'some condition'&>
31170
31171 &`accept `&<&'some condition'&>
31172 &`       remove_header = X-Internal`&
31173 .endd
31174 In the first case, the header line is always removed, whether or not the
31175 condition is true. In the second case, the header line is removed only if the
31176 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31177 same ACL statement. All those that are encountered before a condition fails
31178 are honoured.
31179
31180 &*Warning*&: This facility currently applies only to header lines that are
31181 present during ACL processing. It does NOT remove header lines that are added
31182 in a system filter or in a router or transport.
31183
31184
31185
31186
31187 .section "ACL conditions" "SECTaclconditions"
31188 .cindex "&ACL;" "conditions; list of"
31189 Some of the conditions listed in this section are available only when Exim is
31190 compiled with the content-scanning extension. They are included here briefly
31191 for completeness. More detailed descriptions can be found in the discussion on
31192 content scanning in chapter &<<CHAPexiscan>>&.
31193
31194 Not all conditions are relevant in all circumstances. For example, testing
31195 senders and recipients does not make sense in an ACL that is being run as the
31196 result of the arrival of an ETRN command, and checks on message headers can be
31197 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31198 can use the same condition (with different parameters) more than once in the
31199 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31200 The conditions are as follows:
31201
31202
31203 .vlist
31204 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31205 .cindex "&ACL;" "nested"
31206 .cindex "&ACL;" "indirect"
31207 .cindex "&ACL;" "arguments"
31208 .cindex "&%acl%& ACL condition"
31209 The possible values of the argument are the same as for the
31210 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31211 &"accept"& the condition is true; if it returns &"deny"& the condition is
31212 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31213 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31214 condition false. This means that further processing of the &%warn%& verb
31215 ceases, but processing of the ACL continues.
31216
31217 If the argument is a named ACL, up to nine space-separated optional values
31218 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31219 and $acl_narg is set to the count of values.
31220 Previous values of these variables are restored after the call returns.
31221 The name and values are expanded separately.
31222 Note that spaces in complex expansions which are used as arguments
31223 will act as argument separators.
31224
31225 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31226 the connection is dropped. If it returns &"discard"&, the verb must be
31227 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31228 conditions are tested.
31229
31230 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31231 loops. This condition allows you to use different ACLs in different
31232 circumstances. For example, different ACLs can be used to handle RCPT commands
31233 for different local users or different local domains.
31234
31235 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31236 .cindex "&%authenticated%& ACL condition"
31237 .cindex "authentication" "ACL checking"
31238 .cindex "&ACL;" "testing for authentication"
31239 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31240 the name of the authenticator is tested against the list. To test for
31241 authentication by any authenticator, you can set
31242 .code
31243 authenticated = *
31244 .endd
31245
31246 .vitem &*condition&~=&~*&<&'string'&>
31247 .cindex "&%condition%& ACL condition"
31248 .cindex "customizing" "ACL condition"
31249 .cindex "&ACL;" "customized test"
31250 .cindex "&ACL;" "testing, customized"
31251 This feature allows you to make up custom conditions. If the result of
31252 expanding the string is an empty string, the number zero, or one of the strings
31253 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31254 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31255 any other value, some error is assumed to have occurred, and the ACL returns
31256 &"defer"&. However, if the expansion is forced to fail, the condition is
31257 ignored. The effect is to treat it as true, whether it is positive or
31258 negative.
31259
31260 .vitem &*decode&~=&~*&<&'location'&>
31261 .cindex "&%decode%& ACL condition"
31262 This condition is available only when Exim is compiled with the
31263 content-scanning extension, and it is allowed only in the ACL defined by
31264 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31265 If all goes well, the condition is true. It is false only if there are
31266 problems such as a syntax error or a memory shortage. For more details, see
31267 chapter &<<CHAPexiscan>>&.
31268
31269 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31270 .cindex "&%dnslists%& ACL condition"
31271 .cindex "DNS list" "in ACL"
31272 .cindex "black list (DNS)"
31273 .cindex "&ACL;" "testing a DNS list"
31274 This condition checks for entries in DNS black lists. These are also known as
31275 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31276 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31277 different variants of this condition to describe briefly here. See sections
31278 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31279
31280 .vitem &*domains&~=&~*&<&'domain&~list'&>
31281 .cindex "&%domains%& ACL condition"
31282 .cindex "domain" "ACL checking"
31283 .cindex "&ACL;" "testing a recipient domain"
31284 .vindex "&$domain_data$&"
31285 This condition is relevant only after a RCPT command. It checks that the domain
31286 of the recipient address is in the domain list. If percent-hack processing is
31287 enabled, it is done before this test is done. If the check succeeds with a
31288 lookup, the result of the lookup is placed in &$domain_data$& until the next
31289 &%domains%& test.
31290
31291 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31292 use &%domains%& in a DATA ACL.
31293
31294
31295 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31296 .cindex "&%encrypted%& ACL condition"
31297 .cindex "encryption" "checking in an ACL"
31298 .cindex "&ACL;" "testing for encryption"
31299 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31300 name of the cipher suite in use is tested against the list. To test for
31301 encryption without testing for any specific cipher suite(s), set
31302 .code
31303 encrypted = *
31304 .endd
31305
31306
31307 .vitem &*hosts&~=&~*&<&'host&~list'&>
31308 .cindex "&%hosts%& ACL condition"
31309 .cindex "host" "ACL checking"
31310 .cindex "&ACL;" "testing the client host"
31311 This condition tests that the calling host matches the host list. If you have
31312 name lookups or wildcarded host names and IP addresses in the same host list,
31313 you should normally put the IP addresses first. For example, you could have:
31314 .code
31315 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31316 .endd
31317 The lookup in this example uses the host name for its key. This is implied by
31318 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31319 and it wouldn't matter which way round you had these two items.)
31320
31321 The reason for the problem with host names lies in the left-to-right way that
31322 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31323 but when it reaches an item that requires a host name, it fails if it cannot
31324 find a host name to compare with the pattern. If the above list is given in the
31325 opposite order, the &%accept%& statement fails for a host whose name cannot be
31326 found, even if its IP address is 10.9.8.7.
31327
31328 If you really do want to do the name check first, and still recognize the IP
31329 address even if the name lookup fails, you can rewrite the ACL like this:
31330 .code
31331 accept hosts = dbm;/etc/friendly/hosts
31332 accept hosts = 10.9.8.7
31333 .endd
31334 The default action on failing to find the host name is to assume that the host
31335 is not in the list, so the first &%accept%& statement fails. The second
31336 statement can then check the IP address.
31337
31338 .vindex "&$host_data$&"
31339 If a &%hosts%& condition is satisfied by means of a lookup, the result
31340 of the lookup is made available in the &$host_data$& variable. This
31341 allows you, for example, to set up a statement like this:
31342 .code
31343 deny  hosts = net-lsearch;/some/file
31344 message = $host_data
31345 .endd
31346 which gives a custom error message for each denied host.
31347
31348 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31349 .cindex "&%local_parts%& ACL condition"
31350 .cindex "local part" "ACL checking"
31351 .cindex "&ACL;" "testing a local part"
31352 .vindex "&$local_part_data$&"
31353 This condition is relevant only after a RCPT command. It checks that the local
31354 part of the recipient address is in the list. If percent-hack processing is
31355 enabled, it is done before this test. If the check succeeds with a lookup, the
31356 result of the lookup is placed in &$local_part_data$&, which remains set until
31357 the next &%local_parts%& test.
31358
31359 .vitem &*malware&~=&~*&<&'option'&>
31360 .cindex "&%malware%& ACL condition"
31361 .cindex "&ACL;" "virus scanning"
31362 .cindex "&ACL;" "scanning for viruses"
31363 This condition is available only when Exim is compiled with the
31364 content-scanning extension
31365 and only after a DATA command.
31366 It causes the incoming message to be scanned for
31367 viruses. For details, see chapter &<<CHAPexiscan>>&.
31368
31369 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31370 .cindex "&%mime_regex%& ACL condition"
31371 .cindex "&ACL;" "testing by regex matching"
31372 This condition is available only when Exim is compiled with the
31373 content-scanning extension, and it is allowed only in the ACL defined by
31374 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31375 with any of the regular expressions. For details, see chapter
31376 &<<CHAPexiscan>>&.
31377
31378 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31379 .cindex "rate limiting"
31380 This condition can be used to limit the rate at which a user or host submits
31381 messages. Details are given in section &<<SECTratelimiting>>&.
31382
31383 .vitem &*recipients&~=&~*&<&'address&~list'&>
31384 .cindex "&%recipients%& ACL condition"
31385 .cindex "recipient" "ACL checking"
31386 .cindex "&ACL;" "testing a recipient"
31387 This condition is relevant only after a RCPT command. It checks the entire
31388 recipient address against a list of recipients.
31389
31390 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31391 .cindex "&%regex%& ACL condition"
31392 .cindex "&ACL;" "testing by regex matching"
31393 This condition is available only when Exim is compiled with the
31394 content-scanning extension, and is available only in the DATA, MIME, and
31395 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31396 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31397
31398 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31399 .cindex "&%sender_domains%& ACL condition"
31400 .cindex "sender" "ACL checking"
31401 .cindex "&ACL;" "testing a sender domain"
31402 .vindex "&$domain$&"
31403 .vindex "&$sender_address_domain$&"
31404 This condition tests the domain of the sender of the message against the given
31405 domain list. &*Note*&: The domain of the sender address is in
31406 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31407 of this condition. This is an exception to the general rule for testing domain
31408 lists. It is done this way so that, if this condition is used in an ACL for a
31409 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31410 influence the sender checking.
31411
31412 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31413 relaying, because sender addresses are easily, and commonly, forged.
31414
31415 .vitem &*senders&~=&~*&<&'address&~list'&>
31416 .cindex "&%senders%& ACL condition"
31417 .cindex "sender" "ACL checking"
31418 .cindex "&ACL;" "testing a sender"
31419 This condition tests the sender of the message against the given list. To test
31420 for a bounce message, which has an empty sender, set
31421 .code
31422 senders = :
31423 .endd
31424 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31425 relaying, because sender addresses are easily, and commonly, forged.
31426
31427 .vitem &*spam&~=&~*&<&'username'&>
31428 .cindex "&%spam%& ACL condition"
31429 .cindex "&ACL;" "scanning for spam"
31430 This condition is available only when Exim is compiled with the
31431 content-scanning extension. It causes the incoming message to be scanned by
31432 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31433
31434 .vitem &*verify&~=&~certificate*&
31435 .cindex "&%verify%& ACL condition"
31436 .cindex "TLS" "client certificate verification"
31437 .cindex "certificate" "verification of client"
31438 .cindex "&ACL;" "certificate verification"
31439 .cindex "&ACL;" "testing a TLS certificate"
31440 This condition is true in an SMTP session if the session is encrypted, and a
31441 certificate was received from the client, and the certificate was verified. The
31442 server requests a certificate only if the client matches &%tls_verify_hosts%&
31443 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31444
31445 .vitem &*verify&~=&~csa*&
31446 .cindex "CSA verification"
31447 This condition checks whether the sending host (the client) is authorized to
31448 send email. Details of how this works are given in section
31449 &<<SECTverifyCSA>>&.
31450
31451 .vitem &*verify&~=&~header_names_ascii*&
31452 .cindex "&%verify%& ACL condition"
31453 .cindex "&ACL;" "verifying header names only ASCII"
31454 .cindex "header lines" "verifying header names only ASCII"
31455 .cindex "verifying" "header names only ASCII"
31456 This condition is relevant only in an ACL that is run after a message has been
31457 received, that is, in an ACL specified by &%acl_smtp_data%& or
31458 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31459 there are no non-ASCII characters, also excluding control characters.  The
31460 allowable characters are decimal ASCII values 33 through 126.
31461
31462 Exim itself will handle headers with non-ASCII characters, but it can cause
31463 problems for downstream applications, so this option will allow their
31464 detection and rejection in the DATA ACL's.
31465
31466 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31467 .cindex "&%verify%& ACL condition"
31468 .cindex "&ACL;" "verifying sender in the header"
31469 .cindex "header lines" "verifying the sender in"
31470 .cindex "sender" "verifying in header"
31471 .cindex "verifying" "sender in header"
31472 This condition is relevant only in an ACL that is run after a message has been
31473 received, that is, in an ACL specified by &%acl_smtp_data%& or
31474 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31475 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31476 is loosely thought of as a &"sender"& address (hence the name of the test).
31477 However, an address that appears in one of these headers need not be an address
31478 that accepts bounce messages; only sender addresses in envelopes are required
31479 to accept bounces. Therefore, if you use the callout option on this check, you
31480 might want to arrange for a non-empty address in the MAIL command.
31481
31482 Details of address verification and the options are given later, starting at
31483 section &<<SECTaddressverification>>& (callouts are described in section
31484 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31485 condition to restrict it to bounce messages only:
31486 .code
31487 deny    senders = :
31488         message = A valid sender header is required for bounces
31489        !verify  = header_sender
31490 .endd
31491
31492 .vitem &*verify&~=&~header_syntax*&
31493 .cindex "&%verify%& ACL condition"
31494 .cindex "&ACL;" "verifying header syntax"
31495 .cindex "header lines" "verifying syntax"
31496 .cindex "verifying" "header syntax"
31497 This condition is relevant only in an ACL that is run after a message has been
31498 received, that is, in an ACL specified by &%acl_smtp_data%& or
31499 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31500 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31501 and &'Bcc:'&), returning true if there are no problems.
31502 Unqualified addresses (local parts without domains) are
31503 permitted only in locally generated messages and from hosts that match
31504 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31505 appropriate.
31506
31507 Note that this condition is a syntax check only. However, a common spamming
31508 ploy used to be to send syntactically invalid headers such as
31509 .code
31510 To: @
31511 .endd
31512 and this condition can be used to reject such messages, though they are not as
31513 common as they used to be.
31514
31515 .vitem &*verify&~=&~helo*&
31516 .cindex "&%verify%& ACL condition"
31517 .cindex "&ACL;" "verifying HELO/EHLO"
31518 .cindex "HELO" "verifying"
31519 .cindex "EHLO" "verifying"
31520 .cindex "verifying" "EHLO"
31521 .cindex "verifying" "HELO"
31522 This condition is true if a HELO or EHLO command has been received from the
31523 client host, and its contents have been verified. If there has been no previous
31524 attempt to verify the HELO/EHLO contents, it is carried out when this
31525 condition is encountered. See the description of the &%helo_verify_hosts%& and
31526 &%helo_try_verify_hosts%& options for details of how to request verification
31527 independently of this condition, and for detail of the verification.
31528
31529 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31530 option), this condition is always true.
31531
31532
31533 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31534 .cindex "verifying" "not blind"
31535 .cindex "bcc recipients, verifying none"
31536 This condition checks that there are no blind (bcc) recipients in the message.
31537 Every envelope recipient must appear either in a &'To:'& header line or in a
31538 &'Cc:'& header line for this condition to be true. Local parts are checked
31539 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31540 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31541 used only in a DATA or non-SMTP ACL.
31542
31543 There is one possible option, &`case_insensitive`&.  If this is present then
31544 local parts are checked case-insensitively.
31545
31546 There are, of course, many legitimate messages that make use of blind (bcc)
31547 recipients. This check should not be used on its own for blocking messages.
31548
31549
31550 .vitem &*verify&~=&~recipient/*&<&'options'&>
31551 .cindex "&%verify%& ACL condition"
31552 .cindex "&ACL;" "verifying recipient"
31553 .cindex "recipient" "verifying"
31554 .cindex "verifying" "recipient"
31555 .vindex "&$address_data$&"
31556 This condition is relevant only after a RCPT command. It verifies the current
31557 recipient. Details of address verification are given later, starting at section
31558 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31559 of &$address_data$& is the last value that was set while routing the address.
31560 This applies even if the verification fails. When an address that is being
31561 verified is redirected to a single address, verification continues with the new
31562 address, and in that case, the subsequent value of &$address_data$& is the
31563 value for the child address.
31564
31565 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31566 .cindex "&%verify%& ACL condition"
31567 .cindex "&ACL;" "verifying host reverse lookup"
31568 .cindex "host" "verifying reverse lookup"
31569 This condition ensures that a verified host name has been looked up from the IP
31570 address of the client host. (This may have happened already if the host name
31571 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31572 Verification ensures that the host name obtained from a reverse DNS lookup, or
31573 one of its aliases, does, when it is itself looked up in the DNS, yield the
31574 original IP address.
31575
31576 There is one possible option, &`defer_ok`&.  If this is present and a
31577 DNS operation returns a temporary error, the verify condition succeeds.
31578
31579 If this condition is used for a locally generated message (that is, when there
31580 is no client host involved), it always succeeds.
31581
31582 .vitem &*verify&~=&~sender/*&<&'options'&>
31583 .cindex "&%verify%& ACL condition"
31584 .cindex "&ACL;" "verifying sender"
31585 .cindex "sender" "verifying"
31586 .cindex "verifying" "sender"
31587 This condition is relevant only after a MAIL or RCPT command, or after a
31588 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31589 the message's sender is empty (that is, this is a bounce message), the
31590 condition is true. Otherwise, the sender address is verified.
31591
31592 .vindex "&$address_data$&"
31593 .vindex "&$sender_address_data$&"
31594 If there is data in the &$address_data$& variable at the end of routing, its
31595 value is placed in &$sender_address_data$& at the end of verification. This
31596 value can be used in subsequent conditions and modifiers in the same ACL
31597 statement. It does not persist after the end of the current statement. If you
31598 want to preserve the value for longer, you can save it in an ACL variable.
31599
31600 Details of verification are given later, starting at section
31601 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31602 to avoid doing it more than once per message.
31603
31604 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31605 .cindex "&%verify%& ACL condition"
31606 This is a variation of the previous option, in which a modified address is
31607 verified as a sender.
31608
31609 Note that '/' is legal in local-parts; if the address may have such
31610 (eg. is generated from the received message)
31611 they must be protected from the options parsing by doubling:
31612 .code
31613 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31614 .endd
31615 .endlist
31616
31617
31618
31619 .section "Using DNS lists" "SECTmorednslists"
31620 .cindex "DNS list" "in ACL"
31621 .cindex "black list (DNS)"
31622 .cindex "&ACL;" "testing a DNS list"
31623 In its simplest form, the &%dnslists%& condition tests whether the calling host
31624 is on at least one of a number of DNS lists by looking up the inverted IP
31625 address in one or more DNS domains. (Note that DNS list domains are not mail
31626 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31627 special options instead.) For example, if the calling host's IP
31628 address is 192.168.62.43, and the ACL statement is
31629 .code
31630 deny dnslists = blackholes.mail-abuse.org : \
31631                 dialups.mail-abuse.org
31632 .endd
31633 the following records are looked up:
31634 .code
31635 43.62.168.192.blackholes.mail-abuse.org
31636 43.62.168.192.dialups.mail-abuse.org
31637 .endd
31638 As soon as Exim finds an existing DNS record, processing of the list stops.
31639 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31640 to test that a host is on more than one list (an &"and"& conjunction), you can
31641 use two separate conditions:
31642 .code
31643 deny dnslists = blackholes.mail-abuse.org
31644      dnslists = dialups.mail-abuse.org
31645 .endd
31646 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31647 behaves as if the host does not match the list item, that is, as if the DNS
31648 record does not exist. If there are further items in the DNS list, they are
31649 processed.
31650
31651 This is usually the required action when &%dnslists%& is used with &%deny%&
31652 (which is the most common usage), because it prevents a DNS failure from
31653 blocking mail. However, you can change this behaviour by putting one of the
31654 following special items in the list:
31655 .display
31656 &`+include_unknown `&   behave as if the item is on the list
31657 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31658 &`+defer_unknown   `&   give a temporary error
31659 .endd
31660 .cindex "&`+include_unknown`&"
31661 .cindex "&`+exclude_unknown`&"
31662 .cindex "&`+defer_unknown`&"
31663 Each of these applies to any subsequent items on the list. For example:
31664 .code
31665 deny dnslists = +defer_unknown : foo.bar.example
31666 .endd
31667 Testing the list of domains stops as soon as a match is found. If you want to
31668 warn for one list and block for another, you can use two different statements:
31669 .code
31670 deny  dnslists = blackholes.mail-abuse.org
31671 warn  message  = X-Warn: sending host is on dialups list
31672       dnslists = dialups.mail-abuse.org
31673 .endd
31674 .cindex caching "of dns lookup"
31675 .cindex DNS TTL
31676 DNS list lookups are cached by Exim for the duration of the SMTP session
31677 (but limited by the DNS return TTL value),
31678 so a lookup based on the IP address is done at most once for any incoming
31679 connection (assuming long-enough TTL).
31680 Exim does not share information between multiple incoming
31681 connections (but your local name server cache should be active).
31682
31683 There are a number of DNS lists to choose from, some commercial, some free,
31684 or free for small deployments.  An overview can be found at
31685 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31686
31687
31688
31689 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31690 .cindex "DNS list" "keyed by explicit IP address"
31691 By default, the IP address that is used in a DNS list lookup is the IP address
31692 of the calling host. However, you can specify another IP address by listing it
31693 after the domain name, introduced by a slash. For example:
31694 .code
31695 deny dnslists = black.list.tld/192.168.1.2
31696 .endd
31697 This feature is not very helpful with explicit IP addresses; it is intended for
31698 use with IP addresses that are looked up, for example, the IP addresses of the
31699 MX hosts or nameservers of an email sender address. For an example, see section
31700 &<<SECTmulkeyfor>>& below.
31701
31702
31703
31704
31705 .section "DNS lists keyed on domain names" "SECID202"
31706 .cindex "DNS list" "keyed by domain name"
31707 There are some lists that are keyed on domain names rather than inverted IP
31708 addresses (see, e.g., the &'domain based zones'& link at
31709 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31710 with these lists. You can change the name that is looked up in a DNS list by
31711 listing it after the domain name, introduced by a slash. For example,
31712 .code
31713 deny  message  = Sender's domain is listed at $dnslist_domain
31714       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31715 .endd
31716 This particular example is useful only in ACLs that are obeyed after the
31717 RCPT or DATA commands, when a sender address is available. If (for
31718 example) the message's sender is &'user@tld.example'& the name that is looked
31719 up by this example is
31720 .code
31721 tld.example.dsn.rfc-ignorant.org
31722 .endd
31723 A single &%dnslists%& condition can contain entries for both names and IP
31724 addresses. For example:
31725 .code
31726 deny dnslists = sbl.spamhaus.org : \
31727                 dsn.rfc-ignorant.org/$sender_address_domain
31728 .endd
31729 The first item checks the sending host's IP address; the second checks a domain
31730 name. The whole condition is true if either of the DNS lookups succeeds.
31731
31732
31733
31734
31735 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31736 .cindex "DNS list" "multiple keys for"
31737 The syntax described above for looking up explicitly-defined values (either
31738 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31739 name for the DNS list, what follows the slash can in fact be a list of items.
31740 As with all lists in Exim, the default separator is a colon. However, because
31741 this is a sublist within the list of DNS blacklist domains, it is necessary
31742 either to double the separators like this:
31743 .code
31744 dnslists = black.list.tld/name.1::name.2
31745 .endd
31746 or to change the separator character, like this:
31747 .code
31748 dnslists = black.list.tld/<;name.1;name.2
31749 .endd
31750 If an item in the list is an IP address, it is inverted before the DNS
31751 blacklist domain is appended. If it is not an IP address, no inversion
31752 occurs. Consider this condition:
31753 .code
31754 dnslists = black.list.tld/<;192.168.1.2;a.domain
31755 .endd
31756 The DNS lookups that occur are:
31757 .code
31758 2.1.168.192.black.list.tld
31759 a.domain.black.list.tld
31760 .endd
31761 Once a DNS record has been found (that matches a specific IP return
31762 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31763 are done. If there is a temporary DNS error, the rest of the sublist of domains
31764 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31765 only if no other DNS lookup in this sublist succeeds. In other words, a
31766 successful lookup for any of the items in the sublist overrides a temporary
31767 error for a previous item.
31768
31769 The ability to supply a list of items after the slash is in some sense just a
31770 syntactic convenience. These two examples have the same effect:
31771 .code
31772 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31773 dnslists = black.list.tld/a.domain::b.domain
31774 .endd
31775 However, when the data for the list is obtained from a lookup, the second form
31776 is usually much more convenient. Consider this example:
31777 .code
31778 deny message  = The mail servers for the domain \
31779                 $sender_address_domain \
31780                 are listed at $dnslist_domain ($dnslist_value); \
31781                 see $dnslist_text.
31782      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31783                                    ${lookup dnsdb {>|mxh=\
31784                                    $sender_address_domain} }} }
31785 .endd
31786 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31787 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31788 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31789 of expanding the condition might be something like this:
31790 .code
31791 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31792 .endd
31793 Thus, this example checks whether or not the IP addresses of the sender
31794 domain's mail servers are on the Spamhaus black list.
31795
31796 The key that was used for a successful DNS list lookup is put into the variable
31797 &$dnslist_matched$& (see section &<<SECID204>>&).
31798
31799
31800
31801
31802 .section "Data returned by DNS lists" "SECID203"
31803 .cindex "DNS list" "data returned from"
31804 DNS lists are constructed using address records in the DNS. The original RBL
31805 just used the address 127.0.0.1 on the right hand side of each record, but the
31806 RBL+ list and some other lists use a number of values with different meanings.
31807 The values used on the RBL+ list are:
31808 .display
31809 127.1.0.1  RBL
31810 127.1.0.2  DUL
31811 127.1.0.3  DUL and RBL
31812 127.1.0.4  RSS
31813 127.1.0.5  RSS and RBL
31814 127.1.0.6  RSS and DUL
31815 127.1.0.7  RSS and DUL and RBL
31816 .endd
31817 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31818 different values. Some DNS lists may return more than one address record;
31819 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31820
31821
31822 .section "Variables set from DNS lists" "SECID204"
31823 .cindex "expansion" "variables, set from DNS list"
31824 .cindex "DNS list" "variables set from"
31825 .vindex "&$dnslist_domain$&"
31826 .vindex "&$dnslist_matched$&"
31827 .vindex "&$dnslist_text$&"
31828 .vindex "&$dnslist_value$&"
31829 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31830 the name of the overall domain that matched (for example,
31831 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31832 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31833 the DNS record. When the key is an IP address, it is not reversed in
31834 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31835 cases, for example:
31836 .code
31837 deny dnslists = spamhaus.example
31838 .endd
31839 the key is also available in another variable (in this case,
31840 &$sender_host_address$&). In more complicated cases, however, this is not true.
31841 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31842 might generate a dnslists lookup like this:
31843 .code
31844 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31845 .endd
31846 If this condition succeeds, the value in &$dnslist_matched$& might be
31847 &`192.168.6.7`& (for example).
31848
31849 If more than one address record is returned by the DNS lookup, all the IP
31850 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31851 The variable &$dnslist_text$& contains the contents of any associated TXT
31852 record. For lists such as RBL+ the TXT record for a merged entry is often not
31853 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31854 information.
31855
31856 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31857 &-- although these appear before the condition in the ACL, they are not
31858 expanded until after it has failed. For example:
31859 .code
31860 deny    hosts = !+local_networks
31861         message = $sender_host_address is listed \
31862                   at $dnslist_domain
31863         dnslists = rbl-plus.mail-abuse.example
31864 .endd
31865
31866
31867
31868 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31869 .cindex "DNS list" "matching specific returned data"
31870 You can add an equals sign and an IP address after a &%dnslists%& domain name
31871 in order to restrict its action to DNS records with a matching right hand side.
31872 For example,
31873 .code
31874 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31875 .endd
31876 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31877 any address record is considered to be a match. For the moment, we assume
31878 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31879 describes how multiple records are handled.
31880
31881 More than one IP address may be given for checking, using a comma as a
31882 separator. These are alternatives &-- if any one of them matches, the
31883 &%dnslists%& condition is true. For example:
31884 .code
31885 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31886 .endd
31887 If you want to specify a constraining address list and also specify names or IP
31888 addresses to be looked up, the constraining address list must be specified
31889 first. For example:
31890 .code
31891 deny dnslists = dsn.rfc-ignorant.org\
31892                 =127.0.0.2/$sender_address_domain
31893 .endd
31894
31895 If the character &`&&`& is used instead of &`=`&, the comparison for each
31896 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31897 In other words, the listed addresses are used as bit masks. The comparison is
31898 true if all the bits in the mask are present in the address that is being
31899 tested. For example:
31900 .code
31901 dnslists = a.b.c&0.0.0.3
31902 .endd
31903 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31904 want to test whether one bit or another bit is present (as opposed to both
31905 being present), you must use multiple values. For example:
31906 .code
31907 dnslists = a.b.c&0.0.0.1,0.0.0.2
31908 .endd
31909 matches if the final component of the address is an odd number or two times
31910 an odd number.
31911
31912
31913
31914 .section "Negated DNS matching conditions" "SECID205"
31915 You can supply a negative list of IP addresses as part of a &%dnslists%&
31916 condition. Whereas
31917 .code
31918 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31919 .endd
31920 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31921 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31922 .code
31923 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31924 .endd
31925 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31926 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31927 words, the result of the test is inverted if an exclamation mark appears before
31928 the &`=`& (or the &`&&`&) sign.
31929
31930 &*Note*&: This kind of negation is not the same as negation in a domain,
31931 host, or address list (which is why the syntax is different).
31932
31933 If you are using just one list, the negation syntax does not gain you much. The
31934 previous example is precisely equivalent to
31935 .code
31936 deny  dnslists = a.b.c
31937      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31938 .endd
31939 However, if you are using multiple lists, the negation syntax is clearer.
31940 Consider this example:
31941 .code
31942 deny  dnslists = sbl.spamhaus.org : \
31943                  list.dsbl.org : \
31944                  dnsbl.njabl.org!=127.0.0.3 : \
31945                  relays.ordb.org
31946 .endd
31947 Using only positive lists, this would have to be:
31948 .code
31949 deny  dnslists = sbl.spamhaus.org : \
31950                  list.dsbl.org
31951 deny  dnslists = dnsbl.njabl.org
31952      !dnslists = dnsbl.njabl.org=127.0.0.3
31953 deny  dnslists = relays.ordb.org
31954 .endd
31955 which is less clear, and harder to maintain.
31956
31957
31958
31959
31960 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31961 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31962 thereby providing more than one IP address. When an item in a &%dnslists%& list
31963 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31964 the match to specific results from the DNS lookup, there are two ways in which
31965 the checking can be handled. For example, consider the condition:
31966 .code
31967 dnslists = a.b.c=127.0.0.1
31968 .endd
31969 What happens if the DNS lookup for the incoming IP address yields both
31970 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31971 condition true because at least one given value was found, or is it false
31972 because at least one of the found values was not listed? And how does this
31973 affect negated conditions? Both possibilities are provided for with the help of
31974 additional separators &`==`& and &`=&&`&.
31975
31976 .ilist
31977 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31978 IP addresses matches one of the listed addresses. For the example above, the
31979 condition is true because 127.0.0.1 matches.
31980 .next
31981 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31982 looked up IP addresses matches one of the listed addresses. If the condition is
31983 changed to:
31984 .code
31985 dnslists = a.b.c==127.0.0.1
31986 .endd
31987 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31988 false because 127.0.0.2 is not listed. You would need to have:
31989 .code
31990 dnslists = a.b.c==127.0.0.1,127.0.0.2
31991 .endd
31992 for the condition to be true.
31993 .endlist
31994
31995 When &`!`& is used to negate IP address matching, it inverts the result, giving
31996 the precise opposite of the behaviour above. Thus:
31997 .ilist
31998 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31999 addresses matches one of the listed addresses. Consider:
32000 .code
32001 dnslists = a.b.c!&0.0.0.1
32002 .endd
32003 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32004 false because 127.0.0.1 matches.
32005 .next
32006 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32007 looked up IP address that does not match. Consider:
32008 .code
32009 dnslists = a.b.c!=&0.0.0.1
32010 .endd
32011 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32012 true, because 127.0.0.2 does not match. You would need to have:
32013 .code
32014 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32015 .endd
32016 for the condition to be false.
32017 .endlist
32018 When the DNS lookup yields only a single IP address, there is no difference
32019 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32020
32021
32022
32023
32024 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32025 .cindex "DNS list" "information from merged"
32026 When the facility for restricting the matching IP values in a DNS list is used,
32027 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32028 the true reason for rejection. This happens when lists are merged and the IP
32029 address in the A record is used to distinguish them; unfortunately there is
32030 only one TXT record. One way round this is not to use merged lists, but that
32031 can be inefficient because it requires multiple DNS lookups where one would do
32032 in the vast majority of cases when the host of interest is not on any of the
32033 lists.
32034
32035 A less inefficient way of solving this problem is available. If
32036 two domain names, comma-separated, are given, the second is used first to
32037 do an initial check, making use of any IP value restrictions that are set.
32038 If there is a match, the first domain is used, without any IP value
32039 restrictions, to get the TXT record. As a byproduct of this, there is also
32040 a check that the IP being tested is indeed on the first list. The first
32041 domain is the one that is put in &$dnslist_domain$&. For example:
32042 .code
32043 deny message  = \
32044          rejected because $sender_host_address is blacklisted \
32045          at $dnslist_domain\n$dnslist_text
32046        dnslists = \
32047          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32048          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32049 .endd
32050 For the first blacklist item, this starts by doing a lookup in
32051 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32052 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32053 value, and as long as something is found, it looks for the corresponding TXT
32054 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32055 The second blacklist item is processed similarly.
32056
32057 If you are interested in more than one merged list, the same list must be
32058 given several times, but because the results of the DNS lookups are cached,
32059 the DNS calls themselves are not repeated. For example:
32060 .code
32061 deny dnslists = \
32062          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32063          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32064          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32065          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32066 .endd
32067 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32068 values matches (or if no record is found), this is the only lookup that is
32069 done. Only if there is a match is one of the more specific lists consulted.
32070
32071
32072
32073 .section "DNS lists and IPv6" "SECTmorednslistslast"
32074 .cindex "IPv6" "DNS black lists"
32075 .cindex "DNS list" "IPv6 usage"
32076 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32077 nibble by nibble. For example, if the calling host's IP address is
32078 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32079 .code
32080 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32081   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32082 .endd
32083 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32084 lists contain wildcard records, intended for IPv4, that interact badly with
32085 IPv6. For example, the DNS entry
32086 .code
32087 *.3.some.list.example.    A    127.0.0.1
32088 .endd
32089 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32090 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32091
32092 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32093 &%condition%& condition, as in this example:
32094 .code
32095 deny   condition = ${if isip4{$sender_host_address}}
32096        dnslists  = some.list.example
32097 .endd
32098
32099 If an explicit key is being used for a DNS lookup and it may be an IPv6
32100 address you should specify alternate list separators for both the outer
32101 (DNS list name) list and inner (lookup keys) list:
32102 .code
32103        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32104 .endd
32105
32106 .section "Rate limiting incoming messages" "SECTratelimiting"
32107 .cindex "rate limiting" "client sending"
32108 .cindex "limiting client sending rates"
32109 .oindex "&%smtp_ratelimit_*%&"
32110 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32111 which clients can send email. This is more powerful than the
32112 &%smtp_ratelimit_*%& options, because those options control the rate of
32113 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32114 works across all connections (concurrent and sequential) from the same client
32115 host. The syntax of the &%ratelimit%& condition is:
32116 .display
32117 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32118 .endd
32119 If the average client sending rate is less than &'m'& messages per time
32120 period &'p'& then the condition is false; otherwise it is true.
32121
32122 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32123 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32124 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32125 of &'p'&.
32126
32127 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32128 time interval, for example, &`8h`& for eight hours. A larger time constant
32129 means that it takes Exim longer to forget a client's past behaviour. The
32130 parameter &'m'& is the maximum number of messages that a client is permitted to
32131 send in each time interval. It also specifies the number of messages permitted
32132 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32133 constant, you can allow a client to send more messages in a burst without
32134 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32135 both small, messages must be sent at an even rate.
32136
32137 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32138 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32139 when deploying the &%ratelimit%& ACL condition. The script prints usage
32140 instructions when it is run with no arguments.
32141
32142 The key is used to look up the data for calculating the client's average
32143 sending rate. This data is stored in Exim's spool directory, alongside the
32144 retry and other hints databases. The default key is &$sender_host_address$&,
32145 which means Exim computes the sending rate of each client host IP address.
32146 By changing the key you can change how Exim identifies clients for the purpose
32147 of ratelimiting. For example, to limit the sending rate of each authenticated
32148 user, independent of the computer they are sending from, set the key to
32149 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32150 example, &$authenticated_id$& is only meaningful if the client has
32151 authenticated (which you can check with the &%authenticated%& ACL condition).
32152
32153 The lookup key does not have to identify clients: If you want to limit the
32154 rate at which a recipient receives messages, you can use the key
32155 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32156 ACL.
32157
32158 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32159 specifies what Exim measures the rate of, for example, messages or recipients
32160 or bytes. You can adjust the measurement using the &%unique=%& and/or
32161 &%count=%& options. You can also control when Exim updates the recorded rate
32162 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32163 separated by a slash, like the other parameters. They may appear in any order.
32164
32165 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32166 any options that alter the meaning of the stored data. The limit &'m'& is not
32167 stored, so you can alter the configured maximum rate and Exim will still
32168 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32169 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32170 behaviour. The lookup key is not affected by changes to the update mode and
32171 the &%count=%& option.
32172
32173
32174 .section "Ratelimit options for what is being measured" "ratoptmea"
32175 .cindex "rate limiting" "per_* options"
32176 The &%per_conn%& option limits the client's connection rate. It is not
32177 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32178 &%acl_not_smtp_start%& ACLs.
32179
32180 The &%per_mail%& option limits the client's rate of sending messages. This is
32181 the default if none of the &%per_*%& options is specified. It can be used in
32182 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32183 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32184
32185 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32186 the same ACLs as the &%per_mail%& option, though it is best to use this option
32187 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32188 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32189 in its MAIL command, which may be inaccurate or completely missing. You can
32190 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32191 in kilobytes, megabytes, or gigabytes, respectively.
32192
32193 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32194 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32195 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32196 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32197 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32198 in either case the rate limiting engine will see a message with many
32199 recipients as a large high-speed burst.
32200
32201 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32202 number of different recipients that the client has sent messages to in the
32203 last time period. That is, if the client repeatedly sends messages to the same
32204 recipient, its measured rate is not increased. This option can only be used in
32205 &%acl_smtp_rcpt%&.
32206
32207 The &%per_cmd%& option causes Exim to recompute the rate every time the
32208 condition is processed. This can be used to limit the rate of any SMTP
32209 command. If it is used in multiple ACLs it can limit the aggregate rate of
32210 multiple different commands.
32211
32212 The &%count=%& option can be used to alter how much Exim adds to the client's
32213 measured rate. For example, the &%per_byte%& option is equivalent to
32214 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32215 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32216 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32217
32218 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32219
32220
32221 .section "Ratelimit update modes" "ratoptupd"
32222 .cindex "rate limiting" "reading data without updating"
32223 You can specify one of three options with the &%ratelimit%& condition to
32224 control when its database is updated. This section describes the &%readonly%&
32225 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32226
32227 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32228 previously-computed rate to check against the limit.
32229
32230 For example, you can test the client's sending rate and deny it access (when
32231 it is too fast) in the connect ACL. If the client passes this check then it
32232 can go on to send a message, in which case its recorded rate will be updated
32233 in the MAIL ACL. Subsequent connections from the same client will check this
32234 new rate.
32235 .code
32236 acl_check_connect:
32237  deny ratelimit = 100 / 5m / readonly
32238     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32239                   (max $sender_rate_limit)
32240 # ...
32241 acl_check_mail:
32242  warn ratelimit = 100 / 5m / strict
32243     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32244                   (max $sender_rate_limit)
32245 .endd
32246
32247 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32248 processing a message then it may increase the client's measured rate more than
32249 it should. For example, this will happen if you check the &%per_rcpt%& option
32250 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32251 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32252 multiple update problems by using the &%readonly%& option on later ratelimit
32253 checks.
32254
32255 The &%per_*%& options described above do not make sense in some ACLs. If you
32256 use a &%per_*%& option in an ACL where it is not normally permitted then the
32257 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32258 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32259 next section) so you must specify the &%readonly%& option explicitly.
32260
32261
32262 .section "Ratelimit options for handling fast clients" "ratoptfast"
32263 .cindex "rate limiting" "strict and leaky modes"
32264 If a client's average rate is greater than the maximum, the rate limiting
32265 engine can react in two possible ways, depending on the presence of the
32266 &%strict%& or &%leaky%& update modes. This is independent of the other
32267 counter-measures (such as rejecting the message) that may be specified by the
32268 rest of the ACL.
32269
32270 The &%leaky%& (default) option means that the client's recorded rate is not
32271 updated if it is above the limit. The effect of this is that Exim measures the
32272 client's average rate of successfully sent email,
32273 up to the given limit.
32274 This is appropriate if the countermeasure when the condition is true
32275 consists of refusing the message, and
32276 is generally the better choice if you have clients that retry automatically.
32277 If the action when true is anything more complex then this option is
32278 likely not what is wanted.
32279
32280 The &%strict%& option means that the client's recorded rate is always
32281 updated. The effect of this is that Exim measures the client's average rate
32282 of attempts to send email, which can be much higher than the maximum it is
32283 actually allowed. If the client is over the limit it may be subjected to
32284 counter-measures by the ACL. It must slow down and allow sufficient time to
32285 pass that its computed rate falls below the maximum before it can send email
32286 again. The time (the number of smoothing periods) it must wait and not
32287 attempt to send mail can be calculated with this formula:
32288 .code
32289         ln(peakrate/maxrate)
32290 .endd
32291
32292
32293 .section "Limiting the rate of different events" "ratoptuniq"
32294 .cindex "rate limiting" "counting unique events"
32295 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32296 rate of different events. For example, the &%per_addr%& option uses this
32297 mechanism to count the number of different recipients that the client has
32298 sent messages to in the last time period; it is equivalent to
32299 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32300 measure the rate that a client uses different sender addresses with the
32301 options &`per_mail/unique=$sender_address`&.
32302
32303 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32304 has seen for that key. The whole set is thrown away when it is older than the
32305 rate smoothing period &'p'&, so each different event is counted at most once
32306 per period. In the &%leaky%& update mode, an event that causes the client to
32307 go over the limit is not added to the set, in the same way that the client's
32308 recorded rate is not updated in the same situation.
32309
32310 When you combine the &%unique=%& and &%readonly%& options, the specific
32311 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32312 rate.
32313
32314 The &%unique=%& mechanism needs more space in the ratelimit database than the
32315 other &%ratelimit%& options in order to store the event set. The number of
32316 unique values is potentially as large as the rate limit, so the extra space
32317 required increases with larger limits.
32318
32319 The uniqueification is not perfect: there is a small probability that Exim
32320 will think a new event has happened before. If the sender's rate is less than
32321 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32322 the measured rate can go above the limit, in which case Exim may under-count
32323 events by a significant margin. Fortunately, if the rate is high enough (2.7
32324 times the limit) that the false positive rate goes above 9%, then Exim will
32325 throw away the over-full event set before the measured rate falls below the
32326 limit. Therefore the only harm should be that exceptionally high sending rates
32327 are logged incorrectly; any countermeasures you configure will be as effective
32328 as intended.
32329
32330
32331 .section "Using rate limiting" "useratlim"
32332 Exim's other ACL facilities are used to define what counter-measures are taken
32333 when the rate limit is exceeded. This might be anything from logging a warning
32334 (for example, while measuring existing sending rates in order to define
32335 policy), through time delays to slow down fast senders, up to rejecting the
32336 message. For example:
32337 .code
32338 # Log all senders' rates
32339 warn ratelimit = 0 / 1h / strict
32340      log_message = Sender rate $sender_rate / $sender_rate_period
32341
32342 # Slow down fast senders; note the need to truncate $sender_rate
32343 # at the decimal point.
32344 warn ratelimit = 100 / 1h / per_rcpt / strict
32345      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32346                    $sender_rate_limit }s
32347
32348 # Keep authenticated users under control
32349 deny authenticated = *
32350      ratelimit = 100 / 1d / strict / $authenticated_id
32351
32352 # System-wide rate limit
32353 defer message = Sorry, too busy. Try again later.
32354      ratelimit = 10 / 1s / $primary_hostname
32355
32356 # Restrict incoming rate from each host, with a default
32357 # set using a macro and special cases looked up in a table.
32358 defer message = Sender rate exceeds $sender_rate_limit \
32359                messages per $sender_rate_period
32360      ratelimit = ${lookup {$sender_host_address} \
32361                    cdb {DB/ratelimits.cdb} \
32362                    {$value} {RATELIMIT} }
32363 .endd
32364 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32365 especially with the &%per_rcpt%& option, you may suffer from a performance
32366 bottleneck caused by locking on the ratelimit hints database. Apart from
32367 making your ACLs less complicated, you can reduce the problem by using a
32368 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32369 this means that Exim will lose its hints data after a reboot (including retry
32370 hints, the callout cache, and ratelimit data).
32371
32372
32373
32374 .section "Address verification" "SECTaddressverification"
32375 .cindex "verifying address" "options for"
32376 .cindex "policy control" "address verification"
32377 Several of the &%verify%& conditions described in section
32378 &<<SECTaclconditions>>& cause addresses to be verified. Section
32379 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32380 The verification conditions can be followed by options that modify the
32381 verification process. The options are separated from the keyword and from each
32382 other by slashes, and some of them contain parameters. For example:
32383 .code
32384 verify = sender/callout
32385 verify = recipient/defer_ok/callout=10s,defer_ok
32386 .endd
32387 The first stage of address verification, which always happens, is to run the
32388 address through the routers, in &"verify mode"&. Routers can detect the
32389 difference between verification and routing for delivery, and their actions can
32390 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32391 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32392 The available options are as follows:
32393
32394 .ilist
32395 If the &%callout%& option is specified, successful routing to one or more
32396 remote hosts is followed by a &"callout"& to those hosts as an additional
32397 check. Callouts and their sub-options are discussed in the next section.
32398 .next
32399 If there is a defer error while doing verification routing, the ACL
32400 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32401 options, the condition is forced to be true instead. Note that this is a main
32402 verification option as well as a suboption for callouts.
32403 .next
32404 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32405 discusses the reporting of sender address verification failures.
32406 .next
32407 The &%success_on_redirect%& option causes verification always to succeed
32408 immediately after a successful redirection. By default, if a redirection
32409 generates just one address, that address is also verified. See further
32410 discussion in section &<<SECTredirwhilveri>>&.
32411 .endlist
32412
32413 .cindex "verifying address" "differentiating failures"
32414 .vindex "&$recipient_verify_failure$&"
32415 .vindex "&$sender_verify_failure$&"
32416 .vindex "&$acl_verify_message$&"
32417 After an address verification failure, &$acl_verify_message$& contains the
32418 error message that is associated with the failure. It can be preserved by
32419 coding like this:
32420 .code
32421 warn  !verify = sender
32422        set acl_m0 = $acl_verify_message
32423 .endd
32424 If you are writing your own custom rejection message or log message when
32425 denying access, you can use this variable to include information about the
32426 verification failure.
32427
32428 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32429 appropriate) contains one of the following words:
32430
32431 .ilist
32432 &%qualify%&: The address was unqualified (no domain), and the message
32433 was neither local nor came from an exempted host.
32434 .next
32435 &%route%&: Routing failed.
32436 .next
32437 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32438 occurred at or before the MAIL command (that is, on initial
32439 connection, HELO, or MAIL).
32440 .next
32441 &%recipient%&: The RCPT command in a callout was rejected.
32442 .next
32443 &%postmaster%&: The postmaster check in a callout was rejected.
32444 .endlist
32445
32446 The main use of these variables is expected to be to distinguish between
32447 rejections of MAIL and rejections of RCPT in callouts.
32448
32449 The above variables may also be set after a &*successful*&
32450 address verification to:
32451
32452 .ilist
32453 &%random%&: A random local-part callout succeeded
32454 .endlist
32455
32456
32457
32458
32459 .section "Callout verification" "SECTcallver"
32460 .cindex "verifying address" "by callout"
32461 .cindex "callout" "verification"
32462 .cindex "SMTP" "callout verification"
32463 For non-local addresses, routing verifies the domain, but is unable to do any
32464 checking of the local part. There are situations where some means of verifying
32465 the local part is desirable. One way this can be done is to make an SMTP
32466 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32467 a subsequent host for a recipient address, to see if the host accepts the
32468 address. We use the term &'callout'& to cover both cases. Note that for a
32469 sender address, the callback is not to the client host that is trying to
32470 deliver the message, but to one of the hosts that accepts incoming mail for the
32471 sender's domain.
32472
32473 Exim does not do callouts by default. If you want them to happen, you must
32474 request them by setting appropriate options on the &%verify%& condition, as
32475 described below. This facility should be used with care, because it can add a
32476 lot of resource usage to the cost of verifying an address. However, Exim does
32477 cache the results of callouts, which helps to reduce the cost. Details of
32478 caching are in section &<<SECTcallvercache>>&.
32479
32480 Recipient callouts are usually used only between hosts that are controlled by
32481 the same administration. For example, a corporate gateway host could use
32482 callouts to check for valid recipients on an internal mailserver. A successful
32483 callout does not guarantee that a real delivery to the address would succeed;
32484 on the other hand, a failing callout does guarantee that a delivery would fail.
32485
32486 If the &%callout%& option is present on a condition that verifies an address, a
32487 second stage of verification occurs if the address is successfully routed to
32488 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32489 &(manualroute)& router, where the router specifies the hosts. However, if a
32490 router that does not set up hosts routes to an &(smtp)& transport with a
32491 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32492 &%hosts_override%& set, its hosts are always used, whether or not the router
32493 supplies a host list.
32494 Callouts are only supported on &(smtp)& transports.
32495
32496 The port that is used is taken from the transport, if it is specified and is a
32497 remote transport. (For routers that do verification only, no transport need be
32498 specified.) Otherwise, the default SMTP port is used. If a remote transport
32499 specifies an outgoing interface, this is used; otherwise the interface is not
32500 specified. Likewise, the text that is used for the HELO command is taken from
32501 the transport's &%helo_data%& option; if there is no transport, the value of
32502 &$smtp_active_hostname$& is used.
32503
32504 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32505 test whether a bounce message could be delivered to the sender address. The
32506 following SMTP commands are sent:
32507 .display
32508 &`HELO `&<&'local host name'&>
32509 &`MAIL FROM:<>`&
32510 &`RCPT TO:`&<&'the address to be tested'&>
32511 &`QUIT`&
32512 .endd
32513 LHLO is used instead of HELO if the transport's &%protocol%& option is
32514 set to &"lmtp"&.
32515
32516 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32517 settings.
32518
32519 A recipient callout check is similar. By default, it also uses an empty address
32520 for the sender. This default is chosen because most hosts do not make use of
32521 the sender address when verifying a recipient. Using the same address means
32522 that a single cache entry can be used for each recipient. Some sites, however,
32523 do make use of the sender address when verifying. These are catered for by the
32524 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32525
32526 If the response to the RCPT command is a 2&'xx'& code, the verification
32527 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32528 Exim tries the next host, if any. If there is a problem with all the remote
32529 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32530 &%callout%& option is given, in which case the condition is forced to succeed.
32531
32532 .cindex "SMTP" "output flushing, disabling for callout"
32533 A callout may take a little time. For this reason, Exim normally flushes SMTP
32534 output before performing a callout in an ACL, to avoid unexpected timeouts in
32535 clients when the SMTP PIPELINING extension is in use. The flushing can be
32536 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32537
32538
32539
32540
32541 .section "Additional parameters for callouts" "CALLaddparcall"
32542 .cindex "callout" "additional parameters for"
32543 The &%callout%& option can be followed by an equals sign and a number of
32544 optional parameters, separated by commas. For example:
32545 .code
32546 verify = recipient/callout=10s,defer_ok
32547 .endd
32548 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32549 separate verify options, is retained for backwards compatibility, but is now
32550 deprecated. The additional parameters for &%callout%& are as follows:
32551
32552
32553 .vlist
32554 .vitem <&'a&~time&~interval'&>
32555 .cindex "callout" "timeout, specifying"
32556 This specifies the timeout that applies for the callout attempt to each host.
32557 For example:
32558 .code
32559 verify = sender/callout=5s
32560 .endd
32561 The default is 30 seconds. The timeout is used for each response from the
32562 remote host. It is also used for the initial connection, unless overridden by
32563 the &%connect%& parameter.
32564
32565
32566 .vitem &*connect&~=&~*&<&'time&~interval'&>
32567 .cindex "callout" "connection timeout, specifying"
32568 This parameter makes it possible to set a different (usually smaller) timeout
32569 for making the SMTP connection. For example:
32570 .code
32571 verify = sender/callout=5s,connect=1s
32572 .endd
32573 If not specified, this timeout defaults to the general timeout value.
32574
32575 .vitem &*defer_ok*&
32576 .cindex "callout" "defer, action on"
32577 When this parameter is present, failure to contact any host, or any other kind
32578 of temporary error, is treated as success by the ACL. However, the cache is not
32579 updated in this circumstance.
32580
32581 .vitem &*fullpostmaster*&
32582 .cindex "callout" "full postmaster check"
32583 This operates like the &%postmaster%& option (see below), but if the check for
32584 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32585 accordance with the specification in RFC 2821. The RFC states that the
32586 unqualified address &'postmaster'& should be accepted.
32587
32588
32589 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32590 .cindex "callout" "sender when verifying header"
32591 When verifying addresses in header lines using the &%header_sender%&
32592 verification option, Exim behaves by default as if the addresses are envelope
32593 sender addresses from a message. Callout verification therefore tests to see
32594 whether a bounce message could be delivered, by using an empty address in the
32595 MAIL command. However, it is arguable that these addresses might never be used
32596 as envelope senders, and could therefore justifiably reject bounce messages
32597 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32598 address to use in the MAIL command. For example:
32599 .code
32600 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32601 .endd
32602 This parameter is available only for the &%header_sender%& verification option.
32603
32604
32605 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32606 .cindex "callout" "overall timeout, specifying"
32607 This parameter sets an overall timeout for performing a callout verification.
32608 For example:
32609 .code
32610 verify = sender/callout=5s,maxwait=30s
32611 .endd
32612 This timeout defaults to four times the callout timeout for individual SMTP
32613 commands. The overall timeout applies when there is more than one host that can
32614 be tried. The timeout is checked before trying the next host. This prevents
32615 very long delays if there are a large number of hosts and all are timing out
32616 (for example, when network connections are timing out).
32617
32618
32619 .vitem &*no_cache*&
32620 .cindex "callout" "cache, suppressing"
32621 .cindex "caching callout, suppressing"
32622 When this parameter is given, the callout cache is neither read nor updated.
32623
32624 .vitem &*postmaster*&
32625 .cindex "callout" "postmaster; checking"
32626 When this parameter is set, a successful callout check is followed by a similar
32627 check for the local part &'postmaster'& at the same domain. If this address is
32628 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32629 the postmaster check is recorded in a cache record; if it is a failure, this is
32630 used to fail subsequent callouts for the domain without a connection being
32631 made, until the cache record expires.
32632
32633 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32634 The postmaster check uses an empty sender in the MAIL command by default.
32635 You can use this parameter to do a postmaster check using a different address.
32636 For example:
32637 .code
32638 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32639 .endd
32640 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32641 one overrides. The &%postmaster%& parameter is equivalent to this example:
32642 .code
32643 require  verify = sender/callout=postmaster_mailfrom=
32644 .endd
32645 &*Warning*&: The caching arrangements for postmaster checking do not take
32646 account of the sender address. It is assumed that either the empty address or
32647 a fixed non-empty address will be used. All that Exim remembers is that the
32648 postmaster check for the domain succeeded or failed.
32649
32650
32651 .vitem &*random*&
32652 .cindex "callout" "&""random""& check"
32653 When this parameter is set, before doing the normal callout check, Exim does a
32654 check for a &"random"& local part at the same domain. The local part is not
32655 really random &-- it is defined by the expansion of the option
32656 &%callout_random_local_part%&, which defaults to
32657 .code
32658 $primary_hostname-$tod_epoch-testing
32659 .endd
32660 The idea here is to try to determine whether the remote host accepts all local
32661 parts without checking. If it does, there is no point in doing callouts for
32662 specific local parts. If the &"random"& check succeeds, the result is saved in
32663 a cache record, and used to force the current and subsequent callout checks to
32664 succeed without a connection being made, until the cache record expires.
32665
32666 .vitem &*use_postmaster*&
32667 .cindex "callout" "sender for recipient check"
32668 This parameter applies to recipient callouts only. For example:
32669 .code
32670 deny  !verify = recipient/callout=use_postmaster
32671 .endd
32672 .vindex "&$qualify_domain$&"
32673 It causes a non-empty postmaster address to be used in the MAIL command when
32674 performing the callout for the recipient, and also for a &"random"& check if
32675 that is configured. The local part of the address is &`postmaster`& and the
32676 domain is the contents of &$qualify_domain$&.
32677
32678 .vitem &*use_sender*&
32679 This option applies to recipient callouts only. For example:
32680 .code
32681 require  verify = recipient/callout=use_sender
32682 .endd
32683 It causes the message's actual sender address to be used in the MAIL
32684 command when performing the callout, instead of an empty address. There is no
32685 need to use this option unless you know that the called hosts make use of the
32686 sender when checking recipients. If used indiscriminately, it reduces the
32687 usefulness of callout caching.
32688
32689 .vitem &*hold*&
32690 This option applies to recipient callouts only. For example:
32691 .code
32692 require  verify = recipient/callout=use_sender,hold
32693 .endd
32694 It causes the connection to be held open and used for any further recipients
32695 and for eventual delivery (should that be done quickly).
32696 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32697 when that is used for the connections.
32698 The advantage is only gained if there are no callout cache hits
32699 (which could be enforced by the no_cache option),
32700 if the use_sender option is used,
32701 if neither the random nor the use_postmaster option is used,
32702 and if no other callouts intervene.
32703 .endlist
32704
32705 If you use any of the parameters that set a non-empty sender for the MAIL
32706 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32707 &%use_sender%&), you should think about possible loops. Recipient checking is
32708 usually done between two hosts that are under the same management, and the host
32709 that receives the callouts is not normally configured to do callouts itself.
32710 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32711 these circumstances.
32712
32713 However, if you use a non-empty sender address for a callout to an arbitrary
32714 host, there is the likelihood that the remote host will itself initiate a
32715 callout check back to your host. As it is checking what appears to be a message
32716 sender, it is likely to use an empty address in MAIL, thus avoiding a
32717 callout loop. However, to be on the safe side it would be best to set up your
32718 own ACLs so that they do not do sender verification checks when the recipient
32719 is the address you use for header sender or postmaster callout checking.
32720
32721 Another issue to think about when using non-empty senders for callouts is
32722 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32723 by the sender/recipient combination; thus, for any given recipient, many more
32724 actual callouts are performed than when an empty sender or postmaster is used.
32725
32726
32727
32728
32729 .section "Callout caching" "SECTcallvercache"
32730 .cindex "hints database" "callout cache"
32731 .cindex "callout" "cache, description of"
32732 .cindex "caching" "callout"
32733 Exim caches the results of callouts in order to reduce the amount of resources
32734 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32735 option. A hints database called &"callout"& is used for the cache. Two
32736 different record types are used: one records the result of a callout check for
32737 a specific address, and the other records information that applies to the
32738 entire domain (for example, that it accepts the local part &'postmaster'&).
32739
32740 When an original callout fails, a detailed SMTP error message is given about
32741 the failure. However, for subsequent failures use the cache data, this message
32742 is not available.
32743
32744 The expiry times for negative and positive address cache records are
32745 independent, and can be set by the global options &%callout_negative_expire%&
32746 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32747
32748 If a host gives a negative response to an SMTP connection, or rejects any
32749 commands up to and including
32750 .code
32751 MAIL FROM:<>
32752 .endd
32753 (but not including the MAIL command with a non-empty address),
32754 any callout attempt is bound to fail. Exim remembers such failures in a
32755 domain cache record, which it uses to fail callouts for the domain without
32756 making new connections, until the domain record times out. There are two
32757 separate expiry times for domain cache records:
32758 &%callout_domain_negative_expire%& (default 3h) and
32759 &%callout_domain_positive_expire%& (default 7d).
32760
32761 Domain records expire when the negative expiry time is reached if callouts
32762 cannot be made for the domain, or if the postmaster check failed.
32763 Otherwise, they expire when the positive expiry time is reached. This
32764 ensures that, for example, a host that stops accepting &"random"& local parts
32765 will eventually be noticed.
32766
32767 The callout caching mechanism is based on the domain of the address that is
32768 being tested. If the domain routes to several hosts, it is assumed that their
32769 behaviour will be the same.
32770
32771
32772
32773 .section "Sender address verification reporting" "SECTsenaddver"
32774 .cindex "verifying" "suppressing error details"
32775 See section &<<SECTaddressverification>>& for a general discussion of
32776 verification. When sender verification fails in an ACL, the details of the
32777 failure are given as additional output lines before the 550 response to the
32778 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32779 you might see:
32780 .code
32781 MAIL FROM:<xyz@abc.example>
32782 250 OK
32783 RCPT TO:<pqr@def.example>
32784 550-Verification failed for <xyz@abc.example>
32785 550-Called:   192.168.34.43
32786 550-Sent:     RCPT TO:<xyz@abc.example>
32787 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32788 550 Sender verification failed
32789 .endd
32790 If more than one RCPT command fails in the same way, the details are given
32791 only for the first of them. However, some administrators do not want to send
32792 out this much information. You can suppress the details by adding
32793 &`/no_details`& to the ACL statement that requests sender verification. For
32794 example:
32795 .code
32796 verify = sender/no_details
32797 .endd
32798
32799 .section "Redirection while verifying" "SECTredirwhilveri"
32800 .cindex "verifying" "redirection while"
32801 .cindex "address redirection" "while verifying"
32802 A dilemma arises when a local address is redirected by aliasing or forwarding
32803 during verification: should the generated addresses themselves be verified,
32804 or should the successful expansion of the original address be enough to verify
32805 it? By default, Exim takes the following pragmatic approach:
32806
32807 .ilist
32808 When an incoming address is redirected to just one child address, verification
32809 continues with the child address, and if that fails to verify, the original
32810 verification also fails.
32811 .next
32812 When an incoming address is redirected to more than one child address,
32813 verification does not continue. A success result is returned.
32814 .endlist
32815
32816 This seems the most reasonable behaviour for the common use of aliasing as a
32817 way of redirecting different local parts to the same mailbox. It means, for
32818 example, that a pair of alias entries of the form
32819 .code
32820 A.Wol:   aw123
32821 aw123:   :fail: Gone away, no forwarding address
32822 .endd
32823 work as expected, with both local parts causing verification failure. When a
32824 redirection generates more than one address, the behaviour is more like a
32825 mailing list, where the existence of the alias itself is sufficient for
32826 verification to succeed.
32827
32828 It is possible, however, to change the default behaviour so that all successful
32829 redirections count as successful verifications, however many new addresses are
32830 generated. This is specified by the &%success_on_redirect%& verification
32831 option. For example:
32832 .code
32833 require verify = recipient/success_on_redirect/callout=10s
32834 .endd
32835 In this example, verification succeeds if a router generates a new address, and
32836 the callout does not occur, because no address was routed to a remote host.
32837
32838 When verification is being tested via the &%-bv%& option, the treatment of
32839 redirections is as just described, unless the &%-v%& or any debugging option is
32840 also specified. In that case, full verification is done for every generated
32841 address and a report is output for each of them.
32842
32843
32844
32845 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32846 .cindex "CSA" "verifying"
32847 Client SMTP Authorization is a system that allows a site to advertise
32848 which machines are and are not permitted to send email. This is done by placing
32849 special SRV records in the DNS; these are looked up using the client's HELO
32850 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32851 Authorization checks in Exim are performed by the ACL condition:
32852 .code
32853 verify = csa
32854 .endd
32855 This fails if the client is not authorized. If there is a DNS problem, or if no
32856 valid CSA SRV record is found, or if the client is authorized, the condition
32857 succeeds. These three cases can be distinguished using the expansion variable
32858 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32859 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32860 be likely to cause problems for legitimate email.
32861
32862 The error messages produced by the CSA code include slightly more
32863 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32864 looking up the CSA SRV record, or problems looking up the CSA target
32865 address record. There are four reasons for &$csa_status$& being &"fail"&:
32866
32867 .ilist
32868 The client's host name is explicitly not authorized.
32869 .next
32870 The client's IP address does not match any of the CSA target IP addresses.
32871 .next
32872 The client's host name is authorized but it has no valid target IP addresses
32873 (for example, the target's addresses are IPv6 and the client is using IPv4).
32874 .next
32875 The client's host name has no CSA SRV record but a parent domain has asserted
32876 that all subdomains must be explicitly authorized.
32877 .endlist
32878
32879 The &%csa%& verification condition can take an argument which is the domain to
32880 use for the DNS query. The default is:
32881 .code
32882 verify = csa/$sender_helo_name
32883 .endd
32884 This implementation includes an extension to CSA. If the query domain
32885 is an address literal such as [192.0.2.95], or if it is a bare IP
32886 address, Exim searches for CSA SRV records in the reverse DNS as if
32887 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32888 meaningful to say:
32889 .code
32890 verify = csa/$sender_host_address
32891 .endd
32892 In fact, this is the check that Exim performs if the client does not say HELO.
32893 This extension can be turned off by setting the main configuration option
32894 &%dns_csa_use_reverse%& to be false.
32895
32896 If a CSA SRV record is not found for the domain itself, a search
32897 is performed through its parent domains for a record which might be
32898 making assertions about subdomains. The maximum depth of this search is limited
32899 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32900 default. Exim does not look for CSA SRV records in a top level domain, so the
32901 default settings handle HELO domains as long as seven
32902 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32903 of legitimate HELO domains.
32904
32905 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32906 direct SRV lookups, this is not sufficient because of the extra parent domain
32907 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32908 addresses into lookups in the reverse DNS space. The result of a successful
32909 lookup such as:
32910 .code
32911 ${lookup dnsdb {csa=$sender_helo_name}}
32912 .endd
32913 has two space-separated fields: an authorization code and a target host name.
32914 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32915 authorization required but absent, or &"?"& for unknown.
32916
32917
32918
32919
32920 .section "Bounce address tag validation" "SECTverifyPRVS"
32921 .cindex "BATV, verifying"
32922 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32923 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32924 Genuine incoming bounce messages should therefore always be addressed to
32925 recipients that have a valid tag. This scheme is a way of detecting unwanted
32926 bounce messages caused by sender address forgeries (often called &"collateral
32927 spam"&), because the recipients of such messages do not include valid tags.
32928
32929 There are two expansion items to help with the implementation of the BATV
32930 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32931 the original envelope sender address by using a simple key to add a hash of the
32932 address and some time-based randomizing information. The &%prvs%& expansion
32933 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32934 The syntax of these expansion items is described in section
32935 &<<SECTexpansionitems>>&.
32936 The validity period on signed addresses is seven days.
32937
32938 As an example, suppose the secret per-address keys are stored in an MySQL
32939 database. A query to look up the key for an address could be defined as a macro
32940 like this:
32941 .code
32942 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32943                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32944                 }{$value}}
32945 .endd
32946 Suppose also that the senders who make use of BATV are defined by an address
32947 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32948 use this:
32949 .code
32950 # Bounces: drop unsigned addresses for BATV senders
32951 deny message = This address does not send an unsigned reverse path
32952      senders = :
32953      recipients = +batv_senders
32954
32955 # Bounces: In case of prvs-signed address, check signature.
32956 deny message = Invalid reverse path signature.
32957      senders = :
32958      condition  = ${prvscheck {$local_part@$domain}\
32959                   {PRVSCHECK_SQL}{1}}
32960      !condition = $prvscheck_result
32961 .endd
32962 The first statement rejects recipients for bounce messages that are addressed
32963 to plain BATV sender addresses, because it is known that BATV senders do not
32964 send out messages with plain sender addresses. The second statement rejects
32965 recipients that are prvs-signed, but with invalid signatures (either because
32966 the key is wrong, or the signature has timed out).
32967
32968 A non-prvs-signed address is not rejected by the second statement, because the
32969 &%prvscheck%& expansion yields an empty string if its first argument is not a
32970 prvs-signed address, thus causing the &%condition%& condition to be false. If
32971 the first argument is a syntactically valid prvs-signed address, the yield is
32972 the third string (in this case &"1"&), whether or not the cryptographic and
32973 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32974 of the checks (empty for failure, &"1"& for success).
32975
32976 There is one more issue you must consider when implementing prvs-signing:
32977 you have to ensure that the routers accept prvs-signed addresses and
32978 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32979 router to remove the signature with a configuration along these lines:
32980 .code
32981 batv_redirect:
32982   driver = redirect
32983   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32984 .endd
32985 This works because, if the third argument of &%prvscheck%& is empty, the result
32986 of the expansion of a prvs-signed address is the decoded value of the original
32987 address. This router should probably be the first of your routers that handles
32988 local addresses.
32989
32990 To create BATV-signed addresses in the first place, a transport of this form
32991 can be used:
32992 .code
32993 external_smtp_batv:
32994   driver = smtp
32995   return_path = ${prvs {$return_path} \
32996                        {${lookup mysql{SELECT \
32997                        secret FROM batv_prvs WHERE \
32998                        sender='${quote_mysql:$sender_address}'} \
32999                        {$value}fail}}}
33000 .endd
33001 If no key can be found for the existing return path, no signing takes place.
33002
33003
33004
33005 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33006 .cindex "&ACL;" "relay control"
33007 .cindex "relaying" "control by ACL"
33008 .cindex "policy control" "relay control"
33009 An MTA is said to &'relay'& a message if it receives it from some host and
33010 delivers it directly to another host as a result of a remote address contained
33011 within it. Redirecting a local address via an alias or forward file and then
33012 passing the message on to another host is not relaying,
33013 .cindex "&""percent hack""&"
33014 but a redirection as a result of the &"percent hack"& is.
33015
33016 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33017 A host which is acting as a gateway or an MX backup is concerned with incoming
33018 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33019 a host which is acting as a smart host for a number of clients is concerned
33020 with outgoing relaying from those clients to the Internet at large. Often the
33021 same host is fulfilling both functions,
33022 . ///
33023 . as illustrated in the diagram below,
33024 . ///
33025 but in principle these two kinds of relaying are entirely independent. What is
33026 not wanted is the transmission of mail from arbitrary remote hosts through your
33027 system to arbitrary domains.
33028
33029
33030 You can implement relay control by means of suitable statements in the ACL that
33031 runs for each RCPT command. For convenience, it is often easiest to use
33032 Exim's named list facility to define the domains and hosts involved. For
33033 example, suppose you want to do the following:
33034
33035 .ilist
33036 Deliver a number of domains to mailboxes on the local host (or process them
33037 locally in some other way). Let's say these are &'my.dom1.example'& and
33038 &'my.dom2.example'&.
33039 .next
33040 Relay mail for a number of other domains for which you are the secondary MX.
33041 These might be &'friend1.example'& and &'friend2.example'&.
33042 .next
33043 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33044 Suppose your LAN is 192.168.45.0/24.
33045 .endlist
33046
33047
33048 In the main part of the configuration, you put the following definitions:
33049 .code
33050 domainlist local_domains    = my.dom1.example : my.dom2.example
33051 domainlist relay_to_domains = friend1.example : friend2.example
33052 hostlist   relay_from_hosts = 192.168.45.0/24
33053 .endd
33054 Now you can use these definitions in the ACL that is run for every RCPT
33055 command:
33056 .code
33057 acl_check_rcpt:
33058   accept domains = +local_domains : +relay_to_domains
33059   accept hosts   = +relay_from_hosts
33060 .endd
33061 The first statement accepts any RCPT command that contains an address in
33062 the local or relay domains. For any other domain, control passes to the second
33063 statement, which accepts the command only if it comes from one of the relay
33064 hosts. In practice, you will probably want to make your ACL more sophisticated
33065 than this, for example, by including sender and recipient verification. The
33066 default configuration includes a more comprehensive example, which is described
33067 in chapter &<<CHAPdefconfil>>&.
33068
33069
33070
33071 .section "Checking a relay configuration" "SECTcheralcon"
33072 .cindex "relaying" "checking control of"
33073 You can check the relay characteristics of your configuration in the same way
33074 that you can test any ACL behaviour for an incoming SMTP connection, by using
33075 the &%-bh%& option to run a fake SMTP session with which you interact.
33076 .ecindex IIDacl
33077
33078
33079
33080 . ////////////////////////////////////////////////////////////////////////////
33081 . ////////////////////////////////////////////////////////////////////////////
33082
33083 .chapter "Content scanning at ACL time" "CHAPexiscan"
33084 .scindex IIDcosca "content scanning" "at ACL time"
33085 The extension of Exim to include content scanning at ACL time, formerly known
33086 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33087 was integrated into the main source for Exim release 4.50, and Tom continues to
33088 maintain it. Most of the wording of this chapter is taken from Tom's
33089 specification.
33090
33091 It is also possible to scan the content of messages at other times. The
33092 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33093 scanning after all the ACLs have run. A transport filter can be used to scan
33094 messages at delivery time (see the &%transport_filter%& option, described in
33095 chapter &<<CHAPtransportgeneric>>&).
33096
33097 If you want to include the ACL-time content-scanning features when you compile
33098 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33099 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33100
33101 .ilist
33102 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33103 for all MIME parts for SMTP and non-SMTP messages, respectively.
33104 .next
33105 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33106 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33107 run at the end of message reception (the &%acl_smtp_data%& ACL).
33108 .next
33109 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33110 of messages, or parts of messages, for debugging purposes.
33111 .next
33112 Additional expansion variables that are set in the new ACL and by the new
33113 conditions.
33114 .next
33115 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33116 .endlist
33117
33118 Content-scanning is continually evolving, and new features are still being
33119 added. While such features are still unstable and liable to incompatible
33120 changes, they are made available in Exim by setting options whose names begin
33121 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33122 this manual. You can find out about them by reading the file called
33123 &_doc/experimental.txt_&.
33124
33125 All the content-scanning facilities work on a MBOX copy of the message that is
33126 temporarily created in a file called:
33127 .display
33128 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33129 .endd
33130 The &_.eml_& extension is a friendly hint to virus scanners that they can
33131 expect an MBOX-like structure inside that file. The file is created when the
33132 first content scanning facility is called. Subsequent calls to content
33133 scanning conditions open the same file again. The directory is recursively
33134 removed when the &%acl_smtp_data%& ACL has finished running, unless
33135 .code
33136 control = no_mbox_unspool
33137 .endd
33138 has been encountered. When the MIME ACL decodes files, they are put into the
33139 same directory by default.
33140
33141
33142
33143 .section "Scanning for viruses" "SECTscanvirus"
33144 .cindex "virus scanning"
33145 .cindex "content scanning" "for viruses"
33146 .cindex "content scanning" "the &%malware%& condition"
33147 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33148 It supports a &"generic"& interface to scanners called via the shell, and
33149 specialized interfaces for &"daemon"& type virus scanners, which are resident
33150 in memory and thus are much faster.
33151
33152 Since message data needs to have arrived,
33153 the condition may be only called in ACL defined by
33154 &%acl_smtp_data%&,
33155 &%acl_smtp_data_prdr%&,
33156 &%acl_smtp_mime%& or
33157 &%acl_smtp_dkim%&
33158
33159 A timeout of 2 minutes is applied to a scanner call (by default);
33160 if it expires then a defer action is taken.
33161
33162 .oindex "&%av_scanner%&"
33163 You can set the &%av_scanner%& option in the main part of the configuration
33164 to specify which scanner to use, together with any additional options that
33165 are needed. The basic syntax is as follows:
33166 .display
33167 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33168 .endd
33169 If you do not set &%av_scanner%&, it defaults to
33170 .code
33171 av_scanner = sophie:/var/run/sophie
33172 .endd
33173 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33174 before use.
33175 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33176 The following scanner types are supported in this release,
33177 though individual ones can be included or not at build time:
33178
33179 .vlist
33180 .vitem &%avast%&
33181 .cindex "virus scanners" "avast"
33182 This is the scanner daemon of Avast. It has been tested with Avast Core
33183 Security (currently at version 2.2.0).
33184 You can get a trial version at &url(https://www.avast.com) or for Linux
33185 at &url(https://www.avast.com/linux-server-antivirus).
33186 This scanner type takes one option,
33187 which can be either a full path to a UNIX socket,
33188 or host and port specifiers separated by white space.
33189 The host may be a name or an IP address; the port is either a
33190 single number or a pair of numbers with a dash between.
33191 A list of options may follow. These options are interpreted on the
33192 Exim's side of the malware scanner, or are given on separate lines to
33193 the daemon as options before the main scan command.
33194
33195 .cindex &`pass_unscanned`& "avast"
33196 If &`pass_unscanned`&
33197 is set, any files the Avast scanner can't scan (e.g.
33198 decompression bombs, or invalid archives) are considered clean. Use with
33199 care.
33200
33201 For example:
33202 .code
33203 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33204 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33205 av_scanner = avast:192.168.2.22 5036
33206 .endd
33207 If you omit the argument, the default path
33208 &_/var/run/avast/scan.sock_&
33209 is used.
33210 If you use a remote host,
33211 you need to make Exim's spool directory available to it,
33212 as the scanner is passed a file path, not file contents.
33213 For information about available commands and their options you may use
33214 .code
33215 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33216     FLAGS
33217     SENSITIVITY
33218     PACK
33219 .endd
33220
33221 If the scanner returns a temporary failure (e.g. license issues, or
33222 permission problems), the message is deferred and a paniclog entry is
33223 written.  The usual &`defer_ok`& option is available.
33224
33225 .vitem &%aveserver%&
33226 .cindex "virus scanners" "Kaspersky"
33227 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33228 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33229 which is the path to the daemon's UNIX socket. The default is shown in this
33230 example:
33231 .code
33232 av_scanner = aveserver:/var/run/aveserver
33233 .endd
33234
33235
33236 .vitem &%clamd%&
33237 .cindex "virus scanners" "clamd"
33238 This daemon-type scanner is GPL and free. You can get it at
33239 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33240 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33241 in the MIME ACL. This is no longer believed to be necessary.
33242
33243 The options are a list of server specifiers, which may be
33244 a UNIX socket specification,
33245 a TCP socket specification,
33246 or a (global) option.
33247
33248 A socket specification consists of a space-separated list.
33249 For a Unix socket the first element is a full path for the socket,
33250 for a TCP socket the first element is the IP address
33251 and the second a port number,
33252 Any further elements are per-server (non-global) options.
33253 These per-server options are supported:
33254 .code
33255 retry=<timespec>        Retry on connect fail
33256 .endd
33257
33258 The &`retry`& option specifies a time after which a single retry for
33259 a failed connect is made.  The default is to not retry.
33260
33261 If a Unix socket file is specified, only one server is supported.
33262
33263 Examples:
33264 .code
33265 av_scanner = clamd:/opt/clamd/socket
33266 av_scanner = clamd:192.0.2.3 1234
33267 av_scanner = clamd:192.0.2.3 1234:local
33268 av_scanner = clamd:192.0.2.3 1234 retry=10s
33269 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33270 .endd
33271 If the value of av_scanner points to a UNIX socket file or contains the
33272 &`local`&
33273 option, then the ClamAV interface will pass a filename containing the data
33274 to be scanned, which should normally result in less I/O happening and be
33275 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33276 Exim does not assume that there is a common filesystem with the remote host.
33277
33278 The final example shows that multiple TCP targets can be specified.  Exim will
33279 randomly use one for each incoming email (i.e. it load balances them).  Note
33280 that only TCP targets may be used if specifying a list of scanners; a UNIX
33281 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33282 unavailable, Exim will try the remaining one(s) until it finds one that works.
33283 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33284 not keep track of scanner state between multiple messages, and the scanner
33285 selection is random, so the message will get logged in the mainlog for each
33286 email that the down scanner gets chosen first (message wrapped to be readable):
33287 .code
33288 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33289    clamd: connection to localhost, port 3310 failed
33290    (Connection refused)
33291 .endd
33292
33293 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33294 contributing the code for this scanner.
33295
33296 .vitem &%cmdline%&
33297 .cindex "virus scanners" "command line interface"
33298 This is the keyword for the generic command line scanner interface. It can be
33299 used to attach virus scanners that are invoked from the shell. This scanner
33300 type takes 3 mandatory options:
33301
33302 .olist
33303 The full path and name of the scanner binary, with all command line options,
33304 and a placeholder (&`%s`&) for the directory to scan.
33305
33306 .next
33307 A regular expression to match against the STDOUT and STDERR output of the
33308 virus scanner. If the expression matches, a virus was found. You must make
33309 absolutely sure that this expression matches on &"virus found"&. This is called
33310 the &"trigger"& expression.
33311
33312 .next
33313 Another regular expression, containing exactly one pair of parentheses, to
33314 match the name of the virus found in the scanners output. This is called the
33315 &"name"& expression.
33316 .endlist olist
33317
33318 For example, Sophos Sweep reports a virus on a line like this:
33319 .code
33320 Virus 'W32/Magistr-B' found in file ./those.bat
33321 .endd
33322 For the trigger expression, we can match the phrase &"found in file"&. For the
33323 name expression, we want to extract the W32/Magistr-B string, so we can match
33324 for the single quotes left and right of it. Altogether, this makes the
33325 configuration setting:
33326 .code
33327 av_scanner = cmdline:\
33328              /path/to/sweep -ss -all -rec -archive %s:\
33329              found in file:'(.+)'
33330 .endd
33331 .vitem &%drweb%&
33332 .cindex "virus scanners" "DrWeb"
33333 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33334 takes one option,
33335 either a full path to a UNIX socket,
33336 or host and port specifiers separated by white space.
33337 The host may be a name or an IP address; the port is either a
33338 single number or a pair of numbers with a dash between.
33339 For example:
33340 .code
33341 av_scanner = drweb:/var/run/drwebd.sock
33342 av_scanner = drweb:192.168.2.20 31337
33343 .endd
33344 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33345 is used. Thanks to Alex Miller for contributing the code for this scanner.
33346
33347 .vitem &%f-protd%&
33348 .cindex "virus scanners" "f-protd"
33349 The f-protd scanner is accessed via HTTP over TCP.
33350 One argument is taken, being a space-separated hostname and port number
33351 (or port-range).
33352 For example:
33353 .code
33354 av_scanner = f-protd:localhost 10200-10204
33355 .endd
33356 If you omit the argument, the default values shown above are used.
33357
33358 .vitem &%f-prot6d%&
33359 .cindex "virus scanners" "f-prot6d"
33360 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33361 One argument is taken, being a space-separated hostname and port number.
33362 For example:
33363 .code
33364 av_scanner = f-prot6d:localhost 10200
33365 .endd
33366 If you omit the argument, the default values show above are used.
33367
33368 .vitem &%fsecure%&
33369 .cindex "virus scanners" "F-Secure"
33370 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33371 argument which is the path to a UNIX socket. For example:
33372 .code
33373 av_scanner = fsecure:/path/to/.fsav
33374 .endd
33375 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33376 Thelmen for contributing the code for this scanner.
33377
33378 .vitem &%kavdaemon%&
33379 .cindex "virus scanners" "Kaspersky"
33380 This is the scanner daemon of Kaspersky Version 4. This version of the
33381 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33382 scanner type takes one option, which is the path to the daemon's UNIX socket.
33383 For example:
33384 .code
33385 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33386 .endd
33387 The default path is &_/var/run/AvpCtl_&.
33388
33389 .vitem &%mksd%&
33390 .cindex "virus scanners" "mksd"
33391 This was a daemon type scanner that is aimed mainly at Polish users,
33392 though some documentation was available in English.
33393 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33394 and this appears to be a candidate for removal from Exim, unless
33395 we are informed of other virus scanners which use the same protocol
33396 to integrate.
33397 The only option for this scanner type is
33398 the maximum number of processes used simultaneously to scan the attachments,
33399 provided that mksd has
33400 been run with at least the same number of child processes. For example:
33401 .code
33402 av_scanner = mksd:2
33403 .endd
33404 You can safely omit this option (the default value is 1).
33405
33406 .vitem &%sock%&
33407 .cindex "virus scanners" "simple socket-connected"
33408 This is a general-purpose way of talking to simple scanner daemons
33409 running on the local machine.
33410 There are four options:
33411 an address (which may be an IP address and port, or the path of a Unix socket),
33412 a commandline to send (may include a single %s which will be replaced with
33413 the path to the mail file to be scanned),
33414 an RE to trigger on from the returned data,
33415 and an RE to extract malware_name from the returned data.
33416 For example:
33417 .code
33418 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33419 .endd
33420 Note that surrounding whitespace is stripped from each option, meaning
33421 there is no way to specify a trailing newline.
33422 The socket specifier and both regular-expressions are required.
33423 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33424 specify an empty element to get this.
33425
33426 .vitem &%sophie%&
33427 .cindex "virus scanners" "Sophos and Sophie"
33428 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33429 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33430 for this scanner type is the path to the UNIX socket that Sophie uses for
33431 client communication. For example:
33432 .code
33433 av_scanner = sophie:/tmp/sophie
33434 .endd
33435 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33436 the option.
33437 .endlist
33438
33439 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33440 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33441 ACL.
33442
33443 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33444 makes it possible to use different scanners. See further below for an example.
33445 The &%malware%& condition caches its results, so when you use it multiple times
33446 for the same message, the actual scanning process is only carried out once.
33447 However, using expandable items in &%av_scanner%& disables this caching, in
33448 which case each use of the &%malware%& condition causes a new scan of the
33449 message.
33450
33451 The &%malware%& condition takes a right-hand argument that is expanded before
33452 use and taken as a list, slash-separated by default.
33453 The first element can then be one of
33454
33455 .ilist
33456 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33457 The condition succeeds if a virus was found, and fail otherwise. This is the
33458 recommended usage.
33459 .next
33460 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33461 the condition fails immediately.
33462 .next
33463 A regular expression, in which case the message is scanned for viruses. The
33464 condition succeeds if a virus is found and its name matches the regular
33465 expression. This allows you to take special actions on certain types of virus.
33466 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33467 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33468 .endlist
33469
33470 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33471 messages even if there is a problem with the virus scanner.
33472 Otherwise, such a problem causes the ACL to defer.
33473
33474 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33475 specify a non-default timeout.  The default is two minutes.
33476 For example:
33477 .code
33478 malware = * / defer_ok / tmo=10s
33479 .endd
33480 A timeout causes the ACL to defer.
33481
33482 .vindex "&$callout_address$&"
33483 When a connection is made to the scanner the expansion variable &$callout_address$&
33484 is set to record the actual address used.
33485
33486 .vindex "&$malware_name$&"
33487 When a virus is found, the condition sets up an expansion variable called
33488 &$malware_name$& that contains the name of the virus. You can use it in a
33489 &%message%& modifier that specifies the error returned to the sender, and/or in
33490 logging data.
33491
33492 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33493 imposed by your anti-virus scanner.
33494
33495 Here is a very simple scanning example:
33496 .code
33497 deny message = This message contains malware ($malware_name)
33498      malware = *
33499 .endd
33500 The next example accepts messages when there is a problem with the scanner:
33501 .code
33502 deny message = This message contains malware ($malware_name)
33503      malware = */defer_ok
33504 .endd
33505 The next example shows how to use an ACL variable to scan with both sophie and
33506 aveserver. It assumes you have set:
33507 .code
33508 av_scanner = $acl_m0
33509 .endd
33510 in the main Exim configuration.
33511 .code
33512 deny message = This message contains malware ($malware_name)
33513      set acl_m0 = sophie
33514      malware = *
33515
33516 deny message = This message contains malware ($malware_name)
33517      set acl_m0 = aveserver
33518      malware = *
33519 .endd
33520
33521
33522 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33523 .cindex "content scanning" "for spam"
33524 .cindex "spam scanning"
33525 .cindex "SpamAssassin"
33526 .cindex "Rspamd"
33527 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33528 score and a report for the message.
33529 Support is also provided for Rspamd.
33530
33531 For more information about installation and configuration of SpamAssassin or
33532 Rspamd refer to their respective websites at
33533 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33534
33535 SpamAssassin can be installed with CPAN by running:
33536 .code
33537 perl -MCPAN -e 'install Mail::SpamAssassin'
33538 .endd
33539 SpamAssassin has its own set of configuration files. Please review its
33540 documentation to see how you can tweak it. The default installation should work
33541 nicely, however.
33542
33543 .oindex "&%spamd_address%&"
33544 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33545 intend to use an instance running on the local host you do not need to set
33546 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33547 you must set the &%spamd_address%& option in the global part of the Exim
33548 configuration as follows (example):
33549 .code
33550 spamd_address = 192.168.99.45 783
33551 .endd
33552 The SpamAssassin protocol relies on a TCP half-close from the client.
33553 If your SpamAssassin client side is running a Linux system with an
33554 iptables firewall, consider setting
33555 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33556 timeout, Exim uses when waiting for a response from the SpamAssassin
33557 server (currently defaulting to 120s).  With a lower value the Linux
33558 connection tracking may consider your half-closed connection as dead too
33559 soon.
33560
33561
33562 To use Rspamd (which by default listens on all local addresses
33563 on TCP port 11333)
33564 you should add &%variant=rspamd%& after the address/port pair, for example:
33565 .code
33566 spamd_address = 127.0.0.1 11333 variant=rspamd
33567 .endd
33568
33569 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33570 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33571 filename instead of an address/port pair:
33572 .code
33573 spamd_address = /var/run/spamd_socket
33574 .endd
33575 You can have multiple &%spamd%& servers to improve scalability. These can
33576 reside on other hardware reachable over the network. To specify multiple
33577 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33578 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33579 .code
33580 spamd_address = 192.168.2.10 783 : \
33581                 192.168.2.11 783 : \
33582                 192.168.2.12 783
33583 .endd
33584 Up to 32 &%spamd%& servers are supported.
33585 When a server fails to respond to the connection attempt, all other
33586 servers are tried until one succeeds. If no server responds, the &%spam%&
33587 condition defers.
33588
33589 Unix and TCP socket specifications may be mixed in any order.
33590 Each element of the list is a list itself, space-separated by default
33591 and changeable in the usual way (&<<SECTlistsepchange>>&);
33592 take care to not double the separator.
33593
33594 For TCP socket specifications a host name or IP (v4 or v6, but
33595 subject to list-separator quoting rules) address can be used,
33596 and the port can be one or a dash-separated pair.
33597 In the latter case, the range is tried in strict order.
33598
33599 Elements after the first for Unix sockets, or second for TCP socket,
33600 are options.
33601 The supported options are:
33602 .code
33603 pri=<priority>      Selection priority
33604 weight=<value>      Selection bias
33605 time=<start>-<end>  Use only between these times of day
33606 retry=<timespec>    Retry on connect fail
33607 tmo=<timespec>      Connection time limit
33608 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33609 .endd
33610
33611 The &`pri`& option specifies a priority for the server within the list,
33612 higher values being tried first.
33613 The default priority is 1.
33614
33615 The &`weight`& option specifies a selection bias.
33616 Within a priority set
33617 servers are queried in a random fashion, weighted by this value.
33618 The default value for selection bias is 1.
33619
33620 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33621 in the local time zone; each element being one or more digits.
33622 Either the seconds or both minutes and seconds, plus the leading &`.`&
33623 characters, may be omitted and will be taken as zero.
33624
33625 Timeout specifications for the &`retry`& and &`tmo`& options
33626 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33627
33628 The &`tmo`& option specifies an overall timeout for communication.
33629 The default value is two minutes.
33630
33631 The &`retry`& option specifies a time after which a single retry for
33632 a failed connect is made.
33633 The default is to not retry.
33634
33635 The &%spamd_address%& variable is expanded before use if it starts with
33636 a dollar sign. In this case, the expansion may return a string that is
33637 used as the list so that multiple spamd servers can be the result of an
33638 expansion.
33639
33640 .vindex "&$callout_address$&"
33641 When a connection is made to the server the expansion variable &$callout_address$&
33642 is set to record the actual address used.
33643
33644 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33645 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33646 .code
33647 deny message = This message was classified as SPAM
33648      spam = joe
33649 .endd
33650 The right-hand side of the &%spam%& condition specifies a name. This is
33651 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33652 to scan using a specific profile, but rather use the SpamAssassin system-wide
33653 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33654 Rspamd does not use this setting. However, you must put something on the
33655 right-hand side.
33656
33657 The name allows you to use per-domain or per-user antispam profiles in
33658 principle, but this is not straightforward in practice, because a message may
33659 have multiple recipients, not necessarily all in the same domain. Because the
33660 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33661 read the contents of the message, the variables &$local_part$& and &$domain$&
33662 are not set.
33663 Careful enforcement of single-recipient messages
33664 (e.g. by responding with defer in the recipient ACL for all recipients
33665 after the first),
33666 or the use of PRDR,
33667 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33668 are needed to use this feature.
33669
33670 The right-hand side of the &%spam%& condition is expanded before being used, so
33671 you can put lookups or conditions there. When the right-hand side evaluates to
33672 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33673
33674
33675 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33676 large ones may cause significant performance degradation. As most spam messages
33677 are quite small, it is recommended that you do not scan the big ones. For
33678 example:
33679 .code
33680 deny message = This message was classified as SPAM
33681      condition = ${if < {$message_size}{10K}}
33682      spam = nobody
33683 .endd
33684
33685 The &%spam%& condition returns true if the threshold specified in the user's
33686 SpamAssassin profile has been matched or exceeded. If you want to use the
33687 &%spam%& condition for its side effects (see the variables below), you can make
33688 it always return &"true"& by appending &`:true`& to the username.
33689
33690 .cindex "spam scanning" "returned variables"
33691 When the &%spam%& condition is run, it sets up a number of expansion
33692 variables.
33693 Except for &$spam_report$&,
33694 these variables are saved with the received message so are
33695 available for use at delivery time.
33696
33697 .vlist
33698 .vitem &$spam_score$&
33699 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33700 for inclusion in log or reject messages.
33701
33702 .vitem &$spam_score_int$&
33703 The spam score of the message, multiplied by ten, as an integer value. For
33704 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33705 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33706 The integer value is useful for numeric comparisons in conditions.
33707
33708 .vitem &$spam_bar$&
33709 A string consisting of a number of &"+"& or &"-"& characters, representing the
33710 integer part of the spam score value. A spam score of 4.4 would have a
33711 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33712 headers, since MUAs can match on such strings. The maximum length of the
33713 spam bar is 50 characters.
33714
33715 .vitem &$spam_report$&
33716 A multiline text table, containing the full SpamAssassin report for the
33717 message. Useful for inclusion in headers or reject messages.
33718 This variable is only usable in a DATA-time ACL.
33719 Beware that SpamAssassin may return non-ASCII characters, especially
33720 when running in country-specific locales, which are not legal
33721 unencoded in headers.
33722
33723 .vitem &$spam_action$&
33724 For SpamAssassin either 'reject' or 'no action' depending on the
33725 spam score versus threshold.
33726 For Rspamd, the recommended action.
33727
33728 .endlist
33729
33730 The &%spam%& condition caches its results unless expansion in
33731 spamd_address was used. If you call it again with the same user name, it
33732 does not scan again, but rather returns the same values as before.
33733
33734 The &%spam%& condition returns DEFER if there is any error while running
33735 the message through SpamAssassin or if the expansion of spamd_address
33736 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33737 statement block), append &`/defer_ok`& to the right-hand side of the
33738 spam condition, like this:
33739 .code
33740 deny message = This message was classified as SPAM
33741      spam    = joe/defer_ok
33742 .endd
33743 This causes messages to be accepted even if there is a problem with &%spamd%&.
33744
33745 Here is a longer, commented example of the use of the &%spam%&
33746 condition:
33747 .code
33748 # put headers in all messages (no matter if spam or not)
33749 warn  spam = nobody:true
33750       add_header = X-Spam-Score: $spam_score ($spam_bar)
33751       add_header = X-Spam-Report: $spam_report
33752
33753 # add second subject line with *SPAM* marker when message
33754 # is over threshold
33755 warn  spam = nobody
33756       add_header = Subject: *SPAM* $h_Subject:
33757
33758 # reject spam at high scores (> 12)
33759 deny  message = This message scored $spam_score spam points.
33760       spam = nobody:true
33761       condition = ${if >{$spam_score_int}{120}{1}{0}}
33762 .endd
33763
33764
33765
33766 .section "Scanning MIME parts" "SECTscanmimepart"
33767 .cindex "content scanning" "MIME parts"
33768 .cindex "MIME content scanning"
33769 .oindex "&%acl_smtp_mime%&"
33770 .oindex "&%acl_not_smtp_mime%&"
33771 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33772 each MIME part of an SMTP message, including multipart types, in the sequence
33773 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33774 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33775 options may both refer to the same ACL if you want the same processing in both
33776 cases.
33777
33778 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33779 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33780 the case of a non-SMTP message. However, a MIME ACL is called only if the
33781 message contains a &'Content-Type:'& header line. When a call to a MIME
33782 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33783 result code is sent to the client. In the case of an SMTP message, the
33784 &%acl_smtp_data%& ACL is not called when this happens.
33785
33786 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33787 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33788 condition to match against the raw MIME part. You can also use the
33789 &%mime_regex%& condition to match against the decoded MIME part (see section
33790 &<<SECTscanregex>>&).
33791
33792 At the start of a MIME ACL, a number of variables are set from the header
33793 information for the relevant MIME part. These are described below. The contents
33794 of the MIME part are not by default decoded into a disk file except for MIME
33795 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33796 part into a disk file, you can use the &%decode%& condition. The general
33797 syntax is:
33798 .display
33799 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33800 .endd
33801 The right hand side is expanded before use. After expansion,
33802 the value can be:
33803
33804 .olist
33805 &"0"& or &"false"&, in which case no decoding is done.
33806 .next
33807 The string &"default"&. In that case, the file is put in the temporary
33808 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33809 a sequential filename consisting of the message id and a sequence number. The
33810 full path and name is available in &$mime_decoded_filename$& after decoding.
33811 .next
33812 A full path name starting with a slash. If the full name is an existing
33813 directory, it is used as a replacement for the default directory. The filename
33814 is then sequentially assigned. If the path does not exist, it is used as
33815 the full path and filename.
33816 .next
33817 If the string does not start with a slash, it is used as the
33818 filename, and the default path is then used.
33819 .endlist
33820 The &%decode%& condition normally succeeds. It is only false for syntax
33821 errors or unusual circumstances such as memory shortages. You can easily decode
33822 a file with its original, proposed filename using
33823 .code
33824 decode = $mime_filename
33825 .endd
33826 However, you should keep in mind that &$mime_filename$& might contain
33827 anything. If you place files outside of the default path, they are not
33828 automatically unlinked.
33829
33830 For RFC822 attachments (these are messages attached to messages, with a
33831 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33832 as for the primary message, only that the &$mime_is_rfc822$& expansion
33833 variable is set (see below). Attached messages are always decoded to disk
33834 before being checked, and the files are unlinked once the check is done.
33835
33836 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33837 used to match regular expressions against raw and decoded MIME parts,
33838 respectively. They are described in section &<<SECTscanregex>>&.
33839
33840 .cindex "MIME content scanning" "returned variables"
33841 The following list describes all expansion variables that are
33842 available in the MIME ACL:
33843
33844 .vlist
33845 .vitem &$mime_anomaly_level$& &&&
33846        &$mime_anomaly_text$&
33847 .vindex &$mime_anomaly_level$&
33848 .vindex &$mime_anomaly_text$&
33849 If there are problems decoding, these variables contain information on
33850 the detected issue.
33851
33852 .vitem &$mime_boundary$&
33853 .vindex &$mime_boundary$&
33854 If the current part is a multipart (see &$mime_is_multipart$& below), it should
33855 have a boundary string, which is stored in this variable. If the current part
33856 has no boundary parameter in the &'Content-Type:'& header, this variable
33857 contains the empty string.
33858
33859 .vitem &$mime_charset$&
33860 .vindex &$mime_charset$&
33861 This variable contains the character set identifier, if one was found in the
33862 &'Content-Type:'& header. Examples for charset identifiers are:
33863 .code
33864 us-ascii
33865 gb2312 (Chinese)
33866 iso-8859-1
33867 .endd
33868 Please note that this value is not normalized, so you should do matches
33869 case-insensitively.
33870
33871 .vitem &$mime_content_description$&
33872 .vindex &$mime_content_description$&
33873 This variable contains the normalized content of the &'Content-Description:'&
33874 header. It can contain a human-readable description of the parts content. Some
33875 implementations repeat the filename for attachments here, but they are usually
33876 only used for display purposes.
33877
33878 .vitem &$mime_content_disposition$&
33879 .vindex &$mime_content_disposition$&
33880 This variable contains the normalized content of the &'Content-Disposition:'&
33881 header. You can expect strings like &"attachment"& or &"inline"& here.
33882
33883 .vitem &$mime_content_id$&
33884 .vindex &$mime_content_id$&
33885 This variable contains the normalized content of the &'Content-ID:'& header.
33886 This is a unique ID that can be used to reference a part from another part.
33887
33888 .vitem &$mime_content_size$&
33889 .vindex &$mime_content_size$&
33890 This variable is set only after the &%decode%& modifier (see above) has been
33891 successfully run. It contains the size of the decoded part in kilobytes. The
33892 size is always rounded up to full kilobytes, so only a completely empty part
33893 has a &$mime_content_size$& of zero.
33894
33895 .vitem &$mime_content_transfer_encoding$&
33896 .vindex &$mime_content_transfer_encoding$&
33897 This variable contains the normalized content of the
33898 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33899 type. Typical values are &"base64"& and &"quoted-printable"&.
33900
33901 .vitem &$mime_content_type$&
33902 .vindex &$mime_content_type$&
33903 If the MIME part has a &'Content-Type:'& header, this variable contains its
33904 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33905 are some examples of popular MIME types, as they may appear in this variable:
33906 .code
33907 text/plain
33908 text/html
33909 application/octet-stream
33910 image/jpeg
33911 audio/midi
33912 .endd
33913 If the MIME part has no &'Content-Type:'& header, this variable contains the
33914 empty string.
33915
33916 .vitem &$mime_decoded_filename$&
33917 .vindex &$mime_decoded_filename$&
33918 This variable is set only after the &%decode%& modifier (see above) has been
33919 successfully run. It contains the full path and filename of the file
33920 containing the decoded data.
33921 .endlist
33922
33923 .cindex "RFC 2047"
33924 .vlist
33925 .vitem &$mime_filename$&
33926 .vindex &$mime_filename$&
33927 This is perhaps the most important of the MIME variables. It contains a
33928 proposed filename for an attachment, if one was found in either the
33929 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33930 RFC2047
33931 or RFC2231
33932 decoded, but no additional sanity checks are done.
33933  If no filename was
33934 found, this variable contains the empty string.
33935
33936 .vitem &$mime_is_coverletter$&
33937 .vindex &$mime_is_coverletter$&
33938 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33939 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33940 content in the cover letter, while not restricting attachments at all.
33941
33942 The variable contains 1 (true) for a MIME part believed to be part of the
33943 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33944 follows:
33945
33946 .olist
33947 The outermost MIME part of a message is always a cover letter.
33948
33949 .next
33950 If a multipart/alternative or multipart/related MIME part is a cover letter,
33951 so are all MIME subparts within that multipart.
33952
33953 .next
33954 If any other multipart is a cover letter, the first subpart is a cover letter,
33955 and the rest are attachments.
33956
33957 .next
33958 All parts contained within an attachment multipart are attachments.
33959 .endlist olist
33960
33961 As an example, the following will ban &"HTML mail"& (including that sent with
33962 alternative plain text), while allowing HTML files to be attached. HTML
33963 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33964 .code
33965 deny message = HTML mail is not accepted here
33966 !condition = $mime_is_rfc822
33967 condition = $mime_is_coverletter
33968 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33969 .endd
33970
33971 .vitem &$mime_is_multipart$&
33972 .vindex &$mime_is_multipart$&
33973 This variable has the value 1 (true) when the current part has the main type
33974 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33975 Since multipart entities only serve as containers for other parts, you may not
33976 want to carry out specific actions on them.
33977
33978 .vitem &$mime_is_rfc822$&
33979 .vindex &$mime_is_rfc822$&
33980 This variable has the value 1 (true) if the current part is not a part of the
33981 checked message itself, but part of an attached message. Attached message
33982 decoding is fully recursive.
33983
33984 .vitem &$mime_part_count$&
33985 .vindex &$mime_part_count$&
33986 This variable is a counter that is raised for each processed MIME part. It
33987 starts at zero for the very first part (which is usually a multipart). The
33988 counter is per-message, so it is reset when processing RFC822 attachments (see
33989 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33990 complete, so you can use it in the DATA ACL to determine the number of MIME
33991 parts of a message. For non-MIME messages, this variable contains the value -1.
33992 .endlist
33993
33994
33995
33996 .section "Scanning with regular expressions" "SECTscanregex"
33997 .cindex "content scanning" "with regular expressions"
33998 .cindex "regular expressions" "content scanning with"
33999 You can specify your own custom regular expression matches on the full body of
34000 the message, or on individual MIME parts.
34001
34002 The &%regex%& condition takes one or more regular expressions as arguments and
34003 matches them against the full message (when called in the DATA ACL) or a raw
34004 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34005 linewise, with a maximum line length of 32K characters. That means you cannot
34006 have multiline matches with the &%regex%& condition.
34007
34008 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34009 to 32K of decoded content (the whole content at once, not linewise). If the
34010 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34011 is decoded automatically when &%mime_regex%& is executed (using default path
34012 and filename values). If the decoded data is larger than  32K, only the first
34013 32K characters are checked.
34014
34015 The regular expressions are passed as a colon-separated list. To include a
34016 literal colon, you must double it. Since the whole right-hand side string is
34017 expanded before being used, you must also escape dollar signs and backslashes
34018 with more backslashes, or use the &`\N`& facility to disable expansion.
34019 Here is a simple example that contains two regular expressions:
34020 .code
34021 deny message = contains blacklisted regex ($regex_match_string)
34022      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34023 .endd
34024 The conditions returns true if any one of the regular expressions matches. The
34025 &$regex_match_string$& expansion variable is then set up and contains the
34026 matching regular expression.
34027 The expansion variables &$regex1$& &$regex2$& etc
34028 are set to any substrings captured by the regular expression.
34029
34030 &*Warning*&: With large messages, these conditions can be fairly
34031 CPU-intensive.
34032
34033 .ecindex IIDcosca
34034
34035
34036
34037
34038 . ////////////////////////////////////////////////////////////////////////////
34039 . ////////////////////////////////////////////////////////////////////////////
34040
34041 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34042          "Local scan function"
34043 .scindex IIDlosca "&[local_scan()]& function" "description of"
34044 .cindex "customizing" "input scan using C function"
34045 .cindex "policy control" "by local scan function"
34046 In these days of email worms, viruses, and ever-increasing spam, some sites
34047 want to apply a lot of checking to messages before accepting them.
34048
34049 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34050 passing messages to external virus and spam scanning software. You can also do
34051 a certain amount in Exim itself through string expansions and the &%condition%&
34052 condition in the ACL that runs after the SMTP DATA command or the ACL for
34053 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34054
34055 To allow for further customization to a site's own requirements, there is the
34056 possibility of linking Exim with a private message scanning function, written
34057 in C. If you want to run code that is written in something other than C, you
34058 can of course use a little C stub to call it.
34059
34060 The local scan function is run once for every incoming message, at the point
34061 when Exim is just about to accept the message.
34062 It can therefore be used to control non-SMTP messages from local processes as
34063 well as messages arriving via SMTP.
34064
34065 Exim applies a timeout to calls of the local scan function, and there is an
34066 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34067 Zero means &"no timeout"&.
34068 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34069 before calling the local scan function, so that the most common types of crash
34070 are caught. If the timeout is exceeded or one of those signals is caught, the
34071 incoming message is rejected with a temporary error if it is an SMTP message.
34072 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34073 code. The incident is logged on the main and reject logs.
34074
34075
34076
34077 .section "Building Exim to use a local scan function" "SECID207"
34078 .cindex "&[local_scan()]& function" "building Exim to use"
34079 To make use of the local scan function feature, you must tell Exim where your
34080 function is before building Exim, by setting
34081 both HAVE_LOCAL_SCAN and
34082 LOCAL_SCAN_SOURCE in your
34083 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34084 directory, so you might set
34085 .code
34086 HAVE_LOCAL_SCAN=yes
34087 LOCAL_SCAN_SOURCE=Local/local_scan.c
34088 .endd
34089 for example. The function must be called &[local_scan()]&;
34090 .new
34091 the source file(s) for it should first #define LOCAL_SCAN
34092 and then #include "local_scan.h".
34093 .wen
34094 It is called by
34095 Exim after it has received a message, when the success return code is about to
34096 be sent. This is after all the ACLs have been run. The return code from your
34097 function controls whether the message is actually accepted or not. There is a
34098 commented template function (that just accepts the message) in the file
34099 _src/local_scan.c_.
34100
34101 If you want to make use of Exim's runtime configuration file to set options
34102 for your &[local_scan()]& function, you must also set
34103 .code
34104 LOCAL_SCAN_HAS_OPTIONS=yes
34105 .endd
34106 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34107
34108
34109
34110
34111 .section "API for local_scan()" "SECTapiforloc"
34112 .cindex "&[local_scan()]& function" "API description"
34113 .cindex &%dlfunc%& "API description"
34114 You must include this line near the start of your code:
34115 .code
34116 #define LOCAL_SCAN
34117 #include "local_scan.h"
34118 .endd
34119 This header file defines a number of variables and other values, and the
34120 prototype for the function itself. Exim is coded to use unsigned char values
34121 almost exclusively, and one of the things this header defines is a shorthand
34122 for &`unsigned char`& called &`uschar`&.
34123 It also makes available the following macro definitions, to simplify casting character
34124 strings and pointers to character strings:
34125 .code
34126 #define CS   (char *)
34127 #define CCS  (const char *)
34128 #define CSS  (char **)
34129 #define US   (unsigned char *)
34130 #define CUS  (const unsigned char *)
34131 #define USS  (unsigned char **)
34132 .endd
34133 The function prototype for &[local_scan()]& is:
34134 .code
34135 extern int local_scan(int fd, uschar **return_text);
34136 .endd
34137 The arguments are as follows:
34138
34139 .ilist
34140 &%fd%& is a file descriptor for the file that contains the body of the message
34141 (the -D file). The file is open for reading and writing, but updating it is not
34142 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34143
34144 The descriptor is positioned at character 19 of the file, which is the first
34145 character of the body itself, because the first 19 characters are the message
34146 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34147 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34148 case this changes in some future version.
34149 .next
34150 &%return_text%& is an address which you can use to return a pointer to a text
34151 string at the end of the function. The value it points to on entry is NULL.
34152 .endlist
34153
34154 The function must return an &%int%& value which is one of the following macros:
34155
34156 .vlist
34157 .vitem &`LOCAL_SCAN_ACCEPT`&
34158 .vindex "&$local_scan_data$&"
34159 The message is accepted. If you pass back a string of text, it is saved with
34160 the message, and made available in the variable &$local_scan_data$&. No
34161 newlines are permitted (if there are any, they are turned into spaces) and the
34162 maximum length of text is 1000 characters.
34163
34164 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34165 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34166 queued without immediate delivery, and is frozen.
34167
34168 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34169 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34170 queued without immediate delivery.
34171
34172 .vitem &`LOCAL_SCAN_REJECT`&
34173 The message is rejected; the returned text is used as an error message which is
34174 passed back to the sender and which is also logged. Newlines are permitted &--
34175 they cause a multiline response for SMTP rejections, but are converted to
34176 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34177 used.
34178
34179 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34180 The message is temporarily rejected; the returned text is used as an error
34181 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34182 problem"& is used.
34183
34184 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34185 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34186 message is not written to the reject log. It has the effect of unsetting the
34187 &%rejected_header%& log selector for just this rejection. If
34188 &%rejected_header%& is already unset (see the discussion of the
34189 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34190 same as LOCAL_SCAN_REJECT.
34191
34192 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34193 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34194 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34195 .endlist
34196
34197 If the message is not being received by interactive SMTP, rejections are
34198 reported by writing to &%stderr%& or by sending an email, as configured by the
34199 &%-oe%& command line options.
34200
34201
34202
34203 .section "Configuration options for local_scan()" "SECTconoptloc"
34204 .cindex "&[local_scan()]& function" "configuration options"
34205 It is possible to have option settings in the main configuration file
34206 that set values in static variables in the &[local_scan()]& module. If you
34207 want to do this, you must have the line
34208 .code
34209 LOCAL_SCAN_HAS_OPTIONS=yes
34210 .endd
34211 in your &_Local/Makefile_& when you build Exim. (This line is in
34212 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34213 file, you must define static variables to hold the option values, and a table
34214 to define them.
34215
34216 The table must be a vector called &%local_scan_options%&, of type
34217 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34218 and a pointer to the variable that holds the value. The entries must appear in
34219 alphabetical order. Following &%local_scan_options%& you must also define a
34220 variable called &%local_scan_options_count%& that contains the number of
34221 entries in the table. Here is a short example, showing two kinds of option:
34222 .code
34223 static int my_integer_option = 42;
34224 static uschar *my_string_option = US"a default string";
34225
34226 optionlist local_scan_options[] = {
34227   { "my_integer", opt_int,       &my_integer_option },
34228   { "my_string",  opt_stringptr, &my_string_option }
34229 };
34230
34231 int local_scan_options_count =
34232   sizeof(local_scan_options)/sizeof(optionlist);
34233 .endd
34234 The values of the variables can now be changed from Exim's runtime
34235 configuration file by including a local scan section as in this example:
34236 .code
34237 begin local_scan
34238 my_integer = 99
34239 my_string = some string of text...
34240 .endd
34241 The available types of option data are as follows:
34242
34243 .vlist
34244 .vitem &*opt_bool*&
34245 This specifies a boolean (true/false) option. The address should point to a
34246 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34247 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34248 whether such a variable has been set at all, you can initialize it to
34249 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34250 values.)
34251
34252 .vitem &*opt_fixed*&
34253 This specifies a fixed point number, such as is used for load averages.
34254 The address should point to a variable of type &`int`&. The value is stored
34255 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34256
34257 .vitem &*opt_int*&
34258 This specifies an integer; the address should point to a variable of type
34259 &`int`&. The value may be specified in any of the integer formats accepted by
34260 Exim.
34261
34262 .vitem &*opt_mkint*&
34263 This is the same as &%opt_int%&, except that when such a value is output in a
34264 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34265 printed with the suffix K or M.
34266
34267 .vitem &*opt_octint*&
34268 This also specifies an integer, but the value is always interpreted as an
34269 octal integer, whether or not it starts with the digit zero, and it is
34270 always output in octal.
34271
34272 .vitem &*opt_stringptr*&
34273 This specifies a string value; the address must be a pointer to a
34274 variable that points to a string (for example, of type &`uschar *`&).
34275
34276 .vitem &*opt_time*&
34277 This specifies a time interval value. The address must point to a variable of
34278 type &`int`&. The value that is placed there is a number of seconds.
34279 .endlist
34280
34281 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34282 out the values of all the &[local_scan()]& options.
34283
34284
34285
34286 .section "Available Exim variables" "SECID208"
34287 .cindex "&[local_scan()]& function" "available Exim variables"
34288 The header &_local_scan.h_& gives you access to a number of C variables. These
34289 are the only ones that are guaranteed to be maintained from release to release.
34290 Note, however, that you can obtain the value of any Exim expansion variable,
34291 including &$recipients$&, by calling &'expand_string()'&. The exported
34292 C variables are as follows:
34293
34294 .vlist
34295 .vitem &*int&~body_linecount*&
34296 This variable contains the number of lines in the message's body.
34297 It is not valid if the &%spool_files_wireformat%& option is used.
34298
34299 .vitem &*int&~body_zerocount*&
34300 This variable contains the number of binary zero bytes in the message's body.
34301 It is not valid if the &%spool_files_wireformat%& option is used.
34302
34303 .vitem &*unsigned&~int&~debug_selector*&
34304 This variable is set to zero when no debugging is taking place. Otherwise, it
34305 is a bitmap of debugging selectors. Two bits are identified for use in
34306 &[local_scan()]&; they are defined as macros:
34307
34308 .ilist
34309 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34310 testing option that is not privileged &-- any caller may set it. All the
34311 other selector bits can be set only by admin users.
34312
34313 .next
34314 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34315 by the &`+local_scan`& debug selector. It is not included in the default set
34316 of debugging bits.
34317 .endlist ilist
34318
34319 Thus, to write to the debugging output only when &`+local_scan`& has been
34320 selected, you should use code like this:
34321 .code
34322 if ((debug_selector & D_local_scan) != 0)
34323   debug_printf("xxx", ...);
34324 .endd
34325 .vitem &*uschar&~*expand_string_message*&
34326 After a failing call to &'expand_string()'& (returned value NULL), the
34327 variable &%expand_string_message%& contains the error message, zero-terminated.
34328
34329 .vitem &*header_line&~*header_list*&
34330 A pointer to a chain of header lines. The &%header_line%& structure is
34331 discussed below.
34332
34333 .vitem &*header_line&~*header_last*&
34334 A pointer to the last of the header lines.
34335
34336 .vitem &*uschar&~*headers_charset*&
34337 The value of the &%headers_charset%& configuration option.
34338
34339 .vitem &*BOOL&~host_checking*&
34340 This variable is TRUE during a host checking session that is initiated by the
34341 &%-bh%& command line option.
34342
34343 .vitem &*uschar&~*interface_address*&
34344 The IP address of the interface that received the message, as a string. This
34345 is NULL for locally submitted messages.
34346
34347 .vitem &*int&~interface_port*&
34348 The port on which this message was received. When testing with the &%-bh%&
34349 command line option, the value of this variable is -1 unless a port has been
34350 specified via the &%-oMi%& option.
34351
34352 .vitem &*uschar&~*message_id*&
34353 This variable contains Exim's message id for the incoming message (the value of
34354 &$message_exim_id$&) as a zero-terminated string.
34355
34356 .vitem &*uschar&~*received_protocol*&
34357 The name of the protocol by which the message was received.
34358
34359 .vitem &*int&~recipients_count*&
34360 The number of accepted recipients.
34361
34362 .vitem &*recipient_item&~*recipients_list*&
34363 .cindex "recipient" "adding in local scan"
34364 .cindex "recipient" "removing in local scan"
34365 The list of accepted recipients, held in a vector of length
34366 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34367 can add additional recipients by calling &'receive_add_recipient()'& (see
34368 below). You can delete recipients by removing them from the vector and
34369 adjusting the value in &%recipients_count%&. In particular, by setting
34370 &%recipients_count%& to zero you remove all recipients. If you then return the
34371 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34372 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34373 and then call &'receive_add_recipient()'& as often as needed.
34374
34375 .vitem &*uschar&~*sender_address*&
34376 The envelope sender address. For bounce messages this is the empty string.
34377
34378 .vitem &*uschar&~*sender_host_address*&
34379 The IP address of the sending host, as a string. This is NULL for
34380 locally-submitted messages.
34381
34382 .vitem &*uschar&~*sender_host_authenticated*&
34383 The name of the authentication mechanism that was used, or NULL if the message
34384 was not received over an authenticated SMTP connection.
34385
34386 .vitem &*uschar&~*sender_host_name*&
34387 The name of the sending host, if known.
34388
34389 .vitem &*int&~sender_host_port*&
34390 The port on the sending host.
34391
34392 .vitem &*BOOL&~smtp_input*&
34393 This variable is TRUE for all SMTP input, including BSMTP.
34394
34395 .vitem &*BOOL&~smtp_batched_input*&
34396 This variable is TRUE for BSMTP input.
34397
34398 .vitem &*int&~store_pool*&
34399 The contents of this variable control which pool of memory is used for new
34400 requests. See section &<<SECTmemhanloc>>& for details.
34401 .endlist
34402
34403
34404 .section "Structure of header lines" "SECID209"
34405 The &%header_line%& structure contains the members listed below.
34406 You can add additional header lines by calling the &'header_add()'& function
34407 (see below). You can cause header lines to be ignored (deleted) by setting
34408 their type to *.
34409
34410
34411 .vlist
34412 .vitem &*struct&~header_line&~*next*&
34413 A pointer to the next header line, or NULL for the last line.
34414
34415 .vitem &*int&~type*&
34416 A code identifying certain headers that Exim recognizes. The codes are printing
34417 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34418 Notice in particular that any header line whose type is * is not transmitted
34419 with the message. This flagging is used for header lines that have been
34420 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34421 lines.) Effectively, * means &"deleted"&.
34422
34423 .vitem &*int&~slen*&
34424 The number of characters in the header line, including the terminating and any
34425 internal newlines.
34426
34427 .vitem &*uschar&~*text*&
34428 A pointer to the text of the header. It always ends with a newline, followed by
34429 a zero byte. Internal newlines are preserved.
34430 .endlist
34431
34432
34433
34434 .section "Structure of recipient items" "SECID210"
34435 The &%recipient_item%& structure contains these members:
34436
34437 .vlist
34438 .vitem &*uschar&~*address*&
34439 This is a pointer to the recipient address as it was received.
34440
34441 .vitem &*int&~pno*&
34442 This is used in later Exim processing when top level addresses are created by
34443 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34444 and must always contain -1 at this stage.
34445
34446 .vitem &*uschar&~*errors_to*&
34447 If this value is not NULL, bounce messages caused by failing to deliver to the
34448 recipient are sent to the address it contains. In other words, it overrides the
34449 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34450 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34451 an unqualified address, Exim qualifies it using the domain from
34452 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34453 is NULL for all recipients.
34454 .endlist
34455
34456
34457
34458 .section "Available Exim functions" "SECID211"
34459 .cindex "&[local_scan()]& function" "available Exim functions"
34460 The header &_local_scan.h_& gives you access to a number of Exim functions.
34461 These are the only ones that are guaranteed to be maintained from release to
34462 release:
34463
34464 .vlist
34465 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34466        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34467
34468 This function creates a child process that runs the command specified by
34469 &%argv%&. The environment for the process is specified by &%envp%&, which can
34470 be NULL if no environment variables are to be passed. A new umask is supplied
34471 for the process in &%newumask%&.
34472
34473 Pipes to the standard input and output of the new process are set up
34474 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34475 standard error is cloned to the standard output. If there are any file
34476 descriptors &"in the way"& in the new process, they are closed. If the final
34477 argument is TRUE, the new process is made into a process group leader.
34478
34479 The function returns the pid of the new process, or -1 if things go wrong.
34480
34481 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34482 This function waits for a child process to terminate, or for a timeout (in
34483 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34484 return value is as follows:
34485
34486 .ilist
34487 >= 0
34488
34489 The process terminated by a normal exit and the value is the process
34490 ending status.
34491
34492 .next
34493 < 0 and > &--256
34494
34495 The process was terminated by a signal and the value is the negation of the
34496 signal number.
34497
34498 .next
34499 &--256
34500
34501 The process timed out.
34502 .next
34503 &--257
34504
34505 The was some other error in wait(); &%errno%& is still set.
34506 .endlist
34507
34508 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34509 This function provide you with a means of submitting a new message to
34510 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34511 want, but this packages it all up for you.) The function creates a pipe,
34512 forks a subprocess that is running
34513 .code
34514 exim -t -oem -oi -f <>
34515 .endd
34516 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34517 that is connected to the standard input. The yield of the function is the PID
34518 of the subprocess. You can then write a message to the file descriptor, with
34519 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34520
34521 When you have finished, call &'child_close()'& to wait for the process to
34522 finish and to collect its ending status. A timeout value of zero is usually
34523 fine in this circumstance. Unless you have made a mistake with the recipient
34524 addresses, you should get a return code of zero.
34525
34526
34527 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34528        *sender_authentication)*&
34529 This function is a more sophisticated version of &'child_open()'&. The command
34530 that it runs is:
34531 .display
34532 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34533 .endd
34534 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34535
34536
34537 .vitem &*void&~debug_printf(char&~*,&~...)*&
34538 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34539 output is written to the standard error stream. If no debugging is selected,
34540 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34541 conditional on the &`local_scan`& debug selector by coding like this:
34542 .code
34543 if ((debug_selector & D_local_scan) != 0)
34544   debug_printf("xxx", ...);
34545 .endd
34546
34547 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34548 This is an interface to Exim's string expansion code. The return value is the
34549 expanded string, or NULL if there was an expansion failure.
34550 The C variable &%expand_string_message%& contains an error message after an
34551 expansion failure. If expansion does not change the string, the return value is
34552 the pointer to the input string. Otherwise, the return value points to a new
34553 block of memory that was obtained by a call to &'store_get()'&. See section
34554 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34555
34556 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34557 This function allows you to an add additional header line at the end of the
34558 existing ones. The first argument is the type, and should normally be a space
34559 character. The second argument is a format string and any number of
34560 substitution arguments as for &[sprintf()]&. You may include internal newlines
34561 if you want, and you must ensure that the string ends with a newline.
34562
34563 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34564         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34565 This function adds a new header line at a specified point in the header
34566 chain. The header itself is specified as for &'header_add()'&.
34567
34568 If &%name%& is NULL, the new header is added at the end of the chain if
34569 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34570 NULL, the header lines are searched for the first non-deleted header that
34571 matches the name. If one is found, the new header is added before it if
34572 &%after%& is false. If &%after%& is true, the new header is added after the
34573 found header and any adjacent subsequent ones with the same name (even if
34574 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34575 option controls where the header is added. If it is true, addition is at the
34576 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34577 headers, or at the top if there are no &'Received:'& headers, you could use
34578 .code
34579 header_add_at_position(TRUE, US"Received", TRUE,
34580   ' ', "X-xxx: ...");
34581 .endd
34582 Normally, there is always at least one non-deleted &'Received:'& header, but
34583 there may not be if &%received_header_text%& expands to an empty string.
34584
34585
34586 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34587 This function removes header lines. If &%occurrence%& is zero or negative, all
34588 occurrences of the header are removed. If occurrence is greater than zero, that
34589 particular instance of the header is removed. If no header(s) can be found that
34590 match the specification, the function does nothing.
34591
34592
34593 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34594         int&~length,&~BOOL&~notdel)*&"
34595 This function tests whether the given header has the given name. It is not just
34596 a string comparison, because white space is permitted between the name and the
34597 colon. If the &%notdel%& argument is true, a false return is forced for all
34598 &"deleted"& headers; otherwise they are not treated specially. For example:
34599 .code
34600 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34601 .endd
34602 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34603 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34604 This function base64-encodes a string, which is passed by address and length.
34605 The text may contain bytes of any value, including zero. The result is passed
34606 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34607 zero-terminated.
34608
34609 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34610 This function decodes a base64-encoded string. Its arguments are a
34611 zero-terminated base64-encoded string and the address of a variable that is set
34612 to point to the result, which is in dynamic memory. The length of the decoded
34613 string is the yield of the function. If the input is invalid base64 data, the
34614 yield is -1. A zero byte is added to the end of the output string to make it
34615 easy to interpret as a C string (assuming it contains no zeros of its own). The
34616 added zero byte is not included in the returned count.
34617
34618 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34619 This function checks for a match in a domain list. Domains are always
34620 matched caselessly. The return value is one of the following:
34621 .display
34622 &`OK     `& match succeeded
34623 &`FAIL   `& match failed
34624 &`DEFER  `& match deferred
34625 .endd
34626 DEFER is usually caused by some kind of lookup defer, such as the
34627 inability to contact a database.
34628
34629 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34630         BOOL&~caseless)*&"
34631 This function checks for a match in a local part list. The third argument
34632 controls case-sensitivity. The return values are as for
34633 &'lss_match_domain()'&.
34634
34635 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34636         BOOL&~caseless)*&"
34637 This function checks for a match in an address list. The third argument
34638 controls the case-sensitivity of the local part match. The domain is always
34639 matched caselessly. The return values are as for &'lss_match_domain()'&.
34640
34641 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34642         uschar&~*list)*&"
34643 This function checks for a match in a host list. The most common usage is
34644 expected to be
34645 .code
34646 lss_match_host(sender_host_name, sender_host_address, ...)
34647 .endd
34648 .vindex "&$sender_host_address$&"
34649 An empty address field matches an empty item in the host list. If the host name
34650 is NULL, the name corresponding to &$sender_host_address$& is automatically
34651 looked up if a host name is required to match an item in the list. The return
34652 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34653 returns ERROR in the case when it had to look up a host name, but the lookup
34654 failed.
34655
34656 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34657         *format,&~...)*&"
34658 This function writes to Exim's log files. The first argument should be zero (it
34659 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34660 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34661 them. It specifies to which log or logs the message is written. The remaining
34662 arguments are a format and relevant insertion arguments. The string should not
34663 contain any newlines, not even at the end.
34664
34665
34666 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34667 This function adds an additional recipient to the message. The first argument
34668 is the recipient address. If it is unqualified (has no domain), it is qualified
34669 with the &%qualify_recipient%& domain. The second argument must always be -1.
34670
34671 This function does not allow you to specify a private &%errors_to%& address (as
34672 described with the structure of &%recipient_item%& above), because it pre-dates
34673 the addition of that field to the structure. However, it is easy to add such a
34674 value afterwards. For example:
34675 .code
34676  receive_add_recipient(US"monitor@mydom.example", -1);
34677  recipients_list[recipients_count-1].errors_to =
34678    US"postmaster@mydom.example";
34679 .endd
34680
34681 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34682 This is a convenience function to remove a named recipient from the list of
34683 recipients. It returns true if a recipient was removed, and false if no
34684 matching recipient could be found. The argument must be a complete email
34685 address.
34686 .endlist
34687
34688
34689 .cindex "RFC 2047"
34690 .vlist
34691 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34692   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34693 This function decodes strings that are encoded according to RFC 2047. Typically
34694 these are the contents of header lines. First, each &"encoded word"& is decoded
34695 from the Q or B encoding into a byte-string. Then, if provided with the name of
34696 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34697 made  to translate the result to the named character set. If this fails, the
34698 binary string is returned with an error message.
34699
34700 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34701 maximum MIME word length is enforced. The third argument is the target
34702 encoding, or NULL if no translation is wanted.
34703
34704 .cindex "binary zero" "in RFC 2047 decoding"
34705 .cindex "RFC 2047" "binary zero in"
34706 If a binary zero is encountered in the decoded string, it is replaced by the
34707 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34708 not be 0 because header lines are handled as zero-terminated strings.
34709
34710 The function returns the result of processing the string, zero-terminated; if
34711 &%lenptr%& is not NULL, the length of the result is set in the variable to
34712 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34713
34714 If an error is encountered, the function returns NULL and uses the &%error%&
34715 argument to return an error message. The variable pointed to by &%error%& is
34716 set to NULL if there is no error; it may be set non-NULL even when the function
34717 returns a non-NULL value if decoding was successful, but there was a problem
34718 with translation.
34719
34720
34721 .vitem &*int&~smtp_fflush(void)*&
34722 This function is used in conjunction with &'smtp_printf()'&, as described
34723 below.
34724
34725 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34726 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34727 output stream. You should use this function only when there is an SMTP output
34728 stream, that is, when the incoming message is being received via interactive
34729 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34730 is FALSE. If you want to test for an incoming message from another host (as
34731 opposed to a local process that used the &%-bs%& command line option), you can
34732 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34733 is involved.
34734
34735 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34736 output function, so it can be used for all forms of SMTP connection.
34737
34738 The second argument is used to request that the data be buffered
34739 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34740 This is advisory only, but likely to save on system-calls and packets
34741 sent when a sequence of calls to the function are made.
34742
34743 The argument was added in Exim version 4.90 - changing the API/ABI.
34744 Nobody noticed until 4.93 was imminent, at which point the
34745 ABI version number was incremented.
34746
34747 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34748 must start with an appropriate response code: 550 if you are going to return
34749 LOCAL_SCAN_REJECT, 451 if you are going to return
34750 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34751 initial lines of a multi-line response, the code must be followed by a hyphen
34752 to indicate that the line is not the final response line. You must also ensure
34753 that the lines you write terminate with CRLF. For example:
34754 .code
34755 smtp_printf("550-this is some extra info\r\n");
34756 return LOCAL_SCAN_REJECT;
34757 .endd
34758 Note that you can also create multi-line responses by including newlines in
34759 the data returned via the &%return_text%& argument. The added value of using
34760 &'smtp_printf()'& is that, for instance, you could introduce delays between
34761 multiple output lines.
34762
34763 The &'smtp_printf()'& function does not return any error indication, because it
34764 does not
34765 guarantee a flush of
34766 pending output, and therefore does not test
34767 the state of the stream. (In the main code of Exim, flushing and error
34768 detection is done when Exim is ready for the next SMTP input command.) If
34769 you want to flush the output and check for an error (for example, the
34770 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34771 arguments. It flushes the output stream, and returns a non-zero value if there
34772 is an error.
34773
34774 .new
34775 .vitem &*void&~*store_get(int,BOOL)*&
34776 This function accesses Exim's internal store (memory) manager. It gets a new
34777 chunk of memory whose size is given by the first argument.
34778 The second argument should be given as TRUE if the memory will be used for
34779 data possibly coming from an attacker (eg. the message content),
34780 FALSE if it is locally-sourced.
34781 Exim bombs out if it ever
34782 runs out of memory. See the next section for a discussion of memory handling.
34783 .wen
34784
34785 .vitem &*void&~*store_get_perm(int,BOOL)*&
34786 This function is like &'store_get()'&, but it always gets memory from the
34787 permanent pool. See the next section for a discussion of memory handling.
34788
34789 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34790 See below.
34791
34792 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34793 See below.
34794
34795 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34796 These three functions create strings using Exim's dynamic memory facilities.
34797 The first makes a copy of an entire string. The second copies up to a maximum
34798 number of characters, indicated by the second argument. The third uses a format
34799 and insertion arguments to create a new string. In each case, the result is a
34800 pointer to a new string in the current memory pool. See the next section for
34801 more discussion.
34802 .endlist
34803
34804
34805
34806 .section "More about Exim's memory handling" "SECTmemhanloc"
34807 .cindex "&[local_scan()]& function" "memory handling"
34808 No function is provided for freeing memory, because that is never needed.
34809 The dynamic memory that Exim uses when receiving a message is automatically
34810 recycled if another message is received by the same process (this applies only
34811 to incoming SMTP connections &-- other input methods can supply only one
34812 message at a time). After receiving the last message, a reception process
34813 terminates.
34814
34815 Because it is recycled, the normal dynamic memory cannot be used for holding
34816 data that must be preserved over a number of incoming messages on the same SMTP
34817 connection. However, Exim in fact uses two pools of dynamic memory; the second
34818 one is not recycled, and can be used for this purpose.
34819
34820 If you want to allocate memory that remains available for subsequent messages
34821 in the same SMTP connection, you should set
34822 .code
34823 store_pool = POOL_PERM
34824 .endd
34825 before calling the function that does the allocation. There is no need to
34826 restore the value if you do not need to; however, if you do want to revert to
34827 the normal pool, you can either restore the previous value of &%store_pool%& or
34828 set it explicitly to POOL_MAIN.
34829
34830 The pool setting applies to all functions that get dynamic memory, including
34831 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34832 There is also a convenience function called &'store_get_perm()'& that gets a
34833 block of memory from the permanent pool while preserving the value of
34834 &%store_pool%&.
34835 .ecindex IIDlosca
34836
34837
34838
34839
34840 . ////////////////////////////////////////////////////////////////////////////
34841 . ////////////////////////////////////////////////////////////////////////////
34842
34843 .chapter "System-wide message filtering" "CHAPsystemfilter"
34844 .scindex IIDsysfil1 "filter" "system filter"
34845 .scindex IIDsysfil2 "filtering all mail"
34846 .scindex IIDsysfil3 "system filter"
34847 The previous chapters (on ACLs and the local scan function) describe checks
34848 that can be applied to messages before they are accepted by a host. There is
34849 also a mechanism for checking messages once they have been received, but before
34850 they are delivered. This is called the &'system filter'&.
34851
34852 The system filter operates in a similar manner to users' filter files, but it
34853 is run just once per message (however many recipients the message has).
34854 It should not normally be used as a substitute for routing, because &%deliver%&
34855 commands in a system router provide new envelope recipient addresses.
34856 The system filter must be an Exim filter. It cannot be a Sieve filter.
34857
34858 The system filter is run at the start of a delivery attempt, before any routing
34859 is done. If a message fails to be completely delivered at the first attempt,
34860 the system filter is run again at the start of every retry.
34861 If you want your filter to do something only once per message, you can make use
34862 of the &%first_delivery%& condition in an &%if%& command in the filter to
34863 prevent it happening on retries.
34864
34865 .vindex "&$domain$&"
34866 .vindex "&$local_part$&"
34867 &*Warning*&: Because the system filter runs just once, variables that are
34868 specific to individual recipient addresses, such as &$local_part$& and
34869 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34870 you want to run a centrally-specified filter for each recipient address
34871 independently, you can do so by setting up a suitable &(redirect)& router, as
34872 described in section &<<SECTperaddfil>>& below.
34873
34874
34875 .section "Specifying a system filter" "SECID212"
34876 .cindex "uid (user id)" "system filter"
34877 .cindex "gid (group id)" "system filter"
34878 The name of the file that contains the system filter must be specified by
34879 setting &%system_filter%&. If you want the filter to run under a uid and gid
34880 other than root, you must also set &%system_filter_user%& and
34881 &%system_filter_group%& as appropriate. For example:
34882 .code
34883 system_filter = /etc/mail/exim.filter
34884 system_filter_user = exim
34885 .endd
34886 If a system filter generates any deliveries directly to files or pipes (via the
34887 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34888 specified by setting &%system_filter_file_transport%& and
34889 &%system_filter_pipe_transport%&, respectively. Similarly,
34890 &%system_filter_reply_transport%& must be set to handle any messages generated
34891 by the &%reply%& command.
34892
34893
34894 .section "Testing a system filter" "SECID213"
34895 You can run simple tests of a system filter in the same way as for a user
34896 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34897 are permitted only in system filters are recognized.
34898
34899 If you want to test the combined effect of a system filter and a user filter,
34900 you can use both &%-bF%& and &%-bf%& on the same command line.
34901
34902
34903
34904 .section "Contents of a system filter" "SECID214"
34905 The language used to specify system filters is the same as for users' filter
34906 files. It is described in the separate end-user document &'Exim's interface to
34907 mail filtering'&. However, there are some additional features that are
34908 available only in system filters; these are described in subsequent sections.
34909 If they are encountered in a user's filter file or when testing with &%-bf%&,
34910 they cause errors.
34911
34912 .cindex "frozen messages" "manual thaw; testing in filter"
34913 There are two special conditions which, though available in users' filter
34914 files, are designed for use in system filters. The condition &%first_delivery%&
34915 is true only for the first attempt at delivering a message, and
34916 &%manually_thawed%& is true only if the message has been frozen, and
34917 subsequently thawed by an admin user. An explicit forced delivery counts as a
34918 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34919
34920 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34921 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34922 succeed, it will not be tried again.
34923 If you want Exim to retry an unseen delivery until it succeeds, you should
34924 arrange to set it up every time the filter runs.
34925
34926 When a system filter finishes running, the values of the variables &$n0$& &--
34927 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34928 users' filter files. Thus a system filter can, for example, set up &"scores"&
34929 to which users' filter files can refer.
34930
34931
34932
34933 .section "Additional variable for system filters" "SECID215"
34934 .vindex "&$recipients$&"
34935 The expansion variable &$recipients$&, containing a list of all the recipients
34936 of the message (separated by commas and white space), is available in system
34937 filters. It is not available in users' filters for privacy reasons.
34938
34939
34940
34941 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34942 .cindex "freezing messages"
34943 .cindex "message" "freezing"
34944 .cindex "message" "forced failure"
34945 .cindex "&%fail%&" "in system filter"
34946 .cindex "&%freeze%& in system filter"
34947 .cindex "&%defer%& in system filter"
34948 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34949 always available in system filters, but are not normally enabled in users'
34950 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34951 for the &(redirect)& router.) These commands can optionally be followed by the
34952 word &%text%& and a string containing an error message, for example:
34953 .code
34954 fail text "this message looks like spam to me"
34955 .endd
34956 The keyword &%text%& is optional if the next character is a double quote.
34957
34958 The &%defer%& command defers delivery of the original recipients of the
34959 message. The &%fail%& command causes all the original recipients to be failed,
34960 and a bounce message to be created. The &%freeze%& command suspends all
34961 delivery attempts for the original recipients. In all cases, any new deliveries
34962 that are specified by the filter are attempted as normal after the filter has
34963 run.
34964
34965 The &%freeze%& command is ignored if the message has been manually unfrozen and
34966 not manually frozen since. This means that automatic freezing by a system
34967 filter can be used as a way of checking out suspicious messages. If a message
34968 is found to be all right, manually unfreezing it allows it to be delivered.
34969
34970 .cindex "log" "&%fail%& command log line"
34971 .cindex "&%fail%&" "log line; reducing"
34972 The text given with a fail command is used as part of the bounce message as
34973 well as being written to the log. If the message is quite long, this can fill
34974 up a lot of log space when such failures are common. To reduce the size of the
34975 log message, Exim interprets the text in a special way if it starts with the
34976 two characters &`<<`& and contains &`>>`& later. The text between these two
34977 strings is written to the log, and the rest of the text is used in the bounce
34978 message. For example:
34979 .code
34980 fail "<<filter test 1>>Your message is rejected \
34981      because it contains attachments that we are \
34982      not prepared to receive."
34983 .endd
34984
34985 .cindex "loop" "caused by &%fail%&"
34986 Take great care with the &%fail%& command when basing the decision to fail on
34987 the contents of the message, because the bounce message will of course include
34988 the contents of the original message and will therefore trigger the &%fail%&
34989 command again (causing a mail loop) unless steps are taken to prevent this.
34990 Testing the &%error_message%& condition is one way to prevent this. You could
34991 use, for example
34992 .code
34993 if $message_body contains "this is spam" and not error_message
34994 then fail text "spam is not wanted here" endif
34995 .endd
34996 though of course that might let through unwanted bounce messages. The
34997 alternative is clever checking of the body and/or headers to detect bounces
34998 generated by the filter.
34999
35000 The interpretation of a system filter file ceases after a
35001 &%defer%&,
35002 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35003 set up earlier in the filter file are honoured, so you can use a sequence such
35004 as
35005 .code
35006 mail ...
35007 freeze
35008 .endd
35009 to send a specified message when the system filter is freezing (or deferring or
35010 failing) a message. The normal deliveries for the message do not, of course,
35011 take place.
35012
35013
35014
35015 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35016 .cindex "header lines" "adding; in system filter"
35017 .cindex "header lines" "removing; in system filter"
35018 .cindex "filter" "header lines; adding/removing"
35019 Two filter commands that are available only in system filters are:
35020 .code
35021 headers add <string>
35022 headers remove <string>
35023 .endd
35024 The argument for the &%headers add%& is a string that is expanded and then
35025 added to the end of the message's headers. It is the responsibility of the
35026 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35027 space is ignored, and if the string is otherwise empty, or if the expansion is
35028 forced to fail, the command has no effect.
35029
35030 You can use &"\n"& within the string, followed by white space, to specify
35031 continued header lines. More than one header may be added in one command by
35032 including &"\n"& within the string without any following white space. For
35033 example:
35034 .code
35035 headers add "X-header-1: ....\n  \
35036              continuation of X-header-1 ...\n\
35037              X-header-2: ...."
35038 .endd
35039 Note that the header line continuation white space after the first newline must
35040 be placed before the backslash that continues the input string, because white
35041 space after input continuations is ignored.
35042
35043 The argument for &%headers remove%& is a colon-separated list of header names.
35044 This command applies only to those headers that are stored with the message;
35045 those that are added at delivery time (such as &'Envelope-To:'& and
35046 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35047 header with the same name, they are all removed.
35048
35049 The &%headers%& command in a system filter makes an immediate change to the set
35050 of header lines that was received with the message (with possible additions
35051 from ACL processing). Subsequent commands in the system filter operate on the
35052 modified set, which also forms the basis for subsequent message delivery.
35053 Unless further modified during routing or transporting, this set of headers is
35054 used for all recipients of the message.
35055
35056 During routing and transporting, the variables that refer to the contents of
35057 header lines refer only to those lines that are in this set. Thus, header lines
35058 that are added by a system filter are visible to users' filter files and to all
35059 routers and transports. This contrasts with the manipulation of header lines by
35060 routers and transports, which is not immediate, but which instead is saved up
35061 until the message is actually being written (see section
35062 &<<SECTheadersaddrem>>&).
35063
35064 If the message is not delivered at the first attempt, header lines that were
35065 added by the system filter are stored with the message, and so are still
35066 present at the next delivery attempt. Header lines that were removed are still
35067 present, but marked &"deleted"& so that they are not transported with the
35068 message. For this reason, it is usual to make the &%headers%& command
35069 conditional on &%first_delivery%& so that the set of header lines is not
35070 modified more than once.
35071
35072 Because header modification in a system filter acts immediately, you have to
35073 use an indirect approach if you want to modify the contents of a header line.
35074 For example:
35075 .code
35076 headers add "Old-Subject: $h_subject:"
35077 headers remove "Subject"
35078 headers add "Subject: new subject (was: $h_old-subject:)"
35079 headers remove "Old-Subject"
35080 .endd
35081
35082
35083
35084 .section "Setting an errors address in a system filter" "SECID217"
35085 .cindex "envelope from"
35086 .cindex "envelope sender"
35087 In a system filter, if a &%deliver%& command is followed by
35088 .code
35089 errors_to <some address>
35090 .endd
35091 in order to change the envelope sender (and hence the error reporting) for that
35092 delivery, any address may be specified. (In a user filter, only the current
35093 user's address can be set.) For example, if some mail is being monitored, you
35094 might use
35095 .code
35096 unseen deliver monitor@spying.example errors_to root@local.example
35097 .endd
35098 to take a copy which would not be sent back to the normal error reporting
35099 address if its delivery failed.
35100
35101
35102
35103 .section "Per-address filtering" "SECTperaddfil"
35104 .vindex "&$domain$&"
35105 .vindex "&$local_part$&"
35106 In contrast to the system filter, which is run just once per message for each
35107 delivery attempt, it is also possible to set up a system-wide filtering
35108 operation that runs once for each recipient address. In this case, variables
35109 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
35110 filter file could be made dependent on them. This is an example of a router
35111 which implements such a filter:
35112 .code
35113 central_filter:
35114   check_local_user
35115   driver = redirect
35116   domains = +local_domains
35117   file = /central/filters/$local_part
35118   no_verify
35119   allow_filter
35120   allow_freeze
35121 .endd
35122 The filter is run in a separate process under its own uid. Therefore, either
35123 &%check_local_user%& must be set (as above), in which case the filter is run as
35124 the local user, or the &%user%& option must be used to specify which user to
35125 use. If both are set, &%user%& overrides.
35126
35127 Care should be taken to ensure that none of the commands in the filter file
35128 specify a significant delivery if the message is to go on to be delivered to
35129 its intended recipient. The router will not then claim to have dealt with the
35130 address, so it will be passed on to subsequent routers to be delivered in the
35131 normal way.
35132 .ecindex IIDsysfil1
35133 .ecindex IIDsysfil2
35134 .ecindex IIDsysfil3
35135
35136
35137
35138
35139
35140
35141 . ////////////////////////////////////////////////////////////////////////////
35142 . ////////////////////////////////////////////////////////////////////////////
35143
35144 .chapter "Message processing" "CHAPmsgproc"
35145 .scindex IIDmesproc "message" "general processing"
35146 Exim performs various transformations on the sender and recipient addresses of
35147 all messages that it handles, and also on the messages' header lines. Some of
35148 these are optional and configurable, while others always take place. All of
35149 this processing, except rewriting as a result of routing, and the addition or
35150 removal of header lines while delivering, happens when a message is received,
35151 before it is placed on Exim's queue.
35152
35153 Some of the automatic processing takes place by default only for
35154 &"locally-originated"& messages. This adjective is used to describe messages
35155 that are not received over TCP/IP, but instead are passed to an Exim process on
35156 its standard input. This includes the interactive &"local SMTP"& case that is
35157 set up by the &%-bs%& command line option.
35158
35159 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35160 or ::1) are not considered to be locally-originated. Exim does not treat the
35161 loopback interface specially in any way.
35162
35163 If you want the loopback interface to be treated specially, you must ensure
35164 that there are appropriate entries in your ACLs.
35165
35166
35167
35168
35169 .section "Submission mode for non-local messages" "SECTsubmodnon"
35170 .cindex "message" "submission"
35171 .cindex "submission mode"
35172 Processing that happens automatically for locally-originated messages (unless
35173 &%suppress_local_fixups%& is set) can also be requested for messages that are
35174 received over TCP/IP. The term &"submission mode"& is used to describe this
35175 state. Submission mode is set by the modifier
35176 .code
35177 control = submission
35178 .endd
35179 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35180 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35181 a local submission, and is normally used when the source of the message is
35182 known to be an MUA running on a client host (as opposed to an MTA). For
35183 example, to set submission mode for messages originating on the IPv4 loopback
35184 interface, you could include the following in the MAIL ACL:
35185 .code
35186 warn  hosts = 127.0.0.1
35187       control = submission
35188 .endd
35189 .cindex "&%sender_retain%& submission option"
35190 There are some options that can be used when setting submission mode. A slash
35191 is used to separate options. For example:
35192 .code
35193 control = submission/sender_retain
35194 .endd
35195 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35196 true and &%local_from_check%& false for the current incoming message. The first
35197 of these allows an existing &'Sender:'& header in the message to remain, and
35198 the second suppresses the check to ensure that &'From:'& matches the
35199 authenticated sender. With this setting, Exim still fixes up messages by adding
35200 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35201 attempt to check sender authenticity in header lines.
35202
35203 When &%sender_retain%& is not set, a submission mode setting may specify a
35204 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35205 example:
35206 .code
35207 control = submission/domain=some.domain
35208 .endd
35209 The domain may be empty. How this value is used is described in sections
35210 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35211 that allows you to specify the user's full name for inclusion in a created
35212 &'Sender:'& or &'From:'& header line. For example:
35213 .code
35214 accept authenticated = *
35215        control = submission/domain=wonderland.example/\
35216                             name=${lookup {$authenticated_id} \
35217                                    lsearch {/etc/exim/namelist}}
35218 .endd
35219 Because the name may contain any characters, including slashes, the &%name%&
35220 option must be given last. The remainder of the string is used as the name. For
35221 the example above, if &_/etc/exim/namelist_& contains:
35222 .code
35223 bigegg:  Humpty Dumpty
35224 .endd
35225 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35226 line would be:
35227 .code
35228 Sender: Humpty Dumpty <bigegg@wonderland.example>
35229 .endd
35230 .cindex "return path" "in submission mode"
35231 By default, submission mode forces the return path to the same address as is
35232 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35233 specified, the return path is also left unchanged.
35234
35235 &*Note*&: The changes caused by submission mode take effect after the predata
35236 ACL. This means that any sender checks performed before the fix-ups use the
35237 untrusted sender address specified by the user, not the trusted sender address
35238 specified by submission mode. Although this might be slightly unexpected, it
35239 does mean that you can configure ACL checks to spot that a user is trying to
35240 spoof another's address.
35241
35242 .section "Line endings" "SECTlineendings"
35243 .cindex "line endings"
35244 .cindex "carriage return"
35245 .cindex "linefeed"
35246 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35247 linefeed) is the line ending for messages transmitted over the Internet using
35248 SMTP over TCP/IP. However, within individual operating systems, different
35249 conventions are used. For example, Unix-like systems use just LF, but others
35250 use CRLF or just CR.
35251
35252 Exim was designed for Unix-like systems, and internally, it stores messages
35253 using the system's convention of a single LF as a line terminator. When
35254 receiving a message, all line endings are translated to this standard format.
35255 Originally, it was thought that programs that passed messages directly to an
35256 MTA within an operating system would use that system's convention. Experience
35257 has shown that this is not the case; for example, there are Unix applications
35258 that use CRLF in this circumstance. For this reason, and for compatibility with
35259 other MTAs, the way Exim handles line endings for all messages is now as
35260 follows:
35261
35262 .ilist
35263 LF not preceded by CR is treated as a line ending.
35264 .next
35265 CR is treated as a line ending; if it is immediately followed by LF, the LF
35266 is ignored.
35267 .next
35268 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35269 nor a local message in the state where a line containing only a dot is a
35270 terminator.
35271 .next
35272 If a bare CR is encountered within a header line, an extra space is added after
35273 the line terminator so as not to end the header line. The reasoning behind this
35274 is that bare CRs in header lines are most likely either to be mistakes, or
35275 people trying to play silly games.
35276 .next
35277 If the first header line received in a message ends with CRLF, a subsequent
35278 bare LF in a header line is treated in the same way as a bare CR in a header
35279 line.
35280 .endlist
35281
35282
35283
35284
35285
35286 .section "Unqualified addresses" "SECID218"
35287 .cindex "unqualified addresses"
35288 .cindex "address" "qualification"
35289 By default, Exim expects every envelope address it receives from an external
35290 host to be fully qualified. Unqualified addresses cause negative responses to
35291 SMTP commands. However, because SMTP is used as a means of transporting
35292 messages from MUAs running on personal workstations, there is sometimes a
35293 requirement to accept unqualified addresses from specific hosts or IP networks.
35294
35295 Exim has two options that separately control which hosts may send unqualified
35296 sender or recipient addresses in SMTP commands, namely
35297 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35298 cases, if an unqualified address is accepted, it is qualified by adding the
35299 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35300
35301 .oindex "&%qualify_domain%&"
35302 .oindex "&%qualify_recipient%&"
35303 Unqualified addresses in header lines are automatically qualified for messages
35304 that are locally originated, unless the &%-bnq%& option is given on the command
35305 line. For messages received over SMTP, unqualified addresses in header lines
35306 are qualified only if unqualified addresses are permitted in SMTP commands. In
35307 other words, such qualification is also controlled by
35308 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35309
35310
35311
35312
35313 .section "The UUCP From line" "SECID219"
35314 .cindex "&""From""& line"
35315 .cindex "UUCP" "&""From""& line"
35316 .cindex "sender" "address"
35317 .oindex "&%uucp_from_pattern%&"
35318 .oindex "&%uucp_from_sender%&"
35319 .cindex "envelope from"
35320 .cindex "envelope sender"
35321 .cindex "Sendmail compatibility" "&""From""& line"
35322 Messages that have come from UUCP (and some other applications) often begin
35323 with a line containing the envelope sender and a timestamp, following the word
35324 &"From"&. Examples of two common formats are:
35325 .code
35326 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35327 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35328 .endd
35329 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35330 Exim recognizes such lines at the start of messages that are submitted to it
35331 via the command line (that is, on the standard input). It does not recognize
35332 such lines in incoming SMTP messages, unless the sending host matches
35333 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35334 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35335 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35336 default value matches the two common cases shown above and puts the address
35337 that follows &"From"& into &$1$&.
35338
35339 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35340 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35341 a trusted user, the message's sender address is constructed by expanding the
35342 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35343 then parsed as an RFC 2822 address. If there is no domain, the local part is
35344 qualified with &%qualify_domain%& unless it is the empty string. However, if
35345 the command line &%-f%& option is used, it overrides the &"From"& line.
35346
35347 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35348 sender address is not changed. This is also the case for incoming SMTP messages
35349 that are permitted to contain &"From"& lines.
35350
35351 Only one &"From"& line is recognized. If there is more than one, the second is
35352 treated as a data line that starts the body of the message, as it is not valid
35353 as a header line. This also happens if a &"From"& line is present in an
35354 incoming SMTP message from a source that is not permitted to send them.
35355
35356
35357
35358 .section "Resent- header lines" "SECID220"
35359 .cindex "&%Resent-%& header lines"
35360 .cindex "header lines" "Resent-"
35361 RFC 2822 makes provision for sets of header lines starting with the string
35362 &`Resent-`& to be added to a message when it is resent by the original
35363 recipient to somebody else. These headers are &'Resent-Date:'&,
35364 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35365 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35366
35367 .blockquote
35368 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35369 processing of replies or other such automatic actions on messages.'&
35370 .endblockquote
35371
35372 This leaves things a bit vague as far as other processing actions such as
35373 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35374 follows:
35375
35376 .ilist
35377 A &'Resent-From:'& line that just contains the login id of the submitting user
35378 is automatically rewritten in the same way as &'From:'& (see below).
35379 .next
35380 If there's a rewriting rule for a particular header line, it is also applied to
35381 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35382 &'From:'& also rewrites &'Resent-From:'&.
35383 .next
35384 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35385 also removed.
35386 .next
35387 For a locally-submitted message,
35388 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35389 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35390 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35391 included in log lines in this case.
35392 .next
35393 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35394 &%Resent-%& header lines are present.
35395 .endlist
35396
35397
35398
35399
35400 .section "The Auto-Submitted: header line" "SECID221"
35401 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35402 includes the header line:
35403 .code
35404 Auto-Submitted: auto-replied
35405 .endd
35406
35407 .section "The Bcc: header line" "SECID222"
35408 .cindex "&'Bcc:'& header line"
35409 If Exim is called with the &%-t%& option, to take recipient addresses from a
35410 message's header, it removes any &'Bcc:'& header line that may exist (after
35411 extracting its addresses). If &%-t%& is not present on the command line, any
35412 existing &'Bcc:'& is not removed.
35413
35414
35415 .section "The Date: header line" "SECID223"
35416 .cindex "&'Date:'& header line"
35417 .cindex "header lines" "Date:"
35418 If a locally-generated or submission-mode message has no &'Date:'& header line,
35419 Exim adds one, using the current date and time, unless the
35420 &%suppress_local_fixups%& control has been specified.
35421
35422 .section "The Delivery-date: header line" "SECID224"
35423 .cindex "&'Delivery-date:'& header line"
35424 .oindex "&%delivery_date_remove%&"
35425 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35426 set. Exim can be configured to add them to the final delivery of messages. (See
35427 the generic &%delivery_date_add%& transport option.) They should not be present
35428 in messages in transit. If the &%delivery_date_remove%& configuration option is
35429 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35430 messages.
35431
35432
35433 .section "The Envelope-to: header line" "SECID225"
35434 .cindex "&'Envelope-to:'& header line"
35435 .cindex "header lines" "Envelope-to:"
35436 .oindex "&%envelope_to_remove%&"
35437 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35438 Exim can be configured to add them to the final delivery of messages. (See the
35439 generic &%envelope_to_add%& transport option.) They should not be present in
35440 messages in transit. If the &%envelope_to_remove%& configuration option is set
35441 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35442 messages.
35443
35444
35445 .section "The From: header line" "SECTthefrohea"
35446 .cindex "&'From:'& header line"
35447 .cindex "header lines" "From:"
35448 .cindex "Sendmail compatibility" "&""From""& line"
35449 .cindex "message" "submission"
35450 .cindex "submission mode"
35451 If a submission-mode message does not contain a &'From:'& header line, Exim
35452 adds one if either of the following conditions is true:
35453
35454 .ilist
35455 The envelope sender address is not empty (that is, this is not a bounce
35456 message). The added header line copies the envelope sender address.
35457 .next
35458 .vindex "&$authenticated_id$&"
35459 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35460 .olist
35461 .vindex "&$qualify_domain$&"
35462 If no domain is specified by the submission control, the local part is
35463 &$authenticated_id$& and the domain is &$qualify_domain$&.
35464 .next
35465 If a non-empty domain is specified by the submission control, the local
35466 part is &$authenticated_id$&, and the domain is the specified domain.
35467 .next
35468 If an empty domain is specified by the submission control,
35469 &$authenticated_id$& is assumed to be the complete address.
35470 .endlist
35471 .endlist
35472
35473 A non-empty envelope sender takes precedence.
35474
35475 If a locally-generated incoming message does not contain a &'From:'& header
35476 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35477 containing the sender's address. The calling user's login name and full name
35478 are used to construct the address, as described in section &<<SECTconstr>>&.
35479 They are obtained from the password data by calling &[getpwuid()]& (but see the
35480 &%unknown_login%& configuration option). The address is qualified with
35481 &%qualify_domain%&.
35482
35483 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35484 &'From:'& header line containing just the unqualified login name of the calling
35485 user, this is replaced by an address containing the user's login name and full
35486 name as described in section &<<SECTconstr>>&.
35487
35488
35489 .section "The Message-ID: header line" "SECID226"
35490 .cindex "&'Message-ID:'& header line"
35491 .cindex "header lines" "Message-ID:"
35492 .cindex "message" "submission"
35493 .oindex "&%message_id_header_text%&"
35494 If a locally-generated or submission-mode incoming message does not contain a
35495 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35496 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35497 to the message. If there are any &'Resent-:'& headers in the message, it
35498 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35499 message id, preceded by the letter E to ensure it starts with a letter, and
35500 followed by @ and the primary host name. Additional information can be included
35501 in this header line by setting the &%message_id_header_text%& and/or
35502 &%message_id_header_domain%& options.
35503
35504
35505 .section "The Received: header line" "SECID227"
35506 .cindex "&'Received:'& header line"
35507 .cindex "header lines" "Received:"
35508 A &'Received:'& header line is added at the start of every message. The
35509 contents are defined by the &%received_header_text%& configuration option, and
35510 Exim automatically adds a semicolon and a timestamp to the configured string.
35511
35512 The &'Received:'& header is generated as soon as the message's header lines
35513 have been received. At this stage, the timestamp in the &'Received:'& header
35514 line is the time that the message started to be received. This is the value
35515 that is seen by the DATA ACL and by the &[local_scan()]& function.
35516
35517 Once a message is accepted, the timestamp in the &'Received:'& header line is
35518 changed to the time of acceptance, which is (apart from a small delay while the
35519 -H spool file is written) the earliest time at which delivery could start.
35520
35521
35522 .section "The References: header line" "SECID228"
35523 .cindex "&'References:'& header line"
35524 .cindex "header lines" "References:"
35525 Messages created by the &(autoreply)& transport include a &'References:'&
35526 header line. This is constructed according to the rules that are described in
35527 section 3.64 of RFC 2822 (which states that replies should contain such a
35528 header line), and section 3.14 of RFC 3834 (which states that automatic
35529 responses are not different in this respect). However, because some mail
35530 processing software does not cope well with very long header lines, no more
35531 than 12 message IDs are copied from the &'References:'& header line in the
35532 incoming message. If there are more than 12, the first one and then the final
35533 11 are copied, before adding the message ID of the incoming message.
35534
35535
35536
35537 .section "The Return-path: header line" "SECID229"
35538 .cindex "&'Return-path:'& header line"
35539 .cindex "header lines" "Return-path:"
35540 .oindex "&%return_path_remove%&"
35541 &'Return-path:'& header lines are defined as something an MTA may insert when
35542 it does the final delivery of messages. (See the generic &%return_path_add%&
35543 transport option.) Therefore, they should not be present in messages in
35544 transit. If the &%return_path_remove%& configuration option is set (the
35545 default), Exim removes &'Return-path:'& header lines from incoming messages.
35546
35547
35548
35549 .section "The Sender: header line" "SECTthesenhea"
35550 .cindex "&'Sender:'& header line"
35551 .cindex "message" "submission"
35552 .cindex "header lines" "Sender:"
35553 For a locally-originated message from an untrusted user, Exim may remove an
35554 existing &'Sender:'& header line, and it may add a new one. You can modify
35555 these actions by setting the &%local_sender_retain%& option true, the
35556 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35557 control setting.
35558
35559 When a local message is received from an untrusted user and
35560 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35561 control has not been set, a check is made to see if the address given in the
35562 &'From:'& header line is the correct (local) sender of the message. The address
35563 that is expected has the login name as the local part and the value of
35564 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35565 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35566 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35567 line is added to the message.
35568
35569 If you set &%local_from_check%& false, this checking does not occur. However,
35570 the removal of an existing &'Sender:'& line still happens, unless you also set
35571 &%local_sender_retain%& to be true. It is not possible to set both of these
35572 options true at the same time.
35573
35574 .cindex "submission mode"
35575 By default, no processing of &'Sender:'& header lines is done for messages
35576 received over TCP/IP or for messages submitted by trusted users. However, when
35577 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35578 not specified on the submission control, the following processing takes place:
35579
35580 .vindex "&$authenticated_id$&"
35581 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35582 authenticated, and &$authenticated_id$& is not empty, a sender address is
35583 created as follows:
35584
35585 .ilist
35586 .vindex "&$qualify_domain$&"
35587 If no domain is specified by the submission control, the local part is
35588 &$authenticated_id$& and the domain is &$qualify_domain$&.
35589 .next
35590 If a non-empty domain is specified by the submission control, the local part
35591 is &$authenticated_id$&, and the domain is the specified domain.
35592 .next
35593 If an empty domain is specified by the submission control,
35594 &$authenticated_id$& is assumed to be the complete address.
35595 .endlist
35596
35597 This address is compared with the address in the &'From:'& header line. If they
35598 are different, a &'Sender:'& header line containing the created address is
35599 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35600 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35601
35602 .cindex "return path" "created from &'Sender:'&"
35603 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35604 the message (the envelope sender address) is changed to be the same address,
35605 except in the case of submission mode when &%sender_retain%& is specified.
35606
35607
35608
35609 .section "Adding and removing header lines in routers and transports" &&&
35610          "SECTheadersaddrem"
35611 .cindex "header lines" "adding; in router or transport"
35612 .cindex "header lines" "removing; in router or transport"
35613 When a message is delivered, the addition and removal of header lines can be
35614 specified in a system filter, or on any of the routers and transports that
35615 process the message. Section &<<SECTaddremheasys>>& contains details about
35616 modifying headers in a system filter. Header lines can also be added in an ACL
35617 as a message is received (see section &<<SECTaddheadacl>>&).
35618
35619 In contrast to what happens in a system filter, header modifications that are
35620 specified on routers and transports apply only to the particular recipient
35621 addresses that are being processed by those routers and transports. These
35622 changes do not actually take place until a copy of the message is being
35623 transported. Therefore, they do not affect the basic set of header lines, and
35624 they do not affect the values of the variables that refer to header lines.
35625
35626 &*Note*&: In particular, this means that any expansions in the configuration of
35627 the transport cannot refer to the modified header lines, because such
35628 expansions all occur before the message is actually transported.
35629
35630 For both routers and transports, the argument of a &%headers_add%&
35631 option must be in the form of one or more RFC 2822 header lines, separated by
35632 newlines (coded as &"\n"&). For example:
35633 .code
35634 headers_add = X-added-header: added by $primary_hostname\n\
35635               X-added-second: another added header line
35636 .endd
35637 Exim does not check the syntax of these added header lines.
35638
35639 Multiple &%headers_add%& options for a single router or transport can be
35640 specified; the values will append to a single list of header lines.
35641 Each header-line is separately expanded.
35642
35643 The argument of a &%headers_remove%& option must consist of a colon-separated
35644 list of header names. This is confusing, because header names themselves are
35645 often terminated by colons. In this case, the colons are the list separators,
35646 not part of the names. For example:
35647 .code
35648 headers_remove = return-receipt-to:acknowledge-to
35649 .endd
35650
35651 Multiple &%headers_remove%& options for a single router or transport can be
35652 specified; the arguments will append to a single header-names list.
35653 Each item is separately expanded.
35654 Note that colons in complex expansions which are used to
35655 form all or part of a &%headers_remove%& list
35656 will act as list separators.
35657
35658 When &%headers_add%& or &%headers_remove%& is specified on a router,
35659 items are expanded at routing time,
35660 and then associated with all addresses that are
35661 accepted by that router, and also with any new addresses that it generates. If
35662 an address passes through several routers as a result of aliasing or
35663 forwarding, the changes are cumulative.
35664
35665 .oindex "&%unseen%&"
35666 However, this does not apply to multiple routers that result from the use of
35667 the &%unseen%& option. Any header modifications that were specified by the
35668 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35669
35670 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35671 settings cannot be delivered together in a batch, so a transport is always
35672 dealing with a set of addresses that have the same header-processing
35673 requirements.
35674
35675 The transport starts by writing the original set of header lines that arrived
35676 with the message, possibly modified by the system filter. As it writes out
35677 these lines, it consults the list of header names that were attached to the
35678 recipient address(es) by &%headers_remove%& options in routers, and it also
35679 consults the transport's own &%headers_remove%& option. Header lines whose
35680 names are on either of these lists are not written out. If there are multiple
35681 instances of any listed header, they are all skipped.
35682
35683 After the remaining original header lines have been written, new header
35684 lines that were specified by routers' &%headers_add%& options are written, in
35685 the order in which they were attached to the address. These are followed by any
35686 header lines specified by the transport's &%headers_add%& option.
35687
35688 This way of handling header line modifications in routers and transports has
35689 the following consequences:
35690
35691 .ilist
35692 The original set of header lines, possibly modified by the system filter,
35693 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35694 to it, at all times.
35695 .next
35696 Header lines that are added by a router's
35697 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35698 expansion syntax in subsequent routers or the transport.
35699 .next
35700 Conversely, header lines that are specified for removal by &%headers_remove%&
35701 in a router remain visible to subsequent routers and the transport.
35702 .next
35703 Headers added to an address by &%headers_add%& in a router cannot be removed by
35704 a later router or by a transport.
35705 .next
35706 An added header can refer to the contents of an original header that is to be
35707 removed, even it has the same name as the added header. For example:
35708 .code
35709 headers_remove = subject
35710 headers_add = Subject: new subject (was: $h_subject:)
35711 .endd
35712 .endlist
35713
35714 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35715 for a &(redirect)& router that has the &%one_time%& option set.
35716
35717
35718
35719
35720
35721 .section "Constructed addresses" "SECTconstr"
35722 .cindex "address" "constructed"
35723 .cindex "constructed address"
35724 When Exim constructs a sender address for a locally-generated message, it uses
35725 the form
35726 .display
35727 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35728 .endd
35729 For example:
35730 .code
35731 Zaphod Beeblebrox <zaphod@end.univ.example>
35732 .endd
35733 The user name is obtained from the &%-F%& command line option if set, or
35734 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35735 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35736 ampersand character, this is replaced by the login name with the first letter
35737 upper cased, as is conventional in a number of operating systems. See the
35738 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35739 The &%unknown_username%& option can be used to specify user names in cases when
35740 there is no password file entry.
35741
35742 .cindex "RFC 2047"
35743 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35744 parts of it if necessary. In addition, if it contains any non-printing
35745 characters, it is encoded as described in RFC 2047, which defines a way of
35746 including non-ASCII characters in header lines. The value of the
35747 &%headers_charset%& option specifies the name of the encoding that is used (the
35748 characters are assumed to be in this encoding). The setting of
35749 &%print_topbitchars%& controls whether characters with the top bit set (that
35750 is, with codes greater than 127) count as printing characters or not.
35751
35752
35753
35754 .section "Case of local parts" "SECID230"
35755 .cindex "case of local parts"
35756 .cindex "local part" "case of"
35757 RFC 2822 states that the case of letters in the local parts of addresses cannot
35758 be assumed to be non-significant. Exim preserves the case of local parts of
35759 addresses, but by default it uses a lower-cased form when it is routing,
35760 because on most Unix systems, usernames are in lower case and case-insensitive
35761 routing is required. However, any particular router can be made to use the
35762 original case for local parts by setting the &%caseful_local_part%& generic
35763 router option.
35764
35765 .cindex "mixed-case login names"
35766 If you must have mixed-case user names on your system, the best way to proceed,
35767 assuming you want case-independent handling of incoming email, is to set up
35768 your first router to convert incoming local parts in your domains to the
35769 correct case by means of a file lookup. For example:
35770 .code
35771 correct_case:
35772   driver = redirect
35773   domains = +local_domains
35774   data = ${lookup{$local_part}cdb\
35775               {/etc/usercased.cdb}{$value}fail}\
35776               @$domain
35777 .endd
35778 For this router, the local part is forced to lower case by the default action
35779 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35780 up a new local part in the correct case. If you then set &%caseful_local_part%&
35781 on any subsequent routers which process your domains, they will operate on
35782 local parts with the correct case in a case-sensitive manner.
35783
35784
35785
35786 .section "Dots in local parts" "SECID231"
35787 .cindex "dot" "in local part"
35788 .cindex "local part" "dots in"
35789 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35790 part may not begin or end with a dot, nor have two consecutive dots in the
35791 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35792 empty components for compatibility.
35793
35794
35795
35796 .section "Rewriting addresses" "SECID232"
35797 .cindex "rewriting" "addresses"
35798 Rewriting of sender and recipient addresses, and addresses in headers, can
35799 happen automatically, or as the result of configuration options, as described
35800 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35801 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35802
35803 Automatic rewriting includes qualification, as mentioned above. The other case
35804 in which it can happen is when an incomplete non-local domain is given. The
35805 routing process may cause this to be expanded into the full domain name. For
35806 example, a header such as
35807 .code
35808 To: hare@teaparty
35809 .endd
35810 might get rewritten as
35811 .code
35812 To: hare@teaparty.wonderland.fict.example
35813 .endd
35814 Rewriting as a result of routing is the one kind of message processing that
35815 does not happen at input time, as it cannot be done until the address has
35816 been routed.
35817
35818 Strictly, one should not do &'any'& deliveries of a message until all its
35819 addresses have been routed, in case any of the headers get changed as a
35820 result of routing. However, doing this in practice would hold up many
35821 deliveries for unreasonable amounts of time, just because one address could not
35822 immediately be routed. Exim therefore does not delay other deliveries when
35823 routing of one or more addresses is deferred.
35824 .ecindex IIDmesproc
35825
35826
35827
35828 . ////////////////////////////////////////////////////////////////////////////
35829 . ////////////////////////////////////////////////////////////////////////////
35830
35831 .chapter "SMTP processing" "CHAPSMTP"
35832 .scindex IIDsmtpproc1 "SMTP" "processing details"
35833 .scindex IIDsmtpproc2 "LMTP" "processing details"
35834 Exim supports a number of different ways of using the SMTP protocol, and its
35835 LMTP variant, which is an interactive protocol for transferring messages into a
35836 closed mail store application. This chapter contains details of how SMTP is
35837 processed. For incoming mail, the following are available:
35838
35839 .ilist
35840 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35841 .next
35842 SMTP over the standard input and output (the &%-bs%& option);
35843 .next
35844 Batched SMTP on the standard input (the &%-bS%& option).
35845 .endlist
35846
35847 For mail delivery, the following are available:
35848
35849 .ilist
35850 SMTP over TCP/IP (the &(smtp)& transport);
35851 .next
35852 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35853 &"lmtp"&);
35854 .next
35855 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35856 transport);
35857 .next
35858 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35859 the &%use_bsmtp%& option set).
35860 .endlist
35861
35862 &'Batched SMTP'& is the name for a process in which batches of messages are
35863 stored in or read from files (or pipes), in a format in which SMTP commands are
35864 used to contain the envelope information.
35865
35866
35867
35868 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35869 .cindex "SMTP" "outgoing over TCP/IP"
35870 .cindex "outgoing SMTP over TCP/IP"
35871 .cindex "LMTP" "over TCP/IP"
35872 .cindex "outgoing LMTP over TCP/IP"
35873 .cindex "EHLO"
35874 .cindex "HELO"
35875 .cindex "SIZE option on MAIL command"
35876 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35877 The &%protocol%& option selects which protocol is to be used, but the actual
35878 processing is the same in both cases.
35879
35880 If, in response to its EHLO command, Exim is told that the SIZE
35881 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35882 command. The value of <&'n'&> is the message size plus the value of the
35883 &%size_addition%& option (default 1024) to allow for additions to the message
35884 such as per-transport header lines, or changes made in a
35885 .cindex "transport" "filter"
35886 .cindex "filter" "transport filter"
35887 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35888 suppressed.
35889
35890 If the remote server advertises support for PIPELINING, Exim uses the
35891 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35892 required for the transaction.
35893
35894 If the remote server advertises support for the STARTTLS command, and Exim
35895 was built to support TLS encryption, it tries to start a TLS session unless the
35896 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35897 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35898 is called for verification.
35899
35900 If the remote server advertises support for the AUTH command, Exim scans
35901 the authenticators configuration for any suitable client settings, as described
35902 in chapter &<<CHAPSMTPAUTH>>&.
35903
35904 .cindex "carriage return"
35905 .cindex "linefeed"
35906 Responses from the remote host are supposed to be terminated by CR followed by
35907 LF. However, there are known to be hosts that do not send CR characters, so in
35908 order to be able to interwork with such hosts, Exim treats LF on its own as a
35909 line terminator.
35910
35911 If a message contains a number of different addresses, all those with the same
35912 characteristics (for example, the same envelope sender) that resolve to the
35913 same set of hosts, in the same order, are sent in a single SMTP transaction,
35914 even if they are for different domains, unless there are more than the setting
35915 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35916 they are split into groups containing no more than &%max_rcpt%&s addresses
35917 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35918 in parallel sessions. The order of hosts with identical MX values is not
35919 significant when checking whether addresses can be batched in this way.
35920
35921 When the &(smtp)& transport suffers a temporary failure that is not
35922 message-related, Exim updates its transport-specific database, which contains
35923 records indexed by host name that remember which messages are waiting for each
35924 particular host. It also updates the retry database with new retry times.
35925
35926 .cindex "hints database" "retry keys"
35927 Exim's retry hints are based on host name plus IP address, so if one address of
35928 a multi-homed host is broken, it will soon be skipped most of the time.
35929 See the next section for more detail about error handling.
35930
35931 .cindex "SMTP" "passed connection"
35932 .cindex "SMTP" "batching over TCP/IP"
35933 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35934 looks in the hints database for the transport to see if there are any queued
35935 messages waiting for the host to which it is connected. If it finds one, it
35936 creates a new Exim process using the &%-MC%& option (which can only be used by
35937 a process running as root or the Exim user) and passes the TCP/IP socket to it
35938 so that it can deliver another message using the same socket. The new process
35939 does only those deliveries that are routed to the connected host, and may in
35940 turn pass the socket on to a third process, and so on.
35941
35942 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35943 limit the number of messages sent down a single TCP/IP connection.
35944
35945 .cindex "asterisk" "after IP address"
35946 The second and subsequent messages delivered down an existing connection are
35947 identified in the main log by the addition of an asterisk after the closing
35948 square bracket of the IP address.
35949
35950
35951
35952
35953 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35954 .cindex "error" "in outgoing SMTP"
35955 .cindex "SMTP" "errors in outgoing"
35956 .cindex "host" "error"
35957 Three different kinds of error are recognized for outgoing SMTP: host errors,
35958 message errors, and recipient errors.
35959
35960 .vlist
35961 .vitem "&*Host errors*&"
35962 A host error is not associated with a particular message or with a
35963 particular recipient of a message. The host errors are:
35964
35965 .ilist
35966 Connection refused or timed out,
35967 .next
35968 Any error response code on connection,
35969 .next
35970 Any error response code to EHLO or HELO,
35971 .next
35972 Loss of connection at any time, except after &"."&,
35973 .next
35974 I/O errors at any time,
35975 .next
35976 Timeouts during the session, other than in response to MAIL, RCPT or
35977 the &"."& at the end of the data.
35978 .endlist ilist
35979
35980 For a host error, a permanent error response on connection, or in response to
35981 EHLO, causes all addresses routed to the host to be failed. Any other host
35982 error causes all addresses to be deferred, and retry data to be created for the
35983 host. It is not tried again, for any message, until its retry time arrives. If
35984 the current set of addresses are not all delivered in this run (to some
35985 alternative host), the message is added to the list of those waiting for this
35986 host, so if it is still undelivered when a subsequent successful delivery is
35987 made to the host, it will be sent down the same SMTP connection.
35988
35989 .vitem "&*Message errors*&"
35990 .cindex "message" "error"
35991 A message error is associated with a particular message when sent to a
35992 particular host, but not with a particular recipient of the message. The
35993 message errors are:
35994
35995 .ilist
35996 Any error response code to MAIL, DATA, or the &"."& that terminates
35997 the data,
35998 .next
35999 Timeout after MAIL,
36000 .next
36001 Timeout or loss of connection after the &"."& that terminates the data. A
36002 timeout after the DATA command itself is treated as a host error, as is loss of
36003 connection at any other time.
36004 .endlist ilist
36005
36006 For a message error, a permanent error response (5&'xx'&) causes all addresses
36007 to be failed, and a delivery error report to be returned to the sender. A
36008 temporary error response (4&'xx'&), or one of the timeouts, causes all
36009 addresses to be deferred. Retry data is not created for the host, but instead,
36010 a retry record for the combination of host plus message id is created. The
36011 message is not added to the list of those waiting for this host. This ensures
36012 that the failing message will not be sent to this host again until the retry
36013 time arrives. However, other messages that are routed to the host are not
36014 affected, so if it is some property of the message that is causing the error,
36015 it will not stop the delivery of other mail.
36016
36017 If the remote host specified support for the SIZE parameter in its response
36018 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36019 over-large message will cause a message error because the error arrives as a
36020 response to MAIL.
36021
36022 .vitem "&*Recipient errors*&"
36023 .cindex "recipient" "error"
36024 A recipient error is associated with a particular recipient of a message. The
36025 recipient errors are:
36026
36027 .ilist
36028 Any error response to RCPT,
36029 .next
36030 Timeout after RCPT.
36031 .endlist
36032
36033 For a recipient error, a permanent error response (5&'xx'&) causes the
36034 recipient address to be failed, and a bounce message to be returned to the
36035 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36036 address to be deferred, and routing retry data to be created for it. This is
36037 used to delay processing of the address in subsequent queue runs, until its
36038 routing retry time arrives. This applies to all messages, but because it
36039 operates only in queue runs, one attempt will be made to deliver a new message
36040 to the failing address before the delay starts to operate. This ensures that,
36041 if the failure is really related to the message rather than the recipient
36042 (&"message too big for this recipient"& is a possible example), other messages
36043 have a chance of getting delivered. If a delivery to the address does succeed,
36044 the retry information gets cleared, so all stuck messages get tried again, and
36045 the retry clock is reset.
36046
36047 The message is not added to the list of those waiting for this host. Use of the
36048 host for other messages is unaffected, and except in the case of a timeout,
36049 other recipients are processed independently, and may be successfully delivered
36050 in the current SMTP session. After a timeout it is of course impossible to
36051 proceed with the session, so all addresses get deferred. However, those other
36052 than the one that failed do not suffer any subsequent retry delays. Therefore,
36053 if one recipient is causing trouble, the others have a chance of getting
36054 through when a subsequent delivery attempt occurs before the failing
36055 recipient's retry time.
36056 .endlist
36057
36058 In all cases, if there are other hosts (or IP addresses) available for the
36059 current set of addresses (for example, from multiple MX records), they are
36060 tried in this run for any undelivered addresses, subject of course to their
36061 own retry data. In other words, recipient error retry data does not take effect
36062 until the next delivery attempt.
36063
36064 Some hosts have been observed to give temporary error responses to every
36065 MAIL command at certain times (&"insufficient space"& has been seen). It
36066 would be nice if such circumstances could be recognized, and defer data for the
36067 host itself created, but this is not possible within the current Exim design.
36068 What actually happens is that retry data for every (host, message) combination
36069 is created.
36070
36071 The reason that timeouts after MAIL and RCPT are treated specially is that
36072 these can sometimes arise as a result of the remote host's verification
36073 procedures. Exim makes this assumption, and treats them as if a temporary error
36074 response had been received. A timeout after &"."& is treated specially because
36075 it is known that some broken implementations fail to recognize the end of the
36076 message if the last character of the last line is a binary zero. Thus, it is
36077 helpful to treat this case as a message error.
36078
36079 Timeouts at other times are treated as host errors, assuming a problem with the
36080 host, or the connection to it. If a timeout after MAIL, RCPT,
36081 or &"."& is really a connection problem, the assumption is that at the next try
36082 the timeout is likely to occur at some other point in the dialogue, causing it
36083 then to be treated as a host error.
36084
36085 There is experimental evidence that some MTAs drop the connection after the
36086 terminating &"."& if they do not like the contents of the message for some
36087 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36088 should be given. That is why Exim treats this case as a message rather than a
36089 host error, in order not to delay other messages to the same host.
36090
36091
36092
36093
36094 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36095 .cindex "SMTP" "incoming over TCP/IP"
36096 .cindex "incoming SMTP over TCP/IP"
36097 .cindex "inetd"
36098 .cindex "daemon"
36099 Incoming SMTP messages can be accepted in one of two ways: by running a
36100 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36101 &_/etc/inetd.conf_& should be like this:
36102 .code
36103 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36104 .endd
36105 Exim distinguishes between this case and the case of a locally running user
36106 agent using the &%-bs%& option by checking whether or not the standard input is
36107 a socket. When it is, either the port must be privileged (less than 1024), or
36108 the caller must be root or the Exim user. If any other user passes a socket
36109 with an unprivileged port number, Exim prints a message on the standard error
36110 stream and exits with an error code.
36111
36112 By default, Exim does not make a log entry when a remote host connects or
36113 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36114 unexpected. It can be made to write such log entries by setting the
36115 &%smtp_connection%& log selector.
36116
36117 .cindex "carriage return"
36118 .cindex "linefeed"
36119 Commands from the remote host are supposed to be terminated by CR followed by
36120 LF. However, there are known to be hosts that do not send CR characters. In
36121 order to be able to interwork with such hosts, Exim treats LF on its own as a
36122 line terminator.
36123 Furthermore, because common code is used for receiving messages from all
36124 sources, a CR on its own is also interpreted as a line terminator. However, the
36125 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36126
36127 .cindex "EHLO" "invalid data"
36128 .cindex "HELO" "invalid data"
36129 One area that sometimes gives rise to problems concerns the EHLO or
36130 HELO commands. Some clients send syntactically invalid versions of these
36131 commands, which Exim rejects by default. (This is nothing to do with verifying
36132 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36133 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36134 match the broken hosts that send invalid commands.
36135
36136 .cindex "SIZE option on MAIL command"
36137 .cindex "MAIL" "SIZE option"
36138 The amount of disk space available is checked whenever SIZE is received on
36139 a MAIL command, independently of whether &%message_size_limit%& or
36140 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36141 false. A temporary error is given if there is not enough space. If
36142 &%check_spool_space%& is set, the check is for that amount of space plus the
36143 value given with SIZE, that is, it checks that the addition of the incoming
36144 message will not reduce the space below the threshold.
36145
36146 When a message is successfully received, Exim includes the local message id in
36147 its response to the final &"."& that terminates the data. If the remote host
36148 logs this text it can help with tracing what has happened to a message.
36149
36150 The Exim daemon can limit the number of simultaneous incoming connections it is
36151 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36152 number of simultaneous incoming connections from a single remote host (see the
36153 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36154 rejected using the SMTP temporary error code 421.
36155
36156 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36157 subprocess has finished, as this can get lost at busy times. Instead, it looks
36158 for completed subprocesses every time it wakes up. Provided there are other
36159 things happening (new incoming calls, starts of queue runs), completed
36160 processes will be noticed and tidied away. On very quiet systems you may
36161 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36162 it will be noticed when the daemon next wakes up.
36163
36164 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36165 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36166 high system load &-- for details see the &%smtp_accept_reserve%&,
36167 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36168 applies in both the daemon and &'inetd'& cases.
36169
36170 Exim normally starts a delivery process for each message received, though this
36171 can be varied by means of the &%-odq%& command line option and the
36172 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36173 number of simultaneously running delivery processes started in this way from
36174 SMTP input can be limited by the &%smtp_accept_queue%& and
36175 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36176 subsequently received messages are just put on the input queue without starting
36177 a delivery process.
36178
36179 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36180 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36181 started up from the &'inetd'& daemon, because in that case each connection is
36182 handled by an entirely independent Exim process. Control by load average is,
36183 however, available with &'inetd'&.
36184
36185 Exim can be configured to verify addresses in incoming SMTP commands as they
36186 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36187 to rewrite addresses at this time &-- before any syntax checking is done. See
36188 section &<<SECTrewriteS>>&.
36189
36190 Exim can also be configured to limit the rate at which a client host submits
36191 MAIL and RCPT commands in a single SMTP session. See the
36192 &%smtp_ratelimit_hosts%& option.
36193
36194
36195
36196 .section "Unrecognized SMTP commands" "SECID234"
36197 .cindex "SMTP" "unrecognized commands"
36198 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36199 commands during a single SMTP connection, it drops the connection after sending
36200 the error response to the last command. The default value for
36201 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36202 abuse that subvert web servers into making connections to SMTP ports; in these
36203 circumstances, a number of non-SMTP lines are sent first.
36204
36205
36206 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36207 .cindex "SMTP" "syntax errors"
36208 .cindex "SMTP" "protocol errors"
36209 A syntax error is detected if an SMTP command is recognized, but there is
36210 something syntactically wrong with its data, for example, a malformed email
36211 address in a RCPT command. Protocol errors include invalid command
36212 sequencing such as RCPT before MAIL. If Exim receives more than
36213 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36214 drops the connection after sending the error response to the last command. The
36215 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36216 broken clients that loop sending bad commands (yes, it has been seen).
36217
36218
36219
36220 .section "Use of non-mail SMTP commands" "SECID236"
36221 .cindex "SMTP" "non-mail commands"
36222 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36223 DATA. Exim counts such commands, and drops the connection if there are too
36224 many of them in a single SMTP session. This action catches some
36225 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36226 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36227 defines what &"too many"& means. Its default value is 10.
36228
36229 When a new message is expected, one occurrence of RSET is not counted. This
36230 allows a client to send one RSET between messages (this is not necessary,
36231 but some clients do it). Exim also allows one uncounted occurrence of HELO
36232 or EHLO, and one occurrence of STARTTLS between messages. After
36233 starting up a TLS session, another EHLO is expected, and so it too is not
36234 counted.
36235
36236 The first occurrence of AUTH in a connection, or immediately following
36237 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36238 RCPT, DATA, and QUIT are counted.
36239
36240 You can control which hosts are subject to the limit set by
36241 &%smtp_accept_max_nonmail%& by setting
36242 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36243 the limit apply to all hosts. This option means that you can exclude any
36244 specific badly-behaved hosts that you have to live with.
36245
36246
36247
36248
36249 .section "The VRFY and EXPN commands" "SECID237"
36250 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36251 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36252 appropriate) in order to decide whether the command should be accepted or not.
36253
36254 .cindex "VRFY" "processing"
36255 When no ACL is defined for VRFY, or if it rejects without
36256 setting an explicit response code, the command is accepted
36257 (with a 252 SMTP response code)
36258 in order to support awkward clients that do a VRFY before every RCPT.
36259 When VRFY is accepted, it runs exactly the same code as when Exim is
36260 called with the &%-bv%& option, and returns 250/451/550
36261 SMTP response codes.
36262
36263 .cindex "EXPN" "processing"
36264 If no ACL for EXPN is defined, the command is rejected.
36265 When EXPN is accepted, a single-level expansion of the address is done.
36266 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36267 than a verification (the &%-bv%& option). If an unqualified local part is given
36268 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36269 of VRFY and EXPN commands are logged on the main and reject logs, and
36270 VRFY verification failures are logged on the main log for consistency with
36271 RCPT failures.
36272
36273
36274
36275 .section "The ETRN command" "SECTETRN"
36276 .cindex "ETRN" "processing"
36277 RFC 1985 describes an SMTP command called ETRN that is designed to
36278 overcome the security problems of the TURN command (which has fallen into
36279 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36280 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36281 should be accepted or not. If no ACL is defined, the command is rejected.
36282
36283 The ETRN command is concerned with &"releasing"& messages that are awaiting
36284 delivery to certain hosts. As Exim does not organize its message queue by host,
36285 the only form of ETRN that is supported by default is the one where the
36286 text starts with the &"#"& prefix, in which case the remainder of the text is
36287 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36288 the &%-R%& option to happen, with the remainder of the ETRN text as its
36289 argument. For example,
36290 .code
36291 ETRN #brigadoon
36292 .endd
36293 runs the command
36294 .code
36295 exim -R brigadoon
36296 .endd
36297 which causes a delivery attempt on all messages with undelivered addresses
36298 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36299 default), Exim prevents the simultaneous execution of more than one queue run
36300 for the same argument string as a result of an ETRN command. This stops
36301 a misbehaving client from starting more than one queue runner at once.
36302
36303 .cindex "hints database" "ETRN serialization"
36304 Exim implements the serialization by means of a hints database in which a
36305 record is written whenever a process is started by ETRN, and deleted when
36306 the process completes. However, Exim does not keep the SMTP session waiting for
36307 the ETRN process to complete. Once ETRN is accepted, the client is sent
36308 a &"success"& return code. Obviously there is scope for hints records to get
36309 left lying around if there is a system or program crash. To guard against this,
36310 Exim ignores any records that are more than six hours old.
36311
36312 .oindex "&%smtp_etrn_command%&"
36313 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36314 used. This specifies a command that is run whenever ETRN is received,
36315 whatever the form of its argument. For
36316 example:
36317 .code
36318 smtp_etrn_command = /etc/etrn_command $domain \
36319                     $sender_host_address
36320 .endd
36321 .vindex "&$domain$&"
36322 The string is split up into arguments which are independently expanded. The
36323 expansion variable &$domain$& is set to the argument of the ETRN command,
36324 and no syntax checking is done on the contents of this argument. Exim does not
36325 wait for the command to complete, so its status code is not checked. Exim runs
36326 under its own uid and gid when receiving incoming SMTP, so it is not possible
36327 for it to change them before running the command.
36328
36329
36330
36331 .section "Incoming local SMTP" "SECID238"
36332 .cindex "SMTP" "local incoming"
36333 Some user agents use SMTP to pass messages to their local MTA using the
36334 standard input and output, as opposed to passing the envelope on the command
36335 line and writing the message to the standard input. This is supported by the
36336 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36337 messages over TCP/IP (including the use of ACLs), except that the envelope
36338 sender given in a MAIL command is ignored unless the caller is trusted. In
36339 an ACL you can detect this form of SMTP input by testing for an empty host
36340 identification. It is common to have this as the first line in the ACL that
36341 runs for RCPT commands:
36342 .code
36343 accept hosts = :
36344 .endd
36345 This accepts SMTP messages from local processes without doing any other tests.
36346
36347
36348
36349 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36350 .cindex "SMTP" "batched outgoing"
36351 .cindex "batched SMTP output"
36352 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36353 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36354 be output in BSMTP format. No SMTP responses are possible for this form of
36355 delivery. All it is doing is using SMTP commands as a way of transmitting the
36356 envelope along with the message.
36357
36358 The message is written to the file or pipe preceded by the SMTP commands
36359 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36360 the message that start with a dot have an extra dot added. The SMTP command
36361 HELO is not normally used. If it is required, the &%message_prefix%& option
36362 can be used to specify it.
36363
36364 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36365 one recipient address at a time by default. However, you can arrange for them
36366 to handle several addresses at once by setting the &%batch_max%& option. When
36367 this is done for BSMTP, messages may contain multiple RCPT commands. See
36368 chapter &<<CHAPbatching>>& for more details.
36369
36370 .vindex "&$host$&"
36371 When one or more addresses are routed to a BSMTP transport by a router that
36372 sets up a host list, the name of the first host on the list is available to the
36373 transport in the variable &$host$&. Here is an example of such a transport and
36374 router:
36375 .code
36376 begin routers
36377 route_append:
36378   driver = manualroute
36379   transport = smtp_appendfile
36380   route_list = domain.example  batch.host.example
36381
36382 begin transports
36383 smtp_appendfile:
36384   driver = appendfile
36385   directory = /var/bsmtp/$host
36386   batch_max = 1000
36387   use_bsmtp
36388   user = exim
36389 .endd
36390 This causes messages addressed to &'domain.example'& to be written in BSMTP
36391 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36392 message (unless there are more than 1000 recipients).
36393
36394
36395
36396 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36397 .cindex "SMTP" "batched incoming"
36398 .cindex "batched SMTP input"
36399 The &%-bS%& command line option causes Exim to accept one or more messages by
36400 reading SMTP on the standard input, but to generate no responses. If the caller
36401 is trusted, the senders in the MAIL commands are believed; otherwise the
36402 sender is always the caller of Exim. Unqualified senders and receivers are not
36403 rejected (there seems little point) but instead just get qualified. HELO
36404 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36405 as NOOP; QUIT quits.
36406
36407 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36408 ACL is run in the same way as for non-SMTP local input.
36409
36410 If an error is detected while reading a message, including a missing &"."& at
36411 the end, Exim gives up immediately. It writes details of the error to the
36412 standard output in a stylized way that the calling program should be able to
36413 make some use of automatically, for example:
36414 .code
36415 554 Unexpected end of file
36416 Transaction started in line 10
36417 Error detected in line 14
36418 .endd
36419 It writes a more verbose version, for human consumption, to the standard error
36420 file, for example:
36421 .code
36422 An error was detected while processing a file of BSMTP input.
36423 The error message was:
36424
36425 501 '>' missing at end of address
36426
36427 The SMTP transaction started in line 10.
36428 The error was detected in line 12.
36429 The SMTP command at fault was:
36430
36431 rcpt to:<malformed@in.com.plete
36432
36433 1 previous message was successfully processed.
36434 The rest of the batch was abandoned.
36435 .endd
36436 The return code from Exim is zero only if there were no errors. It is 1 if some
36437 messages were accepted before an error was detected, and 2 if no messages were
36438 accepted.
36439 .ecindex IIDsmtpproc1
36440 .ecindex IIDsmtpproc2
36441
36442
36443
36444 . ////////////////////////////////////////////////////////////////////////////
36445 . ////////////////////////////////////////////////////////////////////////////
36446
36447 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36448          "Customizing messages"
36449 When a message fails to be delivered, or remains in the queue for more than a
36450 configured amount of time, Exim sends a message to the original sender, or
36451 to an alternative configured address. The text of these messages is built into
36452 the code of Exim, but it is possible to change it, either by adding a single
36453 string, or by replacing each of the paragraphs by text supplied in a file.
36454
36455 The &'From:'& and &'To:'& header lines are automatically generated; you can
36456 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36457 option. Exim also adds the line
36458 .code
36459 Auto-Submitted: auto-generated
36460 .endd
36461 to all warning and bounce messages,
36462
36463
36464 .section "Customizing bounce messages" "SECID239"
36465 .cindex "customizing" "bounce message"
36466 .cindex "bounce message" "customizing"
36467 If &%bounce_message_text%& is set, its contents are included in the default
36468 message immediately after &"This message was created automatically by mail
36469 delivery software."& The string is not expanded. It is not used if
36470 &%bounce_message_file%& is set.
36471
36472 When &%bounce_message_file%& is set, it must point to a template file for
36473 constructing error messages. The file consists of a series of text items,
36474 separated by lines consisting of exactly four asterisks. If the file cannot be
36475 opened, default text is used and a message is written to the main and panic
36476 logs. If any text item in the file is empty, default text is used for that
36477 item.
36478
36479 .vindex "&$bounce_recipient$&"
36480 .vindex "&$bounce_return_size_limit$&"
36481 Each item of text that is read from the file is expanded, and there are two
36482 expansion variables which can be of use here: &$bounce_recipient$& is set to
36483 the recipient of an error message while it is being created, and
36484 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36485 option, rounded to a whole number.
36486
36487 The items must appear in the file in the following order:
36488
36489 .ilist
36490 The first item is included in the headers, and should include at least a
36491 &'Subject:'& header. Exim does not check the syntax of these headers.
36492 .next
36493 The second item forms the start of the error message. After it, Exim lists the
36494 failing addresses with their error messages.
36495 .next
36496 The third item is used to introduce any text from pipe transports that is to be
36497 returned to the sender. It is omitted if there is no such text.
36498 .next
36499 The fourth, fifth and sixth items will be ignored and may be empty.
36500 The fields exist for back-compatibility
36501 .endlist
36502
36503 The default state (&%bounce_message_file%& unset) is equivalent to the
36504 following file, in which the sixth item is empty. The &'Subject:'& and some
36505 other lines have been split in order to fit them on the page:
36506 .code
36507 Subject: Mail delivery failed
36508   ${if eq{$sender_address}{$bounce_recipient}
36509   {: returning message to sender}}
36510 ****
36511 This message was created automatically by mail delivery software.
36512
36513 A message ${if eq{$sender_address}{$bounce_recipient}
36514   {that you sent }{sent by
36515
36516 <$sender_address>
36517
36518 }}could not be delivered to all of its recipients.
36519 This is a permanent error. The following address(es) failed:
36520 ****
36521 The following text was generated during the delivery attempt(s):
36522 ****
36523 ------ This is a copy of the message, including all the headers.
36524   ------
36525 ****
36526 ------ The body of the message is $message_size characters long;
36527   only the first
36528 ------ $bounce_return_size_limit or so are included here.
36529 ****
36530 .endd
36531 .section "Customizing warning messages" "SECTcustwarn"
36532 .cindex "customizing" "warning message"
36533 .cindex "warning of delay" "customizing the message"
36534 The option &%warn_message_file%& can be pointed at a template file for use when
36535 warnings about message delays are created. In this case there are only three
36536 text sections:
36537
36538 .ilist
36539 The first item is included in the headers, and should include at least a
36540 &'Subject:'& header. Exim does not check the syntax of these headers.
36541 .next
36542 The second item forms the start of the warning message. After it, Exim lists
36543 the delayed addresses.
36544 .next
36545 The third item then ends the message.
36546 .endlist
36547
36548 The default state is equivalent to the following file, except that some lines
36549 have been split here, in order to fit them on the page:
36550 .code
36551 Subject: Warning: message $message_exim_id delayed
36552   $warn_message_delay
36553 ****
36554 This message was created automatically by mail delivery software.
36555
36556 A message ${if eq{$sender_address}{$warn_message_recipients}
36557 {that you sent }{sent by
36558
36559 <$sender_address>
36560
36561 }}has not been delivered to all of its recipients after
36562 more than $warn_message_delay in the queue on $primary_hostname.
36563
36564 The message identifier is:     $message_exim_id
36565 The subject of the message is: $h_subject
36566 The date of the message is:    $h_date
36567
36568 The following address(es) have not yet been delivered:
36569 ****
36570 No action is required on your part. Delivery attempts will
36571 continue for some time, and this warning may be repeated at
36572 intervals if the message remains undelivered. Eventually the
36573 mail delivery software will give up, and when that happens,
36574 the message will be returned to you.
36575 .endd
36576 .vindex "&$warn_message_delay$&"
36577 .vindex "&$warn_message_recipients$&"
36578 However, in the default state the subject and date lines are omitted if no
36579 appropriate headers exist. During the expansion of this file,
36580 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36581 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36582 of recipients for the warning message. There may be more than one if there are
36583 multiple addresses with different &%errors_to%& settings on the routers that
36584 handled them.
36585
36586
36587
36588
36589 . ////////////////////////////////////////////////////////////////////////////
36590 . ////////////////////////////////////////////////////////////////////////////
36591
36592 .chapter "Some common configuration settings" "CHAPcomconreq"
36593 This chapter discusses some configuration settings that seem to be fairly
36594 common. More examples and discussion can be found in the Exim book.
36595
36596
36597
36598 .section "Sending mail to a smart host" "SECID240"
36599 .cindex "smart host" "example router"
36600 If you want to send all mail for non-local domains to a &"smart host"&, you
36601 should replace the default &(dnslookup)& router with a router which does the
36602 routing explicitly:
36603 .code
36604 send_to_smart_host:
36605   driver = manualroute
36606   route_list = !+local_domains smart.host.name
36607   transport = remote_smtp
36608 .endd
36609 You can use the smart host's IP address instead of the name if you wish.
36610 If you are using Exim only to submit messages to a smart host, and not for
36611 receiving incoming messages, you can arrange for it to do the submission
36612 synchronously by setting the &%mua_wrapper%& option (see chapter
36613 &<<CHAPnonqueueing>>&).
36614
36615
36616
36617
36618 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36619 .cindex "mailing lists"
36620 Exim can be used to run simple mailing lists, but for large and/or complicated
36621 requirements, the use of additional specialized mailing list software such as
36622 Majordomo or Mailman is recommended.
36623
36624 The &(redirect)& router can be used to handle mailing lists where each list
36625 is maintained in a separate file, which can therefore be managed by an
36626 independent manager. The &%domains%& router option can be used to run these
36627 lists in a separate domain from normal mail. For example:
36628 .code
36629 lists:
36630   driver = redirect
36631   domains = lists.example
36632   file = /usr/lists/$local_part
36633   forbid_pipe
36634   forbid_file
36635   errors_to = $local_part-request@lists.example
36636   no_more
36637 .endd
36638 This router is skipped for domains other than &'lists.example'&. For addresses
36639 in that domain, it looks for a file that matches the local part. If there is no
36640 such file, the router declines, but because &%no_more%& is set, no subsequent
36641 routers are tried, and so the whole delivery fails.
36642
36643 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36644 expanded into a filename or a pipe delivery, which is usually inappropriate in
36645 a mailing list.
36646
36647 .oindex "&%errors_to%&"
36648 The &%errors_to%& option specifies that any delivery errors caused by addresses
36649 taken from a mailing list are to be sent to the given address rather than the
36650 original sender of the message. However, before acting on this, Exim verifies
36651 the error address, and ignores it if verification fails.
36652
36653 For example, using the configuration above, mail sent to
36654 &'dicts@lists.example'& is passed on to those addresses contained in
36655 &_/usr/lists/dicts_&, with error reports directed to
36656 &'dicts-request@lists.example'&, provided that this address can be verified.
36657 There could be a file called &_/usr/lists/dicts-request_& containing
36658 the address(es) of this particular list's manager(s), but other approaches,
36659 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36660 or &%local_part_suffix%& options) to handle addresses of the form
36661 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36662
36663
36664
36665 .section "Syntax errors in mailing lists" "SECID241"
36666 .cindex "mailing lists" "syntax errors in"
36667 If an entry in redirection data contains a syntax error, Exim normally defers
36668 delivery of the original address. That means that a syntax error in a mailing
36669 list holds up all deliveries to the list. This may not be appropriate when a
36670 list is being maintained automatically from data supplied by users, and the
36671 addresses are not rigorously checked.
36672
36673 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36674 entries that fail to parse, noting the incident in the log. If in addition
36675 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36676 whenever a broken address is skipped. It is usually appropriate to set
36677 &%syntax_errors_to%& to the same address as &%errors_to%&.
36678
36679
36680
36681 .section "Re-expansion of mailing lists" "SECID242"
36682 .cindex "mailing lists" "re-expansion of"
36683 Exim remembers every individual address to which a message has been delivered,
36684 in order to avoid duplication, but it normally stores only the original
36685 recipient addresses with a message. If all the deliveries to a mailing list
36686 cannot be done at the first attempt, the mailing list is re-expanded when the
36687 delivery is next tried. This means that alterations to the list are taken into
36688 account at each delivery attempt, so addresses that have been added to
36689 the list since the message arrived will therefore receive a copy of the
36690 message, even though it pre-dates their subscription.
36691
36692 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36693 on the &(redirect)& router. If this is done, any addresses generated by the
36694 router that fail to deliver at the first attempt are added to the message as
36695 &"top level"& addresses, and the parent address that generated them is marked
36696 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36697 subsequent delivery attempts. The disadvantage of this is that if any of the
36698 failing addresses are incorrect, correcting them in the file has no effect on
36699 pre-existing messages.
36700
36701 The original top-level address is remembered with each of the generated
36702 addresses, and is output in any log messages. However, any intermediate parent
36703 addresses are not recorded. This makes a difference to the log only if the
36704 &%all_parents%& selector is set, but for mailing lists there is normally only
36705 one level of expansion anyway.
36706
36707
36708
36709 .section "Closed mailing lists" "SECID243"
36710 .cindex "mailing lists" "closed"
36711 The examples so far have assumed open mailing lists, to which anybody may
36712 send mail. It is also possible to set up closed lists, where mail is accepted
36713 from specified senders only. This is done by making use of the generic
36714 &%senders%& option to restrict the router that handles the list.
36715
36716 The following example uses the same file as a list of recipients and as a list
36717 of permitted senders. It requires three routers:
36718 .code
36719 lists_request:
36720   driver = redirect
36721   domains = lists.example
36722   local_part_suffix = -request
36723   file = /usr/lists/$local_part$local_part_suffix
36724   no_more
36725
36726 lists_post:
36727   driver = redirect
36728   domains = lists.example
36729   senders = ${if exists {/usr/lists/$local_part}\
36730              {lsearch;/usr/lists/$local_part}{*}}
36731   file = /usr/lists/$local_part
36732   forbid_pipe
36733   forbid_file
36734   errors_to = $local_part-request@lists.example
36735   no_more
36736
36737 lists_closed:
36738   driver = redirect
36739   domains = lists.example
36740   allow_fail
36741   data = :fail: $local_part@lists.example is a closed mailing list
36742 .endd
36743 All three routers have the same &%domains%& setting, so for any other domains,
36744 they are all skipped. The first router runs only if the local part ends in
36745 &%-request%&. It handles messages to the list manager(s) by means of an open
36746 mailing list.
36747
36748 The second router runs only if the &%senders%& precondition is satisfied. It
36749 checks for the existence of a list that corresponds to the local part, and then
36750 checks that the sender is on the list by means of a linear search. It is
36751 necessary to check for the existence of the file before trying to search it,
36752 because otherwise Exim thinks there is a configuration error. If the file does
36753 not exist, the expansion of &%senders%& is *, which matches all senders. This
36754 means that the router runs, but because there is no list, declines, and
36755 &%no_more%& ensures that no further routers are run. The address fails with an
36756 &"unrouteable address"& error.
36757
36758 The third router runs only if the second router is skipped, which happens when
36759 a mailing list exists, but the sender is not on it. This router forcibly fails
36760 the address, giving a suitable error message.
36761
36762
36763
36764
36765 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36766 .cindex "VERP"
36767 .cindex "Variable Envelope Return Paths"
36768 .cindex "envelope from"
36769 .cindex "envelope sender"
36770 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36771 are a way of helping mailing list administrators discover which subscription
36772 address is the cause of a particular delivery failure. The idea is to encode
36773 the original recipient address in the outgoing envelope sender address, so that
36774 if the message is forwarded by another host and then subsequently bounces, the
36775 original recipient can be extracted from the recipient address of the bounce.
36776
36777 .oindex &%errors_to%&
36778 .oindex &%return_path%&
36779 Envelope sender addresses can be modified by Exim using two different
36780 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36781 list examples), or the &%return_path%& option on a transport. The second of
36782 these is effective only if the message is successfully delivered to another
36783 host; it is not used for errors detected on the local host (see the description
36784 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36785 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36786 .code
36787 verp_smtp:
36788   driver = smtp
36789   max_rcpt = 1
36790   return_path = \
36791     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36792       {$1-request+$local_part=$domain@your.dom.example}fail}
36793 .endd
36794 This has the effect of rewriting the return path (envelope sender) on outgoing
36795 SMTP messages, if the local part of the original return path ends in
36796 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36797 local part and domain of the recipient into the return path. Suppose, for
36798 example, that a message whose return path has been set to
36799 &'somelist-request@your.dom.example'& is sent to
36800 &'subscriber@other.dom.example'&. In the transport, the return path is
36801 rewritten as
36802 .code
36803 somelist-request+subscriber=other.dom.example@your.dom.example
36804 .endd
36805 .vindex "&$local_part$&"
36806 For this to work, you must tell Exim to send multiple copies of messages that
36807 have more than one recipient, so that each copy has just one recipient. This is
36808 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36809 might be sent to several different recipients in the same domain, in which case
36810 &$local_part$& is not available in the transport, because it is not unique.
36811
36812 Unless your host is doing nothing but mailing list deliveries, you should
36813 probably use a separate transport for the VERP deliveries, so as not to use
36814 extra resources in making one-per-recipient copies for other deliveries. This
36815 can easily be done by expanding the &%transport%& option in the router:
36816 .code
36817 dnslookup:
36818   driver = dnslookup
36819   domains = ! +local_domains
36820   transport = \
36821     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36822       {verp_smtp}{remote_smtp}}
36823   no_more
36824 .endd
36825 If you want to change the return path using &%errors_to%& in a router instead
36826 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36827 routers that handle mailing list addresses. This will ensure that all delivery
36828 errors, including those detected on the local host, are sent to the VERP
36829 address.
36830
36831 On a host that does no local deliveries and has no manual routing, only the
36832 &(dnslookup)& router needs to be changed. A special transport is not needed for
36833 SMTP deliveries. Every mailing list recipient has its own return path value,
36834 and so Exim must hand them to the transport one at a time. Here is an example
36835 of a &(dnslookup)& router that implements VERP:
36836 .code
36837 verp_dnslookup:
36838   driver = dnslookup
36839   domains = ! +local_domains
36840   transport = remote_smtp
36841   errors_to = \
36842     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36843      {$1-request+$local_part=$domain@your.dom.example}fail}
36844   no_more
36845 .endd
36846 Before you start sending out messages with VERPed return paths, you must also
36847 configure Exim to accept the bounce messages that come back to those paths.
36848 Typically this is done by setting a &%local_part_suffix%& option for a
36849 router, and using this to route the messages to wherever you want to handle
36850 them.
36851
36852 The overhead incurred in using VERP depends very much on the size of the
36853 message, the number of recipient addresses that resolve to the same remote
36854 host, and the speed of the connection over which the message is being sent. If
36855 a lot of addresses resolve to the same host and the connection is slow, sending
36856 a separate copy of the message for each address may take substantially longer
36857 than sending a single copy with many recipients (for which VERP cannot be
36858 used).
36859
36860
36861
36862
36863
36864
36865 .section "Virtual domains" "SECTvirtualdomains"
36866 .cindex "virtual domains"
36867 .cindex "domain" "virtual"
36868 The phrase &'virtual domain'& is unfortunately used with two rather different
36869 meanings:
36870
36871 .ilist
36872 A domain for which there are no real mailboxes; all valid local parts are
36873 aliases for other email addresses. Common examples are organizational
36874 top-level domains and &"vanity"& domains.
36875 .next
36876 One of a number of independent domains that are all handled by the same host,
36877 with mailboxes on that host, but where the mailbox owners do not necessarily
36878 have login accounts on that host.
36879 .endlist
36880
36881 The first usage is probably more common, and does seem more &"virtual"& than
36882 the second. This kind of domain can be handled in Exim with a straightforward
36883 aliasing router. One approach is to create a separate alias file for each
36884 virtual domain. Exim can test for the existence of the alias file to determine
36885 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36886 to a router of this form:
36887 .code
36888 virtual:
36889   driver = redirect
36890   domains = dsearch;/etc/mail/virtual
36891   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
36892   no_more
36893 .endd
36894 .new
36895 The &%domains%& option specifies that the router is to be skipped, unless there
36896 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36897 domain that is being processed.
36898 The &(dsearch)& lookup used results in an untainted version of &$domain$&
36899 being placed into the &$domain_data$& variable.
36900 .wen
36901
36902 When the router runs, it looks up the local
36903 part in the file to find a new address (or list of addresses). The &%no_more%&
36904 setting ensures that if the lookup fails (leading to &%data%& being an empty
36905 string), Exim gives up on the address without trying any subsequent routers.
36906
36907 This one router can handle all the virtual domains because the alias filenames
36908 follow a fixed pattern. Permissions can be arranged so that appropriate people
36909 can edit the different alias files. A successful aliasing operation results in
36910 a new envelope recipient address, which is then routed from scratch.
36911
36912 The other kind of &"virtual"& domain can also be handled in a straightforward
36913 way. One approach is to create a file for each domain containing a list of
36914 valid local parts, and use it in a router like this:
36915 .code
36916 my_domains:
36917   driver = accept
36918   domains = dsearch;/etc/mail/domains
36919   local_parts = lsearch;/etc/mail/domains/$domain
36920   transport = my_mailboxes
36921 .endd
36922 The address is accepted if there is a file for the domain, and the local part
36923 can be found in the file. The &%domains%& option is used to check for the
36924 file's existence because &%domains%& is tested before the &%local_parts%&
36925 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36926 because that option is tested after &%local_parts%&. The transport is as
36927 follows:
36928 .code
36929 my_mailboxes:
36930   driver = appendfile
36931   file = /var/mail/$domain/$local_part
36932   user = mail
36933 .endd
36934 This uses a directory of mailboxes for each domain. The &%user%& setting is
36935 required, to specify which uid is to be used for writing to the mailboxes.
36936
36937 The configuration shown here is just one example of how you might support this
36938 requirement. There are many other ways this kind of configuration can be set
36939 up, for example, by using a database instead of separate files to hold all the
36940 information about the domains.
36941
36942
36943
36944 .section "Multiple user mailboxes" "SECTmulbox"
36945 .cindex "multiple mailboxes"
36946 .cindex "mailbox" "multiple"
36947 .cindex "local part" "prefix"
36948 .cindex "local part" "suffix"
36949 Heavy email users often want to operate with multiple mailboxes, into which
36950 incoming mail is automatically sorted. A popular way of handling this is to
36951 allow users to use multiple sender addresses, so that replies can easily be
36952 identified. Users are permitted to add prefixes or suffixes to their local
36953 parts for this purpose. The wildcard facility of the generic router options
36954 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36955 example, consider this router:
36956 .code
36957 userforward:
36958   driver = redirect
36959   check_local_user
36960   file = $home/.forward
36961   local_part_suffix = -*
36962   local_part_suffix_optional
36963   allow_filter
36964 .endd
36965 .vindex "&$local_part_suffix$&"
36966 It runs a user's &_.forward_& file for all local parts of the form
36967 &'username-*'&. Within the filter file the user can distinguish different
36968 cases by testing the variable &$local_part_suffix$&. For example:
36969 .code
36970 if $local_part_suffix contains -special then
36971 save /home/$local_part/Mail/special
36972 endif
36973 .endd
36974 If the filter file does not exist, or does not deal with such addresses, they
36975 fall through to subsequent routers, and, assuming no subsequent use of the
36976 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36977 control over which suffixes are valid.
36978
36979 Alternatively, a suffix can be used to trigger the use of a different
36980 &_.forward_& file &-- which is the way a similar facility is implemented in
36981 another MTA:
36982 .code
36983 userforward:
36984   driver = redirect
36985   check_local_user
36986   file = $home/.forward$local_part_suffix
36987   local_part_suffix = -*
36988   local_part_suffix_optional
36989   allow_filter
36990 .endd
36991 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36992 example, &_.forward-special_& is used. Once again, if the appropriate file
36993 does not exist, or does not deal with the address, it is passed on to
36994 subsequent routers, which could, if required, look for an unqualified
36995 &_.forward_& file to use as a default.
36996
36997
36998
36999 .section "Simplified vacation processing" "SECID244"
37000 .cindex "vacation processing"
37001 The traditional way of running the &'vacation'& program is for a user to set up
37002 a pipe command in a &_.forward_& file
37003 (see section &<<SECTspecitredli>>& for syntax details).
37004 This is prone to error by inexperienced users. There are two features of Exim
37005 that can be used to make this process simpler for users:
37006
37007 .ilist
37008 A local part prefix such as &"vacation-"& can be specified on a router which
37009 can cause the message to be delivered directly to the &'vacation'& program, or
37010 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37011 &_.forward_& file are then much simpler. For example:
37012 .code
37013 spqr, vacation-spqr
37014 .endd
37015 .next
37016 The &%require_files%& generic router option can be used to trigger a
37017 vacation delivery by checking for the existence of a certain file in the
37018 user's home directory. The &%unseen%& generic option should also be used, to
37019 ensure that the original delivery also proceeds. In this case, all the user has
37020 to do is to create a file called, say, &_.vacation_&, containing a vacation
37021 message.
37022 .endlist
37023
37024 Another advantage of both these methods is that they both work even when the
37025 use of arbitrary pipes by users is locked out.
37026
37027
37028
37029 .section "Taking copies of mail" "SECID245"
37030 .cindex "message" "copying every"
37031 Some installations have policies that require archive copies of all messages to
37032 be made. A single copy of each message can easily be taken by an appropriate
37033 command in a system filter, which could, for example, use a different file for
37034 each day's messages.
37035
37036 There is also a shadow transport mechanism that can be used to take copies of
37037 messages that are successfully delivered by local transports, one copy per
37038 delivery. This could be used, &'inter alia'&, to implement automatic
37039 notification of delivery by sites that insist on doing such things.
37040
37041
37042
37043 .section "Intermittently connected hosts" "SECID246"
37044 .cindex "intermittently connected hosts"
37045 It has become quite common (because it is cheaper) for hosts to connect to the
37046 Internet periodically rather than remain connected all the time. The normal
37047 arrangement is that mail for such hosts accumulates on a system that is
37048 permanently connected.
37049
37050 Exim was designed for use on permanently connected hosts, and so it is not
37051 particularly well-suited to use in an intermittently connected environment.
37052 Nevertheless there are some features that can be used.
37053
37054
37055 .section "Exim on the upstream server host" "SECID247"
37056 It is tempting to arrange for incoming mail for the intermittently connected
37057 host to remain in Exim's queue until the client connects. However, this
37058 approach does not scale very well. Two different kinds of waiting message are
37059 being mixed up in the same queue &-- those that cannot be delivered because of
37060 some temporary problem, and those that are waiting for their destination host
37061 to connect. This makes it hard to manage the queue, as well as wasting
37062 resources, because each queue runner scans the entire queue.
37063
37064 A better approach is to separate off those messages that are waiting for an
37065 intermittently connected host. This can be done by delivering these messages
37066 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37067 format, from where they are transmitted by other software when their
37068 destination connects. This makes it easy to collect all the mail for one host
37069 in a single directory, and to apply local timeout rules on a per-message basis
37070 if required.
37071
37072 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37073 you are doing this, you should configure Exim with a long retry period for the
37074 intermittent host. For example:
37075 .code
37076 cheshire.wonderland.fict.example    *   F,5d,24h
37077 .endd
37078 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37079 which messages it has queued up for that host. Once the intermittent host comes
37080 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37081 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37082 causes all the queued up messages to be delivered, often down a single SMTP
37083 connection. While the host remains connected, any new messages get delivered
37084 immediately.
37085
37086 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37087 issued with a different IP address each time it connects, Exim's retry
37088 mechanisms on the holding host get confused, because the IP address is normally
37089 used as part of the key string for holding retry information. This can be
37090 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37091 Since this has disadvantages for permanently connected hosts, it is best to
37092 arrange a separate transport for the intermittently connected ones.
37093
37094
37095
37096 .section "Exim on the intermittently connected client host" "SECID248"
37097 The value of &%smtp_accept_queue_per_connection%& should probably be
37098 increased, or even set to zero (that is, disabled) on the intermittently
37099 connected host, so that all incoming messages down a single connection get
37100 delivered immediately.
37101
37102 .cindex "SMTP" "passed connection"
37103 .cindex "SMTP" "multiple deliveries"
37104 .cindex "multiple SMTP deliveries"
37105 .cindex "first pass routing"
37106 Mail waiting to be sent from an intermittently connected host will probably
37107 not have been routed, because without a connection DNS lookups are not
37108 possible. This means that if a normal queue run is done at connection time,
37109 each message is likely to be sent in a separate SMTP session. This can be
37110 avoided by starting the queue run with a command line option beginning with
37111 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37112 first pass, routing is done but no deliveries take place. The second pass is a
37113 normal queue run; since all the messages have been previously routed, those
37114 destined for the same host are likely to get sent as multiple deliveries in a
37115 single SMTP connection.
37116
37117
37118
37119 . ////////////////////////////////////////////////////////////////////////////
37120 . ////////////////////////////////////////////////////////////////////////////
37121
37122 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37123          "Exim as a non-queueing client"
37124 .cindex "client, non-queueing"
37125 .cindex "smart host" "suppressing queueing"
37126 On a personal computer, it is a common requirement for all
37127 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37128 configured to operate that way, for all the popular operating systems.
37129 However, there are some MUAs for Unix-like systems that cannot be so
37130 configured: they submit messages using the command line interface of
37131 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37132 messages this way.
37133
37134 If the personal computer runs continuously, there is no problem, because it can
37135 run a conventional MTA that handles delivery to the smart host, and deal with
37136 any delays via its queueing mechanism. However, if the computer does not run
37137 continuously or runs different operating systems at different times, queueing
37138 email is not desirable.
37139
37140 There is therefore a requirement for something that can provide the
37141 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37142 any queueing or retrying facilities. Furthermore, the delivery to the smart
37143 host should be synchronous, so that if it fails, the sending MUA is immediately
37144 informed. In other words, we want something that extends an MUA that submits
37145 to a local MTA via the command line so that it behaves like one that submits
37146 to a remote smart host using TCP/SMTP.
37147
37148 There are a number of applications (for example, there is one called &'ssmtp'&)
37149 that do this job. However, people have found them to be lacking in various
37150 ways. For instance, you might want to allow aliasing and forwarding to be done
37151 before sending a message to the smart host.
37152
37153 Exim already had the necessary infrastructure for doing this job. Just a few
37154 tweaks were needed to make it behave as required, though it is somewhat of an
37155 overkill to use a fully-featured MTA for this purpose.
37156
37157 .oindex "&%mua_wrapper%&"
37158 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37159 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37160 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37161 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37162 compatible router and transport configuration. Typically there will be just one
37163 router and one transport, sending everything to a smart host.
37164
37165 When run in MUA wrapping mode, the behaviour of Exim changes in the
37166 following ways:
37167
37168 .ilist
37169 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37170 In other words, the only way to submit messages is via the command line.
37171 .next
37172 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37173 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37174 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37175 does not finish until the delivery attempt is complete. If the delivery is
37176 successful, a zero return code is given.
37177 .next
37178 Address redirection is permitted, but the final routing for all addresses must
37179 be to the same remote transport, and to the same list of hosts. Furthermore,
37180 the return address (envelope sender) must be the same for all recipients, as
37181 must any added or deleted header lines. In other words, it must be possible to
37182 deliver the message in a single SMTP transaction, however many recipients there
37183 are.
37184 .next
37185 If these conditions are not met, or if routing any address results in a
37186 failure or defer status, or if Exim is unable to deliver all the recipients
37187 successfully to one of the smart hosts, delivery of the entire message fails.
37188 .next
37189 Because no queueing is allowed, all failures are treated as permanent; there
37190 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37191 smart host. Furthermore, because only a single yes/no response can be given to
37192 the caller, it is not possible to deliver to some recipients and not others. If
37193 there is an error (temporary or permanent) for any recipient, all are failed.
37194 .next
37195 If more than one smart host is listed, Exim will try another host after a
37196 connection failure or a timeout, in the normal way. However, if this kind of
37197 failure happens for all the hosts, the delivery fails.
37198 .next
37199 When delivery fails, an error message is written to the standard error stream
37200 (as well as to Exim's log), and Exim exits to the caller with a return code
37201 value 1. The message is expunged from Exim's spool files. No bounce messages
37202 are ever generated.
37203 .next
37204 No retry data is maintained, and any retry rules are ignored.
37205 .next
37206 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37207 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37208 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37209 .endlist
37210
37211 The overall effect is that Exim makes a single synchronous attempt to deliver
37212 the message, failing if there is any kind of problem. Because no local
37213 deliveries are done and no daemon can be run, Exim does not need root
37214 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37215 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37216 the advantages and disadvantages of running without root privilege.
37217
37218
37219
37220
37221 . ////////////////////////////////////////////////////////////////////////////
37222 . ////////////////////////////////////////////////////////////////////////////
37223
37224 .chapter "Log files" "CHAPlog"
37225 .scindex IIDloggen "log" "general description"
37226 .cindex "log" "types of"
37227 Exim writes three different logs, referred to as the main log, the reject log,
37228 and the panic log:
37229
37230 .ilist
37231 .cindex "main log"
37232 The main log records the arrival of each message and each delivery in a single
37233 line in each case. The format is as compact as possible, in an attempt to keep
37234 down the size of log files. Two-character flag sequences make it easy to pick
37235 out these lines. A number of other events are recorded in the main log. Some of
37236 them are optional, in which case the &%log_selector%& option controls whether
37237 they are included or not. A Perl script called &'eximstats'&, which does simple
37238 analysis of main log files, is provided in the Exim distribution (see section
37239 &<<SECTmailstat>>&).
37240 .next
37241 .cindex "reject log"
37242 The reject log records information from messages that are rejected as a result
37243 of a configuration option (that is, for policy reasons).
37244 The first line of each rejection is a copy of the line that is also written to
37245 the main log. Then, if the message's header has been read at the time the log
37246 is written, its contents are written to this log. Only the original header
37247 lines are available; header lines added by ACLs are not logged. You can use the
37248 reject log to check that your policy controls are working correctly; on a busy
37249 host this may be easier than scanning the main log for rejection messages. You
37250 can suppress the writing of the reject log by setting &%write_rejectlog%&
37251 false.
37252 .next
37253 .cindex "panic log"
37254 .cindex "system log"
37255 When certain serious errors occur, Exim writes entries to its panic log. If the
37256 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37257 are usually written to the main log as well, but can get lost amid the mass of
37258 other entries. The panic log should be empty under normal circumstances. It is
37259 therefore a good idea to check it (or to have a &'cron'& script check it)
37260 regularly, in order to become aware of any problems. When Exim cannot open its
37261 panic log, it tries as a last resort to write to the system log (syslog). This
37262 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37263 message itself is written at priority LOG_CRIT.
37264 .endlist
37265
37266 Every log line starts with a timestamp, in the format shown in the following
37267 example. Note that many of the examples shown in this chapter are line-wrapped.
37268 In the log file, this would be all on one line:
37269 .code
37270 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37271   by QUIT
37272 .endd
37273 By default, the timestamps are in the local timezone. There are two
37274 ways of changing this:
37275
37276 .ilist
37277 You can set the &%timezone%& option to a different time zone; in particular, if
37278 you set
37279 .code
37280 timezone = UTC
37281 .endd
37282 the timestamps will be in UTC (aka GMT).
37283 .next
37284 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37285 example:
37286 .code
37287 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37288 .endd
37289 .endlist
37290
37291 .cindex "log" "process ids in"
37292 .cindex "pid (process id)" "in log lines"
37293 Exim does not include its process id in log lines by default, but you can
37294 request that it does so by specifying the &`pid`& log selector (see section
37295 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37296 brackets, immediately after the time and date.
37297
37298
37299
37300
37301 .section "Where the logs are written" "SECTwhelogwri"
37302 .cindex "log" "destination"
37303 .cindex "log" "to file"
37304 .cindex "log" "to syslog"
37305 .cindex "syslog"
37306 The logs may be written to local files, or to syslog, or both. However, it
37307 should be noted that many syslog implementations use UDP as a transport, and
37308 are therefore unreliable in the sense that messages are not guaranteed to
37309 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37310 It has also been reported that on large log files (tens of megabytes) you may
37311 need to tweak syslog to prevent it syncing the file with each write &-- on
37312 Linux this has been seen to make syslog take 90% plus of CPU time.
37313
37314 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37315 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37316 configuration. This latter string is expanded, so it can contain, for example,
37317 references to the host name:
37318 .code
37319 log_file_path = /var/log/$primary_hostname/exim_%slog
37320 .endd
37321 It is generally advisable, however, to set the string in &_Local/Makefile_&
37322 rather than at runtime, because then the setting is available right from the
37323 start of Exim's execution. Otherwise, if there's something it wants to log
37324 before it has read the configuration file (for example, an error in the
37325 configuration file) it will not use the path you want, and may not be able to
37326 log at all.
37327
37328 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37329 list, currently limited to at most two items. This is one option where the
37330 facility for changing a list separator may not be used. The list must always be
37331 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37332 otherwise the item must either be an absolute path, containing &`%s`& at the
37333 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37334 implying the use of a default path.
37335
37336 When Exim encounters an empty item in the list, it searches the list defined by
37337 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37338 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37339 mean &"use the path specified at build time"&. It no such item exists, log
37340 files are written in the &_log_& subdirectory of the spool directory. This is
37341 equivalent to the setting:
37342 .code
37343 log_file_path = $spool_directory/log/%slog
37344 .endd
37345 If you do not specify anything at build time or runtime,
37346 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37347 that is where the logs are written.
37348
37349 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37350 are in use &-- see section &<<SECTdatlogfil>>& below.
37351
37352 Here are some examples of possible settings:
37353 .display
37354 &`LOG_FILE_PATH=syslog                    `& syslog only
37355 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37356 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37357 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37358 .endd
37359 If there are more than two paths in the list, the first is used and a panic
37360 error is logged.
37361
37362
37363
37364 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37365 .cindex "log" "cycling local files"
37366 .cindex "cycling logs"
37367 .cindex "&'exicyclog'&"
37368 .cindex "log" "local files; writing to"
37369 Some operating systems provide centralized and standardized methods for cycling
37370 log files. For those that do not, a utility script called &'exicyclog'& is
37371 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37372 main and reject logs each time it is called. The maximum number of old logs to
37373 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37374
37375 An Exim delivery process opens the main log when it first needs to write to it,
37376 and it keeps the file open in case subsequent entries are required &-- for
37377 example, if a number of different deliveries are being done for the same
37378 message. However, remote SMTP deliveries can take a long time, and this means
37379 that the file may be kept open long after it is renamed if &'exicyclog'& or
37380 something similar is being used to rename log files on a regular basis. To
37381 ensure that a switch of log files is noticed as soon as possible, Exim calls
37382 &[stat()]& on the main log's name before reusing an open file, and if the file
37383 does not exist, or its inode has changed, the old file is closed and Exim
37384 tries to open the main log from scratch. Thus, an old log file may remain open
37385 for quite some time, but no Exim processes should write to it once it has been
37386 renamed.
37387
37388
37389
37390 .section "Datestamped log files" "SECTdatlogfil"
37391 .cindex "log" "datestamped files"
37392 Instead of cycling the main and reject log files by renaming them
37393 periodically, some sites like to use files whose names contain a datestamp,
37394 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37395 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37396 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37397 point where the datestamp is required. For example:
37398 .code
37399 log_file_path = /var/spool/exim/log/%slog-%D
37400 log_file_path = /var/log/exim-%s-%D.log
37401 log_file_path = /var/spool/exim/log/%D-%slog
37402 log_file_path = /var/log/exim/%s.%M
37403 .endd
37404 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37405 examples of names generated by the above examples:
37406 .code
37407 /var/spool/exim/log/mainlog-20021225
37408 /var/log/exim-reject-20021225.log
37409 /var/spool/exim/log/20021225-mainlog
37410 /var/log/exim/main.200212
37411 .endd
37412 When this form of log file is specified, Exim automatically switches to new
37413 files at midnight. It does not make any attempt to compress old logs; you
37414 will need to write your own script if you require this. You should not
37415 run &'exicyclog'& with this form of logging.
37416
37417 The location of the panic log is also determined by &%log_file_path%&, but it
37418 is not datestamped, because rotation of the panic log does not make sense.
37419 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37420 the string. In addition, if it immediately follows a slash, a following
37421 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37422 character is removed. Thus, the four examples above would give these panic
37423 log names:
37424 .code
37425 /var/spool/exim/log/paniclog
37426 /var/log/exim-panic.log
37427 /var/spool/exim/log/paniclog
37428 /var/log/exim/panic
37429 .endd
37430
37431
37432 .section "Logging to syslog" "SECID249"
37433 .cindex "log" "syslog; writing to"
37434 The use of syslog does not change what Exim logs or the format of its messages,
37435 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37436 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37437 that, the same strings are written to syslog as to log files. The syslog
37438 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37439 by default, but you can change these by setting the &%syslog_facility%& and
37440 &%syslog_processname%& options, respectively. If Exim was compiled with
37441 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37442 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37443 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37444 the time and host name to each line.
37445 The three log streams are mapped onto syslog priorities as follows:
37446
37447 .ilist
37448 &'mainlog'& is mapped to LOG_INFO
37449 .next
37450 &'rejectlog'& is mapped to LOG_NOTICE
37451 .next
37452 &'paniclog'& is mapped to LOG_ALERT
37453 .endlist
37454
37455 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37456 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37457 these are routed by syslog to the same place. You can suppress this duplication
37458 by setting &%syslog_duplication%& false.
37459
37460 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37461 entries contain multiple lines when headers are included. To cope with both
37462 these cases, entries written to syslog are split into separate &[syslog()]&
37463 calls at each internal newline, and also after a maximum of
37464 870 data characters. (This allows for a total syslog line length of 1024, when
37465 additions such as timestamps are added.) If you are running a syslog
37466 replacement that can handle lines longer than the 1024 characters allowed by
37467 RFC 3164, you should set
37468 .code
37469 SYSLOG_LONG_LINES=yes
37470 .endd
37471 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37472 lines, but it still splits at internal newlines in &'reject'& log entries.
37473
37474 To make it easy to re-assemble split lines later, each component of a split
37475 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37476 where <&'n'&> is the component number and <&'m'&> is the total number of
37477 components in the entry. The / delimiter is used when the line was split
37478 because it was too long; if it was split because of an internal newline, the \
37479 delimiter is used. For example, supposing the length limit to be 50 instead of
37480 870, the following would be the result of a typical rejection message to
37481 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37482 name, and pid as added by syslog:
37483 .code
37484 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37485 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37486 [3/5]  when scanning for sender: missing or malformed lo
37487 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37488 [5/5] mple>)
37489 .endd
37490 The same error might cause the following lines to be written to &"rejectlog"&
37491 (LOG_NOTICE):
37492 .code
37493 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37494 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37495 [3/18] er when scanning for sender: missing or malformed
37496 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37497 [5\18] .example>)
37498 [6\18] Recipients: ph10@some.domain.cam.example
37499 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37500 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37501 [9\18]        id 16RdAL-0006pc-00
37502 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37503 [11\18] 09:43 +0100
37504 [12\18] F From: <>
37505 [13\18]   Subject: this is a test header
37506 [18\18]   X-something: this is another header
37507 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37508 [16\18] le>
37509 [17\18] B Bcc:
37510 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37511 .endd
37512 Log lines that are neither too long nor contain newlines are written to syslog
37513 without modification.
37514
37515 If only syslog is being used, the Exim monitor is unable to provide a log tail
37516 display, unless syslog is routing &'mainlog'& to a file on the local host and
37517 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37518 where it is.
37519
37520
37521
37522 .section "Log line flags" "SECID250"
37523 One line is written to the main log for each message received, and for each
37524 successful, unsuccessful, and delayed delivery. These lines can readily be
37525 picked out by the distinctive two-character flags that immediately follow the
37526 timestamp. The flags are:
37527 .display
37528 &`<=`&     message arrival
37529 &`(=`&     message fakereject
37530 &`=>`&     normal message delivery
37531 &`->`&     additional address in same delivery
37532 &`>>`&     cutthrough message delivery
37533 &`*>`&     delivery suppressed by &%-N%&
37534 &`**`&     delivery failed; address bounced
37535 &`==`&     delivery deferred; temporary problem
37536 .endd
37537
37538
37539 .section "Logging message reception" "SECID251"
37540 .cindex "log" "reception line"
37541 The format of the single-line entry in the main log that is written for every
37542 message received is shown in the basic example below, which is split over
37543 several lines in order to fit it on the page:
37544 .code
37545 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37546   H=mailer.fict.example [192.168.123.123] U=exim
37547   P=smtp S=5678 id=<incoming message id>
37548 .endd
37549 The address immediately following &"<="& is the envelope sender address. A
37550 bounce message is shown with the sender address &"<>"&, and if it is locally
37551 generated, this is followed by an item of the form
37552 .code
37553 R=<message id>
37554 .endd
37555 which is a reference to the message that caused the bounce to be sent.
37556
37557 .cindex "HELO"
37558 .cindex "EHLO"
37559 For messages from other hosts, the H and U fields identify the remote host and
37560 record the RFC 1413 identity of the user that sent the message, if one was
37561 received. The number given in square brackets is the IP address of the sending
37562 host. If there is a single, unparenthesized  host name in the H field, as
37563 above, it has been verified to correspond to the IP address (see the
37564 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37565 by the remote host in the SMTP HELO or EHLO command, and has not been
37566 verified. If verification yields a different name to that given for HELO or
37567 EHLO, the verified name appears first, followed by the HELO or EHLO
37568 name in parentheses.
37569
37570 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37571 without brackets, in the HELO or EHLO command, leading to entries in
37572 the log containing text like these examples:
37573 .code
37574 H=(10.21.32.43) [192.168.8.34]
37575 H=([10.21.32.43]) [192.168.8.34]
37576 .endd
37577 This can be confusing. Only the final address in square brackets can be relied
37578 on.
37579
37580 For locally generated messages (that is, messages not received over TCP/IP),
37581 the H field is omitted, and the U field contains the login name of the caller
37582 of Exim.
37583
37584 .cindex "authentication" "logging"
37585 .cindex "AUTH" "logging"
37586 For all messages, the P field specifies the protocol used to receive the
37587 message. This is the value that is stored in &$received_protocol$&. In the case
37588 of incoming SMTP messages, the value indicates whether or not any SMTP
37589 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37590 session was encrypted, there is an additional X field that records the cipher
37591 suite that was used.
37592
37593 .cindex log protocol
37594 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37595 hosts that have authenticated themselves using the SMTP AUTH command. The first
37596 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37597 there is an additional item A= followed by the name of the authenticator that
37598 was used. If an authenticated identification was set up by the authenticator's
37599 &%server_set_id%& option, this is logged too, separated by a colon from the
37600 authenticator name.
37601
37602 .cindex "size" "of message"
37603 The id field records the existing message id, if present. The size of the
37604 received message is given by the S field. When the message is delivered,
37605 headers may be removed or added, so that the size of delivered copies of the
37606 message may not correspond with this value (and indeed may be different to each
37607 other).
37608
37609 The &%log_selector%& option can be used to request the logging of additional
37610 data when a message is received. See section &<<SECTlogselector>>& below.
37611
37612
37613
37614 .section "Logging deliveries" "SECID252"
37615 .cindex "log" "delivery line"
37616 The format of the single-line entry in the main log that is written for every
37617 delivery is shown in one of the examples below, for local and remote
37618 deliveries, respectively. Each example has been split into multiple lines in order
37619 to fit it on the page:
37620 .code
37621 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37622   <marv@hitch.fict.example> R=localuser T=local_delivery
37623 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37624   monk@holistic.fict.example R=dnslookup T=remote_smtp
37625   H=holistic.fict.example [192.168.234.234]
37626 .endd
37627 For ordinary local deliveries, the original address is given in angle brackets
37628 after the final delivery address, which might be a pipe or a file. If
37629 intermediate address(es) exist between the original and the final address, the
37630 last of these is given in parentheses after the final address. The R and T
37631 fields record the router and transport that were used to process the address.
37632
37633 If SMTP AUTH was used for the delivery there is an additional item A=
37634 followed by the name of the authenticator that was used.
37635 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37636 option, this is logged too, separated by a colon from the authenticator name.
37637
37638 If a shadow transport was run after a successful local delivery, the log line
37639 for the successful delivery has an item added on the end, of the form
37640 .display
37641 &`ST=<`&&'shadow transport name'&&`>`&
37642 .endd
37643 If the shadow transport did not succeed, the error message is put in
37644 parentheses afterwards.
37645
37646 .cindex "asterisk" "after IP address"
37647 When more than one address is included in a single delivery (for example, two
37648 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37649 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37650 down a single SMTP connection, an asterisk follows the IP address in the log
37651 lines for the second and subsequent messages.
37652 When two or more messages are delivered down a single TLS connection, the
37653 DNS and some TLS-related information logged for the first message delivered
37654 will not be present in the log lines for the second and subsequent messages.
37655 TLS cipher information is still available.
37656
37657 .cindex "delivery" "cutthrough; logging"
37658 .cindex "cutthrough" "logging"
37659 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37660 line precedes the reception line, since cutthrough waits for a possible
37661 rejection from the destination in case it can reject the sourced item.
37662
37663 The generation of a reply message by a filter file gets logged as a
37664 &"delivery"& to the addressee, preceded by &">"&.
37665
37666 The &%log_selector%& option can be used to request the logging of additional
37667 data when a message is delivered. See section &<<SECTlogselector>>& below.
37668
37669
37670 .section "Discarded deliveries" "SECID253"
37671 .cindex "discarded messages"
37672 .cindex "message" "discarded"
37673 .cindex "delivery" "discarded; logging"
37674 When a message is discarded as a result of the command &"seen finish"& being
37675 obeyed in a filter file which generates no deliveries, a log entry of the form
37676 .code
37677 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37678   <low.club@bridge.example> R=userforward
37679 .endd
37680 is written, to record why no deliveries are logged. When a message is discarded
37681 because it is aliased to &":blackhole:"& the log line is like this:
37682 .code
37683 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37684   <hole@nowhere.example> R=blackhole_router
37685 .endd
37686
37687
37688 .section "Deferred deliveries" "SECID254"
37689 When a delivery is deferred, a line of the following form is logged:
37690 .code
37691 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37692   R=dnslookup T=smtp defer (146): Connection refused
37693 .endd
37694 In the case of remote deliveries, the error is the one that was given for the
37695 last IP address that was tried. Details of individual SMTP failures are also
37696 written to the log, so the above line would be preceded by something like
37697 .code
37698 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37699   mail1.endrest.example [192.168.239.239]: Connection refused
37700 .endd
37701 When a deferred address is skipped because its retry time has not been reached,
37702 a message is written to the log, but this can be suppressed by setting an
37703 appropriate value in &%log_selector%&.
37704
37705
37706
37707 .section "Delivery failures" "SECID255"
37708 .cindex "delivery" "failure; logging"
37709 If a delivery fails because an address cannot be routed, a line of the
37710 following form is logged:
37711 .code
37712 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37713   <jim@trek99.example>: unknown mail domain
37714 .endd
37715 If a delivery fails at transport time, the router and transport are shown, and
37716 the response from the remote host is included, as in this example:
37717 .code
37718 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37719   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37720   after pipelined RCPT TO:<ace400@pb.example>: host
37721   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37722   <ace400@pb.example>...Addressee unknown
37723 .endd
37724 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37725 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37726 disabling PIPELINING. The log lines for all forms of delivery failure are
37727 flagged with &`**`&.
37728
37729
37730
37731 .section "Fake deliveries" "SECID256"
37732 .cindex "delivery" "fake; logging"
37733 If a delivery does not actually take place because the &%-N%& option has been
37734 used to suppress it, a normal delivery line is written to the log, except that
37735 &"=>"& is replaced by &"*>"&.
37736
37737
37738
37739 .section "Completion" "SECID257"
37740 A line of the form
37741 .code
37742 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37743 .endd
37744 is written to the main log when a message is about to be removed from the spool
37745 at the end of its processing.
37746
37747
37748
37749
37750 .section "Summary of Fields in Log Lines" "SECID258"
37751 .cindex "log" "summary of fields"
37752 A summary of the field identifiers that are used in log lines is shown in
37753 the following table:
37754 .display
37755 &`A   `&        authenticator name (and optional id and sender)
37756 &`C   `&        SMTP confirmation on delivery
37757 &`    `&        command list for &"no mail in SMTP session"&
37758 &`CV  `&        certificate verification status
37759 &`D   `&        duration of &"no mail in SMTP session"&
37760 &`DKIM`&        domain verified in incoming message
37761 &`DN  `&        distinguished name from peer certificate
37762 &`DS  `&        DNSSEC secured lookups
37763 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
37764 &`F   `&        sender address (on delivery lines)
37765 &`H   `&        host name and IP address
37766 &`I   `&        local interface used
37767 &`id  `&        message id (from header) for incoming message
37768 &`K   `&        CHUNKING extension used
37769 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37770 &`M8S `&        8BITMIME status for incoming message
37771 &`P   `&        on &`<=`& lines: protocol used
37772 &`    `&        on &`=>`& and &`**`& lines: return path
37773 &`PRDR`&        PRDR extension used
37774 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37775 &`Q   `&        alternate queue name
37776 &`QT  `&        on &`=>`& lines: time spent on queue so far
37777 &`    `&        on &"Completed"& lines: time spent on queue
37778 &`R   `&        on &`<=`& lines: reference for local bounce
37779 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37780 &`RT  `&        on &`<=`& lines: time taken for reception
37781 &`S   `&        size of message in bytes
37782 &`SNI `&        server name indication from TLS client hello
37783 &`ST  `&        shadow transport name
37784 &`T   `&        on &`<=`& lines: message subject (topic)
37785 &`TFO `&        connection took advantage of TCP Fast Open
37786 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37787 &`U   `&        local user or RFC 1413 identity
37788 &`X   `&        TLS cipher suite
37789 .endd
37790
37791
37792 .section "Other log entries" "SECID259"
37793 Various other types of log entry are written from time to time. Most should be
37794 self-explanatory. Among the more common are:
37795
37796 .ilist
37797 .cindex "retry" "time not reached"
37798 &'retry time not reached'&&~&~An address previously suffered a temporary error
37799 during routing or local delivery, and the time to retry has not yet arrived.
37800 This message is not written to an individual message log file unless it happens
37801 during the first delivery attempt.
37802 .next
37803 &'retry time not reached for any host'&&~&~An address previously suffered
37804 temporary errors during remote delivery, and the retry time has not yet arrived
37805 for any of the hosts to which it is routed.
37806 .next
37807 .cindex "spool directory" "file locked"
37808 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37809 some other Exim process is already working on the message. This can be quite
37810 common if queue running processes are started at frequent intervals. The
37811 &'exiwhat'& utility script can be used to find out what Exim processes are
37812 doing.
37813 .next
37814 .cindex "error" "ignored"
37815 &'error ignored'&&~&~There are several circumstances that give rise to this
37816 message:
37817 .olist
37818 Exim failed to deliver a bounce message whose age was greater than
37819 &%ignore_bounce_errors_after%&. The bounce was discarded.
37820 .next
37821 A filter file set up a delivery using the &"noerror"& option, and the delivery
37822 failed. The delivery was discarded.
37823 .next
37824 A delivery set up by a router configured with
37825 . ==== As this is a nested list, any displays it contains must be indented
37826 . ==== as otherwise they are too far to the left.
37827 .code
37828     errors_to = <>
37829 .endd
37830 failed. The delivery was discarded.
37831 .endlist olist
37832 .next
37833 .cindex DKIM "log line"
37834 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37835 logging and the message has a DKIM signature header.
37836 .endlist ilist
37837
37838
37839
37840
37841
37842 .section "Reducing or increasing what is logged" "SECTlogselector"
37843 .cindex "log" "selectors"
37844 By setting the &%log_selector%& global option, you can disable some of Exim's
37845 default logging, or you can request additional logging. The value of
37846 &%log_selector%& is made up of names preceded by plus or minus characters. For
37847 example:
37848 .code
37849 log_selector = +arguments -retry_defer
37850 .endd
37851 The list of optional log items is in the following table, with the default
37852 selection marked by asterisks:
37853 .display
37854 &` 8bitmime                   `&  received 8BITMIME status
37855 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37856 &` address_rewrite            `&  address rewriting
37857 &` all_parents                `&  all parents in => lines
37858 &` arguments                  `&  command line arguments
37859 &`*connection_reject          `&  connection rejections
37860 &`*delay_delivery             `&  immediate delivery delayed
37861 &` deliver_time               `&  time taken to attempt delivery
37862 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37863 &`*dkim                       `&  DKIM verified domain on <= lines
37864 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37865 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37866 &` dnssec                     `&  DNSSEC secured lookups
37867 &`*etrn                       `&  ETRN commands
37868 &`*host_lookup_failed         `&  as it says
37869 &` ident_timeout              `&  timeout for ident connection
37870 &` incoming_interface         `&  local interface on <= and => lines
37871 &` incoming_port              `&  remote port on <= lines
37872 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37873 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37874 &`*msg_id                     `&  on <= lines, Message-ID: header value
37875 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37876 &` outgoing_interface         `&  local interface on => lines
37877 &` outgoing_port              `&  add remote port to => lines
37878 &`*queue_run                  `&  start and end queue runs
37879 &` queue_time                 `&  time on queue for one recipient
37880 &` queue_time_overall         `&  time on queue for whole message
37881 &` pid                        `&  Exim process id
37882 &` pipelining                 `&  PIPELINING use, on <= and => lines
37883 &` proxy                      `&  proxy address on <= and => lines
37884 &` receive_time               `&  time taken to receive message
37885 &` received_recipients        `&  recipients on <= lines
37886 &` received_sender            `&  sender on <= lines
37887 &`*rejected_header            `&  header contents on reject log
37888 &`*retry_defer                `&  &"retry time not reached"&
37889 &` return_path_on_delivery    `&  put return path on => and ** lines
37890 &` sender_on_delivery         `&  add sender to => lines
37891 &`*sender_verify_fail         `&  sender verification failures
37892 &`*size_reject                `&  rejection because too big
37893 &`*skip_delivery              `&  delivery skipped in a queue run
37894 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37895 &` smtp_connection            `&  incoming SMTP connections
37896 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37897 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37898 &` smtp_no_mail               `&  session with no MAIL commands
37899 &` smtp_protocol_error        `&  SMTP protocol errors
37900 &` smtp_syntax_error          `&  SMTP syntax errors
37901 &` subject                    `&  contents of &'Subject:'& on <= lines
37902 &`*tls_certificate_verified   `&  certificate verification status
37903 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37904 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37905 &` tls_sni                    `&  TLS SNI on <= lines
37906 &` unknown_in_list            `&  DNS lookup failed in list match
37907
37908 &` all                        `&  all of the above
37909 .endd
37910 See also the &%slow_lookup_log%& main configuration option,
37911 section &<<SECID99>>&
37912
37913 More details on each of these items follows:
37914
37915 .ilist
37916 .cindex "8BITMIME"
37917 .cindex "log" "8BITMIME"
37918 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37919 which may help in tracking down interoperability issues with ancient MTAs
37920 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37921 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37922 &`7BIT`& and &`8BITMIME`& respectively.
37923 .next
37924 .cindex "&%warn%& ACL verb" "log when skipping"
37925 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37926 its conditions cannot be evaluated, a log line to this effect is written if
37927 this log selector is set.
37928 .next
37929 .cindex "log" "rewriting"
37930 .cindex "rewriting" "logging"
37931 &%address_rewrite%&: This applies both to global rewrites and per-transport
37932 rewrites, but not to rewrites in filters run as an unprivileged user (because
37933 such users cannot access the log).
37934 .next
37935 .cindex "log" "full parentage"
37936 &%all_parents%&: Normally only the original and final addresses are logged on
37937 delivery lines; with this selector, intermediate parents are given in
37938 parentheses between them.
37939 .next
37940 .cindex "log" "Exim arguments"
37941 .cindex "Exim arguments, logging"
37942 &%arguments%&: This causes Exim to write the arguments with which it was called
37943 to the main log, preceded by the current working directory. This is a debugging
37944 feature, added to make it easier to find out how certain MUAs call
37945 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37946 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37947 that are empty or that contain white space are quoted. Non-printing characters
37948 are shown as escape sequences. This facility cannot log unrecognized arguments,
37949 because the arguments are checked before the configuration file is read. The
37950 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37951 between the caller and Exim.
37952 .next
37953 .cindex "log" "connection rejections"
37954 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37955 connection is rejected, for whatever reason.
37956 .next
37957 .cindex "log" "delayed delivery"
37958 .cindex "delayed delivery, logging"
37959 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37960 started for an incoming message because the load is too high or too many
37961 messages were received on one connection. Logging does not occur if no delivery
37962 process is started because &%queue_only%& is set or &%-odq%& was used.
37963 .next
37964 .cindex "log" "delivery duration"
37965 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37966 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37967 If millisecond logging is enabled, short times will be shown with greater
37968 precision, eg. &`DT=0.304s`&.
37969 .next
37970 .cindex "log" "message size on delivery"
37971 .cindex "size" "of message"
37972 &%delivery_size%&: For each delivery, the size of message delivered is added to
37973 the &"=>"& line, tagged with S=.
37974 .next
37975 .cindex log "DKIM verification"
37976 .cindex DKIM "verification logging"
37977 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37978 verifies successfully a tag of DKIM is added, with one of the verified domains.
37979 .next
37980 .cindex log "DKIM verification"
37981 .cindex DKIM "verification logging"
37982 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37983 .next
37984 .cindex "log" "dnslist defer"
37985 .cindex "DNS list" "logging defer"
37986 .cindex "black list (DNS)"
37987 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37988 DNS black list suffers a temporary error.
37989 .next
37990 .cindex log dnssec
37991 .cindex dnssec logging
37992 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37993 dns lookups gave secure results a tag of DS is added.
37994 For acceptance this covers the reverse and forward lookups for host name verification.
37995 It does not cover helo-name verification.
37996 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37997 .next
37998 .cindex "log" "ETRN commands"
37999 .cindex "ETRN" "logging"
38000 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38001 is run to determine whether or not it is actually accepted. An invalid ETRN
38002 command, or one received within a message transaction is not logged by this
38003 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38004 .next
38005 .cindex "log" "host lookup failure"
38006 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38007 any addresses, or when a lookup of an IP address fails to find a host name, a
38008 log line is written. This logging does not apply to direct DNS lookups when
38009 routing email addresses, but it does apply to &"byname"& lookups.
38010 .next
38011 .cindex "log" "ident timeout"
38012 .cindex "RFC 1413" "logging timeout"
38013 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38014 client's ident port times out.
38015 .next
38016 .cindex "log" "incoming interface"
38017 .cindex "log" "local interface"
38018 .cindex "log" "local address and port"
38019 .cindex "TCP/IP" "logging local address and port"
38020 .cindex "interface" "logging"
38021 &%incoming_interface%&: The interface on which a message was received is added
38022 to the &"<="& line as an IP address in square brackets, tagged by I= and
38023 followed by a colon and the port number. The local interface and port are also
38024 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38025 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
38026 The latter can be disabled by turning off the &%outgoing_interface%& option.
38027 .next
38028 .cindex log "incoming proxy address"
38029 .cindex proxy "logging proxy address"
38030 .cindex "TCP/IP" "logging proxy address"
38031 &%proxy%&: The internal (closest to the system running Exim) IP address
38032 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38033 on a proxied connection
38034 or the &"=>"& line for a message delivered on a proxied connection.
38035 See &<<SECTproxyInbound>>& for more information.
38036 .next
38037 .cindex "log" "incoming remote port"
38038 .cindex "port" "logging remote"
38039 .cindex "TCP/IP" "logging incoming remote port"
38040 .vindex "&$sender_fullhost$&"
38041 .vindex "&$sender_rcvhost$&"
38042 &%incoming_port%&: The remote port number from which a message was received is
38043 added to log entries and &'Received:'& header lines, following the IP address
38044 in square brackets, and separated from it by a colon. This is implemented by
38045 changing the value that is put in the &$sender_fullhost$& and
38046 &$sender_rcvhost$& variables. Recording the remote port number has become more
38047 important with the widening use of NAT (see RFC 2505).
38048 .next
38049 .cindex "log" "dropped connection"
38050 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38051 connection is unexpectedly dropped.
38052 .next
38053 .cindex "log" "millisecond timestamps"
38054 .cindex millisecond logging
38055 .cindex timestamps "millisecond, in logs"
38056 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38057 appended to the seconds value.
38058 .next
38059 .cindex "log" "message id"
38060 &%msg_id%&: The value of the Message-ID: header.
38061 .next
38062 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38063 This will be either because the message is a bounce, or was submitted locally
38064 (submission mode) without one.
38065 The field identifier will have an asterix appended: &"id*="&.
38066 .next
38067 .cindex "log" "outgoing interface"
38068 .cindex "log" "local interface"
38069 .cindex "log" "local address and port"
38070 .cindex "TCP/IP" "logging local address and port"
38071 .cindex "interface" "logging"
38072 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38073 interface on which a message was sent is added to delivery lines as an I= tag
38074 followed by IP address in square brackets. You can disable this by turning
38075 off the &%outgoing_interface%& option.
38076 .next
38077 .cindex "log" "outgoing remote port"
38078 .cindex "port" "logging outgoing remote"
38079 .cindex "TCP/IP" "logging outgoing remote port"
38080 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38081 containing => tags) following the IP address.
38082 The local port is also added if &%incoming_interface%& and
38083 &%outgoing_interface%& are both enabled.
38084 This option is not included in the default setting, because for most ordinary
38085 configurations, the remote port number is always 25 (the SMTP port), and the
38086 local port is a random ephemeral port.
38087 .next
38088 .cindex "log" "process ids in"
38089 .cindex "pid (process id)" "in log lines"
38090 &%pid%&: The current process id is added to every log line, in square brackets,
38091 immediately after the time and date.
38092 .next
38093 .cindex log pipelining
38094 .cindex pipelining "logging outgoing"
38095 &%pipelining%&: A field is added to delivery and accept
38096 log lines when the ESMTP PIPELINING extension was used.
38097 The field is a single "L".
38098
38099 On accept lines, where PIPELINING was offered but not used by the client,
38100 the field has a minus appended.
38101
38102 .cindex "pipelining" "early connection"
38103 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38104 accept "L" fields have a period appended if the feature was
38105 offered but not used, or an asterisk appended if used.
38106 Delivery "L" fields have an asterisk appended if used.
38107
38108 .next
38109 .cindex "log" "queue run"
38110 .cindex "queue runner" "logging"
38111 &%queue_run%&: The start and end of every queue run are logged.
38112 .next
38113 .cindex "log" "queue time"
38114 &%queue_time%&: The amount of time the message has been in the queue on the
38115 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38116 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38117 includes reception time as well as the delivery time for the current address.
38118 This means that it may be longer than the difference between the arrival and
38119 delivery log line times, because the arrival log line is not written until the
38120 message has been successfully received.
38121 If millisecond logging is enabled, short times will be shown with greater
38122 precision, eg. &`QT=1.578s`&.
38123 .next
38124 &%queue_time_overall%&: The amount of time the message has been in the queue on
38125 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38126 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38127 message, so it includes reception time as well as the total delivery time.
38128 .next
38129 .cindex "log" "receive duration"
38130 &%receive_time%&: For each message, the amount of real time it has taken to
38131 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38132 If millisecond logging is enabled, short times will be shown with greater
38133 precision, eg. &`RT=0.204s`&.
38134 .next
38135 .cindex "log" "recipients"
38136 &%received_recipients%&: The recipients of a message are listed in the main log
38137 as soon as the message is received. The list appears at the end of the log line
38138 that is written when a message is received, preceded by the word &"for"&. The
38139 addresses are listed after they have been qualified, but before any rewriting
38140 has taken place.
38141 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38142 in the list.
38143 .next
38144 .cindex "log" "sender reception"
38145 &%received_sender%&: The unrewritten original sender of a message is added to
38146 the end of the log line that records the message's arrival, after the word
38147 &"from"& (before the recipients if &%received_recipients%& is also set).
38148 .next
38149 .cindex "log" "header lines for rejection"
38150 &%rejected_header%&: If a message's header has been received at the time a
38151 rejection is written to the reject log, the complete header is added to the
38152 log. Header logging can be turned off individually for messages that are
38153 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38154 .next
38155 .cindex "log" "retry defer"
38156 &%retry_defer%&: A log line is written if a delivery is deferred because a
38157 retry time has not yet been reached. However, this &"retry time not reached"&
38158 message is always omitted from individual message logs after the first delivery
38159 attempt.
38160 .next
38161 .cindex "log" "return path"
38162 &%return_path_on_delivery%&: The return path that is being transmitted with
38163 the message is included in delivery and bounce lines, using the tag P=.
38164 This is omitted if no delivery actually happens, for example, if routing fails,
38165 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38166 .next
38167 .cindex "log" "sender on delivery"
38168 &%sender_on_delivery%&: The message's sender address is added to every delivery
38169 and bounce line, tagged by F= (for &"from"&).
38170 This is the original sender that was received with the message; it is not
38171 necessarily the same as the outgoing return path.
38172 .next
38173 .cindex "log" "sender verify failure"
38174 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38175 gives details of a sender verification failure is not written. Log lines for
38176 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38177 detail is lost.
38178 .next
38179 .cindex "log" "size rejection"
38180 &%size_reject%&: A log line is written whenever a message is rejected because
38181 it is too big.
38182 .next
38183 .cindex "log" "frozen messages; skipped"
38184 .cindex "frozen messages" "logging skipping"
38185 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38186 queue run because it is frozen or because another process is already delivering
38187 it.
38188 .cindex "&""spool file is locked""&"
38189 The message that is written is &"spool file is locked"&.
38190 .next
38191 .cindex "log" "smtp confirmation"
38192 .cindex "SMTP" "logging confirmation"
38193 .cindex "LMTP" "logging confirmation"
38194 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38195 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38196 A number of MTAs (including Exim) return an identifying string in this
38197 response.
38198 .next
38199 .cindex "log" "SMTP connections"
38200 .cindex "SMTP" "logging connections"
38201 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38202 established or closed, unless the connection is from a host that matches
38203 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38204 only when the closure is unexpected.) This applies to connections from local
38205 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38206 dropped in the middle of a message, a log line is always written, whether or
38207 not this selector is set, but otherwise nothing is written at the start and end
38208 of connections unless this selector is enabled.
38209
38210 For TCP/IP connections to an Exim daemon, the current number of connections is
38211 included in the log message for each new connection, but note that the count is
38212 reset if the daemon is restarted.
38213 Also, because connections are closed (and the closure is logged) in
38214 subprocesses, the count may not include connections that have been closed but
38215 whose termination the daemon has not yet noticed. Thus, while it is possible to
38216 match up the opening and closing of connections in the log, the value of the
38217 logged counts may not be entirely accurate.
38218 .next
38219 .cindex "log" "SMTP transaction; incomplete"
38220 .cindex "SMTP" "logging incomplete transactions"
38221 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38222 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38223 and the message sender plus any accepted recipients are included in the log
38224 line. This can provide evidence of dictionary attacks.
38225 .next
38226 .cindex "log" "non-MAIL SMTP sessions"
38227 .cindex "MAIL" "logging session without"
38228 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38229 connection terminates without having issued a MAIL command. This includes both
38230 the case when the connection is dropped, and the case when QUIT is used. It
38231 does not include cases where the connection is rejected right at the start (by
38232 an ACL, or because there are too many connections, or whatever). These cases
38233 already have their own log lines.
38234
38235 The log line that is written contains the identity of the client in the usual
38236 way, followed by D= and a time, which records the duration of the connection.
38237 If the connection was authenticated, this fact is logged exactly as it is for
38238 an incoming message, with an A= item. If the connection was encrypted, CV=,
38239 DN=, and X= items may appear as they do for an incoming message, controlled by
38240 the same logging options.
38241
38242 Finally, if any SMTP commands were issued during the connection, a C= item
38243 is added to the line, listing the commands that were used. For example,
38244 .code
38245 C=EHLO,QUIT
38246 .endd
38247 shows that the client issued QUIT straight after EHLO. If there were fewer
38248 than 20 commands, they are all listed. If there were more than 20 commands,
38249 the last 20 are listed, preceded by &"..."&. However, with the default
38250 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38251 have been aborted before 20 non-mail commands are processed.
38252 .next
38253 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38254 colon-separated, is appended to the A= item for a message arrival or delivery
38255 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38256 was accepted or used.
38257 .next
38258 .cindex "log" "SMTP protocol error"
38259 .cindex "SMTP" "logging protocol error"
38260 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38261 encountered. Exim does not have perfect detection of all protocol errors
38262 because of transmission delays and the use of pipelining. If PIPELINING has
38263 been advertised to a client, an Exim server assumes that the client will use
38264 it, and therefore it does not count &"expected"& errors (for example, RCPT
38265 received after rejecting MAIL) as protocol errors.
38266 .next
38267 .cindex "SMTP" "logging syntax errors"
38268 .cindex "SMTP" "syntax errors; logging"
38269 .cindex "SMTP" "unknown command; logging"
38270 .cindex "log" "unknown SMTP command"
38271 .cindex "log" "SMTP syntax error"
38272 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38273 encountered. An unrecognized command is treated as a syntax error. For an
38274 external connection, the host identity is given; for an internal connection
38275 using &%-bs%& the sender identification (normally the calling user) is given.
38276 .next
38277 .cindex "log" "subject"
38278 .cindex "subject, logging"
38279 &%subject%&: The subject of the message is added to the arrival log line,
38280 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38281 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38282 specifies whether characters with values greater than 127 should be logged
38283 unchanged, or whether they should be rendered as escape sequences.
38284 .next
38285 .cindex "log" "certificate verification"
38286 .cindex log DANE
38287 .cindex DANE logging
38288 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38289 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38290 verified
38291 using a CA trust anchor,
38292 &`CA=dane`& if using a DNS trust anchor,
38293 and &`CV=no`& if not.
38294 .next
38295 .cindex "log" "TLS cipher"
38296 .cindex "TLS" "logging cipher"
38297 &%tls_cipher%&: When a message is sent or received over an encrypted
38298 connection, the cipher suite used is added to the log line, preceded by X=.
38299 .next
38300 .cindex "log" "TLS peer DN"
38301 .cindex "TLS" "logging peer DN"
38302 &%tls_peerdn%&: When a message is sent or received over an encrypted
38303 connection, and a certificate is supplied by the remote host, the peer DN is
38304 added to the log line, preceded by DN=.
38305 .next
38306 .cindex "log" "TLS SNI"
38307 .cindex "TLS" "logging SNI"
38308 &%tls_sni%&: When a message is received over an encrypted connection, and
38309 the remote host provided the Server Name Indication extension, the SNI is
38310 added to the log line, preceded by SNI=.
38311 .next
38312 .cindex "log" "DNS failure in list"
38313 &%unknown_in_list%&: This setting causes a log entry to be written when the
38314 result of a list match is failure because a DNS lookup failed.
38315 .endlist
38316
38317
38318 .section "Message log" "SECID260"
38319 .cindex "message" "log file for"
38320 .cindex "log" "message log; description of"
38321 .cindex "&_msglog_& directory"
38322 .oindex "&%preserve_message_logs%&"
38323 In addition to the general log files, Exim writes a log file for each message
38324 that it handles. The names of these per-message logs are the message ids, and
38325 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38326 message log contains copies of the log lines that apply to the message. This
38327 makes it easier to inspect the status of an individual message without having
38328 to search the main log. A message log is deleted when processing of the message
38329 is complete, unless &%preserve_message_logs%& is set, but this should be used
38330 only with great care because they can fill up your disk very quickly.
38331
38332 On a heavily loaded system, it may be desirable to disable the use of
38333 per-message logs, in order to reduce disk I/O. This can be done by setting the
38334 &%message_logs%& option false.
38335 .ecindex IIDloggen
38336
38337
38338
38339
38340 . ////////////////////////////////////////////////////////////////////////////
38341 . ////////////////////////////////////////////////////////////////////////////
38342
38343 .chapter "Exim utilities" "CHAPutils"
38344 .scindex IIDutils "utilities"
38345 A number of utility scripts and programs are supplied with Exim and are
38346 described in this chapter. There is also the Exim Monitor, which is covered in
38347 the next chapter. The utilities described here are:
38348
38349 .itable none 0 0 3  7* left  15* left  40* left
38350 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38351   "list what Exim processes are doing"
38352 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38353 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38354 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38355 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38356                                                 various criteria"
38357 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38358 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38359   "extract statistics from the log"
38360 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38361   "check address acceptance from given IP"
38362 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38363 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38364 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38365 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38366 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38367 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38368 .endtable
38369
38370 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38371 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38372 &url(https://duncanthrax.net/exilog/) for details.
38373
38374
38375
38376
38377 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38378 .cindex "&'exiwhat'&"
38379 .cindex "process, querying"
38380 .cindex "SIGUSR1"
38381 On operating systems that can restart a system call after receiving a signal
38382 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38383 a line describing what it is doing to the file &_exim-process.info_& in the
38384 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38385 processes it can find, having first emptied the file. It then waits for one
38386 second to allow the Exim processes to react before displaying the results. In
38387 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38388 send the signal to the Exim processes, so it is normally run as root.
38389
38390 &*Warning*&: This is not an efficient process. It is intended for occasional
38391 use by system administrators. It is not sensible, for example, to set up a
38392 script that sends SIGUSR1 signals to Exim processes at short intervals.
38393
38394
38395 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38396 varies in different operating systems. Not only are different options used,
38397 but the format of the output is different. For this reason, there are some
38398 system configuration options that configure exactly how &'exiwhat'& works. If
38399 it doesn't seem to be working for you, check the following compile-time
38400 options:
38401 .display
38402 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38403 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38404 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38405 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38406 .endd
38407 An example of typical output from &'exiwhat'& is
38408 .code
38409 164 daemon: -q1h, listening on port 25
38410 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38411 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38412   [10.19.42.42] (editor@ref.example)
38413 10592 handling incoming call from [192.168.243.242]
38414 10628 accepting a local non-SMTP message
38415 .endd
38416 The first number in the output line is the process number. The third line has
38417 been split here, in order to fit it on the page.
38418
38419
38420
38421 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38422 .cindex "&'exiqgrep'&"
38423 .cindex "queue" "grepping"
38424 This utility is a Perl script contributed by Matt Hubbard. It runs
38425 .code
38426 exim -bpu
38427 .endd
38428 or (in case &*-a*& switch is specified)
38429 .code
38430 exim -bp
38431 .endd
38432 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38433 contain alternate exim configuration the queue management might be using.
38434
38435 to obtain a queue listing, and then greps the output to select messages
38436 that match given criteria. The following selection options are available:
38437
38438 .vlist
38439 .vitem &*-f*&&~<&'regex'&>
38440 Match the sender address using a case-insensitive search. The field that is
38441 tested is enclosed in angle brackets, so you can test for bounce messages with
38442 .code
38443 exiqgrep -f '^<>$'
38444 .endd
38445 .vitem &*-r*&&~<&'regex'&>
38446 Match a recipient address using a case-insensitive search. The field that is
38447 tested is not enclosed in angle brackets.
38448
38449 .vitem &*-s*&&~<&'regex'&>
38450 Match against the size field.
38451
38452 .vitem &*-y*&&~<&'seconds'&>
38453 Match messages that are younger than the given time.
38454
38455 .vitem &*-o*&&~<&'seconds'&>
38456 Match messages that are older than the given time.
38457
38458 .vitem &*-z*&
38459 Match only frozen messages.
38460
38461 .vitem &*-x*&
38462 Match only non-frozen messages.
38463
38464 .vitem &*-G*&&~<&'queuename'&>
38465 Match only messages in the given queue.  Without this, the default queue is searched.
38466 .endlist
38467
38468 The following options control the format of the output:
38469
38470 .vlist
38471 .vitem &*-c*&
38472 Display only the count of matching messages.
38473
38474 .vitem &*-l*&
38475 Long format &-- display the full message information as output by Exim. This is
38476 the default.
38477
38478 .vitem &*-i*&
38479 Display message ids only.
38480
38481 .vitem &*-b*&
38482 Brief format &-- one line per message.
38483
38484 .vitem &*-R*&
38485 Display messages in reverse order.
38486
38487 .vitem &*-a*&
38488 Include delivered recipients in queue listing.
38489 .endlist
38490
38491 There is one more option, &%-h%&, which outputs a list of options.
38492
38493
38494
38495 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38496 .cindex "&'exiqsumm'&"
38497 .cindex "queue" "summary"
38498 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38499 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38500 running a command such as
38501 .code
38502 exim -bp | exiqsumm
38503 .endd
38504 The output consists of one line for each domain that has messages waiting for
38505 it, as in the following example:
38506 .code
38507 3   2322   74m   66m  msn.com.example
38508 .endd
38509 Each line lists the number of pending deliveries for a domain, their total
38510 volume, and the length of time that the oldest and the newest messages have
38511 been waiting. Note that the number of pending deliveries is greater than the
38512 number of messages when messages have more than one recipient.
38513
38514 A summary line is output at the end. By default the output is sorted on the
38515 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38516 the output to be sorted by oldest message and by count of messages,
38517 respectively. There are also three options that split the messages for each
38518 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38519 separates frozen messages, and &%-s%& separates messages according to their
38520 sender.
38521
38522 The output of &'exim -bp'& contains the original addresses in the message, so
38523 this also applies to the output from &'exiqsumm'&. No domains from addresses
38524 generated by aliasing or forwarding are included (unless the &%one_time%&
38525 option of the &(redirect)& router has been used to convert them into &"top
38526 level"& addresses).
38527
38528
38529
38530
38531 .section "Extracting specific information from the log (exigrep)" &&&
38532          "SECTextspeinf"
38533 .cindex "&'exigrep'&"
38534 .cindex "log" "extracts; grepping for"
38535 The &'exigrep'& utility is a Perl script that searches one or more main log
38536 files for entries that match a given pattern. When it finds a match, it
38537 extracts all the log entries for the relevant message, not just those that
38538 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38539 given message, or all mail for a given user, or for a given host, for example.
38540 The input files can be in Exim log format or syslog format.
38541 If a matching log line is not associated with a specific message, it is
38542 included in &'exigrep'&'s output without any additional lines. The usage is:
38543 .display
38544 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38545 .endd
38546 If no log filenames are given on the command line, the standard input is read.
38547
38548 The &%-t%& argument specifies a number of seconds. It adds an additional
38549 condition for message selection. Messages that are complete are shown only if
38550 they spent more than <&'n'&> seconds in the queue.
38551
38552 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38553 makes it case-sensitive. This may give a performance improvement when searching
38554 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38555 option; with &%-I%& they do not. In both cases it is possible to change the
38556 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38557
38558 The &%-l%& option means &"literal"&, that is, treat all characters in the
38559 pattern as standing for themselves. Otherwise the pattern must be a Perl
38560 regular expression.
38561
38562 The &%-v%& option inverts the matching condition. That is, a line is selected
38563 if it does &'not'& match the pattern.
38564
38565 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38566 that are generated as a result/response to a message that &'exigrep'& matched
38567 normally.
38568
38569 Example of &%-M%&:
38570 user_a sends a message to user_b, which generates a bounce back to user_b. If
38571 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38572 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38573 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38574 when searching for &"user_a"& will show both messages since the bounce is
38575 &"related"& to or a &"result"& of the first message that was found by the
38576 search term.
38577
38578 If the location of a &'zcat'& command is known from the definition of
38579 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38580 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38581 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38582 autodetection of some well known compression extensions.
38583
38584
38585 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38586 .cindex "&'exipick'&"
38587 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38588 lists messages from the queue according to a variety of criteria. For details
38589 of &'exipick'&'s facilities, run &'exipick'& with
38590 the &%--help%& option.
38591
38592
38593 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38594 .cindex "log" "cycling local files"
38595 .cindex "cycling logs"
38596 .cindex "&'exicyclog'&"
38597 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38598 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38599 you are using log files with datestamps in their names (see section
38600 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38601 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38602 There are two command line options for &'exicyclog'&:
38603 .ilist
38604 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38605 default that is set when Exim is built. The default default is 10.
38606 .next
38607 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38608 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38609 overriding the script's default, which is to find the setting from Exim's
38610 configuration.
38611 .endlist
38612
38613 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38614 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38615 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38616 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38617 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38618 logs are handled similarly.
38619
38620 If the limit is greater than 99, the script uses 3-digit numbers such as
38621 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38622 to one that is greater, or &'vice versa'&, you will have to fix the names of
38623 any existing log files.
38624
38625 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38626 the end are deleted. All files with numbers greater than 01 are compressed,
38627 using a compression command which is configured by the COMPRESS_COMMAND
38628 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38629 root &%crontab%& entry of the form
38630 .code
38631 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38632 .endd
38633 assuming you have used the name &"exim"& for the Exim user. You can run
38634 &'exicyclog'& as root if you wish, but there is no need.
38635
38636
38637
38638 .section "Mail statistics (eximstats)" "SECTmailstat"
38639 .cindex "statistics"
38640 .cindex "&'eximstats'&"
38641 A Perl script called &'eximstats'& is provided for extracting statistical
38642 information from log files. The output is either plain text, or HTML.
38643 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38644 . --- 404 error and everything else points to that.
38645
38646 The &'eximstats'& script has been hacked about quite a bit over time. The
38647 latest version is the result of some extensive revision by Steve Campbell. A
38648 lot of information is given by default, but there are options for suppressing
38649 various parts of it. Following any options, the arguments to the script are a
38650 list of files, which should be main log files. For example:
38651 .code
38652 eximstats -nr /var/spool/exim/log/mainlog.01
38653 .endd
38654 By default, &'eximstats'& extracts information about the number and volume of
38655 messages received from or delivered to various hosts. The information is sorted
38656 both by message count and by volume, and the top fifty hosts in each category
38657 are listed on the standard output. Similar information, based on email
38658 addresses or domains instead of hosts can be requested by means of various
38659 options. For messages delivered and received locally, similar statistics are
38660 also produced per user.
38661
38662 The output also includes total counts and statistics about delivery errors, and
38663 histograms showing the number of messages received and deliveries made in each
38664 hour of the day. A delivery with more than one address in its envelope (for
38665 example, an SMTP transaction with more than one RCPT command) is counted
38666 as a single delivery by &'eximstats'&.
38667
38668 Though normally more deliveries than receipts are reported (as messages may
38669 have multiple recipients), it is possible for &'eximstats'& to report more
38670 messages received than delivered, even though the queue is empty at the start
38671 and end of the period in question. If an incoming message contains no valid
38672 recipients, no deliveries are recorded for it. A bounce message is handled as
38673 an entirely separate message.
38674
38675 &'eximstats'& always outputs a grand total summary giving the volume and number
38676 of messages received and deliveries made, and the number of hosts involved in
38677 each case. It also outputs the number of messages that were delayed (that is,
38678 not completely delivered at the first attempt), and the number that had at
38679 least one address that failed.
38680
38681 The remainder of the output is in sections that can be independently disabled
38682 or modified by various options. It consists of a summary of deliveries by
38683 transport, histograms of messages received and delivered per time interval
38684 (default per hour), information about the time messages spent in the queue,
38685 a list of relayed messages, lists of the top fifty sending hosts, local
38686 senders, destination hosts, and destination local users by count and by volume,
38687 and a list of delivery errors that occurred.
38688
38689 The relay information lists messages that were actually relayed, that is, they
38690 came from a remote host and were directly delivered to some other remote host,
38691 without being processed (for example, for aliasing or forwarding) locally.
38692
38693 There are quite a few options for &'eximstats'& to control exactly what it
38694 outputs. These are documented in the Perl script itself, and can be extracted
38695 by running the command &(perldoc)& on the script. For example:
38696 .code
38697 perldoc /usr/exim/bin/eximstats
38698 .endd
38699
38700 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38701 .cindex "&'exim_checkaccess'&"
38702 .cindex "policy control" "checking access"
38703 .cindex "checking access"
38704 The &%-bh%& command line argument allows you to run a fake SMTP session with
38705 debugging output, in order to check what Exim is doing when it is applying
38706 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38707 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38708 sometimes you just want to answer the question &"Does this address have
38709 access?"& without bothering with any further details.
38710
38711 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38712 two arguments, an IP address and an email address:
38713 .code
38714 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38715 .endd
38716 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38717 given email address would be accepted in a RCPT command in a TCP/IP
38718 connection from the host with the given IP address. The output of the utility
38719 is either the word &"accepted"&, or the SMTP error response, for example:
38720 .code
38721 Rejected:
38722 550 Relay not permitted
38723 .endd
38724 When running this test, the utility uses &`<>`& as the envelope sender address
38725 for the MAIL command, but you can change this by providing additional
38726 options. These are passed directly to the Exim command. For example, to specify
38727 that the test is to be run with the sender address &'himself@there.example'&
38728 you can use:
38729 .code
38730 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38731                  -f himself@there.example
38732 .endd
38733 Note that these additional Exim command line items must be given after the two
38734 mandatory arguments.
38735
38736 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38737 while running its checks. You can run checks that include callouts by using
38738 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38739
38740
38741
38742 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38743 .cindex "DBM" "building dbm files"
38744 .cindex "building DBM files"
38745 .cindex "&'exim_dbmbuild'&"
38746 .cindex "lower casing"
38747 .cindex "binary zero" "in lookup key"
38748 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38749 the format used by the &(lsearch)& lookup (see section
38750 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38751 names as keys and the remainder of the information as data. The lower-casing
38752 can be prevented by calling the program with the &%-nolc%& option.
38753
38754 A terminating zero is included as part of the key string. This is expected by
38755 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38756 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38757 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38758 files.
38759
38760 The program requires two arguments: the name of the input file (which can be a
38761 single hyphen to indicate the standard input), and the name of the output file.
38762 It creates the output under a temporary name, and then renames it if all went
38763 well.
38764
38765 .cindex "USE_DB"
38766 If the native DB interface is in use (USE_DB is set in a compile-time
38767 configuration file &-- this is common in free versions of Unix) the two
38768 filenames must be different, because in this mode the Berkeley DB functions
38769 create a single output file using exactly the name given. For example,
38770 .code
38771 exim_dbmbuild /etc/aliases /etc/aliases.db
38772 .endd
38773 reads the system alias file and creates a DBM version of it in
38774 &_/etc/aliases.db_&.
38775
38776 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38777 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38778 environment, the suffixes are added to the second argument of
38779 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38780 when the Berkeley functions are used in compatibility mode (though this is not
38781 recommended), because in that case it adds a &_.db_& suffix to the filename.
38782
38783 If a duplicate key is encountered, the program outputs a warning, and when it
38784 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38785 option is used. By default, only the first of a set of duplicates is used &--
38786 this makes it compatible with &(lsearch)& lookups. There is an option
38787 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38788 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38789 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38790 return code is 2.
38791
38792
38793
38794
38795 .section "Finding individual retry times (exinext)" "SECTfinindret"
38796 .cindex "retry" "times"
38797 .cindex "&'exinext'&"
38798 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38799 fish specific information out of the retry database. Given a mail domain (or a
38800 complete address), it looks up the hosts for that domain, and outputs any retry
38801 information for the hosts or for the domain. At present, the retry information
38802 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38803 output. For example:
38804 .code
38805 $ exinext piglet@milne.fict.example
38806 kanga.milne.example:192.168.8.1 error 146: Connection refused
38807   first failed: 21-Feb-1996 14:57:34
38808   last tried:   21-Feb-1996 14:57:34
38809   next try at:  21-Feb-1996 15:02:34
38810 roo.milne.example:192.168.8.3 error 146: Connection refused
38811   first failed: 20-Jan-1996 13:12:08
38812   last tried:   21-Feb-1996 11:42:03
38813   next try at:  21-Feb-1996 19:42:03
38814   past final cutoff time
38815 .endd
38816 You can also give &'exinext'& a local part, without a domain, and it
38817 will give any retry information for that local part in your default domain.
38818 A message id can be used to obtain retry information pertaining to a specific
38819 message. This exists only when an attempt to deliver a message to a remote host
38820 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38821 &'exinext'& is not particularly efficient, but then it is not expected to be
38822 run very often.
38823
38824 The &'exinext'& utility calls Exim to find out information such as the location
38825 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38826 passed on to the &'exim'& commands. The first specifies an alternate Exim
38827 configuration file, and the second sets macros for use within the configuration
38828 file. These features are mainly to help in testing, but might also be useful in
38829 environments where more than one configuration file is in use.
38830
38831
38832
38833 .section "Hints database maintenance" "SECThindatmai"
38834 .cindex "hints database" "maintenance"
38835 .cindex "maintaining Exim's hints database"
38836 Three utility programs are provided for maintaining the DBM files that Exim
38837 uses to contain its delivery hint information. Each program requires two
38838 arguments. The first specifies the name of Exim's spool directory, and the
38839 second is the name of the database it is to operate on. These are as follows:
38840
38841 .ilist
38842 &'retry'&: the database of retry information
38843 .next
38844 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38845 for remote hosts
38846 .next
38847 &'callout'&: the callout cache
38848 .next
38849 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38850 .next
38851 &'misc'&: other hints data
38852 .endlist
38853
38854 The &'misc'& database is used for
38855
38856 .ilist
38857 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38858 .next
38859 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38860 &(smtp)& transport)
38861 .next
38862 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38863 in a transport)
38864 .endlist
38865
38866
38867
38868 .section "exim_dumpdb" "SECID261"
38869 .cindex "&'exim_dumpdb'&"
38870 The entire contents of a database are written to the standard output by the
38871 &'exim_dumpdb'& program, which has no options or arguments other than the
38872 spool and database names. For example, to dump the retry database:
38873 .code
38874 exim_dumpdb /var/spool/exim retry
38875 .endd
38876 Two lines of output are produced for each entry:
38877 .code
38878 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38879 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38880 .endd
38881 The first item on the first line is the key of the record. It starts with one
38882 of the letters R, or T, depending on whether it refers to a routing or
38883 transport retry. For a local delivery, the next part is the local address; for
38884 a remote delivery it is the name of the remote host, followed by its failing IP
38885 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38886 transport). If the remote port is not the standard one (port 25), it is added
38887 to the IP address. Then there follows an error code, an additional error code,
38888 and a textual description of the error.
38889
38890 The three times on the second line are the time of first failure, the time of
38891 the last delivery attempt, and the computed time for the next attempt. The line
38892 ends with an asterisk if the cutoff time for the last retry rule has been
38893 exceeded.
38894
38895 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38896 consists of a host name followed by a list of ids for messages that are or were
38897 waiting to be delivered to that host. If there are a very large number for any
38898 one host, continuation records, with a sequence number added to the host name,
38899 may be seen. The data in these records is often out of date, because a message
38900 may be routed to several alternative hosts, and Exim makes no effort to keep
38901 cross-references.
38902
38903
38904
38905 .section "exim_tidydb" "SECID262"
38906 .cindex "&'exim_tidydb'&"
38907 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38908 database. If run with no options, it removes all records that are more than 30
38909 days old. The age is calculated from the date and time that the record was last
38910 updated. Note that, in the case of the retry database, it is &'not'& the time
38911 since the first delivery failure. Information about a host that has been down
38912 for more than 30 days will remain in the database, provided that the record is
38913 updated sufficiently often.
38914
38915 The cutoff date can be altered by means of the &%-t%& option, which must be
38916 followed by a time. For example, to remove all records older than a week from
38917 the retry database:
38918 .code
38919 exim_tidydb -t 7d /var/spool/exim retry
38920 .endd
38921 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38922 message ids. In the former these appear as data in records keyed by host &--
38923 they were messages that were waiting for that host &-- and in the latter they
38924 are the keys for retry information for messages that have suffered certain
38925 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38926 message ids in database records are those of messages that are still on the
38927 queue. Message ids for messages that no longer exist are removed from
38928 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38929 For the &'retry'& database, records whose keys are non-existent message ids are
38930 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38931 whenever it removes information from the database.
38932
38933 Certain records are automatically removed by Exim when they are no longer
38934 needed, but others are not. For example, if all the MX hosts for a domain are
38935 down, a retry record is created for each one. If the primary MX host comes back
38936 first, its record is removed when Exim successfully delivers to it, but the
38937 records for the others remain because Exim has not tried to use those hosts.
38938
38939 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38940 hints databases. You should do this at a quiet time of day, because it requires
38941 a database to be locked (and therefore inaccessible to Exim) while it does its
38942 work. Removing records from a DBM file does not normally make the file smaller,
38943 but all the common DBM libraries are able to re-use the space that is released.
38944 After an initial phase of increasing in size, the databases normally reach a
38945 point at which they no longer get any bigger, as long as they are regularly
38946 tidied.
38947
38948 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38949 databases is likely to keep on increasing.
38950
38951
38952
38953
38954 .section "exim_fixdb" "SECID263"
38955 .cindex "&'exim_fixdb'&"
38956 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38957 Its main use is for testing Exim, but it might also be occasionally useful for
38958 getting round problems in a live system. It has no options, and its interface
38959 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38960 key of a database record can then be entered, and the data for that record is
38961 displayed.
38962
38963 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38964 except the &'retry'& database, that is the only operation that can be carried
38965 out. For the &'retry'& database, each field is output preceded by a number, and
38966 data for individual fields can be changed by typing the field number followed
38967 by new data, for example:
38968 .code
38969 > 4 951102:1000
38970 .endd
38971 resets the time of the next delivery attempt. Time values are given as a
38972 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38973 used as optional separators.
38974
38975
38976
38977
38978 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38979 .cindex "mailbox" "maintenance"
38980 .cindex "&'exim_lock'&"
38981 .cindex "locking mailboxes"
38982 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38983 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38984 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38985 a user agent while investigating a problem. The utility requires the name of
38986 the file as its first argument. If the locking is successful, the second
38987 argument is run as a command (using C's &[system()]& function); if there is no
38988 second argument, the value of the SHELL environment variable is used; if this
38989 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38990 is unlocked and the utility ends. The following options are available:
38991
38992 .vlist
38993 .vitem &%-fcntl%&
38994 Use &[fcntl()]& locking on the open mailbox.
38995
38996 .vitem &%-flock%&
38997 Use &[flock()]& locking on the open mailbox, provided the operating system
38998 supports it.
38999
39000 .vitem &%-interval%&
39001 This must be followed by a number, which is a number of seconds; it sets the
39002 interval to sleep between retries (default 3).
39003
39004 .vitem &%-lockfile%&
39005 Create a lock file before opening the mailbox.
39006
39007 .vitem &%-mbx%&
39008 Lock the mailbox using MBX rules.
39009
39010 .vitem &%-q%&
39011 Suppress verification output.
39012
39013 .vitem &%-retries%&
39014 This must be followed by a number; it sets the number of times to try to get
39015 the lock (default 10).
39016
39017 .vitem &%-restore_time%&
39018 This option causes &%exim_lock%& to restore the modified and read times to the
39019 locked file before exiting. This allows you to access a locked mailbox (for
39020 example, to take a backup copy) without disturbing the times that the user
39021 subsequently sees.
39022
39023 .vitem &%-timeout%&
39024 This must be followed by a number, which is a number of seconds; it sets a
39025 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39026 default), a non-blocking call is used.
39027
39028 .vitem &%-v%&
39029 Generate verbose output.
39030 .endlist
39031
39032 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39033 default is to create a lock file and also to use &[fcntl()]& locking on the
39034 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39035 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39036 requires that the directory containing the file be writeable. Locking by lock
39037 file does not last forever; Exim assumes that a lock file is expired if it is
39038 more than 30 minutes old.
39039
39040 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39041 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39042 to be taken out on the open mailbox, and an exclusive lock on the file
39043 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39044 number of the mailbox file. When the locking is released, if an exclusive lock
39045 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39046
39047 The default output contains verification of the locking that takes place. The
39048 &%-v%& option causes some additional information to be given. The &%-q%& option
39049 suppresses all output except error messages.
39050
39051 A command such as
39052 .code
39053 exim_lock /var/spool/mail/spqr
39054 .endd
39055 runs an interactive shell while the file is locked, whereas
39056 .display
39057 &`exim_lock -q /var/spool/mail/spqr <<End`&
39058 <&'some commands'&>
39059 &`End`&
39060 .endd
39061 runs a specific non-interactive sequence of commands while the file is locked,
39062 suppressing all verification output. A single command can be run by a command
39063 such as
39064 .code
39065 exim_lock -q /var/spool/mail/spqr \
39066   "cp /var/spool/mail/spqr /some/where"
39067 .endd
39068 Note that if a command is supplied, it must be entirely contained within the
39069 second argument &-- hence the quotes.
39070 .ecindex IIDutils
39071
39072
39073 . ////////////////////////////////////////////////////////////////////////////
39074 . ////////////////////////////////////////////////////////////////////////////
39075
39076 .chapter "The Exim monitor" "CHAPeximon"
39077 .scindex IIDeximon "Exim monitor" "description"
39078 .cindex "X-windows"
39079 .cindex "&'eximon'&"
39080 .cindex "Local/eximon.conf"
39081 .cindex "&_exim_monitor/EDITME_&"
39082 The Exim monitor is an application which displays in an X window information
39083 about the state of Exim's queue and what Exim is doing. An admin user can
39084 perform certain operations on messages from this GUI interface; however all
39085 such facilities are also available from the command line, and indeed, the
39086 monitor itself makes use of the command line to perform any actions requested.
39087
39088
39089
39090 .section "Running the monitor" "SECID264"
39091 The monitor is started by running the script called &'eximon'&. This is a shell
39092 script that sets up a number of environment variables, and then runs the
39093 binary called &_eximon.bin_&. The default appearance of the monitor window can
39094 be changed by editing the &_Local/eximon.conf_& file created by editing
39095 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39096 parameters are for.
39097
39098 The parameters that get built into the &'eximon'& script can be overridden for
39099 a particular invocation by setting up environment variables of the same names,
39100 preceded by &`EXIMON_`&. For example, a shell command such as
39101 .code
39102 EXIMON_LOG_DEPTH=400 eximon
39103 .endd
39104 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39105 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39106 overrides the Exim log file configuration. This makes it possible to have
39107 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39108 syslog messages are routed to a file on the local host.
39109
39110 X resources can be used to change the appearance of the window in the normal
39111 way. For example, a resource setting of the form
39112 .code
39113 Eximon*background: gray94
39114 .endd
39115 changes the colour of the background to light grey rather than white. The
39116 stripcharts are drawn with both the data lines and the reference lines in
39117 black. This means that the reference lines are not visible when on top of the
39118 data. However, their colour can be changed by setting a resource called
39119 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39120 For example, if your X server is running Unix, you could set up lighter
39121 reference lines in the stripcharts by obeying
39122 .code
39123 xrdb -merge <<End
39124 Eximon*highlight: gray
39125 End
39126 .endd
39127 .cindex "admin user"
39128 In order to see the contents of messages in the queue, and to operate on them,
39129 &'eximon'& must either be run as root or by an admin user.
39130
39131 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39132 contain X11 resource parameters interpreted by the X11 library.  In addition,
39133 if the first parameter starts with the string "gdb" then it is removed and the
39134 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39135 versioned variants of gdb can be invoked).
39136
39137 The monitor's window is divided into three parts. The first contains one or
39138 more stripcharts and two action buttons, the second contains a &"tail"& of the
39139 main log file, and the third is a display of the queue of messages awaiting
39140 delivery, with two more action buttons. The following sections describe these
39141 different parts of the display.
39142
39143
39144
39145
39146 .section "The stripcharts" "SECID265"
39147 .cindex "stripchart"
39148 The first stripchart is always a count of messages in the queue. Its name can
39149 be configured by setting QUEUE_STRIPCHART_NAME in the
39150 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39151 configuration script by regular expression matches on log file entries, making
39152 it possible to display, for example, counts of messages delivered to certain
39153 hosts or using certain transports. The supplied defaults display counts of
39154 received and delivered messages, and of local and SMTP deliveries. The default
39155 period between stripchart updates is one minute; this can be adjusted by a
39156 parameter in the &_Local/eximon.conf_& file.
39157
39158 The stripchart displays rescale themselves automatically as the value they are
39159 displaying changes. There are always 10 horizontal lines in each chart; the
39160 title string indicates the value of each division when it is greater than one.
39161 For example, &"x2"& means that each division represents a value of 2.
39162
39163 It is also possible to have a stripchart which shows the percentage fullness of
39164 a particular disk partition, which is useful when local deliveries are confined
39165 to a single partition.
39166
39167 .cindex "&%statvfs%& function"
39168 This relies on the availability of the &[statvfs()]& function or equivalent in
39169 the operating system. Most, but not all versions of Unix that support Exim have
39170 this. For this particular stripchart, the top of the chart always represents
39171 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39172 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39173 &_Local/eximon.conf_& file.
39174
39175
39176
39177
39178 .section "Main action buttons" "SECID266"
39179 .cindex "size" "of monitor window"
39180 .cindex "Exim monitor" "window size"
39181 .cindex "window size"
39182 Below the stripcharts there is an action button for quitting the monitor. Next
39183 to this is another button marked &"Size"&. They are placed here so that
39184 shrinking the window to its default minimum size leaves just the queue count
39185 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39186 the window to expand to its maximum size, unless it is already at the maximum,
39187 in which case it is reduced to its minimum.
39188
39189 When expanding to the maximum, if the window cannot be fully seen where it
39190 currently is, it is moved back to where it was the last time it was at full
39191 size. When it is expanding from its minimum size, the old position is
39192 remembered, and next time it is reduced to the minimum it is moved back there.
39193
39194 The idea is that you can keep a reduced window just showing one or two
39195 stripcharts at a convenient place on your screen, easily expand it to show
39196 the full window when required, and just as easily put it back to what it was.
39197 The idea is copied from what the &'twm'& window manager does for its
39198 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39199 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39200
39201 Normally, the monitor starts up with the window at its full size, but it can be
39202 built so that it starts up with the window at its smallest size, by setting
39203 START_SMALL=yes in &_Local/eximon.conf_&.
39204
39205
39206
39207 .section "The log display" "SECID267"
39208 .cindex "log" "tail of; in monitor"
39209 The second section of the window is an area in which a display of the tail of
39210 the main log is maintained.
39211 To save space on the screen, the timestamp on each log line is shortened by
39212 removing the date and, if &%log_timezone%& is set, the timezone.
39213 The log tail is not available when the only destination for logging data is
39214 syslog, unless the syslog lines are routed to a local file whose name is passed
39215 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39216
39217 The log sub-window has a scroll bar at its lefthand side which can be used to
39218 move back to look at earlier text, and the up and down arrow keys also have a
39219 scrolling effect. The amount of log that is kept depends on the setting of
39220 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39221 to use. When this is full, the earlier 50% of data is discarded &-- this is
39222 much more efficient than throwing it away line by line. The sub-window also has
39223 a horizontal scroll bar for accessing the ends of long log lines. This is the
39224 only means of horizontal scrolling; the right and left arrow keys are not
39225 available. Text can be cut from this part of the window using the mouse in the
39226 normal way. The size of this subwindow is controlled by parameters in the
39227 configuration file &_Local/eximon.conf_&.
39228
39229 Searches of the text in the log window can be carried out by means of the ^R
39230 and ^S keystrokes, which default to a reverse and a forward search,
39231 respectively. The search covers only the text that is displayed in the window.
39232 It cannot go further back up the log.
39233
39234 The point from which the search starts is indicated by a caret marker. This is
39235 normally at the end of the text in the window, but can be positioned explicitly
39236 by pointing and clicking with the left mouse button, and is moved automatically
39237 by a successful search. If new text arrives in the window when it is scrolled
39238 back, the caret remains where it is, but if the window is not scrolled back,
39239 the caret is moved to the end of the new text.
39240
39241 Pressing ^R or ^S pops up a window into which the search text can be typed.
39242 There are buttons for selecting forward or reverse searching, for carrying out
39243 the search, and for cancelling. If the &"Search"& button is pressed, the search
39244 happens and the window remains so that further searches can be done. If the
39245 &"Return"& key is pressed, a single search is done and the window is closed. If
39246 ^C is typed the search is cancelled.
39247
39248 The searching facility is implemented using the facilities of the Athena text
39249 widget. By default this pops up a window containing both &"search"& and
39250 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39251 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39252 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39253 provided version of &%TextPop%& when the remaining parts of the text widget
39254 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39255 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39256 on these systems, at the expense of having unwanted items in the search popup
39257 window.
39258
39259
39260
39261 .section "The queue display" "SECID268"
39262 .cindex "queue" "display in monitor"
39263 The bottom section of the monitor window contains a list of all messages that
39264 are in the queue, which includes those currently being received or delivered,
39265 as well as those awaiting delivery. The size of this subwindow is controlled by
39266 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39267 at which it is updated is controlled by another parameter in the same file &--
39268 the default is 5 minutes, since queue scans can be quite expensive. However,
39269 there is an &"Update"& action button just above the display which can be used
39270 to force an update of the queue display at any time.
39271
39272 When a host is down for some time, a lot of pending mail can build up for it,
39273 and this can make it hard to deal with other messages in the queue. To help
39274 with this situation there is a button next to &"Update"& called &"Hide"&. If
39275 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39276 type anything in here and press &"Return"&, the text is added to a chain of
39277 such texts, and if every undelivered address in a message matches at least one
39278 of the texts, the message is not displayed.
39279
39280 If there is an address that does not match any of the texts, all the addresses
39281 are displayed as normal. The matching happens on the ends of addresses so, for
39282 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39283 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39284 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39285 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39286 a hide request is automatically cancelled after one hour.
39287
39288 While the dialogue box is displayed, you can't press any buttons or do anything
39289 else to the monitor window. For this reason, if you want to cut text from the
39290 queue display to use in the dialogue box, you have to do the cutting before
39291 pressing the &"Hide"& button.
39292
39293 The queue display contains, for each unhidden queued message, the length of
39294 time it has been in the queue, the size of the message, the message id, the
39295 message sender, and the first undelivered recipient, all on one line. If it is
39296 a bounce message, the sender is shown as &"<>"&. If there is more than one
39297 recipient to which the message has not yet been delivered, subsequent ones are
39298 listed on additional lines, up to a maximum configured number, following which
39299 an ellipsis is displayed. Recipients that have already received the message are
39300 not shown.
39301
39302 .cindex "frozen messages" "display"
39303 If a message is frozen, an asterisk is displayed at the left-hand side.
39304
39305 The queue display has a vertical scroll bar, and can also be scrolled by means
39306 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39307 The text searching facilities, as described above for the log window, are also
39308 available, but the caret is always moved to the end of the text when the queue
39309 display is updated.
39310
39311
39312
39313 .section "The queue menu" "SECID269"
39314 .cindex "queue" "menu in monitor"
39315 If the &%shift%& key is held down and the left button is clicked when the mouse
39316 pointer is over the text for any message, an action menu pops up, and the first
39317 line of the queue display for the message is highlighted. This does not affect
39318 any selected text.
39319
39320 If you want to use some other event for popping up the menu, you can set the
39321 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39322 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39323 value set in this parameter is a standard X event description. For example, to
39324 run eximon using &%ctrl%& rather than &%shift%& you could use
39325 .code
39326 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39327 .endd
39328 The title of the menu is the message id, and it contains entries which act as
39329 follows:
39330
39331 .ilist
39332 &'message log'&: The contents of the message log for the message are displayed
39333 in a new text window.
39334 .next
39335 &'headers'&: Information from the spool file that contains the envelope
39336 information and headers is displayed in a new text window. See chapter
39337 &<<CHAPspool>>& for a description of the format of spool files.
39338 .next
39339 &'body'&: The contents of the spool file containing the body of the message are
39340 displayed in a new text window. There is a default limit of 20,000 bytes to the
39341 amount of data displayed. This can be changed by setting the BODY_MAX
39342 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39343 .next
39344 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39345 delivery of the message. This causes an automatic thaw if the message is
39346 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39347 a new text window. The delivery is run in a separate process, to avoid holding
39348 up the monitor while the delivery proceeds.
39349 .next
39350 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39351 that the message be frozen.
39352 .next
39353 .cindex "thawing messages"
39354 .cindex "unfreezing messages"
39355 .cindex "frozen messages" "thawing"
39356 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39357 that the message be thawed.
39358 .next
39359 .cindex "delivery" "forcing failure"
39360 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39361 that Exim gives up trying to deliver the message. A bounce message is generated
39362 for any remaining undelivered addresses.
39363 .next
39364 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39365 that the message be deleted from the system without generating a bounce
39366 message.
39367 .next
39368 &'add recipient'&: A dialog box is displayed into which a recipient address can
39369 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39370 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39371 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39372 causes a call to Exim to be made using the &%-Mar%& option to request that an
39373 additional recipient be added to the message, unless the entry box is empty, in
39374 which case no action is taken.
39375 .next
39376 &'mark delivered'&: A dialog box is displayed into which a recipient address
39377 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39378 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39379 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39380 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39381 recipient address as already delivered, unless the entry box is empty, in which
39382 case no action is taken.
39383 .next
39384 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39385 mark all recipient addresses as already delivered.
39386 .next
39387 &'edit sender'&: A dialog box is displayed initialized with the current
39388 sender's address. Pressing RETURN causes a call to Exim to be made using the
39389 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39390 in which case no action is taken. If you want to set an empty sender (as in
39391 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39392 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39393 the address is qualified with that domain.
39394 .endlist
39395
39396 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39397 other cases when a call to Exim is made, if there is any output from Exim (in
39398 particular, if the command fails) a window containing the command and the
39399 output is displayed. Otherwise, the results of the action are normally apparent
39400 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39401 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39402 if no output is generated.
39403
39404 The queue display is automatically updated for actions such as freezing and
39405 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39406 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39407 force an update of the display after one of these actions.
39408
39409 In any text window that is displayed as result of a menu action, the normal
39410 cut-and-paste facility is available, and searching can be carried out using ^R
39411 and ^S, as described above for the log tail window.
39412 .ecindex IIDeximon
39413
39414
39415
39416
39417
39418 . ////////////////////////////////////////////////////////////////////////////
39419 . ////////////////////////////////////////////////////////////////////////////
39420
39421 .chapter "Security considerations" "CHAPsecurity"
39422 .scindex IIDsecurcon "security" "discussion of"
39423 This chapter discusses a number of issues concerned with security, some of
39424 which are also covered in other parts of this manual.
39425
39426 For reasons that this author does not understand, some people have promoted
39427 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39428 existence of this chapter in the documentation. However, the intent of the
39429 chapter is simply to describe the way Exim works in relation to certain
39430 security concerns, not to make any specific claims about the effectiveness of
39431 its security as compared with other MTAs.
39432
39433 What follows is a description of the way Exim is supposed to be. Best efforts
39434 have been made to try to ensure that the code agrees with the theory, but an
39435 absence of bugs can never be guaranteed. Any that are reported will get fixed
39436 as soon as possible.
39437
39438
39439 .section "Building a more &""hardened""& Exim" "SECID286"
39440 .cindex "security" "build-time features"
39441 There are a number of build-time options that can be set in &_Local/Makefile_&
39442 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39443 Exim administrator who does not have the root password, or by someone who has
39444 penetrated the Exim (but not the root) account. These options are as follows:
39445
39446 .ilist
39447 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39448 start of any filenames used with the &%-C%& option. When it is set, these
39449 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39450 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39451 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39452 default setting for &%ALT_CONFIG_PREFIX%&.
39453
39454 If the permitted configuration files are confined to a directory to
39455 which only root has access, this guards against someone who has broken
39456 into the Exim account from running a privileged Exim with an arbitrary
39457 configuration file, and using it to break into other accounts.
39458 .next
39459
39460 If a non-trusted configuration file (i.e. not the default configuration file
39461 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39462 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39463 the next item), then root privilege is retained only if the caller of Exim is
39464 root. This locks out the possibility of testing a configuration using &%-C%&
39465 right through message reception and delivery, even if the caller is root. The
39466 reception works, but by that time, Exim is running as the Exim user, so when
39467 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39468 privilege to be lost. However, root can test reception and delivery using two
39469 separate commands.
39470
39471 .next
39472 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39473 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39474 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39475 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39476 the restrictive side.  Requiring build-time selection of safe macros is onerous
39477 but this option is intended solely as a transition mechanism to permit
39478 previously-working configurations to continue to work after release 4.73.
39479 .next
39480 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39481 is disabled.
39482 .next
39483 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39484 never to be used for any deliveries. This is like the &%never_users%& runtime
39485 option, but it cannot be overridden; the runtime option adds additional users
39486 to the list. The default setting is &"root"&; this prevents a non-root user who
39487 is permitted to modify the runtime file from using Exim as a way to get root.
39488 .endlist
39489
39490
39491
39492 .section "Root privilege" "SECID270"
39493 .cindex "setuid"
39494 .cindex "root privilege"
39495 The Exim binary is normally setuid to root, which means that it gains root
39496 privilege (runs as root) when it starts execution. In some special cases (for
39497 example, when the daemon is not in use and there are no local deliveries), it
39498 may be possible to run Exim setuid to some user other than root. This is
39499 discussed in the next section. However, in most installations, root privilege
39500 is required for two things:
39501
39502 .ilist
39503 To set up a socket connected to the standard SMTP port (25) when initialising
39504 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39505 not required.
39506 .next
39507 To be able to change uid and gid in order to read users' &_.forward_& files and
39508 perform local deliveries as the receiving user or as specified in the
39509 configuration.
39510 .endlist
39511
39512 It is not necessary to be root to do any of the other things Exim does, such as
39513 receiving messages and delivering them externally over SMTP, and it is
39514 obviously more secure if Exim does not run as root except when necessary.
39515 For this reason, a user and group for Exim to use must be defined in
39516 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39517 group"&. Their values can be changed by the runtime configuration, though this
39518 is not recommended. Often a user called &'exim'& is used, but some sites use
39519 &'mail'& or another user name altogether.
39520
39521 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39522 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39523 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39524
39525 After a new Exim process has interpreted its command line options, it changes
39526 uid and gid in the following cases:
39527
39528 .ilist
39529 .oindex "&%-C%&"
39530 .oindex "&%-D%&"
39531 If the &%-C%& option is used to specify an alternate configuration file, or if
39532 the &%-D%& option is used to define macro values for the configuration, and the
39533 calling process is not running as root, the uid and gid are changed to those of
39534 the calling process.
39535 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39536 option may not be used at all.
39537 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39538 can be supplied if the calling process is running as root, the Exim run-time
39539 user or CONFIGURE_OWNER, if defined.
39540 .next
39541 .oindex "&%-be%&"
39542 .oindex "&%-bf%&"
39543 .oindex "&%-bF%&"
39544 If the expansion test option (&%-be%&) or one of the filter testing options
39545 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39546 calling process.
39547 .next
39548 If the process is not a daemon process or a queue runner process or a delivery
39549 process or a process for testing address routing (started with &%-bt%&), the
39550 uid and gid are changed to the Exim user and group. This means that Exim always
39551 runs under its own uid and gid when receiving messages. This also applies when
39552 testing address verification
39553 .oindex "&%-bv%&"
39554 .oindex "&%-bh%&"
39555 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39556 option).
39557 .next
39558 For a daemon, queue runner, delivery, or address testing process, the uid
39559 remains as root at this stage, but the gid is changed to the Exim group.
39560 .endlist
39561
39562 The processes that initially retain root privilege behave as follows:
39563
39564 .ilist
39565 A daemon process changes the gid to the Exim group and the uid to the Exim
39566 user after setting up one or more listening sockets. The &[initgroups()]&
39567 function is called, so that if the Exim user is in any additional groups, they
39568 will be used during message reception.
39569 .next
39570 A queue runner process retains root privilege throughout its execution. Its
39571 job is to fork a controlled sequence of delivery processes.
39572 .next
39573 A delivery process retains root privilege throughout most of its execution,
39574 but any actual deliveries (that is, the transports themselves) are run in
39575 subprocesses which always change to a non-root uid and gid. For local
39576 deliveries this is typically the uid and gid of the owner of the mailbox; for
39577 remote deliveries, the Exim uid and gid are used. Once all the delivery
39578 subprocesses have been run, a delivery process changes to the Exim uid and gid
39579 while doing post-delivery tidying up such as updating the retry database and
39580 generating bounce and warning messages.
39581
39582 While the recipient addresses in a message are being routed, the delivery
39583 process runs as root. However, if a user's filter file has to be processed,
39584 this is done in a subprocess that runs under the individual user's uid and
39585 gid. A system filter is run as root unless &%system_filter_user%& is set.
39586 .next
39587 A process that is testing addresses (the &%-bt%& option) runs as root so that
39588 the routing is done in the same environment as a message delivery.
39589 .endlist
39590
39591
39592
39593
39594 .section "Running Exim without privilege" "SECTrunexiwitpri"
39595 .cindex "privilege, running without"
39596 .cindex "unprivileged running"
39597 .cindex "root privilege" "running without"
39598 Some installations like to run Exim in an unprivileged state for more of its
39599 operation, for added security. Support for this mode of operation is provided
39600 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39601 gid are changed to the Exim user and group at the start of a delivery process
39602 (and also queue runner and address testing processes). This means that address
39603 routing is no longer run as root, and the deliveries themselves cannot change
39604 to any other uid.
39605
39606 .cindex SIGHUP
39607 .cindex "daemon" "restarting"
39608 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39609 that the daemon can still be started in the usual way, and it can respond
39610 correctly to SIGHUP because the re-invocation regains root privilege.
39611
39612 An alternative approach is to make Exim setuid to the Exim user and also setgid
39613 to the Exim group. If you do this, the daemon must be started from a root
39614 process. (Calling Exim from a root process makes it behave in the way it does
39615 when it is setuid root.) However, the daemon cannot restart itself after a
39616 SIGHUP signal because it cannot regain privilege.
39617
39618 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39619 stops Exim from trying to re-invoke itself to do a delivery after a message has
39620 been received. Such a re-invocation is a waste of resources because it has no
39621 effect.
39622
39623 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39624 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39625 to the Exim user seems a clean approach, but there is one complication:
39626
39627 In this style of operation, Exim is running with the real uid and gid set to
39628 those of the calling process, and the effective uid/gid set to Exim's values.
39629 Ideally, any association with the calling process' uid/gid should be dropped,
39630 that is, the real uid/gid should be reset to the effective values so as to
39631 discard any privileges that the caller may have. While some operating systems
39632 have a function that permits this action for a non-root effective uid, quite a
39633 number of them do not. Because of this lack of standardization, Exim does not
39634 address this problem at this time.
39635
39636 For this reason, the recommended approach for &"mostly unprivileged"& running
39637 is to keep the Exim binary setuid to root, and to set
39638 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39639 be used in the most straightforward way.
39640
39641 If you configure Exim not to run delivery processes as root, there are a
39642 number of restrictions on what you can do:
39643
39644 .ilist
39645 You can deliver only as the Exim user/group. You should  explicitly use the
39646 &%user%& and &%group%& options to override routers or local transports that
39647 normally deliver as the recipient. This makes sure that configurations that
39648 work in this mode function the same way in normal mode. Any implicit or
39649 explicit specification of another user causes an error.
39650 .next
39651 Use of &_.forward_& files is severely restricted, such that it is usually
39652 not worthwhile to include them in the configuration.
39653 .next
39654 Users who wish to use &_.forward_& would have to make their home directory and
39655 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39656 and their equivalents in Exim filters, cannot be used. While they could be
39657 enabled in the Exim user's name, that would be insecure and not very useful.
39658 .next
39659 Unless the local user mailboxes are all owned by the Exim user (possible in
39660 some POP3 or IMAP-only environments):
39661
39662 .olist
39663 They must be owned by the Exim group and be writeable by that group. This
39664 implies you must set &%mode%& in the appendfile configuration, as well as the
39665 mode of the mailbox files themselves.
39666 .next
39667 You must set &%no_check_owner%&, since most or all of the files will not be
39668 owned by the Exim user.
39669 .next
39670 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39671 on a newly created mailbox when unprivileged. This also implies that new
39672 mailboxes need to be created manually.
39673 .endlist olist
39674 .endlist ilist
39675
39676
39677 These restrictions severely restrict what can be done in local deliveries.
39678 However, there are no restrictions on remote deliveries. If you are running a
39679 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39680 gives more security at essentially no cost.
39681
39682 If you are using the &%mua_wrapper%& facility (see chapter
39683 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39684
39685
39686
39687
39688 .section "Delivering to local files" "SECID271"
39689 Full details of the checks applied by &(appendfile)& before it writes to a file
39690 are given in chapter &<<CHAPappendfile>>&.
39691
39692
39693
39694 .section "Running local commands" "SECTsecconslocalcmds"
39695 .cindex "security" "local commands"
39696 .cindex "security" "command injection attacks"
39697 There are a number of ways in which an administrator can configure Exim to run
39698 commands based upon received, untrustworthy, data. Further, in some
39699 configurations a user who can control a &_.forward_& file can also arrange to
39700 run commands. Configuration to check includes, but is not limited to:
39701
39702 .ilist
39703 Use of &%use_shell%& in the pipe transport: various forms of shell command
39704 injection may be possible with this option present. It is dangerous and should
39705 be used only with considerable caution. Consider constraints which whitelist
39706 allowed characters in a variable which is to be used in a pipe transport that
39707 has &%use_shell%& enabled.
39708 .next
39709 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39710 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39711 &_.forward_& files in a redirect router. If Exim is running on a central mail
39712 hub to which ordinary users do not have shell access, but home directories are
39713 NFS mounted (for instance) then administrators should review the list of these
39714 forbid options available, and should bear in mind that the options that may
39715 need forbidding can change as new features are added between releases.
39716 .next
39717 The &%${run...}%& expansion item does not use a shell by default, but
39718 administrators can configure use of &_/bin/sh_& as part of the command.
39719 Such invocations should be viewed with prejudicial suspicion.
39720 .next
39721 Administrators who use embedded Perl are advised to explore how Perl's
39722 taint checking might apply to their usage.
39723 .next
39724 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39725 administrators are well advised to view its use with suspicion, in case (for
39726 instance) it allows a local-part to contain embedded Exim directives.
39727 .next
39728 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39729 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39730 each can reference arbitrary lists and files, rather than just being a list
39731 of opaque strings.
39732 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39733 real-world security vulnerabilities caused by its use with untrustworthy data
39734 injected in, for SQL injection attacks.
39735 Consider the use of the &%inlisti%& expansion condition instead.
39736 .endlist
39737
39738
39739
39740
39741 .section "Trust in configuration data" "SECTsecconfdata"
39742 .cindex "security" "data sources"
39743 .cindex "security" "regular expressions"
39744 .cindex "regular expressions" "security"
39745 .cindex "PCRE" "security"
39746 If configuration data for Exim can come from untrustworthy sources, there
39747 are some issues to be aware of:
39748
39749 .ilist
39750 Use of &%${expand...}%& may provide a path for shell injection attacks.
39751 .next
39752 Letting untrusted data provide a regular expression is unwise.
39753 .next
39754 Using &%${match...}%& to apply a fixed regular expression against untrusted
39755 data may result in pathological behaviour within PCRE.  Be aware of what
39756 "backtracking" means and consider options for being more strict with a regular
39757 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39758 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39759 possessive quantifiers or just not using regular expressions against untrusted
39760 data.
39761 .next
39762 It can be important to correctly use &%${quote:...}%&,
39763 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39764 items to ensure that data is correctly constructed.
39765 .next
39766 Some lookups might return multiple results, even though normal usage is only
39767 expected to yield one result.
39768 .endlist
39769
39770
39771
39772
39773 .section "IPv4 source routing" "SECID272"
39774 .cindex "source routing" "in IP packets"
39775 .cindex "IP source routing"
39776 Many operating systems suppress IP source-routed packets in the kernel, but
39777 some cannot be made to do this, so Exim does its own check. It logs incoming
39778 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39779 IPv6. No special checking is currently done.
39780
39781
39782
39783 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39784 Support for these SMTP commands is disabled by default. If required, they can
39785 be enabled by defining suitable ACLs.
39786
39787
39788
39789
39790 .section "Privileged users" "SECID274"
39791 .cindex "trusted users"
39792 .cindex "admin user"
39793 .cindex "privileged user"
39794 .cindex "user" "trusted"
39795 .cindex "user" "admin"
39796 Exim recognizes two sets of users with special privileges. Trusted users are
39797 able to submit new messages to Exim locally, but supply their own sender
39798 addresses and information about a sending host. For other users submitting
39799 local messages, Exim sets up the sender address from the uid, and doesn't
39800 permit a remote host to be specified.
39801
39802 .oindex "&%-f%&"
39803 However, an untrusted user is permitted to use the &%-f%& command line option
39804 in the special form &%-f <>%& to indicate that a delivery failure for the
39805 message should not cause an error report. This affects the message's envelope,
39806 but it does not affect the &'Sender:'& header. Untrusted users may also be
39807 permitted to use specific forms of address with the &%-f%& option by setting
39808 the &%untrusted_set_sender%& option.
39809
39810 Trusted users are used to run processes that receive mail messages from some
39811 other mail domain and pass them on to Exim for delivery either locally, or over
39812 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39813 as any user listed in the &%trusted_users%& configuration option, or under any
39814 group listed in the &%trusted_groups%& option.
39815
39816 Admin users are permitted to do things to the messages on Exim's queue. They
39817 can freeze or thaw messages, cause them to be returned to their senders, remove
39818 them entirely, or modify them in various ways. In addition, admin users can run
39819 the Exim monitor and see all the information it is capable of providing, which
39820 includes the contents of files on the spool.
39821
39822 .oindex "&%-M%&"
39823 .oindex "&%-q%&"
39824 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39825 delivery of messages on its queue is restricted to admin users. This
39826 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39827 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39828 queue is also restricted to admin users. This restriction can be relaxed by
39829 setting &%no_queue_list_requires_admin%&.
39830
39831 Exim recognizes an admin user if the calling process is running as root or as
39832 the Exim user or if any of the groups associated with the calling process is
39833 the Exim group. It is not necessary actually to be running under the Exim
39834 group. However, if admin users who are not root or the Exim user are to access
39835 the contents of files on the spool via the Exim monitor (which runs
39836 unprivileged), Exim must be built to allow group read access to its spool
39837 files.
39838
39839 By default, regular users are trusted to perform basic testing and
39840 introspection commands, as themselves.  This setting can be tightened by
39841 setting the &%commandline_checks_require_admin%& option.
39842 This affects most of the checking options,
39843 such as &%-be%& and anything else &%-b*%&.
39844
39845
39846 .section "Spool files" "SECID275"
39847 .cindex "spool directory" "files"
39848 Exim's spool directory and everything it contains is owned by the Exim user and
39849 set to the Exim group. The mode for spool files is defined in the
39850 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39851 any user who is a member of the Exim group can access these files.
39852
39853
39854
39855 .section "Use of argv[0]" "SECID276"
39856 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39857 of specific strings, Exim assumes certain options. For example, calling Exim
39858 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39859 to calling it with the option &%-bS%&. There are no security implications in
39860 this.
39861
39862
39863
39864 .section "Use of %f formatting" "SECID277"
39865 The only use made of &"%f"& by Exim is in formatting load average values. These
39866 are actually stored in integer variables as 1000 times the load average.
39867 Consequently, their range is limited and so therefore is the length of the
39868 converted output.
39869
39870
39871
39872 .section "Embedded Exim path" "SECID278"
39873 Exim uses its own path name, which is embedded in the code, only when it needs
39874 to re-exec in order to regain root privilege. Therefore, it is not root when it
39875 does so. If some bug allowed the path to get overwritten, it would lead to an
39876 arbitrary program's being run as exim, not as root.
39877
39878
39879
39880 .section "Dynamic module directory" "SECTdynmoddir"
39881 Any dynamically loadable modules must be installed into the directory
39882 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39883 loading it.
39884
39885
39886 .section "Use of sprintf()" "SECID279"
39887 .cindex "&[sprintf()]&"
39888 A large number of occurrences of &"sprintf"& in the code are actually calls to
39889 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39890 The intermediate formatting is done into a large fixed buffer by a function
39891 that runs through the format string itself, and checks the length of each
39892 conversion before performing it, thus preventing buffer overruns.
39893
39894 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39895 the output buffer is known to be sufficiently long to contain the converted
39896 string.
39897
39898
39899
39900 .section "Use of debug_printf() and log_write()" "SECID280"
39901 Arbitrary strings are passed to both these functions, but they do their
39902 formatting by calling the function &'string_vformat()'&, which runs through
39903 the format string itself, and checks the length of each conversion.
39904
39905
39906
39907 .section "Use of strcat() and strcpy()" "SECID281"
39908 These are used only in cases where the output buffer is known to be large
39909 enough to hold the result.
39910 .ecindex IIDsecurcon
39911
39912
39913
39914
39915 . ////////////////////////////////////////////////////////////////////////////
39916 . ////////////////////////////////////////////////////////////////////////////
39917
39918 .chapter "Format of spool files" "CHAPspool"
39919 .scindex IIDforspo1 "format" "spool files"
39920 .scindex IIDforspo2 "spool directory" "format of files"
39921 .scindex IIDforspo3 "spool files" "format of"
39922 .cindex "spool files" "editing"
39923 A message on Exim's queue consists of two files, whose names are the message id
39924 followed by -D and -H, respectively. The data portion of the message is kept in
39925 the -D file on its own. The message's envelope, status, and headers are all
39926 kept in the -H file, whose format is described in this chapter. Each of these
39927 two files contains the final component of its own name as its first line. This
39928 is insurance against disk crashes where the directory is lost but the files
39929 themselves are recoverable.
39930
39931 The file formats may be changed, or new formats added, at any release.
39932 Spool files are not intended as an interface to other programs
39933 and should not be used as such.
39934
39935 Some people are tempted into editing -D files in order to modify messages. You
39936 need to be extremely careful if you do this; it is not recommended and you are
39937 on your own if you do it. Here are some of the pitfalls:
39938
39939 .ilist
39940 You must ensure that Exim does not try to deliver the message while you are
39941 fiddling with it. The safest way is to take out a write lock on the -D file,
39942 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39943 place, the lock will be retained. If you write a new file and rename it, the
39944 lock will be lost at the instant of rename.
39945 .next
39946 .vindex "&$body_linecount$&"
39947 If you change the number of lines in the file, the value of
39948 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39949 cause incomplete transmission of messages or undeliverable messages.
39950 .next
39951 If the message is in MIME format, you must take care not to break it.
39952 .next
39953 If the message is cryptographically signed, any change will invalidate the
39954 signature.
39955 .endlist
39956 All in all, modifying -D files is fraught with danger.
39957
39958 Files whose names end with -J may also be seen in the &_input_& directory (or
39959 its subdirectories when &%split_spool_directory%& is set). These are journal
39960 files, used to record addresses to which the message has been delivered during
39961 the course of a delivery attempt. If there are still undelivered recipients at
39962 the end, the -H file is updated, and the -J file is deleted. If, however, there
39963 is some kind of crash (for example, a power outage) before this happens, the -J
39964 file remains in existence. When Exim next processes the message, it notices the
39965 -J file and uses it to update the -H file before starting the next delivery
39966 attempt.
39967
39968 Files whose names end with -K or .eml may also be seen in the spool.
39969 These are temporaries used for DKIM or malware processing, when that is used.
39970 They should be tidied up by normal operations; any old ones are probably
39971 relics of crashes and can be removed.
39972
39973 .section "Format of the -H file" "SECID282"
39974 .cindex "uid (user id)" "in spool file"
39975 .cindex "gid (group id)" "in spool file"
39976 The second line of the -H file contains the login name for the uid of the
39977 process that called Exim to read the message, followed by the numerical uid and
39978 gid. For a locally generated message, this is normally the user who sent the
39979 message. For a message received over TCP/IP via the daemon, it is
39980 normally the Exim user.
39981
39982 The third line of the file contains the address of the message's sender as
39983 transmitted in the envelope, contained in angle brackets. The sender address is
39984 empty for bounce messages. For incoming SMTP mail, the sender address is given
39985 in the MAIL command. For locally generated mail, the sender address is
39986 created by Exim from the login name of the current user and the configured
39987 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39988 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39989 &"<>"& or an address that matches &%untrusted_set_senders%&.
39990
39991 The fourth line contains two numbers. The first is the time that the message
39992 was received, in the conventional Unix form &-- the number of seconds since the
39993 start of the epoch. The second number is a count of the number of messages
39994 warning of delayed delivery that have been sent to the sender.
39995
39996 There follow a number of lines starting with a hyphen. These can appear in any
39997 order, and are omitted when not relevant:
39998
39999 .vlist
40000 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40001 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40002 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40003 recognized, to provide backward compatibility. In the old format, a line of
40004 this form is present for every ACL variable that is not empty. The number
40005 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40006 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40007 the data string for the variable. The string itself starts at the beginning of
40008 the next line, and is followed by a newline character. It may contain internal
40009 newlines.
40010
40011 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40012 A line of this form is present for every ACL connection variable that is
40013 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40014 The length is the length of the data string for the variable. The string itself
40015 starts at the beginning of the next line, and is followed by a newline
40016 character. It may contain internal newlines.
40017
40018 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40019 A line of this form is present for every ACL message variable that is defined.
40020 Note that there is a space between &%-aclm%& and the rest of the name. The
40021 length is the length of the data string for the variable. The string itself
40022 starts at the beginning of the next line, and is followed by a newline
40023 character. It may contain internal newlines.
40024
40025 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40026 This is present if, when the message was received over SMTP, the value of
40027 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40028
40029 .vitem &%-allow_unqualified_recipient%&
40030 This is present if unqualified recipient addresses are permitted in header
40031 lines (to stop such addresses from being qualified if rewriting occurs at
40032 transport time). Local messages that were input using &%-bnq%& and remote
40033 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40034
40035 .vitem &%-allow_unqualified_sender%&
40036 This is present if unqualified sender addresses are permitted in header lines
40037 (to stop such addresses from being qualified if rewriting occurs at transport
40038 time). Local messages that were input using &%-bnq%& and remote messages from
40039 hosts that match &%sender_unqualified_hosts%& set this flag.
40040
40041 .vitem "&%-auth_id%&&~<&'text'&>"
40042 The id information for a message received on an authenticated SMTP connection
40043 &-- the value of the &$authenticated_id$& variable.
40044
40045 .vitem "&%-auth_sender%&&~<&'address'&>"
40046 The address of an authenticated sender &-- the value of the
40047 &$authenticated_sender$& variable.
40048
40049 .vitem "&%-body_linecount%&&~<&'number'&>"
40050 This records the number of lines in the body of the message, and is
40051 present unless &%-spool_file_wireformat%& is.
40052
40053 .vitem "&%-body_zerocount%&&~<&'number'&>"
40054 This records the number of binary zero bytes in the body of the message, and is
40055 present if the number is greater than zero.
40056
40057 .vitem &%-deliver_firsttime%&
40058 This is written when a new message is first added to the spool. When the spool
40059 file is updated after a deferral, it is omitted.
40060
40061 .vitem "&%-frozen%&&~<&'time'&>"
40062 .cindex "frozen messages" "spool data"
40063 The message is frozen, and the freezing happened at <&'time'&>.
40064
40065 .vitem "&%-helo_name%&&~<&'text'&>"
40066 This records the host name as specified by a remote host in a HELO or EHLO
40067 command.
40068
40069 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40070 This records the IP address of the host from which the message was received and
40071 the remote port number that was used. It is omitted for locally generated
40072 messages.
40073
40074 .vitem "&%-host_auth%&&~<&'text'&>"
40075 If the message was received on an authenticated SMTP connection, this records
40076 the name of the authenticator &-- the value of the
40077 &$sender_host_authenticated$& variable.
40078
40079 .vitem &%-host_lookup_failed%&
40080 This is present if an attempt to look up the sending host's name from its IP
40081 address failed. It corresponds to the &$host_lookup_failed$& variable.
40082
40083 .vitem "&%-host_name%&&~<&'text'&>"
40084 .cindex "reverse DNS lookup"
40085 .cindex "DNS" "reverse lookup"
40086 This records the name of the remote host from which the message was received,
40087 if the host name was looked up from the IP address when the message was being
40088 received. It is not present if no reverse lookup was done.
40089
40090 .vitem "&%-ident%&&~<&'text'&>"
40091 For locally submitted messages, this records the login of the originating user,
40092 unless it was a trusted user and the &%-oMt%& option was used to specify an
40093 ident value. For messages received over TCP/IP, this records the ident string
40094 supplied by the remote host, if any.
40095
40096 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40097 This records the IP address of the local interface and the port number through
40098 which a message was received from a remote host. It is omitted for locally
40099 generated messages.
40100
40101 .vitem &%-local%&
40102 The message is from a local sender.
40103
40104 .vitem &%-localerror%&
40105 The message is a locally-generated bounce message.
40106
40107 .vitem "&%-local_scan%&&~<&'string'&>"
40108 This records the data string that was returned by the &[local_scan()]& function
40109 when the message was received &-- the value of the &$local_scan_data$&
40110 variable. It is omitted if no data was returned.
40111
40112 .vitem &%-manual_thaw%&
40113 The message was frozen but has been thawed manually, that is, by an explicit
40114 Exim command rather than via the auto-thaw process.
40115
40116 .vitem &%-N%&
40117 A testing delivery process was started using the &%-N%& option to suppress any
40118 actual deliveries, but delivery was deferred. At any further delivery attempts,
40119 &%-N%& is assumed.
40120
40121 .vitem &%-received_protocol%&
40122 This records the value of the &$received_protocol$& variable, which contains
40123 the name of the protocol by which the message was received.
40124
40125 .vitem &%-sender_set_untrusted%&
40126 The envelope sender of this message was set by an untrusted local caller (used
40127 to ensure that the caller is displayed in queue listings).
40128
40129 .vitem "&%-spam_score_int%&&~<&'number'&>"
40130 If a message was scanned by SpamAssassin, this is present. It records the value
40131 of &$spam_score_int$&.
40132
40133 .vitem &%-spool_file_wireformat%&
40134 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40135 rather than Unix-format.
40136 The line-ending is CRLF rather than newline.
40137 There is still, however, no leading-dot-stuffing.
40138
40139 .vitem &%-tls_certificate_verified%&
40140 A TLS certificate was received from the client that sent this message, and the
40141 certificate was verified by the server.
40142
40143 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40144 When the message was received over an encrypted connection, this records the
40145 name of the cipher suite that was used.
40146
40147 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40148 When the message was received over an encrypted connection, and a certificate
40149 was received from the client, this records the Distinguished Name from that
40150 certificate.
40151 .endlist
40152
40153 Any of the above may have an extra hyphen prepended, to indicate the the
40154 corresponding data is untrusted.
40155
40156 Following the options there is a list of those addresses to which the message
40157 is not to be delivered. This set of addresses is initialized from the command
40158 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40159 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40160 the address is added to this set. The addresses are kept internally as a
40161 balanced binary tree, and it is a representation of that tree which is written
40162 to the spool file. If an address is expanded via an alias or forward file, the
40163 original address is added to the tree when deliveries to all its child
40164 addresses are complete.
40165
40166 If the tree is empty, there is a single line in the spool file containing just
40167 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40168 Y or N, followed by an address. The address is the value for the node of the
40169 tree, and the letters indicate whether the node has a left branch and/or a
40170 right branch attached to it, respectively. If branches exist, they immediately
40171 follow. Here is an example of a three-node tree:
40172 .code
40173 YY darcy@austen.fict.example
40174 NN alice@wonderland.fict.example
40175 NN editor@thesaurus.ref.example
40176 .endd
40177 After the non-recipients tree, there is a list of the message's recipients.
40178 This is a simple list, preceded by a count. It includes all the original
40179 recipients of the message, including those to whom the message has already been
40180 delivered. In the simplest case, the list contains one address per line. For
40181 example:
40182 .code
40183 4
40184 editor@thesaurus.ref.example
40185 darcy@austen.fict.example
40186 rdo@foundation
40187 alice@wonderland.fict.example
40188 .endd
40189 However, when a child address has been added to the top-level addresses as a
40190 result of the use of the &%one_time%& option on a &(redirect)& router, each
40191 line is of the following form:
40192 .display
40193 <&'top-level address'&> <&'errors_to address'&> &&&
40194   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40195 .endd
40196 The 01 flag bit indicates the presence of the three other fields that follow
40197 the top-level address. Other bits may be used in future to support additional
40198 fields. The <&'parent number'&> is the offset in the recipients list of the
40199 original parent of the &"one time"& address. The first two fields are the
40200 envelope sender that is associated with this address and its length. If the
40201 length is zero, there is no special envelope sender (there are then two space
40202 characters in the line). A non-empty field can arise from a &(redirect)& router
40203 that has an &%errors_to%& setting.
40204
40205
40206 A blank line separates the envelope and status information from the headers
40207 which follow. A header may occupy several lines of the file, and to save effort
40208 when reading it in, each header is preceded by a number and an identifying
40209 character. The number is the number of characters in the header, including any
40210 embedded newlines and the terminating newline. The character is one of the
40211 following:
40212
40213 .table2 50pt
40214 .row <&'blank'&>         "header in which Exim has no special interest"
40215 .row &`B`&               "&'Bcc:'& header"
40216 .row &`C`&               "&'Cc:'& header"
40217 .row &`F`&               "&'From:'& header"
40218 .row &`I`&               "&'Message-id:'& header"
40219 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40220 .row &`R`&               "&'Reply-To:'& header"
40221 .row &`S`&               "&'Sender:'& header"
40222 .row &`T`&               "&'To:'& header"
40223 .row &`*`&               "replaced or deleted header"
40224 .endtable
40225
40226 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40227 purposes. They are not transmitted when the message is delivered. Here is a
40228 typical set of headers:
40229 .code
40230 111P Received: by hobbit.fict.example with local (Exim 4.00)
40231 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40232 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40233 038* X-rewrote-sender: bb@hobbit.fict.example
40234 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40235 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40236 099* To: alice@wonderland.fict.example, rdo@foundation,
40237 darcy@austen.fict.example, editor@thesaurus.ref.example
40238 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40239 darcy@austen.fict.example, editor@thesaurus.ref.example
40240 038  Date: Fri, 11 May 2001 10:28:59 +0100
40241 .endd
40242 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40243 &'To:'& header have been rewritten, the last one because routing expanded the
40244 unqualified domain &'foundation'&.
40245 .ecindex IIDforspo1
40246 .ecindex IIDforspo2
40247 .ecindex IIDforspo3
40248
40249 .section "Format of the -D file" "SECID282a"
40250 The data file is traditionally in Unix-standard format: lines are ended with
40251 an ASCII newline character.
40252 However, when the &%spool_wireformat%& main option is used some -D files
40253 can have an alternate format.
40254 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40255 The -D file lines (not including the first name-component line) are
40256 suitable for direct copying to the wire when transmitting using the
40257 ESMTP CHUNKING option, meaning lower processing overhead.
40258 Lines are terminated with an ASCII CRLF pair.
40259 There is no dot-stuffing (and no dot-termination).
40260
40261 . ////////////////////////////////////////////////////////////////////////////
40262 . ////////////////////////////////////////////////////////////////////////////
40263
40264 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
40265          "DKIM, SPF and DMARC Support"
40266
40267 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40268 .cindex "DKIM"
40269
40270 DKIM is a mechanism by which messages sent by some entity can be provably
40271 linked to a domain which that entity controls.  It permits reputation to
40272 be tracked on a per-domain basis, rather than merely upon source IP address.
40273 DKIM is documented in RFC 6376.
40274
40275 As DKIM relies on the message being unchanged in transit, messages handled
40276 by a mailing-list (which traditionally adds to the message) will not match
40277 any original DKIM signature.
40278
40279 DKIM support is compiled into Exim by default if TLS support is present.
40280 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40281
40282 Exim's DKIM implementation allows for
40283 .olist
40284 Signing outgoing messages: This function is implemented in the SMTP transport.
40285 It can co-exist with all other Exim features
40286 (including transport filters)
40287 except cutthrough delivery.
40288 .next
40289 Verifying signatures in incoming messages: This is implemented by an additional
40290 ACL (acl_smtp_dkim), which can be called several times per message, with
40291 different signature contexts.
40292 .endlist
40293
40294 In typical Exim style, the verification implementation does not include any
40295 default "policy". Instead it enables you to build your own policy using
40296 Exim's standard controls.
40297
40298 Please note that verification of DKIM signatures in incoming mail is turned
40299 on by default for logging (in the <= line) purposes.
40300
40301 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40302 When set, for each signature in incoming email,
40303 exim will log a line displaying the most important signature details, and the
40304 signature status. Here is an example (with line-breaks added for clarity):
40305 .code
40306 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40307     d=facebookmail.com s=q1-2009b
40308     c=relaxed/relaxed a=rsa-sha1
40309     i=@facebookmail.com t=1252484542 [verification succeeded]
40310 .endd
40311
40312 You might want to turn off DKIM verification processing entirely for internal
40313 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40314 control modifier. This should typically be done in the RCPT ACL, at points
40315 where you accept mail from relay sources (internal hosts or authenticated
40316 senders).
40317
40318
40319 .section "Signing outgoing messages" "SECDKIMSIGN"
40320 .cindex "DKIM" "signing"
40321
40322 For signing to be usable you must have published a DKIM record in DNS.
40323 Note that RFC 8301 (which does not cover EC keys) says:
40324 .code
40325 rsa-sha1 MUST NOT be used for signing or verifying.
40326
40327 Signers MUST use RSA keys of at least 1024 bits for all keys.
40328 Signers SHOULD use RSA keys of at least 2048 bits.
40329 .endd
40330
40331 Note also that the key content (the 'p=' field)
40332 in the DNS record is different between RSA and EC keys;
40333 for the former it is the base64 of the ASN.1 for the RSA public key
40334 (equivalent to the private-key .pem with the header/trailer stripped)
40335 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40336
40337 Signing is enabled by setting private options on the SMTP transport.
40338 These options take (expandable) strings as arguments.
40339
40340 .option dkim_domain smtp string list&!! unset
40341 The domain(s) you want to sign with.
40342 After expansion, this can be a list.
40343 Each element in turn,
40344 lowercased,
40345 is put into the &%$dkim_domain%& expansion variable
40346 while expanding the remaining signing options.
40347 If it is empty after expansion, DKIM signing is not done,
40348 and no error will result even if &%dkim_strict%& is set.
40349
40350 .option dkim_selector smtp string list&!! unset
40351 This sets the key selector string.
40352 After expansion, which can use &$dkim_domain$&, this can be a list.
40353 Each element in turn is put in the expansion
40354 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40355 option along with &%$dkim_domain%&.
40356 If the option is empty after expansion, DKIM signing is not done for this domain,
40357 and no error will result even if &%dkim_strict%& is set.
40358
40359 .option dkim_private_key smtp string&!! unset
40360 This sets the private key to use.
40361 You can use the &%$dkim_domain%& and
40362 &%$dkim_selector%& expansion variables to determine the private key to use.
40363 The result can either
40364 .ilist
40365 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40366 .next
40367 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40368 be a valid Ed25519 private key (same format as above)
40369 .next
40370 start with a slash, in which case it is treated as a file that contains
40371 the private key
40372 .next
40373 be "0", "false" or the empty string, in which case the message will not
40374 be signed. This case will not result in an error, even if &%dkim_strict%&
40375 is set.
40376 .endlist
40377
40378 To generate keys under OpenSSL:
40379 .code
40380 openssl genrsa -out dkim_rsa.private 2048
40381 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40382 .endd
40383 The result file from the first command should be retained, and
40384 this option set to use it.
40385 Take the base-64 lines from the output of the second command, concatenated,
40386 for the DNS TXT record.
40387 See section 3.6 of RFC6376 for the record specification.
40388
40389 Under GnuTLS:
40390 .code
40391 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40392 certtool --load-privkey=dkim_rsa.private --pubkey-info
40393 .endd
40394
40395 Note that RFC 8301 says:
40396 .code
40397 Signers MUST use RSA keys of at least 1024 bits for all keys.
40398 Signers SHOULD use RSA keys of at least 2048 bits.
40399 .endd
40400
40401 EC keys for DKIM are defined by RFC 8463.
40402 They are considerably smaller than RSA keys for equivalent protection.
40403 As they are a recent development, users should consider dual-signing
40404 (by setting a list of selectors, and an expansion for this option)
40405 for some transition period.
40406 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40407 for EC keys.
40408
40409 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40410 .code
40411 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40412 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40413 .endd
40414
40415 To produce the required public key value for a DNS record:
40416 .code
40417 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40418 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40419 .endd
40420
40421 Exim also supports an alternate format
40422 of Ed25519 keys in DNS which was a candidate during development
40423 of the standard, but not adopted.
40424 A future release will probably drop that support.
40425
40426 .option dkim_hash smtp string&!! sha256
40427 Can be set to any one of the supported hash methods, which are:
40428 .ilist
40429 &`sha1`& &-- should not be used, is old and insecure
40430 .next
40431 &`sha256`& &-- the default
40432 .next
40433 &`sha512`& &-- possibly more secure but less well supported
40434 .endlist
40435
40436 Note that RFC 8301 says:
40437 .code
40438 rsa-sha1 MUST NOT be used for signing or verifying.
40439 .endd
40440
40441 .option dkim_identity smtp string&!! unset
40442 If set after expansion, the value is used to set an "i=" tag in
40443 the signing header.  The DKIM standards restrict the permissible
40444 syntax of this optional tag to a mail address, with possibly-empty
40445 local part, an @, and a domain identical to or subdomain of the "d="
40446 tag value.  Note that Exim does not check the value.
40447
40448 .option dkim_canon smtp string&!! unset
40449 This option sets the canonicalization method used when signing a message.
40450 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40451 The option defaults to "relaxed" when unset. Note: the current implementation
40452 only supports signing with the same canonicalization method for both headers and body.
40453
40454 .option dkim_strict smtp string&!! unset
40455 This  option  defines  how  Exim  behaves  when  signing a message that
40456 should be signed fails for some reason.  When the expansion evaluates to
40457 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
40458 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40459 variables here.
40460
40461 .option dkim_sign_headers smtp string&!! "see below"
40462 If set, this option must expand to a colon-separated
40463 list of header names.
40464 Headers with these names, or the absence or such a header, will be included
40465 in the message signature.
40466 When unspecified, the header names listed in RFC4871 will be used,
40467 whether or not each header is present in the message.
40468 The default list is available for the expansion in the macro
40469 &"_DKIM_SIGN_HEADERS"&
40470 .new
40471 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
40472 .wen
40473
40474 If a name is repeated, multiple headers by that name (or the absence thereof)
40475 will be signed.  The textually later headers in the headers part of the
40476 message are signed first, if there are multiples.
40477
40478 A name can be prefixed with either an &"="& or a &"+"& character.
40479 If an &"="& prefix is used, all headers that are present with this name
40480 will be signed.
40481 If a &"+"& prefix if used, all headers that are present with this name
40482 will be signed, and one signature added for a missing header with the
40483 name will be appended.
40484
40485 .option dkim_timestamps smtp integer&!! unset
40486 This option controls the inclusion of timestamp information in the signature.
40487 If not set, no such information will be included.
40488 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40489 for the expiry tag
40490 (eg. 1209600 for two weeks);
40491 both creation (t=) and expiry (x=) tags will be included.
40492
40493 RFC 6376 lists these tags as RECOMMENDED.
40494
40495
40496 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40497 .cindex "DKIM" "verification"
40498
40499 Verification of DKIM signatures in SMTP incoming email is done for all
40500 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40501 .cindex DKIM "selecting signature algorithms"
40502 Individual classes of signature algorithm can be ignored by changing
40503 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40504 The &%dkim_verify_minimal%& option can be set to cease verification
40505 processing for a message once the first passing signature is found.
40506
40507 .cindex authentication "expansion item"
40508 Performing verification sets up information used by the
40509 &%authresults%& expansion item.
40510
40511 For most purposes the default option settings suffice and the remainder
40512 of this section can be ignored.
40513
40514 The results of verification are made available to the
40515 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40516 A missing ACL definition defaults to accept.
40517 By default, the ACL is called once for each
40518 syntactically(!) correct signature in the incoming message.
40519 If any ACL call does not accept, the message is not accepted.
40520 If a cutthrough delivery was in progress for the message, that is
40521 summarily dropped (having wasted the transmission effort).
40522
40523 To evaluate the verification result in the ACL
40524 a large number of expansion variables
40525 containing the signature status and its details are set up during the
40526 runtime of the ACL.
40527
40528 Calling the ACL only for existing signatures is not sufficient to build
40529 more advanced policies. For that reason, the main option
40530 &%dkim_verify_signers%&, and an expansion variable
40531 &%$dkim_signers%& exist.
40532
40533 The main option &%dkim_verify_signers%& can be set to a colon-separated
40534 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40535 called. It is expanded when the message has been received. At this point,
40536 the expansion variable &%$dkim_signers%& already contains a colon-separated
40537 list of signer domains and identities for the message. When
40538 &%dkim_verify_signers%& is not specified in the main configuration,
40539 it defaults as:
40540 .code
40541 dkim_verify_signers = $dkim_signers
40542 .endd
40543 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40544 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40545 call the ACL for known domains or identities. This would be achieved as follows:
40546 .code
40547 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40548 .endd
40549 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40550 and "ebay.com", plus all domains and identities that have signatures in the message.
40551 You can also be more creative in constructing your policy. For example:
40552 .code
40553 dkim_verify_signers = $sender_address_domain:$dkim_signers
40554 .endd
40555
40556 If a domain or identity is listed several times in the (expanded) value of
40557 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40558
40559 Note that if the option is set using untrustworthy data
40560 (such as the From: header)
40561 care should be taken to force lowercase for domains
40562 and for the domain part if identities.
40563 The default setting can be regarded as trustworthy in this respect.
40564
40565 If multiple signatures match a domain (or identity), the ACL is called once
40566 for each matching signature.
40567
40568
40569 Inside the DKIM ACL, the following expansion variables are
40570 available (from most to least important):
40571
40572
40573 .vlist
40574 .vitem &%$dkim_cur_signer%&
40575 The signer that is being evaluated in this ACL run. This can be a domain or
40576 an identity. This is one of the list items from the expanded main option
40577 &%dkim_verify_signers%& (see above).
40578
40579 .vitem &%$dkim_verify_status%&
40580 Within the DKIM ACL,
40581 a string describing the general status of the signature. One of
40582 .ilist
40583 &%none%&: There is no signature in the message for the current domain or
40584 identity (as reflected by &%$dkim_cur_signer%&).
40585 .next
40586 &%invalid%&: The signature could not be verified due to a processing error.
40587 More detail is available in &%$dkim_verify_reason%&.
40588 .next
40589 &%fail%&: Verification of the signature failed.  More detail is
40590 available in &%$dkim_verify_reason%&.
40591 .next
40592 &%pass%&: The signature passed verification. It is valid.
40593 .endlist
40594
40595 This variable can be overwritten using an ACL 'set' modifier.
40596 This might, for instance, be done to enforce a policy restriction on
40597 hash-method or key-size:
40598 .code
40599   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40600        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40601        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40602                                   {< {$dkim_key_length}{1024}}}}
40603        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40604        set dkim_verify_status = fail
40605        set dkim_verify_reason = hash too weak or key too short
40606 .endd
40607
40608 So long as a DKIM ACL is defined (it need do no more than accept),
40609 after all the DKIM ACL runs have completed, the value becomes a
40610 colon-separated list of the values after each run.
40611 This is maintained for the mime, prdr and data ACLs.
40612
40613 .vitem &%$dkim_verify_reason%&
40614 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40615 "fail" or "invalid". One of
40616 .ilist
40617 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40618 key for the domain could not be retrieved. This may be a temporary problem.
40619 .next
40620 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40621 record for the domain is syntactically invalid.
40622 .next
40623 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40624 body hash does not match the one specified in the signature header. This
40625 means that the message body was modified in transit.
40626 .next
40627 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40628 could not be verified. This may mean that headers were modified,
40629 re-written or otherwise changed in a way which is incompatible with
40630 DKIM verification. It may of course also mean that the signature is forged.
40631 .endlist
40632
40633 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40634
40635 .vitem &%$dkim_domain%&
40636 The signing domain. IMPORTANT: This variable is only populated if there is
40637 an actual signature in the message for the current domain or identity (as
40638 reflected by &%$dkim_cur_signer%&).
40639
40640 .vitem &%$dkim_identity%&
40641 The signing identity, if present. IMPORTANT: This variable is only populated
40642 if there is an actual signature in the message for the current domain or
40643 identity (as reflected by &%$dkim_cur_signer%&).
40644
40645 .vitem &%$dkim_selector%&
40646 The key record selector string.
40647
40648 .vitem &%$dkim_algo%&
40649 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40650 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40651 may also be 'ed25519-sha256'.
40652 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40653 for EC keys.
40654
40655 Note that RFC 8301 says:
40656 .code
40657 rsa-sha1 MUST NOT be used for signing or verifying.
40658
40659 DKIM signatures identified as having been signed with historic
40660 algorithms (currently, rsa-sha1) have permanently failed evaluation
40661 .endd
40662
40663 To enforce this you must either have a DKIM ACL which checks this variable
40664 and overwrites the &$dkim_verify_status$& variable as discussed above,
40665 or have set the main option &%dkim_verify_hashes%& to exclude
40666 processing of such signatures.
40667
40668 .vitem &%$dkim_canon_body%&
40669 The body canonicalization method. One of 'relaxed' or 'simple'.
40670
40671 .vitem &%$dkim_canon_headers%&
40672 The header canonicalization method. One of 'relaxed' or 'simple'.
40673
40674 .vitem &%$dkim_copiedheaders%&
40675 A transcript of headers and their values which are included in the signature
40676 (copied from the 'z=' tag of the signature).
40677 Note that RFC6376 requires that verification fail if the From: header is
40678 not included in the signature.  Exim does not enforce this; sites wishing
40679 strict enforcement should code the check explicitly.
40680
40681 .vitem &%$dkim_bodylength%&
40682 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40683 limit was set by the signer, "9999999999999" is returned. This makes sure
40684 that this variable always expands to an integer value.
40685 &*Note:*& The presence of the signature tag specifying a signing body length
40686 is one possible route to spoofing of valid DKIM signatures.
40687 A paranoid implementation might wish to regard signature where this variable
40688 shows less than the "no limit" return as being invalid.
40689
40690 .vitem &%$dkim_created%&
40691 UNIX timestamp reflecting the date and time when the signature was created.
40692 When this was not specified by the signer, "0" is returned.
40693
40694 .vitem &%$dkim_expires%&
40695 UNIX timestamp reflecting the date and time when the signer wants the
40696 signature to be treated as "expired". When this was not specified by the
40697 signer, "9999999999999" is returned. This makes it possible to do useful
40698 integer size comparisons against this value.
40699 Note that Exim does not check this value.
40700
40701 .vitem &%$dkim_headernames%&
40702 A colon-separated list of names of headers included in the signature.
40703
40704 .vitem &%$dkim_key_testing%&
40705 "1" if the key record has the "testing" flag set, "0" if not.
40706
40707 .vitem &%$dkim_key_nosubdomains%&
40708 "1" if the key record forbids subdomaining, "0" otherwise.
40709
40710 .vitem &%$dkim_key_srvtype%&
40711 Service type (tag s=) from the key record. Defaults to "*" if not specified
40712 in the key record.
40713
40714 .vitem &%$dkim_key_granularity%&
40715 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40716 in the key record.
40717
40718 .vitem &%$dkim_key_notes%&
40719 Notes from the key record (tag n=).
40720
40721 .vitem &%$dkim_key_length%&
40722 Number of bits in the key.
40723
40724 Note that RFC 8301 says:
40725 .code
40726 Verifiers MUST NOT consider signatures using RSA keys of
40727 less than 1024 bits as valid signatures.
40728 .endd
40729
40730 To enforce this you must have a DKIM ACL which checks this variable
40731 and overwrites the &$dkim_verify_status$& variable as discussed above.
40732 As EC keys are much smaller, the check should only do this for RSA keys.
40733
40734 .endlist
40735
40736 In addition, two ACL conditions are provided:
40737
40738 .vlist
40739 .vitem &%dkim_signers%&
40740 ACL condition that checks a colon-separated list of domains or identities
40741 for a match against the domain or identity that the ACL is currently verifying
40742 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40743 verb to a group of domains or identities. For example:
40744
40745 .code
40746 # Warn when Mail purportedly from GMail has no gmail signature
40747 warn log_message = GMail sender without gmail.com DKIM signature
40748      sender_domains = gmail.com
40749      dkim_signers = gmail.com
40750      dkim_status = none
40751 .endd
40752
40753 Note that the above does not check for a total lack of DKIM signing;
40754 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40755
40756 .vitem &%dkim_status%&
40757 ACL condition that checks a colon-separated list of possible DKIM verification
40758 results against the actual result of verification. This is typically used
40759 to restrict an ACL verb to a list of verification outcomes, for example:
40760
40761 .code
40762 deny message = Mail from Paypal with invalid/missing signature
40763      sender_domains = paypal.com:paypal.de
40764      dkim_signers = paypal.com:paypal.de
40765      dkim_status = none:invalid:fail
40766 .endd
40767
40768 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40769 see the documentation of the &%$dkim_verify_status%& expansion variable above
40770 for more information of what they mean.
40771 .endlist
40772
40773
40774
40775
40776 .section "SPF (Sender Policy Framework)" SECSPF
40777 .cindex SPF verification
40778
40779 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40780 messages with its domain in the envelope from, documented by RFC 7208.
40781 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40782 the &url(http://openspf.org).
40783 . --- 2019-10-28: still not https, open-spf.org is told to be a
40784 . --- web-archive copy of the now dead openspf.org site
40785 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40786 . --- discussion.
40787
40788 Messages sent by a system not authorised will fail checking of such assertions.
40789 This includes retransmissions done by traditional forwarders.
40790
40791 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40792 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40793 &url(https://www.libspf2.org/).
40794 There is no Exim involvement in the transmission of messages;
40795 publishing certain DNS records is all that is required.
40796
40797 For verification, an ACL condition and an expansion lookup are provided.
40798 .cindex authentication "expansion item"
40799 Performing verification sets up information used by the
40800 &%authresults%& expansion item.
40801
40802
40803 .cindex SPF "ACL condition"
40804 .cindex ACL "spf condition"
40805 The ACL condition "spf" can be used at or after the MAIL ACL.
40806 It takes as an argument a list of strings giving the outcome of the SPF check,
40807 and will succeed for any matching outcome.
40808 Valid strings are:
40809 .vlist
40810 .vitem &%pass%&
40811 The SPF check passed, the sending host is positively verified by SPF.
40812
40813 .vitem &%fail%&
40814 The SPF check failed, the sending host is NOT allowed to send mail for the
40815 domain in the envelope-from address.
40816
40817 .vitem &%softfail%&
40818 The SPF check failed, but the queried domain can't absolutely confirm that this
40819 is a forgery.
40820
40821 .vitem &%none%&
40822 The queried domain does not publish SPF records.
40823
40824 .vitem &%neutral%&
40825 The SPF check returned a "neutral" state.  This means the queried domain has
40826 published a SPF record, but wants to allow outside servers to send mail under
40827 its domain as well.  This should be treated like "none".
40828
40829 .vitem &%permerror%&
40830 This indicates a syntax error in the SPF record of the queried domain.
40831 You may deny messages when this occurs.
40832
40833 .vitem &%temperror%&
40834 This indicates a temporary error during all processing, including Exim's
40835 SPF processing.  You may defer messages when this occurs.
40836 .endlist
40837
40838 You can prefix each string with an exclamation mark to  invert
40839 its meaning,  for example  "!fail" will  match all  results but
40840 "fail".  The  string  list is  evaluated  left-to-right,  in a
40841 short-circuit fashion.
40842
40843 Example:
40844 .code
40845 deny spf = fail
40846      message = $sender_host_address is not allowed to send mail from \
40847                ${if def:sender_address_domain \
40848                     {$sender_address_domain}{$sender_helo_name}}.  \
40849                Please see http://www.open-spf.org/Why?scope=\
40850                ${if def:sender_address_domain {mfrom}{helo}};\
40851                identity=${if def:sender_address_domain \
40852                              {$sender_address}{$sender_helo_name}};\
40853                ip=$sender_host_address
40854 .endd
40855
40856 When the spf condition has run, it sets up several expansion
40857 variables:
40858
40859 .cindex SPF "verification variables"
40860 .vlist
40861 .vitem &$spf_header_comment$&
40862 .vindex &$spf_header_comment$&
40863   This contains a human-readable string describing the outcome
40864   of the SPF check. You can add it to a custom header or use
40865   it for logging purposes.
40866
40867 .vitem &$spf_received$&
40868 .vindex &$spf_received$&
40869   This contains a complete Received-SPF: header that can be
40870   added to the message. Please note that according to the SPF
40871   draft, this header must be added at the top of the header
40872   list. Please see section 10 on how you can do this.
40873
40874   Note: in case of "Best-guess" (see below), the convention is
40875   to put this string in a header called X-SPF-Guess: instead.
40876
40877 .vitem &$spf_result$&
40878 .vindex &$spf_result$&
40879   This contains the outcome of the SPF check in string form,
40880   one of pass, fail, softfail, none, neutral, permerror or
40881   temperror.
40882
40883 .vitem &$spf_result_guessed$&
40884 .vindex &$spf_result_guessed$&
40885   This boolean is true only if a best-guess operation was used
40886   and required in order to obtain a result.
40887
40888 .vitem &$spf_smtp_comment$&
40889 .vindex &$spf_smtp_comment$&
40890   This contains a string that can be used in a SMTP response
40891   to the calling party. Useful for "fail".
40892 .endlist
40893
40894
40895 .cindex SPF "ACL condition"
40896 .cindex ACL "spf_guess condition"
40897 .cindex SPF "best guess"
40898 In addition to SPF, you can also perform checks for so-called
40899 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40900 SPF, but it is supported by the same framework that enables SPF
40901 capability.
40902 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
40903 for a description of what it means.
40904 . --- 2019-10-28: still not https:
40905
40906 To access this feature, simply use the spf_guess condition in place
40907 of the spf one.  For example:
40908
40909 .code
40910 deny spf_guess = fail
40911      message = $sender_host_address doesn't look trustworthy to me
40912 .endd
40913
40914 In case you decide to reject messages based on this check, you
40915 should note that although it uses the same framework, "Best-guess"
40916 is not SPF, and therefore you should not mention SPF at all in your
40917 reject message.
40918
40919 When the spf_guess condition has run, it sets up the same expansion
40920 variables as when spf condition is run, described above.
40921
40922 Additionally, since Best-guess is not standardized, you may redefine
40923 what "Best-guess" means to you by redefining the main configuration
40924 &%spf_guess%& option.
40925 For example, the following:
40926
40927 .code
40928 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40929 .endd
40930
40931 would relax host matching rules to a broader network range.
40932
40933
40934 .cindex SPF "lookup expansion"
40935 .cindex lookup spf
40936 A lookup expansion is also available. It takes an email
40937 address as the key and an IP address
40938 (v4 or v6)
40939 as the database:
40940
40941 .code
40942   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40943 .endd
40944
40945 The lookup will return the same result strings as can appear in
40946 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40947
40948
40949
40950
40951
40952 .section DMARC SECDMARC
40953 .cindex DMARC verification
40954
40955 DMARC combines feedback from SPF, DKIM, and header From: in order
40956 to attempt to provide better indicators of the authenticity of an
40957 email.  This document does not explain the fundamentals; you
40958 should read and understand how it works by visiting the website at
40959 &url(http://www.dmarc.org/).
40960
40961 If Exim is built with DMARC support,
40962 the libopendmarc library is used.
40963
40964 For building Exim yourself, obtain the library from
40965 &url(http://sourceforge.net/projects/opendmarc/)
40966 to obtain a copy, or find it in your favorite package
40967 repository.  You will need to attend to the local/Makefile feature
40968 SUPPORT_DMARC and the associated LDFLAGS addition.
40969 This description assumes
40970 that headers will be in /usr/local/include, and that the libraries
40971 are in /usr/local/lib.
40972
40973 . subsection
40974
40975 There are three main-configuration options:
40976 .cindex DMARC "configuration options"
40977
40978 The &%dmarc_tld_file%& option
40979 .oindex &%dmarc_tld_file%&
40980 defines the location of a text file of valid
40981 top level domains the opendmarc library uses
40982 during domain parsing. Maintained by Mozilla,
40983 the most current version can be downloaded
40984 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
40985 See also the util/renew-opendmarc-tlds.sh script.
40986 .new
40987 The default for the option is unset.
40988 If not set, DMARC processing is disabled.
40989 .wen
40990
40991
40992 The &%dmarc_history_file%& option, if set
40993 .oindex &%dmarc_history_file%&
40994 defines the location of a file to log results
40995 of dmarc verification on inbound emails. The
40996 contents are importable by the opendmarc tools
40997 which will manage the data, send out DMARC
40998 reports, and expire the data. Make sure the
40999 directory of this file is writable by the user
41000 exim runs as.
41001 The default is unset.
41002
41003 The &%dmarc_forensic_sender%& option
41004 .oindex &%dmarc_forensic_sender%&
41005 defines an alternate email address to use when sending a
41006 forensic report detailing alignment failures
41007 if a sender domain's dmarc record specifies it
41008 and you have configured Exim to send them.
41009 If set, this is expanded and used for the
41010 From: header line; the address is extracted
41011 from it and used for the envelope from.
41012 If not set (the default), the From: header is expanded from
41013 the dsn_from option, and <> is used for the
41014 envelope from.
41015
41016 . I wish we had subsections...
41017
41018 .cindex DMARC controls
41019 By default, the DMARC processing will run for any remote,
41020 non-authenticated user.  It makes sense to only verify DMARC
41021 status of messages coming from remote, untrusted sources.  You can
41022 use standard conditions such as hosts, senders, etc, to decide that
41023 DMARC verification should *not* be performed for them and disable
41024 DMARC with an ACL control modifier:
41025 .code
41026   control = dmarc_disable_verify
41027 .endd
41028 A DMARC record can also specify a "forensic address", which gives
41029 exim an email address to submit reports about failed alignment.
41030 Exim does not do this by default because in certain conditions it
41031 results in unintended information leakage (what lists a user might
41032 be subscribed to, etc).  You must configure exim to submit forensic
41033 reports to the owner of the domain.  If the DMARC record contains a
41034 forensic address and you specify the control statement below, then
41035 exim will send these forensic emails.  It is also advised that you
41036 configure a &%dmarc_forensic_sender%& because the default sender address
41037 construction might be inadequate.
41038 .code
41039   control = dmarc_enable_forensic
41040 .endd
41041 (AGAIN: You can choose not to send these forensic reports by simply
41042 not putting the dmarc_enable_forensic control line at any point in
41043 your exim config.  If you don't tell exim to send them, it will not
41044 send them.)
41045
41046 There are no options to either control.  Both must appear before
41047 the DATA acl.
41048
41049 . subsection
41050
41051 DMARC checks cam be run on incoming SMTP  messages by using the
41052 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41053 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41054 condition.  Putting this condition in the ACLs is required in order
41055 for a DMARC check to actually occur.  All of the variables are set
41056 up before the DATA ACL, but there is no actual DMARC check that
41057 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41058
41059 The &"dmarc_status"& condition takes a list of strings on its
41060 right-hand side.  These strings describe recommended action based
41061 on the DMARC check.  To understand what the policy recommendations
41062 mean, refer to the DMARC website above.  Valid strings are:
41063 .display
41064 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41065 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41066 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41067 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41068 &'norecord    '& No policy section in the DMARC record for this sender domain.
41069 &'nofrom      '& Unable to determine the domain of the sender.
41070 &'temperror   '& Library error or dns error.
41071 &'off         '& The DMARC check was disabled for this email.
41072 .endd
41073 You can prefix each string with an exclamation mark to invert its
41074 meaning, for example "!accept" will match all results but
41075 "accept".  The string list is evaluated left-to-right in a
41076 short-circuit fashion.  When a string matches the outcome of the
41077 DMARC check, the condition succeeds.  If none of the listed
41078 strings matches the outcome of the DMARC check, the condition
41079 fails.
41080
41081 Of course, you can also use any other lookup method that Exim
41082 supports, including LDAP, Postgres, MySQL, etc, as long as the
41083 result is a list of colon-separated strings.
41084
41085 Performing the check sets up information used by the
41086 &%authresults%& expansion item.
41087
41088 Several expansion variables are set before the DATA ACL is
41089 processed, and you can use them in this ACL.  The following
41090 expansion variables are available:
41091
41092 .vlist
41093 .vitem &$dmarc_status$&
41094 .vindex &$dmarc_status$&
41095 .cindex DMARC result
41096 A one word status indicating what the DMARC library
41097 thinks of the email.  It is a combination of the results of
41098 DMARC record lookup and the SPF/DKIM/DMARC processing results
41099 (if a DMARC record was found).  The actual policy declared
41100 in the DMARC record is in a separate expansion variable.
41101
41102 .vitem &$dmarc_status_text$&
41103 .vindex &$dmarc_status_text$&
41104 Slightly longer, human readable status.
41105
41106 .vitem &$dmarc_used_domain$&
41107 .vindex &$dmarc_used_domain$&
41108 The domain which DMARC used to look up the DMARC policy record.
41109
41110 .vitem &$dmarc_domain_policy$&
41111 .vindex &$dmarc_domain_policy$&
41112 The policy declared in the DMARC record.  Valid values
41113 are "none", "reject" and "quarantine".  It is blank when there
41114 is any error, including no DMARC record.
41115 .endlist
41116
41117 . subsection
41118
41119 By default, Exim's DMARC configuration is intended to be
41120 non-intrusive and conservative.  To facilitate this, Exim will not
41121 create any type of logging files without explicit configuration by
41122 you, the admin.  Nor will Exim send out any emails/reports about
41123 DMARC issues without explicit configuration by you, the admin (other
41124 than typical bounce messages that may come about due to ACL
41125 processing or failure delivery issues).
41126
41127 In order to log statistics suitable to be imported by the opendmarc
41128 tools, you need to:
41129 .ilist
41130 Configure the global option &%dmarc_history_file%&
41131 .next
41132 Configure cron jobs to call the appropriate opendmarc history
41133 import scripts and truncating the dmarc_history_file
41134 .endlist
41135
41136 In order to send forensic reports, you need to:
41137 .ilist
41138 Configure the global option &%dmarc_forensic_sender%&
41139 .next
41140 Configure, somewhere before the DATA ACL, the control option to
41141 enable sending DMARC forensic reports
41142 .endlist
41143
41144 . subsection
41145
41146 Example usage:
41147 .code
41148 (RCPT ACL)
41149   warn    domains        = +local_domains
41150           hosts          = +local_hosts
41151           control        = dmarc_disable_verify
41152
41153   warn    !domains       = +screwed_up_dmarc_records
41154           control        = dmarc_enable_forensic
41155
41156   warn    condition      = (lookup if destined to mailing list)
41157           set acl_m_mailing_list = 1
41158
41159 (DATA ACL)
41160   warn    dmarc_status   = accept : none : off
41161           !authenticated = *
41162           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41163
41164   warn    dmarc_status   = !accept
41165           !authenticated = *
41166           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41167
41168   warn    dmarc_status   = quarantine
41169           !authenticated = *
41170           set $acl_m_quarantine = 1
41171           # Do something in a transport with this flag variable
41172
41173   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41174           condition      = ${if eq{$acl_m_mailing_list}{1}}
41175           message        = Messages from $dmarc_used_domain break mailing lists
41176
41177   deny    dmarc_status   = reject
41178           !authenticated = *
41179           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41180
41181   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41182 .endd
41183
41184
41185
41186
41187
41188 . ////////////////////////////////////////////////////////////////////////////
41189 . ////////////////////////////////////////////////////////////////////////////
41190
41191 .chapter "Proxies" "CHAPproxies" &&&
41192          "Proxy support"
41193 .cindex "proxy support"
41194 .cindex "proxy" "access via"
41195
41196 A proxy is an intermediate system through which communication is passed.
41197 Proxies may provide a security, availability or load-distribution function.
41198
41199
41200 .section "Inbound proxies" SECTproxyInbound
41201 .cindex proxy inbound
41202 .cindex proxy "server side"
41203 .cindex proxy "Proxy protocol"
41204 .cindex "Proxy protocol" proxy
41205
41206 Exim has support for receiving inbound SMTP connections via a proxy
41207 that uses &"Proxy Protocol"& to speak to it.
41208 To include this support, include &"SUPPORT_PROXY=yes"&
41209 in Local/Makefile.
41210
41211 It was built on the HAProxy specification, found at
41212 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41213
41214 The purpose of this facility is so that an application load balancer,
41215 such as HAProxy, can sit in front of several Exim servers
41216 to distribute load.
41217 Exim uses the local protocol communication with the proxy to obtain
41218 the remote SMTP system IP address and port information.
41219 There is no logging if a host passes or
41220 fails Proxy Protocol negotiation, but it can easily be determined and
41221 recorded in an ACL (example is below).
41222
41223 Use of a proxy is enabled by setting the &%hosts_proxy%&
41224 main configuration option to a hostlist; connections from these
41225 hosts will use Proxy Protocol.
41226 Exim supports both version 1 and version 2 of the Proxy Protocol and
41227 automatically determines which version is in use.
41228
41229 The Proxy Protocol header is the first data received on a TCP connection
41230 and is inserted before any TLS-on-connect handshake from the client; Exim
41231 negotiates TLS between Exim-as-server and the remote client, not between
41232 Exim and the proxy server.
41233
41234 The following expansion variables are usable
41235 (&"internal"& and &"external"& here refer to the interfaces
41236 of the proxy):
41237 .display
41238 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41239 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41240 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41241 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41242 &'proxy_session            '& boolean: SMTP connection via proxy
41243 .endd
41244 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41245 there was a protocol error.
41246 The variables &$sender_host_address$& and &$sender_host_port$&
41247 will have values for the actual client system, not the proxy.
41248
41249 Since the real connections are all coming from the proxy, and the
41250 per host connection tracking is done before Proxy Protocol is
41251 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41252 handle all of the parallel volume you expect per inbound proxy.
41253 With the option set so high, you lose the ability
41254 to protect your server from many connections from one IP.
41255 In order to prevent your server from overload, you
41256 need to add a per connection ratelimit to your connect ACL.
41257 A possible solution is:
41258 .display
41259   # Set max number of connections per host
41260   LIMIT   = 5
41261   # Or do some kind of IP lookup in a flat file or database
41262   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41263
41264   defer   message        = Too many connections from this IP right now
41265           ratelimit      = LIMIT / 5s / per_conn / strict
41266 .endd
41267
41268
41269
41270 .section "Outbound proxies" SECTproxySOCKS
41271 .cindex proxy outbound
41272 .cindex proxy "client side"
41273 .cindex proxy SOCKS
41274 .cindex SOCKS proxy
41275 Exim has support for sending outbound SMTP via a proxy
41276 using a protocol called SOCKS5 (defined by RFC1928).
41277 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41278 Local/Makefile.
41279
41280 Use of a proxy is enabled by setting the &%socks_proxy%& option
41281 on an smtp transport.
41282 The option value is expanded and should then be a list
41283 (colon-separated by default) of proxy specifiers.
41284 Each proxy specifier is a list
41285 (space-separated by default) where the initial element
41286 is an IP address and any subsequent elements are options.
41287
41288 Options are a string <name>=<value>.
41289 The list of options is in the following table:
41290 .display
41291 &'auth   '& authentication method
41292 &'name   '& authentication username
41293 &'pass   '& authentication password
41294 &'port   '& tcp port
41295 &'tmo    '& connection timeout
41296 &'pri    '& priority
41297 &'weight '& selection bias
41298 .endd
41299
41300 More details on each of these options follows:
41301
41302 .ilist
41303 .cindex authentication "to proxy"
41304 .cindex proxy authentication
41305 &%auth%&: Either &"none"& (default) or &"name"&.
41306 Using &"name"& selects username/password authentication per RFC 1929
41307 for access to the proxy.
41308 Default is &"none"&.
41309 .next
41310 &%name%&: sets the username for the &"name"& authentication method.
41311 Default is empty.
41312 .next
41313 &%pass%&: sets the password for the &"name"& authentication method.
41314 Default is empty.
41315 .next
41316 &%port%&: the TCP port number to use for the connection to the proxy.
41317 Default is 1080.
41318 .next
41319 &%tmo%&: sets a connection timeout in seconds for this proxy.
41320 Default is 5.
41321 .next
41322 &%pri%&: specifies a priority for the proxy within the list,
41323 higher values being tried first.
41324 The default priority is 1.
41325 .next
41326 &%weight%&: specifies a selection bias.
41327 Within a priority set servers are queried in a random fashion,
41328 weighted by this value.
41329 The default value for selection bias is 1.
41330 .endlist
41331
41332 Proxies from the list are tried according to their priority
41333 and weight settings until one responds.  The timeout for the
41334 overall connection applies to the set of proxied attempts.
41335
41336 .section Logging SECTproxyLog
41337 To log the (local) IP of a proxy in the incoming or delivery logline,
41338 add &"+proxy"& to the &%log_selector%& option.
41339 This will add a component tagged with &"PRX="& to the line.
41340
41341 . ////////////////////////////////////////////////////////////////////////////
41342 . ////////////////////////////////////////////////////////////////////////////
41343
41344 .chapter "Internationalisation" "CHAPi18n" &&&
41345          "Internationalisation""
41346 .cindex internationalisation "email address"
41347 .cindex EAI
41348 .cindex i18n
41349 .cindex utf8 "mail name handling"
41350
41351 Exim has support for Internationalised mail names.
41352 To include this it must be built with SUPPORT_I18N and the libidn library.
41353 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41354
41355 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41356 instead of it) then IDNA2008 is supported; this adds an extra library
41357 requirement, upon libidn2.
41358
41359 .section "MTA operations" SECTi18nMTA
41360 .cindex SMTPUTF8 "ESMTP option"
41361 The main configuration option &%smtputf8_advertise_hosts%& specifies
41362 a host list.  If this matches the sending host and
41363 accept_8bitmime is true (the default) then the ESMTP option
41364 SMTPUTF8 will be advertised.
41365
41366 If the sender specifies the SMTPUTF8 option on a MAIL command
41367 international handling for the message is enabled and
41368 the expansion variable &$message_smtputf8$& will have value TRUE.
41369
41370 The option &%allow_utf8_domains%& is set to true for this
41371 message. All DNS lookups are converted to a-label form
41372 whatever the setting of &%allow_utf8_domains%&
41373 when Exim is built with SUPPORT_I18N.
41374
41375 Both localparts and domain are maintained as the original
41376 UTF-8 form internally; any comparison or regular-expression use will
41377 require appropriate care.  Filenames created, eg. by
41378 the appendfile transport, will have UTF-8 names.
41379
41380 HELO names sent by the smtp transport will have any UTF-8
41381 components expanded to a-label form,
41382 and any certificate name checks will be done using the a-label
41383 form of the name.
41384
41385 .cindex log protocol
41386 .cindex SMTPUTF8 logging
41387 .cindex i18n logging
41388 Log lines and Received-by: header lines will acquire a "utf8"
41389 prefix on the protocol element, eg. utf8esmtp.
41390
41391 The following expansion operators can be used:
41392 .code
41393 ${utf8_domain_to_alabel:str}
41394 ${utf8_domain_from_alabel:str}
41395 ${utf8_localpart_to_alabel:str}
41396 ${utf8_localpart_from_alabel:str}
41397 .endd
41398
41399 .cindex utf8 "address downconversion"
41400 .cindex i18n "utf8 address downconversion"
41401 The RCPT ACL
41402 may use the following modifier:
41403 .display
41404 control = utf8_downconvert
41405 control = utf8_downconvert/<value>
41406 .endd
41407 This sets a flag requiring that addresses are converted to
41408 a-label form before smtp delivery, for use in a
41409 Message Submission Agent context.
41410 If a value is appended it may be:
41411 .display
41412 &`1  `& (default) mandatory downconversion
41413 &`0  `& no downconversion
41414 &`-1 `& if SMTPUTF8 not supported by destination host
41415 .endd
41416
41417 If mua_wrapper is set, the utf8_downconvert control
41418 is initially set to -1.
41419
41420 The smtp transport has an option &%utf8_downconvert%&.
41421 If set it must expand to one of the three values described above,
41422 and it overrides any previously set value.
41423
41424
41425 There is no explicit support for VRFY and EXPN.
41426 Configurations supporting these should inspect
41427 &$smtp_command_argument$& for an SMTPUTF8 argument.
41428
41429 There is no support for LMTP on Unix sockets.
41430 Using the "lmtp" protocol option on an smtp transport,
41431 for LMTP over TCP, should work as expected.
41432
41433 There is no support for DSN unitext handling,
41434 and no provision for converting logging from or to UTF-8.
41435
41436
41437
41438 .section "MDA operations" SECTi18nMDA
41439 To aid in constructing names suitable for IMAP folders
41440 the following expansion operator can be used:
41441 .code
41442 ${imapfolder {<string>} {<sep>} {<specials>}}
41443 .endd
41444
41445 The string is converted from the charset specified by
41446 the "headers charset" command (in a filter file)
41447 or &%headers_charset%& main configuration option (otherwise),
41448 to the
41449 modified UTF-7 encoding specified by RFC 2060,
41450 with the following exception: All occurrences of <sep>
41451 (which has to be a single character)
41452 are replaced with periods ("."), and all periods and slashes that are not
41453 <sep> and are not in the <specials> string are BASE64 encoded.
41454
41455 The third argument can be omitted, defaulting to an empty string.
41456 The second argument can be omitted, defaulting to "/".
41457
41458 This is the encoding used by Courier for Maildir names on disk, and followed
41459 by many other IMAP servers.
41460
41461 Examples:
41462 .display
41463 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41464 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41465 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41466 .endd
41467
41468 Note that the source charset setting is vital, and also that characters
41469 must be representable in UTF-16.
41470
41471
41472 . ////////////////////////////////////////////////////////////////////////////
41473 . ////////////////////////////////////////////////////////////////////////////
41474
41475 .chapter "Events" "CHAPevents" &&&
41476          "Events"
41477 .cindex events
41478
41479 The events mechanism in Exim can be used to intercept processing at a number
41480 of points.  It was originally invented to give a way to do customised logging
41481 actions (for example, to a database) but can also be used to modify some
41482 processing actions.
41483
41484 Most installations will never need to use Events.
41485 The support can be left out of a build by defining DISABLE_EVENT=yes
41486 in &_Local/Makefile_&.
41487
41488 There are two major classes of events: main and transport.
41489 The main configuration option &%event_action%& controls reception events;
41490 a transport option &%event_action%& controls delivery events.
41491
41492 Both options are a string which is expanded when the event fires.
41493 An example might look like:
41494 .cindex logging custom
41495 .code
41496 event_action = ${if eq {msg:delivery}{$event_name} \
41497 {${lookup pgsql {SELECT * FROM record_Delivery( \
41498     '${quote_pgsql:$sender_address_domain}',\
41499     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41500     '${quote_pgsql:$domain}', \
41501     '${quote_pgsql:${lc:$local_part}}', \
41502     '${quote_pgsql:$host_address}', \
41503     '${quote_pgsql:${lc:$host}}', \
41504     '${quote_pgsql:$message_exim_id}')}} \
41505 } {}}
41506 .endd
41507
41508 Events have names which correspond to the point in process at which they fire.
41509 The name is placed in the variable &$event_name$& and the event action
41510 expansion must check this, as it will be called for every possible event type.
41511
41512 .new
41513 The current list of events is:
41514 .wen
41515 .display
41516 &`dane:fail              after    transport  `& per connection
41517 &`msg:complete           after    main       `& per message
41518 &`msg:defer              after    transport  `& per message per delivery try
41519 &`msg:delivery           after    transport  `& per recipient
41520 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41521 &`msg:rcpt:defer         after    transport  `& per recipient
41522 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41523 &`msg:fail:delivery      after    transport  `& per recipient
41524 &`msg:fail:internal      after    main       `& per recipient
41525 &`tcp:connect            before   transport  `& per connection
41526 &`tcp:close              after    transport  `& per connection
41527 &`tls:cert               before   both       `& per certificate in verification chain
41528 &`smtp:connect           after    transport  `& per connection
41529 &`smtp:ehlo              after    transport  `& per connection
41530 .endd
41531 New event types may be added in future.
41532
41533 The event name is a colon-separated list, defining the type of
41534 event in a tree of possibilities.  It may be used as a list
41535 or just matched on as a whole.  There will be no spaces in the name.
41536
41537 The second column in the table above describes whether the event fires
41538 before or after the action is associates with.  Those which fire before
41539 can be used to affect that action (more on this below).
41540
41541 The third column in the table above says what section of the configuration
41542 should define the event action.
41543
41544 An additional variable, &$event_data$&, is filled with information varying
41545 with the event type:
41546 .display
41547 &`dane:fail            `& failure reason
41548 &`msg:defer            `& error string
41549 &`msg:delivery         `& smtp confirmation message
41550 &`msg:fail:internal    `& failure reason
41551 &`msg:fail:delivery    `& smtp error message
41552 &`msg:host:defer       `& error string
41553 &`msg:rcpt:host:defer  `& error string
41554 &`msg:rcpt:defer       `& error string
41555 &`tls:cert             `& verification chain depth
41556 &`smtp:connect         `& smtp banner
41557 &`smtp:ehlo            `& smtp ehlo response
41558 .endd
41559
41560 The :defer events populate one extra variable: &$event_defer_errno$&.
41561
41562 For complex operations an ACL expansion can be used in &%event_action%&
41563 however due to the multiple contexts that Exim operates in during
41564 the course of its processing:
41565 .ilist
41566 variables set in transport events will not be visible outside that
41567 transport call
41568 .next
41569 acl_m variables in a server context are lost on a new connection,
41570 and after smtp helo/ehlo/mail/starttls/rset commands
41571 .endlist
41572 Using an ACL expansion with the logwrite modifier can be
41573 a useful way of writing to the main log.
41574
41575 The expansion of the event_action option should normally
41576 return an empty string.  Should it return anything else the
41577 following will be forced:
41578 .display
41579 &`tcp:connect      `&  do not connect
41580 &`tls:cert         `&  refuse verification
41581 &`smtp:connect     `&  close connection
41582 .endd
41583 All other message types ignore the result string, and
41584 no other use is made of it.
41585
41586 For a tcp:connect event, if the connection is being made to a proxy
41587 then the address and port variables will be that of the proxy and not
41588 the target system.
41589
41590 For tls:cert events, if GnuTLS is in use this will trigger only per
41591 chain element received on the connection.
41592 For OpenSSL it will trigger for every chain element including those
41593 loaded locally.
41594
41595 . ////////////////////////////////////////////////////////////////////////////
41596 . ////////////////////////////////////////////////////////////////////////////
41597
41598 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41599          "Adding drivers or lookups"
41600 .cindex "adding drivers"
41601 .cindex "new drivers, adding"
41602 .cindex "drivers" "adding new"
41603 The following actions have to be taken in order to add a new router, transport,
41604 authenticator, or lookup type to Exim:
41605
41606 .olist
41607 Choose a name for the driver or lookup type that does not conflict with any
41608 existing name; I will use &"newdriver"& in what follows.
41609 .next
41610 Add to &_src/EDITME_& the line:
41611 .display
41612 <&'type'&>&`_NEWDRIVER=yes`&
41613 .endd
41614 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41615 code is not to be included in the binary by default, comment this line out. You
41616 should also add any relevant comments about the driver or lookup type.
41617 .next
41618 Add to &_src/config.h.defaults_& the line:
41619 .code
41620 #define <type>_NEWDRIVER
41621 .endd
41622 .next
41623 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41624 and create a table entry as is done for all the other drivers and lookup types.
41625 .next
41626 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41627 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41628 Add your &`NEWDRIVER`& to that list.
41629 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41630 simple form that most lookups have.
41631 .next
41632 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41633 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41634 driver or lookup type and add it to the definition of OBJ.
41635 .next
41636 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41637 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41638 .next
41639 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41640 &_src_&.
41641 .next
41642 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41643 as for other drivers and lookups.
41644 .endlist
41645
41646 Then all you need to do is write the code! A good way to start is to make a
41647 proforma by copying an existing module of the same type, globally changing all
41648 occurrences of the name, and cutting out most of the code. Note that any
41649 options you create must be listed in alphabetical order, because the tables are
41650 searched using a binary chop procedure.
41651
41652 There is a &_README_& file in each of the sub-directories of &_src_& describing
41653 the interface that is expected.
41654
41655
41656
41657
41658 . ////////////////////////////////////////////////////////////////////////////
41659 . ////////////////////////////////////////////////////////////////////////////
41660
41661 . /////////////////////////////////////////////////////////////////////////////
41662 . These lines are processing instructions for the Simple DocBook Processor that
41663 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41664 . PDFs than using xmlto and fop. They will be ignored by all other XML
41665 . processors.
41666 . /////////////////////////////////////////////////////////////////////////////
41667
41668 .literal xml
41669 <?sdop
41670   format="newpage"
41671   foot_right_recto="&chaptertitle;"
41672   foot_right_verso="&chaptertitle;"
41673 ?>
41674 .literal off
41675
41676 .makeindex "Options index"   "option"
41677 .makeindex "Variables index" "variable"
41678 .makeindex "Concept index"   "concept"
41679
41680
41681 . /////////////////////////////////////////////////////////////////////////////
41682 . /////////////////////////////////////////////////////////////////////////////