3b5ae26aa3263e3e14894ed3d6ad73e247297010
[exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing 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 generate the outermost <book> element that wraps then 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.91"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2018
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be 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 . --- the 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 the program,
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 the 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, the 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 This 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 the program 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 the program (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 and web sites" "SECID2"
449 .cindex "web site"
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 web site 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 this 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 Nigel Metheringham's
551 PGP key, a version of which can be found in the release directory in the file
552 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At time of 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 separately 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 "Run time configuration" "SECID7"
625 Exim's run time 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 on 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 on 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 that
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 on 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 licence 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 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 file names, 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 so-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 address
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 any 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 the program 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. Run time 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 run time 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 specially by the local host. These
1237 are typically 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 as case-sensitive. 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$&"
1403 .vindex "&$local_part_suffix$&"
1404 .cindex affix "router precondition"
1405 If the &%local_parts%& option is set, the local part of the address must be in
1406 the set of local parts that it defines. If &%local_part_prefix%& or
1407 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1408 part before this check. If you want to do precondition tests on local parts
1409 that include affixes, you can do so by using a &%condition%& option (see below)
1410 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1411 &$local_part_suffix$& as necessary.
1412 .next
1413 .vindex "&$local_user_uid$&"
1414 .vindex "&$local_user_gid$&"
1415 .vindex "&$home$&"
1416 If the &%check_local_user%& option is set, the local part must be the name of
1417 an account on the local host. If this check succeeds, the uid and gid of the
1418 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1419 user's home directory is placed in &$home$&; these values can be used in the
1420 remaining preconditions.
1421 .next
1422 If the &%router_home_directory%& option is set, it is expanded at this point,
1423 because it overrides the value of &$home$&. If this expansion were left till
1424 later, the value of &$home$& as set by &%check_local_user%& would be used in
1425 subsequent tests. Having two different values of &$home$& in the same router
1426 could lead to confusion.
1427 .next
1428 If the &%senders%& option is set, the envelope sender address must be in the
1429 set of addresses that it defines.
1430 .next
1431 If the &%require_files%& option is set, the existence or non-existence of
1432 specified files is tested.
1433 .next
1434 .cindex "customizing" "precondition"
1435 If the &%condition%& option is set, it is evaluated and tested. This option
1436 uses an expanded string to allow you to set up your own custom preconditions.
1437 Expanded strings are described in chapter &<<CHAPexpand>>&.
1438 .endlist
1439
1440
1441 Note that &%require_files%& comes near the end of the list, so you cannot use
1442 it to check for the existence of a file in which to lookup up a domain, local
1443 part, or sender. However, as these options are all expanded, you can use the
1444 &%exists%& expansion condition to make such tests within each condition. The
1445 &%require_files%& option is intended for checking files that the router may be
1446 going to use internally, or which are needed by a specific transport (for
1447 example, &_.procmailrc_&).
1448
1449
1450
1451 .section "Delivery in detail" "SECID18"
1452 .cindex "delivery" "in detail"
1453 When a message is to be delivered, the sequence of events is as follows:
1454
1455 .ilist
1456 If a system-wide filter file is specified, the message is passed to it. The
1457 filter may add recipients to the message, replace the recipients, discard the
1458 message, cause a new message to be generated, or cause the message delivery to
1459 fail. The format of the system filter file is the same as for Exim user filter
1460 files, described in the separate document entitled &'Exim's interfaces to mail
1461 filtering'&.
1462 .cindex "Sieve filter" "not available for system filter"
1463 (&*Note*&: Sieve cannot be used for system filter files.)
1464
1465 Some additional features are available in system filters &-- see chapter
1466 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1467 filter only once per delivery attempt, however many recipients it has. However,
1468 if there are several delivery attempts because one or more addresses could not
1469 be immediately delivered, the system filter is run each time. The filter
1470 condition &%first_delivery%& can be used to detect the first run of the system
1471 filter.
1472 .next
1473 Each recipient address is offered to each configured router in turn, subject to
1474 its preconditions, until one is able to handle it. If no router can handle the
1475 address, that is, if they all decline, the address is failed. Because routers
1476 can be targeted at particular domains, several locally handled domains can be
1477 processed entirely independently of each other.
1478 .next
1479 .cindex "routing" "loops in"
1480 .cindex "loop" "while routing"
1481 A router that accepts an address may assign it to a local or a remote
1482 transport. However, the transport is not run at this time. Instead, the address
1483 is placed on a list for the particular transport, which will be run later.
1484 Alternatively, the router may generate one or more new addresses (typically
1485 from alias, forward, or filter files). New addresses are fed back into this
1486 process from the top, but in order to avoid loops, a router ignores any address
1487 which has an identically-named ancestor that was processed by itself.
1488 .next
1489 When all the routing has been done, addresses that have been successfully
1490 handled are passed to their assigned transports. When local transports are
1491 doing real local deliveries, they handle only one address at a time, but if a
1492 local transport is being used as a pseudo-remote transport (for example, to
1493 collect batched SMTP messages for transmission by some other means) multiple
1494 addresses can be handled. Remote transports can always handle more than one
1495 address at a time, but can be configured not to do so, or to restrict multiple
1496 addresses to the same domain.
1497 .next
1498 Each local delivery to a file or a pipe runs in a separate process under a
1499 non-privileged uid, and these deliveries are run one at a time. Remote
1500 deliveries also run in separate processes, normally under a uid that is private
1501 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1502 run in parallel. The maximum number of simultaneous remote deliveries for any
1503 one message is set by the &%remote_max_parallel%& option.
1504 The order in which deliveries are done is not defined, except that all local
1505 deliveries happen before any remote deliveries.
1506 .next
1507 .cindex "queue runner"
1508 When it encounters a local delivery during a queue run, Exim checks its retry
1509 database to see if there has been a previous temporary delivery failure for the
1510 address before running the local transport. If there was a previous failure,
1511 Exim does not attempt a new delivery until the retry time for the address is
1512 reached. However, this happens only for delivery attempts that are part of a
1513 queue run. Local deliveries are always attempted when delivery immediately
1514 follows message reception, even if retry times are set for them. This makes for
1515 better behaviour if one particular message is causing problems (for example,
1516 causing quota overflow, or provoking an error in a filter file).
1517 .next
1518 .cindex "delivery" "retry in remote transports"
1519 Remote transports do their own retry handling, since an address may be
1520 deliverable to one of a number of hosts, each of which may have a different
1521 retry time. If there have been previous temporary failures and no host has
1522 reached its retry time, no delivery is attempted, whether in a queue run or
1523 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1524 .next
1525 If there were any permanent errors, a bounce message is returned to an
1526 appropriate address (the sender in the common case), with details of the error
1527 for each failing address. Exim can be configured to send copies of bounce
1528 messages to other addresses.
1529 .next
1530 .cindex "delivery" "deferral"
1531 If one or more addresses suffered a temporary failure, the message is left on
1532 the queue, to be tried again later. Delivery of these addresses is said to be
1533 &'deferred'&.
1534 .next
1535 When all the recipient addresses have either been delivered or bounced,
1536 handling of the message is complete. The spool files and message log are
1537 deleted, though the message log can optionally be preserved if required.
1538 .endlist
1539
1540
1541
1542
1543 .section "Retry mechanism" "SECID19"
1544 .cindex "delivery" "retry mechanism"
1545 .cindex "retry" "description of mechanism"
1546 .cindex "queue runner"
1547 Exim's mechanism for retrying messages that fail to get delivered at the first
1548 attempt is the queue runner process. You must either run an Exim daemon that
1549 uses the &%-q%& option with a time interval to start queue runners at regular
1550 intervals, or use some other means (such as &'cron'&) to start them. If you do
1551 not arrange for queue runners to be run, messages that fail temporarily at the
1552 first attempt will remain on your queue for ever. A queue runner process works
1553 its way through the queue, one message at a time, trying each delivery that has
1554 passed its retry time.
1555 You can run several queue runners at once.
1556
1557 Exim uses a set of configured rules to determine when next to retry the failing
1558 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1559 should give up trying to deliver to the address, at which point it generates a
1560 bounce message. If no retry rules are set for a particular host, address, and
1561 error combination, no retries are attempted, and temporary errors are treated
1562 as permanent.
1563
1564
1565
1566 .section "Temporary delivery failure" "SECID20"
1567 .cindex "delivery" "temporary failure"
1568 There are many reasons why a message may not be immediately deliverable to a
1569 particular address. Failure to connect to a remote machine (because it, or the
1570 connection to it, is down) is one of the most common. Temporary failures may be
1571 detected during routing as well as during the transport stage of delivery.
1572 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1573 is on a file system where the user is over quota. Exim can be configured to
1574 impose its own quotas on local mailboxes; where system quotas are set they will
1575 also apply.
1576
1577 If a host is unreachable for a period of time, a number of messages may be
1578 waiting for it by the time it recovers, and sending them in a single SMTP
1579 connection is clearly beneficial. Whenever a delivery to a remote host is
1580 deferred,
1581 .cindex "hints database" "deferred deliveries"
1582 Exim makes a note in its hints database, and whenever a successful
1583 SMTP delivery has happened, it looks to see if any other messages are waiting
1584 for the same host. If any are found, they are sent over the same SMTP
1585 connection, subject to a configuration limit as to the maximum number in any
1586 one connection.
1587
1588
1589
1590 .section "Permanent delivery failure" "SECID21"
1591 .cindex "delivery" "permanent failure"
1592 .cindex "bounce message" "when generated"
1593 When a message cannot be delivered to some or all of its intended recipients, a
1594 bounce message is generated. Temporary delivery failures turn into permanent
1595 errors when their timeout expires. All the addresses that fail in a given
1596 delivery attempt are listed in a single message. If the original message has
1597 many recipients, it is possible for some addresses to fail in one delivery
1598 attempt and others to fail subsequently, giving rise to more than one bounce
1599 message. The wording of bounce messages can be customized by the administrator.
1600 See chapter &<<CHAPemsgcust>>& for details.
1601
1602 .cindex "&'X-Failed-Recipients:'& header line"
1603 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1604 failed addresses, for the benefit of programs that try to analyse such messages
1605 automatically.
1606
1607 .cindex "bounce message" "recipient of"
1608 A bounce message is normally sent to the sender of the original message, as
1609 obtained from the message's envelope. For incoming SMTP messages, this is the
1610 address given in the MAIL command. However, when an address is expanded via a
1611 forward or alias file, an alternative address can be specified for delivery
1612 failures of the generated addresses. For a mailing list expansion (see section
1613 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1614 of the list.
1615
1616
1617
1618 .section "Failures to deliver bounce messages" "SECID22"
1619 .cindex "bounce message" "failure to deliver"
1620 If a bounce message (either locally generated or received from a remote host)
1621 itself suffers a permanent delivery failure, the message is left on the queue,
1622 but it is frozen, awaiting the attention of an administrator. There are options
1623 that can be used to make Exim discard such failed messages, or to keep them
1624 for only a short time (see &%timeout_frozen_after%& and
1625 &%ignore_bounce_errors_after%&).
1626
1627
1628
1629
1630
1631 . ////////////////////////////////////////////////////////////////////////////
1632 . ////////////////////////////////////////////////////////////////////////////
1633
1634 .chapter "Building and installing Exim" "CHID3"
1635 .scindex IIDbuex "building Exim"
1636
1637 .section "Unpacking" "SECID23"
1638 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1639 creates a directory with the name of the current release (for example,
1640 &_exim-&version()_&) into which the following files are placed:
1641
1642 .table2 140pt
1643 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1644 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1645   documented"
1646 .irow &_LICENCE_&         "the GNU General Public Licence"
1647 .irow &_Makefile_&        "top-level make file"
1648 .irow &_NOTICE_&          "conditions for the use of Exim"
1649 .irow &_README_&          "list of files, directories and simple build &&&
1650   instructions"
1651 .endtable
1652
1653 Other files whose names begin with &_README_& may also be present. The
1654 following subdirectories are created:
1655
1656 .table2 140pt
1657 .irow &_Local_&           "an empty directory for local configuration files"
1658 .irow &_OS_&              "OS-specific files"
1659 .irow &_doc_&             "documentation files"
1660 .irow &_exim_monitor_&    "source files for the Exim monitor"
1661 .irow &_scripts_&         "scripts used in the build process"
1662 .irow &_src_&             "remaining source files"
1663 .irow &_util_&            "independent utilities"
1664 .endtable
1665
1666 The main utility programs are contained in the &_src_& directory, and are built
1667 with the Exim binary. The &_util_& directory contains a few optional scripts
1668 that may be useful to some sites.
1669
1670
1671 .section "Multiple machine architectures and operating systems" "SECID24"
1672 .cindex "building Exim" "multiple OS/architectures"
1673 The building process for Exim is arranged to make it easy to build binaries for
1674 a number of different architectures and operating systems from the same set of
1675 source files. Compilation does not take place in the &_src_& directory.
1676 Instead, a &'build directory'& is created for each architecture and operating
1677 system.
1678 .cindex "symbolic link" "to build directory"
1679 Symbolic links to the sources are installed in this directory, which is where
1680 the actual building takes place. In most cases, Exim can discover the machine
1681 architecture and operating system for itself, but the defaults can be
1682 overridden if necessary.
1683 .cindex compiler requirements
1684 .cindex compiler version
1685 A C99-capable compiler will be required for the build.
1686
1687
1688 .section "PCRE library" "SECTpcre"
1689 .cindex "PCRE library"
1690 Exim no longer has an embedded PCRE library as the vast majority of
1691 modern systems include PCRE as a system library, although you may need
1692 to install the PCRE or PCRE development package for your operating
1693 system. If your system has a normal PCRE installation the Exim build
1694 process will need no further configuration. If the library or the
1695 headers are in an unusual location you will need to either set the PCRE_LIBS
1696 and INCLUDE directives appropriately,
1697 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1698 If your operating system has no
1699 PCRE support then you will need to obtain and build the current PCRE
1700 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1701 More information on PCRE is available at &url(https://www.pcre.org/).
1702
1703 .section "DBM libraries" "SECTdb"
1704 .cindex "DBM libraries" "discussion of"
1705 .cindex "hints database" "DBM files used for"
1706 Even if you do not use any DBM files in your configuration, Exim still needs a
1707 DBM library in order to operate, because it uses indexed files for its hints
1708 databases. Unfortunately, there are a number of DBM libraries in existence, and
1709 different operating systems often have different ones installed.
1710
1711 .cindex "Solaris" "DBM library for"
1712 .cindex "IRIX, DBM library for"
1713 .cindex "BSD, DBM library for"
1714 .cindex "Linux, DBM library for"
1715 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1716 Linux distribution, the DBM configuration should happen automatically, and you
1717 may be able to ignore this section. Otherwise, you may have to learn more than
1718 you would like about DBM libraries from what follows.
1719
1720 .cindex "&'ndbm'& DBM library"
1721 Licensed versions of Unix normally contain a library of DBM functions operating
1722 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1723 versions of Unix seem to vary in what they contain as standard. In particular,
1724 some early versions of Linux have no default DBM library, and different
1725 distributors have chosen to bundle different libraries with their packaged
1726 versions. However, the more recent releases seem to have standardized on the
1727 Berkeley DB library.
1728
1729 Different DBM libraries have different conventions for naming the files they
1730 use. When a program opens a file called &_dbmfile_&, there are several
1731 possibilities:
1732
1733 .olist
1734 A traditional &'ndbm'& implementation, such as that supplied as part of
1735 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1736 .next
1737 .cindex "&'gdbm'& DBM library"
1738 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1739 compatibility interface it makes two different hard links to it with names
1740 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1741 file name is used unmodified.
1742 .next
1743 .cindex "Berkeley DB library"
1744 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1745 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1746 programmer exactly the same as the traditional &'ndbm'& implementation.
1747 .next
1748 If the Berkeley package is used in its native mode, it operates on a single
1749 file called &_dbmfile_&; the programmer's interface is somewhat different to
1750 the traditional &'ndbm'& interface.
1751 .next
1752 To complicate things further, there are several very different versions of the
1753 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1754 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1755 Maintenance of some of the earlier releases has ceased. All versions of
1756 Berkeley DB could be obtained from
1757 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1758 page with far newer versions listed.
1759 It is probably wise to plan to move your storage configurations away from
1760 Berkeley DB format, as today there are smaller and simpler alternatives more
1761 suited to Exim's usage model.
1762 .next
1763 .cindex "&'tdb'& DBM library"
1764 Yet another DBM library, called &'tdb'&, is available from
1765 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1766 operates on a single file.
1767 .endlist
1768
1769 .cindex "USE_DB"
1770 .cindex "DBM libraries" "configuration for building"
1771 Exim and its utilities can be compiled to use any of these interfaces. In order
1772 to use any version of the Berkeley DB package in native mode, you must set
1773 USE_DB in an appropriate configuration file (typically
1774 &_Local/Makefile_&). For example:
1775 .code
1776 USE_DB=yes
1777 .endd
1778 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1779 error is diagnosed if you set more than one of these.
1780
1781 At the lowest level, the build-time configuration sets none of these options,
1782 thereby assuming an interface of type (1). However, some operating system
1783 configuration files (for example, those for the BSD operating systems and
1784 Linux) assume type (4) by setting USE_DB as their default, and the
1785 configuration files for Cygwin set USE_GDBM. Anything you set in
1786 &_Local/Makefile_&, however, overrides these system defaults.
1787
1788 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1789 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1790 in one of these lines:
1791 .code
1792 DBMLIB = -ldb
1793 DBMLIB = -ltdb
1794 .endd
1795 Settings like that will work if the DBM library is installed in the standard
1796 place. Sometimes it is not, and the library's header file may also not be in
1797 the default path. You may need to set INCLUDE to specify where the header
1798 file is, and to specify the path to the library more fully in DBMLIB, as in
1799 this example:
1800 .code
1801 INCLUDE=-I/usr/local/include/db-4.1
1802 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1803 .endd
1804 There is further detailed discussion about the various DBM libraries in the
1805 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1806
1807
1808
1809 .section "Pre-building configuration" "SECID25"
1810 .cindex "building Exim" "pre-building configuration"
1811 .cindex "configuration for building Exim"
1812 .cindex "&_Local/Makefile_&"
1813 .cindex "&_src/EDITME_&"
1814 Before building Exim, a local configuration file that specifies options
1815 independent of any operating system has to be created with the name
1816 &_Local/Makefile_&. A template for this file is supplied as the file
1817 &_src/EDITME_&, and it contains full descriptions of all the option settings
1818 therein. These descriptions are therefore not repeated here. If you are
1819 building Exim for the first time, the simplest thing to do is to copy
1820 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1821
1822 There are three settings that you must supply, because Exim will not build
1823 without them. They are the location of the run time configuration file
1824 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1825 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1826 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1827 a colon-separated list of file names; Exim uses the first of them that exists.
1828
1829 There are a few other parameters that can be specified either at build time or
1830 at run time, to enable the same binary to be used on a number of different
1831 machines. However, if the locations of Exim's spool directory and log file
1832 directory (if not within the spool directory) are fixed, it is recommended that
1833 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1834 detected early in Exim's execution (such as a malformed configuration file) can
1835 be logged.
1836
1837 .cindex "content scanning" "specifying at build time"
1838 Exim's interfaces for calling virus and spam scanning software directly from
1839 access control lists are not compiled by default. If you want to include these
1840 facilities, you need to set
1841 .code
1842 WITH_CONTENT_SCAN=yes
1843 .endd
1844 in your &_Local/Makefile_&. For details of the facilities themselves, see
1845 chapter &<<CHAPexiscan>>&.
1846
1847
1848 .cindex "&_Local/eximon.conf_&"
1849 .cindex "&_exim_monitor/EDITME_&"
1850 If you are going to build the Exim monitor, a similar configuration process is
1851 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1852 your installation and saved under the name &_Local/eximon.conf_&. If you are
1853 happy with the default settings described in &_exim_monitor/EDITME_&,
1854 &_Local/eximon.conf_& can be empty, but it must exist.
1855
1856 This is all the configuration that is needed in straightforward cases for known
1857 operating systems. However, the building process is set up so that it is easy
1858 to override options that are set by default or by operating-system-specific
1859 configuration files, for example to change the name of the C compiler, which
1860 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1861 do this.
1862
1863
1864
1865 .section "Support for iconv()" "SECID26"
1866 .cindex "&[iconv()]& support"
1867 .cindex "RFC 2047"
1868 The contents of header lines in messages may be encoded according to the rules
1869 described RFC 2047. This makes it possible to transmit characters that are not
1870 in the ASCII character set, and to label them as being in a particular
1871 character set. When Exim is inspecting header lines by means of the &%$h_%&
1872 mechanism, it decodes them, and translates them into a specified character set
1873 (default is set at build time). The translation is possible only if the operating system
1874 supports the &[iconv()]& function.
1875
1876 However, some of the operating systems that supply &[iconv()]& do not support
1877 very many conversions. The GNU &%libiconv%& library (available from
1878 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1879 systems to remedy this deficiency, as well as on systems that do not supply
1880 &[iconv()]& at all. After installing &%libiconv%&, you should add
1881 .code
1882 HAVE_ICONV=yes
1883 .endd
1884 to your &_Local/Makefile_& and rebuild Exim.
1885
1886
1887
1888 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1889 .cindex "TLS" "including support for TLS"
1890 .cindex "encryption" "including support for"
1891 .cindex "SUPPORT_TLS"
1892 .cindex "OpenSSL" "building Exim with"
1893 .cindex "GnuTLS" "building Exim with"
1894 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1895 command as per RFC 2487. It can also support legacy clients that expect to
1896 start a TLS session immediately on connection to a non-standard port (see the
1897 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1898 line option).
1899
1900 If you want to build Exim with TLS support, you must first install either the
1901 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1902 implementing SSL.
1903
1904 If OpenSSL is installed, you should set
1905 .code
1906 SUPPORT_TLS=yes
1907 TLS_LIBS=-lssl -lcrypto
1908 .endd
1909 in &_Local/Makefile_&. You may also need to specify the locations of the
1910 OpenSSL library and include files. For example:
1911 .code
1912 SUPPORT_TLS=yes
1913 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1914 TLS_INCLUDE=-I/usr/local/openssl/include/
1915 .endd
1916 .cindex "pkg-config" "OpenSSL"
1917 If you have &'pkg-config'& available, then instead you can just use:
1918 .code
1919 SUPPORT_TLS=yes
1920 USE_OPENSSL_PC=openssl
1921 .endd
1922 .cindex "USE_GNUTLS"
1923 If GnuTLS is installed, you should set
1924 .code
1925 SUPPORT_TLS=yes
1926 USE_GNUTLS=yes
1927 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1928 .endd
1929 in &_Local/Makefile_&, and again you may need to specify the locations of the
1930 library and include files. For example:
1931 .code
1932 SUPPORT_TLS=yes
1933 USE_GNUTLS=yes
1934 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1935 TLS_INCLUDE=-I/usr/gnu/include
1936 .endd
1937 .cindex "pkg-config" "GnuTLS"
1938 If you have &'pkg-config'& available, then instead you can just use:
1939 .code
1940 SUPPORT_TLS=yes
1941 USE_GNUTLS=yes
1942 USE_GNUTLS_PC=gnutls
1943 .endd
1944
1945 You do not need to set TLS_INCLUDE if the relevant directory is already
1946 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1947 given in chapter &<<CHAPTLS>>&.
1948
1949
1950
1951
1952 .section "Use of tcpwrappers" "SECID27"
1953
1954 .cindex "tcpwrappers, building Exim to support"
1955 .cindex "USE_TCP_WRAPPERS"
1956 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1957 .cindex "tcp_wrappers_daemon_name"
1958 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1959 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1960 alternative to Exim's own checking facilities for installations that are
1961 already making use of &'tcpwrappers'& for other purposes. To do this, you
1962 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1963 &_tcpd.h_& to be available at compile time, and also ensure that the library
1964 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1965 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1966 you might have
1967 .code
1968 USE_TCP_WRAPPERS=yes
1969 CFLAGS=-O -I/usr/local/include
1970 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1971 .endd
1972 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1973 files is &"exim"&. For example, the line
1974 .code
1975 exim : LOCAL  192.168.1.  .friendly.domain.example
1976 .endd
1977 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1978 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1979 All other connections are denied. The daemon name used by &'tcpwrappers'&
1980 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1981 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1982 configure file. Consult the &'tcpwrappers'& documentation for
1983 further details.
1984
1985
1986 .section "Including support for IPv6" "SECID28"
1987 .cindex "IPv6" "including support for"
1988 Exim contains code for use on systems that have IPv6 support. Setting
1989 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1990 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1991 where the IPv6 support is not fully integrated into the normal include and
1992 library files.
1993
1994 Two different types of DNS record for handling IPv6 addresses have been
1995 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1996 currently seen as the mainstream. Another record type called A6 was proposed
1997 as better than AAAA because it had more flexibility. However, it was felt to be
1998 over-complex, and its status was reduced to &"experimental"&.
1999 Exim used to
2000 have a compile option for including A6 record support but this has now been
2001 withdrawn.
2002
2003
2004
2005 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2006 .cindex "lookup modules"
2007 .cindex "dynamic modules"
2008 .cindex ".so building"
2009 On some platforms, Exim supports not compiling all lookup types directly into
2010 the main binary, instead putting some into external modules which can be loaded
2011 on demand.
2012 This permits packagers to build Exim with support for lookups with extensive
2013 library dependencies without requiring all users to install all of those
2014 dependencies.
2015 Most, but not all, lookup types can be built this way.
2016
2017 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2018 installed; Exim will only load modules from that directory, as a security
2019 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2020 for your OS; see &_OS/Makefile-Linux_& for an example.
2021 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2022 see &_src/EDITME_& for details.
2023
2024 Then, for each module to be loaded dynamically, define the relevant
2025 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2026 For example, this will build in lsearch but load sqlite and mysql support
2027 on demand:
2028 .code
2029 LOOKUP_LSEARCH=yes
2030 LOOKUP_SQLITE=2
2031 LOOKUP_MYSQL=2
2032 .endd
2033
2034
2035 .section "The building process" "SECID29"
2036 .cindex "build directory"
2037 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2038 created, run &'make'& at the top level. It determines the architecture and
2039 operating system types, and creates a build directory if one does not exist.
2040 For example, on a Sun system running Solaris 8, the directory
2041 &_build-SunOS5-5.8-sparc_& is created.
2042 .cindex "symbolic link" "to source files"
2043 Symbolic links to relevant source files are installed in the build directory.
2044
2045 If this is the first time &'make'& has been run, it calls a script that builds
2046 a make file inside the build directory, using the configuration files from the
2047 &_Local_& directory. The new make file is then passed to another instance of
2048 &'make'&. This does the real work, building a number of utility scripts, and
2049 then compiling and linking the binaries for the Exim monitor (if configured), a
2050 number of utility programs, and finally Exim itself. The command &`make
2051 makefile`& can be used to force a rebuild of the make file in the build
2052 directory, should this ever be necessary.
2053
2054 If you have problems building Exim, check for any comments there may be in the
2055 &_README_& file concerning your operating system, and also take a look at the
2056 FAQ, where some common problems are covered.
2057
2058
2059
2060 .section 'Output from &"make"&' "SECID283"
2061 The output produced by the &'make'& process for compile lines is often very
2062 unreadable, because these lines can be very long. For this reason, the normal
2063 output is suppressed by default, and instead output similar to that which
2064 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2065 each module that is being compiled or linked. However, it is still possible to
2066 get the full output, by calling &'make'& like this:
2067 .code
2068 FULLECHO='' make -e
2069 .endd
2070 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2071 command reflection in &'make'&. When you ask for the full output, it is
2072 given in addition to the short output.
2073
2074
2075
2076 .section "Overriding build-time options for Exim" "SECToverride"
2077 .cindex "build-time options, overriding"
2078 The main make file that is created at the beginning of the building process
2079 consists of the concatenation of a number of files which set configuration
2080 values, followed by a fixed set of &'make'& instructions. If a value is set
2081 more than once, the last setting overrides any previous ones. This provides a
2082 convenient way of overriding defaults. The files that are concatenated are, in
2083 order:
2084 .display
2085 &_OS/Makefile-Default_&
2086 &_OS/Makefile-_&<&'ostype'&>
2087 &_Local/Makefile_&
2088 &_Local/Makefile-_&<&'ostype'&>
2089 &_Local/Makefile-_&<&'archtype'&>
2090 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2091 &_OS/Makefile-Base_&
2092 .endd
2093 .cindex "&_Local/Makefile_&"
2094 .cindex "building Exim" "operating system type"
2095 .cindex "building Exim" "architecture type"
2096 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2097 architecture type. &_Local/Makefile_& is required to exist, and the building
2098 process fails if it is absent. The other three &_Local_& files are optional,
2099 and are often not needed.
2100
2101 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2102 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2103 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2104 values are used, thereby providing a means of forcing particular settings.
2105 Otherwise, the scripts try to get values from the &%uname%& command. If this
2106 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2107 of &'ad hoc'& transformations are then applied, to produce the standard names
2108 that Exim expects. You can run these scripts directly from the shell in order
2109 to find out what values are being used on your system.
2110
2111
2112 &_OS/Makefile-Default_& contains comments about the variables that are set
2113 therein. Some (but not all) are mentioned below. If there is something that
2114 needs changing, review the contents of this file and the contents of the make
2115 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2116 default values are.
2117
2118
2119 .cindex "building Exim" "overriding default settings"
2120 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2121 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2122 need to change the original files. Instead, you should make the changes by
2123 putting the new values in an appropriate &_Local_& file. For example,
2124 .cindex "Tru64-Unix build-time settings"
2125 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2126 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2127 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2128 called with the option &%-std1%&, to make it recognize some of the features of
2129 Standard C that Exim uses. (Most other compilers recognize Standard C by
2130 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2131 containing the lines
2132 .code
2133 CC=cc
2134 CFLAGS=-std1
2135 .endd
2136 If you are compiling for just one operating system, it may be easier to put
2137 these lines directly into &_Local/Makefile_&.
2138
2139 Keeping all your local configuration settings separate from the distributed
2140 files makes it easy to transfer them to new versions of Exim simply by copying
2141 the contents of the &_Local_& directory.
2142
2143
2144 .cindex "NIS lookup type" "including support for"
2145 .cindex "NIS+ lookup type" "including support for"
2146 .cindex "LDAP" "including support for"
2147 .cindex "lookup" "inclusion in binary"
2148 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2149 lookup, but not all systems have these components installed, so the default is
2150 not to include the relevant code in the binary. All the different kinds of file
2151 and database lookup that Exim supports are implemented as separate code modules
2152 which are included only if the relevant compile-time options are set. In the
2153 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2154 .code
2155 LOOKUP_LDAP=yes
2156 LOOKUP_NIS=yes
2157 LOOKUP_NISPLUS=yes
2158 .endd
2159 and similar settings apply to the other lookup types. They are all listed in
2160 &_src/EDITME_&. In many cases the relevant include files and interface
2161 libraries need to be installed before compiling Exim.
2162 .cindex "cdb" "including support for"
2163 However, there are some optional lookup types (such as cdb) for which
2164 the code is entirely contained within Exim, and no external include
2165 files or libraries are required. When a lookup type is not included in the
2166 binary, attempts to configure Exim to use it cause run time configuration
2167 errors.
2168
2169 .cindex "pkg-config" "lookups"
2170 .cindex "pkg-config" "authenticators"
2171 Many systems now use a tool called &'pkg-config'& to encapsulate information
2172 about how to compile against a library; Exim has some initial support for
2173 being able to use pkg-config for lookups and authenticators.  For any given
2174 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2175 variable with the &`_PC`& suffix in the name and assign as the value the
2176 name of the package to be queried.  The results of querying via the
2177 &'pkg-config'& command will be added to the appropriate Makefile variables
2178 with &`+=`& directives, so your version of &'make'& will need to support that
2179 syntax.  For instance:
2180 .code
2181 LOOKUP_SQLITE=yes
2182 LOOKUP_SQLITE_PC=sqlite3
2183 AUTH_GSASL=yes
2184 AUTH_GSASL_PC=libgsasl
2185 AUTH_HEIMDAL_GSSAPI=yes
2186 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2187 .endd
2188
2189 .cindex "Perl" "including support for"
2190 Exim can be linked with an embedded Perl interpreter, allowing Perl
2191 subroutines to be called during string expansion. To enable this facility,
2192 .code
2193 EXIM_PERL=perl.o
2194 .endd
2195 must be defined in &_Local/Makefile_&. Details of this facility are given in
2196 chapter &<<CHAPperl>>&.
2197
2198 .cindex "X11 libraries, location of"
2199 The location of the X11 libraries is something that varies a lot between
2200 operating systems, and there may be different versions of X11 to cope
2201 with. Exim itself makes no use of X11, but if you are compiling the Exim
2202 monitor, the X11 libraries must be available.
2203 The following three variables are set in &_OS/Makefile-Default_&:
2204 .code
2205 X11=/usr/X11R6
2206 XINCLUDE=-I$(X11)/include
2207 XLFLAGS=-L$(X11)/lib
2208 .endd
2209 These are overridden in some of the operating-system configuration files. For
2210 example, in &_OS/Makefile-SunOS5_& there is
2211 .code
2212 X11=/usr/openwin
2213 XINCLUDE=-I$(X11)/include
2214 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2215 .endd
2216 If you need to override the default setting for your operating system, place a
2217 definition of all three of these variables into your
2218 &_Local/Makefile-<ostype>_& file.
2219
2220 .cindex "EXTRALIBS"
2221 If you need to add any extra libraries to the link steps, these can be put in a
2222 variable called EXTRALIBS, which appears in all the link commands, but by
2223 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2224 command for linking the main Exim binary, and not for any associated utilities.
2225
2226 .cindex "DBM libraries" "configuration for building"
2227 There is also DBMLIB, which appears in the link commands for binaries that
2228 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2229 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2230 binary, and which can be used, for example, to include additional X11
2231 libraries.
2232
2233 .cindex "configuration file" "editing"
2234 The make file copes with rebuilding Exim correctly if any of the configuration
2235 files are edited. However, if an optional configuration file is deleted, it is
2236 necessary to touch the associated non-optional file (that is,
2237 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2238
2239
2240 .section "OS-specific header files" "SECID30"
2241 .cindex "&_os.h_&"
2242 .cindex "building Exim" "OS-specific C header files"
2243 The &_OS_& directory contains a number of files with names of the form
2244 &_os.h-<ostype>_&. These are system-specific C header files that should not
2245 normally need to be changed. There is a list of macro settings that are
2246 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2247 are porting Exim to a new operating system.
2248
2249
2250
2251 .section "Overriding build-time options for the monitor" "SECID31"
2252 .cindex "building Eximon"
2253 A similar process is used for overriding things when building the Exim monitor,
2254 where the files that are involved are
2255 .display
2256 &_OS/eximon.conf-Default_&
2257 &_OS/eximon.conf-_&<&'ostype'&>
2258 &_Local/eximon.conf_&
2259 &_Local/eximon.conf-_&<&'ostype'&>
2260 &_Local/eximon.conf-_&<&'archtype'&>
2261 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2262 .endd
2263 .cindex "&_Local/eximon.conf_&"
2264 As with Exim itself, the final three files need not exist, and in this case the
2265 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2266 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2267 variables of the same name, preceded by EXIMON_. For example, setting
2268 EXIMON_LOG_DEPTH in the environment overrides the value of
2269 LOG_DEPTH at run time.
2270 .ecindex IIDbuex
2271
2272
2273 .section "Installing Exim binaries and scripts" "SECID32"
2274 .cindex "installing Exim"
2275 .cindex "BIN_DIRECTORY"
2276 The command &`make install`& runs the &(exim_install)& script with no
2277 arguments. The script copies binaries and utility scripts into the directory
2278 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2279 .cindex "setuid" "installing Exim with"
2280 The install script copies files only if they are newer than the files they are
2281 going to replace. The Exim binary is required to be owned by root and have the
2282 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2283 install`& as root so that it can set up the Exim binary in this way. However, in
2284 some special situations (for example, if a host is doing no local deliveries)
2285 it may be possible to run Exim without making the binary setuid root (see
2286 chapter &<<CHAPsecurity>>& for details).
2287
2288 .cindex "CONFIGURE_FILE"
2289 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2290 in &_Local/Makefile_&. If this names a single file, and the file does not
2291 exist, the default configuration file &_src/configure.default_& is copied there
2292 by the installation script. If a run time configuration file already exists, it
2293 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2294 alternative files, no default is installed.
2295
2296 .cindex "system aliases file"
2297 .cindex "&_/etc/aliases_&"
2298 One change is made to the default configuration file when it is installed: the
2299 default configuration contains a router that references a system aliases file.
2300 The path to this file is set to the value specified by
2301 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2302 If the system aliases file does not exist, the installation script creates it,
2303 and outputs a comment to the user.
2304
2305 The created file contains no aliases, but it does contain comments about the
2306 aliases a site should normally have. Mail aliases have traditionally been
2307 kept in &_/etc/aliases_&. However, some operating systems are now using
2308 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2309 Exim's configuration if necessary.
2310
2311 The default configuration uses the local host's name as the only local domain,
2312 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2313 running as the local user. System aliases and &_.forward_& files in users' home
2314 directories are supported, but no NIS or NIS+ support is configured. Domains
2315 other than the name of the local host are routed using the DNS, with delivery
2316 over SMTP.
2317
2318 It is possible to install Exim for special purposes (such as building a binary
2319 distribution) in a private part of the file system. You can do this by a
2320 command such as
2321 .code
2322 make DESTDIR=/some/directory/ install
2323 .endd
2324 This has the effect of pre-pending the specified directory to all the file
2325 paths, except the name of the system aliases file that appears in the default
2326 configuration. (If a default alias file is created, its name &'is'& modified.)
2327 For backwards compatibility, ROOT is used if DESTDIR is not set,
2328 but this usage is deprecated.
2329
2330 .cindex "installing Exim" "what is not installed"
2331 Running &'make install'& does not copy the Exim 4 conversion script
2332 &'convert4r4'&. You will probably run this only once if you are
2333 upgrading from Exim 3. None of the documentation files in the &_doc_&
2334 directory are copied, except for the info files when you have set
2335 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2336
2337 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2338 to their names. The Exim binary itself, however, is handled differently. It is
2339 installed under a name that includes the version number and the compile number,
2340 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2341 called &_exim_& to point to the binary. If you are updating a previous version
2342 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2343 from the directory (as seen by other processes).
2344
2345 .cindex "installing Exim" "testing the script"
2346 If you want to see what the &'make install'& will do before running it for
2347 real, you can pass the &%-n%& option to the installation script by this
2348 command:
2349 .code
2350 make INSTALL_ARG=-n install
2351 .endd
2352 The contents of the variable INSTALL_ARG are passed to the installation
2353 script. You do not need to be root to run this test. Alternatively, you can run
2354 the installation script directly, but this must be from within the build
2355 directory. For example, from the top-level Exim directory you could use this
2356 command:
2357 .code
2358 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2359 .endd
2360 .cindex "installing Exim" "install script options"
2361 There are two other options that can be supplied to the installation script.
2362
2363 .ilist
2364 &%-no_chown%& bypasses the call to change the owner of the installed binary
2365 to root, and the call to make it a setuid binary.
2366 .next
2367 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2368 installed binary.
2369 .endlist
2370
2371 INSTALL_ARG can be used to pass these options to the script. For example:
2372 .code
2373 make INSTALL_ARG=-no_symlink install
2374 .endd
2375 The installation script can also be given arguments specifying which files are
2376 to be copied. For example, to install just the Exim binary, and nothing else,
2377 without creating the symbolic link, you could use:
2378 .code
2379 make INSTALL_ARG='-no_symlink exim' install
2380 .endd
2381
2382
2383
2384 .section "Installing info documentation" "SECTinsinfdoc"
2385 .cindex "installing Exim" "&'info'& documentation"
2386 Not all systems use the GNU &'info'& system for documentation, and for this
2387 reason, the Texinfo source of Exim's documentation is not included in the main
2388 distribution. Instead it is available separately from the ftp site (see section
2389 &<<SECTavail>>&).
2390
2391 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2392 source of the documentation is found in the source tree, running &`make
2393 install`& automatically builds the info files and installs them.
2394
2395
2396
2397 .section "Setting up the spool directory" "SECID33"
2398 .cindex "spool directory" "creating"
2399 When it starts up, Exim tries to create its spool directory if it does not
2400 exist. The Exim uid and gid are used for the owner and group of the spool
2401 directory. Sub-directories are automatically created in the spool directory as
2402 necessary.
2403
2404
2405
2406
2407 .section "Testing" "SECID34"
2408 .cindex "testing" "installation"
2409 Having installed Exim, you can check that the run time configuration file is
2410 syntactically valid by running the following command, which assumes that the
2411 Exim binary directory is within your PATH environment variable:
2412 .code
2413 exim -bV
2414 .endd
2415 If there are any errors in the configuration file, Exim outputs error messages.
2416 Otherwise it outputs the version number and build date,
2417 the DBM library that is being used, and information about which drivers and
2418 other optional code modules are included in the binary.
2419 Some simple routing tests can be done by using the address testing option. For
2420 example,
2421 .display
2422 &`exim -bt`& <&'local username'&>
2423 .endd
2424 should verify that it recognizes a local mailbox, and
2425 .display
2426 &`exim -bt`& <&'remote address'&>
2427 .endd
2428 a remote one. Then try getting it to deliver mail, both locally and remotely.
2429 This can be done by passing messages directly to Exim, without going through a
2430 user agent. For example:
2431 .code
2432 exim -v postmaster@your.domain.example
2433 From: user@your.domain.example
2434 To: postmaster@your.domain.example
2435 Subject: Testing Exim
2436
2437 This is a test message.
2438 ^D
2439 .endd
2440 The &%-v%& option causes Exim to output some verification of what it is doing.
2441 In this case you should see copies of three log lines, one for the message's
2442 arrival, one for its delivery, and one containing &"Completed"&.
2443
2444 .cindex "delivery" "problems with"
2445 If you encounter problems, look at Exim's log files (&'mainlog'& and
2446 &'paniclog'&) to see if there is any relevant information there. Another source
2447 of information is running Exim with debugging turned on, by specifying the
2448 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2449 with debugging turned on by a command of the form
2450 .display
2451 &`exim -d -M`& <&'exim-message-id'&>
2452 .endd
2453 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2454 produces rather a lot of output, but you can cut this down to specific areas.
2455 For example, if you use &%-d-all+route%& only the debugging information
2456 relevant to routing is included. (See the &%-d%& option in chapter
2457 &<<CHAPcommandline>>& for more details.)
2458
2459 .cindex '&"sticky"& bit'
2460 .cindex "lock files"
2461 One specific problem that has shown up on some sites is the inability to do
2462 local deliveries into a shared mailbox directory, because it does not have the
2463 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2464 writing to a mailbox file, and if it cannot create the lock file, the delivery
2465 is deferred. You can get round this either by setting the &"sticky bit"& on the
2466 directory, or by setting a specific group for local deliveries and allowing
2467 that group to create files in the directory (see the comments above the
2468 &(local_delivery)& transport in the default configuration file). Another
2469 approach is to configure Exim not to use lock files, but just to rely on
2470 &[fcntl()]& locking instead. However, you should do this only if all user
2471 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2472 see chapter &<<CHAPappendfile>>&.
2473
2474 One thing that cannot be tested on a system that is already running an MTA is
2475 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2476 &%-oX%& option can be used to run an Exim daemon that listens on some other
2477 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2478 &'exim_checkaccess'& utility can be used to check out policy controls on
2479 incoming SMTP mail.
2480
2481 Testing a new version on a system that is already running Exim can most easily
2482 be done by building a binary with a different CONFIGURE_FILE setting. From
2483 within the run time configuration, all other file and directory names
2484 that Exim uses can be altered, in order to keep it entirely clear of the
2485 production version.
2486
2487
2488 .section "Replacing another MTA with Exim" "SECID35"
2489 .cindex "replacing another MTA"
2490 Building and installing Exim for the first time does not of itself put it in
2491 general use. The name by which the system's MTA is called by mail user agents
2492 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2493 operating system), and it is necessary to make this name point to the &'exim'&
2494 binary in order to get the user agents to pass messages to Exim. This is
2495 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2496 or &_/usr/lib/sendmail_&
2497 .cindex "symbolic link" "to &'exim'& binary"
2498 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2499 privilege and executable status from the old MTA. It is then necessary to stop
2500 and restart the mailer daemon, if one is running.
2501
2502 .cindex "FreeBSD, MTA indirection"
2503 .cindex "&_/etc/mail/mailer.conf_&"
2504 Some operating systems have introduced alternative ways of switching MTAs. For
2505 example, if you are running FreeBSD, you need to edit the file
2506 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2507 described. A typical example of the contents of this file for running Exim is
2508 as follows:
2509 .code
2510 sendmail            /usr/exim/bin/exim
2511 send-mail           /usr/exim/bin/exim
2512 mailq               /usr/exim/bin/exim -bp
2513 newaliases          /usr/bin/true
2514 .endd
2515 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2516 your Exim installation is &"live"&. Check it by sending a message from your
2517 favourite user agent.
2518
2519 You should consider what to tell your users about the change of MTA. Exim may
2520 have different capabilities to what was previously running, and there are
2521 various operational differences such as the text of messages produced by
2522 command line options and in bounce messages. If you allow your users to make
2523 use of Exim's filtering capabilities, you should make the document entitled
2524 &'Exim's interface to mail filtering'& available to them.
2525
2526
2527
2528 .section "Upgrading Exim" "SECID36"
2529 .cindex "upgrading Exim"
2530 If you are already running Exim on your host, building and installing a new
2531 version automatically makes it available to MUAs, or any other programs that
2532 call the MTA directly. However, if you are running an Exim daemon, you do need
2533 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2534 new binary. You do not need to stop processing mail in order to install a new
2535 version of Exim. The install script does not modify an existing runtime
2536 configuration file.
2537
2538
2539
2540
2541 .section "Stopping the Exim daemon on Solaris" "SECID37"
2542 .cindex "Solaris" "stopping Exim on"
2543 The standard command for stopping the mailer daemon on Solaris is
2544 .code
2545 /etc/init.d/sendmail stop
2546 .endd
2547 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2548 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2549 for the text &"sendmail"&; this is not present because the actual program name
2550 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2551 solution is to replace the line that finds the process id with something like
2552 .code
2553 pid=`cat /var/spool/exim/exim-daemon.pid`
2554 .endd
2555 to obtain the daemon's pid directly from the file that Exim saves it in.
2556
2557 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2558 still be received from local processes, and if automatic delivery is configured
2559 (the normal case), deliveries will still occur.
2560
2561
2562
2563
2564 . ////////////////////////////////////////////////////////////////////////////
2565 . ////////////////////////////////////////////////////////////////////////////
2566
2567 .chapter "The Exim command line" "CHAPcommandline"
2568 .scindex IIDclo1 "command line" "options"
2569 .scindex IIDclo2 "options" "command line"
2570 Exim's command line takes the standard Unix form of a sequence of options,
2571 each starting with a hyphen character, followed by a number of arguments. The
2572 options are compatible with the main options of Sendmail, and there are also
2573 some additional options, some of which are compatible with Smail 3. Certain
2574 combinations of options do not make sense, and provoke an error if used.
2575 The form of the arguments depends on which options are set.
2576
2577
2578 .section "Setting options by program name" "SECID38"
2579 .cindex "&'mailq'&"
2580 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2581 were present before any other options.
2582 The &%-bp%& option requests a listing of the contents of the mail queue on the
2583 standard output.
2584 This feature is for compatibility with some systems that contain a command of
2585 that name in one of the standard libraries, symbolically linked to
2586 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2587
2588 .cindex "&'rsmtp'&"
2589 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2590 were present before any other options, for compatibility with Smail. The
2591 &%-bS%& option is used for reading in a number of messages in batched SMTP
2592 format.
2593
2594 .cindex "&'rmail'&"
2595 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2596 &%-oee%& options were present before any other options, for compatibility with
2597 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2598
2599 .cindex "&'runq'&"
2600 .cindex "queue runner"
2601 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2602 were present before any other options, for compatibility with Smail. The &%-q%&
2603 option causes a single queue runner process to be started.
2604
2605 .cindex "&'newaliases'&"
2606 .cindex "alias file" "building"
2607 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2608 If Exim is called under the name &'newaliases'& it behaves as if the option
2609 &%-bi%& were present before any other options, for compatibility with Sendmail.
2610 This option is used for rebuilding Sendmail's alias file. Exim does not have
2611 the concept of a single alias file, but can be configured to run a given
2612 command if called with the &%-bi%& option.
2613
2614
2615 .section "Trusted and admin users" "SECTtrustedadmin"
2616 Some Exim options are available only to &'trusted users'& and others are
2617 available only to &'admin users'&. In the description below, the phrases &"Exim
2618 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2619 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2620 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2621
2622 .ilist
2623 .cindex "trusted users" "definition of"
2624 .cindex "user" "trusted definition of"
2625 The trusted users are root, the Exim user, any user listed in the
2626 &%trusted_users%& configuration option, and any user whose current group or any
2627 supplementary group is one of those listed in the &%trusted_groups%&
2628 configuration option. Note that the Exim group is not automatically trusted.
2629
2630 .cindex '&"From"& line'
2631 .cindex "envelope sender"
2632 Trusted users are always permitted to use the &%-f%& option or a leading
2633 &"From&~"& line to specify the envelope sender of a message that is passed to
2634 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2635 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2636 users to set envelope senders.
2637
2638 .cindex "&'From:'& header line"
2639 .cindex "&'Sender:'& header line"
2640 .cindex "header lines" "From:"
2641 .cindex "header lines" "Sender:"
2642 For a trusted user, there is never any check on the contents of the &'From:'&
2643 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2644 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2645
2646 Trusted users may also specify a host name, host address, interface address,
2647 protocol name, ident value, and authentication data when submitting a message
2648 locally. Thus, they are able to insert messages into Exim's queue locally that
2649 have the characteristics of messages received from a remote host. Untrusted
2650 users may in some circumstances use &%-f%&, but can never set the other values
2651 that are available to trusted users.
2652 .next
2653 .cindex "user" "admin definition of"
2654 .cindex "admin user" "definition of"
2655 The admin users are root, the Exim user, and any user that is a member of the
2656 Exim group or of any group listed in the &%admin_groups%& configuration option.
2657 The current group does not have to be one of these groups.
2658
2659 Admin users are permitted to list the queue, and to carry out certain
2660 operations on messages, for example, to force delivery failures. It is also
2661 necessary to be an admin user in order to see the full information provided by
2662 the Exim monitor, and full debugging output.
2663
2664 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2665 Exim to attempt delivery of messages on its queue is restricted to admin users.
2666 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2667 option false (that is, specifying &%no_prod_requires_admin%&).
2668
2669 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2670 is restricted to admin users unless &%queue_list_requires_admin%& is set
2671 false.
2672 .endlist
2673
2674
2675 &*Warning*&: If you configure your system so that admin users are able to
2676 edit Exim's configuration file, you are giving those users an easy way of
2677 getting root. There is further discussion of this issue at the start of chapter
2678 &<<CHAPconf>>&.
2679
2680
2681
2682
2683 .section "Command line options" "SECID39"
2684 Exim's command line options are described in alphabetical order below. If none
2685 of the options that specifies a specific action (such as starting the daemon or
2686 a queue runner, or testing an address, or receiving a message in a specific
2687 format, or listing the queue) are present, and there is at least one argument
2688 on the command line, &%-bm%& (accept a local message on the standard input,
2689 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2690 outputs a brief message about itself and exits.
2691
2692 . ////////////////////////////////////////////////////////////////////////////
2693 . Insert a stylized XML comment here, to identify the start of the command line
2694 . options. This is for the benefit of the Perl script that automatically
2695 . creates a man page for the options.
2696 . ////////////////////////////////////////////////////////////////////////////
2697
2698 .literal xml
2699 <!-- === Start of command line options === -->
2700 .literal off
2701
2702
2703 .vlist
2704 .vitem &%--%&
2705 .oindex "--"
2706 .cindex "options" "command line; terminating"
2707 This is a pseudo-option whose only purpose is to terminate the options and
2708 therefore to cause subsequent command line items to be treated as arguments
2709 rather than options, even if they begin with hyphens.
2710
2711 .vitem &%--help%&
2712 .oindex "&%--help%&"
2713 This option causes Exim to output a few sentences stating what it is.
2714 The same output is generated if the Exim binary is called with no options and
2715 no arguments.
2716
2717 .vitem &%--version%&
2718 .oindex "&%--version%&"
2719 This option is an alias for &%-bV%& and causes version information to be
2720 displayed.
2721
2722 .vitem &%-Ac%& &&&
2723        &%-Am%&
2724 .oindex "&%-Ac%&"
2725 .oindex "&%-Am%&"
2726 These options are used by Sendmail for selecting configuration files and are
2727 ignored by Exim.
2728
2729 .vitem &%-B%&<&'type'&>
2730 .oindex "&%-B%&"
2731 .cindex "8-bit characters"
2732 .cindex "Sendmail compatibility" "8-bit characters"
2733 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2734 clean; it ignores this option.
2735
2736 .vitem &%-bd%&
2737 .oindex "&%-bd%&"
2738 .cindex "daemon"
2739 .cindex "SMTP" "listener"
2740 .cindex "queue runner"
2741 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2742 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2743 that the daemon should also initiate periodic queue runs.
2744
2745 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2746 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2747 disconnect from the controlling terminal. When running this way, it can be
2748 stopped by pressing ctrl-C.
2749
2750 By default, Exim listens for incoming connections to the standard SMTP port on
2751 all the host's running interfaces. However, it is possible to listen on other
2752 ports, on multiple ports, and only on specific interfaces. Chapter
2753 &<<CHAPinterfaces>>& contains a description of the options that control this.
2754
2755 When a listening daemon
2756 .cindex "daemon" "process id (pid)"
2757 .cindex "pid (process id)" "of daemon"
2758 is started without the use of &%-oX%& (that is, without overriding the normal
2759 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2760 in Exim's spool directory. This location can be overridden by setting
2761 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2762 running as root.
2763
2764 When &%-oX%& is used on the command line to start a listening daemon, the
2765 process id is not written to the normal pid file path. However, &%-oP%& can be
2766 used to specify a path on the command line if a pid file is required.
2767
2768 The SIGHUP signal
2769 .cindex "SIGHUP"
2770 .cindex "daemon" "restarting"
2771 can be used to cause the daemon to re-execute itself. This should be done
2772 whenever Exim's configuration file, or any file that is incorporated into it by
2773 means of the &%.include%& facility, is changed, and also whenever a new version
2774 of Exim is installed. It is not necessary to do this when other files that are
2775 referenced from the configuration (for example, alias files) are changed,
2776 because these are reread each time they are used.
2777
2778 .vitem &%-bdf%&
2779 .oindex "&%-bdf%&"
2780 This option has the same effect as &%-bd%& except that it never disconnects
2781 from the controlling terminal, even when no debugging is specified.
2782
2783 .vitem &%-be%&
2784 .oindex "&%-be%&"
2785 .cindex "testing" "string expansion"
2786 .cindex "expansion" "testing"
2787 Run Exim in expansion testing mode. Exim discards its root privilege, to
2788 prevent ordinary users from using this mode to read otherwise inaccessible
2789 files. If no arguments are given, Exim runs interactively, prompting for lines
2790 of data. Otherwise, it processes each argument in turn.
2791
2792 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2793 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2794 used without command line arguments. If successful, it uses the &[readline()]&
2795 function, which provides extensive line-editing facilities, for reading the
2796 test data. A line history is supported.
2797
2798 Long expansion expressions can be split over several lines by using backslash
2799 continuations. As in Exim's run time configuration, white space at the start of
2800 continuation lines is ignored. Each argument or data line is passed through the
2801 string expansion mechanism, and the result is output. Variable values from the
2802 configuration file (for example, &$qualify_domain$&) are available, but no
2803 message-specific values (such as &$message_exim_id$&) are set, because no message
2804 is being processed (but see &%-bem%& and &%-Mset%&).
2805
2806 &*Note*&: If you use this mechanism to test lookups, and you change the data
2807 files or databases you are using, you must exit and restart Exim before trying
2808 the same lookup again. Otherwise, because each Exim process caches the results
2809 of lookups, you will just get the same result as before.
2810
2811 Macro processing is done on lines before string-expansion: new macros can be
2812 defined and macros will be expanded.
2813 Because macros in the config file are often used for secrets, those are only
2814 available to admin users.
2815
2816 .vitem &%-bem%&&~<&'filename'&>
2817 .oindex "&%-bem%&"
2818 .cindex "testing" "string expansion"
2819 .cindex "expansion" "testing"
2820 This option operates like &%-be%& except that it must be followed by the name
2821 of a file. For example:
2822 .code
2823 exim -bem /tmp/testmessage
2824 .endd
2825 The file is read as a message (as if receiving a locally-submitted non-SMTP
2826 message) before any of the test expansions are done. Thus, message-specific
2827 variables such as &$message_size$& and &$header_from:$& are available. However,
2828 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2829 recipients are read from the headers in the normal way, and are shown in the
2830 &$recipients$& variable. Note that recipients cannot be given on the command
2831 line, because further arguments are taken as strings to expand (just like
2832 &%-be%&).
2833
2834 .vitem &%-bF%&&~<&'filename'&>
2835 .oindex "&%-bF%&"
2836 .cindex "system filter" "testing"
2837 .cindex "testing" "system filter"
2838 This option is the same as &%-bf%& except that it assumes that the filter being
2839 tested is a system filter. The additional commands that are available only in
2840 system filters are recognized.
2841
2842 .vitem &%-bf%&&~<&'filename'&>
2843 .oindex "&%-bf%&"
2844 .cindex "filter" "testing"
2845 .cindex "testing" "filter file"
2846 .cindex "forward file" "testing"
2847 .cindex "testing" "forward file"
2848 .cindex "Sieve filter" "testing"
2849 This option runs Exim in user filter testing mode; the file is the filter file
2850 to be tested, and a test message must be supplied on the standard input. If
2851 there are no message-dependent tests in the filter, an empty file can be
2852 supplied.
2853
2854 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2855 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2856 filter and a user filter in the same run. For example:
2857 .code
2858 exim -bF /system/filter -bf /user/filter </test/message
2859 .endd
2860 This is helpful when the system filter adds header lines or sets filter
2861 variables that are used by the user filter.
2862
2863 If the test filter file does not begin with one of the special lines
2864 .code
2865 # Exim filter
2866 # Sieve filter
2867 .endd
2868 it is taken to be a normal &_.forward_& file, and is tested for validity under
2869 that interpretation. See sections &<<SECTitenonfilred>>& to
2870 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2871 redirection lists.
2872
2873 The result of an Exim command that uses &%-bf%&, provided no errors are
2874 detected, is a list of the actions that Exim would try to take if presented
2875 with the message for real. More details of filter testing are given in the
2876 separate document entitled &'Exim's interfaces to mail filtering'&.
2877
2878 When testing a filter file,
2879 .cindex "&""From""& line"
2880 .cindex "envelope sender"
2881 .oindex "&%-f%&" "for filter testing"
2882 the envelope sender can be set by the &%-f%& option,
2883 or by a &"From&~"& line at the start of the test message. Various parameters
2884 that would normally be taken from the envelope recipient address of the message
2885 can be set by means of additional command line options (see the next four
2886 options).
2887
2888 .vitem &%-bfd%&&~<&'domain'&>
2889 .oindex "&%-bfd%&"
2890 .vindex "&$qualify_domain$&"
2891 This sets the domain of the recipient address when a filter file is being
2892 tested by means of the &%-bf%& option. The default is the value of
2893 &$qualify_domain$&.
2894
2895 .vitem &%-bfl%&&~<&'local&~part'&>
2896 .oindex "&%-bfl%&"
2897 This sets the local part of the recipient address when a filter file is being
2898 tested by means of the &%-bf%& option. The default is the username of the
2899 process that calls Exim. A local part should be specified with any prefix or
2900 suffix stripped, because that is how it appears to the filter when a message is
2901 actually being delivered.
2902
2903 .vitem &%-bfp%&&~<&'prefix'&>
2904 .oindex "&%-bfp%&"
2905 .cindex affix "filter testing"
2906 This sets the prefix of the local part of the recipient address when a filter
2907 file is being tested by means of the &%-bf%& option. The default is an empty
2908 prefix.
2909
2910 .vitem &%-bfs%&&~<&'suffix'&>
2911 .oindex "&%-bfs%&"
2912 .cindex affix "filter testing"
2913 This sets the suffix of the local part of the recipient address when a filter
2914 file is being tested by means of the &%-bf%& option. The default is an empty
2915 suffix.
2916
2917 .vitem &%-bh%&&~<&'IP&~address'&>
2918 .oindex "&%-bh%&"
2919 .cindex "testing" "incoming SMTP"
2920 .cindex "SMTP" "testing incoming"
2921 .cindex "testing" "relay control"
2922 .cindex "relaying" "testing configuration"
2923 .cindex "policy control" "testing"
2924 .cindex "debugging" "&%-bh%& option"
2925 This option runs a fake SMTP session as if from the given IP address, using the
2926 standard input and output. The IP address may include a port number at the end,
2927 after a full stop. For example:
2928 .code
2929 exim -bh 10.9.8.7.1234
2930 exim -bh fe80::a00:20ff:fe86:a061.5678
2931 .endd
2932 When an IPv6 address is given, it is converted into canonical form. In the case
2933 of the second example above, the value of &$sender_host_address$& after
2934 conversion to the canonical form is
2935 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2936
2937 Comments as to what is going on are written to the standard error file. These
2938 include lines beginning with &"LOG"& for anything that would have been logged.
2939 This facility is provided for testing configuration options for incoming
2940 messages, to make sure they implement the required policy. For example, you can
2941 test your relay controls using &%-bh%&.
2942
2943 &*Warning 1*&:
2944 .cindex "RFC 1413"
2945 You can test features of the configuration that rely on ident (RFC 1413)
2946 information by using the &%-oMt%& option. However, Exim cannot actually perform
2947 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2948 connection.
2949
2950 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2951 are also skipped when testing using &%-bh%&. If you want these callouts to
2952 occur, use &%-bhc%& instead.
2953
2954 Messages supplied during the testing session are discarded, and nothing is
2955 written to any of the real log files. There may be pauses when DNS (and other)
2956 lookups are taking place, and of course these may time out. The &%-oMi%& option
2957 can be used to specify a specific IP interface and port if this is important,
2958 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2959 session were authenticated.
2960
2961 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2962 output just states whether a given recipient address from a given host is
2963 acceptable or not. See section &<<SECTcheckaccess>>&.
2964
2965 Features such as authentication and encryption, where the client input is not
2966 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2967 specialized SMTP test program such as
2968 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2969
2970 .vitem &%-bhc%&&~<&'IP&~address'&>
2971 .oindex "&%-bhc%&"
2972 This option operates in the same way as &%-bh%&, except that address
2973 verification callouts are performed if required. This includes consulting and
2974 updating the callout cache database.
2975
2976 .vitem &%-bi%&
2977 .oindex "&%-bi%&"
2978 .cindex "alias file" "building"
2979 .cindex "building alias file"
2980 .cindex "Sendmail compatibility" "&%-bi%& option"
2981 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2982 Exim does not have the concept of a single alias file, and so it cannot mimic
2983 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2984 tend to appear in various scripts such as NIS make files, so the option must be
2985 recognized.
2986
2987 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2988 configuration option is run, under the uid and gid of the caller of Exim. If
2989 the &%-oA%& option is used, its value is passed to the command as an argument.
2990 The command set by &%bi_command%& may not contain arguments. The command can
2991 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2992 if this is required. If the &%bi_command%& option is not set, calling Exim with
2993 &%-bi%& is a no-op.
2994
2995 . // Keep :help first, then the rest in alphabetical order
2996 .vitem &%-bI:help%&
2997 .oindex "&%-bI:help%&"
2998 .cindex "querying exim information"
2999 We shall provide various options starting &`-bI:`& for querying Exim for
3000 information.  The output of many of these will be intended for machine
3001 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3002 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3003 options shall cause Exim to exit after producing the requested output.
3004
3005 .vitem &%-bI:dscp%&
3006 .oindex "&%-bI:dscp%&"
3007 .cindex "DSCP" "values"
3008 This option causes Exim to emit an alphabetically sorted list of all
3009 recognised DSCP names.
3010
3011 .vitem &%-bI:sieve%&
3012 .oindex "&%-bI:sieve%&"
3013 .cindex "Sieve filter" "capabilities"
3014 This option causes Exim to emit an alphabetically sorted list of all supported
3015 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3016 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3017 &`SIEVE`& capability response line.  As the precise list may depend upon
3018 compile-time build options, which this option will adapt to, this is the only
3019 way to guarantee a correct response.
3020
3021 .vitem &%-bm%&
3022 .oindex "&%-bm%&"
3023 .cindex "local message reception"
3024 This option runs an Exim receiving process that accepts an incoming,
3025 locally-generated message on the standard input. The recipients are given as the
3026 command arguments (except when &%-t%& is also present &-- see below). Each
3027 argument can be a comma-separated list of RFC 2822 addresses. This is the
3028 default option for selecting the overall action of an Exim call; it is assumed
3029 if no other conflicting option is present.
3030
3031 If any addresses in the message are unqualified (have no domain), they are
3032 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3033 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3034 suppressing this for special cases.
3035
3036 Policy checks on the contents of local messages can be enforced by means of
3037 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3038
3039 .cindex "return code" "for &%-bm%&"
3040 The return code is zero if the message is successfully accepted. Otherwise, the
3041 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3042
3043 The format
3044 .cindex "message" "format"
3045 .cindex "format" "message"
3046 .cindex "&""From""& line"
3047 .cindex "UUCP" "&""From""& line"
3048 .cindex "Sendmail compatibility" "&""From""& line"
3049 of the message must be as defined in RFC 2822, except that, for
3050 compatibility with Sendmail and Smail, a line in one of the forms
3051 .code
3052 From sender Fri Jan  5 12:55 GMT 1997
3053 From sender Fri, 5 Jan 97 12:55:01
3054 .endd
3055 (with the weekday optional, and possibly with additional text after the date)
3056 is permitted to appear at the start of the message. There appears to be no
3057 authoritative specification of the format of this line. Exim recognizes it by
3058 matching against the regular expression defined by the &%uucp_from_pattern%&
3059 option, which can be changed if necessary.
3060
3061 .oindex "&%-f%&" "overriding &""From""& line"
3062 The specified sender is treated as if it were given as the argument to the
3063 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3064 preference to the address taken from the message. The caller of Exim must be a
3065 trusted user for the sender of a message to be set in this way.
3066
3067 .vitem &%-bmalware%&&~<&'filename'&>
3068 .oindex "&%-bmalware%&"
3069 .cindex "testing", "malware"
3070 .cindex "malware scan test"
3071 This debugging option causes Exim to scan the given file or directory
3072 (depending on the used scanner interface),
3073 using the malware scanning framework.  The option of &%av_scanner%& influences
3074 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3075 the expansion should have defaults which apply to this invocation.  ACLs are
3076 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3077 will never be populated and &%-bmalware%& will fail.
3078
3079 Exim will have changed working directory before resolving the filename, so
3080 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3081 user when it tries to open the file, rather than as the invoking user.
3082 This option requires admin privileges.
3083
3084 The &%-bmalware%& option will not be extended to be more generally useful,
3085 there are better tools for file-scanning.  This option exists to help
3086 administrators verify their Exim and AV scanner configuration.
3087
3088 .vitem &%-bnq%&
3089 .oindex "&%-bnq%&"
3090 .cindex "address qualification, suppressing"
3091 By default, Exim automatically qualifies unqualified addresses (those
3092 without domains) that appear in messages that are submitted locally (that
3093 is, not over TCP/IP). This qualification applies both to addresses in
3094 envelopes, and addresses in header lines. Sender addresses are qualified using
3095 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3096 defaults to the value of &%qualify_domain%&).
3097
3098 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3099 being used to re-submit messages that originally came from remote hosts after
3100 content scanning, you probably do not want to qualify unqualified addresses in
3101 header lines. (Such lines will be present only if you have not enabled a header
3102 syntax check in the appropriate ACL.)
3103
3104 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3105 messages that originate on the local host. When this is used, unqualified
3106 addresses in the envelope provoke errors (causing message rejection) and
3107 unqualified addresses in header lines are left alone.
3108
3109
3110 .vitem &%-bP%&
3111 .oindex "&%-bP%&"
3112 .cindex "configuration options" "extracting"
3113 .cindex "options" "configuration &-- extracting"
3114 If this option is given with no arguments, it causes the values of all Exim's
3115 main configuration options to be written to the standard output. The values
3116 of one or more specific options can be requested by giving their names as
3117 arguments, for example:
3118 .code
3119 exim -bP qualify_domain hold_domains
3120 .endd
3121 .cindex "hiding configuration option values"
3122 .cindex "configuration options" "hiding value of"
3123 .cindex "options" "hiding value of"
3124 However, any option setting that is preceded by the word &"hide"& in the
3125 configuration file is not shown in full, except to an admin user. For other
3126 users, the output is as in this example:
3127 .code
3128 mysql_servers = <value not displayable>
3129 .endd
3130 If &%config%& is given as an argument, the config is
3131 output, as it was parsed, any include file resolved, any comment removed.
3132
3133 If &%config_file%& is given as an argument, the name of the run time
3134 configuration file is output. (&%configure_file%& works too, for
3135 backward compatibility.)
3136 If a list of configuration files was supplied, the value that is output here
3137 is the name of the file that was actually used.
3138
3139 .cindex "options" "hiding name of"
3140 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3141 name will not be output.
3142
3143 .cindex "daemon" "process id (pid)"
3144 .cindex "pid (process id)" "of daemon"
3145 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3146 directories where log files and daemon pid files are written are output,
3147 respectively. If these values are unset, log files are written in a
3148 sub-directory of the spool directory called &%log%&, and the pid file is
3149 written directly into the spool directory.
3150
3151 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3152 .code
3153 exim -bP +local_domains
3154 .endd
3155 it searches for a matching named list of any type (domain, host, address, or
3156 local part) and outputs what it finds.
3157
3158 .cindex "options" "router &-- extracting"
3159 .cindex "options" "transport &-- extracting"
3160 .cindex "options" "authenticator &-- extracting"
3161 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3162 followed by the name of an appropriate driver instance, the option settings for
3163 that driver are output. For example:
3164 .code
3165 exim -bP transport local_delivery
3166 .endd
3167 The generic driver options are output first, followed by the driver's private
3168 options. A list of the names of drivers of a particular type can be obtained by
3169 using one of the words &%router_list%&, &%transport_list%&, or
3170 &%authenticator_list%&, and a complete list of all drivers with their option
3171 settings can be obtained by using &%routers%&, &%transports%&, or
3172 &%authenticators%&.
3173
3174 .cindex "environment"
3175 If &%environment%& is given as an argument, the set of environment
3176 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3177 variables.
3178
3179 .cindex "options" "macro &-- extracting"
3180 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3181 are available, similarly to the drivers.  Because macros are sometimes used
3182 for storing passwords, this option is restricted.
3183 The output format is one item per line.
3184 For the "-bP macro <name>" form, if no such macro is found
3185 the exit status will be nonzero.
3186
3187 .vitem &%-bp%&
3188 .oindex "&%-bp%&"
3189 .cindex "queue" "listing messages on"
3190 .cindex "listing" "messages on the queue"
3191 This option requests a listing of the contents of the mail queue on the
3192 standard output. If the &%-bp%& option is followed by a list of message ids,
3193 just those messages are listed. By default, this option can be used only by an
3194 admin user. However, the &%queue_list_requires_admin%& option can be set false
3195 to allow any user to see the queue.
3196
3197 Each message on the queue is displayed as in the following example:
3198 .code
3199 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3200           red.king@looking-glass.fict.example
3201           <other addresses>
3202 .endd
3203 .cindex "message" "size in queue listing"
3204 .cindex "size" "of message"
3205 The first line contains the length of time the message has been on the queue
3206 (in this case 25 minutes), the size of the message (2.9K), the unique local
3207 identifier for the message, and the message sender, as contained in the
3208 envelope. For bounce messages, the sender address is empty, and appears as
3209 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3210 the default sender address, the user's login name is shown in parentheses
3211 before the sender address.
3212
3213 .cindex "frozen messages" "in queue listing"
3214 If the message is frozen (attempts to deliver it are suspended) then the text
3215 &"*** frozen ***"& is displayed at the end of this line.
3216
3217 The recipients of the message (taken from the envelope, not the headers) are
3218 displayed on subsequent lines. Those addresses to which the message has already
3219 been delivered are marked with the letter D. If an original address gets
3220 expanded into several addresses via an alias or forward file, the original is
3221 displayed with a D only when deliveries for all of its child addresses are
3222 complete.
3223
3224
3225 .vitem &%-bpa%&
3226 .oindex "&%-bpa%&"
3227 This option operates like &%-bp%&, but in addition it shows delivered addresses
3228 that were generated from the original top level address(es) in each message by
3229 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3230 of just &"D"&.
3231
3232
3233 .vitem &%-bpc%&
3234 .oindex "&%-bpc%&"
3235 .cindex "queue" "count of messages on"
3236 This option counts the number of messages on the queue, and writes the total
3237 to the standard output. It is restricted to admin users, unless
3238 &%queue_list_requires_admin%& is set false.
3239
3240
3241 .vitem &%-bpr%&
3242 .oindex "&%-bpr%&"
3243 This option operates like &%-bp%&, but the output is not sorted into
3244 chronological order of message arrival. This can speed it up when there are
3245 lots of messages on the queue, and is particularly useful if the output is
3246 going to be post-processed in a way that doesn't need the sorting.
3247
3248 .vitem &%-bpra%&
3249 .oindex "&%-bpra%&"
3250 This option is a combination of &%-bpr%& and &%-bpa%&.
3251
3252 .vitem &%-bpru%&
3253 .oindex "&%-bpru%&"
3254 This option is a combination of &%-bpr%& and &%-bpu%&.
3255
3256
3257 .vitem &%-bpu%&
3258 .oindex "&%-bpu%&"
3259 This option operates like &%-bp%& but shows only undelivered top-level
3260 addresses for each message displayed. Addresses generated by aliasing or
3261 forwarding are not shown, unless the message was deferred after processing by a
3262 router with the &%one_time%& option set.
3263
3264
3265 .vitem &%-brt%&
3266 .oindex "&%-brt%&"
3267 .cindex "testing" "retry configuration"
3268 .cindex "retry" "configuration testing"
3269 This option is for testing retry rules, and it must be followed by up to three
3270 arguments. It causes Exim to look for a retry rule that matches the values
3271 and to write it to the standard output. For example:
3272 .code
3273 exim -brt bach.comp.mus.example
3274 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3275 .endd
3276 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3277 argument, which is required, can be a complete address in the form
3278 &'local_part@domain'&, or it can be just a domain name. If the second argument
3279 contains a dot, it is interpreted as an optional second domain name; if no
3280 retry rule is found for the first argument, the second is tried. This ties in
3281 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3282 rule is found that matches the host, one that matches the mail domain is
3283 sought. Finally, an argument that is the name of a specific delivery error, as
3284 used in setting up retry rules, can be given. For example:
3285 .code
3286 exim -brt haydn.comp.mus.example quota_3d
3287 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3288 .endd
3289
3290 .vitem &%-brw%&
3291 .oindex "&%-brw%&"
3292 .cindex "testing" "rewriting"
3293 .cindex "rewriting" "testing"
3294 This option is for testing address rewriting rules, and it must be followed by
3295 a single argument, consisting of either a local part without a domain, or a
3296 complete address with a fully qualified domain. Exim outputs how this address
3297 would be rewritten for each possible place it might appear. See chapter
3298 &<<CHAPrewrite>>& for further details.
3299
3300 .vitem &%-bS%&
3301 .oindex "&%-bS%&"
3302 .cindex "SMTP" "batched incoming"
3303 .cindex "batched SMTP input"
3304 This option is used for batched SMTP input, which is an alternative interface
3305 for non-interactive local message submission. A number of messages can be
3306 submitted in a single run. However, despite its name, this is not really SMTP
3307 input. Exim reads each message's envelope from SMTP commands on the standard
3308 input, but generates no responses. If the caller is trusted, or
3309 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3310 believed; otherwise the sender is always the caller of Exim.
3311
3312 The message itself is read from the standard input, in SMTP format (leading
3313 dots doubled), terminated by a line containing just a single dot. An error is
3314 provoked if the terminating dot is missing. A further message may then follow.
3315
3316 As for other local message submissions, the contents of incoming batch SMTP
3317 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3318 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3319 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3320
3321 Some other SMTP commands are recognized in the input. HELO and EHLO act
3322 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3323 QUIT quits, ignoring the rest of the standard input.
3324
3325 .cindex "return code" "for &%-bS%&"
3326 If any error is encountered, reports are written to the standard output and
3327 error streams, and Exim gives up immediately. The return code is 0 if no error
3328 was detected; it is 1 if one or more messages were accepted before the error
3329 was detected; otherwise it is 2.
3330
3331 More details of input using batched SMTP are given in section
3332 &<<SECTincomingbatchedSMTP>>&.
3333
3334 .vitem &%-bs%&
3335 .oindex "&%-bs%&"
3336 .cindex "SMTP" "local input"
3337 .cindex "local SMTP input"
3338 This option causes Exim to accept one or more messages by reading SMTP commands
3339 on the standard input, and producing SMTP replies on the standard output. SMTP
3340 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3341 Some user agents use this interface as a way of passing locally-generated
3342 messages to the MTA.
3343
3344 In
3345 .cindex "sender" "source of"
3346 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3347 set, the senders of messages are taken from the SMTP MAIL commands.
3348 Otherwise the content of these commands is ignored and the sender is set up as
3349 the calling user. Unqualified addresses are automatically qualified using
3350 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3351 &%-bnq%& option is used.
3352
3353 .cindex "inetd"
3354 The
3355 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3356 using a listening daemon. Exim can distinguish the two cases by checking
3357 whether the standard input is a TCP/IP socket. When Exim is called from
3358 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3359 above concerning senders and qualification do not apply. In this situation,
3360 Exim behaves in exactly the same way as it does when receiving a message via
3361 the listening daemon.
3362
3363 .vitem &%-bt%&
3364 .oindex "&%-bt%&"
3365 .cindex "testing" "addresses"
3366 .cindex "address" "testing"
3367 This option runs Exim in address testing mode, in which each argument is taken
3368 as a recipient address to be tested for deliverability. The results are
3369 written to the standard output. If a test fails, and the caller is not an admin
3370 user, no details of the failure are output, because these might contain
3371 sensitive information such as usernames and passwords for database lookups.
3372
3373 If no arguments are given, Exim runs in an interactive manner, prompting with a
3374 right angle bracket for addresses to be tested.
3375
3376 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3377 &[readline()]& function, because it is running as &'root'& and there are
3378 security issues.
3379
3380 Each address is handled as if it were the recipient address of a message
3381 (compare the &%-bv%& option). It is passed to the routers and the result is
3382 written to the standard output. However, any router that has
3383 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3384 genuine routing tests if your first router passes everything to a scanner
3385 program.
3386
3387 .cindex "return code" "for &%-bt%&"
3388 The return code is 2 if any address failed outright; it is 1 if no address
3389 failed outright but at least one could not be resolved for some reason. Return
3390 code 0 is given only when all addresses succeed.
3391
3392 .cindex "duplicate addresses"
3393 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3394 addresses after routing is complete, so that only one delivery takes place.
3395 This does not happen when testing with &%-bt%&; the full results of routing are
3396 always shown.
3397
3398 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3399 routers in the configuration makes any tests on the sender address of a
3400 message,
3401 .oindex "&%-f%&" "for address testing"
3402 you can use the &%-f%& option to set an appropriate sender when running
3403 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3404 default qualifying domain. However, if you have set up (for example) routers
3405 whose behaviour depends on the contents of an incoming message, you cannot test
3406 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3407 doing such tests.
3408
3409 .vitem &%-bV%&
3410 .oindex "&%-bV%&"
3411 .cindex "version number of Exim"
3412 This option causes Exim to write the current version number, compilation
3413 number, and compilation date of the &'exim'& binary to the standard output.
3414 It also lists the DBM library that is being used, the optional modules (such as
3415 specific lookup types), the drivers that are included in the binary, and the
3416 name of the run time configuration file that is in use.
3417
3418 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3419 configuration file. However, this is a static check only. It cannot check
3420 values that are to be expanded. For example, although a misspelt ACL verb is
3421 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3422 alone to discover (for example) all the typos in the configuration; some
3423 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3424 dynamic testing facilities.
3425
3426 .vitem &%-bv%&
3427 .oindex "&%-bv%&"
3428 .cindex "verifying address" "using &%-bv%&"
3429 .cindex "address" "verification"
3430 This option runs Exim in address verification mode, in which each argument is
3431 taken as a recipient address to be verified by the routers. (This does
3432 not involve any verification callouts). During normal operation, verification
3433 happens mostly as a consequence processing a &%verify%& condition in an ACL
3434 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3435 including callouts, see the &%-bh%& and &%-bhc%& options.
3436
3437 If verification fails, and the caller is not an admin user, no details of the
3438 failure are output, because these might contain sensitive information such as
3439 usernames and passwords for database lookups.
3440
3441 If no arguments are given, Exim runs in an interactive manner, prompting with a
3442 right angle bracket for addresses to be verified.
3443
3444 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3445 &[readline()]& function, because it is running as &'exim'& and there are
3446 security issues.
3447
3448 Verification differs from address testing (the &%-bt%& option) in that routers
3449 that have &%no_verify%& set are skipped, and if the address is accepted by a
3450 router that has &%fail_verify%& set, verification fails. The address is
3451 verified as a recipient if &%-bv%& is used; to test verification for a sender
3452 address, &%-bvs%& should be used.
3453
3454 If the &%-v%& option is not set, the output consists of a single line for each
3455 address, stating whether it was verified or not, and giving a reason in the
3456 latter case. Without &%-v%&, generating more than one address by redirection
3457 causes verification to end successfully, without considering the generated
3458 addresses. However, if just one address is generated, processing continues,
3459 and the generated address must verify successfully for the overall verification
3460 to succeed.
3461
3462 When &%-v%& is set, more details are given of how the address has been handled,
3463 and in the case of address redirection, all the generated addresses are also
3464 considered. Verification may succeed for some and fail for others.
3465
3466 The
3467 .cindex "return code" "for &%-bv%&"
3468 return code is 2 if any address failed outright; it is 1 if no address
3469 failed outright but at least one could not be resolved for some reason. Return
3470 code 0 is given only when all addresses succeed.
3471
3472 If any of the routers in the configuration makes any tests on the sender
3473 address of a message, you should use the &%-f%& option to set an appropriate
3474 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3475 calling user at the default qualifying domain.
3476
3477 .vitem &%-bvs%&
3478 .oindex "&%-bvs%&"
3479 This option acts like &%-bv%&, but verifies the address as a sender rather
3480 than a recipient address. This affects any rewriting and qualification that
3481 might happen.
3482
3483 .vitem &%-bw%&
3484 .oindex "&%-bw%&"
3485 .cindex "daemon"
3486 .cindex "inetd"
3487 .cindex "inetd" "wait mode"
3488 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3489 similarly to the &%-bd%& option.  All port specifications on the command-line
3490 and in the configuration file are ignored.  Queue-running may not be specified.
3491
3492 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3493 listening for connections.  This permits the system to start up and have
3494 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3495 each port only when the first connection is received.
3496
3497 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3498 which the daemon will exit, which should cause inetd to listen once more.
3499
3500 .vitem &%-C%&&~<&'filelist'&>
3501 .oindex "&%-C%&"
3502 .cindex "configuration file" "alternate"
3503 .cindex "CONFIGURE_FILE"
3504 .cindex "alternate configuration file"
3505 This option causes Exim to find the run time configuration file from the given
3506 list instead of from the list specified by the CONFIGURE_FILE
3507 compile-time setting. Usually, the list will consist of just a single file
3508 name, but it can be a colon-separated list of names. In this case, the first
3509 file that exists is used. Failure to open an existing file stops Exim from
3510 proceeding any further along the list, and an error is generated.
3511
3512 When this option is used by a caller other than root, and the list is different
3513 from the compiled-in list, Exim gives up its root privilege immediately, and
3514 runs with the real and effective uid and gid set to those of the caller.
3515 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3516 file contains a list of full pathnames, one per line, for configuration files
3517 which are trusted. Root privilege is retained for any configuration file so
3518 listed, as long as the caller is the Exim user (or the user specified in the
3519 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3520 not writeable by inappropriate users or groups.
3521
3522 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3523 configuration using &%-C%& right through message reception and delivery,
3524 even if the caller is root. The reception works, but by that time, Exim is
3525 running as the Exim user, so when it re-executes to regain privilege for the
3526 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3527 test reception and delivery using two separate commands (one to put a message
3528 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3529
3530 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3531 prefix string with which any file named in a &%-C%& command line option
3532 must start. In addition, the file name must not contain the sequence &`/../`&.
3533 However, if the value of the &%-C%& option is identical to the value of
3534 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3535 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3536 unset, any file name can be used with &%-C%&.
3537
3538 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3539 to a directory to which only root has access. This prevents someone who has
3540 broken into the Exim account from running a privileged Exim with an arbitrary
3541 configuration file.
3542
3543 The &%-C%& facility is useful for ensuring that configuration files are
3544 syntactically correct, but cannot be used for test deliveries, unless the
3545 caller is privileged, or unless it is an exotic configuration that does not
3546 require privilege. No check is made on the owner or group of the files
3547 specified by this option.
3548
3549
3550 .vitem &%-D%&<&'macro'&>=<&'value'&>
3551 .oindex "&%-D%&"
3552 .cindex "macro" "setting on command line"
3553 This option can be used to override macro definitions in the configuration file
3554 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3555 unprivileged caller, it causes Exim to give up its root privilege.
3556 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3557 completely disabled, and its use causes an immediate error exit.
3558
3559 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3560 colon-separated list of macros which are considered safe and, if &%-D%& only
3561 supplies macros from this list, and the values are acceptable, then Exim will
3562 not give up root privilege if the caller is root, the Exim run-time user, or
3563 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3564 to be removed in the future.  Acceptable values for the macros satisfy the
3565 regexp: &`^[A-Za-z0-9_/.-]*$`&
3566
3567 The entire option (including equals sign if present) must all be within one
3568 command line item. &%-D%& can be used to set the value of a macro to the empty
3569 string, in which case the equals sign is optional. These two commands are
3570 synonymous:
3571 .code
3572 exim -DABC  ...
3573 exim -DABC= ...
3574 .endd
3575 To include spaces in a macro definition item, quotes must be used. If you use
3576 quotes, spaces are permitted around the macro name and the equals sign. For
3577 example:
3578 .code
3579 exim '-D ABC = something' ...
3580 .endd
3581 &%-D%& may be repeated up to 10 times on a command line.
3582 Only macro names up to 22 letters long can be set.
3583
3584
3585 .vitem &%-d%&<&'debug&~options'&>
3586 .oindex "&%-d%&"
3587 .cindex "debugging" "list of selectors"
3588 .cindex "debugging" "&%-d%& option"
3589 This option causes debugging information to be written to the standard
3590 error stream. It is restricted to admin users because debugging output may show
3591 database queries that contain password information. Also, the details of users'
3592 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3593 writes an error message to the standard error stream and exits with a non-zero
3594 return code.
3595
3596 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3597 standard debugging data is output. This can be reduced, or increased to include
3598 some more rarely needed information, by directly following &%-d%& with a string
3599 made up of names preceded by plus or minus characters. These add or remove sets
3600 of debugging data, respectively. For example, &%-d+filter%& adds filter
3601 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3602 no spaces are allowed in the debug setting. The available debugging categories
3603 are:
3604 .display
3605 &`acl            `& ACL interpretation
3606 &`auth           `& authenticators
3607 &`deliver        `& general delivery logic
3608 &`dns            `& DNS lookups (see also resolver)
3609 &`dnsbl          `& DNS black list (aka RBL) code
3610 &`exec           `& arguments for &[execv()]& calls
3611 &`expand         `& detailed debugging for string expansions
3612 &`filter         `& filter handling
3613 &`hints_lookup   `& hints data lookups
3614 &`host_lookup    `& all types of name-to-IP address handling
3615 &`ident          `& ident lookup
3616 &`interface      `& lists of local interfaces
3617 &`lists          `& matching things in lists
3618 &`load           `& system load checks
3619 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3620                     &<<CHAPlocalscan>>&)
3621 &`lookup         `& general lookup code and all lookups
3622 &`memory         `& memory handling
3623 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3624 &`pid            `& modifier: add pid to debug output lines
3625 &`process_info   `& setting info for the process log
3626 &`queue_run      `& queue runs
3627 &`receive        `& general message reception logic
3628 &`resolver       `& turn on the DNS resolver's debugging output
3629 &`retry          `& retry handling
3630 &`rewrite        `& address rewriting
3631 &`route          `& address routing
3632 &`timestamp      `& modifier: add timestamp to debug output lines
3633 &`tls            `& TLS logic
3634 &`transport      `& transports
3635 &`uid            `& changes of uid/gid and looking up uid/gid
3636 &`verify         `& address verification logic
3637 &`all            `& almost all of the above (see below), and also &%-v%&
3638 .endd
3639 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3640 for &`-all`&. The reason for this is that &`+all`& is something that people
3641 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3642 is included, an awful lot of output that is very rarely of interest is
3643 generated, so it now has to be explicitly requested. However, &`-all`& does
3644 turn everything off.
3645
3646 .cindex "resolver, debugging output"
3647 .cindex "DNS resolver, debugging output"
3648 The &`resolver`& option produces output only if the DNS resolver was compiled
3649 with DEBUG enabled. This is not the case in some operating systems. Also,
3650 unfortunately, debugging output from the DNS resolver is written to stdout
3651 rather than stderr.
3652
3653 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3654 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3655 However, the &`pid`& selector is forced when debugging is turned on for a
3656 daemon, which then passes it on to any re-executed Exims. Exim also
3657 automatically adds the pid to debug lines when several remote deliveries are
3658 run in parallel.
3659
3660 The &`timestamp`& selector causes the current time to be inserted at the start
3661 of all debug output lines. This can be useful when trying to track down delays
3662 in processing.
3663
3664 .new
3665 .cindex debugging "UTF-8 in"
3666 .cindex UTF-8 "in debug output"
3667 The &`noutf8`& selector disables the use of
3668 UTF-8 line-drawing characters to group related information.
3669 When disabled. ascii-art is used instead.
3670 Using the &`+all`& option does not set this modifier,
3671 .wen
3672
3673 If the &%debug_print%& option is set in any driver, it produces output whenever
3674 any debugging is selected, or if &%-v%& is used.
3675
3676 .vitem &%-dd%&<&'debug&~options'&>
3677 .oindex "&%-dd%&"
3678 This option behaves exactly like &%-d%& except when used on a command that
3679 starts a daemon process. In that case, debugging is turned off for the
3680 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3681 behaviour of the daemon without creating as much output as full debugging does.
3682
3683 .vitem &%-dropcr%&
3684 .oindex "&%-dropcr%&"
3685 This is an obsolete option that is now a no-op. It used to affect the way Exim
3686 handled CR and LF characters in incoming messages. What happens now is
3687 described in section &<<SECTlineendings>>&.
3688
3689 .vitem &%-E%&
3690 .oindex "&%-E%&"
3691 .cindex "bounce message" "generating"
3692 This option specifies that an incoming message is a locally-generated delivery
3693 failure report. It is used internally by Exim when handling delivery failures
3694 and is not intended for external use. Its only effect is to stop Exim
3695 generating certain messages to the postmaster, as otherwise message cascades
3696 could occur in some situations. As part of the same option, a message id may
3697 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3698 new message contains the id, following &"R="&, as a cross-reference.
3699
3700 .vitem &%-e%&&'x'&
3701 .oindex "&%-e%&&'x'&"
3702 There are a number of Sendmail options starting with &%-oe%& which seem to be
3703 called by various programs without the leading &%o%& in the option. For
3704 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3705 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3706
3707 .vitem &%-F%&&~<&'string'&>
3708 .oindex "&%-F%&"
3709 .cindex "sender" "name"
3710 .cindex "name" "of sender"
3711 This option sets the sender's full name for use when a locally-generated
3712 message is being accepted. In the absence of this option, the user's &'gecos'&
3713 entry from the password data is used. As users are generally permitted to alter
3714 their &'gecos'& entries, no security considerations are involved. White space
3715 between &%-F%& and the <&'string'&> is optional.
3716
3717 .vitem &%-f%&&~<&'address'&>
3718 .oindex "&%-f%&"
3719 .cindex "sender" "address"
3720 .cindex "address" "sender"
3721 .cindex "trusted users"
3722 .cindex "envelope sender"
3723 .cindex "user" "trusted"
3724 This option sets the address of the envelope sender of a locally-generated
3725 message (also known as the return path). The option can normally be used only
3726 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3727 users to use it.
3728
3729 Processes running as root or the Exim user are always trusted. Other
3730 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3731 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3732 of a local message is set to the caller's login name at the default qualify
3733 domain.
3734
3735 There is one exception to the restriction on the use of &%-f%&: an empty sender
3736 can be specified by any user, trusted or not, to create a message that can
3737 never provoke a bounce. An empty sender can be specified either as an empty
3738 string, or as a pair of angle brackets with nothing between them, as in these
3739 examples of shell commands:
3740 .code
3741 exim -f '<>' user@domain
3742 exim -f "" user@domain
3743 .endd
3744 In addition, the use of &%-f%& is not restricted when testing a filter file
3745 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3746 &%-bv%& options.
3747
3748 Allowing untrusted users to change the sender address does not of itself make
3749 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3750 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3751 though this can be overridden by setting &%no_local_from_check%&.
3752
3753 White
3754 .cindex "&""From""& line"
3755 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3756 given as two arguments or one combined argument). The sender of a
3757 locally-generated message can also be set (when permitted) by an initial
3758 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3759 if &%-f%& is also present, it overrides &"From&~"&.
3760
3761 .vitem &%-G%&
3762 .oindex "&%-G%&"
3763 .cindex "submission fixups, suppressing (command-line)"
3764 This option is equivalent to an ACL applying:
3765 .code
3766 control = suppress_local_fixups
3767 .endd
3768 for every message received.  Note that Sendmail will complain about such
3769 bad formatting, where Exim silently just does not fix it up.  This may change
3770 in future.
3771
3772 As this affects audit information, the caller must be a trusted user to use
3773 this option.
3774
3775 .vitem &%-h%&&~<&'number'&>
3776 .oindex "&%-h%&"
3777 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3778 This option is accepted for compatibility with Sendmail, but has no effect. (In
3779 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3780 headers.)
3781
3782 .vitem &%-i%&
3783 .oindex "&%-i%&"
3784 .cindex "Solaris" "&'mail'& command"
3785 .cindex "dot" "in incoming non-SMTP message"
3786 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3787 line by itself should not terminate an incoming, non-SMTP message. I can find
3788 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3789 command in Solaris 2.4 uses it. See also &%-ti%&.
3790
3791 .vitem &%-L%&&~<&'tag'&>
3792 .oindex "&%-L%&"
3793 .cindex "syslog" "process name; set with flag"
3794 This option is equivalent to setting &%syslog_processname%& in the config
3795 file and setting &%log_file_path%& to &`syslog`&.
3796 Its use is restricted to administrators.  The configuration file has to be
3797 read and parsed, to determine access rights, before this is set and takes
3798 effect, so early configuration file errors will not honour this flag.
3799
3800 The tag should not be longer than 32 characters.
3801
3802 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3803 .oindex "&%-M%&"
3804 .cindex "forcing delivery"
3805 .cindex "delivery" "forcing attempt"
3806 .cindex "frozen messages" "forcing delivery"
3807 This option requests Exim to run a delivery attempt on each message in turn. If
3808 any of the messages are frozen, they are automatically thawed before the
3809 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3810 and &%hold_domains%& are ignored.
3811
3812 Retry
3813 .cindex "hints database" "overriding retry hints"
3814 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3815 the normal retry time has not yet been reached. This option requires the caller
3816 to be an admin user. However, there is an option called &%prod_requires_admin%&
3817 which can be set false to relax this restriction (and also the same requirement
3818 for the &%-q%&, &%-R%&, and &%-S%& options).
3819
3820 The deliveries happen synchronously, that is, the original Exim process does
3821 not terminate until all the delivery attempts have finished. No output is
3822 produced unless there is a serious error. If you want to see what is happening,
3823 use the &%-v%& option as well, or inspect Exim's main log.
3824
3825 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3826 .oindex "&%-Mar%&"
3827 .cindex "message" "adding recipients"
3828 .cindex "recipient" "adding"
3829 This option requests Exim to add the addresses to the list of recipients of the
3830 message (&"ar"& for &"add recipients"&). The first argument must be a message
3831 id, and the remaining ones must be email addresses. However, if the message is
3832 active (in the middle of a delivery attempt), it is not altered. This option
3833 can be used only by an admin user.
3834
3835 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3836         &~<&'message&~id'&>"
3837 .oindex "&%-MC%&"
3838 .cindex "SMTP" "passed connection"
3839 .cindex "SMTP" "multiple deliveries"
3840 .cindex "multiple SMTP deliveries"
3841 This option is not intended for use by external callers. It is used internally
3842 by Exim to invoke another instance of itself to deliver a waiting message using
3843 an existing SMTP connection, which is passed as the standard input. Details are
3844 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3845 must be root or the Exim user in order to use it.
3846
3847 .vitem &%-MCA%&
3848 .oindex "&%-MCA%&"
3849 This option is not intended for use by external callers. It is used internally
3850 by Exim in conjunction with the &%-MC%& option. It signifies that the
3851 connection to the remote host has been authenticated.
3852
3853 .vitem &%-MCD%&
3854 .oindex "&%-MCD%&"
3855 This option is not intended for use by external callers. It is used internally
3856 by Exim in conjunction with the &%-MC%& option. It signifies that the
3857 remote host supports the ESMTP &_DSN_& extension.
3858
3859 .vitem &%-MCG%&&~<&'queue&~name'&>
3860 .oindex "&%-MCG%&"
3861 This option is not intended for use by external callers. It is used internally
3862 by Exim in conjunction with the &%-MC%& option. It signifies that an
3863 alternate queue is used, named by the following argument.
3864
3865 .vitem &%-MCK%&
3866 .oindex "&%-MCK%&"
3867 This option is not intended for use by external callers. It is used internally
3868 by Exim in conjunction with the &%-MC%& option. It signifies that a
3869 remote host supports the ESMTP &_CHUNKING_& extension.
3870
3871 .vitem &%-MCP%&
3872 .oindex "&%-MCP%&"
3873 This option is not intended for use by external callers. It is used internally
3874 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3875 which Exim is connected supports pipelining.
3876
3877 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3878 .oindex "&%-MCQ%&"
3879 This option is not intended for use by external callers. It is used internally
3880 by Exim in conjunction with the &%-MC%& option when the original delivery was
3881 started by a queue runner. It passes on the process id of the queue runner,
3882 together with the file descriptor number of an open pipe. Closure of the pipe
3883 signals the final completion of the sequence of processes that are passing
3884 messages through the same SMTP connection.
3885
3886 .vitem &%-MCS%&
3887 .oindex "&%-MCS%&"
3888 This option is not intended for use by external callers. It is used internally
3889 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3890 SMTP SIZE option should be used on messages delivered down the existing
3891 connection.
3892
3893 .vitem &%-MCT%&
3894 .oindex "&%-MCT%&"
3895 This option is not intended for use by external callers. It is used internally
3896 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3897 host to which Exim is connected supports TLS encryption.
3898
3899 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3900 .oindex "&%-MCt%&"
3901 This option is not intended for use by external callers. It is used internally
3902 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3903 connection is being proxied by a parent process for handling TLS encryption.
3904 The arguments give the local address and port being proxied, and the TLS cipher.
3905
3906 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3907 .oindex "&%-Mc%&"
3908 .cindex "hints database" "not overridden by &%-Mc%&"
3909 .cindex "delivery" "manually started &-- not forced"
3910 This option requests Exim to run a delivery attempt on each message in turn,
3911 but unlike the &%-M%& option, it does check for retry hints, and respects any
3912 that are found. This option is not very useful to external callers. It is
3913 provided mainly for internal use by Exim when it needs to re-invoke itself in
3914 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3915 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3916 respects retry times and other options such as &%hold_domains%& that are
3917 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3918 If you want to run a specific delivery as if in a queue run, you should use
3919 &%-q%& with a message id argument. A distinction between queue run deliveries
3920 and other deliveries is made in one or two places.
3921
3922 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3923 .oindex "&%-Mes%&"
3924 .cindex "message" "changing sender"
3925 .cindex "sender" "changing"
3926 This option requests Exim to change the sender address in the message to the
3927 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3928 &"edit sender"&). There must be exactly two arguments. The first argument must
3929 be a message id, and the second one an email address. However, if the message
3930 is active (in the middle of a delivery attempt), its status is not altered.
3931 This option can be used only by an admin user.
3932
3933 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3934 .oindex "&%-Mf%&"
3935 .cindex "freezing messages"
3936 .cindex "message" "manually freezing"
3937 This option requests Exim to mark each listed message as &"frozen"&. This
3938 prevents any delivery attempts taking place until the message is &"thawed"&,
3939 either manually or as a result of the &%auto_thaw%& configuration option.
3940 However, if any of the messages are active (in the middle of a delivery
3941 attempt), their status is not altered. This option can be used only by an admin
3942 user.
3943
3944 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3945 .oindex "&%-Mg%&"
3946 .cindex "giving up on messages"
3947 .cindex "message" "abandoning delivery attempts"
3948 .cindex "delivery" "abandoning further attempts"
3949 This option requests Exim to give up trying to deliver the listed messages,
3950 including any that are frozen. However, if any of the messages are active,
3951 their status is not altered. For non-bounce messages, a delivery error message
3952 is sent to the sender, containing the text &"cancelled by administrator"&.
3953 Bounce messages are just discarded. This option can be used only by an admin
3954 user.
3955
3956 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3957 .oindex "&%-Mmad%&"
3958 .cindex "delivery" "cancelling all"
3959 This option requests Exim to mark all the recipient addresses in the messages
3960 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3961 message is active (in the middle of a delivery attempt), its status is not
3962 altered. This option can be used only by an admin user.
3963
3964 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3965 .oindex "&%-Mmd%&"
3966 .cindex "delivery" "cancelling by address"
3967 .cindex "recipient" "removing"
3968 .cindex "removing recipients"
3969 This option requests Exim to mark the given addresses as already delivered
3970 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3971 the remaining ones must be email addresses. These are matched to recipient
3972 addresses in the message in a case-sensitive manner. If the message is active
3973 (in the middle of a delivery attempt), its status is not altered. This option
3974 can be used only by an admin user.
3975
3976 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3977 .oindex "&%-Mrm%&"
3978 .cindex "removing messages"
3979 .cindex "abandoning mail"
3980 .cindex "message" "manually discarding"
3981 This option requests Exim to remove the given messages from the queue. No
3982 bounce messages are sent; each message is simply forgotten. However, if any of
3983 the messages are active, their status is not altered. This option can be used
3984 only by an admin user or by the user who originally caused the message to be
3985 placed on the queue.
3986
3987 . .new
3988 . .vitem &%-MS%&
3989 . .oindex "&%-MS%&"
3990 . .cindex REQUIRETLS
3991 . This option is used to request REQUIRETLS processing on the message.
3992 . It is used internally by Exim in conjunction with -E when generating
3993 . a bounce message.
3994 . .wen
3995
3996 .vitem &%-Mset%&&~<&'message&~id'&>
3997 .oindex "&%-Mset%&"
3998 .cindex "testing" "string expansion"
3999 .cindex "expansion" "testing"
4000 This option is useful only in conjunction with &%-be%& (that is, when testing
4001 string expansions). Exim loads the given message from its spool before doing
4002 the test expansions, thus setting message-specific variables such as
4003 &$message_size$& and the header variables. The &$recipients$& variable is made
4004 available. This feature is provided to make it easier to test expansions that
4005 make use of these variables. However, this option can be used only by an admin
4006 user. See also &%-bem%&.
4007
4008 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4009 .oindex "&%-Mt%&"
4010 .cindex "thawing messages"
4011 .cindex "unfreezing messages"
4012 .cindex "frozen messages" "thawing"
4013 .cindex "message" "thawing frozen"
4014 This option requests Exim to &"thaw"& any of the listed messages that are
4015 &"frozen"&, so that delivery attempts can resume. However, if any of the
4016 messages are active, their status is not altered. This option can be used only
4017 by an admin user.
4018
4019 .vitem &%-Mvb%&&~<&'message&~id'&>
4020 .oindex "&%-Mvb%&"
4021 .cindex "listing" "message body"
4022 .cindex "message" "listing body of"
4023 This option causes the contents of the message body (-D) spool file to be
4024 written to the standard output. This option can be used only by an admin user.
4025
4026 .vitem &%-Mvc%&&~<&'message&~id'&>
4027 .oindex "&%-Mvc%&"
4028 .cindex "message" "listing in RFC 2822 format"
4029 .cindex "listing" "message in RFC 2822 format"
4030 This option causes a copy of the complete message (header lines plus body) to
4031 be written to the standard output in RFC 2822 format. This option can be used
4032 only by an admin user.
4033
4034 .vitem &%-Mvh%&&~<&'message&~id'&>
4035 .oindex "&%-Mvh%&"
4036 .cindex "listing" "message headers"
4037 .cindex "header lines" "listing"
4038 .cindex "message" "listing header lines"
4039 This option causes the contents of the message headers (-H) spool file to be
4040 written to the standard output. This option can be used only by an admin user.
4041
4042 .vitem &%-Mvl%&&~<&'message&~id'&>
4043 .oindex "&%-Mvl%&"
4044 .cindex "listing" "message log"
4045 .cindex "message" "listing message log"
4046 This option causes the contents of the message log spool file to be written to
4047 the standard output. This option can be used only by an admin user.
4048
4049 .vitem &%-m%&
4050 .oindex "&%-m%&"
4051 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4052 treats it that way too.
4053
4054 .vitem &%-N%&
4055 .oindex "&%-N%&"
4056 .cindex "debugging" "&%-N%& option"
4057 .cindex "debugging" "suppressing delivery"
4058 This is a debugging option that inhibits delivery of a message at the transport
4059 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4060 it just doesn't actually transport the message, but instead behaves as if it
4061 had successfully done so. However, it does not make any updates to the retry
4062 database, and the log entries for deliveries are flagged with &"*>"& rather
4063 than &"=>"&.
4064
4065 Because &%-N%& discards any message to which it applies, only root or the Exim
4066 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4067 words, an ordinary user can use it only when supplying an incoming message to
4068 which it will apply. Although transportation never fails when &%-N%& is set, an
4069 address may be deferred because of a configuration problem on a transport, or a
4070 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4071 the message, and applies to any subsequent delivery attempts that may happen
4072 for that message.
4073
4074 .vitem &%-n%&
4075 .oindex "&%-n%&"
4076 This option is interpreted by Sendmail to mean &"no aliasing"&.
4077 For normal modes of operation, it is ignored by Exim.
4078 When combined with &%-bP%& it makes the output more terse (suppresses
4079 option names, environment values and config pretty printing).
4080
4081 .vitem &%-O%&&~<&'data'&>
4082 .oindex "&%-O%&"
4083 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4084 Exim.
4085
4086 .vitem &%-oA%&&~<&'file&~name'&>
4087 .oindex "&%-oA%&"
4088 .cindex "Sendmail compatibility" "&%-oA%& option"
4089 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4090 alternative alias file name. Exim handles &%-bi%& differently; see the
4091 description above.
4092
4093 .vitem &%-oB%&&~<&'n'&>
4094 .oindex "&%-oB%&"
4095 .cindex "SMTP" "passed connection"
4096 .cindex "SMTP" "multiple deliveries"
4097 .cindex "multiple SMTP deliveries"
4098 This is a debugging option which limits the maximum number of messages that can
4099 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4100 transport. If <&'n'&> is omitted, the limit is set to 1.
4101
4102 .vitem &%-odb%&
4103 .oindex "&%-odb%&"
4104 .cindex "background delivery"
4105 .cindex "delivery" "in the background"
4106 This option applies to all modes in which Exim accepts incoming messages,
4107 including the listening daemon. It requests &"background"& delivery of such
4108 messages, which means that the accepting process automatically starts a
4109 delivery process for each message received, but does not wait for the delivery
4110 processes to finish.
4111
4112 When all the messages have been received, the reception process exits,
4113 leaving the delivery processes to finish in their own time. The standard output
4114 and error streams are closed at the start of each delivery process.
4115 This is the default action if none of the &%-od%& options are present.
4116
4117 If one of the queueing options in the configuration file
4118 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4119 overrides it if &%queue_only_override%& is set true, which is the default
4120 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4121
4122 .vitem &%-odf%&
4123 .oindex "&%-odf%&"
4124 .cindex "foreground delivery"
4125 .cindex "delivery" "in the foreground"
4126 This option requests &"foreground"& (synchronous) delivery when Exim has
4127 accepted a locally-generated message. (For the daemon it is exactly the same as
4128 &%-odb%&.) A delivery process is automatically started to deliver the message,
4129 and Exim waits for it to complete before proceeding.
4130
4131 The original Exim reception process does not finish until the delivery
4132 process for the final message has ended. The standard error stream is left open
4133 during deliveries.
4134
4135 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4136 false and one of the queueing options in the configuration file is in effect.
4137
4138 If there is a temporary delivery error during foreground delivery, the
4139 message is left on the queue for later delivery, and the original reception
4140 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4141 restricted configuration that never queues messages.
4142
4143
4144 .vitem &%-odi%&
4145 .oindex "&%-odi%&"
4146 This option is synonymous with &%-odf%&. It is provided for compatibility with
4147 Sendmail.
4148
4149 .vitem &%-odq%&
4150 .oindex "&%-odq%&"
4151 .cindex "non-immediate delivery"
4152 .cindex "delivery" "suppressing immediate"
4153 .cindex "queueing incoming messages"
4154 This option applies to all modes in which Exim accepts incoming messages,
4155 including the listening daemon. It specifies that the accepting process should
4156 not automatically start a delivery process for each message received. Messages
4157 are placed on the queue, and remain there until a subsequent queue runner
4158 process encounters them. There are several configuration options (such as
4159 &%queue_only%&) that can be used to queue incoming messages under certain
4160 conditions. This option overrides all of them and also &%-odqs%&. It always
4161 forces queueing.
4162
4163 .vitem &%-odqs%&
4164 .oindex "&%-odqs%&"
4165 .cindex "SMTP" "delaying delivery"
4166 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4167 However, like &%-odb%& and &%-odi%&, this option has no effect if
4168 &%queue_only_override%& is false and one of the queueing options in the
4169 configuration file is in effect.
4170
4171 When &%-odqs%& does operate, a delivery process is started for each incoming
4172 message, in the background by default, but in the foreground if &%-odi%& is
4173 also present. The recipient addresses are routed, and local deliveries are done
4174 in the normal way. However, if any SMTP deliveries are required, they are not
4175 done at this time, so the message remains on the queue until a subsequent queue
4176 runner process encounters it. Because routing was done, Exim knows which
4177 messages are waiting for which hosts, and so a number of messages for the same
4178 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4179 configuration option has the same effect for specific domains. See also the
4180 &%-qq%& option.
4181
4182 .vitem &%-oee%&
4183 .oindex "&%-oee%&"
4184 .cindex "error" "reporting"
4185 If an error is detected while a non-SMTP message is being received (for
4186 example, a malformed address), the error is reported to the sender in a mail
4187 message.
4188
4189 .cindex "return code" "for &%-oee%&"
4190 Provided
4191 this error message is successfully sent, the Exim receiving process
4192 exits with a return code of zero. If not, the return code is 2 if the problem
4193 is that the original message has no recipients, or 1 for any other error.
4194 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4195
4196 .vitem &%-oem%&
4197 .oindex "&%-oem%&"
4198 .cindex "error" "reporting"
4199 .cindex "return code" "for &%-oem%&"
4200 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4201 return code, whether or not the error message was successfully sent.
4202 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4203
4204 .vitem &%-oep%&
4205 .oindex "&%-oep%&"
4206 .cindex "error" "reporting"
4207 If an error is detected while a non-SMTP message is being received, the
4208 error is reported by writing a message to the standard error file (stderr).
4209 .cindex "return code" "for &%-oep%&"
4210 The return code is 1 for all errors.
4211
4212 .vitem &%-oeq%&
4213 .oindex "&%-oeq%&"
4214 .cindex "error" "reporting"
4215 This option is supported for compatibility with Sendmail, but has the same
4216 effect as &%-oep%&.
4217
4218 .vitem &%-oew%&
4219 .oindex "&%-oew%&"
4220 .cindex "error" "reporting"
4221 This option is supported for compatibility with Sendmail, but has the same
4222 effect as &%-oem%&.
4223
4224 .vitem &%-oi%&
4225 .oindex "&%-oi%&"
4226 .cindex "dot" "in incoming non-SMTP message"
4227 This option, which has the same effect as &%-i%&, specifies that a dot on a
4228 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4229 single dot does terminate, though Exim does no special processing for other
4230 lines that start with a dot. This option is set by default if Exim is called as
4231 &'rmail'&. See also &%-ti%&.
4232
4233 .vitem &%-oitrue%&
4234 .oindex "&%-oitrue%&"
4235 This option is treated as synonymous with &%-oi%&.
4236
4237 .vitem &%-oMa%&&~<&'host&~address'&>
4238 .oindex "&%-oMa%&"
4239 .cindex "sender" "host address, specifying for local message"
4240 A number of options starting with &%-oM%& can be used to set values associated
4241 with remote hosts on locally-submitted messages (that is, messages not received
4242 over TCP/IP). These options can be used by any caller in conjunction with the
4243 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4244 other circumstances, they are ignored unless the caller is trusted.
4245
4246 The &%-oMa%& option sets the sender host address. This may include a port
4247 number at the end, after a full stop (period). For example:
4248 .code
4249 exim -bs -oMa 10.9.8.7.1234
4250 .endd
4251 An alternative syntax is to enclose the IP address in square brackets,
4252 followed by a colon and the port number:
4253 .code
4254 exim -bs -oMa [10.9.8.7]:1234
4255 .endd
4256 The IP address is placed in the &$sender_host_address$& variable, and the
4257 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4258 are present on the command line, the sender host IP address is taken from
4259 whichever one is last.
4260
4261 .vitem &%-oMaa%&&~<&'name'&>
4262 .oindex "&%-oMaa%&"
4263 .cindex "authentication" "name, specifying for local message"
4264 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4265 option sets the value of &$sender_host_authenticated$& (the authenticator
4266 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4267 This option can be used with &%-bh%& and &%-bs%& to set up an
4268 authenticated SMTP session without actually using the SMTP AUTH command.
4269
4270 .vitem &%-oMai%&&~<&'string'&>
4271 .oindex "&%-oMai%&"
4272 .cindex "authentication" "id, specifying for local message"
4273 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4274 option sets the value of &$authenticated_id$& (the id that was authenticated).
4275 This overrides the default value (the caller's login id, except with &%-bh%&,
4276 where there is no default) for messages from local sources. See chapter
4277 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4278
4279 .vitem &%-oMas%&&~<&'address'&>
4280 .oindex "&%-oMas%&"
4281 .cindex "authentication" "sender, specifying for local message"
4282 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4283 option sets the authenticated sender value in &$authenticated_sender$&. It
4284 overrides the sender address that is created from the caller's login id for
4285 messages from local sources, except when &%-bh%& is used, when there is no
4286 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4287 specified on a MAIL command overrides this value. See chapter
4288 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4289
4290 .vitem &%-oMi%&&~<&'interface&~address'&>
4291 .oindex "&%-oMi%&"
4292 .cindex "interface" "address, specifying for local message"
4293 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4294 option sets the IP interface address value. A port number may be included,
4295 using the same syntax as for &%-oMa%&. The interface address is placed in
4296 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4297
4298 .vitem &%-oMm%&&~<&'message&~reference'&>
4299 .oindex "&%-oMm%&"
4300 .cindex "message reference" "message reference, specifying for local message"
4301 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4302 option sets the message reference, e.g. message-id, and is logged during
4303 delivery. This is useful when some kind of audit trail is required to tie
4304 messages together. The format of the message reference is checked and will
4305 abort if the format is invalid. The option will only be accepted if exim is
4306 running in trusted mode, not as any regular user.
4307
4308 The best example of a message reference is when Exim sends a bounce message.
4309 The message reference is the message-id of the original message for which Exim
4310 is sending the bounce.
4311
4312 .vitem &%-oMr%&&~<&'protocol&~name'&>
4313 .oindex "&%-oMr%&"
4314 .cindex "protocol, specifying for local message"
4315 .vindex "&$received_protocol$&"
4316 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4317 option sets the received protocol value that is stored in
4318 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4319 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4320 SMTP protocol names (see the description of &$received_protocol$& in section
4321 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4322 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4323 be set by &%-oMr%&. Repeated use of this option is not supported.
4324
4325 .vitem &%-oMs%&&~<&'host&~name'&>
4326 .oindex "&%-oMs%&"
4327 .cindex "sender" "host name, specifying for local message"
4328 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4329 option sets the sender host name in &$sender_host_name$&. When this option is
4330 present, Exim does not attempt to look up a host name from an IP address; it
4331 uses the name it is given.
4332
4333 .vitem &%-oMt%&&~<&'ident&~string'&>
4334 .oindex "&%-oMt%&"
4335 .cindex "sender" "ident string, specifying for local message"
4336 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4337 option sets the sender ident value in &$sender_ident$&. The default setting for
4338 local callers is the login id of the calling process, except when &%-bh%& is
4339 used, when there is no default.
4340
4341 .vitem &%-om%&
4342 .oindex "&%-om%&"
4343 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4344 In Sendmail, this option means &"me too"&, indicating that the sender of a
4345 message should receive a copy of the message if the sender appears in an alias
4346 expansion. Exim always does this, so the option does nothing.
4347
4348 .vitem &%-oo%&
4349 .oindex "&%-oo%&"
4350 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4351 This option is ignored. In Sendmail it specifies &"old style headers"&,
4352 whatever that means.
4353
4354 .vitem &%-oP%&&~<&'path'&>
4355 .oindex "&%-oP%&"
4356 .cindex "pid (process id)" "of daemon"
4357 .cindex "daemon" "process id (pid)"
4358 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4359 value. The option specifies the file to which the process id of the daemon is
4360 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4361 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4362 because in those cases, the normal pid file is not used.
4363
4364 .vitem &%-or%&&~<&'time'&>
4365 .oindex "&%-or%&"
4366 .cindex "timeout" "for non-SMTP input"
4367 This option sets a timeout value for incoming non-SMTP messages. If it is not
4368 set, Exim will wait forever for the standard input. The value can also be set
4369 by the &%receive_timeout%& option. The format used for specifying times is
4370 described in section &<<SECTtimeformat>>&.
4371
4372 .vitem &%-os%&&~<&'time'&>
4373 .oindex "&%-os%&"
4374 .cindex "timeout" "for SMTP input"
4375 .cindex "SMTP" "input timeout"
4376 This option sets a timeout value for incoming SMTP messages. The timeout
4377 applies to each SMTP command and block of data. The value can also be set by
4378 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4379 for specifying times is described in section &<<SECTtimeformat>>&.
4380
4381 .vitem &%-ov%&
4382 .oindex "&%-ov%&"
4383 This option has exactly the same effect as &%-v%&.
4384
4385 .vitem &%-oX%&&~<&'number&~or&~string'&>
4386 .oindex "&%-oX%&"
4387 .cindex "TCP/IP" "setting listening ports"
4388 .cindex "TCP/IP" "setting listening interfaces"
4389 .cindex "port" "receiving TCP/IP"
4390 This option is relevant only when the &%-bd%& (start listening daemon) option
4391 is also given. It controls which ports and interfaces the daemon uses. Details
4392 of the syntax, and how it interacts with configuration file options, are given
4393 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4394 file is written unless &%-oP%& is also present to specify a pid file name.
4395
4396 .vitem &%-pd%&
4397 .oindex "&%-pd%&"
4398 .cindex "Perl" "starting the interpreter"
4399 This option applies when an embedded Perl interpreter is linked with Exim (see
4400 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4401 option, forcing the starting of the interpreter to be delayed until it is
4402 needed.
4403
4404 .vitem &%-ps%&
4405 .oindex "&%-ps%&"
4406 .cindex "Perl" "starting the interpreter"
4407 This option applies when an embedded Perl interpreter is linked with Exim (see
4408 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4409 option, forcing the starting of the interpreter to occur as soon as Exim is
4410 started.
4411
4412 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4413 .oindex "&%-p%&"
4414 For compatibility with Sendmail, this option is equivalent to
4415 .display
4416 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4417 .endd
4418 It sets the incoming protocol and host name (for trusted callers). The
4419 host name and its colon can be omitted when only the protocol is to be set.
4420 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4421 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4422 or &`s`& using this option (but that does not seem a real limitation).
4423 Repeated use of this option is not supported.
4424
4425 .vitem &%-q%&
4426 .oindex "&%-q%&"
4427 .cindex "queue runner" "starting manually"
4428 This option is normally restricted to admin users. However, there is a
4429 configuration option called &%prod_requires_admin%& which can be set false to
4430 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4431 and &%-S%& options).
4432
4433 .cindex "queue runner" "description of operation"
4434 If other commandline options do not specify an action,
4435 the &%-q%& option starts one queue runner process. This scans the queue of
4436 waiting messages, and runs a delivery process for each one in turn. It waits
4437 for each delivery process to finish before starting the next one. A delivery
4438 process may not actually do any deliveries if the retry times for the addresses
4439 have not been reached. Use &%-qf%& (see below) if you want to override this.
4440
4441 If
4442 .cindex "SMTP" "passed connection"
4443 .cindex "SMTP" "multiple deliveries"
4444 .cindex "multiple SMTP deliveries"
4445 the delivery process spawns other processes to deliver other messages down
4446 passed SMTP connections, the queue runner waits for these to finish before
4447 proceeding.
4448
4449 When all the queued messages have been considered, the original queue runner
4450 process terminates. In other words, a single pass is made over the waiting
4451 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4452 this to be repeated periodically.
4453
4454 Exim processes the waiting messages in an unpredictable order. It isn't very
4455 random, but it is likely to be different each time, which is all that matters.
4456 If one particular message screws up a remote MTA, other messages to the same
4457 MTA have a chance of getting through if they get tried first.
4458
4459 It is possible to cause the messages to be processed in lexical message id
4460 order, which is essentially the order in which they arrived, by setting the
4461 &%queue_run_in_order%& option, but this is not recommended for normal use.
4462
4463 .vitem &%-q%&<&'qflags'&>
4464 The &%-q%& option may be followed by one or more flag letters that change its
4465 behaviour. They are all optional, but if more than one is present, they must
4466 appear in the correct order. Each flag is described in a separate item below.
4467
4468 .vitem &%-qq...%&
4469 .oindex "&%-qq%&"
4470 .cindex "queue" "double scanning"
4471 .cindex "queue" "routing"
4472 .cindex "routing" "whole queue before delivery"
4473 An option starting with &%-qq%& requests a two-stage queue run. In the first
4474 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4475 every domain. Addresses are routed, local deliveries happen, but no remote
4476 transports are run.
4477
4478 .cindex "hints database" "remembering routing"
4479 The hints database that remembers which messages are waiting for specific hosts
4480 is updated, as if delivery to those hosts had been deferred. After this is
4481 complete, a second, normal queue scan happens, with routing and delivery taking
4482 place as normal. Messages that are routed to the same host should mostly be
4483 delivered down a single SMTP
4484 .cindex "SMTP" "passed connection"
4485 .cindex "SMTP" "multiple deliveries"
4486 .cindex "multiple SMTP deliveries"
4487 connection because of the hints that were set up during the first queue scan.
4488 This option may be useful for hosts that are connected to the Internet
4489 intermittently.
4490
4491 .vitem &%-q[q]i...%&
4492 .oindex "&%-qi%&"
4493 .cindex "queue" "initial delivery"
4494 If the &'i'& flag is present, the queue runner runs delivery processes only for
4495 those messages that haven't previously been tried. (&'i'& stands for &"initial
4496 delivery"&.) This can be helpful if you are putting messages on the queue using
4497 &%-odq%& and want a queue runner just to process the new messages.
4498
4499 .vitem &%-q[q][i]f...%&
4500 .oindex "&%-qf%&"
4501 .cindex "queue" "forcing delivery"
4502 .cindex "delivery" "forcing in queue run"
4503 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4504 message, whereas without &'f'& only those non-frozen addresses that have passed
4505 their retry times are tried.
4506
4507 .vitem &%-q[q][i]ff...%&
4508 .oindex "&%-qff%&"
4509 .cindex "frozen messages" "forcing delivery"
4510 If &'ff'& is present, a delivery attempt is forced for every message, whether
4511 frozen or not.
4512
4513 .vitem &%-q[q][i][f[f]]l%&
4514 .oindex "&%-ql%&"
4515 .cindex "queue" "local deliveries only"
4516 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4517 be done. If a message requires any remote deliveries, it remains on the queue
4518 for later delivery.
4519
4520 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4521 .oindex "&%-qG%&"
4522 .cindex queue named
4523 .cindex "named queues"
4524 .cindex "queue" "delivering specific messages"
4525 If the &'G'& flag and a name is present, the queue runner operates on the
4526 queue with the given name rather than the default queue.
4527 The name should not contain a &'/'& character.
4528 For a periodic queue run (see below)
4529 append to the name a slash and a time value.
4530
4531 If other commandline options specify an action, a &'-qG<name>'& option
4532 will specify a queue to operate on.
4533 For example:
4534 .code
4535 exim -bp -qGquarantine
4536 mailq -qGquarantine
4537 exim -qGoffpeak -Rf @special.domain.example
4538 .endd
4539
4540 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4541 When scanning the queue, Exim can be made to skip over messages whose ids are
4542 lexically less than a given value by following the &%-q%& option with a
4543 starting message id. For example:
4544 .code
4545 exim -q 0t5C6f-0000c8-00
4546 .endd
4547 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4548 second message id is given, messages whose ids are lexically greater than it
4549 are also skipped. If the same id is given twice, for example,
4550 .code
4551 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4552 .endd
4553 just one delivery process is started, for that message. This differs from
4554 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4555 that it counts as a delivery from a queue run. Note that the selection
4556 mechanism does not affect the order in which the messages are scanned. There
4557 are also other ways of selecting specific sets of messages for delivery in a
4558 queue run &-- see &%-R%& and &%-S%&.
4559
4560 .vitem &%-q%&<&'qflags'&><&'time'&>
4561 .cindex "queue runner" "starting periodically"
4562 .cindex "periodic queue running"
4563 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4564 starting a queue runner process at intervals specified by the given time value
4565 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4566 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4567 single daemon process handles both functions. A common way of starting up a
4568 combined daemon at system boot time is to use a command such as
4569 .code
4570 /usr/exim/bin/exim -bd -q30m
4571 .endd
4572 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4573 process every 30 minutes.
4574
4575 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4576 pid file is written unless one is explicitly requested by the &%-oP%& option.
4577
4578 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4579 .oindex "&%-qR%&"
4580 This option is synonymous with &%-R%&. It is provided for Sendmail
4581 compatibility.
4582
4583 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4584 .oindex "&%-qS%&"
4585 This option is synonymous with &%-S%&.
4586
4587 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4588 .oindex "&%-R%&"
4589 .cindex "queue runner" "for specific recipients"
4590 .cindex "delivery" "to given domain"
4591 .cindex "domain" "delivery to"
4592 The <&'rsflags'&> may be empty, in which case the white space before the string
4593 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4594 which are the possible values for <&'rsflags'&>. White space is required if
4595 <&'rsflags'&> is not empty.
4596
4597 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4598 perform a single queue run, except that, when scanning the messages on the
4599 queue, Exim processes only those that have at least one undelivered recipient
4600 address containing the given string, which is checked in a case-independent
4601 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4602 regular expression; otherwise it is a literal string.
4603
4604 If you want to do periodic queue runs for messages with specific recipients,
4605 you can combine &%-R%& with &%-q%& and a time value. For example:
4606 .code
4607 exim -q25m -R @special.domain.example
4608 .endd
4609 This example does a queue run for messages with recipients in the given domain
4610 every 25 minutes. Any additional flags that are specified with &%-q%& are
4611 applied to each queue run.
4612
4613 Once a message is selected for delivery by this mechanism, all its addresses
4614 are processed. For the first selected message, Exim overrides any retry
4615 information and forces a delivery attempt for each undelivered address. This
4616 means that if delivery of any address in the first message is successful, any
4617 existing retry information is deleted, and so delivery attempts for that
4618 address in subsequently selected messages (which are processed without forcing)
4619 will run. However, if delivery of any address does not succeed, the retry
4620 information is updated, and in subsequently selected messages, the failing
4621 address will be skipped.
4622
4623 .cindex "frozen messages" "forcing delivery"
4624 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4625 all selected messages, not just the first; frozen messages are included when
4626 &'ff'& is present.
4627
4628 The &%-R%& option makes it straightforward to initiate delivery of all messages
4629 to a given domain after a host has been down for some time. When the SMTP
4630 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4631 effect is to run Exim with the &%-R%& option, but it can be configured to run
4632 an arbitrary command instead.
4633
4634 .vitem &%-r%&
4635 .oindex "&%-r%&"
4636 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4637
4638 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4639 .oindex "&%-S%&"
4640 .cindex "delivery" "from given sender"
4641 .cindex "queue runner" "for specific senders"
4642 This option acts like &%-R%& except that it checks the string against each
4643 message's sender instead of against the recipients. If &%-R%& is also set, both
4644 conditions must be met for a message to be selected. If either of the options
4645 has &'f'& or &'ff'& in its flags, the associated action is taken.
4646
4647 .vitem &%-Tqt%&&~<&'times'&>
4648 .oindex "&%-Tqt%&"
4649 This is an option that is exclusively for use by the Exim testing suite. It is not
4650 recognized when Exim is run normally. It allows for the setting up of explicit
4651 &"queue times"& so that various warning/retry features can be tested.
4652
4653 .vitem &%-t%&
4654 .oindex "&%-t%&"
4655 .cindex "recipient" "extracting from header lines"
4656 .cindex "&'Bcc:'& header line"
4657 .cindex "&'Cc:'& header line"
4658 .cindex "&'To:'& header line"
4659 When Exim is receiving a locally-generated, non-SMTP message on its standard
4660 input, the &%-t%& option causes the recipients of the message to be obtained
4661 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4662 from the command arguments. The addresses are extracted before any rewriting
4663 takes place and the &'Bcc:'& header line, if present, is then removed.
4664
4665 .cindex "Sendmail compatibility" "&%-t%& option"
4666 If the command has any arguments, they specify addresses to which the message
4667 is &'not'& to be delivered. That is, the argument addresses are removed from
4668 the recipients list obtained from the headers. This is compatible with Smail 3
4669 and in accordance with the documented behaviour of several versions of
4670 Sendmail, as described in man pages on a number of operating systems (e.g.
4671 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4672 argument addresses to those obtained from the headers, and the O'Reilly
4673 Sendmail book documents it that way. Exim can be made to add argument addresses
4674 instead of subtracting them by setting the option
4675 &%extract_addresses_remove_arguments%& false.
4676
4677 .cindex "&%Resent-%& header lines" "with &%-t%&"
4678 If there are any &%Resent-%& header lines in the message, Exim extracts
4679 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4680 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4681 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4682 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4683
4684 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4685 message is resent several times). The RFC also specifies that they should be
4686 added at the front of the message, and separated by &'Received:'& lines. It is
4687 not at all clear how &%-t%& should operate in the present of multiple sets,
4688 nor indeed exactly what constitutes a &"set"&.
4689 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4690 are often added at the end of the header, and if a message is resent more than
4691 once, it is common for the original set of &%Resent-%& headers to be renamed as
4692 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4693
4694 .vitem &%-ti%&
4695 .oindex "&%-ti%&"
4696 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4697 compatibility with Sendmail.
4698
4699 .vitem &%-tls-on-connect%&
4700 .oindex "&%-tls-on-connect%&"
4701 .cindex "TLS" "use without STARTTLS"
4702 .cindex "TLS" "automatic start"
4703 This option is available when Exim is compiled with TLS support. It forces all
4704 incoming SMTP connections to behave as if the incoming port is listed in the
4705 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4706 &<<CHAPTLS>>& for further details.
4707
4708
4709 .vitem &%-U%&
4710 .oindex "&%-U%&"
4711 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4712 Sendmail uses this option for &"initial message submission"&, and its
4713 documentation states that in future releases, it may complain about
4714 syntactically invalid messages rather than fixing them when this flag is not
4715 set. Exim ignores this option.
4716
4717 .vitem &%-v%&
4718 .oindex "&%-v%&"
4719 This option causes Exim to write information to the standard error stream,
4720 describing what it is doing. In particular, it shows the log lines for
4721 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4722 dialogue is shown. Some of the log lines shown may not actually be written to
4723 the log if the setting of &%log_selector%& discards them. Any relevant
4724 selectors are shown with each log line. If none are shown, the logging is
4725 unconditional.
4726
4727 .vitem &%-x%&
4728 .oindex "&%-x%&"
4729 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4730 National Language Support extended characters in the body of the mail item"&).
4731 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4732 this option.
4733
4734 .vitem &%-X%&&~<&'logfile'&>
4735 .oindex "&%-X%&"
4736 This option is interpreted by Sendmail to cause debug information to be sent
4737 to the named file.  It is ignored by Exim.
4738
4739 .vitem &%-z%&&~<&'log-line'&>
4740 .oindex "&%-z%&"
4741 This option writes its argument to Exim's logfile.
4742 Use is restricted to administrators; the intent is for operational notes.
4743 Quotes should be used to maintain a multi-word item as a single argument,
4744 under most shells.
4745 .endlist
4746
4747 .ecindex IIDclo1
4748 .ecindex IIDclo2
4749
4750
4751 . ////////////////////////////////////////////////////////////////////////////
4752 . Insert a stylized DocBook comment here, to identify the end of the command
4753 . line options. This is for the benefit of the Perl script that automatically
4754 . creates a man page for the options.
4755 . ////////////////////////////////////////////////////////////////////////////
4756
4757 .literal xml
4758 <!-- === End of command line options === -->
4759 .literal off
4760
4761
4762
4763
4764
4765 . ////////////////////////////////////////////////////////////////////////////
4766 . ////////////////////////////////////////////////////////////////////////////
4767
4768
4769 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4770          "The runtime configuration file"
4771
4772 .cindex "run time configuration"
4773 .cindex "configuration file" "general description"
4774 .cindex "CONFIGURE_FILE"
4775 .cindex "configuration file" "errors in"
4776 .cindex "error" "in configuration file"
4777 .cindex "return code" "for bad configuration"
4778 Exim uses a single run time configuration file that is read whenever an Exim
4779 binary is executed. Note that in normal operation, this happens frequently,
4780 because Exim is designed to operate in a distributed manner, without central
4781 control.
4782
4783 If a syntax error is detected while reading the configuration file, Exim
4784 writes a message on the standard error, and exits with a non-zero return code.
4785 The message is also written to the panic log. &*Note*&: Only simple syntax
4786 errors can be detected at this time. The values of any expanded options are
4787 not checked until the expansion happens, even when the expansion does not
4788 actually alter the string.
4789
4790 The name of the configuration file is compiled into the binary for security
4791 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4792 most configurations, this specifies a single file. However, it is permitted to
4793 give a colon-separated list of file names, in which case Exim uses the first
4794 existing file in the list.
4795
4796 .cindex "EXIM_USER"
4797 .cindex "EXIM_GROUP"
4798 .cindex "CONFIGURE_OWNER"
4799 .cindex "CONFIGURE_GROUP"
4800 .cindex "configuration file" "ownership"
4801 .cindex "ownership" "configuration file"
4802 The run time configuration file must be owned by root or by the user that is
4803 specified at compile time by the CONFIGURE_OWNER option (if set). The
4804 configuration file must not be world-writeable, or group-writeable unless its
4805 group is the root group or the one specified at compile time by the
4806 CONFIGURE_GROUP option.
4807
4808 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4809 to root, anybody who is able to edit the run time configuration file has an
4810 easy way to run commands as root. If you specify a user or group in the
4811 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4812 who are members of that group will trivially be able to obtain root privileges.
4813
4814 Up to Exim version 4.72, the run time configuration file was also permitted to
4815 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4816 since it offered a simple privilege escalation for any attacker who managed to
4817 compromise the Exim user account.
4818
4819 A default configuration file, which will work correctly in simple situations,
4820 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4821 defines just one file name, the installation process copies the default
4822 configuration to a new file of that name if it did not previously exist. If
4823 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4824 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4825 configuration.
4826
4827
4828
4829 .section "Using a different configuration file" "SECID40"
4830 .cindex "configuration file" "alternate"
4831 A one-off alternate configuration can be specified by the &%-C%& command line
4832 option, which may specify a single file or a list of files. However, when
4833 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4834 unless the argument for &%-C%& is identical to the built-in value from
4835 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4836 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4837 is useful mainly for checking the syntax of configuration files before
4838 installing them. No owner or group checks are done on a configuration file
4839 specified by &%-C%&, if root privilege has been dropped.
4840
4841 Even the Exim user is not trusted to specify an arbitrary configuration file
4842 with the &%-C%& option to be used with root privileges, unless that file is
4843 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4844 testing a configuration using &%-C%& right through message reception and
4845 delivery, even if the caller is root. The reception works, but by that time,
4846 Exim is running as the Exim user, so when it re-execs to regain privilege for
4847 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4848 can test reception and delivery using two separate commands (one to put a
4849 message on the queue, using &%-odq%&, and another to do the delivery, using
4850 &%-M%&).
4851
4852 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4853 prefix string with which any file named in a &%-C%& command line option must
4854 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4855 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4856 name can be used with &%-C%&.
4857
4858 One-off changes to a configuration can be specified by the &%-D%& command line
4859 option, which defines and overrides values for macros used inside the
4860 configuration file. However, like &%-C%&, the use of this option by a
4861 non-privileged user causes Exim to discard its root privilege.
4862 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4863 completely disabled, and its use causes an immediate error exit.
4864
4865 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4866 to declare certain macro names trusted, such that root privilege will not
4867 necessarily be discarded.
4868 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4869 considered safe and, if &%-D%& only supplies macros from this list, and the
4870 values are acceptable, then Exim will not give up root privilege if the caller
4871 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4872 transition mechanism and is expected to be removed in the future.  Acceptable
4873 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4874
4875 Some sites may wish to use the same Exim binary on different machines that
4876 share a file system, but to use different configuration files on each machine.
4877 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4878 looks for a file whose name is the configuration file name followed by a dot
4879 and the machine's node name, as obtained from the &[uname()]& function. If this
4880 file does not exist, the standard name is tried. This processing occurs for
4881 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4882
4883 In some esoteric situations different versions of Exim may be run under
4884 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4885 help with this. See the comments in &_src/EDITME_& for details.
4886
4887
4888
4889 .section "Configuration file format" "SECTconffilfor"
4890 .cindex "configuration file" "format of"
4891 .cindex "format" "configuration file"
4892 Exim's configuration file is divided into a number of different parts. General
4893 option settings must always appear at the start of the file. The other parts
4894 are all optional, and may appear in any order. Each part other than the first
4895 is introduced by the word &"begin"& followed by at least one literal
4896 space, and the name of the part. The optional parts are:
4897
4898 .ilist
4899 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4900 &<<CHAPACL>>&).
4901 .next
4902 .cindex "AUTH" "configuration"
4903 &'authenticators'&: Configuration settings for the authenticator drivers. These
4904 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4905 .next
4906 &'routers'&: Configuration settings for the router drivers. Routers process
4907 addresses and determine how the message is to be delivered (see chapters
4908 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4909 .next
4910 &'transports'&: Configuration settings for the transport drivers. Transports
4911 define mechanisms for copying messages to destinations (see chapters
4912 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4913 .next
4914 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4915 If there is no retry section, or if it is empty (that is, no retry rules are
4916 defined), Exim will not retry deliveries. In this situation, temporary errors
4917 are treated the same as permanent errors. Retry rules are discussed in chapter
4918 &<<CHAPretry>>&.
4919 .next
4920 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4921 when new addresses are generated during delivery. Rewriting is discussed in
4922 chapter &<<CHAPrewrite>>&.
4923 .next
4924 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4925 want to use this feature, you must set
4926 .code
4927 LOCAL_SCAN_HAS_OPTIONS=yes
4928 .endd
4929 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4930 facility are given in chapter &<<CHAPlocalscan>>&.
4931 .endlist
4932
4933 .cindex "configuration file" "leading white space in"
4934 .cindex "configuration file" "trailing white space in"
4935 .cindex "white space" "in configuration file"
4936 Leading and trailing white space in configuration lines is always ignored.
4937
4938 Blank lines in the file, and lines starting with a # character (ignoring
4939 leading white space) are treated as comments and are ignored. &*Note*&: A
4940 # character other than at the beginning of a line is not treated specially,
4941 and does not introduce a comment.
4942
4943 Any non-comment line can be continued by ending it with a backslash. Note that
4944 the general rule for white space means that trailing white space after the
4945 backslash and leading white space at the start of continuation
4946 lines is ignored. Comment lines beginning with # (but not empty lines) may
4947 appear in the middle of a sequence of continuation lines.
4948
4949 A convenient way to create a configuration file is to start from the
4950 default, which is supplied in &_src/configure.default_&, and add, delete, or
4951 change settings as required.
4952
4953 The ACLs, retry rules, and rewriting rules have their own syntax which is
4954 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4955 respectively. The other parts of the configuration file have some syntactic
4956 items in common, and these are described below, from section &<<SECTcos>>&
4957 onwards. Before that, the inclusion, macro, and conditional facilities are
4958 described.
4959
4960
4961
4962 .section "File inclusions in the configuration file" "SECID41"
4963 .cindex "inclusions in configuration file"
4964 .cindex "configuration file" "including other files"
4965 .cindex "&`.include`& in configuration file"
4966 .cindex "&`.include_if_exists`& in configuration file"
4967 You can include other files inside Exim's run time configuration file by
4968 using this syntax:
4969 .display
4970 &`.include`& <&'file name'&>
4971 &`.include_if_exists`& <&'file name'&>
4972 .endd
4973 on a line by itself. Double quotes round the file name are optional. If you use
4974 the first form, a configuration error occurs if the file does not exist; the
4975 second form does nothing for non-existent files.
4976 The first form allows a relative name. It is resolved relative to
4977 the directory of the including file. For the second form an absolute file
4978 name is required.
4979
4980 Includes may be nested to any depth, but remember that Exim reads its
4981 configuration file often, so it is a good idea to keep them to a minimum.
4982 If you change the contents of an included file, you must HUP the daemon,
4983 because an included file is read only when the configuration itself is read.
4984
4985 The processing of inclusions happens early, at a physical line level, so, like
4986 comment lines, an inclusion can be used in the middle of an option setting,
4987 for example:
4988 .code
4989 hosts_lookup = a.b.c \
4990                .include /some/file
4991 .endd
4992 Include processing happens after macro processing (see below). Its effect is to
4993 process the lines of the included file as if they occurred inline where the
4994 inclusion appears.
4995
4996
4997
4998 .section "Macros in the configuration file" "SECTmacrodefs"
4999 .cindex "macro" "description of"
5000 .cindex "configuration file" "macros"
5001 If a line in the main part of the configuration (that is, before the first
5002 &"begin"& line) begins with an upper case letter, it is taken as a macro
5003 definition, and must be of the form
5004 .display
5005 <&'name'&> = <&'rest of line'&>
5006 .endd
5007 The name must consist of letters, digits, and underscores, and need not all be
5008 in upper case, though that is recommended. The rest of the line, including any
5009 continuations, is the replacement text, and has leading and trailing white
5010 space removed. Quotes are not removed. The replacement text can never end with
5011 a backslash character, but this doesn't seem to be a serious limitation.
5012
5013 Macros may also be defined between router, transport, authenticator, or ACL
5014 definitions. They may not, however, be defined within an individual driver or
5015 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5016
5017 .section "Macro substitution" "SECID42"
5018 Once a macro is defined, all subsequent lines in the file (and any included
5019 files) are scanned for the macro name; if there are several macros, the line is
5020 scanned for each in turn, in the order in which the macros are defined. The
5021 replacement text is not re-scanned for the current macro, though it is scanned
5022 for subsequently defined macros. For this reason, a macro name may not contain
5023 the name of a previously defined macro as a substring. You could, for example,
5024 define
5025 .display
5026 &`ABCD_XYZ = `&<&'something'&>
5027 &`ABCD = `&<&'something else'&>
5028 .endd
5029 but putting the definitions in the opposite order would provoke a configuration
5030 error. Macro expansion is applied to individual physical lines from the file,
5031 before checking for line continuation or file inclusion (see above). If a line
5032 consists solely of a macro name, and the expansion of the macro is empty, the
5033 line is ignored. A macro at the start of a line may turn the line into a
5034 comment line or a &`.include`& line.
5035
5036
5037 .section "Redefining macros" "SECID43"
5038 Once defined, the value of a macro can be redefined later in the configuration
5039 (or in an included file). Redefinition is specified by using &'=='& instead of
5040 &'='&. For example:
5041 .code
5042 MAC =  initial value
5043 ...
5044 MAC == updated value
5045 .endd
5046 Redefinition does not alter the order in which the macros are applied to the
5047 subsequent lines of the configuration file. It is still the same order in which
5048 the macros were originally defined. All that changes is the macro's value.
5049 Redefinition makes it possible to accumulate values. For example:
5050 .code
5051 MAC =  initial value
5052 ...
5053 MAC == MAC and something added
5054 .endd
5055 This can be helpful in situations where the configuration file is built
5056 from a number of other files.
5057
5058 .section "Overriding macro values" "SECID44"
5059 The values set for macros in the configuration file can be overridden by the
5060 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5061 used, unless called by root or the Exim user. A definition on the command line
5062 using the &%-D%& option causes all definitions and redefinitions within the
5063 file to be ignored.
5064
5065
5066
5067 .section "Example of macro usage" "SECID45"
5068 As an example of macro usage, consider a configuration where aliases are looked
5069 up in a MySQL database. It helps to keep the file less cluttered if long
5070 strings such as SQL statements are defined separately as macros, for example:
5071 .code
5072 ALIAS_QUERY = select mailbox from user where \
5073               login='${quote_mysql:$local_part}';
5074 .endd
5075 This can then be used in a &(redirect)& router setting like this:
5076 .code
5077 data = ${lookup mysql{ALIAS_QUERY}}
5078 .endd
5079 In earlier versions of Exim macros were sometimes used for domain, host, or
5080 address lists. In Exim 4 these are handled better by named lists &-- see
5081 section &<<SECTnamedlists>>&.
5082
5083
5084 .section "Builtin macros" "SECTbuiltinmacros"
5085 Exim defines some macros depending on facilities available, which may
5086 differ due to build-time definitions and from one release to another.
5087 All of these macros start with an underscore.
5088 They can be used to conditionally include parts of a configuration
5089 (see below).
5090
5091 The following classes of macros are defined:
5092 .display
5093 &` _HAVE_*                    `&  build-time defines
5094 &` _DRIVER_ROUTER_*           `&  router drivers
5095 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5096 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5097 &` _LOG_*                     `&  log_selector values
5098 &` _OPT_MAIN_*                `&  main config options
5099 &` _OPT_ROUTERS_*             `&  generic router options
5100 &` _OPT_TRANSPORTS_*          `&  generic transport options
5101 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5102 &` _OPT_ROUTER_*_*            `&  private router options
5103 &` _OPT_TRANSPORT_*_*         `&  private transport options
5104 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5105 .endd
5106
5107 Use an &"exim -bP macros"& command to get the list of macros.
5108
5109
5110 .section "Conditional skips in the configuration file" "SECID46"
5111 .cindex "configuration file" "conditional skips"
5112 .cindex "&`.ifdef`&"
5113 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5114 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5115 portions of the configuration file. The processing happens whenever the file is
5116 read (that is, when an Exim binary starts to run).
5117
5118 The implementation is very simple. Instances of the first four directives must
5119 be followed by text that includes the names of one or macros. The condition
5120 that is tested is whether or not any macro substitution has taken place in the
5121 line. Thus:
5122 .code
5123 .ifdef AAA
5124 message_size_limit = 50M
5125 .else
5126 message_size_limit = 100M
5127 .endif
5128 .endd
5129 sets a message size limit of 50M if the macro &`AAA`& is defined
5130 (or &`A`& or &`AA`&), and 100M
5131 otherwise. If there is more than one macro named on the line, the condition
5132 is true if any of them are defined. That is, it is an &"or"& condition. To
5133 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5134
5135 Although you can use a macro expansion to generate one of these directives,
5136 it is not very useful, because the condition &"there was a macro substitution
5137 in this line"& will always be true.
5138
5139 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5140 to clarify complicated nestings.
5141
5142
5143
5144 .section "Common option syntax" "SECTcos"
5145 .cindex "common option syntax"
5146 .cindex "syntax of common options"
5147 .cindex "configuration file" "common option syntax"
5148 For the main set of options, driver options, and &[local_scan()]& options,
5149 each setting is on a line by itself, and starts with a name consisting of
5150 lower-case letters and underscores. Many options require a data value, and in
5151 these cases the name must be followed by an equals sign (with optional white
5152 space) and then the value. For example:
5153 .code
5154 qualify_domain = mydomain.example.com
5155 .endd
5156 .cindex "hiding configuration option values"
5157 .cindex "configuration options" "hiding value of"
5158 .cindex "options" "hiding value of"
5159 Some option settings may contain sensitive data, for example, passwords for
5160 accessing databases. To stop non-admin users from using the &%-bP%& command
5161 line option to read these values, you can precede the option settings with the
5162 word &"hide"&. For example:
5163 .code
5164 hide mysql_servers = localhost/users/admin/secret-password
5165 .endd
5166 For non-admin users, such options are displayed like this:
5167 .code
5168 mysql_servers = <value not displayable>
5169 .endd
5170 If &"hide"& is used on a driver option, it hides the value of that option on
5171 all instances of the same driver.
5172
5173 The following sections describe the syntax used for the different data types
5174 that are found in option settings.
5175
5176
5177 .section "Boolean options" "SECID47"
5178 .cindex "format" "boolean"
5179 .cindex "boolean configuration values"
5180 .oindex "&%no_%&&'xxx'&"
5181 .oindex "&%not_%&&'xxx'&"
5182 Options whose type is given as boolean are on/off switches. There are two
5183 different ways of specifying such options: with and without a data value. If
5184 the option name is specified on its own without data, the switch is turned on;
5185 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5186 boolean options may be followed by an equals sign and one of the words
5187 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5188 the following two settings have exactly the same effect:
5189 .code
5190 queue_only
5191 queue_only = true
5192 .endd
5193 The following two lines also have the same (opposite) effect:
5194 .code
5195 no_queue_only
5196 queue_only = false
5197 .endd
5198 You can use whichever syntax you prefer.
5199
5200
5201
5202
5203 .section "Integer values" "SECID48"
5204 .cindex "integer configuration values"
5205 .cindex "format" "integer"
5206 If an option's type is given as &"integer"&, the value can be given in decimal,
5207 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5208 number is assumed. Otherwise, it is treated as an octal number unless it starts
5209 with the characters &"0x"&, in which case the remainder is interpreted as a
5210 hexadecimal number.
5211
5212 If an integer value is followed by the letter K, it is multiplied by 1024; if
5213 it is followed by the letter M, it is multiplied by 1024x1024;
5214 if by the letter G, 1024x1024x1024.
5215 When the values
5216 of integer option settings are output, values which are an exact multiple of
5217 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5218 and M. The printing style is independent of the actual input format that was
5219 used.
5220
5221
5222 .section "Octal integer values" "SECID49"
5223 .cindex "integer format"
5224 .cindex "format" "octal integer"
5225 If an option's type is given as &"octal integer"&, its value is always
5226 interpreted as an octal number, whether or not it starts with the digit zero.
5227 Such options are always output in octal.
5228
5229
5230 .section "Fixed point numbers" "SECID50"
5231 .cindex "fixed point configuration values"
5232 .cindex "format" "fixed point"
5233 If an option's type is given as &"fixed-point"&, its value must be a decimal
5234 integer, optionally followed by a decimal point and up to three further digits.
5235
5236
5237
5238 .section "Time intervals" "SECTtimeformat"
5239 .cindex "time interval" "specifying in configuration"
5240 .cindex "format" "time interval"
5241 A time interval is specified as a sequence of numbers, each followed by one of
5242 the following letters, with no intervening white space:
5243
5244 .table2 30pt
5245 .irow &%s%& seconds
5246 .irow &%m%& minutes
5247 .irow &%h%& hours
5248 .irow &%d%& days
5249 .irow &%w%& weeks
5250 .endtable
5251
5252 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5253 intervals are output in the same format. Exim does not restrict the values; it
5254 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5255
5256
5257
5258 .section "String values" "SECTstrings"
5259 .cindex "string" "format of configuration values"
5260 .cindex "format" "string"
5261 If an option's type is specified as &"string"&, the value can be specified with
5262 or without double-quotes. If it does not start with a double-quote, the value
5263 consists of the remainder of the line plus any continuation lines, starting at
5264 the first character after any leading white space, with trailing white space
5265 removed, and with no interpretation of the characters in the string. Because
5266 Exim removes comment lines (those beginning with #) at an early stage, they can
5267 appear in the middle of a multi-line string. The following two settings are
5268 therefore equivalent:
5269 .code
5270 trusted_users = uucp:mail
5271 trusted_users = uucp:\
5272                 # This comment line is ignored
5273                 mail
5274 .endd
5275 .cindex "string" "quoted"
5276 .cindex "escape characters in quoted strings"
5277 If a string does start with a double-quote, it must end with a closing
5278 double-quote, and any backslash characters other than those used for line
5279 continuation are interpreted as escape characters, as follows:
5280
5281 .table2 100pt
5282 .irow &`\\`&                     "single backslash"
5283 .irow &`\n`&                     "newline"
5284 .irow &`\r`&                     "carriage return"
5285 .irow &`\t`&                     "tab"
5286 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5287 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5288                                    character"
5289 .endtable
5290
5291 If a backslash is followed by some other character, including a double-quote
5292 character, that character replaces the pair.
5293
5294 Quoting is necessary only if you want to make use of the backslash escapes to
5295 insert special characters, or if you need to specify a value with leading or
5296 trailing spaces. These cases are rare, so quoting is almost never needed in
5297 current versions of Exim. In versions of Exim before 3.14, quoting was required
5298 in order to continue lines, so you may come across older configuration files
5299 and examples that apparently quote unnecessarily.
5300
5301
5302 .section "Expanded strings" "SECID51"
5303 .cindex "expansion" "definition of"
5304 Some strings in the configuration file are subjected to &'string expansion'&,
5305 by which means various parts of the string may be changed according to the
5306 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5307 is as just described; in particular, the handling of backslashes in quoted
5308 strings is done as part of the input process, before expansion takes place.
5309 However, backslash is also an escape character for the expander, so any
5310 backslashes that are required for that reason must be doubled if they are
5311 within a quoted configuration string.
5312
5313
5314 .section "User and group names" "SECID52"
5315 .cindex "user name" "format of"
5316 .cindex "format" "user name"
5317 .cindex "groups" "name format"
5318 .cindex "format" "group name"
5319 User and group names are specified as strings, using the syntax described
5320 above, but the strings are interpreted specially. A user or group name must
5321 either consist entirely of digits, or be a name that can be looked up using the
5322 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5323
5324
5325 .section "List construction" "SECTlistconstruct"
5326 .cindex "list" "syntax of in configuration"
5327 .cindex "format" "list item in configuration"
5328 .cindex "string" "list, definition of"
5329 The data for some configuration options is a list of items, with colon as the
5330 default separator. Many of these options are shown with type &"string list"& in
5331 the descriptions later in this document. Others are listed as &"domain list"&,
5332 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5333 are all the same; however, those other than &"string list"& are subject to
5334 particular kinds of interpretation, as described in chapter
5335 &<<CHAPdomhosaddlists>>&.
5336
5337 In all these cases, the entire list is treated as a single string as far as the
5338 input syntax is concerned. The &%trusted_users%& setting in section
5339 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5340 in a list, it must be entered as two colons. Leading and trailing white space
5341 on each item in a list is ignored. This makes it possible to include items that
5342 start with a colon, and in particular, certain forms of IPv6 address. For
5343 example, the list
5344 .code
5345 local_interfaces = 127.0.0.1 : ::::1
5346 .endd
5347 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5348
5349 &*Note*&: Although leading and trailing white space is ignored in individual
5350 list items, it is not ignored when parsing the list. The space after the first
5351 colon in the example above is necessary. If it were not there, the list would
5352 be interpreted as the two items 127.0.0.1:: and 1.
5353
5354 .section "Changing list separators" "SECTlistsepchange"
5355 .cindex "list separator" "changing"
5356 .cindex "IPv6" "addresses in lists"
5357 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5358 introduced to allow the separator character to be changed. If a list begins
5359 with a left angle bracket, followed by any punctuation character, that
5360 character is used instead of colon as the list separator. For example, the list
5361 above can be rewritten to use a semicolon separator like this:
5362 .code
5363 local_interfaces = <; 127.0.0.1 ; ::1
5364 .endd
5365 This facility applies to all lists, with the exception of the list in
5366 &%log_file_path%&. It is recommended that the use of non-colon separators be
5367 confined to circumstances where they really are needed.
5368
5369 .cindex "list separator" "newline as"
5370 .cindex "newline" "as list separator"
5371 It is also possible to use newline and other control characters (those with
5372 code values less than 32, plus DEL) as separators in lists. Such separators
5373 must be provided literally at the time the list is processed. For options that
5374 are string-expanded, you can write the separator using a normal escape
5375 sequence. This will be processed by the expander before the string is
5376 interpreted as a list. For example, if a newline-separated list of domains is
5377 generated by a lookup, you can process it directly by a line such as this:
5378 .code
5379 domains = <\n ${lookup mysql{.....}}
5380 .endd
5381 This avoids having to change the list separator in such data. You are unlikely
5382 to want to use a control character as a separator in an option that is not
5383 expanded, because the value is literal text. However, it can be done by giving
5384 the value in quotes. For example:
5385 .code
5386 local_interfaces = "<\n 127.0.0.1 \n ::1"
5387 .endd
5388 Unlike printing character separators, which can be included in list items by
5389 doubling, it is not possible to include a control character as data when it is
5390 set as the separator. Two such characters in succession are interpreted as
5391 enclosing an empty list item.
5392
5393
5394
5395 .section "Empty items in lists" "SECTempitelis"
5396 .cindex "list" "empty item in"
5397 An empty item at the end of a list is always ignored. In other words, trailing
5398 separator characters are ignored. Thus, the list in
5399 .code
5400 senders = user@domain :
5401 .endd
5402 contains only a single item. If you want to include an empty string as one item
5403 in a list, it must not be the last item. For example, this list contains three
5404 items, the second of which is empty:
5405 .code
5406 senders = user1@domain : : user2@domain
5407 .endd
5408 &*Note*&: There must be white space between the two colons, as otherwise they
5409 are interpreted as representing a single colon data character (and the list
5410 would then contain just one item). If you want to specify a list that contains
5411 just one, empty item, you can do it as in this example:
5412 .code
5413 senders = :
5414 .endd
5415 In this case, the first item is empty, and the second is discarded because it
5416 is at the end of the list.
5417
5418
5419
5420
5421 .section "Format of driver configurations" "SECTfordricon"
5422 .cindex "drivers" "configuration format"
5423 There are separate parts in the configuration for defining routers, transports,
5424 and authenticators. In each part, you are defining a number of driver
5425 instances, each with its own set of options. Each driver instance is defined by
5426 a sequence of lines like this:
5427 .display
5428 <&'instance name'&>:
5429   <&'option'&>
5430   ...
5431   <&'option'&>
5432 .endd
5433 In the following example, the instance name is &(localuser)&, and it is
5434 followed by three options settings:
5435 .code
5436 localuser:
5437   driver = accept
5438   check_local_user
5439   transport = local_delivery
5440 .endd
5441 For each driver instance, you specify which Exim code module it uses &-- by the
5442 setting of the &%driver%& option &-- and (optionally) some configuration
5443 settings. For example, in the case of transports, if you want a transport to
5444 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5445 a local file you would use the &(appendfile)& driver. Each of the drivers is
5446 described in detail in its own separate chapter later in this manual.
5447
5448 You can have several routers, transports, or authenticators that are based on
5449 the same underlying driver (each must have a different instance name).
5450
5451 The order in which routers are defined is important, because addresses are
5452 passed to individual routers one by one, in order. The order in which
5453 transports are defined does not matter at all. The order in which
5454 authenticators are defined is used only when Exim, as a client, is searching
5455 them to find one that matches an authentication mechanism offered by the
5456 server.
5457
5458 .cindex "generic options"
5459 .cindex "options" "generic &-- definition of"
5460 Within a driver instance definition, there are two kinds of option: &'generic'&
5461 and &'private'&. The generic options are those that apply to all drivers of the
5462 same type (that is, all routers, all transports or all authenticators). The
5463 &%driver%& option is a generic option that must appear in every definition.
5464 .cindex "private options"
5465 The private options are special for each driver, and none need appear, because
5466 they all have default values.
5467
5468 The options may appear in any order, except that the &%driver%& option must
5469 precede any private options, since these depend on the particular driver. For
5470 this reason, it is recommended that &%driver%& always be the first option.
5471
5472 Driver instance names, which are used for reference in log entries and
5473 elsewhere, can be any sequence of letters, digits, and underscores (starting
5474 with a letter) and must be unique among drivers of the same type. A router and
5475 a transport (for example) can each have the same name, but no two router
5476 instances can have the same name. The name of a driver instance should not be
5477 confused with the name of the underlying driver module. For example, the
5478 configuration lines:
5479 .code
5480 remote_smtp:
5481   driver = smtp
5482 .endd
5483 create an instance of the &(smtp)& transport driver whose name is
5484 &(remote_smtp)&. The same driver code can be used more than once, with
5485 different instance names and different option settings each time. A second
5486 instance of the &(smtp)& transport, with different options, might be defined
5487 thus:
5488 .code
5489 special_smtp:
5490   driver = smtp
5491   port = 1234
5492   command_timeout = 10s
5493 .endd
5494 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5495 these transport instances from routers, and these names would appear in log
5496 lines.
5497
5498 Comment lines may be present in the middle of driver specifications. The full
5499 list of option settings for any particular driver instance, including all the
5500 defaulted values, can be extracted by making use of the &%-bP%& command line
5501 option.
5502
5503
5504
5505
5506
5507
5508 . ////////////////////////////////////////////////////////////////////////////
5509 . ////////////////////////////////////////////////////////////////////////////
5510
5511 .chapter "The default configuration file" "CHAPdefconfil"
5512 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5513 .cindex "default" "configuration file &""walk through""&"
5514 The default configuration file supplied with Exim as &_src/configure.default_&
5515 is sufficient for a host with simple mail requirements. As an introduction to
5516 the way Exim is configured, this chapter &"walks through"& the default
5517 configuration, giving brief explanations of the settings. Detailed descriptions
5518 of the options are given in subsequent chapters. The default configuration file
5519 itself contains extensive comments about ways you might want to modify the
5520 initial settings. However, note that there are many options that are not
5521 mentioned at all in the default configuration.
5522
5523
5524
5525 .section "Macros" "SECTdefconfmacros"
5526 All macros should be defined before any options.
5527
5528 One macro is specified, but commented out, in the default configuration:
5529 .code
5530 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5531 .endd
5532 If all off-site mail is expected to be delivered to a "smarthost", then set the
5533 hostname here and uncomment the macro.  This will affect which router is used
5534 later on.  If this is left commented out, then Exim will perform direct-to-MX
5535 deliveries using a &(dnslookup)& router.
5536
5537 In addition to macros defined here, Exim includes a number of built-in macros
5538 to enable configuration to be guarded by a binary built with support for a
5539 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5540
5541
5542 .section "Main configuration settings" "SECTdefconfmain"
5543 The main (global) configuration option settings section must always come first
5544 in the file, after the macros.
5545 The first thing you'll see in the file, after some initial comments, is the line
5546 .code
5547 # primary_hostname =
5548 .endd
5549 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5550 to know the official, fully qualified name of your host, and this is where you
5551 can specify it. However, in most cases you do not need to set this option. When
5552 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5553
5554 The first three non-comment configuration lines are as follows:
5555 .code
5556 domainlist local_domains    = @
5557 domainlist relay_to_domains =
5558 hostlist   relay_from_hosts = 127.0.0.1
5559 .endd
5560 These are not, in fact, option settings. They are definitions of two named
5561 domain lists and one named host list. Exim allows you to give names to lists of
5562 domains, hosts, and email addresses, in order to make it easier to manage the
5563 configuration file (see section &<<SECTnamedlists>>&).
5564
5565 The first line defines a domain list called &'local_domains'&; this is used
5566 later in the configuration to identify domains that are to be delivered
5567 on the local host.
5568
5569 .cindex "@ in a domain list"
5570 There is just one item in this list, the string &"@"&. This is a special form
5571 of entry which means &"the name of the local host"&. Thus, if the local host is
5572 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5573 be delivered locally. Because the local host's name is referenced indirectly,
5574 the same configuration file can be used on different hosts.
5575
5576 The second line defines a domain list called &'relay_to_domains'&, but the
5577 list itself is empty. Later in the configuration we will come to the part that
5578 controls mail relaying through the local host; it allows relaying to any
5579 domains in this list. By default, therefore, no relaying on the basis of a mail
5580 domain is permitted.
5581
5582 The third line defines a host list called &'relay_from_hosts'&. This list is
5583 used later in the configuration to permit relaying from any host or IP address
5584 that matches the list. The default contains just the IP address of the IPv4
5585 loopback interface, which means that processes on the local host are able to
5586 submit mail for relaying by sending it over TCP/IP to that interface. No other
5587 hosts are permitted to submit messages for relaying.
5588
5589 Just to be sure there's no misunderstanding: at this point in the configuration
5590 we aren't actually setting up any controls. We are just defining some domains
5591 and hosts that will be used in the controls that are specified later.
5592
5593 The next two configuration lines are genuine option settings:
5594 .code
5595 acl_smtp_rcpt = acl_check_rcpt
5596 acl_smtp_data = acl_check_data
5597 .endd
5598 These options specify &'Access Control Lists'& (ACLs) that are to be used
5599 during an incoming SMTP session for every recipient of a message (every RCPT
5600 command), and after the contents of the message have been received,
5601 respectively. The names of the lists are &'acl_check_rcpt'& and
5602 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5603 section of the configuration. The RCPT ACL controls which recipients are
5604 accepted for an incoming message &-- if a configuration does not provide an ACL
5605 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5606 contents of a message to be checked.
5607
5608 Two commented-out option settings are next:
5609 .code
5610 # av_scanner = clamd:/tmp/clamd
5611 # spamd_address = 127.0.0.1 783
5612 .endd
5613 These are example settings that can be used when Exim is compiled with the
5614 content-scanning extension. The first specifies the interface to the virus
5615 scanner, and the second specifies the interface to SpamAssassin. Further
5616 details are given in chapter &<<CHAPexiscan>>&.
5617
5618 Three more commented-out option settings follow:
5619 .code
5620 # tls_advertise_hosts = *
5621 # tls_certificate = /etc/ssl/exim.crt
5622 # tls_privatekey = /etc/ssl/exim.pem
5623 .endd
5624 These are example settings that can be used when Exim is compiled with
5625 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5626 first one specifies the list of clients that are allowed to use TLS when
5627 connecting to this server; in this case the wildcard means all clients. The
5628 other options specify where Exim should find its TLS certificate and private
5629 key, which together prove the server's identity to any clients that connect.
5630 More details are given in chapter &<<CHAPTLS>>&.
5631
5632 Another two commented-out option settings follow:
5633 .code
5634 # daemon_smtp_ports = 25 : 465 : 587
5635 # tls_on_connect_ports = 465
5636 .endd
5637 .cindex "port" "465 and 587"
5638 .cindex "port" "for message submission"
5639 .cindex "message" "submission, ports for"
5640 .cindex "submissions protocol"
5641 .cindex "smtps protocol"
5642 .cindex "ssmtp protocol"
5643 .cindex "SMTP" "submissions protocol"
5644 .cindex "SMTP" "ssmtp protocol"
5645 .cindex "SMTP" "smtps protocol"
5646 These options provide better support for roaming users who wish to use this
5647 server for message submission. They are not much use unless you have turned on
5648 TLS (as described in the previous paragraph) and authentication (about which
5649 more in section &<<SECTdefconfauth>>&).
5650 Mail submission from mail clients (MUAs) should be separate from inbound mail
5651 to your domain (MX delivery) for various good reasons (eg, ability to impose
5652 much saner TLS protocol and ciphersuite requirements without unintended
5653 consequences).
5654 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5655 which uses STARTTLS, so this is the &"submission"& port.
5656 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5657 which should be used in preference to 587.
5658 You should also consider deploying SRV records to help clients find
5659 these ports.
5660 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5661
5662 Two more commented-out options settings follow:
5663 .code
5664 # qualify_domain =
5665 # qualify_recipient =
5666 .endd
5667 The first of these specifies a domain that Exim uses when it constructs a
5668 complete email address from a local login name. This is often needed when Exim
5669 receives a message from a local process. If you do not set &%qualify_domain%&,
5670 the value of &%primary_hostname%& is used. If you set both of these options,
5671 you can have different qualification domains for sender and recipient
5672 addresses. If you set only the first one, its value is used in both cases.
5673
5674 .cindex "domain literal" "recognizing format"
5675 The following line must be uncommented if you want Exim to recognize
5676 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5677 (an IP address within square brackets) instead of a named domain.
5678 .code
5679 # allow_domain_literals
5680 .endd
5681 The RFCs still require this form, but many people think that in the modern
5682 Internet it makes little sense to permit mail to be sent to specific hosts by
5683 quoting their IP addresses. This ancient format has been used by people who
5684 try to abuse hosts by using them for unwanted relaying. However, some
5685 people believe there are circumstances (for example, messages addressed to
5686 &'postmaster'&) where domain literals are still useful.
5687
5688 The next configuration line is a kind of trigger guard:
5689 .code
5690 never_users = root
5691 .endd
5692 It specifies that no delivery must ever be run as the root user. The normal
5693 convention is to set up &'root'& as an alias for the system administrator. This
5694 setting is a guard against slips in the configuration.
5695 The list of users specified by &%never_users%& is not, however, the complete
5696 list; the build-time configuration in &_Local/Makefile_& has an option called
5697 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5698 contents of &%never_users%& are added to this list. By default
5699 FIXED_NEVER_USERS also specifies root.
5700
5701 When a remote host connects to Exim in order to send mail, the only information
5702 Exim has about the host's identity is its IP address. The next configuration
5703 line,
5704 .code
5705 host_lookup = *
5706 .endd
5707 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5708 in order to get a host name. This improves the quality of the logging
5709 information, but if you feel it is too expensive, you can remove it entirely,
5710 or restrict the lookup to hosts on &"nearby"& networks.
5711 Note that it is not always possible to find a host name from an IP address,
5712 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5713 unreachable.
5714
5715 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5716 1413 (hence their names):
5717 .code
5718 rfc1413_hosts = *
5719 rfc1413_query_timeout = 0s
5720 .endd
5721 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5722 Few hosts offer RFC1413 service these days; calls have to be
5723 terminated by a timeout and this needlessly delays the startup
5724 of an incoming SMTP connection.
5725 If you have hosts for which you trust RFC1413 and need this
5726 information, you can change this.
5727
5728 This line enables an efficiency SMTP option.  It is negotiated by clients
5729 and not expected to cause problems but can be disabled if needed.
5730 .code
5731 prdr_enable = true
5732 .endd
5733
5734 When Exim receives messages over SMTP connections, it expects all addresses to
5735 be fully qualified with a domain, as required by the SMTP definition. However,
5736 if you are running a server to which simple clients submit messages, you may
5737 find that they send unqualified addresses. The two commented-out options:
5738 .code
5739 # sender_unqualified_hosts =
5740 # recipient_unqualified_hosts =
5741 .endd
5742 show how you can specify hosts that are permitted to send unqualified sender
5743 and recipient addresses, respectively.
5744
5745 The &%log_selector%& option is used to increase the detail of logging
5746 over the default:
5747 .code
5748 log_selector = +smtp_protocol_error +smtp_syntax_error \
5749                +tls_certificate_verified
5750 .endd
5751
5752 The &%percent_hack_domains%& option is also commented out:
5753 .code
5754 # percent_hack_domains =
5755 .endd
5756 It provides a list of domains for which the &"percent hack"& is to operate.
5757 This is an almost obsolete form of explicit email routing. If you do not know
5758 anything about it, you can safely ignore this topic.
5759
5760 The next two settings in the main part of the default configuration are
5761 concerned with messages that have been &"frozen"& on Exim's queue. When a
5762 message is frozen, Exim no longer continues to try to deliver it. Freezing
5763 occurs when a bounce message encounters a permanent failure because the sender
5764 address of the original message that caused the bounce is invalid, so the
5765 bounce cannot be delivered. This is probably the most common case, but there
5766 are also other conditions that cause freezing, and frozen messages are not
5767 always bounce messages.
5768 .code
5769 ignore_bounce_errors_after = 2d
5770 timeout_frozen_after = 7d
5771 .endd
5772 The first of these options specifies that failing bounce messages are to be
5773 discarded after 2 days on the queue. The second specifies that any frozen
5774 message (whether a bounce message or not) is to be timed out (and discarded)
5775 after a week. In this configuration, the first setting ensures that no failing
5776 bounce message ever lasts a week.
5777
5778 Exim queues it's messages in a spool directory. If you expect to have
5779 large queues, you may consider using this option. It splits the spool
5780 directory into subdirectories to avoid file system degradation from
5781 many files in a single directory, resulting in better performance.
5782 Manual manipulation of queued messages becomes more complex (though fortunately
5783 not often needed).
5784 .code
5785 # split_spool_directory = true
5786 .endd
5787
5788 In an ideal world everybody follows the standards. For non-ASCII
5789 messages RFC 2047 is a standard, allowing a maximum line length of 76
5790 characters. Exim adheres that standard and won't process messages which
5791 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5792 In particular, the Exim maintainers have had multiple reports of
5793 problems from Russian administrators of issues until they disable this
5794 check, because of some popular, yet buggy, mail composition software.
5795 .code
5796 # check_rfc2047_length = false
5797 .endd
5798
5799 If you need to be strictly RFC compliant you may wish to disable the
5800 8BITMIME advertisement. Use this, if you exchange mails with systems
5801 that are not 8-bit clean.
5802 .code
5803 # accept_8bitmime = false
5804 .endd
5805
5806 Libraries you use may depend on specific environment settings.  This
5807 imposes a security risk (e.g. PATH). There are two lists:
5808 &%keep_environment%& for the variables to import as they are, and
5809 &%add_environment%& for variables we want to set to a fixed value.
5810 Note that TZ is handled separately, by the $%timezone%$ runtime
5811 option and by the TIMEZONE_DEFAULT buildtime option.
5812 .code
5813 # keep_environment = ^LDAP
5814 # add_environment = PATH=/usr/bin::/bin
5815 .endd
5816
5817
5818 .section "ACL configuration" "SECID54"
5819 .cindex "default" "ACLs"
5820 .cindex "&ACL;" "default configuration"
5821 In the default configuration, the ACL section follows the main configuration.
5822 It starts with the line
5823 .code
5824 begin acl
5825 .endd
5826 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5827 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5828 and &%acl_smtp_data%& above.
5829
5830 .cindex "RCPT" "ACL for"
5831 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5832 RCPT command specifies one of the message's recipients. The ACL statements
5833 are considered in order, until the recipient address is either accepted or
5834 rejected. The RCPT command is then accepted or rejected, according to the
5835 result of the ACL processing.
5836 .code
5837 acl_check_rcpt:
5838 .endd
5839 This line, consisting of a name terminated by a colon, marks the start of the
5840 ACL, and names it.
5841 .code
5842 accept  hosts = :
5843 .endd
5844 This ACL statement accepts the recipient if the sending host matches the list.
5845 But what does that strange list mean? It doesn't actually contain any host
5846 names or IP addresses. The presence of the colon puts an empty item in the
5847 list; Exim matches this only if the incoming message did not come from a remote
5848 host, because in that case, the remote hostname is empty. The colon is
5849 important. Without it, the list itself is empty, and can never match anything.
5850
5851 What this statement is doing is to accept unconditionally all recipients in
5852 messages that are submitted by SMTP from local processes using the standard
5853 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5854 manner.
5855 .code
5856 deny    message       = Restricted characters in address
5857         domains       = +local_domains
5858         local_parts   = ^[.] : ^.*[@%!/|]
5859
5860 deny    message       = Restricted characters in address
5861         domains       = !+local_domains
5862         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5863 .endd
5864 These statements are concerned with local parts that contain any of the
5865 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5866 Although these characters are entirely legal in local parts (in the case of
5867 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5868 in Internet mail addresses.
5869
5870 The first three have in the past been associated with explicitly routed
5871 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5872 option). Addresses containing these characters are regularly tried by spammers
5873 in an attempt to bypass relaying restrictions, and also by open relay testing
5874 programs. Unless you really need them it is safest to reject these characters
5875 at this early stage. This configuration is heavy-handed in rejecting these
5876 characters for all messages it accepts from remote hosts. This is a deliberate
5877 policy of being as safe as possible.
5878
5879 The first rule above is stricter, and is applied to messages that are addressed
5880 to one of the local domains handled by this host. This is implemented by the
5881 first condition, which restricts it to domains that are listed in the
5882 &'local_domains'& domain list. The &"+"& character is used to indicate a
5883 reference to a named list. In this configuration, there is just one domain in
5884 &'local_domains'&, but in general there may be many.
5885
5886 The second condition on the first statement uses two regular expressions to
5887 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5888 or &"|"&. If you have local accounts that include these characters, you will
5889 have to modify this rule.
5890
5891 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5892 allows them because they have been encountered in practice. (Consider the
5893 common convention of local parts constructed as
5894 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5895 the author of Exim, who has no second initial.) However, a local part starting
5896 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5897 file name (for example, for a mailing list). This is also true for local parts
5898 that contain slashes. A pipe symbol can also be troublesome if the local part
5899 is incorporated unthinkingly into a shell command line.
5900
5901 The second rule above applies to all other domains, and is less strict. This
5902 allows your own users to send outgoing messages to sites that use slashes
5903 and vertical bars in their local parts. It blocks local parts that begin
5904 with a dot, slash, or vertical bar, but allows these characters within the
5905 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5906 and &"!"& is blocked, as before. The motivation here is to prevent your users
5907 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5908 .code
5909 accept  local_parts   = postmaster
5910         domains       = +local_domains
5911 .endd
5912 This statement, which has two conditions, accepts an incoming address if the
5913 local part is &'postmaster'& and the domain is one of those listed in the
5914 &'local_domains'& domain list. The &"+"& character is used to indicate a
5915 reference to a named list. In this configuration, there is just one domain in
5916 &'local_domains'&, but in general there may be many.
5917
5918 The presence of this statement means that mail to postmaster is never blocked
5919 by any of the subsequent tests. This can be helpful while sorting out problems
5920 in cases where the subsequent tests are incorrectly denying access.
5921 .code
5922 require verify        = sender
5923 .endd
5924 This statement requires the sender address to be verified before any subsequent
5925 ACL statement can be used. If verification fails, the incoming recipient
5926 address is refused. Verification consists of trying to route the address, to
5927 see if a bounce message could be delivered to it. In the case of remote
5928 addresses, basic verification checks only the domain, but &'callouts'& can be
5929 used for more verification if required. Section &<<SECTaddressverification>>&
5930 discusses the details of address verification.
5931 .code
5932 accept  hosts         = +relay_from_hosts
5933         control       = submission
5934 .endd
5935 This statement accepts the address if the message is coming from one of the
5936 hosts that are defined as being allowed to relay through this host. Recipient
5937 verification is omitted here, because in many cases the clients are dumb MUAs
5938 that do not cope well with SMTP error responses. For the same reason, the
5939 second line specifies &"submission mode"& for messages that are accepted. This
5940 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5941 messages that are deficient in some way, for example, because they lack a
5942 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5943 probably add recipient verification here, and disable submission mode.
5944 .code
5945 accept  authenticated = *
5946         control       = submission
5947 .endd
5948 This statement accepts the address if the client host has authenticated itself.
5949 Submission mode is again specified, on the grounds that such messages are most
5950 likely to come from MUAs. The default configuration does not define any
5951 authenticators, though it does include some nearly complete commented-out
5952 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5953 fact authenticate until you complete the authenticator definitions.
5954 .code
5955 require message = relay not permitted
5956         domains = +local_domains : +relay_to_domains
5957 .endd
5958 This statement rejects the address if its domain is neither a local domain nor
5959 one of the domains for which this host is a relay.
5960 .code
5961 require verify = recipient
5962 .endd
5963 This statement requires the recipient address to be verified; if verification
5964 fails, the address is rejected.
5965 .code
5966 # deny    message     = rejected because $sender_host_address \
5967 #                       is in a black list at $dnslist_domain\n\
5968 #                       $dnslist_text
5969 #         dnslists    = black.list.example
5970 #
5971 # warn    dnslists    = black.list.example
5972 #         add_header  = X-Warning: $sender_host_address is in \
5973 #                       a black list at $dnslist_domain
5974 #         log_message = found in $dnslist_domain
5975 .endd
5976 These commented-out lines are examples of how you could configure Exim to check
5977 sending hosts against a DNS black list. The first statement rejects messages
5978 from blacklisted hosts, whereas the second just inserts a warning header
5979 line.
5980 .code
5981 # require verify = csa
5982 .endd
5983 This commented-out line is an example of how you could turn on client SMTP
5984 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5985 records.
5986 .code
5987 accept
5988 .endd
5989 The final statement in the first ACL unconditionally accepts any recipient
5990 address that has successfully passed all the previous tests.
5991 .code
5992 acl_check_data:
5993 .endd
5994 This line marks the start of the second ACL, and names it. Most of the contents
5995 of this ACL are commented out:
5996 .code
5997 # deny    malware   = *
5998 #         message   = This message contains a virus \
5999 #                     ($malware_name).
6000 .endd
6001 These lines are examples of how to arrange for messages to be scanned for
6002 viruses when Exim has been compiled with the content-scanning extension, and a
6003 suitable virus scanner is installed. If the message is found to contain a
6004 virus, it is rejected with the given custom error message.
6005 .code
6006 # warn    spam      = nobody
6007 #         message   = X-Spam_score: $spam_score\n\
6008 #                     X-Spam_score_int: $spam_score_int\n\
6009 #                     X-Spam_bar: $spam_bar\n\
6010 #                     X-Spam_report: $spam_report
6011 .endd
6012 These lines are an example of how to arrange for messages to be scanned by
6013 SpamAssassin when Exim has been compiled with the content-scanning extension,
6014 and SpamAssassin has been installed. The SpamAssassin check is run with
6015 &`nobody`& as its user parameter, and the results are added to the message as a
6016 series of extra header line. In this case, the message is not rejected,
6017 whatever the spam score.
6018 .code
6019 accept
6020 .endd
6021 This final line in the DATA ACL accepts the message unconditionally.
6022
6023
6024 .section "Router configuration" "SECID55"
6025 .cindex "default" "routers"
6026 .cindex "routers" "default"
6027 The router configuration comes next in the default configuration, introduced
6028 by the line
6029 .code
6030 begin routers
6031 .endd
6032 Routers are the modules in Exim that make decisions about where to send
6033 messages. An address is passed to each router in turn, until it is either
6034 accepted, or failed. This means that the order in which you define the routers
6035 matters. Each router is fully described in its own chapter later in this
6036 manual. Here we give only brief overviews.
6037 .code
6038 # domain_literal:
6039 #   driver = ipliteral
6040 #   domains = !+local_domains
6041 #   transport = remote_smtp
6042 .endd
6043 .cindex "domain literal" "default router"
6044 This router is commented out because the majority of sites do not want to
6045 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6046 you uncomment this router, you also need to uncomment the setting of
6047 &%allow_domain_literals%& in the main part of the configuration.
6048
6049 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6050 macro has been defined, per
6051 .code
6052 .ifdef ROUTER_SMARTHOST
6053 smarthost:
6054 #...
6055 .else
6056 dnslookup:
6057 #...
6058 .endif
6059 .endd
6060
6061 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6062 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6063 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6064 skip these routers because of the &%domains%& option.
6065
6066 .code
6067 smarthost:
6068   driver = manualroute
6069   domains = ! +local_domains
6070   transport = smarthost_smtp
6071   route_data = ROUTER_SMARTHOST
6072   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6073   no_more
6074 .endd
6075 This router only handles mail which is not to any local domains; this is
6076 specified by the line
6077 .code
6078 domains = ! +local_domains
6079 .endd
6080 The &%domains%& option lists the domains to which this router applies, but the
6081 exclamation mark is a negation sign, so the router is used only for domains
6082 that are not in the domain list called &'local_domains'& (which was defined at
6083 the start of the configuration). The plus sign before &'local_domains'&
6084 indicates that it is referring to a named list. Addresses in other domains are
6085 passed on to the following routers.
6086
6087 The name of the router driver is &(manualroute)& because we are manually
6088 specifying how mail should be routed onwards, instead of using DNS MX.
6089 While the name of this router instance is arbitrary, the &%driver%& option must
6090 be one of the driver modules that is in the Exim binary.
6091
6092 With no pre-conditions other than &%domains%&, all mail for non-local domains
6093 will be handled by this router, and the &%no_more%& setting will ensure that no
6094 other routers will be used for messages matching the pre-conditions.  See
6095 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6096 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6097 and the macro supplies the value; the address is then queued for the
6098 &(smarthost_smtp)& transport.
6099
6100 .code
6101 dnslookup:
6102   driver = dnslookup
6103   domains = ! +local_domains
6104   transport = remote_smtp
6105   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6106   no_more
6107 .endd
6108 The &%domains%& option behaves as per smarthost, above.
6109
6110 The name of the router driver is &(dnslookup)&,
6111 and is specified by the &%driver%& option. Do not be confused by the fact that
6112 the name of this router instance is the same as the name of the driver. The
6113 instance name is arbitrary, but the name set in the &%driver%& option must be
6114 one of the driver modules that is in the Exim binary.
6115
6116 The &(dnslookup)& router routes addresses by looking up their domains in the
6117 DNS in order to obtain a list of hosts to which the address is routed. If the
6118 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6119 specified by the &%transport%& option. If the router does not find the domain
6120 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6121 the address fails and is bounced.
6122
6123 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6124 be entirely ignored. This option is present because a number of cases have been
6125 encountered where MX records in the DNS point to host names
6126 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6127 Completely ignoring these IP addresses causes Exim to fail to route the
6128 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6129 continue to try to deliver the message periodically until the address timed
6130 out.
6131 .code
6132 system_aliases:
6133   driver = redirect
6134   allow_fail
6135   allow_defer
6136   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6137 # user = exim
6138   file_transport = address_file
6139   pipe_transport = address_pipe
6140 .endd
6141 Control reaches this and subsequent routers only for addresses in the local
6142 domains. This router checks to see whether the local part is defined as an
6143 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6144 data that it looks up from that file. If no data is found for the local part,
6145 the value of the &%data%& option is empty, causing the address to be passed to
6146 the next router.
6147
6148 &_/etc/aliases_& is a conventional name for the system aliases file that is
6149 often used. That is why it is referenced by from the default configuration
6150 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6151 &_Local/Makefile_& before building Exim.
6152 .code
6153 userforward:
6154   driver = redirect
6155   check_local_user
6156 # local_part_suffix = +* : -*
6157 # local_part_suffix_optional
6158   file = $home/.forward
6159 # allow_filter
6160   no_verify
6161   no_expn
6162   check_ancestor
6163   file_transport = address_file
6164   pipe_transport = address_pipe
6165   reply_transport = address_reply
6166 .endd
6167 This is the most complicated router in the default configuration. It is another
6168 redirection router, but this time it is looking for forwarding data set up by
6169 individual users. The &%check_local_user%& setting specifies a check that the
6170 local part of the address is the login name of a local user. If it is not, the
6171 router is skipped. The two commented options that follow &%check_local_user%&,
6172 namely:
6173 .code
6174 # local_part_suffix = +* : -*
6175 # local_part_suffix_optional
6176 .endd
6177 .vindex "&$local_part_suffix$&"
6178 show how you can specify the recognition of local part suffixes. If the first
6179 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6180 by any sequence of characters, is removed from the local part and placed in the
6181 variable &$local_part_suffix$&. The second suffix option specifies that the
6182 presence of a suffix in the local part is optional. When a suffix is present,
6183 the check for a local login uses the local part with the suffix removed.
6184
6185 When a local user account is found, the file called &_.forward_& in the user's
6186 home directory is consulted. If it does not exist, or is empty, the router
6187 declines. Otherwise, the contents of &_.forward_& are interpreted as
6188 redirection data (see chapter &<<CHAPredirect>>& for more details).
6189
6190 .cindex "Sieve filter" "enabling in default router"
6191 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6192 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6193 is commented out by default), the contents of the file are interpreted as a set
6194 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6195 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6196 separate document entitled &'Exim's interfaces to mail filtering'&.
6197
6198 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6199 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6200 There are two reasons for doing this:
6201
6202 .olist
6203 Whether or not a local user has a &_.forward_& file is not really relevant when
6204 checking an address for validity; it makes sense not to waste resources doing
6205 unnecessary work.
6206 .next
6207 More importantly, when Exim is verifying addresses or handling an EXPN
6208 command during an SMTP session, it is running as the Exim user, not as root.
6209 The group is the Exim group, and no additional groups are set up.
6210 It may therefore not be possible for Exim to read users' &_.forward_& files at
6211 this time.
6212 .endlist
6213
6214 The setting of &%check_ancestor%& prevents the router from generating a new
6215 address that is the same as any previous address that was redirected. (This
6216 works round a problem concerning a bad interaction between aliasing and
6217 forwarding &-- see section &<<SECTredlocmai>>&).
6218
6219 The final three option settings specify the transports that are to be used when
6220 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6221 auto-reply, respectively. For example, if a &_.forward_& file contains
6222 .code
6223 a.nother@elsewhere.example, /home/spqr/archive
6224 .endd
6225 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6226 transport.
6227 .code
6228 localuser:
6229   driver = accept
6230   check_local_user
6231 # local_part_suffix = +* : -*
6232 # local_part_suffix_optional
6233   transport = local_delivery
6234 .endd
6235 The final router sets up delivery into local mailboxes, provided that the local
6236 part is the name of a local login, by accepting the address and assigning it to
6237 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6238 routers, so the address is bounced. The commented suffix settings fulfil the
6239 same purpose as they do for the &(userforward)& router.
6240
6241
6242 .section "Transport configuration" "SECID56"
6243 .cindex "default" "transports"
6244 .cindex "transports" "default"
6245 Transports define mechanisms for actually delivering messages. They operate
6246 only when referenced from routers, so the order in which they are defined does
6247 not matter. The transports section of the configuration starts with
6248 .code
6249 begin transports
6250 .endd
6251 Two remote transports and four local transports are defined.
6252 .code
6253 remote_smtp:
6254   driver = smtp
6255   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6256 .ifdef _HAVE_DANE
6257   dnssec_request_domains = *
6258   hosts_try_dane = *
6259 .endif
6260 .endd
6261 This transport is used for delivering messages over SMTP connections.
6262 The list of remote hosts comes from the router.
6263 The &%message_size_limit%& usage is a hack to avoid sending on messages
6264 with over-long lines.  The built-in macro _HAVE_DANE guards configuration
6265 to try to use DNSSEC for all queries and to use DANE for delivery;
6266 see section &<<SECDANE>>& for more details.
6267
6268 The other remote transport is used when delivering to a specific smarthost
6269 with whom there must be some kind of existing relationship, instead of the
6270 usual federated system.
6271
6272 .code
6273 smarthost_smtp:
6274   driver = smtp
6275   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6276   multi_domain
6277   #
6278 .ifdef _HAVE_TLS
6279   # Comment out any of these which you have to, then file a Support
6280   # request with your smarthost provider to get things fixed:
6281   hosts_require_tls = *
6282   tls_verify_hosts = *
6283   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6284   # have to comment it out then this will at least log whether you succeed
6285   # or not:
6286   tls_try_verify_hosts = *
6287   #
6288   # The SNI name should match the name which we'll expect to verify;
6289   # many mail systems don't use SNI and this doesn't matter, but if it does,
6290   # we need to send a name which the remote site will recognize.
6291   # This _should_ be the name which the smarthost operators specified as
6292   # the hostname for sending your mail to.
6293   tls_sni = ROUTER_SMARTHOST
6294   #
6295 .ifdef _HAVE_OPENSSL
6296   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6297 .endif
6298 .ifdef _HAVE_GNUTLS
6299   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6300 .endif
6301 .endif
6302 .endd
6303 After the same &%message_size_limit%& hack, we then specify that this Transport
6304 can handle messages to multiple domains in one run.  The assumption here is
6305 that you're routing all non-local mail to the same place and that place is
6306 happy to take all messages from you as quickly as possible.
6307 All other options depend upon built-in macros; if Exim was built without TLS support
6308 then no other options are defined.
6309 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6310 and versions using the &%tls_require_ciphers%& option, where the value to be
6311 used depends upon the library providing TLS.
6312 Beyond that, the options adopt the stance that you should have TLS support available
6313 from your smarthost on today's Internet, so we turn on requiring TLS for the
6314 mail to be delivered, and requiring that the certificate be valid, and match
6315 the expected hostname.  The &%tls_sni%& option can be used by service providers
6316 to select an appropriate certificate to present to you and here we re-use the
6317 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6318 You want to specify the hostname which you'll expect to validate for, and that
6319 should not be subject to insecure tampering via DNS results.
6320
6321 .code
6322 local_delivery:
6323   driver = appendfile
6324   file = /var/mail/$local_part
6325   delivery_date_add
6326   envelope_to_add
6327   return_path_add
6328 # group = mail
6329 # mode = 0660
6330 .endd
6331 This &(appendfile)& transport is used for local delivery to user mailboxes in
6332 traditional BSD mailbox format. By default it runs under the uid and gid of the
6333 local user, which requires the sticky bit to be set on the &_/var/mail_&
6334 directory. Some systems use the alternative approach of running mail deliveries
6335 under a particular group instead of using the sticky bit. The commented options
6336 show how this can be done.
6337
6338 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6339 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6340 similarly-named options above.
6341 .code
6342 address_pipe:
6343   driver = pipe
6344   return_output
6345 .endd
6346 This transport is used for handling deliveries to pipes that are generated by
6347 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6348 option specifies that any output on stdout or stderr generated by the pipe is to
6349 be returned to the sender.
6350 .code
6351 address_file:
6352   driver = appendfile
6353   delivery_date_add
6354   envelope_to_add
6355   return_path_add
6356 .endd
6357 This transport is used for handling deliveries to files that are generated by
6358 redirection. The name of the file is not specified in this instance of
6359 &(appendfile)&, because it comes from the &(redirect)& router.
6360 .code
6361 address_reply:
6362   driver = autoreply
6363 .endd
6364 This transport is used for handling automatic replies generated by users'
6365 filter files.
6366
6367
6368
6369 .section "Default retry rule" "SECID57"
6370 .cindex "retry" "default rule"
6371 .cindex "default" "retry rule"
6372 The retry section of the configuration file contains rules which affect the way
6373 Exim retries deliveries that cannot be completed at the first attempt. It is
6374 introduced by the line
6375 .code
6376 begin retry
6377 .endd
6378 In the default configuration, there is just one rule, which applies to all
6379 errors:
6380 .code
6381 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6382 .endd
6383 This causes any temporarily failing address to be retried every 15 minutes for
6384 2 hours, then at intervals starting at one hour and increasing by a factor of
6385 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6386 is not delivered after 4 days of temporary failure, it is bounced. The time is
6387 measured from first failure, not from the time the message was received.
6388
6389 If the retry section is removed from the configuration, or is empty (that is,
6390 if no retry rules are defined), Exim will not retry deliveries. This turns
6391 temporary errors into permanent errors.
6392
6393
6394 .section "Rewriting configuration" "SECID58"
6395 The rewriting section of the configuration, introduced by
6396 .code
6397 begin rewrite
6398 .endd
6399 contains rules for rewriting addresses in messages as they arrive. There are no
6400 rewriting rules in the default configuration file.
6401
6402
6403
6404 .section "Authenticators configuration" "SECTdefconfauth"
6405 .cindex "AUTH" "configuration"
6406 The authenticators section of the configuration, introduced by
6407 .code
6408 begin authenticators
6409 .endd
6410 defines mechanisms for the use of the SMTP AUTH command. The default
6411 configuration file contains two commented-out example authenticators
6412 which support plaintext username/password authentication using the
6413 standard PLAIN mechanism and the traditional but non-standard LOGIN
6414 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6415 to support most MUA software.
6416
6417 The example PLAIN authenticator looks like this:
6418 .code
6419 #PLAIN:
6420 #  driver                  = plaintext
6421 #  server_set_id           = $auth2
6422 #  server_prompts          = :
6423 #  server_condition        = Authentication is not yet configured
6424 #  server_advertise_condition = ${if def:tls_in_cipher }
6425 .endd
6426 And the example LOGIN authenticator looks like this:
6427 .code
6428 #LOGIN:
6429 #  driver                  = plaintext
6430 #  server_set_id           = $auth1
6431 #  server_prompts          = <| Username: | Password:
6432 #  server_condition        = Authentication is not yet configured
6433 #  server_advertise_condition = ${if def:tls_in_cipher }
6434 .endd
6435
6436 The &%server_set_id%& option makes Exim remember the authenticated username
6437 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6438 &%server_prompts%& option configures the &(plaintext)& authenticator so
6439 that it implements the details of the specific authentication mechanism,
6440 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6441 when Exim offers authentication to clients; in the examples, this is only
6442 when TLS or SSL has been started, so to enable the authenticators you also
6443 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6444
6445 The &%server_condition%& setting defines how to verify that the username and
6446 password are correct. In the examples it just produces an error message.
6447 To make the authenticators work, you can use a string expansion
6448 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6449
6450 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6451 usercode and password are in different positions.
6452 Chapter &<<CHAPplaintext>>& covers both.
6453
6454 .ecindex IIDconfiwal
6455
6456
6457
6458 . ////////////////////////////////////////////////////////////////////////////
6459 . ////////////////////////////////////////////////////////////////////////////
6460
6461 .chapter "Regular expressions" "CHAPregexp"
6462
6463 .cindex "regular expressions" "library"
6464 .cindex "PCRE"
6465 Exim supports the use of regular expressions in many of its options. It
6466 uses the PCRE regular expression library; this provides regular expression
6467 matching that is compatible with Perl 5. The syntax and semantics of
6468 regular expressions is discussed in
6469 online Perl manpages, in
6470 many Perl reference books, and also in
6471 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6472 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6473 . --- the http: URL here redirects to another page with the ISBN in the URL
6474 . --- where trying to use https: just redirects back to http:, so sticking
6475 . --- to the old URL for now.  2018-09-07.
6476
6477 The documentation for the syntax and semantics of the regular expressions that
6478 are supported by PCRE is included in the PCRE distribution, and no further
6479 description is included here. The PCRE functions are called from Exim using
6480 the default option settings (that is, with no PCRE options set), except that
6481 the PCRE_CASELESS option is set when the matching is required to be
6482 case-insensitive.
6483
6484 In most cases, when a regular expression is required in an Exim configuration,
6485 it has to start with a circumflex, in order to distinguish it from plain text
6486 or an &"ends with"& wildcard. In this example of a configuration setting, the
6487 second item in the colon-separated list is a regular expression.
6488 .code
6489 domains = a.b.c : ^\\d{3} : *.y.z : ...
6490 .endd
6491 The doubling of the backslash is required because of string expansion that
6492 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6493 of this issue, and a way of avoiding the need for doubling backslashes. The
6494 regular expression that is eventually used in this example contains just one
6495 backslash. The circumflex is included in the regular expression, and has the
6496 normal effect of &"anchoring"& it to the start of the string that is being
6497 matched.
6498
6499 There are, however, two cases where a circumflex is not required for the
6500 recognition of a regular expression: these are the &%match%& condition in a
6501 string expansion, and the &%matches%& condition in an Exim filter file. In
6502 these cases, the relevant string is always treated as a regular expression; if
6503 it does not start with a circumflex, the expression is not anchored, and can
6504 match anywhere in the subject string.
6505
6506 In all cases, if you want a regular expression to match at the end of a string,
6507 you must code the $ metacharacter to indicate this. For example:
6508 .code
6509 domains = ^\\d{3}\\.example
6510 .endd
6511 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6512 You need to use:
6513 .code
6514 domains = ^\\d{3}\\.example\$
6515 .endd
6516 if you want &'example'& to be the top-level domain. The backslash before the
6517 $ is needed because string expansion also interprets dollar characters.
6518
6519
6520
6521 . ////////////////////////////////////////////////////////////////////////////
6522 . ////////////////////////////////////////////////////////////////////////////
6523
6524 .chapter "File and database lookups" "CHAPfdlookup"
6525 .scindex IIDfidalo1 "file" "lookups"
6526 .scindex IIDfidalo2 "database" "lookups"
6527 .cindex "lookup" "description of"
6528 Exim can be configured to look up data in files or databases as it processes
6529 messages. Two different kinds of syntax are used:
6530
6531 .olist
6532 A string that is to be expanded may contain explicit lookup requests. These
6533 cause parts of the string to be replaced by data that is obtained from the
6534 lookup. Lookups of this type are conditional expansion items. Different results
6535 can be defined for the cases of lookup success and failure. See chapter
6536 &<<CHAPexpand>>&, where string expansions are described in detail.
6537 The key for the lookup is specified as part of the string expansion.
6538 .next
6539 Lists of domains, hosts, and email addresses can contain lookup requests as a
6540 way of avoiding excessively long linear lists. In this case, the data that is
6541 returned by the lookup is often (but not always) discarded; whether the lookup
6542 succeeds or fails is what really counts. These kinds of list are described in
6543 chapter &<<CHAPdomhosaddlists>>&.
6544 The key for the lookup is given by the context in which the list is expanded.
6545 .endlist
6546
6547 String expansions, lists, and lookups interact with each other in such a way
6548 that there is no order in which to describe any one of them that does not
6549 involve references to the others. Each of these three chapters makes more sense
6550 if you have read the other two first. If you are reading this for the first
6551 time, be aware that some of it will make a lot more sense after you have read
6552 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6553
6554 .section "Examples of different lookup syntax" "SECID60"
6555 It is easy to confuse the two different kinds of lookup, especially as the
6556 lists that may contain the second kind are always expanded before being
6557 processed as lists. Therefore, they may also contain lookups of the first kind.
6558 Be careful to distinguish between the following two examples:
6559 .code
6560 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6561 domains = lsearch;/some/file
6562 .endd
6563 The first uses a string expansion, the result of which must be a domain list.
6564 No strings have been specified for a successful or a failing lookup; the
6565 defaults in this case are the looked-up data and an empty string, respectively.
6566 The expansion takes place before the string is processed as a list, and the
6567 file that is searched could contain lines like this:
6568 .code
6569 192.168.3.4: domain1:domain2:...
6570 192.168.1.9: domain3:domain4:...
6571 .endd
6572 When the lookup succeeds, the result of the expansion is a list of domains (and
6573 possibly other types of item that are allowed in domain lists).
6574
6575 In the second example, the lookup is a single item in a domain list. It causes
6576 Exim to use a lookup to see if the domain that is being processed can be found
6577 in the file. The file could contains lines like this:
6578 .code
6579 domain1:
6580 domain2:
6581 .endd
6582 Any data that follows the keys is not relevant when checking that the domain
6583 matches the list item.
6584
6585 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6586 Consider a file containing lines like this:
6587 .code
6588 192.168.5.6: lsearch;/another/file
6589 .endd
6590 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6591 first &%domains%& setting above generates the second setting, which therefore
6592 causes a second lookup to occur.
6593
6594 The rest of this chapter describes the different lookup types that are
6595 available. Any of them can be used in any part of the configuration where a
6596 lookup is permitted.
6597
6598
6599 .section "Lookup types" "SECID61"
6600 .cindex "lookup" "types of"
6601 .cindex "single-key lookup" "definition of"
6602 Two different types of data lookup are implemented:
6603
6604 .ilist
6605 The &'single-key'& type requires the specification of a file in which to look,
6606 and a single key to search for. The key must be a non-empty string for the
6607 lookup to succeed. The lookup type determines how the file is searched.
6608 .next
6609 .cindex "query-style lookup" "definition of"
6610 The &'query-style'& type accepts a generalized database query. No particular
6611 key value is assumed by Exim for query-style lookups. You can use whichever
6612 Exim variables you need to construct the database query.
6613 .endlist
6614
6615 The code for each lookup type is in a separate source file that is included in
6616 the binary of Exim only if the corresponding compile-time option is set. The
6617 default settings in &_src/EDITME_& are:
6618 .code
6619 LOOKUP_DBM=yes
6620 LOOKUP_LSEARCH=yes
6621 .endd
6622 which means that only linear searching and DBM lookups are included by default.
6623 For some types of lookup (e.g. SQL databases), you need to install appropriate
6624 libraries and header files before building Exim.
6625
6626
6627
6628
6629 .section "Single-key lookup types" "SECTsinglekeylookups"
6630 .cindex "lookup" "single-key types"
6631 .cindex "single-key lookup" "list of types"
6632 The following single-key lookup types are implemented:
6633
6634 .ilist
6635 .cindex "cdb" "description of"
6636 .cindex "lookup" "cdb"
6637 .cindex "binary zero" "in lookup key"
6638 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6639 string without a terminating binary zero. The cdb format is designed for
6640 indexed files that are read frequently and never updated, except by total
6641 re-creation. As such, it is particularly suitable for large files containing
6642 aliases or other indexed data referenced by an MTA. Information about cdb and
6643 tools for building the files can be found in several places:
6644 .display
6645 &url(https://cr.yp.to/cdb.html)
6646 &url(http://www.corpit.ru/mjt/tinycdb.html)
6647 &url(https://packages.debian.org/stable/utils/freecdb)
6648 &url(https://github.com/philpennock/cdbtools) (in Go)
6649 .endd
6650 . --- 2018-09-07: corpit.ru http:-only
6651 A cdb distribution is not needed in order to build Exim with cdb support,
6652 because the code for reading cdb files is included directly in Exim itself.
6653 However, no means of building or testing cdb files is provided with Exim, so
6654 you need to obtain a cdb distribution in order to do this.
6655 .next
6656 .cindex "DBM" "lookup type"
6657 .cindex "lookup" "dbm"
6658 .cindex "binary zero" "in lookup key"
6659 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6660 DBM file by looking up the record with the given key. A terminating binary
6661 zero is included in the key that is passed to the DBM library. See section
6662 &<<SECTdb>>& for a discussion of DBM libraries.
6663
6664 .cindex "Berkeley DB library" "file format"
6665 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6666 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6667 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6668 the DB_UNKNOWN option. This enables it to handle any of the types of database
6669 that the library supports, and can be useful for accessing DBM files created by
6670 other applications. (For earlier DB versions, DB_HASH is always used.)
6671 .next
6672 .cindex "lookup" "dbmjz"
6673 .cindex "lookup" "dbm &-- embedded NULs"
6674 .cindex "sasldb2"
6675 .cindex "dbmjz lookup type"
6676 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6677 interpreted as an Exim list; the elements of the list are joined together with
6678 ASCII NUL characters to form the lookup key.  An example usage would be to
6679 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6680 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6681 &(cram_md5)& authenticator.
6682 .next
6683 .cindex "lookup" "dbmnz"
6684 .cindex "lookup" "dbm &-- terminating zero"
6685 .cindex "binary zero" "in lookup key"
6686 .cindex "Courier"
6687 .cindex "&_/etc/userdbshadow.dat_&"
6688 .cindex "dbmnz lookup type"
6689 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6690 is not included in the key that is passed to the DBM library. You may need this
6691 if you want to look up data in files that are created by or shared with some
6692 other application that does not use terminating zeros. For example, you need to
6693 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6694 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6695 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6696 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6697 .next
6698 .cindex "lookup" "dsearch"
6699 .cindex "dsearch lookup type"
6700 &(dsearch)&: The given file must be a directory; this is searched for an entry
6701 whose name is the key by calling the &[lstat()]& function. The key may not
6702 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6703 the lookup is the name of the entry, which may be a file, directory,
6704 symbolic link, or any other kind of directory entry. An example of how this
6705 lookup can be used to support virtual domains is given in section
6706 &<<SECTvirtualdomains>>&.
6707 .next
6708 .cindex "lookup" "iplsearch"
6709 .cindex "iplsearch lookup type"
6710 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6711 terminated by a colon or white space or the end of the line. The keys in the
6712 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6713 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6714 being interpreted as a key terminator. For example:
6715 .code
6716 1.2.3.4:           data for 1.2.3.4
6717 192.168.0.0/16:    data for 192.168.0.0/16
6718 "abcd::cdab":      data for abcd::cdab
6719 "abcd:abcd::/32"   data for abcd:abcd::/32
6720 .endd
6721 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6722 file is searched linearly, using the CIDR masks where present, until a matching
6723 key is found. The first key that matches is used; there is no attempt to find a
6724 &"best"& match. Apart from the way the keys are matched, the processing for
6725 &(iplsearch)& is the same as for &(lsearch)&.
6726
6727 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6728 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6729 lookup types support only literal keys.
6730
6731 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6732 the implicit key is the host's IP address rather than its name (see section
6733 &<<SECThoslispatsikey>>&).
6734 .next
6735 .cindex "linear search"
6736 .cindex "lookup" "lsearch"
6737 .cindex "lsearch lookup type"
6738 .cindex "case sensitivity" "in lsearch lookup"
6739 &(lsearch)&: The given file is a text file that is searched linearly for a
6740 line beginning with the search key, terminated by a colon or white space or the
6741 end of the line. The search is case-insensitive; that is, upper and lower case
6742 letters are treated as the same. The first occurrence of the key that is found
6743 in the file is used.
6744
6745 White space between the key and the colon is permitted. The remainder of the
6746 line, with leading and trailing white space removed, is the data. This can be
6747 continued onto subsequent lines by starting them with any amount of white
6748 space, but only a single space character is included in the data at such a
6749 junction. If the data begins with a colon, the key must be terminated by a
6750 colon, for example:
6751 .code
6752 baduser:  :fail:
6753 .endd
6754 Empty lines and lines beginning with # are ignored, even if they occur in the
6755 middle of an item. This is the traditional textual format of alias files. Note
6756 that the keys in an &(lsearch)& file are literal strings. There is no
6757 wildcarding of any kind.
6758
6759 .cindex "lookup" "lsearch &-- colons in keys"
6760 .cindex "white space" "in lsearch key"
6761 In most &(lsearch)& files, keys are not required to contain colons or #
6762 characters, or white space. However, if you need this feature, it is available.
6763 If a key begins with a doublequote character, it is terminated only by a
6764 matching quote (or end of line), and the normal escaping rules apply to its
6765 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6766 quoted keys (exactly as for unquoted keys). There is no special handling of
6767 quotes for the data part of an &(lsearch)& line.
6768
6769 .next
6770 .cindex "NIS lookup type"
6771 .cindex "lookup" "NIS"
6772 .cindex "binary zero" "in lookup key"
6773 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6774 the given key, without a terminating binary zero. There is a variant called
6775 &(nis0)& which does include the terminating binary zero in the key. This is
6776 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6777 aliases; the full map names must be used.
6778
6779 .next
6780 .cindex "wildlsearch lookup type"
6781 .cindex "lookup" "wildlsearch"
6782 .cindex "nwildlsearch lookup type"
6783 .cindex "lookup" "nwildlsearch"
6784 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6785 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6786 the file may be wildcarded. The difference between these two lookup types is
6787 that for &(wildlsearch)&, each key in the file is string-expanded before being
6788 used, whereas for &(nwildlsearch)&, no expansion takes place.
6789
6790 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6791 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6792 file that are regular expressions can be made case-sensitive by the use of
6793 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6794
6795 . ==== As this is a nested list, any displays it contains must be indented
6796 . ==== as otherwise they are too far to the left.
6797
6798 .olist
6799 The string may begin with an asterisk to mean &"ends with"&. For example:
6800 .code
6801     *.a.b.c       data for anything.a.b.c
6802     *fish         data for anythingfish
6803 .endd
6804 .next
6805 The string may begin with a circumflex to indicate a regular expression. For
6806 example, for &(wildlsearch)&:
6807 .code
6808     ^\N\d+\.a\.b\N    data for <digits>.a.b
6809 .endd
6810 Note the use of &`\N`& to disable expansion of the contents of the regular
6811 expression. If you are using &(nwildlsearch)&, where the keys are not
6812 string-expanded, the equivalent entry is:
6813 .code
6814     ^\d+\.a\.b        data for <digits>.a.b
6815 .endd
6816 The case-insensitive flag is set at the start of compiling the regular
6817 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6818 For example, to make the entire pattern case-sensitive:
6819 .code
6820     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6821 .endd
6822
6823 If the regular expression contains white space or colon characters, you must
6824 either quote it (see &(lsearch)& above), or represent these characters in other
6825 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6826 colon. This may be easier than quoting, because if you quote, you have to
6827 escape all the backslashes inside the quotes.
6828
6829 &*Note*&: It is not possible to capture substrings in a regular expression
6830 match for later use, because the results of all lookups are cached. If a lookup
6831 is repeated, the result is taken from the cache, and no actual pattern matching
6832 takes place. The values of all the numeric variables are unset after a
6833 &((n)wildlsearch)& match.
6834
6835 .next
6836 Although I cannot see it being of much use, the general matching function that
6837 is used to implement &((n)wildlsearch)& means that the string may begin with a
6838 lookup name terminated by a semicolon, and followed by lookup data. For
6839 example:
6840 .code
6841     cdb;/some/file  data for keys that match the file
6842 .endd
6843 The data that is obtained from the nested lookup is discarded.
6844 .endlist olist
6845
6846 Keys that do not match any of these patterns are interpreted literally. The
6847 continuation rules for the data are the same as for &(lsearch)&, and keys may
6848 be followed by optional colons.
6849
6850 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6851 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6852 lookup types support only literal keys.
6853
6854 .next
6855 .cindex "lookup" "spf"
6856 If Exim is built with SPF support, manual lookups can be done
6857 (as opposed to the standard ACL condition method.
6858 For details see section &<<SECSPF>>&.
6859 .endlist ilist
6860
6861
6862 .section "Query-style lookup types" "SECTquerystylelookups"
6863 .cindex "lookup" "query-style types"
6864 .cindex "query-style lookup" "list of types"
6865 The supported query-style lookup types are listed below. Further details about
6866 many of them are given in later sections.
6867
6868 .ilist
6869 .cindex "DNS" "as a lookup type"
6870 .cindex "lookup" "DNS"
6871 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6872 are given in the supplied query. The resulting data is the contents of the
6873 records. See section &<<SECTdnsdb>>&.
6874 .next
6875 .cindex "InterBase lookup type"
6876 .cindex "lookup" "InterBase"
6877 &(ibase)&: This does a lookup in an InterBase database.
6878 .next
6879 .cindex "LDAP" "lookup type"
6880 .cindex "lookup" "LDAP"
6881 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6882 returns attributes from a single entry. There is a variant called &(ldapm)&
6883 that permits values from multiple entries to be returned. A third variant
6884 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6885 any attribute values. See section &<<SECTldap>>&.
6886 .next
6887 .cindex "MySQL" "lookup type"
6888 .cindex "lookup" "MySQL"
6889 &(mysql)&: The format of the query is an SQL statement that is passed to a
6890 MySQL database. See section &<<SECTsql>>&.
6891 .next
6892 .cindex "NIS+ lookup type"
6893 .cindex "lookup" "NIS+"
6894 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6895 the field to be returned. See section &<<SECTnisplus>>&.
6896 .next
6897 .cindex "Oracle" "lookup type"
6898 .cindex "lookup" "Oracle"
6899 &(oracle)&: The format of the query is an SQL statement that is passed to an
6900 Oracle database. See section &<<SECTsql>>&.
6901 .next
6902 .cindex "lookup" "passwd"
6903 .cindex "passwd lookup type"
6904 .cindex "&_/etc/passwd_&"
6905 &(passwd)& is a query-style lookup with queries that are just user names. The
6906 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6907 success, the result string is the same as you would get from an &(lsearch)&
6908 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6909 password value. For example:
6910 .code
6911 *:42:42:King Rat:/home/kr:/bin/bash
6912 .endd
6913 .next
6914 .cindex "PostgreSQL lookup type"
6915 .cindex "lookup" "PostgreSQL"
6916 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6917 PostgreSQL database. See section &<<SECTsql>>&.
6918
6919 .next
6920 .cindex "Redis lookup type"
6921 .cindex lookup Redis
6922 &(redis)&: The format of the query is either a simple get or simple set,
6923 passed to a Redis database. See section &<<SECTsql>>&.
6924
6925 .next
6926 .cindex "sqlite lookup type"
6927 .cindex "lookup" "sqlite"
6928 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6929 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6930
6931 .next
6932 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6933 not likely to be useful in normal operation.
6934 .next
6935 .cindex "whoson lookup type"
6936 .cindex "lookup" "whoson"
6937 . --- still http:-only, 2018-09-07
6938 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6939 allows a server to check whether a particular (dynamically allocated) IP
6940 address is currently allocated to a known (trusted) user and, optionally, to
6941 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6942 at one time for &"POP before SMTP"& authentication, but that approach has been
6943 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6944 &"POP before SMTP"& checking using ACL statements such as
6945 .code
6946 require condition = \
6947   ${lookup whoson {$sender_host_address}{yes}{no}}
6948 .endd
6949 The query consists of a single IP address. The value returned is the name of
6950 the authenticated user, which is stored in the variable &$value$&. However, in
6951 this example, the data in &$value$& is not used; the result of the lookup is
6952 one of the fixed strings &"yes"& or &"no"&.
6953 .endlist
6954
6955
6956
6957 .section "Temporary errors in lookups" "SECID63"
6958 .cindex "lookup" "temporary error in"
6959 Lookup functions can return temporary error codes if the lookup cannot be
6960 completed. For example, an SQL or LDAP database might be unavailable. For this
6961 reason, it is not advisable to use a lookup that might do this for critical
6962 options such as a list of local domains.
6963
6964 When a lookup cannot be completed in a router or transport, delivery
6965 of the message (to the relevant address) is deferred, as for any other
6966 temporary error. In other circumstances Exim may assume the lookup has failed,
6967 or may give up altogether.
6968
6969
6970
6971 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6972 .cindex "wildcard lookups"
6973 .cindex "lookup" "default values"
6974 .cindex "lookup" "wildcard"
6975 .cindex "lookup" "* added to type"
6976 .cindex "default" "in single-key lookups"
6977 In this context, a &"default value"& is a value specified by the administrator
6978 that is to be used if a lookup fails.
6979
6980 &*Note:*& This section applies only to single-key lookups. For query-style
6981 lookups, the facilities of the query language must be used. An attempt to
6982 specify a default for a query-style lookup provokes an error.
6983
6984 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6985 and the initial lookup fails, the key &"*"& is looked up in the file to
6986 provide a default value. See also the section on partial matching below.
6987
6988 .cindex "*@ with single-key lookup"
6989 .cindex "lookup" "*@ added to type"
6990 .cindex "alias file" "per-domain default"
6991 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6992 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6993 character, a second lookup is done with everything before the last @ replaced
6994 by *. This makes it possible to provide per-domain defaults in alias files
6995 that include the domains in the keys. If the second lookup fails (or doesn't
6996 take place because there is no @ in the key), &"*"& is looked up.
6997 For example, a &(redirect)& router might contain:
6998 .code
6999 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7000 .endd
7001 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7002 looks up these keys, in this order:
7003 .code
7004 jane@eyre.example
7005 *@eyre.example
7006 *
7007 .endd
7008 The data is taken from whichever key it finds first. &*Note*&: In an
7009 &(lsearch)& file, this does not mean the first of these keys in the file. A
7010 complete scan is done for each key, and only if it is not found at all does
7011 Exim move on to try the next key.
7012
7013
7014
7015 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7016 .cindex "partial matching"
7017 .cindex "wildcard lookups"
7018 .cindex "lookup" "partial matching"
7019 .cindex "lookup" "wildcard"
7020 .cindex "asterisk" "in search type"
7021 The normal operation of a single-key lookup is to search the file for an exact
7022 match with the given key. However, in a number of situations where domains are
7023 being looked up, it is useful to be able to do partial matching. In this case,
7024 information in the file that has a key starting with &"*."& is matched by any
7025 domain that ends with the components that follow the full stop. For example, if
7026 a key in a DBM file is
7027 .code
7028 *.dates.fict.example
7029 .endd
7030 then when partial matching is enabled this is matched by (amongst others)
7031 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7032 by &'dates.fict.example'&, if that does not appear as a separate key in the
7033 file.
7034
7035 &*Note*&: Partial matching is not available for query-style lookups. It is
7036 also not available for any lookup items in address lists (see section
7037 &<<SECTaddresslist>>&).
7038
7039 Partial matching is implemented by doing a series of separate lookups using
7040 keys constructed by modifying the original subject key. This means that it can
7041 be used with any of the single-key lookup types, provided that
7042 partial matching keys
7043 beginning with a special prefix (default &"*."&) are included in the data file.
7044 Keys in the file that do not begin with the prefix are matched only by
7045 unmodified subject keys when partial matching is in use.
7046
7047 Partial matching is requested by adding the string &"partial-"& to the front of
7048 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7049 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7050 is added at the start of the subject key, and it is looked up again. If that
7051 fails, further lookups are tried with dot-separated components removed from the
7052 start of the subject key, one-by-one, and &"*."& added on the front of what
7053 remains.
7054
7055 A minimum number of two non-* components are required. This can be adjusted
7056 by including a number before the hyphen in the search type. For example,
7057 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7058 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7059 subject key is &'2250.dates.fict.example'& then the following keys are looked
7060 up when the minimum number of non-* components is two:
7061 .code
7062 2250.dates.fict.example
7063 *.2250.dates.fict.example
7064 *.dates.fict.example
7065 *.fict.example
7066 .endd
7067 As soon as one key in the sequence is successfully looked up, the lookup
7068 finishes.
7069
7070 .cindex "lookup" "partial matching &-- changing prefix"
7071 .cindex "prefix" "for partial matching"
7072 The use of &"*."& as the partial matching prefix is a default that can be
7073 changed. The motivation for this feature is to allow Exim to operate with file
7074 formats that are used by other MTAs. A different prefix can be supplied in
7075 parentheses instead of the hyphen after &"partial"&. For example:
7076 .code
7077 domains = partial(.)lsearch;/some/file
7078 .endd
7079 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7080 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7081 components is unchanged). The prefix may consist of any punctuation characters
7082 other than a closing parenthesis. It may be empty, for example:
7083 .code
7084 domains = partial1()cdb;/some/file
7085 .endd
7086 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7087 &`a.b.c`&, &`b.c`&, and &`c`&.
7088
7089 If &"partial0"& is specified, what happens at the end (when the lookup with
7090 just one non-wild component has failed, and the original key is shortened right
7091 down to the null string) depends on the prefix:
7092
7093 .ilist
7094 If the prefix has zero length, the whole lookup fails.
7095 .next
7096 If the prefix has length 1, a lookup for just the prefix is done. For
7097 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7098 .next
7099 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7100 remainder is looked up. With the default prefix, therefore, the final lookup is
7101 for &"*"& on its own.
7102 .next
7103 Otherwise, the whole prefix is looked up.
7104 .endlist
7105
7106
7107 If the search type ends in &"*"& or &"*@"& (see section
7108 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7109 this implies happens after all partial lookups have failed. If &"partial0"& is
7110 specified, adding &"*"& to the search type has no effect with the default
7111 prefix, because the &"*"& key is already included in the sequence of partial
7112 lookups. However, there might be a use for lookup types such as
7113 &"partial0(.)lsearch*"&.
7114
7115 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7116 in domain lists and the like. Partial matching works only in terms of
7117 dot-separated components; a key such as &`*fict.example`&
7118 in a database file is useless, because the asterisk in a partial matching
7119 subject key is always followed by a dot.
7120
7121
7122
7123
7124 .section "Lookup caching" "SECID64"
7125 .cindex "lookup" "caching"
7126 .cindex "caching" "lookup data"
7127 Exim caches all lookup results in order to avoid needless repetition of
7128 lookups. However, because (apart from the daemon) Exim operates as a collection
7129 of independent, short-lived processes, this caching applies only within a
7130 single Exim process. There is no inter-process lookup caching facility.
7131
7132 For single-key lookups, Exim keeps the relevant files open in case there is
7133 another lookup that needs them. In some types of configuration this can lead to
7134 many files being kept open for messages with many recipients. To avoid hitting
7135 the operating system limit on the number of simultaneously open files, Exim
7136 closes the least recently used file when it needs to open more files than its
7137 own internal limit, which can be changed via the &%lookup_open_max%& option.
7138
7139 The single-key lookup files are closed and the lookup caches are flushed at
7140 strategic points during delivery &-- for example, after all routing is
7141 complete.
7142
7143
7144
7145
7146 .section "Quoting lookup data" "SECID65"
7147 .cindex "lookup" "quoting"
7148 .cindex "quoting" "in lookups"
7149 When data from an incoming message is included in a query-style lookup, there
7150 is the possibility of special characters in the data messing up the syntax of
7151 the query. For example, a NIS+ query that contains
7152 .code
7153 [name=$local_part]
7154 .endd
7155 will be broken if the local part happens to contain a closing square bracket.
7156 For NIS+, data can be enclosed in double quotes like this:
7157 .code
7158 [name="$local_part"]
7159 .endd
7160 but this still leaves the problem of a double quote in the data. The rule for
7161 NIS+ is that double quotes must be doubled. Other lookup types have different
7162 rules, and to cope with the differing requirements, an expansion operator
7163 of the following form is provided:
7164 .code
7165 ${quote_<lookup-type>:<string>}
7166 .endd
7167 For example, the safest way to write the NIS+ query is
7168 .code
7169 [name="${quote_nisplus:$local_part}"]
7170 .endd
7171 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7172 operator can be used for all lookup types, but has no effect for single-key
7173 lookups, since no quoting is ever needed in their key strings.
7174
7175
7176
7177
7178 .section "More about dnsdb" "SECTdnsdb"
7179 .cindex "dnsdb lookup"
7180 .cindex "lookup" "dnsdb"
7181 .cindex "DNS" "as a lookup type"
7182 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7183 of a record type and a domain name, separated by an equals sign. For example,
7184 an expansion string could contain:
7185 .code
7186 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7187 .endd
7188 If the lookup succeeds, the result is placed in &$value$&, which in this case
7189 is used on its own as the result. If the lookup does not succeed, the
7190 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7191 &<<SECTforexpfai>>& for an explanation of what this means.
7192
7193 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7194 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7195 If no type is given, TXT is assumed.
7196
7197 For any record type, if multiple records are found, the data is returned as a
7198 concatenation, with newline as the default separator. The order, of course,
7199 depends on the DNS resolver. You can specify a different separator character
7200 between multiple records by putting a right angle-bracket followed immediately
7201 by the new separator at the start of the query. For example:
7202 .code
7203 ${lookup dnsdb{>: a=host1.example}}
7204 .endd
7205 It is permitted to specify a space as the separator character. Further
7206 white space is ignored.
7207 For lookup types that return multiple fields per record,
7208 an alternate field separator can be specified using a comma after the main
7209 separator character, followed immediately by the field separator.
7210
7211 .cindex "PTR record" "in &(dnsdb)& lookup"
7212 When the type is PTR,
7213 the data can be an IP address, written as normal; inversion and the addition of
7214 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7215 .code
7216 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7217 .endd
7218 If the data for a PTR record is not a syntactically valid IP address, it is not
7219 altered and nothing is added.
7220
7221 .cindex "MX record" "in &(dnsdb)& lookup"
7222 .cindex "SRV record" "in &(dnsdb)& lookup"
7223 For an MX lookup, both the preference value and the host name are returned for
7224 each record, separated by a space. For an SRV lookup, the priority, weight,
7225 port, and host name are returned for each record, separated by spaces.
7226 The field separator can be modified as above.
7227
7228 .cindex "TXT record" "in &(dnsdb)& lookup"
7229 .cindex "SPF record" "in &(dnsdb)& lookup"
7230 For TXT records with multiple items of data, only the first item is returned,
7231 unless a field separator is specified.
7232 To concatenate items without a separator, use a semicolon instead.
7233 For SPF records the
7234 default behaviour is to concatenate multiple items without using a separator.
7235 .code
7236 ${lookup dnsdb{>\n,: txt=a.b.example}}
7237 ${lookup dnsdb{>\n; txt=a.b.example}}
7238 ${lookup dnsdb{spf=example.org}}
7239 .endd
7240 It is permitted to specify a space as the separator character. Further
7241 white space is ignored.
7242
7243 .cindex "SOA record" "in &(dnsdb)& lookup"
7244 For an SOA lookup, while no result is obtained the lookup is redone with
7245 successively more leading components dropped from the given domain.
7246 Only the primary-nameserver field is returned unless a field separator is
7247 specified.
7248 .code
7249 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7250 .endd
7251
7252 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7253 .cindex "dnsdb modifiers"
7254 .cindex "modifiers" "dnsdb"
7255 .cindex "options" "dnsdb"
7256 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7257 each followed by a comma,
7258 that may appear before the record type.
7259
7260 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7261 temporary DNS error for any of them, the behaviour is controlled by
7262 a defer-option modifier.
7263 The possible keywords are
7264 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7265 With &"strict"& behaviour, any temporary DNS error causes the
7266 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7267 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7268 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7269 error causes the whole lookup to defer only if none of the other lookups
7270 succeed. The default is &"lax"&, so the following lookups are equivalent:
7271 .code
7272 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7273 ${lookup dnsdb{a=one.host.com:two.host.com}}
7274 .endd
7275 Thus, in the default case, as long as at least one of the DNS lookups
7276 yields some data, the lookup succeeds.
7277
7278 .cindex "DNSSEC" "dns lookup"
7279 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7280 The possible keywords are
7281 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7282 With &"strict"& or &"lax"& DNSSEC information is requested
7283 with the lookup.
7284 With &"strict"& a response from the DNS resolver that
7285 is not labelled as authenticated data
7286 is treated as equivalent to a temporary DNS error.
7287 The default is &"never"&.
7288
7289 See also the &$lookup_dnssec_authenticated$& variable.
7290
7291 .cindex timeout "dns lookup"
7292 .cindex "DNS" timeout
7293 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7294 The form is &"retrans_VAL"& where VAL is an Exim time specification
7295 (e.g. &"5s"&).
7296 The default value is set by the main configuration option &%dns_retrans%&.
7297
7298 Retries for the dnsdb lookup can be controlled by a retry modifier.
7299 The form if &"retry_VAL"& where VAL is an integer.
7300 The default count is set by the main configuration option &%dns_retry%&.
7301
7302 .cindex caching "of dns lookup"
7303 .cindex TTL "of dns lookup"
7304 .cindex DNS TTL
7305 Dnsdb lookup results are cached within a single process (and its children).
7306 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7307 value of the set of returned DNS records.
7308
7309
7310 .section "Pseudo dnsdb record types" "SECID66"
7311 .cindex "MX record" "in &(dnsdb)& lookup"
7312 By default, both the preference value and the host name are returned for
7313 each MX record, separated by a space. If you want only host names, you can use
7314 the pseudo-type MXH:
7315 .code
7316 ${lookup dnsdb{mxh=a.b.example}}
7317 .endd
7318 In this case, the preference values are omitted, and just the host names are
7319 returned.
7320
7321 .cindex "name server for enclosing domain"
7322 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7323 records on the given domain, but if none are found, it removes the first
7324 component of the domain name, and tries again. This process continues until NS
7325 records are found or there are no more components left (or there is a DNS
7326 error). In other words, it may return the name servers for a top-level domain,
7327 but it never returns the root name servers. If there are no NS records for the
7328 top-level domain, the lookup fails. Consider these examples:
7329 .code
7330 ${lookup dnsdb{zns=xxx.quercite.com}}
7331 ${lookup dnsdb{zns=xxx.edu}}
7332 .endd
7333 Assuming that in each case there are no NS records for the full domain name,
7334 the first returns the name servers for &%quercite.com%&, and the second returns
7335 the name servers for &%edu%&.
7336
7337 You should be careful about how you use this lookup because, unless the
7338 top-level domain does not exist, the lookup always returns some host names. The
7339 sort of use to which this might be put is for seeing if the name servers for a
7340 given domain are on a blacklist. You can probably assume that the name servers
7341 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7342 such a list.
7343
7344 .cindex "CSA" "in &(dnsdb)& lookup"
7345 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7346 records according to the CSA rules, which are described in section
7347 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7348 not sufficient because of the extra parent domain search behaviour of CSA. The
7349 result of a successful lookup such as:
7350 .code
7351 ${lookup dnsdb {csa=$sender_helo_name}}
7352 .endd
7353 has two space-separated fields: an authorization code and a target host name.
7354 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7355 authorization required but absent, or &"?"& for unknown.
7356
7357 .cindex "A+" "in &(dnsdb)& lookup"
7358 The pseudo-type A+ performs an AAAA
7359 and then an A lookup.  All results are returned; defer processing
7360 (see below) is handled separately for each lookup.  Example:
7361 .code
7362 ${lookup dnsdb {>; a+=$sender_helo_name}}
7363 .endd
7364
7365
7366 .section "Multiple dnsdb lookups" "SECID67"
7367 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7368 However, you can specify a list of domains or IP addresses in a single
7369 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7370 the default separator, but with the ability to change this. For example:
7371 .code
7372 ${lookup dnsdb{one.domain.com:two.domain.com}}
7373 ${lookup dnsdb{a=one.host.com:two.host.com}}
7374 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7375 .endd
7376 In order to retain backwards compatibility, there is one special case: if
7377 the lookup type is PTR and no change of separator is specified, Exim looks
7378 to see if the rest of the string is precisely one IPv6 address. In this
7379 case, it does not treat it as a list.
7380
7381 The data from each lookup is concatenated, with newline separators by default,
7382 in the same way that multiple DNS records for a single item are handled. A
7383 different separator can be specified, as described above.
7384
7385
7386
7387
7388 .section "More about LDAP" "SECTldap"
7389 .cindex "LDAP" "lookup, more about"
7390 .cindex "lookup" "LDAP"
7391 .cindex "Solaris" "LDAP"
7392 The original LDAP implementation came from the University of Michigan; this has
7393 become &"Open LDAP"&, and there are now two different releases. Another
7394 implementation comes from Netscape, and Solaris 7 and subsequent releases
7395 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7396 the lookup function level, their error handling is different. For this reason
7397 it is necessary to set a compile-time variable when building Exim with LDAP, to
7398 indicate which LDAP library is in use. One of the following should appear in
7399 your &_Local/Makefile_&:
7400 .code
7401 LDAP_LIB_TYPE=UMICHIGAN
7402 LDAP_LIB_TYPE=OPENLDAP1
7403 LDAP_LIB_TYPE=OPENLDAP2
7404 LDAP_LIB_TYPE=NETSCAPE
7405 LDAP_LIB_TYPE=SOLARIS
7406 .endd
7407 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7408 same interface as the University of Michigan version.
7409
7410 There are three LDAP lookup types in Exim. These behave slightly differently in
7411 the way they handle the results of a query:
7412
7413 .ilist
7414 &(ldap)& requires the result to contain just one entry; if there are more, it
7415 gives an error.
7416 .next
7417 &(ldapdn)& also requires the result to contain just one entry, but it is the
7418 Distinguished Name that is returned rather than any attribute values.
7419 .next
7420 &(ldapm)& permits the result to contain more than one entry; the attributes
7421 from all of them are returned.
7422 .endlist
7423
7424
7425 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7426 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7427 the data returned by a successful lookup is described in the next section.
7428 First we explain how LDAP queries are coded.
7429
7430
7431 .section "Format of LDAP queries" "SECTforldaque"
7432 .cindex "LDAP" "query format"
7433 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7434 the configuration of a &(redirect)& router one might have this setting:
7435 .code
7436 data = ${lookup ldap \
7437   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7438   c=UK?mailbox?base?}}
7439 .endd
7440 .cindex "LDAP" "with TLS"
7441 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7442 secure (encrypted) LDAP connections. The second of these ensures that an
7443 encrypted TLS connection is used.
7444
7445 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7446 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7447 See the &%ldap_start_tls%& option.
7448
7449 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7450 controlled. Every part of the TLS configuration can be configured by settings in
7451 &_exim.conf_&. Depending on the version of the client libraries installed on
7452 your system, some of the initialization may have required setting options in
7453 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7454 certificates. This revealed a nuance where the current UID that exim was
7455 running as could affect which config files it read. With Exim 4.83, these
7456 methods become optional, only taking effect if not specifically set in
7457 &_exim.conf_&.
7458
7459
7460 .section "LDAP quoting" "SECID68"
7461 .cindex "LDAP" "quoting"
7462 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7463 and the second because the LDAP query is represented as a URL. Furthermore,
7464 within an LDAP query, two different kinds of quoting are required. For this
7465 reason, there are two different LDAP-specific quoting operators.
7466
7467 The &%quote_ldap%& operator is designed for use on strings that are part of
7468 filter specifications. Conceptually, it first does the following conversions on
7469 the string:
7470 .code
7471 *   =>   \2A
7472 (   =>   \28
7473 )   =>   \29
7474 \   =>   \5C
7475 .endd
7476 in accordance with RFC 2254. The resulting string is then quoted according
7477 to the rules for URLs, that is, all non-alphanumeric characters except
7478 .code
7479 ! $ ' - . _ ( ) * +
7480 .endd
7481 are converted to their hex values, preceded by a percent sign. For example:
7482 .code
7483 ${quote_ldap: a(bc)*, a<yz>; }
7484 .endd
7485 yields
7486 .code
7487 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7488 .endd
7489 Removing the URL quoting, this is (with a leading and a trailing space):
7490 .code
7491 a\28bc\29\2A, a<yz>;
7492 .endd
7493 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7494 base DN specifications in queries. Conceptually, it first converts the string
7495 by inserting a backslash in front of any of the following characters:
7496 .code
7497 , + " \ < > ;
7498 .endd
7499 It also inserts a backslash before any leading spaces or # characters, and
7500 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7501 is then quoted according to the rules for URLs. For example:
7502 .code
7503 ${quote_ldap_dn: a(bc)*, a<yz>; }
7504 .endd
7505 yields
7506 .code
7507 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7508 .endd
7509 Removing the URL quoting, this is (with a trailing space):
7510 .code
7511 \ a(bc)*\, a\<yz\>\;\
7512 .endd
7513 There are some further comments about quoting in the section on LDAP
7514 authentication below.
7515
7516
7517 .section "LDAP connections" "SECID69"
7518 .cindex "LDAP" "connections"
7519 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7520 is in use, via a Unix domain socket. The example given above does not specify
7521 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7522 by starting it with
7523 .code
7524 ldap://<hostname>:<port>/...
7525 .endd
7526 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7527 used. When no server is specified in a query, a list of default servers is
7528 taken from the &%ldap_default_servers%& configuration option. This supplies a
7529 colon-separated list of servers which are tried in turn until one successfully
7530 handles a query, or there is a serious error. Successful handling either
7531 returns the requested data, or indicates that it does not exist. Serious errors
7532 are syntactical, or multiple values when only a single value is expected.
7533 Errors which cause the next server to be tried are connection failures, bind
7534 failures, and timeouts.
7535
7536 For each server name in the list, a port number can be given. The standard way
7537 of specifying a host and port is to use a colon separator (RFC 1738). Because
7538 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7539 doubled. For example
7540 .code
7541 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7542 .endd
7543 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7544 to the LDAP library with no server name, and the library's default (normally
7545 the local host) is used.
7546
7547 If you are using the OpenLDAP library, you can connect to an LDAP server using
7548 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7549 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7550 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7551 not available.
7552
7553 For this type of connection, instead of a host name for the server, a pathname
7554 for the socket is required, and the port number is not relevant. The pathname
7555 can be specified either as an item in &%ldap_default_servers%&, or inline in
7556 the query. In the former case, you can have settings such as
7557 .code
7558 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7559 .endd
7560 When the pathname is given in the query, you have to escape the slashes as
7561 &`%2F`& to fit in with the LDAP URL syntax. For example:
7562 .code
7563 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7564 .endd
7565 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7566 a pathname, it uses the Unix domain socket code, even if the query actually
7567 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7568 socket connection. This behaviour means that you can use a setting of
7569 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7570 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7571 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7572 backup host.
7573
7574 If an explicit &`ldapi`& type is given in a query when a host name is
7575 specified, an error is diagnosed. However, if there are more items in
7576 &%ldap_default_servers%&, they are tried. In other words:
7577
7578 .ilist
7579 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7580 interface.
7581 .next
7582 Using &`ldapi`& with a host name causes an error.
7583 .endlist
7584
7585
7586 Using &`ldapi`& with no host or path in the query, and no setting of
7587 &%ldap_default_servers%&, does whatever the library does by default.
7588
7589
7590
7591 .section "LDAP authentication and control information" "SECID70"
7592 .cindex "LDAP" "authentication"
7593 The LDAP URL syntax provides no way of passing authentication and other control
7594 information to the server. To make this possible, the URL in an LDAP query may
7595 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7596 spaces. If a value contains spaces it must be enclosed in double quotes, and
7597 when double quotes are used, backslash is interpreted in the usual way inside
7598 them. The following names are recognized:
7599 .display
7600 &`DEREFERENCE`&  set the dereferencing parameter
7601 &`NETTIME    `&  set a timeout for a network operation
7602 &`USER       `&  set the DN, for authenticating the LDAP bind
7603 &`PASS       `&  set the password, likewise
7604 &`REFERRALS  `&  set the referrals parameter
7605 &`SERVERS    `&  set alternate server list for this query only
7606 &`SIZE       `&  set the limit for the number of entries returned
7607 &`TIME       `&  set the maximum waiting time for a query
7608 .endd
7609 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7610 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7611 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7612 library from trying to follow referrals issued by the LDAP server.
7613
7614 .cindex LDAP timeout
7615 .cindex timeout "LDAP lookup"
7616 The name CONNECT is an obsolete name for NETTIME, retained for
7617 backwards compatibility. This timeout (specified as a number of seconds) is
7618 enforced from the client end for operations that can be carried out over a
7619 network. Specifically, it applies to network connections and calls to the
7620 &'ldap_result()'& function. If the value is greater than zero, it is used if
7621 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7622 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7623 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7624 Netscape SDK; for OpenLDAP no action is taken.
7625
7626 The TIME parameter (also a number of seconds) is passed to the server to
7627 set a server-side limit on the time taken to complete a search.
7628
7629 The SERVERS parameter allows you to specify an alternate list of ldap servers
7630 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7631 default list of ldap servers, and a single lookup can specify a single ldap
7632 server to use.  But when you need to do a lookup with a list of servers that is
7633 different than the default list (maybe different order, maybe a completely
7634 different set of servers), the SERVERS parameter allows you to specify this
7635 alternate list (colon-separated).
7636
7637 Here is an example of an LDAP query in an Exim lookup that uses some of these
7638 values. This is a single line, folded to fit on the page:
7639 .code
7640 ${lookup ldap
7641   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7642   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7643   {$value}fail}
7644 .endd
7645 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7646 any of the auxiliary data. Exim configuration settings that include lookups
7647 which contain password information should be preceded by &"hide"& to prevent
7648 non-admin users from using the &%-bP%& option to see their values.
7649
7650 The auxiliary data items may be given in any order. The default is no
7651 connection timeout (the system timeout is used), no user or password, no limit
7652 on the number of entries returned, and no time limit on queries.
7653
7654 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7655 removes any URL quoting that it may contain before passing it LDAP. Apparently
7656 some libraries do this for themselves, but some do not. Removing the URL
7657 quoting has two advantages:
7658
7659 .ilist
7660 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7661 DNs as with DNs inside actual queries.
7662 .next
7663 It permits spaces inside USER= DNs.
7664 .endlist
7665
7666 For example, a setting such as
7667 .code
7668 USER=cn=${quote_ldap_dn:$1}
7669 .endd
7670 should work even if &$1$& contains spaces.
7671
7672 Expanded data for the PASS= value should be quoted using the &%quote%&
7673 expansion operator, rather than the LDAP quote operators. The only reason this
7674 field needs quoting is to ensure that it conforms to the Exim syntax, which
7675 does not allow unquoted spaces. For example:
7676 .code
7677 PASS=${quote:$3}
7678 .endd
7679 The LDAP authentication mechanism can be used to check passwords as part of
7680 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7681 &<<CHAPexpand>>&.
7682
7683
7684
7685 .section "Format of data returned by LDAP" "SECID71"
7686 .cindex "LDAP" "returned data formats"
7687 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7688 as a sequence of values, for example
7689 .code
7690 cn=manager,o=University of Cambridge,c=UK
7691 .endd
7692 The &(ldap)& lookup type generates an error if more than one entry matches the
7693 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7694 the result between the data from different entries. It is possible for multiple
7695 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7696 you know that whatever values are returned all came from a single entry in the
7697 directory.
7698
7699 In the common case where you specify a single attribute in your LDAP query, the
7700 result is not quoted, and does not contain the attribute name. If the attribute
7701 has multiple values, they are separated by commas. Any comma that is
7702 part of an attribute's value is doubled.
7703
7704 If you specify multiple attributes, the result contains space-separated, quoted
7705 strings, each preceded by the attribute name and an equals sign. Within the
7706 quotes, the quote character, backslash, and newline are escaped with
7707 backslashes, and commas are used to separate multiple values for the attribute.
7708 Any commas in attribute values are doubled
7709 (permitting treatment of the values as a comma-separated list).
7710 Apart from the escaping, the string within quotes takes the same form as the
7711 output when a single attribute is requested. Specifying no attributes is the
7712 same as specifying all of an entry's attributes.
7713
7714 Here are some examples of the output format. The first line of each pair is an
7715 LDAP query, and the second is the data that is returned. The attribute called
7716 &%attr1%& has two values, one of them with an embedded comma, whereas
7717 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7718 (they have SUP &%attr%& in their schema definitions).
7719
7720 .code
7721 ldap:///o=base?attr1?sub?(uid=fred)
7722 value1.1,value1,,2
7723
7724 ldap:///o=base?attr2?sub?(uid=fred)
7725 value two
7726
7727 ldap:///o=base?attr?sub?(uid=fred)
7728 value1.1,value1,,2,value two
7729
7730 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7731 attr1="value1.1,value1,,2" attr2="value two"
7732
7733 ldap:///o=base??sub?(uid=fred)
7734 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7735 .endd
7736 You can
7737 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7738 results of LDAP lookups.
7739 The &%extract%& operator in string expansions can be used to pick out
7740 individual fields from data that consists of &'key'&=&'value'& pairs.
7741 The &%listextract%& operator should be used to pick out individual values
7742 of attributes, even when only a single value is expected.
7743 The doubling of embedded commas allows you to use the returned data as a
7744 comma separated list (using the "<," syntax for changing the input list separator).
7745
7746
7747
7748
7749 .section "More about NIS+" "SECTnisplus"
7750 .cindex "NIS+ lookup type"
7751 .cindex "lookup" "NIS+"
7752 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7753 and field name. If this is given, the result of a successful query is the
7754 contents of the named field; otherwise the result consists of a concatenation
7755 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7756 values containing spaces are quoted. For example, the query
7757 .code
7758 [name=mg1456],passwd.org_dir
7759 .endd
7760 might return the string
7761 .code
7762 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7763 home=/home/mg1456 shell=/bin/bash shadow=""
7764 .endd
7765 (split over two lines here to fit on the page), whereas
7766 .code
7767 [name=mg1456],passwd.org_dir:gcos
7768 .endd
7769 would just return
7770 .code
7771 Martin Guerre
7772 .endd
7773 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7774 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7775 operator is to double any quote characters within the text.
7776
7777
7778
7779 .section "SQL lookups" "SECTsql"
7780 .cindex "SQL lookup types"
7781 .cindex "MySQL" "lookup type"
7782 .cindex "PostgreSQL lookup type"
7783 .cindex "lookup" "MySQL"
7784 .cindex "lookup" "PostgreSQL"
7785 .cindex "Oracle" "lookup type"
7786 .cindex "lookup" "Oracle"
7787 .cindex "InterBase lookup type"
7788 .cindex "lookup" "InterBase"
7789 .cindex "Redis lookup type"
7790 .cindex lookup Redis
7791 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7792 and SQLite
7793 databases. Queries for these databases contain SQL statements, so an example
7794 might be
7795 .code
7796 ${lookup mysql{select mailbox from users where id='userx'}\
7797   {$value}fail}
7798 .endd
7799 If the result of the query contains more than one field, the data for each
7800 field in the row is returned, preceded by its name, so the result of
7801 .code
7802 ${lookup pgsql{select home,name from users where id='userx'}\
7803   {$value}}
7804 .endd
7805 might be
7806 .code
7807 home=/home/userx name="Mister X"
7808 .endd
7809 Empty values and values containing spaces are double quoted, with embedded
7810 quotes escaped by a backslash. If the result of the query contains just one
7811 field, the value is passed back verbatim, without a field name, for example:
7812 .code
7813 Mister X
7814 .endd
7815 If the result of the query yields more than one row, it is all concatenated,
7816 with a newline between the data for each row.
7817
7818
7819 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7820 .cindex "MySQL" "lookup type"
7821 .cindex "PostgreSQL lookup type"
7822 .cindex "lookup" "MySQL"
7823 .cindex "lookup" "PostgreSQL"
7824 .cindex "Oracle" "lookup type"
7825 .cindex "lookup" "Oracle"
7826 .cindex "InterBase lookup type"
7827 .cindex "lookup" "InterBase"
7828 .cindex "Redis lookup type"
7829 .cindex lookup Redis
7830 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7831 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7832 or &%redis_servers%&
7833 option (as appropriate) must be set to a colon-separated list of server
7834 information.
7835 (For MySQL and PostgreSQL, the global option need not be set if all
7836 queries contain their own server information &-- see section
7837 &<<SECTspeserque>>&.)
7838 For all but Redis
7839 each item in the list is a slash-separated list of four
7840 items: host name, database name, user name, and password. In the case of
7841 Oracle, the host name field is used for the &"service name"&, and the database
7842 name field is not used and should be empty. For example:
7843 .code
7844 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7845 .endd
7846 Because password data is sensitive, you should always precede the setting with
7847 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7848 option. Here is an example where two MySQL servers are listed:
7849 .code
7850 hide mysql_servers = localhost/users/root/secret:\
7851                      otherhost/users/root/othersecret
7852 .endd
7853 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7854 because this is a colon-separated list, the colon has to be doubled. For each
7855 query, these parameter groups are tried in order until a connection is made and
7856 a query is successfully processed. The result of a query may be that no data is
7857 found, but that is still a successful query. In other words, the list of
7858 servers provides a backup facility, not a list of different places to look.
7859
7860 For Redis the global option need not be specified if all queries contain their
7861 own server information &-- see section &<<SECTspeserque>>&.
7862 If specified, the option must be set to a colon-separated list of server
7863 information.
7864 Each item in the list is a slash-separated list of three items:
7865 host, database number, and password.
7866 .olist
7867 The host is required and may be either an IPv4 address and optional
7868 port number (separated by a colon, which needs doubling due to the
7869 higher-level list), or a Unix socket pathname enclosed in parentheses
7870 .next
7871 The database number is optional; if present that number is selected in the backend
7872 .next
7873 The password is optional; if present it is used to authenticate to the backend
7874 .endlist
7875
7876 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7877 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7878 respectively, and the characters single-quote, double-quote, and backslash
7879 itself are escaped with backslashes.
7880
7881 The &%quote_redis%& expansion operator
7882 escapes whitespace and backslash characters with a backslash.
7883
7884 .section "Specifying the server in the query" "SECTspeserque"
7885 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7886 it is possible to specify a list of servers with an individual query. This is
7887 done by starting the query with
7888 .display
7889 &`servers=`&&'server1:server2:server3:...'&&`;`&
7890 .endd
7891 Each item in the list may take one of two forms:
7892 .olist
7893 If it contains no slashes it is assumed to be just a host name. The appropriate
7894 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7895 of the same name, and the remaining parameters (database, user, password) are
7896 taken from there.
7897 .next
7898 If it contains any slashes, it is taken as a complete parameter set.
7899 .endlist
7900 The list of servers is used in exactly the same way as the global list.
7901 Once a connection to a server has happened and a query has been
7902 successfully executed, processing of the lookup ceases.
7903
7904 This feature is intended for use in master/slave situations where updates
7905 are occurring and you want to update the master rather than a slave. If the
7906 master is in the list as a backup for reading, you might have a global setting
7907 like this:
7908 .code
7909 mysql_servers = slave1/db/name/pw:\
7910                 slave2/db/name/pw:\
7911                 master/db/name/pw
7912 .endd
7913 In an updating lookup, you could then write:
7914 .code
7915 ${lookup mysql{servers=master; UPDATE ...} }
7916 .endd
7917 That query would then be sent only to the master server. If, on the other hand,
7918 the master is not to be used for reading, and so is not present in the global
7919 option, you can still update it by a query of this form:
7920 .code
7921 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7922 .endd
7923
7924
7925 .section "Special MySQL features" "SECID73"
7926 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7927 causes a connection to the server on the local host by means of a Unix domain
7928 socket. An alternate socket can be specified in parentheses.
7929 An option group name for MySQL option files can be specified in square brackets;
7930 the default value is &"exim"&.
7931 The full syntax of each item in &%mysql_servers%& is:
7932 .display
7933 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7934   <&'database'&>/<&'user'&>/<&'password'&>
7935 .endd
7936 Any of the four sub-parts of the first field can be omitted. For normal use on
7937 the local host it can be left blank or set to just &"localhost"&.
7938
7939 No database need be supplied &-- but if it is absent here, it must be given in
7940 the queries.
7941
7942 If a MySQL query is issued that does not request any data (an insert, update,
7943 or delete command), the result of the lookup is the number of rows affected.
7944
7945 &*Warning*&: This can be misleading. If an update does not actually change
7946 anything (for example, setting a field to the value it already has), the result
7947 is zero because no rows are affected.
7948
7949
7950 .section "Special PostgreSQL features" "SECID74"
7951 PostgreSQL lookups can also use Unix domain socket connections to the database.
7952 This is usually faster and costs less CPU time than a TCP/IP connection.
7953 However it can be used only if the mail server runs on the same machine as the
7954 database server. A configuration line for PostgreSQL via Unix domain sockets
7955 looks like this:
7956 .code
7957 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7958 .endd
7959 In other words, instead of supplying a host name, a path to the socket is
7960 given. The path name is enclosed in parentheses so that its slashes aren't
7961 visually confused with the delimiters for the other server parameters.
7962
7963 If a PostgreSQL query is issued that does not request any data (an insert,
7964 update, or delete command), the result of the lookup is the number of rows
7965 affected.
7966
7967 .section "More about SQLite" "SECTsqlite"
7968 .cindex "lookup" "SQLite"
7969 .cindex "sqlite lookup type"
7970 SQLite is different to the other SQL lookups because a file name is required in
7971 addition to the SQL query. An SQLite database is a single file, and there is no
7972 daemon as in the other SQL databases. The interface to Exim requires the name
7973 of the file, as an absolute path, to be given at the start of the query. It is
7974 separated from the query by white space. This means that the path name cannot
7975 contain white space. Here is a lookup expansion example:
7976 .code
7977 ${lookup sqlite {/some/thing/sqlitedb \
7978   select name from aliases where id='userx';}}
7979 .endd
7980 In a list, the syntax is similar. For example:
7981 .code
7982 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7983    select * from relays where ip='$sender_host_address';
7984 .endd
7985 The only character affected by the &%quote_sqlite%& operator is a single
7986 quote, which it doubles.
7987
7988 .cindex timeout SQLite
7989 .cindex sqlite "lookup timeout"
7990 The SQLite library handles multiple simultaneous accesses to the database
7991 internally. Multiple readers are permitted, but only one process can
7992 update at once. Attempts to access the database while it is being updated
7993 are rejected after a timeout period, during which the SQLite library
7994 waits for the lock to be released. In Exim, the default timeout is set
7995 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7996 option.
7997
7998 .section "More about Redis" "SECTredis"
7999 .cindex "lookup" "Redis"
8000 .cindex "redis lookup type"
8001 Redis is a non-SQL database. Commands are simple get and set.
8002 Examples:
8003 .code
8004 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8005 ${lookup redis{get keyname}}
8006 .endd
8007
8008 As of release 4.91, "lightweight" support for Redis Cluster is available.
8009 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8010 of which must be reachable from the running exim instance. If the cluster has
8011 master/slave replication, the list must contain all the master and slave
8012 servers.
8013
8014 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8015 immediately follow the redirection but treats the response as a DEFER, moving on
8016 to the next server in the &%redis_servers%& list until the correct server is
8017 reached.
8018
8019 .ecindex IIDfidalo1
8020 .ecindex IIDfidalo2
8021
8022
8023 . ////////////////////////////////////////////////////////////////////////////
8024 . ////////////////////////////////////////////////////////////////////////////
8025
8026 .chapter "Domain, host, address, and local part lists" &&&
8027          "CHAPdomhosaddlists" &&&
8028          "Domain, host, and address lists"
8029 .scindex IIDdohoadli "lists of domains; hosts; etc."
8030 A number of Exim configuration options contain lists of domains, hosts,
8031 email addresses, or local parts. For example, the &%hold_domains%& option
8032 contains a list of domains whose delivery is currently suspended. These lists
8033 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8034 arguments to expansion conditions such as &%match_domain%&.
8035
8036 Each item in one of these lists is a pattern to be matched against a domain,
8037 host, email address, or local part, respectively. In the sections below, the
8038 different types of pattern for each case are described, but first we cover some
8039 general facilities that apply to all four kinds of list.
8040
8041 Note that other parts of Exim use a &'string list'& which does not
8042 support all the complexity available in
8043 domain, host, address and local part lists.
8044
8045
8046
8047 .section "Expansion of lists" "SECTlistexpand"
8048 .cindex "expansion" "of lists"
8049 Each list is expanded as a single string before it is used.
8050
8051 &'Exception: the router headers_remove option, where list-item
8052 splitting is done before string-expansion.'&
8053
8054 The result of
8055 expansion must be a list, possibly containing empty items, which is split up
8056 into separate items for matching. By default, colon is the separator character,
8057 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8058 &<<SECTempitelis>>& for details of the list syntax; the second of these
8059 discusses the way to specify empty list items.
8060
8061
8062 If the string expansion is forced to fail, Exim behaves as if the item it is
8063 testing (domain, host, address, or local part) is not in the list. Other
8064 expansion failures cause temporary errors.
8065
8066 If an item in a list is a regular expression, backslashes, dollars and possibly
8067 other special characters in the expression must be protected against
8068 misinterpretation by the string expander. The easiest way to do this is to use
8069 the &`\N`& expansion feature to indicate that the contents of the regular
8070 expression should not be expanded. For example, in an ACL you might have:
8071 .code
8072 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8073                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8074 .endd
8075 The first item is a regular expression that is protected from expansion by
8076 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8077 senders based on the receiving domain.
8078
8079
8080
8081
8082 .section "Negated items in lists" "SECID76"
8083 .cindex "list" "negation"
8084 .cindex "negation" "in lists"
8085 Items in a list may be positive or negative. Negative items are indicated by a
8086 leading exclamation mark, which may be followed by optional white space. A list
8087 defines a set of items (domains, etc). When Exim processes one of these lists,
8088 it is trying to find out whether a domain, host, address, or local part
8089 (respectively) is in the set that is defined by the list. It works like this:
8090
8091 The list is scanned from left to right. If a positive item is matched, the
8092 subject that is being checked is in the set; if a negative item is matched, the
8093 subject is not in the set. If the end of the list is reached without the
8094 subject having matched any of the patterns, it is in the set if the last item
8095 was a negative one, but not if it was a positive one. For example, the list in
8096 .code
8097 domainlist relay_to_domains = !a.b.c : *.b.c
8098 .endd
8099 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8100 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8101 list is positive. However, if the setting were
8102 .code
8103 domainlist relay_to_domains = !a.b.c
8104 .endd
8105 then all domains other than &'a.b.c'& would match because the last item in the
8106 list is negative. In other words, a list that ends with a negative item behaves
8107 as if it had an extra item &`:*`& on the end.
8108
8109 Another way of thinking about positive and negative items in lists is to read
8110 the connector as &"or"& after a positive item and as &"and"& after a negative
8111 item.
8112
8113
8114
8115 .section "File names in lists" "SECTfilnamlis"
8116 .cindex "list" "file name in"
8117 If an item in a domain, host, address, or local part list is an absolute file
8118 name (beginning with a slash character), each line of the file is read and
8119 processed as if it were an independent item in the list, except that further
8120 file names are not allowed,
8121 and no expansion of the data from the file takes place.
8122 Empty lines in the file are ignored, and the file may also contain comment
8123 lines:
8124
8125 .ilist
8126 For domain and host lists, if a # character appears anywhere in a line of the
8127 file, it and all following characters are ignored.
8128 .next
8129 Because local parts may legitimately contain # characters, a comment in an
8130 address list or local part list file is recognized only if # is preceded by
8131 white space or the start of the line. For example:
8132 .code
8133 not#comment@x.y.z   # but this is a comment
8134 .endd
8135 .endlist
8136
8137 Putting a file name in a list has the same effect as inserting each line of the
8138 file as an item in the list (blank lines and comments excepted). However, there
8139 is one important difference: the file is read each time the list is processed,
8140 so if its contents vary over time, Exim's behaviour changes.
8141
8142 If a file name is preceded by an exclamation mark, the sense of any match
8143 within the file is inverted. For example, if
8144 .code
8145 hold_domains = !/etc/nohold-domains
8146 .endd
8147 and the file contains the lines
8148 .code
8149 !a.b.c
8150 *.b.c
8151 .endd
8152 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8153 any domain matching &`*.b.c`& is not.
8154
8155
8156
8157 .section "An lsearch file is not an out-of-line list" "SECID77"
8158 As will be described in the sections that follow, lookups can be used in lists
8159 to provide indexed methods of checking list membership. There has been some
8160 confusion about the way &(lsearch)& lookups work in lists. Because
8161 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8162 sometimes thought that it is allowed to contain wild cards and other kinds of
8163 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8164 always fixed strings, just as for any other single-key lookup type.
8165
8166 If you want to use a file to contain wild-card patterns that form part of a
8167 list, just give the file name on its own, without a search type, as described
8168 in the previous section. You could also use the &(wildlsearch)& or
8169 &(nwildlsearch)&, but there is no advantage in doing this.
8170
8171
8172
8173
8174 .section "Named lists" "SECTnamedlists"
8175 .cindex "named lists"
8176 .cindex "list" "named"
8177 A list of domains, hosts, email addresses, or local parts can be given a name
8178 which is then used to refer to the list elsewhere in the configuration. This is
8179 particularly convenient if the same list is required in several different
8180 places. It also allows lists to be given meaningful names, which can improve
8181 the readability of the configuration. For example, it is conventional to define
8182 a domain list called &'local_domains'& for all the domains that are handled
8183 locally on a host, using a configuration line such as
8184 .code
8185 domainlist local_domains = localhost:my.dom.example
8186 .endd
8187 Named lists are referenced by giving their name preceded by a plus sign, so,
8188 for example, a router that is intended to handle local domains would be
8189 configured with the line
8190 .code
8191 domains = +local_domains
8192 .endd
8193 The first router in a configuration is often one that handles all domains
8194 except the local ones, using a configuration with a negated item like this:
8195 .code
8196 dnslookup:
8197   driver = dnslookup
8198   domains = ! +local_domains
8199   transport = remote_smtp
8200   no_more
8201 .endd
8202 The four kinds of named list are created by configuration lines starting with
8203 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8204 respectively. Then there follows the name that you are defining, followed by an
8205 equals sign and the list itself. For example:
8206 .code
8207 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8208 addresslist bad_senders = cdb;/etc/badsenders
8209 .endd
8210 A named list may refer to other named lists:
8211 .code
8212 domainlist  dom1 = first.example : second.example
8213 domainlist  dom2 = +dom1 : third.example
8214 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8215 .endd
8216 &*Warning*&: If the last item in a referenced list is a negative one, the
8217 effect may not be what you intended, because the negation does not propagate
8218 out to the higher level. For example, consider:
8219 .code
8220 domainlist  dom1 = !a.b
8221 domainlist  dom2 = +dom1 : *.b
8222 .endd
8223 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8224 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8225 means it matches the second list as well. The effect is not the same as
8226 .code
8227 domainlist  dom2 = !a.b : *.b
8228 .endd
8229 where &'x.y'& does not match. It's best to avoid negation altogether in
8230 referenced lists if you can.
8231
8232 Named lists may have a performance advantage. When Exim is routing an
8233 address or checking an incoming message, it caches the result of tests on named
8234 lists. So, if you have a setting such as
8235 .code
8236 domains = +local_domains
8237 .endd
8238 on several of your routers
8239 or in several ACL statements,
8240 the actual test is done only for the first one. However, the caching works only
8241 if there are no expansions within the list itself or any sublists that it
8242 references. In other words, caching happens only for lists that are known to be
8243 the same each time they are referenced.
8244
8245 By default, there may be up to 16 named lists of each type. This limit can be
8246 extended by changing a compile-time variable. The use of domain and host lists
8247 is recommended for concepts such as local domains, relay domains, and relay
8248 hosts. The default configuration is set up like this.
8249
8250
8251
8252 .section "Named lists compared with macros" "SECID78"
8253 .cindex "list" "named compared with macro"
8254 .cindex "macro" "compared with named list"
8255 At first sight, named lists might seem to be no different from macros in the
8256 configuration file. However, macros are just textual substitutions. If you
8257 write
8258 .code
8259 ALIST = host1 : host2
8260 auth_advertise_hosts = !ALIST
8261 .endd
8262 it probably won't do what you want, because that is exactly the same as
8263 .code
8264 auth_advertise_hosts = !host1 : host2
8265 .endd
8266 Notice that the second host name is not negated. However, if you use a host
8267 list, and write
8268 .code
8269 hostlist alist = host1 : host2
8270 auth_advertise_hosts = ! +alist
8271 .endd
8272 the negation applies to the whole list, and so that is equivalent to
8273 .code
8274 auth_advertise_hosts = !host1 : !host2
8275 .endd
8276
8277
8278 .section "Named list caching" "SECID79"
8279 .cindex "list" "caching of named"
8280 .cindex "caching" "named lists"
8281 While processing a message, Exim caches the result of checking a named list if
8282 it is sure that the list is the same each time. In practice, this means that
8283 the cache operates only if the list contains no $ characters, which guarantees
8284 that it will not change when it is expanded. Sometimes, however, you may have
8285 an expanded list that you know will be the same each time within a given
8286 message. For example:
8287 .code
8288 domainlist special_domains = \
8289            ${lookup{$sender_host_address}cdb{/some/file}}
8290 .endd
8291 This provides a list of domains that depends only on the sending host's IP
8292 address. If this domain list is referenced a number of times (for example,
8293 in several ACL lines, or in several routers) the result of the check is not
8294 cached by default, because Exim does not know that it is going to be the
8295 same list each time.
8296
8297 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8298 cache the result anyway. For example:
8299 .code
8300 domainlist_cache special_domains = ${lookup{...
8301 .endd
8302 If you do this, you should be absolutely sure that caching is going to do
8303 the right thing in all cases. When in doubt, leave it out.
8304
8305
8306
8307 .section "Domain lists" "SECTdomainlist"
8308 .cindex "domain list" "patterns for"
8309 .cindex "list" "domain list"
8310 Domain lists contain patterns that are to be matched against a mail domain.
8311 The following types of item may appear in domain lists:
8312
8313 .ilist
8314 .cindex "primary host name"
8315 .cindex "host name" "matched in domain list"
8316 .oindex "&%primary_hostname%&"
8317 .cindex "domain list" "matching primary host name"
8318 .cindex "@ in a domain list"
8319 If a pattern consists of a single @ character, it matches the local host name,
8320 as set by the &%primary_hostname%& option (or defaulted). This makes it
8321 possible to use the same configuration file on several different hosts that
8322 differ only in their names.
8323 .next
8324 .cindex "@[] in a domain list"
8325 .cindex "domain list" "matching local IP interfaces"
8326 .cindex "domain literal"
8327 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8328 in square brackets (as in an email address that contains a domain literal), but
8329 only if that IP address is recognized as local for email routing purposes. The
8330 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8331 control which of a host's several IP addresses are treated as local.
8332 In today's Internet, the use of domain literals is controversial.
8333 .next
8334 .cindex "@mx_any"
8335 .cindex "@mx_primary"
8336 .cindex "@mx_secondary"
8337 .cindex "domain list" "matching MX pointers to local host"
8338 If a pattern consists of the string &`@mx_any`& it matches any domain that
8339 has an MX record pointing to the local host or to any host that is listed in
8340 .oindex "&%hosts_treat_as_local%&"
8341 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8342 are similar, except that the first matches only when a primary MX target is the
8343 local host, and the second only when no primary MX target is the local host,
8344 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8345 preference value &-- there may of course be more than one of them.
8346
8347 The MX lookup that takes place when matching a pattern of this type is
8348 performed with the resolver options for widening names turned off. Thus, for
8349 example, a single-component domain will &'not'& be expanded by adding the
8350 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8351 options of the &(dnslookup)& router for a discussion of domain widening.
8352
8353 Sometimes you may want to ignore certain IP addresses when using one of these
8354 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8355 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8356 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8357 on a router). For example:
8358 .code
8359 domains = @mx_any/ignore=127.0.0.1
8360 .endd
8361 This example matches any domain that has an MX record pointing to one of
8362 the local host's IP addresses other than 127.0.0.1.
8363
8364 The list of IP addresses is in fact processed by the same code that processes
8365 host lists, so it may contain CIDR-coded network specifications and it may also
8366 contain negative items.
8367
8368 Because the list of IP addresses is a sublist within a domain list, you have to
8369 be careful about delimiters if there is more than one address. Like any other
8370 list, the default delimiter can be changed. Thus, you might have:
8371 .code
8372 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8373           an.other.domain : ...
8374 .endd
8375 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8376 involved, it is easiest to change the delimiter for the main list as well:
8377 .code
8378 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8379           an.other.domain ? ...
8380 .endd
8381 .next
8382 .cindex "asterisk" "in domain list"
8383 .cindex "domain list" "asterisk in"
8384 .cindex "domain list" "matching &""ends with""&"
8385 If a pattern starts with an asterisk, the remaining characters of the pattern
8386 are compared with the terminating characters of the domain. The use of &"*"& in
8387 domain lists differs from its use in partial matching lookups. In a domain
8388 list, the character following the asterisk need not be a dot, whereas partial
8389 matching works only in terms of dot-separated components. For example, a domain
8390 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8391 &'cipher.key.ex'&.
8392
8393 .next
8394 .cindex "regular expressions" "in domain list"
8395 .cindex "domain list" "matching regular expression"
8396 If a pattern starts with a circumflex character, it is treated as a regular
8397 expression, and matched against the domain using a regular expression matching
8398 function. The circumflex is treated as part of the regular expression.
8399 Email domains are case-independent, so this regular expression match is by
8400 default case-independent, but you can make it case-dependent by starting it
8401 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8402 are given in chapter &<<CHAPregexp>>&.
8403
8404 &*Warning*&: Because domain lists are expanded before being processed, you
8405 must escape any backslash and dollar characters in the regular expression, or
8406 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8407 it is not to be expanded (unless you really do want to build a regular
8408 expression by expansion, of course).
8409 .next
8410 .cindex "lookup" "in domain list"
8411 .cindex "domain list" "matching by lookup"
8412 If a pattern starts with the name of a single-key lookup type followed by a
8413 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8414 must be a file name in a suitable format for the lookup type. For example, for
8415 &"cdb;"& it must be an absolute path:
8416 .code
8417 domains = cdb;/etc/mail/local_domains.cdb
8418 .endd
8419 The appropriate type of lookup is done on the file using the domain name as the
8420 key. In most cases, the data that is looked up is not used; Exim is interested
8421 only in whether or not the key is present in the file. However, when a lookup
8422 is used for the &%domains%& option on a router
8423 or a &%domains%& condition in an ACL statement, the data is preserved in the
8424 &$domain_data$& variable and can be referred to in other router options or
8425 other statements in the same ACL.
8426
8427 .next
8428 Any of the single-key lookup type names may be preceded by
8429 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8430 .code
8431 domains = partial-dbm;/partial/domains
8432 .endd
8433 This causes partial matching logic to be invoked; a description of how this
8434 works is given in section &<<SECTpartiallookup>>&.
8435
8436 .next
8437 .cindex "asterisk" "in lookup type"
8438 Any of the single-key lookup types may be followed by an asterisk. This causes
8439 a default lookup for a key consisting of a single asterisk to be done if the
8440 original lookup fails. This is not a useful feature when using a domain list to
8441 select particular domains (because any domain would match), but it might have
8442 value if the result of the lookup is being used via the &$domain_data$&
8443 expansion variable.
8444 .next
8445 If the pattern starts with the name of a query-style lookup type followed by a
8446 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8447 pattern must be an appropriate query for the lookup type, as described in
8448 chapter &<<CHAPfdlookup>>&. For example:
8449 .code
8450 hold_domains = mysql;select domain from holdlist \
8451   where domain = '${quote_mysql:$domain}';
8452 .endd
8453 In most cases, the data that is looked up is not used (so for an SQL query, for
8454 example, it doesn't matter what field you select). Exim is interested only in
8455 whether or not the query succeeds. However, when a lookup is used for the
8456 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8457 variable and can be referred to in other options.
8458 .next
8459 .cindex "domain list" "matching literal domain name"
8460 If none of the above cases apply, a caseless textual comparison is made
8461 between the pattern and the domain.
8462 .endlist
8463
8464 Here is an example that uses several different kinds of pattern:
8465 .code
8466 domainlist funny_domains = \
8467   @ : \
8468   lib.unseen.edu : \
8469   *.foundation.fict.example : \
8470   \N^[1-2]\d{3}\.fict\.example$\N : \
8471   partial-dbm;/opt/data/penguin/book : \
8472   nis;domains.byname : \
8473   nisplus;[name=$domain,status=local],domains.org_dir
8474 .endd
8475 There are obvious processing trade-offs among the various matching modes. Using
8476 an asterisk is faster than a regular expression, and listing a few names
8477 explicitly probably is too. The use of a file or database lookup is expensive,
8478 but may be the only option if hundreds of names are required. Because the
8479 patterns are tested in order, it makes sense to put the most commonly matched
8480 patterns earlier.
8481
8482
8483
8484 .section "Host lists" "SECThostlist"
8485 .cindex "host list" "patterns in"
8486 .cindex "list" "host list"
8487 Host lists are used to control what remote hosts are allowed to do. For
8488 example, some hosts may be allowed to use the local host as a relay, and some
8489 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8490 two different ways, by name or by IP address. In a host list, some types of
8491 pattern are matched to a host name, and some are matched to an IP address.
8492 You need to be particularly careful with this when single-key lookups are
8493 involved, to ensure that the right value is being used as the key.
8494
8495
8496 .section "Special host list patterns" "SECID80"
8497 .cindex "empty item in hosts list"
8498 .cindex "host list" "empty string in"
8499 If a host list item is the empty string, it matches only when no remote host is
8500 involved. This is the case when a message is being received from a local
8501 process using SMTP on the standard input, that is, when a TCP/IP connection is
8502 not used.
8503
8504 .cindex "asterisk" "in host list"
8505 The special pattern &"*"& in a host list matches any host or no host. Neither
8506 the IP address nor the name is actually inspected.
8507
8508
8509
8510 .section "Host list patterns that match by IP address" "SECThoslispatip"
8511 .cindex "host list" "matching IP addresses"
8512 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8513 the incoming address actually appears in the IPv6 host as
8514 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8515 list, it is converted into a traditional IPv4 address first. (Not all operating
8516 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8517 concerns.)
8518
8519 The following types of pattern in a host list check the remote host by
8520 inspecting its IP address:
8521
8522 .ilist
8523 If the pattern is a plain domain name (not a regular expression, not starting
8524 with *, not a lookup of any kind), Exim calls the operating system function
8525 to find the associated IP address(es). Exim uses the newer
8526 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8527 This typically causes a forward DNS lookup of the name. The result is compared
8528 with the IP address of the subject host.
8529
8530 If there is a temporary problem (such as a DNS timeout) with the host name
8531 lookup, a temporary error occurs. For example, if the list is being used in an
8532 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8533 temporary SMTP error code. If no IP address can be found for the host name,
8534 what happens is described in section &<<SECTbehipnot>>& below.
8535
8536 .next
8537 .cindex "@ in a host list"
8538 If the pattern is &"@"&, the primary host name is substituted and used as a
8539 domain name, as just described.
8540
8541 .next
8542 If the pattern is an IP address, it is matched against the IP address of the
8543 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8544 IPv6 addresses can be given in colon-separated format, but the colons have to
8545 be doubled so as not to be taken as item separators when the default list
8546 separator is used. IPv6 addresses are recognized even when Exim is compiled
8547 without IPv6 support. This means that if they appear in a host list on an
8548 IPv4-only host, Exim will not treat them as host names. They are just addresses
8549 that can never match a client host.
8550
8551 .next
8552 .cindex "@[] in a host list"
8553 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8554 the local host. For example, if the local host is an IPv4 host with one
8555 interface address 10.45.23.56, these two ACL statements have the same effect:
8556 .code
8557 accept hosts = 127.0.0.1 : 10.45.23.56
8558 accept hosts = @[]
8559 .endd
8560 .next
8561 .cindex "CIDR notation"
8562 If the pattern is an IP address followed by a slash and a mask length (for
8563 example 10.11.42.0/24), it is matched against the IP address of the subject
8564 host under the given mask. This allows, an entire network of hosts to be
8565 included (or excluded) by a single item. The mask uses CIDR notation; it
8566 specifies the number of address bits that must match, starting from the most
8567 significant end of the address.
8568
8569 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8570 of a range of addresses. It is the number of bits in the network portion of the
8571 address. The above example specifies a 24-bit netmask, so it matches all 256
8572 addresses in the 10.11.42.0 network. An item such as
8573 .code
8574 192.168.23.236/31
8575 .endd
8576 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8577 32 for an IPv4 address is the same as no mask at all; just a single address
8578 matches.
8579
8580 Here is another example which shows an IPv4 and an IPv6 network:
8581 .code
8582 recipient_unqualified_hosts = 192.168.0.0/16: \
8583                               3ffe::ffff::836f::::/48
8584 .endd
8585 The doubling of list separator characters applies only when these items
8586 appear inline in a host list. It is not required when indirecting via a file.
8587 For example:
8588 .code
8589 recipient_unqualified_hosts = /opt/exim/unqualnets
8590 .endd
8591 could make use of a file containing
8592 .code
8593 172.16.0.0/12
8594 3ffe:ffff:836f::/48
8595 .endd
8596 to have exactly the same effect as the previous example. When listing IPv6
8597 addresses inline, it is usually more convenient to use the facility for
8598 changing separator characters. This list contains the same two networks:
8599 .code
8600 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8601                                  3ffe:ffff:836f::/48
8602 .endd
8603 The separator is changed to semicolon by the leading &"<;"& at the start of the
8604 list.
8605 .endlist
8606
8607
8608
8609 .section "Host list patterns for single-key lookups by host address" &&&
8610          "SECThoslispatsikey"
8611 .cindex "host list" "lookup of IP address"
8612 When a host is to be identified by a single-key lookup of its complete IP
8613 address, the pattern takes this form:
8614 .display
8615 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8616 .endd
8617 For example:
8618 .code
8619 hosts_lookup = net-cdb;/hosts-by-ip.db
8620 .endd
8621 The text form of the IP address of the subject host is used as the lookup key.
8622 IPv6 addresses are converted to an unabbreviated form, using lower case
8623 letters, with dots as separators because colon is the key terminator in
8624 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8625 quoting the keys, but this is a facility that was added later.] The data
8626 returned by the lookup is not used.
8627
8628 .cindex "IP address" "masking"
8629 .cindex "host list" "masked IP address"
8630 Single-key lookups can also be performed using masked IP addresses, using
8631 patterns of this form:
8632 .display
8633 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8634 .endd
8635 For example:
8636 .code
8637 net24-dbm;/networks.db
8638 .endd
8639 The IP address of the subject host is masked using <&'number'&> as the mask
8640 length. A textual string is constructed from the masked value, followed by the
8641 mask, and this is used as the lookup key. For example, if the host's IP address
8642 is 192.168.34.6, the key that is looked up for the above example is
8643 &"192.168.34.0/24"&.
8644
8645 When an IPv6 address is converted to a string, dots are normally used instead
8646 of colons, so that keys in &(lsearch)& files need not contain colons (which
8647 terminate &(lsearch)& keys). This was implemented some time before the ability
8648 to quote keys was made available in &(lsearch)& files. However, the more
8649 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8650 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8651 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8652 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8653 addresses are always used.
8654
8655 Ideally, it would be nice to tidy up this anomalous situation by changing to
8656 colons in all cases, given that quoting is now available for &(lsearch)&.
8657 However, this would be an incompatible change that might break some existing
8658 configurations.
8659
8660 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8661 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8662 the former case the key strings include the mask value, whereas in the latter
8663 case the IP address is used on its own.
8664
8665
8666
8667 .section "Host list patterns that match by host name" "SECThoslispatnam"
8668 .cindex "host" "lookup failures"
8669 .cindex "unknown host name"
8670 .cindex "host list" "matching host name"
8671 There are several types of pattern that require Exim to know the name of the
8672 remote host. These are either wildcard patterns or lookups by name. (If a
8673 complete hostname is given without any wildcarding, it is used to find an IP
8674 address to match against, as described in section &<<SECThoslispatip>>&
8675 above.)
8676
8677 If the remote host name is not already known when Exim encounters one of these
8678 patterns, it has to be found from the IP address.
8679 Although many sites on the Internet are conscientious about maintaining reverse
8680 DNS data for their hosts, there are also many that do not do this.
8681 Consequently, a name cannot always be found, and this may lead to unwanted
8682 effects. Take care when configuring host lists with wildcarded name patterns.
8683 Consider what will happen if a name cannot be found.
8684
8685 Because of the problems of determining host names from IP addresses, matching
8686 against host names is not as common as matching against IP addresses.
8687
8688 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8689 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8690 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8691 are done can be changed by setting the &%host_lookup_order%& option. For
8692 security, once Exim has found one or more names, it looks up the IP addresses
8693 for these names and compares them with the IP address that it started with.
8694 Only those names whose IP addresses match are accepted. Any other names are
8695 discarded. If no names are left, Exim behaves as if the host name cannot be
8696 found. In the most common case there is only one name and one IP address.
8697
8698 There are some options that control what happens if a host name cannot be
8699 found. These are described in section &<<SECTbehipnot>>& below.
8700
8701 .cindex "host" "alias for"
8702 .cindex "alias for host"
8703 As a result of aliasing, hosts may have more than one name. When processing any
8704 of the following types of pattern, all the host's names are checked:
8705
8706 .ilist
8707 .cindex "asterisk" "in host list"
8708 If a pattern starts with &"*"& the remainder of the item must match the end of
8709 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8710 &'.b.c'&. This special simple form is provided because this is a very common
8711 requirement. Other kinds of wildcarding require the use of a regular
8712 expression.
8713 .next
8714 .cindex "regular expressions" "in host list"
8715 .cindex "host list" "regular expression in"
8716 If the item starts with &"^"& it is taken to be a regular expression which is
8717 matched against the host name. Host names are case-independent, so this regular
8718 expression match is by default case-independent, but you can make it
8719 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8720 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8721 example,
8722 .code
8723 ^(a|b)\.c\.d$
8724 .endd
8725 is a regular expression that matches either of the two hosts &'a.c.d'& or
8726 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8727 that backslash and dollar characters are not misinterpreted as part of the
8728 string expansion. The simplest way to do this is to use &`\N`& to mark that
8729 part of the string as non-expandable. For example:
8730 .code
8731 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8732 .endd
8733 &*Warning*&: If you want to match a complete host name, you must include the
8734 &`$`& terminating metacharacter in the regular expression, as in the above
8735 example. Without it, a match at the start of the host name is all that is
8736 required.
8737 .endlist
8738
8739
8740
8741
8742 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8743 .cindex "host" "lookup failures, permanent"
8744 While processing a host list, Exim may need to look up an IP address from a
8745 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8746 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8747 behaviour when it fails to find the information it is seeking is the same.
8748
8749 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8750 apply to temporary DNS errors, whose handling is described in the next section.
8751
8752 .cindex "&`+include_unknown`&"
8753 .cindex "&`+ignore_unknown`&"
8754 Exim parses a host list from left to right. If it encounters a permanent
8755 lookup failure in any item in the host list before it has found a match,
8756 Exim treats it as a failure and the default behavior is as if the host
8757 does not match the list. This may not always be what you want to happen.
8758 To change Exim's behaviour, the special items &`+include_unknown`& or
8759 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8760 not recognized in an indirected file).
8761
8762 .ilist
8763 If any item that follows &`+include_unknown`& requires information that
8764 cannot found, Exim behaves as if the host does match the list. For example,
8765 .code
8766 host_reject_connection = +include_unknown:*.enemy.ex
8767 .endd
8768 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8769 any hosts whose name it cannot find.
8770
8771 .next
8772 If any item that follows &`+ignore_unknown`& requires information that cannot
8773 be found, Exim ignores that item and proceeds to the rest of the list. For
8774 example:
8775 .code
8776 accept hosts = +ignore_unknown : friend.example : \
8777                192.168.4.5
8778 .endd
8779 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8780 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8781 name can be found for 192.168.4.5, it is rejected.
8782 .endlist
8783
8784 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8785 list. The effect of each one lasts until the next, or until the end of the
8786 list.
8787
8788 .section "Mixing wildcarded host names and addresses in host lists" &&&
8789          "SECTmixwilhos"
8790 .cindex "host list" "mixing names and addresses in"
8791
8792 This section explains the host/ip processing logic with the same concepts
8793 as the previous section, but specifically addresses what happens when a
8794 wildcarded hostname is one of the items in the hostlist.
8795
8796 .ilist
8797 If you have name lookups or wildcarded host names and
8798 IP addresses in the same host list, you should normally put the IP
8799 addresses first. For example, in an ACL you could have:
8800 .code
8801 accept hosts = 10.9.8.7 : *.friend.example
8802 .endd
8803 The reason you normally would order it this way lies in the
8804 left-to-right way that Exim processes lists.  It can test IP addresses
8805 without doing any DNS lookups, but when it reaches an item that requires
8806 a host name, it fails if it cannot find a host name to compare with the
8807 pattern. If the above list is given in the opposite order, the
8808 &%accept%& statement fails for a host whose name cannot be found, even
8809 if its IP address is 10.9.8.7.
8810
8811 .next
8812 If you really do want to do the name check first, and still recognize the IP
8813 address, you can rewrite the ACL like this:
8814 .code
8815 accept hosts = *.friend.example
8816 accept hosts = 10.9.8.7
8817 .endd
8818 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8819 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8820 &`+ignore_unknown`&, which was discussed in depth in the first example in
8821 this section.
8822 .endlist
8823
8824
8825 .section "Temporary DNS errors when looking up host information" &&&
8826          "SECTtemdnserr"
8827 .cindex "host" "lookup failures, temporary"
8828 .cindex "&`+include_defer`&"
8829 .cindex "&`+ignore_defer`&"
8830 A temporary DNS lookup failure normally causes a defer action (except when
8831 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8832 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8833 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8834 section. These options should be used with care, probably only in non-critical
8835 host lists such as whitelists.
8836
8837
8838
8839 .section "Host list patterns for single-key lookups by host name" &&&
8840          "SECThoslispatnamsk"
8841 .cindex "unknown host name"
8842 .cindex "host list" "matching host name"
8843 If a pattern is of the form
8844 .display
8845 <&'single-key-search-type'&>;<&'search-data'&>
8846 .endd
8847 for example
8848 .code
8849 dbm;/host/accept/list
8850 .endd
8851 a single-key lookup is performed, using the host name as its key. If the
8852 lookup succeeds, the host matches the item. The actual data that is looked up
8853 is not used.
8854
8855 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8856 keys in the file, not IP addresses. If you want to do lookups based on IP
8857 addresses, you must precede the search type with &"net-"& (see section
8858 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8859 two items in the same list, one doing an address lookup and one doing a name
8860 lookup, both using the same file.
8861
8862
8863
8864 .section "Host list patterns for query-style lookups" "SECID81"
8865 If a pattern is of the form
8866 .display
8867 <&'query-style-search-type'&>;<&'query'&>
8868 .endd
8869 the query is obeyed, and if it succeeds, the host matches the item. The actual
8870 data that is looked up is not used. The variables &$sender_host_address$& and
8871 &$sender_host_name$& can be used in the query. For example:
8872 .code
8873 hosts_lookup = pgsql;\
8874   select ip from hostlist where ip='$sender_host_address'
8875 .endd
8876 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8877 can use the &%sg%& expansion item to change this if you need to. If you want to
8878 use masked IP addresses in database queries, you can use the &%mask%& expansion
8879 operator.
8880
8881 If the query contains a reference to &$sender_host_name$&, Exim automatically
8882 looks up the host name if it has not already done so. (See section
8883 &<<SECThoslispatnam>>& for comments on finding host names.)
8884
8885 Historical note: prior to release 4.30, Exim would always attempt to find a
8886 host name before running the query, unless the search type was preceded by
8887 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8888 still recognized for query-style lookups, but its presence or absence has no
8889 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8890 See section &<<SECThoslispatsikey>>&.)
8891
8892
8893
8894
8895
8896 .section "Address lists" "SECTaddresslist"
8897 .cindex "list" "address list"
8898 .cindex "address list" "empty item"
8899 .cindex "address list" "patterns"
8900 Address lists contain patterns that are matched against mail addresses. There
8901 is one special case to be considered: the sender address of a bounce message is
8902 always empty. You can test for this by providing an empty item in an address
8903 list. For example, you can set up a router to process bounce messages by
8904 using this option setting:
8905 .code
8906 senders = :
8907 .endd
8908 The presence of the colon creates an empty item. If you do not provide any
8909 data, the list is empty and matches nothing. The empty sender can also be
8910 detected by a regular expression that matches an empty string,
8911 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8912
8913 Non-empty items in an address list can be straightforward email addresses. For
8914 example:
8915 .code
8916 senders = jbc@askone.example : hs@anacreon.example
8917 .endd
8918 A certain amount of wildcarding is permitted. If a pattern contains an @
8919 character, but is not a regular expression and does not begin with a
8920 semicolon-terminated lookup type (described below), the local part of the
8921 subject address is compared with the local part of the pattern, which may start
8922 with an asterisk. If the local parts match, the domain is checked in exactly
8923 the same way as for a pattern in a domain list. For example, the domain can be
8924 wildcarded, refer to a named list, or be a lookup:
8925 .code
8926 deny senders = *@*.spamming.site:\
8927                *@+hostile_domains:\
8928                bozo@partial-lsearch;/list/of/dodgy/sites:\
8929                *@dbm;/bad/domains.db
8930 .endd
8931 .cindex "local part" "starting with !"
8932 .cindex "address list" "local part starting with !"
8933 If a local part that begins with an exclamation mark is required, it has to be
8934 specified using a regular expression, because otherwise the exclamation mark is
8935 treated as a sign of negation, as is standard in lists.
8936
8937 If a non-empty pattern that is not a regular expression or a lookup does not
8938 contain an @ character, it is matched against the domain part of the subject
8939 address. The only two formats that are recognized this way are a literal
8940 domain, or a domain pattern that starts with *. In both these cases, the effect
8941 is the same as if &`*@`& preceded the pattern. For example:
8942 .code
8943 deny senders = enemy.domain : *.enemy.domain
8944 .endd
8945
8946 The following kinds of more complicated address list pattern can match any
8947 address, including the empty address that is characteristic of bounce message
8948 senders:
8949
8950 .ilist
8951 .cindex "regular expressions" "in address list"
8952 .cindex "address list" "regular expression in"
8953 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8954 done against the complete address, with the pattern as the regular expression.
8955 You must take care that backslash and dollar characters are not misinterpreted
8956 as part of the string expansion. The simplest way to do this is to use &`\N`&
8957 to mark that part of the string as non-expandable. For example:
8958 .code
8959 deny senders = \N^.*this.*@example\.com$\N : \
8960                \N^\d{8}.+@spamhaus.example$\N : ...
8961 .endd
8962 The &`\N`& sequences are removed by the expansion, so these items do indeed
8963 start with &"^"& by the time they are being interpreted as address patterns.
8964
8965 .next
8966 .cindex "address list" "lookup for complete address"
8967 Complete addresses can be looked up by using a pattern that starts with a
8968 lookup type terminated by a semicolon, followed by the data for the lookup. For
8969 example:
8970 .code
8971 deny senders = cdb;/etc/blocked.senders : \
8972   mysql;select address from blocked where \
8973   address='${quote_mysql:$sender_address}'
8974 .endd
8975 Both query-style and single-key lookup types can be used. For a single-key
8976 lookup type, Exim uses the complete address as the key. However, empty keys are
8977 not supported for single-key lookups, so a match against the empty address
8978 always fails. This restriction does not apply to query-style lookups.
8979
8980 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8981 cannot be used, and is ignored if specified, with an entry being written to the
8982 panic log.
8983 .cindex "*@ with single-key lookup"
8984 However, you can configure lookup defaults, as described in section
8985 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8986 default. For example, with this lookup:
8987 .code
8988 accept senders = lsearch*@;/some/file
8989 .endd
8990 the file could contains lines like this:
8991 .code
8992 user1@domain1.example
8993 *@domain2.example
8994 .endd
8995 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8996 that are tried is:
8997 .code
8998 nimrod@jaeger.example
8999 *@jaeger.example
9000 *
9001 .endd
9002 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9003 would mean that every address matches, thus rendering the test useless.
9004
9005 &*Warning 2*&: Do not confuse these two kinds of item:
9006 .code
9007 deny recipients = dbm*@;/some/file
9008 deny recipients = *@dbm;/some/file
9009 .endd
9010 The first does a whole address lookup, with defaulting, as just described,
9011 because it starts with a lookup type. The second matches the local part and
9012 domain independently, as described in a bullet point below.
9013 .endlist
9014
9015
9016 The following kinds of address list pattern can match only non-empty addresses.
9017 If the subject address is empty, a match against any of these pattern types
9018 always fails.
9019
9020
9021 .ilist
9022 .cindex "@@ with single-key lookup"
9023 .cindex "address list" "@@ lookup type"
9024 .cindex "address list" "split local part and domain"
9025 If a pattern starts with &"@@"& followed by a single-key lookup item
9026 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9027 split into a local part and a domain. The domain is looked up in the file. If
9028 it is not found, there is no match. If it is found, the data that is looked up
9029 from the file is treated as a colon-separated list of local part patterns, each
9030 of which is matched against the subject local part in turn.
9031
9032 .cindex "asterisk" "in address list"
9033 The lookup may be a partial one, and/or one involving a search for a default
9034 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9035 patterns that are looked up can be regular expressions or begin with &"*"&, or
9036 even be further lookups. They may also be independently negated. For example,
9037 with
9038 .code
9039 deny senders = @@dbm;/etc/reject-by-domain
9040 .endd
9041 the data from which the DBM file is built could contain lines like
9042 .code
9043 baddomain.com:  !postmaster : *
9044 .endd
9045 to reject all senders except &%postmaster%& from that domain.
9046
9047 .cindex "local part" "starting with !"
9048 If a local part that actually begins with an exclamation mark is required, it
9049 has to be specified using a regular expression. In &(lsearch)& files, an entry
9050 may be split over several lines by indenting the second and subsequent lines,
9051 but the separating colon must still be included at line breaks. White space
9052 surrounding the colons is ignored. For example:
9053 .code
9054 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9055   spammer3 : spammer4
9056 .endd
9057 As in all colon-separated lists in Exim, a colon can be included in an item by
9058 doubling.
9059
9060 If the last item in the list starts with a right angle-bracket, the remainder
9061 of the item is taken as a new key to look up in order to obtain a continuation
9062 list of local parts. The new key can be any sequence of characters. Thus one
9063 might have entries like
9064 .code
9065 aol.com: spammer1 : spammer 2 : >*
9066 xyz.com: spammer3 : >*
9067 *:       ^\d{8}$
9068 .endd
9069 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9070 local parts for all domains, in addition to the specific local parts listed for
9071 each domain. Of course, using this feature costs another lookup each time a
9072 chain is followed, but the effort needed to maintain the data is reduced.
9073
9074 .cindex "loop" "in lookups"
9075 It is possible to construct loops using this facility, and in order to catch
9076 them, the chains may be no more than fifty items long.
9077
9078 .next
9079 The @@<&'lookup'&> style of item can also be used with a query-style
9080 lookup, but in this case, the chaining facility is not available. The lookup
9081 can only return a single list of local parts.
9082 .endlist
9083
9084 &*Warning*&: There is an important difference between the address list items
9085 in these two examples:
9086 .code
9087 senders = +my_list
9088 senders = *@+my_list
9089 .endd
9090 In the first one, &`my_list`& is a named address list, whereas in the second
9091 example it is a named domain list.
9092
9093
9094
9095
9096 .section "Case of letters in address lists" "SECTcasletadd"
9097 .cindex "case of local parts"
9098 .cindex "address list" "case forcing"
9099 .cindex "case forcing in address lists"
9100 Domains in email addresses are always handled caselessly, but for local parts
9101 case may be significant on some systems (see &%caseful_local_part%& for how
9102 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9103 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9104 blocking lists should be done in a case-independent manner. Since most address
9105 lists in Exim are used for this kind of control, Exim attempts to do this by
9106 default.
9107
9108 The domain portion of an address is always lowercased before matching it to an
9109 address list. The local part is lowercased by default, and any string
9110 comparisons that take place are done caselessly. This means that the data in
9111 the address list itself, in files included as plain file names, and in any file
9112 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9113 keys in files that are looked up by a search type other than &(lsearch)& (which
9114 works caselessly) must be in lower case, because these lookups are not
9115 case-independent.
9116
9117 .cindex "&`+caseful`&"
9118 To allow for the possibility of caseful address list matching, if an item in
9119 an address list is the string &"+caseful"&, the original case of the local
9120 part is restored for any comparisons that follow, and string comparisons are no
9121 longer case-independent. This does not affect the domain, which remains in
9122 lower case. However, although independent matches on the domain alone are still
9123 performed caselessly, regular expressions that match against an entire address
9124 become case-sensitive after &"+caseful"& has been seen.
9125
9126
9127
9128 .section "Local part lists" "SECTlocparlis"
9129 .cindex "list" "local part list"
9130 .cindex "local part" "list"
9131 Case-sensitivity in local part lists is handled in the same way as for address
9132 lists, as just described. The &"+caseful"& item can be used if required. In a
9133 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9134 set false, the subject is lowercased and the matching is initially
9135 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9136 matching in the local part list, but not elsewhere in the router. If
9137 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9138 option is case-sensitive from the start.
9139
9140 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9141 comments are handled in the same way as address lists &-- they are recognized
9142 only if the # is preceded by white space or the start of the line.
9143 Otherwise, local part lists are matched in the same way as domain lists, except
9144 that the special items that refer to the local host (&`@`&, &`@[]`&,
9145 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9146 Refer to section &<<SECTdomainlist>>& for details of the other available item
9147 types.
9148 .ecindex IIDdohoadli
9149
9150
9151
9152
9153 . ////////////////////////////////////////////////////////////////////////////
9154 . ////////////////////////////////////////////////////////////////////////////
9155
9156 .chapter "String expansions" "CHAPexpand"
9157 .scindex IIDstrexp "expansion" "of strings"
9158 Many strings in Exim's run time configuration are expanded before use. Some of
9159 them are expanded every time they are used; others are expanded only once.
9160
9161 When a string is being expanded it is copied verbatim from left to right except
9162 when a dollar or backslash character is encountered. A dollar specifies the
9163 start of a portion of the string that is interpreted and replaced as described
9164 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9165 escape character, as described in the following section.
9166
9167 Whether a string is expanded depends upon the context.  Usually this is solely
9168 dependent upon the option for which a value is sought; in this documentation,
9169 options for which string expansion is performed are marked with &dagger; after
9170 the data type.  ACL rules always expand strings.  A couple of expansion
9171 conditions do not expand some of the brace-delimited branches, for security
9172 reasons.
9173
9174
9175
9176 .section "Literal text in expanded strings" "SECTlittext"
9177 .cindex "expansion" "including literal text"
9178 An uninterpreted dollar can be included in an expanded string by putting a
9179 backslash in front of it. A backslash can be used to prevent any special
9180 character being treated specially in an expansion, including backslash itself.
9181 If the string appears in quotes in the configuration file, two backslashes are
9182 required because the quotes themselves cause interpretation of backslashes when
9183 the string is read in (see section &<<SECTstrings>>&).
9184
9185 .cindex "expansion" "non-expandable substrings"
9186 A portion of the string can specified as non-expandable by placing it between
9187 two occurrences of &`\N`&. This is particularly useful for protecting regular
9188 expressions, which often contain backslashes and dollar signs. For example:
9189 .code
9190 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9191 .endd
9192 On encountering the first &`\N`&, the expander copies subsequent characters
9193 without interpretation until it reaches the next &`\N`& or the end of the
9194 string.
9195
9196
9197
9198 .section "Character escape sequences in expanded strings" "SECID82"
9199 .cindex "expansion" "escape sequences"
9200 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9201 expanded string is recognized as an escape sequence for the character newline,
9202 carriage return, or tab, respectively. A backslash followed by up to three
9203 octal digits is recognized as an octal encoding for a single character, and a
9204 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9205 encoding.
9206
9207 These escape sequences are also recognized in quoted strings when they are read
9208 in. Their interpretation in expansions as well is useful for unquoted strings,
9209 and for other cases such as looked-up strings that are then expanded.
9210
9211
9212 .section "Testing string expansions" "SECID83"
9213 .cindex "expansion" "testing"
9214 .cindex "testing" "string expansion"
9215 .oindex "&%-be%&"
9216 Many expansions can be tested by calling Exim with the &%-be%& option. This
9217 takes the command arguments, or lines from the standard input if there are no
9218 arguments, runs them through the string expansion code, and writes the results
9219 to the standard output. Variables based on configuration values are set up, but
9220 since no message is being processed, variables such as &$local_part$& have no
9221 value. Nevertheless the &%-be%& option can be useful for checking out file and
9222 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9223 and &%nhash%&.
9224
9225 Exim gives up its root privilege when it is called with the &%-be%& option, and
9226 instead runs under the uid and gid it was called with, to prevent users from
9227 using &%-be%& for reading files to which they do not have access.
9228
9229 .oindex "&%-bem%&"
9230 If you want to test expansions that include variables whose values are taken
9231 from a message, there are two other options that can be used. The &%-bem%&
9232 option is like &%-be%& except that it is followed by a file name. The file is
9233 read as a message before doing the test expansions. For example:
9234 .code
9235 exim -bem /tmp/test.message '$h_subject:'
9236 .endd
9237 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9238 Exim message identifier. For example:
9239 .code
9240 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9241 .endd
9242 This loads the message from Exim's spool before doing the test expansions, and
9243 is therefore restricted to admin users.
9244
9245
9246 .section "Forced expansion failure" "SECTforexpfai"
9247 .cindex "expansion" "forced failure"
9248 A number of expansions that are described in the following section have
9249 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9250 (which are sometimes called &"curly brackets"&). Which of the two strings is
9251 used depends on some condition that is evaluated as part of the expansion. If,
9252 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9253 the entire string expansion fails in a way that can be detected by the code
9254 that requested the expansion. This is called &"forced expansion failure"&, and
9255 its consequences depend on the circumstances. In some cases it is no different
9256 from any other expansion failure, but in others a different action may be
9257 taken. Such variations are mentioned in the documentation of the option that is
9258 being expanded.
9259
9260
9261
9262
9263 .section "Expansion items" "SECTexpansionitems"
9264 The following items are recognized in expanded strings. White space may be used
9265 between sub-items that are keywords or substrings enclosed in braces inside an
9266 outer set of braces, to improve readability. &*Warning*&: Within braces,
9267 white space is significant.
9268
9269 .vlist
9270 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9271 .cindex "expansion" "variables"
9272 Substitute the contents of the named variable, for example:
9273 .code
9274 $local_part
9275 ${domain}
9276 .endd
9277 The second form can be used to separate the name from subsequent alphanumeric
9278 characters. This form (using braces) is available only for variables; it does
9279 &'not'& apply to message headers. The names of the variables are given in
9280 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9281 given, the expansion fails.
9282
9283 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9284 .cindex "expansion" "operators"
9285 The string is first itself expanded, and then the operation specified by
9286 <&'op'&> is applied to it. For example:
9287 .code
9288 ${lc:$local_part}
9289 .endd
9290 The string starts with the first character after the colon, which may be
9291 leading white space. A list of operators is given in section &<<SECTexpop>>&
9292 below. The operator notation is used for simple expansion items that have just
9293 one argument, because it reduces the number of braces and therefore makes the
9294 string easier to understand.
9295
9296 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9297 This item inserts &"basic"& header lines. It is described with the &%header%&
9298 expansion item below.
9299
9300
9301 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9302 .cindex "expansion" "calling an acl"
9303 .cindex "&%acl%&" "call from expansion"
9304 The name and zero to nine argument strings are first expanded separately.  The expanded
9305 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9306 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9307 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9308 and may use the variables; if another acl expansion is used the values
9309 are restored after it returns.  If the ACL sets
9310 a value using a "message =" modifier and returns accept or deny, the value becomes
9311 the result of the expansion.
9312 If no message is set and the ACL returns accept or deny
9313 the expansion result is an empty string.
9314 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9315
9316
9317 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9318 .cindex authentication "results header"
9319 .cindex headers "authentication-results:"
9320 .cindex authentication "expansion item"
9321 This item returns a string suitable for insertion as an
9322 &'Authentication-Results"'&
9323 header line.
9324 The given <&'authserv-id'&> is included in the result; typically this
9325 will be a domain name identifying the system performing the authentications.
9326 Methods that might be present in the result include:
9327 .code
9328 none
9329 iprev
9330 auth
9331 spf
9332 dkim
9333 .endd
9334
9335 Example use (as an ACL modifier):
9336 .code
9337       add_header = :at_start:${authresults {$primary_hostname}}
9338 .endd
9339 This is safe even if no authentication results are available.
9340
9341
9342 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9343        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9344 .cindex "expansion" "extracting certificate fields"
9345 .cindex "&%certextract%&" "certificate fields"
9346 .cindex "certificate" "extracting fields"
9347 The <&'certificate'&> must be a variable of type certificate.
9348 The field name is expanded and used to retrieve the relevant field from
9349 the certificate.  Supported fields are:
9350 .display
9351 &`version        `&
9352 &`serial_number  `&
9353 &`subject        `& RFC4514 DN
9354 &`issuer         `& RFC4514 DN
9355 &`notbefore      `& time
9356 &`notafter       `& time
9357 &`sig_algorithm  `&
9358 &`signature      `&
9359 &`subj_altname   `& tagged list
9360 &`ocsp_uri       `& list
9361 &`crl_uri        `& list
9362 .endd
9363 If the field is found,
9364 <&'string2'&> is expanded, and replaces the whole item;
9365 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9366 variable &$value$& contains the value that has been extracted. Afterwards, it
9367 is restored to any previous value it might have had.
9368
9369 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9370 key is not found. If {<&'string2'&>} is also omitted, the value that was
9371 extracted is used.
9372
9373 Some field names take optional modifiers, appended and separated by commas.
9374
9375 The field selectors marked as "RFC4514" above
9376 output a Distinguished Name string which is
9377 not quite
9378 parseable by Exim as a comma-separated tagged list
9379 (the exceptions being elements containing commas).
9380 RDN elements of a single type may be selected by
9381 a modifier of the type label; if so the expansion
9382 result is a list (newline-separated by default).
9383 The separator may be changed by another modifier of
9384 a right angle-bracket followed immediately by the new separator.
9385 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9386
9387 The field selectors marked as "time" above
9388 take an optional modifier of "int"
9389 for which the result is the number of seconds since epoch.
9390 Otherwise the result is a human-readable string
9391 in the timezone selected by the main "timezone" option.
9392
9393 The field selectors marked as "list" above return a list,
9394 newline-separated by default,
9395 (embedded separator characters in elements are doubled).
9396 The separator may be changed by a modifier of
9397 a right angle-bracket followed immediately by the new separator.
9398
9399 The field selectors marked as "tagged" above
9400 prefix each list element with a type string and an equals sign.
9401 Elements of only one type may be selected by a modifier
9402 which is one of "dns", "uri" or "mail";
9403 if so the element tags are omitted.
9404
9405 If not otherwise noted field values are presented in human-readable form.
9406
9407 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9408        {*&<&'arg'&>&*}...}*&"
9409 .cindex &%dlfunc%&
9410 This expansion dynamically loads and then calls a locally-written C function.
9411 This functionality is available only if Exim is compiled with
9412 .code
9413 EXPAND_DLFUNC=yes
9414 .endd
9415 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9416 object so that it doesn't reload the same object file in the same Exim process
9417 (but of course Exim does start new processes frequently).
9418
9419 There may be from zero to eight arguments to the function. When compiling
9420 a local function that is to be called in this way, &_local_scan.h_& should be
9421 included. The Exim variables and functions that are defined by that API
9422 are also available for dynamically loaded functions. The function itself
9423 must have the following type:
9424 .code
9425 int dlfunction(uschar **yield, int argc, uschar *argv[])
9426 .endd
9427 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9428 function should return one of the following values:
9429
9430 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9431 into the expanded string that is being built.
9432
9433 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9434 from &'yield'&, if it is set.
9435
9436 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9437 taken from &'yield'& if it is set.
9438
9439 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9440
9441 When compiling a function that is to be used in this way with gcc,
9442 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9443 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9444
9445
9446 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9447 .cindex "expansion" "extracting value from environment"
9448 .cindex "environment" "values from"
9449 The key is first expanded separately, and leading and trailing white space
9450 removed.
9451 This is then searched for as a name in the environment.
9452 If a variable is found then its value is placed in &$value$&
9453 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9454
9455 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9456 appear, for example:
9457 .code
9458 ${env{USER}{$value} fail }
9459 .endd
9460 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9461 {<&'string1'&>} must be present for &"fail"& to be recognized.
9462
9463 If {<&'string2'&>} is omitted an empty string is substituted on
9464 search failure.
9465 If {<&'string1'&>} is omitted the search result is substituted on
9466 search success.
9467
9468 The environment is adjusted by the &%keep_environment%& and
9469 &%add_environment%& main section options.
9470
9471
9472 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9473        {*&<&'string3'&>&*}}*&"
9474 .cindex "expansion" "extracting substrings by key"
9475 .cindex "&%extract%&" "substrings by key"
9476 The key and <&'string1'&> are first expanded separately. Leading and trailing
9477 white space is removed from the key (but not from any of the strings). The key
9478 must not be empty and must not consist entirely of digits.
9479 The expanded <&'string1'&> must be of the form:
9480 .display
9481 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9482 .endd
9483 .vindex "&$value$&"
9484 where the equals signs and spaces (but not both) are optional. If any of the
9485 values contain white space, they must be enclosed in double quotes, and any
9486 values that are enclosed in double quotes are subject to escape processing as
9487 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9488 for the value that corresponds to the key. The search is case-insensitive. If
9489 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9490 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9491 variable &$value$& contains the value that has been extracted. Afterwards, it
9492 is restored to any previous value it might have had.
9493
9494 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9495 key is not found. If {<&'string2'&>} is also omitted, the value that was
9496 extracted is used. Thus, for example, these two expansions are identical, and
9497 yield &"2001"&:
9498 .code
9499 ${extract{gid}{uid=1984 gid=2001}}
9500 ${extract{gid}{uid=1984 gid=2001}{$value}}
9501 .endd
9502 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9503 appear, for example:
9504 .code
9505 ${extract{Z}{A=... B=...}{$value} fail }
9506 .endd
9507 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9508 {<&'string2'&>} must be present for &"fail"& to be recognized.
9509
9510 .new
9511 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9512        {*&<&'string3'&>&*}}*&"
9513 .cindex "expansion" "extracting from JSON object"
9514 .cindex JSON expansions
9515 The key and <&'string1'&> are first expanded separately. Leading and trailing
9516 white space is removed from the key (but not from any of the strings). The key
9517 must not be empty and must not consist entirely of digits.
9518 The expanded <&'string1'&> must be of the form:
9519 .display
9520 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9521 .endd
9522 .vindex "&$value$&"
9523 The braces, commas and colons, and the quoting of the member name are required;
9524 the spaces are optional.
9525 Matching of the key against the member names is done case-sensitively.
9526 . XXX should be a UTF-8 compare
9527
9528 The results of matching are handled as above.
9529 .wen
9530
9531
9532 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9533         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9534 .cindex "expansion" "extracting substrings by number"
9535 .cindex "&%extract%&" "substrings by number"
9536 The <&'number'&> argument must consist entirely of decimal digits,
9537 apart from leading and trailing white space, which is ignored.
9538 This is what distinguishes this form of &%extract%& from the previous kind. It
9539 behaves in the same way, except that, instead of extracting a named field, it
9540 extracts from <&'string1'&> the field whose number is given as the first
9541 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9542 <&'string3'&> as before.
9543
9544 The fields in the string are separated by any one of the characters in the
9545 separator string. These may include space or tab characters.
9546 The first field is numbered one. If the number is negative, the fields are
9547 counted from the end of the string, with the rightmost one numbered -1. If the
9548 number given is zero, the entire string is returned. If the modulus of the
9549 number is greater than the number of fields in the string, the result is the
9550 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9551 provided. For example:
9552 .code
9553 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9554 .endd
9555 yields &"42"&, and
9556 .code
9557 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9558 .endd
9559 yields &"99"&. Two successive separators mean that the field between them is
9560 empty (for example, the fifth field above).
9561
9562
9563 .new
9564 .vitem "&*${extract json{*&<&'number'&>&*}}&&&
9565         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9566 .cindex "expansion" "extracting from JSON array"
9567 .cindex JSON expansions
9568 The <&'number'&> argument must consist entirely of decimal digits,
9569 apart from leading and trailing white space, which is ignored.
9570
9571 Field selection and result handling is as above;
9572 there is no choice of field separator.
9573 .wen
9574
9575
9576 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9577 .cindex "list" "selecting by condition"
9578 .cindex "expansion" "selecting from list by condition"
9579 .vindex "&$item$&"
9580 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9581 default, but the separator can be changed in the usual way. For each item
9582 in this list, its value is place in &$item$&, and then the condition is
9583 evaluated. If the condition is true, &$item$& is added to the output as an
9584 item in a new list; if the condition is false, the item is discarded. The
9585 separator used for the output list is the same as the one used for the
9586 input, but a separator setting is not included in the output. For example:
9587 .code
9588 ${filter{a:b:c}{!eq{$item}{b}}}
9589 .endd
9590 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9591 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9592
9593
9594 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9595 .cindex "hash function" "textual"
9596 .cindex "expansion" "textual hash"
9597 This is a textual hashing function, and was the first to be implemented in
9598 early versions of Exim. In current releases, there are other hashing functions
9599 (numeric, MD5, and SHA-1), which are described below.
9600
9601 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9602 <&'n'&>. If you are using fixed values for these numbers, that is, if
9603 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9604 use the simpler operator notation that avoids some of the braces:
9605 .code
9606 ${hash_<n>_<m>:<string>}
9607 .endd
9608 The second number is optional (in both notations). If <&'n'&> is greater than
9609 or equal to the length of the string, the expansion item returns the string.
9610 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9611 function to the string. The new string consists of characters taken from the
9612 first <&'m'&> characters of the string
9613 .code
9614 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9615 .endd
9616 If <&'m'&> is not present the value 26 is used, so that only lower case
9617 letters appear. For example:
9618 .display
9619 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9620 &`$hash{5}{monty}}           `&   yields  &`monty`&
9621 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9622 .endd
9623
9624 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9625         &*$h_*&<&'header&~name'&>&*:*&" &&&
9626        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9627         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9628        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9629         &*$lh_*&<&'header&~name'&>&*:*&"
9630        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9631         &*$rh_*&<&'header&~name'&>&*:*&"
9632 .cindex "expansion" "header insertion"
9633 .vindex "&$header_$&"
9634 .vindex "&$bheader_$&"
9635 .vindex "&$lheader_$&"
9636 .vindex "&$rheader_$&"
9637 .cindex "header lines" "in expansion strings"
9638 .cindex "header lines" "character sets"
9639 .cindex "header lines" "decoding"
9640 Substitute the contents of the named message header line, for example
9641 .code
9642 $header_reply-to:
9643 .endd
9644 The newline that terminates a header line is not included in the expansion, but
9645 internal newlines (caused by splitting the header line over several physical
9646 lines) may be present.
9647
9648 The difference between the four pairs of expansions is in the way
9649 the data in the header line is interpreted.
9650
9651 .ilist
9652 .cindex "white space" "in header lines"
9653 &%rheader%& gives the original &"raw"& content of the header line, with no
9654 processing at all, and without the removal of leading and trailing white space.
9655
9656 .next
9657 .cindex "list" "of header lines"
9658 &%lheader%& gives a colon-separated list, one element per header when there
9659 are multiple headers with a given name.
9660 Any embedded colon characters within an element are doubled, so normal Exim
9661 list-processing facilities can be used.
9662 The terminating newline of each element is removed; in other respects
9663 the content is &"raw"&.
9664
9665 .next
9666 .cindex "base64 encoding" "in header lines"
9667 &%bheader%& removes leading and trailing white space, and then decodes base64
9668 or quoted-printable MIME &"words"& within the header text, but does no
9669 character set translation. If decoding of what looks superficially like a MIME
9670 &"word"& fails, the raw string is returned. If decoding
9671 .cindex "binary zero" "in header line"
9672 produces a binary zero character, it is replaced by a question mark &-- this is
9673 what Exim does for binary zeros that are actually received in header lines.
9674
9675 .next
9676 &%header%& tries to translate the string as decoded by &%bheader%& to a
9677 standard character set. This is an attempt to produce the same string as would
9678 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9679 returned. Translation is attempted only on operating systems that support the
9680 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9681 a system Makefile or in &_Local/Makefile_&.
9682 .endlist ilist
9683
9684 In a filter file, the target character set for &%header%& can be specified by a
9685 command of the following form:
9686 .code
9687 headers charset "UTF-8"
9688 .endd
9689 This command affects all references to &$h_$& (or &$header_$&) expansions in
9690 subsequently obeyed filter commands. In the absence of this command, the target
9691 character set in a filter is taken from the setting of the &%headers_charset%&
9692 option in the runtime configuration. The value of this option defaults to the
9693 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9694 ISO-8859-1.
9695
9696 Header names follow the syntax of RFC 2822, which states that they may contain
9697 any printing characters except space and colon. Consequently, curly brackets
9698 &'do not'& terminate header names, and should not be used to enclose them as
9699 if they were variables. Attempting to do so causes a syntax error.
9700
9701 Only header lines that are common to all copies of a message are visible to
9702 this mechanism. These are the original header lines that are received with the
9703 message, and any that are added by an ACL statement or by a system
9704 filter. Header lines that are added to a particular copy of a message by a
9705 router or transport are not accessible.
9706
9707 For incoming SMTP messages, no header lines are visible in
9708 ACLs that are obeyed before the data phase completes,
9709 because the header structure is not set up until the message is received.
9710 They are visible in DKIM, PRDR and DATA ACLs.
9711 Header lines that are added in a RCPT ACL (for example)
9712 are saved until the message's incoming header lines are available, at which
9713 point they are added.
9714 When any of the above ACLs ar
9715 running, however, header lines added by earlier ACLs are visible.
9716
9717 Upper case and lower case letters are synonymous in header names. If the
9718 following character is white space, the terminating colon may be omitted, but
9719 this is not recommended, because you may then forget it when it is needed. When
9720 white space terminates the header name, this white space is included in the
9721 expanded string.  If the message does not contain the given header, the
9722 expansion item is replaced by an empty string. (See the &%def%& condition in
9723 section &<<SECTexpcond>>& for a means of testing for the existence of a
9724 header.)
9725
9726 If there is more than one header with the same name, they are all concatenated
9727 to form the substitution string, up to a maximum length of 64K. Unless
9728 &%rheader%& is being used, leading and trailing white space is removed from
9729 each header before concatenation, and a completely empty header is ignored. A
9730 newline character is then inserted between non-empty headers, but there is no
9731 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9732 those headers that contain lists of addresses, a comma is also inserted at the
9733 junctions between headers. This does not happen for the &%rheader%& expansion.
9734
9735
9736 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9737 .cindex "expansion" "hmac hashing"
9738 .cindex &%hmac%&
9739 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9740 shared secret and some text into a message authentication code, as specified in
9741 RFC 2104. This differs from &`${md5:secret_text...}`& or
9742 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9743 cryptographic hash, allowing for authentication that is not possible with MD5
9744 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9745 present. For example:
9746 .code
9747 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9748 .endd
9749 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9750 produces:
9751 .code
9752 dd97e3ba5d1a61b5006108f8c8252953
9753 .endd
9754 As an example of how this might be used, you might put in the main part of
9755 an Exim configuration:
9756 .code
9757 SPAMSCAN_SECRET=cohgheeLei2thahw
9758 .endd
9759 In a router or a transport you could then have:
9760 .code
9761 headers_add = \
9762   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9763   ${hmac{md5}{SPAMSCAN_SECRET}\
9764   {${primary_hostname},${message_exim_id},$h_message-id:}}
9765 .endd
9766 Then given a message, you can check where it was scanned by looking at the
9767 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9768 this header line is authentic by recomputing the authentication code from the
9769 host name, message ID and the &'Message-id:'& header line. This can be done
9770 using Exim's &%-be%& option, or by other means, for example by using the
9771 &'hmac_md5_hex()'& function in Perl.
9772
9773
9774 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9775 .cindex "expansion" "conditional"
9776 .cindex "&%if%&, expansion item"
9777 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9778 item; otherwise <&'string2'&> is used. The available conditions are described
9779 in section &<<SECTexpcond>>& below. For example:
9780 .code
9781 ${if eq {$local_part}{postmaster} {yes}{no} }
9782 .endd
9783 The second string need not be present; if it is not and the condition is not
9784 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9785 be present instead of the second string (without any curly brackets). In this
9786 case, the expansion is forced to fail if the condition is not true (see section
9787 &<<SECTforexpfai>>&).
9788
9789 If both strings are omitted, the result is the string &`true`& if the condition
9790 is true, and the empty string if the condition is false. This makes it less
9791 cumbersome to write custom ACL and router conditions. For example, instead of
9792 .code
9793 condition = ${if >{$acl_m4}{3}{true}{false}}
9794 .endd
9795 you can use
9796 .code
9797 condition = ${if >{$acl_m4}{3}}
9798 .endd
9799
9800
9801
9802 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9803 .cindex expansion "imap folder"
9804 .cindex "&%imapfolder%& expansion item"
9805 This item converts a (possibly multilevel, or with non-ASCII characters)
9806 folder specification to a Maildir name for filesystem use.
9807 For information on internationalisation support see &<<SECTi18nMDA>>&.
9808
9809
9810
9811 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9812 .cindex "expansion" "string truncation"
9813 .cindex "&%length%& expansion item"
9814 The &%length%& item is used to extract the initial portion of a string. Both
9815 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9816 you are using a fixed value for the number, that is, if <&'string1'&> does not
9817 change when expanded, you can use the simpler operator notation that avoids
9818 some of the braces:
9819 .code
9820 ${length_<n>:<string>}
9821 .endd
9822 The result of this item is either the first <&'n'&> bytes or the whole
9823 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9824 &%strlen%&, which gives the length of a string.
9825 All measurement is done in bytes and is not UTF-8 aware.
9826
9827
9828 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9829         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9830 .cindex "expansion" "extracting list elements by number"
9831 .cindex "&%listextract%&" "extract list elements by number"
9832 .cindex "list" "extracting elements by number"
9833 The <&'number'&> argument must consist entirely of decimal digits,
9834 apart from an optional leading minus,
9835 and leading and trailing white space (which is ignored).
9836
9837 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9838 default, but the separator can be changed in the usual way.
9839
9840 The first field of the list is numbered one.
9841 If the number is negative, the fields are
9842 counted from the end of the list, with the rightmost one numbered -1.
9843 The numbered element of the list is extracted and placed in &$value$&,
9844 then <&'string2'&> is expanded as the result.
9845
9846 If the modulus of the
9847 number is zero or greater than the number of fields in the string,
9848 the result is the expansion of <&'string3'&>.
9849
9850 For example:
9851 .code
9852 ${listextract{2}{x:42:99}}
9853 .endd
9854 yields &"42"&, and
9855 .code
9856 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9857 .endd
9858 yields &"result: 42"&.
9859
9860 If {<&'string3'&>} is omitted, an empty string is used for string3.
9861 If {<&'string2'&>} is also omitted, the value that was
9862 extracted is used.
9863 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9864
9865
9866 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9867         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9868 This is the first of one of two different types of lookup item, which are both
9869 described in the next item.
9870
9871 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9872         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9873 .cindex "expansion" "lookup in"
9874 .cindex "file" "lookups"
9875 .cindex "lookup" "in expanded string"
9876 The two forms of lookup item specify data lookups in files and databases, as
9877 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9878 lookups, and the second is used for query-style lookups. The <&'key'&>,
9879 <&'file'&>, and <&'query'&> strings are expanded before use.
9880
9881 If there is any white space in a lookup item which is part of a filter command,
9882 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9883 other place where white space is significant, the lookup item must be enclosed
9884 in double quotes. The use of data lookups in users' filter files may be locked
9885 out by the system administrator.
9886
9887 .vindex "&$value$&"
9888 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9889 During its expansion, the variable &$value$& contains the data returned by the
9890 lookup. Afterwards it reverts to the value it had previously (at the outer
9891 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9892 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9893 string on failure. If <&'string2'&> is provided, it can itself be a nested
9894 lookup, thus providing a mechanism for looking up a default value when the
9895 original lookup fails.
9896
9897 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9898 data for the outer lookup while the parameters of the second lookup are
9899 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9900 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9901 appear, and in this case, if the lookup fails, the entire expansion is forced
9902 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9903 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9904 successful lookup, and nothing in the case of failure.
9905
9906 For single-key lookups, the string &"partial"& is permitted to precede the
9907 search type in order to do partial matching, and * or *@ may follow a search
9908 type to request default lookups if the key does not match (see sections
9909 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9910
9911 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9912 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9913 and non-wild parts of the key during the expansion of the replacement text.
9914 They return to their previous values at the end of the lookup item.
9915
9916 This example looks up the postmaster alias in the conventional alias file:
9917 .code
9918 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9919 .endd
9920 This example uses NIS+ to look up the full name of the user corresponding to
9921 the local part of an address, forcing the expansion to fail if it is not found:
9922 .code
9923 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9924   {$value}fail}
9925 .endd
9926
9927
9928 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9929 .cindex "expansion" "list creation"
9930 .vindex "&$item$&"
9931 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9932 default, but the separator can be changed in the usual way. For each item
9933 in this list, its value is place in &$item$&, and then <&'string2'&> is
9934 expanded and added to the output as an item in a new list. The separator used
9935 for the output list is the same as the one used for the input, but a separator
9936 setting is not included in the output. For example:
9937 .code
9938 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9939 .endd
9940 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9941 value of &$item$& is restored to what it was before. See also the &*filter*&
9942 and &*reduce*& expansion items.
9943
9944 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9945 .cindex "expansion" "numeric hash"
9946 .cindex "hash function" "numeric"
9947 The three strings are expanded; the first two must yield numbers. Call them
9948 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9949 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9950 can use the simpler operator notation that avoids some of the braces:
9951 .code
9952 ${nhash_<n>_<m>:<string>}
9953 .endd
9954 The second number is optional (in both notations). If there is only one number,
9955 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9956 processed by a div/mod hash function that returns two numbers, separated by a
9957 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9958 example,
9959 .code
9960 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9961 .endd
9962 returns the string &"6/33"&.
9963
9964
9965
9966 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9967 .cindex "Perl" "use in expanded string"
9968 .cindex "expansion" "calling Perl from"
9969 This item is available only if Exim has been built to include an embedded Perl
9970 interpreter. The subroutine name and the arguments are first separately
9971 expanded, and then the Perl subroutine is called with those arguments. No
9972 additional arguments need be given; the maximum number permitted, including the
9973 name of the subroutine, is nine.
9974
9975 The return value of the subroutine is inserted into the expanded string, unless
9976 the return value is &%undef%&. In that case, the expansion fails in the same
9977 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9978 Whatever you return is evaluated in a scalar context. For example, if you
9979 return the name of a Perl vector, the return value is the size of the vector,
9980 not its contents.
9981
9982 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9983 with the error message that was passed to &%die%&. More details of the embedded
9984 Perl facility are given in chapter &<<CHAPperl>>&.
9985
9986 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9987 out the use of this expansion item in filter files.
9988
9989
9990 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9991 .cindex "&%prvs%& expansion item"
9992 The first argument is a complete email address and the second is secret
9993 keystring. The third argument, specifying a key number, is optional. If absent,
9994 it defaults to 0. The result of the expansion is a prvs-signed email address,
9995 to be typically used with the &%return_path%& option on an &(smtp)& transport
9996 as part of a bounce address tag validation (BATV) scheme. For more discussion
9997 and an example, see section &<<SECTverifyPRVS>>&.
9998
9999 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10000         {*&<&'string'&>&*}}*&"
10001 .cindex "&%prvscheck%& expansion item"
10002 This expansion item is the complement of the &%prvs%& item. It is used for
10003 checking prvs-signed addresses. If the expansion of the first argument does not
10004 yield a syntactically valid prvs-signed address, the whole item expands to the
10005 empty string. When the first argument does expand to a syntactically valid
10006 prvs-signed address, the second argument is expanded, with the prvs-decoded
10007 version of the address and the key number extracted from the address in the
10008 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10009
10010 These two variables can be used in the expansion of the second argument to
10011 retrieve the secret. The validity of the prvs-signed address is then checked
10012 against the secret. The result is stored in the variable &$prvscheck_result$&,
10013 which is empty for failure or &"1"& for success.
10014
10015 The third argument is optional; if it is missing, it defaults to an empty
10016 string. This argument is now expanded. If the result is an empty string, the
10017 result of the expansion is the decoded version of the address. This is the case
10018 whether or not the signature was valid. Otherwise, the result of the expansion
10019 is the expansion of the third argument.
10020
10021 All three variables can be used in the expansion of the third argument.
10022 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10023 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10024
10025 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10026 .cindex "expansion" "inserting an entire file"
10027 .cindex "file" "inserting into expansion"
10028 .cindex "&%readfile%& expansion item"
10029 The file name and end-of-line string are first expanded separately. The file is
10030 then read, and its contents replace the entire item. All newline characters in
10031 the file are replaced by the end-of-line string if it is present. Otherwise,
10032 newlines are left in the string.
10033 String expansion is not applied to the contents of the file. If you want this,
10034 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10035 the string expansion fails.
10036
10037 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10038 locks out the use of this expansion item in filter files.
10039
10040
10041
10042 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10043         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10044 .cindex "expansion" "inserting from a socket"
10045 .cindex "socket, use of in expansion"
10046 .cindex "&%readsocket%& expansion item"
10047 This item inserts data from a Unix domain or TCP socket into the expanded
10048 string. The minimal way of using it uses just two arguments, as in these
10049 examples:
10050 .code
10051 ${readsocket{/socket/name}{request string}}
10052 ${readsocket{inet:some.host:1234}{request string}}
10053 .endd
10054 For a Unix domain socket, the first substring must be the path to the socket.
10055 For an Internet socket, the first substring must contain &`inet:`& followed by
10056 a host name or IP address, followed by a colon and a port, which can be a
10057 number or the name of a TCP port in &_/etc/services_&. An IP address may
10058 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10059 example:
10060 .code
10061 ${readsocket{inet:[::1]:1234}{request string}}
10062 .endd
10063 Only a single host name may be given, but if looking it up yields more than
10064 one IP address, they are each tried in turn until a connection is made. For
10065 both kinds of socket, Exim makes a connection, writes the request string
10066 unless it is an empty string; and no terminating NUL is ever sent)
10067 and reads from the socket until an end-of-file
10068 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10069 extend what can be done. Firstly, you can vary the timeout. For example:
10070 .code
10071 ${readsocket{/socket/name}{request string}{3s}}
10072 .endd
10073
10074 The third argument is a list of options, of which the first element is the timeout
10075 and must be present if the argument is given.
10076 Further elements are options of form &'name=value'&.
10077 Two option types is currently recognised: shutdown and tls.
10078 The first defines whether (the default)
10079 or not a shutdown is done on the connection after sending the request.
10080 Example, to not do so (preferred, eg. by some webservers):
10081 .code
10082 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10083 .endd
10084 .new
10085 The second, tls, controls the use of TLS on the connection.  Example:
10086 .code
10087 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10088 .endd
10089 The default is to not use TLS.
10090 If it is enabled, a shutdown as descripbed above is never done.
10091 .wen
10092
10093 A fourth argument allows you to change any newlines that are in the data
10094 that is read, in the same way as for &%readfile%& (see above). This example
10095 turns them into spaces:
10096 .code
10097 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10098 .endd
10099 As with all expansions, the substrings are expanded before the processing
10100 happens. Errors in these sub-expansions cause the expansion to fail. In
10101 addition, the following errors can occur:
10102
10103 .ilist
10104 Failure to create a socket file descriptor;
10105 .next
10106 Failure to connect the socket;
10107 .next
10108 Failure to write the request string;
10109 .next
10110 Timeout on reading from the socket.
10111 .endlist
10112
10113 By default, any of these errors causes the expansion to fail. However, if
10114 you supply a fifth substring, it is expanded and used when any of the above
10115 errors occurs. For example:
10116 .code
10117 ${readsocket{/socket/name}{request string}{3s}{\n}\
10118   {socket failure}}
10119 .endd
10120 You can test for the existence of a Unix domain socket by wrapping this
10121 expansion in &`${if exists`&, but there is a race condition between that test
10122 and the actual opening of the socket, so it is safer to use the fifth argument
10123 if you want to be absolutely sure of avoiding an expansion error for a
10124 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10125
10126 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10127 locks out the use of this expansion item in filter files.
10128
10129
10130 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10131 .cindex "expansion" "reducing a list to a scalar"
10132 .cindex "list" "reducing to a scalar"
10133 .vindex "&$value$&"
10134 .vindex "&$item$&"
10135 This operation reduces a list to a single, scalar string. After expansion,
10136 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10137 separator can be changed in the usual way. Then <&'string2'&> is expanded and
10138 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10139 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
10140 them. The result of that expansion is assigned to &$value$& before the next
10141 iteration. When the end of the list is reached, the final value of &$value$& is
10142 added to the expansion output. The &*reduce*& expansion item can be used in a
10143 number of ways. For example, to add up a list of numbers:
10144 .code
10145 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10146 .endd
10147 The result of that expansion would be &`6`&. The maximum of a list of numbers
10148 can be found:
10149 .code
10150 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10151 .endd
10152 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10153 restored to what they were before. See also the &*filter*& and &*map*&
10154 expansion items.
10155
10156 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10157 This item inserts &"raw"& header lines. It is described with the &%header%&
10158 expansion item in section &<<SECTexpansionitems>>& above.
10159
10160 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10161         {*&<&'string2'&>&*}}*&"
10162 .cindex "expansion" "running a command"
10163 .cindex "&%run%& expansion item"
10164 The command and its arguments are first expanded as one string. The string is
10165 split apart into individual arguments by spaces, and then the command is run
10166 in a separate process, but under the same uid and gid.  As in other command
10167 executions from Exim, a shell is not used by default. If the command requires
10168 a shell, you must explicitly code it.
10169
10170 Since the arguments are split by spaces, when there is a variable expansion
10171 which has an empty result, it will cause the situation that the argument will
10172 simply be omitted when the program is actually executed by Exim. If the
10173 script/program requires a specific number of arguments and the expanded
10174 variable could possibly result in this empty expansion, the variable must be
10175 quoted. This is more difficult if the expanded variable itself could result
10176 in a string containing quotes, because it would interfere with the quotes
10177 around the command arguments. A possible guard against this is to wrap the
10178 variable in the &%sg%& operator to change any quote marks to some other
10179 character.
10180
10181 The standard input for the command exists, but is empty. The standard output
10182 and standard error are set to the same file descriptor.
10183 .cindex "return code" "from &%run%& expansion"
10184 .vindex "&$value$&"
10185 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10186 and replaces the entire item; during this expansion, the standard output/error
10187 from the command is in the variable &$value$&. If the command fails,
10188 <&'string2'&>, if present, is expanded and used. Once again, during the
10189 expansion, the standard output/error from the command is in the variable
10190 &$value$&.
10191
10192 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10193 can be the word &"fail"& (not in braces) to force expansion failure if the
10194 command does not succeed. If both strings are omitted, the result is contents
10195 of the standard output/error on success, and nothing on failure.
10196
10197 .vindex "&$run_in_acl$&"
10198 The standard output/error of the command is put in the variable &$value$&.
10199 In this ACL example, the output of a command is logged for the admin to
10200 troubleshoot:
10201 .code
10202 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10203       log_message  = Output of id: $value
10204 .endd
10205 If the command requires shell idioms, such as the > redirect operator, the
10206 shell must be invoked directly, such as with:
10207 .code
10208 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10209 .endd
10210
10211 .vindex "&$runrc$&"
10212 The return code from the command is put in the variable &$runrc$&, and this
10213 remains set afterwards, so in a filter file you can do things like this:
10214 .code
10215 if "${run{x y z}{}}$runrc" is 1 then ...
10216   elif $runrc is 2 then ...
10217   ...
10218 endif
10219 .endd
10220 If execution of the command fails (for example, the command does not exist),
10221 the return code is 127 &-- the same code that shells use for non-existent
10222 commands.
10223
10224 &*Warning*&: In a router or transport, you cannot assume the order in which
10225 option values are expanded, except for those preconditions whose order of
10226 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10227 by the expansion of one option, and use it in another.
10228
10229 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10230 out the use of this expansion item in filter files.
10231
10232
10233 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10234 .cindex "expansion" "string substitution"
10235 .cindex "&%sg%& expansion item"
10236 This item works like Perl's substitution operator (s) with the global (/g)
10237 option; hence its name. However, unlike the Perl equivalent, Exim does not
10238 modify the subject string; instead it returns the modified string for insertion
10239 into the overall expansion. The item takes three arguments: the subject string,
10240 a regular expression, and a substitution string. For example:
10241 .code
10242 ${sg{abcdefabcdef}{abc}{xyz}}
10243 .endd
10244 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10245 if any $, } or \ characters are required in the regular expression or in the
10246 substitution string, they have to be escaped. For example:
10247 .code
10248 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10249 .endd
10250 yields &"defabc"&, and
10251 .code
10252 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10253 .endd
10254 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10255 the regular expression from string expansion.
10256
10257 The regular expression is compiled in 8-bit mode, working against bytes
10258 rather than any Unicode-aware character handling.
10259
10260
10261 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10262 .cindex sorting "a list"
10263 .cindex list sorting
10264 .cindex expansion "list sorting"
10265 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10266 default, but the separator can be changed in the usual way.
10267 The <&'comparator'&> argument is interpreted as the operator
10268 of a two-argument expansion condition.
10269 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10270 The comparison should return true when applied to two values
10271 if the first value should sort before the second value.
10272 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10273 the element being placed in &$item$&,
10274 to give values for comparison.
10275
10276 The item result is a sorted list,
10277 with the original list separator,
10278 of the list elements (in full) of the original.
10279
10280 Examples:
10281 .code
10282 ${sort{3:2:1:4}{<}{$item}}
10283 .endd
10284 sorts a list of numbers, and
10285 .code
10286 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10287 .endd
10288 will sort an MX lookup into priority order.
10289
10290
10291 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10292 .cindex "&%substr%& expansion item"
10293 .cindex "substring extraction"
10294 .cindex "expansion" "substring extraction"
10295 The three strings are expanded; the first two must yield numbers. Call them
10296 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10297 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10298 can use the simpler operator notation that avoids some of the braces:
10299 .code
10300 ${substr_<n>_<m>:<string>}
10301 .endd
10302 The second number is optional (in both notations).
10303 If it is absent in the simpler format, the preceding underscore must also be
10304 omitted.
10305
10306 The &%substr%& item can be used to extract more general substrings than
10307 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10308 length required. For example
10309 .code
10310 ${substr{3}{2}{$local_part}}
10311 .endd
10312 If the starting offset is greater than the string length the result is the
10313 null string; if the length plus starting offset is greater than the string
10314 length, the result is the right-hand part of the string, starting from the
10315 given offset. The first byte (character) in the string has offset zero.
10316
10317 The &%substr%& expansion item can take negative offset values to count
10318 from the right-hand end of its operand. The last byte (character) is offset -1,
10319 the second-last is offset -2, and so on. Thus, for example,
10320 .code
10321 ${substr{-5}{2}{1234567}}
10322 .endd
10323 yields &"34"&. If the absolute value of a negative offset is greater than the
10324 length of the string, the substring starts at the beginning of the string, and
10325 the length is reduced by the amount of overshoot. Thus, for example,
10326 .code
10327 ${substr{-5}{2}{12}}
10328 .endd
10329 yields an empty string, but
10330 .code
10331 ${substr{-3}{2}{12}}
10332 .endd
10333 yields &"1"&.
10334
10335 When the second number is omitted from &%substr%&, the remainder of the string
10336 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10337 string preceding the offset point are taken. For example, an offset of -1 and
10338 no length, as in these semantically identical examples:
10339 .code
10340 ${substr_-1:abcde}
10341 ${substr{-1}{abcde}}
10342 .endd
10343 yields all but the last character of the string, that is, &"abcd"&.
10344
10345 All measurement is done in bytes and is not UTF-8 aware.
10346
10347
10348
10349 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10350         {*&<&'replacements'&>&*}}*&"
10351 .cindex "expansion" "character translation"
10352 .cindex "&%tr%& expansion item"
10353 This item does single-character (in bytes) translation on its subject string. The second
10354 argument is a list of characters to be translated in the subject string. Each
10355 matching character is replaced by the corresponding character from the
10356 replacement list. For example
10357 .code
10358 ${tr{abcdea}{ac}{13}}
10359 .endd
10360 yields &`1b3de1`&. If there are duplicates in the second character string, the
10361 last occurrence is used. If the third string is shorter than the second, its
10362 last character is replicated. However, if it is empty, no translation takes
10363 place.
10364
10365 All character handling is done in bytes and is not UTF-8 aware.
10366
10367 .endlist
10368
10369
10370
10371 .section "Expansion operators" "SECTexpop"
10372 .cindex "expansion" "operators"
10373 For expansion items that perform transformations on a single argument string,
10374 the &"operator"& notation is used because it is simpler and uses fewer braces.
10375 The substring is first expanded before the operation is applied to it. The
10376 following operations can be performed:
10377
10378 .vlist
10379 .vitem &*${address:*&<&'string'&>&*}*&
10380 .cindex "expansion" "RFC 2822 address handling"
10381 .cindex "&%address%& expansion item"
10382 The string is interpreted as an RFC 2822 address, as it might appear in a
10383 header line, and the effective address is extracted from it. If the string does
10384 not parse successfully, the result is empty.
10385
10386 The parsing correctly handles SMTPUTF8 Unicode in the string.
10387
10388
10389 .vitem &*${addresses:*&<&'string'&>&*}*&
10390 .cindex "expansion" "RFC 2822 address handling"
10391 .cindex "&%addresses%& expansion item"
10392 The string (after expansion) is interpreted as a list of addresses in RFC
10393 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10394 operative address (&'local-part@domain'&) is extracted from each item, and the
10395 result of the expansion is a colon-separated list, with appropriate
10396 doubling of colons should any happen to be present in the email addresses.
10397 Syntactically invalid RFC2822 address items are omitted from the output.
10398
10399 It is possible to specify a character other than colon for the output
10400 separator by starting the string with > followed by the new separator
10401 character. For example:
10402 .code
10403 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10404 .endd
10405 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10406 first, so if the expanded string starts with >, it may change the output
10407 separator unintentionally. This can be avoided by setting the output
10408 separator explicitly:
10409 .code
10410 ${addresses:>:$h_from:}
10411 .endd
10412
10413 Compare the &*address*& (singular)
10414 expansion item, which extracts the working address from a single RFC2822
10415 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10416 processing lists.
10417
10418 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10419 a strict interpretation of header line formatting.  Exim parses the bare,
10420 unquoted portion of an email address and if it finds a comma, treats it as an
10421 email address separator. For the example header line:
10422 .code
10423 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10424 .endd
10425 The first example below demonstrates that Q-encoded email addresses are parsed
10426 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10427 It does not see the comma because it's still encoded as "=2C".  The second
10428 example below is passed the contents of &`$header_from:`&, meaning it gets
10429 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10430 The third example shows that the presence of a comma is skipped when it is
10431 quoted.  The fourth example shows SMTPUTF8 handling.
10432 .code
10433 # exim -be '${addresses:From: \
10434 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10435 user@example.com
10436 # exim -be '${addresses:From: Last, First <user@example.com>}'
10437 Last:user@example.com
10438 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10439 user@example.com
10440 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10441 フィリップ@example.jp
10442 .endd
10443
10444 .vitem &*${base32:*&<&'digits'&>&*}*&
10445 .cindex "&%base32%& expansion item"
10446 .cindex "expansion" "conversion to base 32"
10447 The string must consist entirely of decimal digits. The number is converted to
10448 base 32 and output as a (empty, for zero) string of characters.
10449 Only lowercase letters are used.
10450
10451 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10452 .cindex "&%base32d%& expansion item"
10453 .cindex "expansion" "conversion to base 32"
10454 The string must consist entirely of base-32 digits.
10455 The number is converted to decimal and output as a string.
10456
10457 .vitem &*${base62:*&<&'digits'&>&*}*&
10458 .cindex "&%base62%& expansion item"
10459 .cindex "expansion" "conversion to base 62"
10460 The string must consist entirely of decimal digits. The number is converted to
10461 base 62 and output as a string of six characters, including leading zeros. In
10462 the few operating environments where Exim uses base 36 instead of base 62 for
10463 its message identifiers (because those systems do not have case-sensitive file
10464 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10465 be absolutely clear: this is &'not'& base64 encoding.
10466
10467 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10468 .cindex "&%base62d%& expansion item"
10469 .cindex "expansion" "conversion to base 62"
10470 The string must consist entirely of base-62 digits, or, in operating
10471 environments where Exim uses base 36 instead of base 62 for its message
10472 identifiers, base-36 digits. The number is converted to decimal and output as a
10473 string.
10474
10475 .vitem &*${base64:*&<&'string'&>&*}*&
10476 .cindex "expansion" "base64 encoding"
10477 .cindex "base64 encoding" "in string expansion"
10478 .cindex "&%base64%& expansion item"
10479 .cindex certificate "base64 of DER"
10480 This operator converts a string into one that is base64 encoded.
10481
10482 If the string is a single variable of type certificate,
10483 returns the base64 encoding of the DER form of the certificate.
10484
10485
10486 .vitem &*${base64d:*&<&'string'&>&*}*&
10487 .cindex "expansion" "base64 decoding"
10488 .cindex "base64 decoding" "in string expansion"
10489 .cindex "&%base64d%& expansion item"
10490 This operator converts a base64-encoded string into the un-coded form.
10491
10492
10493 .vitem &*${domain:*&<&'string'&>&*}*&
10494 .cindex "domain" "extraction"
10495 .cindex "expansion" "domain extraction"
10496 The string is interpreted as an RFC 2822 address and the domain is extracted
10497 from it. If the string does not parse successfully, the result is empty.
10498
10499
10500 .vitem &*${escape:*&<&'string'&>&*}*&
10501 .cindex "expansion" "escaping non-printing characters"
10502 .cindex "&%escape%& expansion item"
10503 If the string contains any non-printing characters, they are converted to
10504 escape sequences starting with a backslash. Whether characters with the most
10505 significant bit set (so-called &"8-bit characters"&) count as printing or not
10506 is controlled by the &%print_topbitchars%& option.
10507
10508 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10509 .cindex "expansion" "escaping 8-bit characters"
10510 .cindex "&%escape8bit%& expansion item"
10511 If the string contains and characters with the most significant bit set,
10512 they are converted to escape sequences starting with a backslash.
10513 Backslashes and DEL characters are also converted.
10514
10515
10516 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10517 .cindex "expansion" "expression evaluation"
10518 .cindex "expansion" "arithmetic expression"
10519 .cindex "&%eval%& expansion item"
10520 These items supports simple arithmetic and bitwise logical operations in
10521 expansion strings. The string (after expansion) must be a conventional
10522 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10523 logical operators, and parentheses. All operations are carried out using
10524 integer arithmetic. The operator priorities are as follows (the same as in the
10525 C programming language):
10526 .table2 70pt 300pt
10527 .irow &'highest:'& "not (~), negate (-)"
10528 .irow ""   "multiply (*), divide (/), remainder (%)"
10529 .irow ""   "plus (+), minus (-)"
10530 .irow ""   "shift-left (<<), shift-right (>>)"
10531 .irow ""   "and (&&)"
10532 .irow ""   "xor (^)"
10533 .irow &'lowest:'&  "or (|)"
10534 .endtable
10535 Binary operators with the same priority are evaluated from left to right. White
10536 space is permitted before or after operators.
10537
10538 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10539 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10540 decimal, even if they start with a leading zero; hexadecimal numbers are not
10541 permitted. This can be useful when processing numbers extracted from dates or
10542 times, which often do have leading zeros.
10543
10544 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10545 or 1024*1024*1024,
10546 respectively. Negative numbers are supported. The result of the computation is
10547 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10548
10549 .display
10550 &`${eval:1+1}            `&  yields 2
10551 &`${eval:1+2*3}          `&  yields 7
10552 &`${eval:(1+2)*3}        `&  yields 9
10553 &`${eval:2+42%5}         `&  yields 4
10554 &`${eval:0xc&amp;5}          `&  yields 4
10555 &`${eval:0xc|5}          `&  yields 13
10556 &`${eval:0xc^5}          `&  yields 9
10557 &`${eval:0xc>>1}         `&  yields 6
10558 &`${eval:0xc<<1}         `&  yields 24
10559 &`${eval:~255&amp;0x1234}    `&  yields 4608
10560 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10561 .endd
10562
10563 As a more realistic example, in an ACL you might have
10564 .code
10565 deny   message = Too many bad recipients
10566        condition =                    \
10567          ${if and {                   \
10568            {>{$rcpt_count}{10}}       \
10569            {                          \
10570            <                          \
10571              {$recipients_count}      \
10572              {${eval:$rcpt_count/2}}  \
10573            }                          \
10574          }{yes}{no}}
10575 .endd
10576 The condition is true if there have been more than 10 RCPT commands and
10577 fewer than half of them have resulted in a valid recipient.
10578
10579
10580 .vitem &*${expand:*&<&'string'&>&*}*&
10581 .cindex "expansion" "re-expansion of substring"
10582 The &%expand%& operator causes a string to be expanded for a second time. For
10583 example,
10584 .code
10585 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10586 .endd
10587 first looks up a string in a file while expanding the operand for &%expand%&,
10588 and then re-expands what it has found.
10589
10590
10591 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10592 .cindex "Unicode"
10593 .cindex "UTF-8" "conversion from"
10594 .cindex "expansion" "UTF-8 conversion"
10595 .cindex "&%from_utf8%& expansion item"
10596 The world is slowly moving towards Unicode, although there are no standards for
10597 email yet. However, other applications (including some databases) are starting
10598 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10599 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10600 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10601 the result is an undefined sequence of bytes.
10602
10603 Unicode code points with values less than 256 are compatible with ASCII and
10604 ISO-8859-1 (also known as Latin-1).
10605 For example, character 169 is the copyright symbol in both cases, though the
10606 way it is encoded is different. In UTF-8, more than one byte is needed for
10607 characters with code values greater than 127, whereas ISO-8859-1 is a
10608 single-byte encoding (but thereby limited to 256 characters). This makes
10609 translation from UTF-8 to ISO-8859-1 straightforward.
10610
10611
10612 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10613 .cindex "hash function" "textual"
10614 .cindex "expansion" "textual hash"
10615 The &%hash%& operator is a simpler interface to the hashing function that can
10616 be used when the two parameters are fixed numbers (as opposed to strings that
10617 change when expanded). The effect is the same as
10618 .code
10619 ${hash{<n>}{<m>}{<string>}}
10620 .endd
10621 See the description of the general &%hash%& item above for details. The
10622 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10623
10624
10625
10626 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10627 .cindex "base64 encoding" "conversion from hex"
10628 .cindex "expansion" "hex to base64"
10629 .cindex "&%hex2b64%& expansion item"
10630 This operator converts a hex string into one that is base64 encoded. This can
10631 be useful for processing the output of the various hashing functions.
10632
10633
10634
10635 .vitem &*${hexquote:*&<&'string'&>&*}*&
10636 .cindex "quoting" "hex-encoded unprintable characters"
10637 .cindex "&%hexquote%& expansion item"
10638 This operator converts non-printable characters in a string into a hex
10639 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10640 as is, and other byte values are converted to &`\xNN`&, for example a
10641 byte value 127 is converted to &`\x7f`&.
10642
10643
10644 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10645 .cindex "&%ipv6denorm%& expansion item"
10646 .cindex "IP address" normalisation
10647 This expands an IPv6 address to a full eight-element colon-separated set
10648 of hex digits including leading zeroes.
10649 A trailing ipv4-style dotted-decimal set is converted to hex.
10650 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10651
10652 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10653 .cindex "&%ipv6norm%& expansion item"
10654 .cindex "IP address" normalisation
10655 .cindex "IP address" "canonical form"
10656 This converts an IPv6 address to canonical form.
10657 Leading zeroes of groups are omitted, and the longest
10658 set of zero-valued groups is replaced with a double colon.
10659 A trailing ipv4-style dotted-decimal set is converted to hex.
10660 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10661
10662
10663 .vitem &*${lc:*&<&'string'&>&*}*&
10664 .cindex "case forcing in strings"
10665 .cindex "string" "case forcing"
10666 .cindex "lower casing"
10667 .cindex "expansion" "case forcing"
10668 .cindex "&%lc%& expansion item"
10669 This forces the letters in the string into lower-case, for example:
10670 .code
10671 ${lc:$local_part}
10672 .endd
10673 Case is defined per the system C locale.
10674
10675 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10676 .cindex "expansion" "string truncation"
10677 .cindex "&%length%& expansion item"
10678 The &%length%& operator is a simpler interface to the &%length%& function that
10679 can be used when the parameter is a fixed number (as opposed to a string that
10680 changes when expanded). The effect is the same as
10681 .code
10682 ${length{<number>}{<string>}}
10683 .endd
10684 See the description of the general &%length%& item above for details. Note that
10685 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10686 when &%length%& is used as an operator.
10687 All measurement is done in bytes and is not UTF-8 aware.
10688
10689
10690 .vitem &*${listcount:*&<&'string'&>&*}*&
10691 .cindex "expansion" "list item count"
10692 .cindex "list" "item count"
10693 .cindex "list" "count of items"
10694 .cindex "&%listcount%& expansion item"
10695 The string is interpreted as a list and the number of items is returned.
10696
10697
10698 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10699 .cindex "expansion" "named list"
10700 .cindex "&%listnamed%& expansion item"
10701 The name is interpreted as a named list and the content of the list is returned,
10702 expanding any referenced lists, re-quoting as needed for colon-separation.
10703 If the optional type is given it must be one of "a", "d", "h" or "l"
10704 and selects address-, domain-, host- or localpart- lists to search among respectively.
10705 Otherwise all types are searched in an undefined order and the first
10706 matching list is returned.
10707
10708
10709 .vitem &*${local_part:*&<&'string'&>&*}*&
10710 .cindex "expansion" "local part extraction"
10711 .cindex "&%local_part%& expansion item"
10712 The string is interpreted as an RFC 2822 address and the local part is
10713 extracted from it. If the string does not parse successfully, the result is
10714 empty.
10715 The parsing correctly handles SMTPUTF8 Unicode in the string.
10716
10717
10718 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10719 .cindex "masked IP address"
10720 .cindex "IP address" "masking"
10721 .cindex "CIDR notation"
10722 .cindex "expansion" "IP address masking"
10723 .cindex "&%mask%& expansion item"
10724 If the form of the string to be operated on is not an IP address followed by a
10725 slash and an integer (that is, a network address in CIDR notation), the
10726 expansion fails. Otherwise, this operator converts the IP address to binary,
10727 masks off the least significant bits according to the bit count, and converts
10728 the result back to text, with mask appended. For example,
10729 .code
10730 ${mask:10.111.131.206/28}
10731 .endd
10732 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10733 be mostly used for looking up masked addresses in files, the result for an IPv6
10734 address uses dots to separate components instead of colons, because colon
10735 terminates a key string in lsearch files. So, for example,
10736 .code
10737 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10738 .endd
10739 returns the string
10740 .code
10741 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10742 .endd
10743 Letters in IPv6 addresses are always output in lower case.
10744
10745
10746 .vitem &*${md5:*&<&'string'&>&*}*&
10747 .cindex "MD5 hash"
10748 .cindex "expansion" "MD5 hash"
10749 .cindex certificate fingerprint
10750 .cindex "&%md5%& expansion item"
10751 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10752 as a 32-digit hexadecimal number, in which any letters are in lower case.
10753
10754 If the string is a single variable of type certificate,
10755 returns the MD5 hash fingerprint of the certificate.
10756
10757
10758 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10759 .cindex "expansion" "numeric hash"
10760 .cindex "hash function" "numeric"
10761 The &%nhash%& operator is a simpler interface to the numeric hashing function
10762 that can be used when the two parameters are fixed numbers (as opposed to
10763 strings that change when expanded). The effect is the same as
10764 .code
10765 ${nhash{<n>}{<m>}{<string>}}
10766 .endd
10767 See the description of the general &%nhash%& item above for details.
10768
10769
10770 .vitem &*${quote:*&<&'string'&>&*}*&
10771 .cindex "quoting" "in string expansions"
10772 .cindex "expansion" "quoting"
10773 .cindex "&%quote%& expansion item"
10774 The &%quote%& operator puts its argument into double quotes if it
10775 is an empty string or
10776 contains anything other than letters, digits, underscores, dots, and hyphens.
10777 Any occurrences of double quotes and backslashes are escaped with a backslash.
10778 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10779 respectively For example,
10780 .code
10781 ${quote:ab"*"cd}
10782 .endd
10783 becomes
10784 .code
10785 "ab\"*\"cd"
10786 .endd
10787 The place where this is useful is when the argument is a substitution from a
10788 variable or a message header.
10789
10790 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10791 .cindex "&%quote_local_part%& expansion item"
10792 This operator is like &%quote%&, except that it quotes the string only if
10793 required to do so by the rules of RFC 2822 for quoting local parts. For
10794 example, a plus sign would not cause quoting (but it would for &%quote%&).
10795 If you are creating a new email address from the contents of &$local_part$&
10796 (or any other unknown data), you should always use this operator.
10797
10798 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10799 will likely use the quoting form.
10800 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10801
10802
10803 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10804 .cindex "quoting" "lookup-specific"
10805 This operator applies lookup-specific quoting rules to the string. Each
10806 query-style lookup type has its own quoting rules which are described with
10807 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10808 .code
10809 ${quote_ldap:two * two}
10810 .endd
10811 returns
10812 .code
10813 two%20%5C2A%20two
10814 .endd
10815 For single-key lookup types, no quoting is ever necessary and this operator
10816 yields an unchanged string.
10817
10818
10819 .vitem &*${randint:*&<&'n'&>&*}*&
10820 .cindex "random number"
10821 This operator returns a somewhat random number which is less than the
10822 supplied number and is at least 0.  The quality of this randomness depends
10823 on how Exim was built; the values are not suitable for keying material.
10824 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10825 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10826 for versions of GnuTLS with that function.
10827 Otherwise, the implementation may be arc4random(), random() seeded by
10828 srandomdev() or srandom(), or a custom implementation even weaker than
10829 random().
10830
10831
10832 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10833 .cindex "expansion" "IP address"
10834 This operator reverses an IP address; for IPv4 addresses, the result is in
10835 dotted-quad decimal form, while for IPv6 addresses the result is in
10836 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10837 for DNS.  For example,
10838 .code
10839 ${reverse_ip:192.0.2.4}
10840 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10841 .endd
10842 returns
10843 .code
10844 4.2.0.192
10845 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
10846 .endd
10847
10848
10849 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10850 .cindex "expansion" "RFC 2047"
10851 .cindex "RFC 2047" "expansion operator"
10852 .cindex "&%rfc2047%& expansion item"
10853 This operator encodes text according to the rules of RFC 2047. This is an
10854 encoding that is used in header lines to encode non-ASCII characters. It is
10855 assumed that the input string is in the encoding specified by the
10856 &%headers_charset%& option, which gets its default at build time. If the string
10857 contains only characters in the range 33&--126, and no instances of the
10858 characters
10859 .code
10860 ? = ( ) < > @ , ; : \ " . [ ] _
10861 .endd
10862 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10863 string, using as many &"encoded words"& as necessary to encode all the
10864 characters.
10865
10866
10867 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10868 .cindex "expansion" "RFC 2047"
10869 .cindex "RFC 2047" "decoding"
10870 .cindex "&%rfc2047d%& expansion item"
10871 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10872 bytes are replaced by question marks. Characters are converted into the
10873 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10874 not recognized unless &%check_rfc2047_length%& is set false.
10875
10876 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10877 access a header line, RFC 2047 decoding is done automatically. You do not need
10878 to use this operator as well.
10879
10880
10881
10882 .vitem &*${rxquote:*&<&'string'&>&*}*&
10883 .cindex "quoting" "in regular expressions"
10884 .cindex "regular expressions" "quoting"
10885 .cindex "&%rxquote%& expansion item"
10886 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10887 characters in its argument. This is useful when substituting the values of
10888 variables or headers inside regular expressions.
10889
10890
10891 .vitem &*${sha1:*&<&'string'&>&*}*&
10892 .cindex "SHA-1 hash"
10893 .cindex "expansion" "SHA-1 hashing"
10894 .cindex certificate fingerprint
10895 .cindex "&%sha1%& expansion item"
10896 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10897 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10898
10899 If the string is a single variable of type certificate,
10900 returns the SHA-1 hash fingerprint of the certificate.
10901
10902
10903 .vitem &*${sha256:*&<&'string'&>&*}*&
10904 .cindex "SHA-256 hash"
10905 .cindex certificate fingerprint
10906 .cindex "expansion" "SHA-256 hashing"
10907 .cindex "&%sha256%& expansion item"
10908 The &%sha256%& operator computes the SHA-256 hash value of the string
10909 and returns
10910 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10911
10912 If the string is a single variable of type certificate,
10913 returns the SHA-256 hash fingerprint of the certificate.
10914
10915
10916 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10917        &*${sha3_<n>:*&<&'string'&>&*}*&
10918 .cindex "SHA3 hash"
10919 .cindex "expansion" "SHA3 hashing"
10920 .cindex "&%sha3%& expansion item"
10921 The &%sha3%& operator computes the SHA3-256 hash value of the string
10922 and returns
10923 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10924
10925 If a number is appended, separated by an underbar, it specifies
10926 the output length.  Values of 224, 256, 384 and 512 are accepted;
10927 with 256 being the default.
10928
10929 The &%sha3%& expansion item is only supported if Exim has been
10930 compiled with GnuTLS 3.5.0 or later,
10931 or OpenSSL 1.1.1 or later.
10932 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
10933
10934
10935 .vitem &*${stat:*&<&'string'&>&*}*&
10936 .cindex "expansion" "statting a file"
10937 .cindex "file" "extracting characteristics"
10938 .cindex "&%stat%& expansion item"
10939 The string, after expansion, must be a file path. A call to the &[stat()]&
10940 function is made for this path. If &[stat()]& fails, an error occurs and the
10941 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10942 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10943 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10944 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10945 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10946 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10947 can extract individual fields using the &%extract%& expansion item.
10948
10949 The use of the &%stat%& expansion in users' filter files can be locked out by
10950 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10951 systems for files larger than 2GB.
10952
10953 .vitem &*${str2b64:*&<&'string'&>&*}*&
10954 .cindex "&%str2b64%& expansion item"
10955 Now deprecated, a synonym for the &%base64%& expansion operator.
10956
10957
10958
10959 .vitem &*${strlen:*&<&'string'&>&*}*&
10960 .cindex "expansion" "string length"
10961 .cindex "string" "length in expansion"
10962 .cindex "&%strlen%& expansion item"
10963 The item is replace by the length of the expanded string, expressed as a
10964 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10965 All measurement is done in bytes and is not UTF-8 aware.
10966
10967
10968 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10969 .cindex "&%substr%& expansion item"
10970 .cindex "substring extraction"
10971 .cindex "expansion" "substring expansion"
10972 The &%substr%& operator is a simpler interface to the &%substr%& function that
10973 can be used when the two parameters are fixed numbers (as opposed to strings
10974 that change when expanded). The effect is the same as
10975 .code
10976 ${substr{<start>}{<length>}{<string>}}
10977 .endd
10978 See the description of the general &%substr%& item above for details. The
10979 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10980 All measurement is done in bytes and is not UTF-8 aware.
10981
10982 .vitem &*${time_eval:*&<&'string'&>&*}*&
10983 .cindex "&%time_eval%& expansion item"
10984 .cindex "time interval" "decoding"
10985 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10986 seconds.
10987
10988 .vitem &*${time_interval:*&<&'string'&>&*}*&
10989 .cindex "&%time_interval%& expansion item"
10990 .cindex "time interval" "formatting"
10991 The argument (after sub-expansion) must be a sequence of decimal digits that
10992 represents an interval of time as a number of seconds. It is converted into a
10993 number of larger units and output in Exim's normal time format, for example,
10994 &`1w3d4h2m6s`&.
10995
10996 .vitem &*${uc:*&<&'string'&>&*}*&
10997 .cindex "case forcing in strings"
10998 .cindex "string" "case forcing"
10999 .cindex "upper casing"
11000 .cindex "expansion" "case forcing"
11001 .cindex "&%uc%& expansion item"
11002 This forces the letters in the string into upper-case.
11003 Case is defined per the system C locale.
11004
11005 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11006 .cindex "correction of invalid utf-8 sequences in strings"
11007 .cindex "utf-8" "utf-8 sequences"
11008 .cindex "incorrect utf-8"
11009 .cindex "expansion" "utf-8 forcing"
11010 .cindex "&%utf8clean%& expansion item"
11011 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11012 .new
11013 In versions of Exim before 4.92, this did not correctly do so for a truncated
11014 final codepoint's encoding, and the character would be silently dropped.
11015 If you must handle detection of this scenario across both sets of Exim behavior,
11016 the complexity will depend upon the task.
11017 For instance, to detect if the first character is multibyte and a 1-byte
11018 extraction can be successfully used as a path component (as is common for
11019 dividing up delivery folders), you might use:
11020 .code
11021 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11022 .endd
11023 (which will false-positive if the first character of the local part is a
11024 literal question mark).
11025 .wen
11026
11027 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11028        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11029        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11030        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11031 .cindex expansion UTF-8
11032 .cindex UTF-8 expansion
11033 .cindex EAI
11034 .cindex internationalisation
11035 .cindex "&%utf8_domain_to_alabel%& expansion item"
11036 .cindex "&%utf8_domain_from_alabel%& expansion item"
11037 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11038 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11039 These convert EAI mail name components between UTF-8 and a-label forms.
11040 For information on internationalisation support see &<<SECTi18nMTA>>&.
11041 .endlist
11042
11043
11044
11045
11046
11047
11048 .section "Expansion conditions" "SECTexpcond"
11049 .scindex IIDexpcond "expansion" "conditions"
11050 The following conditions are available for testing by the &%${if%& construct
11051 while expanding strings:
11052
11053 .vlist
11054 .vitem &*!*&<&'condition'&>
11055 .cindex "expansion" "negating a condition"
11056 .cindex "negation" "in expansion condition"
11057 Preceding any condition with an exclamation mark negates the result of the
11058 condition.
11059
11060 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11061 .cindex "numeric comparison"
11062 .cindex "expansion" "numeric comparison"
11063 There are a number of symbolic operators for doing numeric comparisons. They
11064 are:
11065 .display
11066 &`=   `&   equal
11067 &`==  `&   equal
11068 &`>   `&   greater
11069 &`>=  `&   greater or equal
11070 &`<   `&   less
11071 &`<=  `&   less or equal
11072 .endd
11073 For example:
11074 .code
11075 ${if >{$message_size}{10M} ...
11076 .endd
11077 Note that the general negation operator provides for inequality testing. The
11078 two strings must take the form of optionally signed decimal integers,
11079 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11080 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11081 As a special case, the numerical value of an empty string is taken as
11082 zero.
11083
11084 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11085 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11086 10M, not if 10M is larger than &$message_size$&.
11087
11088
11089 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11090         {*&<&'arg2'&>&*}...}*&
11091 .cindex "expansion" "calling an acl"
11092 .cindex "&%acl%&" "expansion condition"
11093 The name and zero to nine argument strings are first expanded separately.  The expanded
11094 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11095 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11096 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11097 and may use the variables; if another acl expansion is used the values
11098 are restored after it returns.  If the ACL sets
11099 a value using a "message =" modifier the variable $value becomes
11100 the result of the expansion, otherwise it is empty.
11101 If the ACL returns accept the condition is true; if deny, false.
11102 If the ACL returns defer the result is a forced-fail.
11103
11104 .vitem &*bool&~{*&<&'string'&>&*}*&
11105 .cindex "expansion" "boolean parsing"
11106 .cindex "&%bool%& expansion condition"
11107 This condition turns a string holding a true or false representation into
11108 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11109 (case-insensitively); also integer numbers map to true if non-zero,
11110 false if zero.
11111 An empty string is treated as false.
11112 Leading and trailing whitespace is ignored;
11113 thus a string consisting only of whitespace is false.
11114 All other string values will result in expansion failure.
11115
11116 When combined with ACL variables, this expansion condition will let you
11117 make decisions in one place and act on those decisions in another place.
11118 For example:
11119 .code
11120 ${if bool{$acl_m_privileged_sender} ...
11121 .endd
11122
11123
11124 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11125 .cindex "expansion" "boolean parsing"
11126 .cindex "&%bool_lax%& expansion condition"
11127 Like &%bool%&, this condition turns a string into a boolean state.  But
11128 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11129 loose definition that the Router &%condition%& option uses.  The empty string
11130 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11131 true.  Leading and trailing whitespace is ignored.
11132
11133 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11134
11135 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11136 .cindex "expansion" "encrypted comparison"
11137 .cindex "encrypted strings, comparing"
11138 .cindex "&%crypteq%& expansion condition"
11139 This condition is included in the Exim binary if it is built to support any
11140 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11141 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11142 included in the binary.
11143
11144 The &%crypteq%& condition has two arguments. The first is encrypted and
11145 compared against the second, which is already encrypted. The second string may
11146 be in the LDAP form for storing encrypted strings, which starts with the
11147 encryption type in curly brackets, followed by the data. If the second string
11148 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11149 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11150 Typically this will be a field from a password file. An example of an encrypted
11151 string in LDAP form is:
11152 .code
11153 {md5}CY9rzUYh03PK3k6DJie09g==
11154 .endd
11155 If such a string appears directly in an expansion, the curly brackets have to
11156 be quoted, because they are part of the expansion syntax. For example:
11157 .code
11158 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11159 .endd
11160 The following encryption types (whose names are matched case-independently) are
11161 supported:
11162
11163 .ilist
11164 .cindex "MD5 hash"
11165 .cindex "base64 encoding" "in encrypted password"
11166 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11167 printable characters to compare with the remainder of the second string. If the
11168 length of the comparison string is 24, Exim assumes that it is base64 encoded
11169 (as in the above example). If the length is 32, Exim assumes that it is a
11170 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11171 comparison fails.
11172
11173 .next
11174 .cindex "SHA-1 hash"
11175 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11176 printable characters to compare with the remainder of the second string. If the
11177 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11178 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11179 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11180
11181 .next
11182 .cindex "&[crypt()]&"
11183 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11184 only the first eight characters of the password. However, in modern operating
11185 systems this is no longer true, and in many cases the entire password is used,
11186 whatever its length.
11187
11188 .next
11189 .cindex "&[crypt16()]&"
11190 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11191 use up to 16 characters of the password in some operating systems. Again, in
11192 modern operating systems, more characters may be used.
11193 .endlist
11194 Exim has its own version of &[crypt16()]&, which is just a double call to
11195 &[crypt()]&. For operating systems that have their own version, setting
11196 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11197 operating system version instead of its own. This option is set by default in
11198 the OS-dependent &_Makefile_& for those operating systems that are known to
11199 support &[crypt16()]&.
11200
11201 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11202 it was not using the same algorithm as some operating systems' versions. It
11203 turns out that as well as &[crypt16()]& there is a function called
11204 &[bigcrypt()]& in some operating systems. This may or may not use the same
11205 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11206
11207 However, since there is now a move away from the traditional &[crypt()]&
11208 functions towards using SHA1 and other algorithms, tidying up this area of
11209 Exim is seen as very low priority.
11210
11211 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11212 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11213 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11214 default is &`{crypt}`&. Whatever the default, you can always use either
11215 function by specifying it explicitly in curly brackets.
11216
11217 .vitem &*def:*&<&'variable&~name'&>
11218 .cindex "expansion" "checking for empty variable"
11219 .cindex "&%def%& expansion condition"
11220 The &%def%& condition must be followed by the name of one of the expansion
11221 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11222 variable does not contain the empty string. For example:
11223 .code
11224 ${if def:sender_ident {from $sender_ident}}
11225 .endd
11226 Note that the variable name is given without a leading &%$%& character. If the
11227 variable does not exist, the expansion fails.
11228
11229 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11230         &~&*def:h_*&<&'header&~name'&>&*:*&"
11231 .cindex "expansion" "checking header line existence"
11232 This condition is true if a message is being processed and the named header
11233 exists in the message. For example,
11234 .code
11235 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11236 .endd
11237 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11238 the header name must be terminated by a colon if white space does not follow.
11239
11240 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11241        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11242 .cindex "string" "comparison"
11243 .cindex "expansion" "string comparison"
11244 .cindex "&%eq%& expansion condition"
11245 .cindex "&%eqi%& expansion condition"
11246 The two substrings are first expanded. The condition is true if the two
11247 resulting strings are identical. For &%eq%& the comparison includes the case of
11248 letters, whereas for &%eqi%& the comparison is case-independent, where
11249 case is defined per the system C locale.
11250
11251 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11252 .cindex "expansion" "file existence test"
11253 .cindex "file" "existence test"
11254 .cindex "&%exists%&, expansion condition"
11255 The substring is first expanded and then interpreted as an absolute path. The
11256 condition is true if the named file (or directory) exists. The existence test
11257 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11258 users' filter files may be locked out by the system administrator.
11259
11260 .vitem &*first_delivery*&
11261 .cindex "delivery" "first"
11262 .cindex "first delivery"
11263 .cindex "expansion" "first delivery test"
11264 .cindex "&%first_delivery%& expansion condition"
11265 This condition, which has no data, is true during a message's first delivery
11266 attempt. It is false during any subsequent delivery attempts.
11267
11268
11269 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11270        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11271 .cindex "list" "iterative conditions"
11272 .cindex "expansion" "&*forall*& condition"
11273 .cindex "expansion" "&*forany*& condition"
11274 .vindex "&$item$&"
11275 These conditions iterate over a list. The first argument is expanded to form
11276 the list. By default, the list separator is a colon, but it can be changed by
11277 the normal method. The second argument is interpreted as a condition that is to
11278 be applied to each item in the list in turn. During the interpretation of the
11279 condition, the current list item is placed in a variable called &$item$&.
11280 .ilist
11281 For &*forany*&, interpretation stops if the condition is true for any item, and
11282 the result of the whole condition is true. If the condition is false for all
11283 items in the list, the overall condition is false.
11284 .next
11285 For &*forall*&, interpretation stops if the condition is false for any item,
11286 and the result of the whole condition is false. If the condition is true for
11287 all items in the list, the overall condition is true.
11288 .endlist
11289 Note that negation of &*forany*& means that the condition must be false for all
11290 items for the overall condition to succeed, and negation of &*forall*& means
11291 that the condition must be false for at least one item. In this example, the
11292 list separator is changed to a comma:
11293 .code
11294 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11295 .endd
11296 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
11297 being processed, to enable these expansion items to be nested.
11298
11299 To scan a named list, expand it with the &*listnamed*& operator.
11300
11301
11302 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11303        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11304 .cindex "string" "comparison"
11305 .cindex "expansion" "string comparison"
11306 .cindex "&%ge%& expansion condition"
11307 .cindex "&%gei%& expansion condition"
11308 The two substrings are first expanded. The condition is true if the first
11309 string is lexically greater than or equal to the second string. For &%ge%& the
11310 comparison includes the case of letters, whereas for &%gei%& the comparison is
11311 case-independent.
11312 Case and collation order are defined per the system C locale.
11313
11314 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11315        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11316 .cindex "string" "comparison"
11317 .cindex "expansion" "string comparison"
11318 .cindex "&%gt%& expansion condition"
11319 .cindex "&%gti%& expansion condition"
11320 The two substrings are first expanded. The condition is true if the first
11321 string is lexically greater than the second string. For &%gt%& the comparison
11322 includes the case of letters, whereas for &%gti%& the comparison is
11323 case-independent.
11324 Case and collation order are defined per the system C locale.
11325
11326 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11327        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11328 .cindex "string" "comparison"
11329 .cindex "list" "iterative conditions"
11330 Both strings are expanded; the second string is treated as a list of simple
11331 strings; if the first string is a member of the second, then the condition
11332 is true.
11333 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11334
11335 These are simpler to use versions of the more powerful &*forany*& condition.
11336 Examples, and the &*forany*& equivalents:
11337 .code
11338 ${if inlist{needle}{foo:needle:bar}}
11339   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11340 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11341   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11342 .endd
11343
11344 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11345        &*isip4&~{*&<&'string'&>&*}*& &&&
11346        &*isip6&~{*&<&'string'&>&*}*&
11347 .cindex "IP address" "testing string format"
11348 .cindex "string" "testing for IP address"
11349 .cindex "&%isip%& expansion condition"
11350 .cindex "&%isip4%& expansion condition"
11351 .cindex "&%isip6%& expansion condition"
11352 The substring is first expanded, and then tested to see if it has the form of
11353 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11354 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11355
11356 For an IPv4 address, the test is for four dot-separated components, each of
11357 which consists of from one to three digits. For an IPv6 address, up to eight
11358 colon-separated components are permitted, each containing from one to four
11359 hexadecimal digits. There may be fewer than eight components if an empty
11360 component (adjacent colons) is present. Only one empty component is permitted.
11361
11362 &*Note*&: The checks used to be just on the form of the address; actual numerical
11363 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11364 check.
11365 This is no longer the case.
11366
11367 The main use of these tests is to distinguish between IP addresses and
11368 host names, or between IPv4 and IPv6 addresses. For example, you could use
11369 .code
11370 ${if isip4{$sender_host_address}...
11371 .endd
11372 to test which IP version an incoming SMTP connection is using.
11373
11374 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11375 .cindex "LDAP" "use for authentication"
11376 .cindex "expansion" "LDAP authentication test"
11377 .cindex "&%ldapauth%& expansion condition"
11378 This condition supports user authentication using LDAP. See section
11379 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11380 queries. For this use, the query must contain a user name and password. The
11381 query itself is not used, and can be empty. The condition is true if the
11382 password is not empty, and the user name and password are accepted by the LDAP
11383 server. An empty password is rejected without calling LDAP because LDAP binds
11384 with an empty password are considered anonymous regardless of the username, and
11385 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11386 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11387 this can be used.
11388
11389
11390 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11391        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11392 .cindex "string" "comparison"
11393 .cindex "expansion" "string comparison"
11394 .cindex "&%le%& expansion condition"
11395 .cindex "&%lei%& expansion condition"
11396 The two substrings are first expanded. The condition is true if the first
11397 string is lexically less than or equal to the second string. For &%le%& the
11398 comparison includes the case of letters, whereas for &%lei%& the comparison is
11399 case-independent.
11400 Case and collation order are defined per the system C locale.
11401
11402 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11403        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11404 .cindex "string" "comparison"
11405 .cindex "expansion" "string comparison"
11406 .cindex "&%lt%& expansion condition"
11407 .cindex "&%lti%& expansion condition"
11408 The two substrings are first expanded. The condition is true if the first
11409 string is lexically less than the second string. For &%lt%& the comparison
11410 includes the case of letters, whereas for &%lti%& the comparison is
11411 case-independent.
11412 Case and collation order are defined per the system C locale.
11413
11414
11415 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11416 .cindex "expansion" "regular expression comparison"
11417 .cindex "regular expressions" "match in expanded string"
11418 .cindex "&%match%& expansion condition"
11419 The two substrings are first expanded. The second is then treated as a regular
11420 expression and applied to the first. Because of the pre-expansion, if the
11421 regular expression contains dollar, or backslash characters, they must be
11422 escaped. Care must also be taken if the regular expression contains braces
11423 (curly brackets). A closing brace must be escaped so that it is not taken as a
11424 premature termination of <&'string2'&>. The easiest approach is to use the
11425 &`\N`& feature to disable expansion of the regular expression.
11426 For example,
11427 .code
11428 ${if match {$local_part}{\N^\d{3}\N} ...
11429 .endd
11430 If the whole expansion string is in double quotes, further escaping of
11431 backslashes is also required.
11432
11433 The condition is true if the regular expression match succeeds.
11434 The regular expression is not required to begin with a circumflex
11435 metacharacter, but if there is no circumflex, the expression is not anchored,
11436 and it may match anywhere in the subject, not just at the start. If you want
11437 the pattern to match at the end of the subject, you must include the &`$`&
11438 metacharacter at an appropriate point.
11439 All character handling is done in bytes and is not UTF-8 aware,
11440 but we might change this in a future Exim release.
11441
11442 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11443 At the start of an &%if%& expansion the values of the numeric variable
11444 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11445 succeeds causes them to be reset to the substrings of that condition and they
11446 will have these values during the expansion of the success string. At the end
11447 of the &%if%& expansion, the previous values are restored. After testing a
11448 combination of conditions using &%or%&, the subsequent values of the numeric
11449 variables are those of the condition that succeeded.
11450
11451 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11452 .cindex "&%match_address%& expansion condition"
11453 See &*match_local_part*&.
11454
11455 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11456 .cindex "&%match_domain%& expansion condition"
11457 See &*match_local_part*&.
11458
11459 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11460 .cindex "&%match_ip%& expansion condition"
11461 This condition matches an IP address to a list of IP address patterns. It must
11462 be followed by two argument strings. The first (after expansion) must be an IP
11463 address or an empty string. The second (not expanded) is a restricted host
11464 list that can match only an IP address, not a host name. For example:
11465 .code
11466 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11467 .endd
11468 The specific types of host list item that are permitted in the list are:
11469
11470 .ilist
11471 An IP address, optionally with a CIDR mask.
11472 .next
11473 A single asterisk, which matches any IP address.
11474 .next
11475 An empty item, which matches only if the IP address is empty. This could be
11476 useful for testing for a locally submitted message or one from specific hosts
11477 in a single test such as
11478 . ==== As this is a nested list, any displays it contains must be indented
11479 . ==== as otherwise they are too far to the left. This comment applies to
11480 . ==== the use of xmlto plus fop. There's no problem when formatting with
11481 . ==== sdop, with or without the extra indent.
11482 .code
11483   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11484 .endd
11485 where the first item in the list is the empty string.
11486 .next
11487 The item @[] matches any of the local host's interface addresses.
11488 .next
11489 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11490 even if &`net-`& is not specified. There is never any attempt to turn the IP
11491 address into a host name. The most common type of linear search for
11492 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11493 masks. For example:
11494 .code
11495   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11496 .endd
11497 It is of course possible to use other kinds of lookup, and in such a case, you
11498 do need to specify the &`net-`& prefix if you want to specify a specific
11499 address mask, for example:
11500 .code
11501   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11502 .endd
11503 However, unless you are combining a &%match_ip%& condition with others, it is
11504 just as easy to use the fact that a lookup is itself a condition, and write:
11505 .code
11506   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11507 .endd
11508 .endlist ilist
11509
11510 Note that <&'string2'&> is not itself subject to string expansion, unless
11511 Exim was built with the EXPAND_LISTMATCH_RHS option.
11512
11513 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11514
11515 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11516 .cindex "domain list" "in expansion condition"
11517 .cindex "address list" "in expansion condition"
11518 .cindex "local part" "list, in expansion condition"
11519 .cindex "&%match_local_part%& expansion condition"
11520 This condition, together with &%match_address%& and &%match_domain%&, make it
11521 possible to test domain, address, and local part lists within expansions. Each
11522 condition requires two arguments: an item and a list to match. A trivial
11523 example is:
11524 .code
11525 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11526 .endd
11527 In each case, the second argument may contain any of the allowable items for a
11528 list of the appropriate type. Also, because the second argument
11529 is a standard form of list, it is possible to refer to a named list.
11530 Thus, you can use conditions like this:
11531 .code
11532 ${if match_domain{$domain}{+local_domains}{...
11533 .endd
11534 .cindex "&`+caseful`&"
11535 For address lists, the matching starts off caselessly, but the &`+caseful`&
11536 item can be used, as in all address lists, to cause subsequent items to
11537 have their local parts matched casefully. Domains are always matched
11538 caselessly.
11539
11540 Note that <&'string2'&> is not itself subject to string expansion, unless
11541 Exim was built with the EXPAND_LISTMATCH_RHS option.
11542
11543 &*Note*&: Host lists are &'not'& supported in this way. This is because
11544 hosts have two identities: a name and an IP address, and it is not clear
11545 how to specify cleanly how such a test would work. However, IP addresses can be
11546 matched using &%match_ip%&.
11547
11548 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11549 .cindex "PAM authentication"
11550 .cindex "AUTH" "with PAM"
11551 .cindex "Solaris" "PAM support"
11552 .cindex "expansion" "PAM authentication test"
11553 .cindex "&%pam%& expansion condition"
11554 &'Pluggable Authentication Modules'&
11555 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11556 available in the latest releases of Solaris and in some GNU/Linux
11557 distributions. The Exim support, which is intended for use in conjunction with
11558 the SMTP AUTH command, is available only if Exim is compiled with
11559 .code
11560 SUPPORT_PAM=yes
11561 .endd
11562 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11563 in some releases of GNU/Linux &%-ldl%& is also needed.
11564
11565 The argument string is first expanded, and the result must be a
11566 colon-separated list of strings. Leading and trailing white space is ignored.
11567 The PAM module is initialized with the service name &"exim"& and the user name
11568 taken from the first item in the colon-separated data string (<&'string1'&>).
11569 The remaining items in the data string are passed over in response to requests
11570 from the authentication function. In the simple case there will only be one
11571 request, for a password, so the data consists of just two strings.
11572
11573 There can be problems if any of the strings are permitted to contain colon
11574 characters. In the usual way, these have to be doubled to avoid being taken as
11575 separators. If the data is being inserted from a variable, the &%sg%& expansion
11576 item can be used to double any existing colons. For example, the configuration
11577 of a LOGIN authenticator might contain this setting:
11578 .code
11579 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11580 .endd
11581 For a PLAIN authenticator you could use:
11582 .code
11583 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11584 .endd
11585 In some operating systems, PAM authentication can be done only from a process
11586 running as root. Since Exim is running as the Exim user when receiving
11587 messages, this means that PAM cannot be used directly in those systems.
11588 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11589
11590
11591 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11592 .cindex "&'pwcheck'& daemon"
11593 .cindex "Cyrus"
11594 .cindex "expansion" "&'pwcheck'& authentication test"
11595 .cindex "&%pwcheck%& expansion condition"
11596 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11597 This is one way of making it possible for passwords to be checked by a process
11598 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11599 deprecated. Its replacement is &'saslauthd'& (see below).
11600
11601 The pwcheck support is not included in Exim by default. You need to specify
11602 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11603 building Exim. For example:
11604 .code
11605 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11606 .endd
11607 You do not need to install the full Cyrus software suite in order to use
11608 the pwcheck daemon. You can compile and install just the daemon alone
11609 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11610 access to the &_/var/pwcheck_& directory.
11611
11612 The &%pwcheck%& condition takes one argument, which must be the user name and
11613 password, separated by a colon. For example, in a LOGIN authenticator
11614 configuration, you might have this:
11615 .code
11616 server_condition = ${if pwcheck{$auth1:$auth2}}
11617 .endd
11618 Again, for a PLAIN authenticator configuration, this would be:
11619 .code
11620 server_condition = ${if pwcheck{$auth2:$auth3}}
11621 .endd
11622 .vitem &*queue_running*&
11623 .cindex "queue runner" "detecting when delivering from"
11624 .cindex "expansion" "queue runner test"
11625 .cindex "&%queue_running%& expansion condition"
11626 This condition, which has no data, is true during delivery attempts that are
11627 initiated by queue runner processes, and false otherwise.
11628
11629
11630 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11631 .cindex "Radius"
11632 .cindex "expansion" "Radius authentication"
11633 .cindex "&%radius%& expansion condition"
11634 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11635 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11636 the Radius client configuration file in order to build Exim with Radius
11637 support.
11638
11639 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11640 library, using the original API. If you are using release 0.4.0 or later of
11641 this library, you need to set
11642 .code
11643 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11644 .endd
11645 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11646 &%libradius%& library that comes with FreeBSD. To do this, set
11647 .code
11648 RADIUS_LIB_TYPE=RADLIB
11649 .endd
11650 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11651 You may also have to supply a suitable setting in EXTRALIBS so that the
11652 Radius library can be found when Exim is linked.
11653
11654 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11655 Radius client library, which calls the Radius server. The condition is true if
11656 the authentication is successful. For example:
11657 .code
11658 server_condition = ${if radius{<arguments>}}
11659 .endd
11660
11661
11662 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11663         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11664 .cindex "&'saslauthd'& daemon"
11665 .cindex "Cyrus"
11666 .cindex "expansion" "&'saslauthd'& authentication test"
11667 .cindex "&%saslauthd%& expansion condition"
11668 This condition supports user authentication using the Cyrus &'saslauthd'&
11669 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11670 Using this daemon is one way of making it possible for passwords to be checked
11671 by a process that is not running as root.
11672
11673 The saslauthd support is not included in Exim by default. You need to specify
11674 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11675 building Exim. For example:
11676 .code
11677 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11678 .endd
11679 You do not need to install the full Cyrus software suite in order to use
11680 the saslauthd daemon. You can compile and install just the daemon alone
11681 from the Cyrus SASL library.
11682
11683 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11684 two are mandatory. For example:
11685 .code
11686 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11687 .endd
11688 The service and the realm are optional (which is why the arguments are enclosed
11689 in their own set of braces). For details of the meaning of the service and
11690 realm, and how to run the daemon, consult the Cyrus documentation.
11691 .endlist vlist
11692
11693
11694
11695 .section "Combining expansion conditions" "SECID84"
11696 .cindex "expansion" "combining conditions"
11697 Several conditions can be tested at once by combining them using the &%and%&
11698 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11699 conditions on their own, and precede their lists of sub-conditions. Each
11700 sub-condition must be enclosed in braces within the overall braces that contain
11701 the list. No repetition of &%if%& is used.
11702
11703
11704 .vlist
11705 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11706 .cindex "&""or""& expansion condition"
11707 .cindex "expansion" "&""or""& of conditions"
11708 The sub-conditions are evaluated from left to right. The condition is true if
11709 any one of the sub-conditions is true.
11710 For example,
11711 .code
11712 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11713 .endd
11714 When a true sub-condition is found, the following ones are parsed but not
11715 evaluated. If there are several &"match"& sub-conditions the values of the
11716 numeric variables afterwards are taken from the first one that succeeds.
11717
11718 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11719 .cindex "&""and""& expansion condition"
11720 .cindex "expansion" "&""and""& of conditions"
11721 The sub-conditions are evaluated from left to right. The condition is true if
11722 all of the sub-conditions are true. If there are several &"match"&
11723 sub-conditions, the values of the numeric variables afterwards are taken from
11724 the last one. When a false sub-condition is found, the following ones are
11725 parsed but not evaluated.
11726 .endlist
11727 .ecindex IIDexpcond
11728
11729
11730
11731
11732 .section "Expansion variables" "SECTexpvar"
11733 .cindex "expansion" "variables, list of"
11734 This section contains an alphabetical list of all the expansion variables. Some
11735 of them are available only when Exim is compiled with specific options such as
11736 support for TLS or the content scanning extension.
11737
11738 .vlist
11739 .vitem "&$0$&, &$1$&, etc"
11740 .cindex "numerical variables (&$1$& &$2$& etc)"
11741 When a &%match%& expansion condition succeeds, these variables contain the
11742 captured substrings identified by the regular expression during subsequent
11743 processing of the success string of the containing &%if%& expansion item.
11744 In the expansion condition case
11745 they do not retain their values afterwards; in fact, their previous
11746 values are restored at the end of processing an &%if%& item. The numerical
11747 variables may also be set externally by some other matching process which
11748 precedes the expansion of the string. For example, the commands available in
11749 Exim filter files include an &%if%& command with its own regular expression
11750 matching condition.
11751
11752 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11753 Within an acl condition, expansion condition or expansion item
11754 any arguments are copied to these variables,
11755 any unused variables being made empty.
11756
11757 .vitem "&$acl_c...$&"
11758 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11759 can be given any name that starts with &$acl_c$& and is at least six characters
11760 long, but the sixth character must be either a digit or an underscore. For
11761 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11762 variables persist throughout the lifetime of an SMTP connection. They can be
11763 used to pass information between ACLs and between different invocations of the
11764 same ACL. When a message is received, the values of these variables are saved
11765 with the message, and can be accessed by filters, routers, and transports
11766 during subsequent delivery.
11767
11768 .vitem "&$acl_m...$&"
11769 These variables are like the &$acl_c...$& variables, except that their values
11770 are reset after a message has been received. Thus, if several messages are
11771 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11772 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11773 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11774 message is received, the values of these variables are saved with the message,
11775 and can be accessed by filters, routers, and transports during subsequent
11776 delivery.
11777
11778 .vitem &$acl_narg$&
11779 Within an acl condition, expansion condition or expansion item
11780 this variable has the number of arguments.
11781
11782 .vitem &$acl_verify_message$&
11783 .vindex "&$acl_verify_message$&"
11784 After an address verification has failed, this variable contains the failure
11785 message. It retains its value for use in subsequent modifiers. The message can
11786 be preserved by coding like this:
11787 .code
11788 warn !verify = sender
11789      set acl_m0 = $acl_verify_message
11790 .endd
11791 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11792 &%log_message%& modifiers, to include information about the verification
11793 failure.
11794
11795 .vitem &$address_data$&
11796 .vindex "&$address_data$&"
11797 This variable is set by means of the &%address_data%& option in routers. The
11798 value then remains with the address while it is processed by subsequent routers
11799 and eventually a transport. If the transport is handling multiple addresses,
11800 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11801 for more details. &*Note*&: The contents of &$address_data$& are visible in
11802 user filter files.
11803
11804 If &$address_data$& is set when the routers are called from an ACL to verify
11805 a recipient address, the final value is still in the variable for subsequent
11806 conditions and modifiers of the ACL statement. If routing the address caused it
11807 to be redirected to just one address, the child address is also routed as part
11808 of the verification, and in this case the final value of &$address_data$& is
11809 from the child's routing.
11810
11811 If &$address_data$& is set when the routers are called from an ACL to verify a
11812 sender address, the final value is also preserved, but this time in
11813 &$sender_address_data$&, to distinguish it from data from a recipient
11814 address.
11815
11816 In both cases (recipient and sender verification), the value does not persist
11817 after the end of the current ACL statement. If you want to preserve
11818 these values for longer, you can save them in ACL variables.
11819
11820 .vitem &$address_file$&
11821 .vindex "&$address_file$&"
11822 When, as a result of aliasing, forwarding, or filtering, a message is directed
11823 to a specific file, this variable holds the name of the file when the transport
11824 is running. At other times, the variable is empty. For example, using the
11825 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11826 .code
11827 /home/r2d2/savemail
11828 .endd
11829 then when the &(address_file)& transport is running, &$address_file$&
11830 contains the text string &`/home/r2d2/savemail`&.
11831 .cindex "Sieve filter" "value of &$address_file$&"
11832 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11833 then up to the transport configuration to generate an appropriate absolute path
11834 to the relevant file.
11835
11836 .vitem &$address_pipe$&
11837 .vindex "&$address_pipe$&"
11838 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11839 this variable holds the pipe command when the transport is running.
11840
11841 .vitem "&$auth1$& &-- &$auth3$&"
11842 .vindex "&$auth1$&, &$auth2$&, etc"
11843 These variables are used in SMTP authenticators (see chapters
11844 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11845
11846 .vitem &$authenticated_id$&
11847 .cindex "authentication" "id"
11848 .vindex "&$authenticated_id$&"
11849 When a server successfully authenticates a client it may be configured to
11850 preserve some of the authentication information in the variable
11851 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11852 user/password authenticator configuration might preserve the user name for use
11853 in the routers. Note that this is not the same information that is saved in
11854 &$sender_host_authenticated$&.
11855
11856 When a message is submitted locally (that is, not over a TCP connection)
11857 the value of &$authenticated_id$& is normally the login name of the calling
11858 process. However, a trusted user can override this by means of the &%-oMai%&
11859 command line option.
11860 This second case also sets up information used by the
11861 &$authresults$& expansion item.
11862
11863 .vitem &$authenticated_fail_id$&
11864 .cindex "authentication" "fail" "id"
11865 .vindex "&$authenticated_fail_id$&"
11866 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11867 will contain the failed authentication id. If more than one authentication
11868 id is attempted, it will contain only the last one. The variable is
11869 available for processing in the ACL's, generally the quit or notquit ACL.
11870 A message to a local recipient could still be accepted without requiring
11871 authentication, which means this variable could also be visible in all of
11872 the ACL's as well.
11873
11874
11875 .vitem &$authenticated_sender$&
11876 .cindex "sender" "authenticated"
11877 .cindex "authentication" "sender"
11878 .cindex "AUTH" "on MAIL command"
11879 .vindex "&$authenticated_sender$&"
11880 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11881 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11882 described in section &<<SECTauthparamail>>&. Unless the data is the string
11883 &"<>"&, it is set as the authenticated sender of the message, and the value is
11884 available during delivery in the &$authenticated_sender$& variable. If the
11885 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11886
11887 .vindex "&$qualify_domain$&"
11888 When a message is submitted locally (that is, not over a TCP connection), the
11889 value of &$authenticated_sender$& is an address constructed from the login
11890 name of the calling process and &$qualify_domain$&, except that a trusted user
11891 can override this by means of the &%-oMas%& command line option.
11892
11893
11894 .vitem &$authentication_failed$&
11895 .cindex "authentication" "failure"
11896 .vindex "&$authentication_failed$&"
11897 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11898 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11899 possible to distinguish between &"did not try to authenticate"&
11900 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11901 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11902 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11903 negative response to an AUTH command, including (for example) an attempt to use
11904 an undefined mechanism.
11905
11906 .vitem &$av_failed$&
11907 .cindex "content scanning" "AV scanner failure"
11908 This variable is available when Exim is compiled with the content-scanning
11909 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11910 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11911 the ACL malware condition.
11912
11913 .vitem &$body_linecount$&
11914 .cindex "message body" "line count"
11915 .cindex "body of message" "line count"
11916 .vindex "&$body_linecount$&"
11917 When a message is being received or delivered, this variable contains the
11918 number of lines in the message's body. See also &$message_linecount$&.
11919
11920 .vitem &$body_zerocount$&
11921 .cindex "message body" "binary zero count"
11922 .cindex "body of message" "binary zero count"
11923 .cindex "binary zero" "in message body"
11924 .vindex "&$body_zerocount$&"
11925 When a message is being received or delivered, this variable contains the
11926 number of binary zero bytes (ASCII NULs) in the message's body.
11927
11928 .vitem &$bounce_recipient$&
11929 .vindex "&$bounce_recipient$&"
11930 This is set to the recipient address of a bounce message while Exim is creating
11931 it. It is useful if a customized bounce message text file is in use (see
11932 chapter &<<CHAPemsgcust>>&).
11933
11934 .vitem &$bounce_return_size_limit$&
11935 .vindex "&$bounce_return_size_limit$&"
11936 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11937 up to a multiple of 1000. It is useful when a customized error message text
11938 file is in use (see chapter &<<CHAPemsgcust>>&).
11939
11940 .vitem &$caller_gid$&
11941 .cindex "gid (group id)" "caller"
11942 .vindex "&$caller_gid$&"
11943 The real group id under which the process that called Exim was running. This is
11944 not the same as the group id of the originator of a message (see
11945 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11946 incarnation normally contains the Exim gid.
11947
11948 .vitem &$caller_uid$&
11949 .cindex "uid (user id)" "caller"
11950 .vindex "&$caller_uid$&"
11951 The real user id under which the process that called Exim was running. This is
11952 not the same as the user id of the originator of a message (see
11953 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11954 incarnation normally contains the Exim uid.
11955
11956 .vitem &$callout_address$&
11957 .vindex "&$callout_address$&"
11958 After a callout for verification, spamd or malware daemon service, the
11959 address that was connected to.
11960
11961 .vitem &$compile_number$&
11962 .vindex "&$compile_number$&"
11963 The building process for Exim keeps a count of the number
11964 of times it has been compiled. This serves to distinguish different
11965 compilations of the same version of the program.
11966
11967 .vitem &$config_dir$&
11968 .vindex "&$config_dir$&"
11969 The directory name of the main configuration file. That is, the content of
11970 &$config_file$& with the last component stripped. The value does not
11971 contain the trailing slash. If &$config_file$& does not contain a slash,
11972 &$config_dir$& is ".".
11973
11974 .vitem &$config_file$&
11975 .vindex "&$config_file$&"
11976 The name of the main configuration file Exim is using.
11977
11978 .vitem &$dkim_verify_status$&
11979 Results of DKIM verification.
11980 For details see section &<<SECDKIMVFY>>&.
11981
11982 .vitem &$dkim_cur_signer$& &&&
11983        &$dkim_verify_reason$& &&&
11984        &$dkim_domain$& &&&
11985        &$dkim_identity$& &&&
11986        &$dkim_selector$& &&&
11987        &$dkim_algo$& &&&
11988        &$dkim_canon_body$& &&&
11989        &$dkim_canon_headers$& &&&
11990        &$dkim_copiedheaders$& &&&
11991        &$dkim_bodylength$& &&&
11992        &$dkim_created$& &&&
11993        &$dkim_expires$& &&&
11994        &$dkim_headernames$& &&&
11995        &$dkim_key_testing$& &&&
11996        &$dkim_key_nosubdomains$& &&&
11997        &$dkim_key_srvtype$& &&&
11998        &$dkim_key_granularity$& &&&
11999        &$dkim_key_notes$& &&&
12000        &$dkim_key_length$&
12001 These variables are only available within the DKIM ACL.
12002 For details see section &<<SECDKIMVFY>>&.
12003
12004 .vitem &$dkim_signers$&
12005 .vindex &$dkim_signers$&
12006 When a message has been received this variable contains
12007 a colon-separated list of signer domains and identities for the message.
12008 For details see section &<<SECDKIMVFY>>&.
12009
12010 .vitem &$dnslist_domain$& &&&
12011        &$dnslist_matched$& &&&
12012        &$dnslist_text$& &&&
12013        &$dnslist_value$&
12014 .vindex "&$dnslist_domain$&"
12015 .vindex "&$dnslist_matched$&"
12016 .vindex "&$dnslist_text$&"
12017 .vindex "&$dnslist_value$&"
12018 .cindex "black list (DNS)"
12019 When a DNS (black) list lookup succeeds, these variables are set to contain
12020 the following data from the lookup: the list's domain name, the key that was
12021 looked up, the contents of any associated TXT record, and the value from the
12022 main A record. See section &<<SECID204>>& for more details.
12023
12024 .vitem &$domain$&
12025 .vindex "&$domain$&"
12026 When an address is being routed, or delivered on its own, this variable
12027 contains the domain. Uppercase letters in the domain are converted into lower
12028 case for &$domain$&.
12029
12030 Global address rewriting happens when a message is received, so the value of
12031 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12032 is set during user filtering, but not during system filtering, because a
12033 message may have many recipients and the system filter is called just once.
12034
12035 When more than one address is being delivered at once (for example, several
12036 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12037 have the same domain. Transports can be restricted to handling only one domain
12038 at a time if the value of &$domain$& is required at transport time &-- this is
12039 the default for local transports. For further details of the environment in
12040 which local transports are run, see chapter &<<CHAPenvironment>>&.
12041
12042 .oindex "&%delay_warning_condition%&"
12043 At the end of a delivery, if all deferred addresses have the same domain, it is
12044 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12045
12046 The &$domain$& variable is also used in some other circumstances:
12047
12048 .ilist
12049 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12050 the recipient address. The domain of the &'sender'& address is in
12051 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12052 normally set during the running of the MAIL ACL. However, if the sender address
12053 is verified with a callout during the MAIL ACL, the sender domain is placed in
12054 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12055 the &(smtp)& transport.
12056
12057 .next
12058 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12059 &$domain$& contains the domain portion of the address that is being rewritten;
12060 it can be used in the expansion of the replacement address, for example, to
12061 rewrite domains by file lookup.
12062
12063 .next
12064 With one important exception, whenever a domain list is being scanned,
12065 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12066 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12067 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12068 that, in a RCPT ACL, the sender domain list can be dependent on the
12069 recipient domain (which is what is in &$domain$& at this time).
12070
12071 .next
12072 .cindex "ETRN" "value of &$domain$&"
12073 .oindex "&%smtp_etrn_command%&"
12074 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12075 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12076 .endlist
12077
12078
12079 .vitem &$domain_data$&
12080 .vindex "&$domain_data$&"
12081 When the &%domains%& option on a router matches a domain by
12082 means of a lookup, the data read by the lookup is available during the running
12083 of the router as &$domain_data$&. In addition, if the driver routes the
12084 address to a transport, the value is available in that transport. If the
12085 transport is handling multiple addresses, the value from the first address is
12086 used.
12087
12088 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12089 domain by means of a lookup. The data read by the lookup is available during
12090 the rest of the ACL statement. In all other situations, this variable expands
12091 to nothing.
12092
12093 .vitem &$exim_gid$&
12094 .vindex "&$exim_gid$&"
12095 This variable contains the numerical value of the Exim group id.
12096
12097 .vitem &$exim_path$&
12098 .vindex "&$exim_path$&"
12099 This variable contains the path to the Exim binary.
12100
12101 .vitem &$exim_uid$&
12102 .vindex "&$exim_uid$&"
12103 This variable contains the numerical value of the Exim user id.
12104
12105 .vitem &$exim_version$&
12106 .vindex "&$exim_version$&"
12107 This variable contains the version string of the Exim build.
12108 The first character is a major version number, currently 4.
12109 Then after a dot, the next group of digits is a minor version number.
12110 There may be other characters following the minor version.
12111
12112 .vitem &$header_$&<&'name'&>
12113 This is not strictly an expansion variable. It is expansion syntax for
12114 inserting the message header line with the given name. Note that the name must
12115 be terminated by colon or white space, because it may contain a wide variety of
12116 characters. Note also that braces must &'not'& be used.
12117 See the full description in section &<<SECTexpansionitems>>& above.
12118
12119 .vitem &$headers_added$&
12120 .vindex "&$headers_added$&"
12121 Within an ACL this variable contains the headers added so far by
12122 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12123 The headers are a newline-separated list.
12124
12125 .vitem &$home$&
12126 .vindex "&$home$&"
12127 When the &%check_local_user%& option is set for a router, the user's home
12128 directory is placed in &$home$& when the check succeeds. In particular, this
12129 means it is set during the running of users' filter files. A router may also
12130 explicitly set a home directory for use by a transport; this can be overridden
12131 by a setting on the transport itself.
12132
12133 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12134 of the environment variable HOME, which is subject to the
12135 &%keep_environment%& and &%add_environment%& main config options.
12136
12137 .vitem &$host$&
12138 .vindex "&$host$&"
12139 If a router assigns an address to a transport (any transport), and passes a
12140 list of hosts with the address, the value of &$host$& when the transport starts
12141 to run is the name of the first host on the list. Note that this applies both
12142 to local and remote transports.
12143
12144 .cindex "transport" "filter"
12145 .cindex "filter" "transport filter"
12146 For the &(smtp)& transport, if there is more than one host, the value of
12147 &$host$& changes as the transport works its way through the list. In
12148 particular, when the &(smtp)& transport is expanding its options for encryption
12149 using TLS, or for specifying a transport filter (see chapter
12150 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12151 is connected.
12152
12153 When used in the client part of an authenticator configuration (see chapter
12154 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12155 client is connected.
12156
12157
12158 .vitem &$host_address$&
12159 .vindex "&$host_address$&"
12160 This variable is set to the remote host's IP address whenever &$host$& is set
12161 for a remote connection. It is also set to the IP address that is being checked
12162 when the &%ignore_target_hosts%& option is being processed.
12163
12164 .vitem &$host_data$&
12165 .vindex "&$host_data$&"
12166 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12167 result of the lookup is made available in the &$host_data$& variable. This
12168 allows you, for example, to do things like this:
12169 .code
12170 deny  hosts = net-lsearch;/some/file
12171 message = $host_data
12172 .endd
12173 .vitem &$host_lookup_deferred$&
12174 .cindex "host name" "lookup, failure of"
12175 .vindex "&$host_lookup_deferred$&"
12176 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12177 message comes from a remote host and there is an attempt to look up the host's
12178 name from its IP address, and the attempt is not successful, one of these
12179 variables is set to &"1"&.
12180
12181 .ilist
12182 If the lookup receives a definite negative response (for example, a DNS lookup
12183 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12184
12185 .next
12186 If there is any kind of problem during the lookup, such that Exim cannot
12187 tell whether or not the host name is defined (for example, a timeout for a DNS
12188 lookup), &$host_lookup_deferred$& is set to &"1"&.
12189 .endlist ilist
12190
12191 Looking up a host's name from its IP address consists of more than just a
12192 single reverse lookup. Exim checks that a forward lookup of at least one of the
12193 names it receives from a reverse lookup yields the original IP address. If this
12194 is not the case, Exim does not accept the looked up name(s), and
12195 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12196 IP address (for example, the existence of a PTR record in the DNS) is not
12197 sufficient on its own for the success of a host name lookup. If the reverse
12198 lookup succeeds, but there is a lookup problem such as a timeout when checking
12199 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12200 &"1"&. See also &$sender_host_name$&.
12201
12202 .cindex authentication "expansion item"
12203 Performing these checks sets up information used by the
12204 &$authresults$& expansion item.
12205
12206
12207 .vitem &$host_lookup_failed$&
12208 .vindex "&$host_lookup_failed$&"
12209 See &$host_lookup_deferred$&.
12210
12211 .vitem &$host_port$&
12212 .vindex "&$host_port$&"
12213 This variable is set to the remote host's TCP port whenever &$host$& is set
12214 for an outbound connection.
12215
12216 .vitem &$initial_cwd$&
12217 .vindex "&$initial_cwd$&
12218 This variable contains the full path name of the initial working
12219 directory of the current Exim process. This may differ from the current
12220 working directory, as Exim changes this to "/" during early startup, and
12221 to &$spool_directory$& later.
12222
12223 .vitem &$inode$&
12224 .vindex "&$inode$&"
12225 The only time this variable is set is while expanding the &%directory_file%&
12226 option in the &(appendfile)& transport. The variable contains the inode number
12227 of the temporary file which is about to be renamed. It can be used to construct
12228 a unique name for the file.
12229
12230 .vitem &$interface_address$&
12231 .vindex "&$interface_address$&"
12232 This is an obsolete name for &$received_ip_address$&.
12233
12234 .vitem &$interface_port$&
12235 .vindex "&$interface_port$&"
12236 This is an obsolete name for &$received_port$&.
12237
12238 .vitem &$item$&
12239 .vindex "&$item$&"
12240 This variable is used during the expansion of &*forall*& and &*forany*&
12241 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12242 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12243 empty.
12244
12245 .vitem &$ldap_dn$&
12246 .vindex "&$ldap_dn$&"
12247 This variable, which is available only when Exim is compiled with LDAP support,
12248 contains the DN from the last entry in the most recently successful LDAP
12249 lookup.
12250
12251 .vitem &$load_average$&
12252 .vindex "&$load_average$&"
12253 This variable contains the system load average, multiplied by 1000 so that it
12254 is an integer. For example, if the load average is 0.21, the value of the
12255 variable is 210. The value is recomputed every time the variable is referenced.
12256
12257 .vitem &$local_part$&
12258 .vindex "&$local_part$&"
12259 When an address is being routed, or delivered on its own, this
12260 variable contains the local part. When a number of addresses are being
12261 delivered together (for example, multiple RCPT commands in an SMTP
12262 session), &$local_part$& is not set.
12263
12264 Global address rewriting happens when a message is received, so the value of
12265 &$local_part$& during routing and delivery is the value after rewriting.
12266 &$local_part$& is set during user filtering, but not during system filtering,
12267 because a message may have many recipients and the system filter is called just
12268 once.
12269
12270 .vindex "&$local_part_prefix$&"
12271 .vindex "&$local_part_suffix$&"
12272 .cindex affix variables
12273 If a local part prefix or suffix has been recognized, it is not included in the
12274 value of &$local_part$& during routing and subsequent delivery. The values of
12275 any prefix or suffix are in &$local_part_prefix$& and
12276 &$local_part_suffix$&, respectively.
12277
12278 When a message is being delivered to a file, pipe, or autoreply transport as a
12279 result of aliasing or forwarding, &$local_part$& is set to the local part of
12280 the parent address, not to the file name or command (see &$address_file$& and
12281 &$address_pipe$&).
12282
12283 When an ACL is running for a RCPT command, &$local_part$& contains the
12284 local part of the recipient address.
12285
12286 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12287 &$local_part$& contains the local part of the address that is being rewritten;
12288 it can be used in the expansion of the replacement address, for example.
12289
12290 In all cases, all quoting is removed from the local part. For example, for both
12291 the addresses
12292 .code
12293 "abc:xyz"@test.example
12294 abc\:xyz@test.example
12295 .endd
12296 the value of &$local_part$& is
12297 .code
12298 abc:xyz
12299 .endd
12300 If you use &$local_part$& to create another address, you should always wrap it
12301 inside a quoting operator. For example, in a &(redirect)& router you could
12302 have:
12303 .code
12304 data = ${quote_local_part:$local_part}@new.domain.example
12305 .endd
12306 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12307 to process local parts in a case-dependent manner in a router, you can set the
12308 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12309
12310 .vitem &$local_part_data$&
12311 .vindex "&$local_part_data$&"
12312 When the &%local_parts%& option on a router matches a local part by means of a
12313 lookup, the data read by the lookup is available during the running of the
12314 router as &$local_part_data$&. In addition, if the driver routes the address
12315 to a transport, the value is available in that transport. If the transport is
12316 handling multiple addresses, the value from the first address is used.
12317
12318 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12319 matches a local part by means of a lookup. The data read by the lookup is
12320 available during the rest of the ACL statement. In all other situations, this
12321 variable expands to nothing.
12322
12323 .vitem &$local_part_prefix$&
12324 .vindex "&$local_part_prefix$&"
12325 .cindex affix variables
12326 When an address is being routed or delivered, and a
12327 specific prefix for the local part was recognized, it is available in this
12328 variable, having been removed from &$local_part$&.
12329
12330 .vitem &$local_part_suffix$&
12331 .vindex "&$local_part_suffix$&"
12332 When an address is being routed or delivered, and a
12333 specific suffix for the local part was recognized, it is available in this
12334 variable, having been removed from &$local_part$&.
12335
12336 .vitem &$local_scan_data$&
12337 .vindex "&$local_scan_data$&"
12338 This variable contains the text returned by the &[local_scan()]& function when
12339 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12340
12341 .vitem &$local_user_gid$&
12342 .vindex "&$local_user_gid$&"
12343 See &$local_user_uid$&.
12344
12345 .vitem &$local_user_uid$&
12346 .vindex "&$local_user_uid$&"
12347 This variable and &$local_user_gid$& are set to the uid and gid after the
12348 &%check_local_user%& router precondition succeeds. This means that their values
12349 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12350 and &%condition%&), for the &%address_data%& expansion, and for any
12351 router-specific expansions. At all other times, the values in these variables
12352 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12353
12354 .vitem &$localhost_number$&
12355 .vindex "&$localhost_number$&"
12356 This contains the expanded value of the
12357 &%localhost_number%& option. The expansion happens after the main options have
12358 been read.
12359
12360 .vitem &$log_inodes$&
12361 .vindex "&$log_inodes$&"
12362 The number of free inodes in the disk partition where Exim's
12363 log files are being written. The value is recalculated whenever the variable is
12364 referenced. If the relevant file system does not have the concept of inodes,
12365 the value of is -1. See also the &%check_log_inodes%& option.
12366
12367 .vitem &$log_space$&
12368 .vindex "&$log_space$&"
12369 The amount of free space (as a number of kilobytes) in the disk
12370 partition where Exim's log files are being written. The value is recalculated
12371 whenever the variable is referenced. If the operating system does not have the
12372 ability to find the amount of free space (only true for experimental systems),
12373 the space value is -1. See also the &%check_log_space%& option.
12374
12375
12376 .vitem &$lookup_dnssec_authenticated$&
12377 .vindex "&$lookup_dnssec_authenticated$&"
12378 This variable is set after a DNS lookup done by
12379 a dnsdb lookup expansion, dnslookup router or smtp transport.
12380 .cindex "DNS" "DNSSEC"
12381 It will be empty if &(DNSSEC)& was not requested,
12382 &"no"& if the result was not labelled as authenticated data
12383 and &"yes"& if it was.
12384 Results that are labelled as authoritative answer that match
12385 the &%dns_trust_aa%& configuration variable count also
12386 as authenticated data.
12387
12388 .vitem &$mailstore_basename$&
12389 .vindex "&$mailstore_basename$&"
12390 This variable is set only when doing deliveries in &"mailstore"& format in the
12391 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12392 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12393 contains the basename of the files that are being written, that is, the name
12394 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12395 variable is empty.
12396
12397 .vitem &$malware_name$&
12398 .vindex "&$malware_name$&"
12399 This variable is available when Exim is compiled with the
12400 content-scanning extension. It is set to the name of the virus that was found
12401 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12402
12403 .vitem &$max_received_linelength$&
12404 .vindex "&$max_received_linelength$&"
12405 .cindex "maximum" "line length"
12406 .cindex "line length" "maximum"
12407 This variable contains the number of bytes in the longest line that was
12408 received as part of the message, not counting the line termination
12409 character(s).
12410 It is not valid if the &%spool_files_wireformat%& option is used.
12411
12412 .vitem &$message_age$&
12413 .cindex "message" "age of"
12414 .vindex "&$message_age$&"
12415 This variable is set at the start of a delivery attempt to contain the number
12416 of seconds since the message was received. It does not change during a single
12417 delivery attempt.
12418
12419 .vitem &$message_body$&
12420 .cindex "body of message" "expansion variable"
12421 .cindex "message body" "in expansion"
12422 .cindex "binary zero" "in message body"
12423 .vindex "&$message_body$&"
12424 .oindex "&%message_body_visible%&"
12425 This variable contains the initial portion of a message's body while it is
12426 being delivered, and is intended mainly for use in filter files. The maximum
12427 number of characters of the body that are put into the variable is set by the
12428 &%message_body_visible%& configuration option; the default is 500.
12429
12430 .oindex "&%message_body_newlines%&"
12431 By default, newlines are converted into spaces in &$message_body$&, to make it
12432 easier to search for phrases that might be split over a line break. However,
12433 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12434 zeros are always converted into spaces.
12435
12436 .vitem &$message_body_end$&
12437 .cindex "body of message" "expansion variable"
12438 .cindex "message body" "in expansion"
12439 .vindex "&$message_body_end$&"
12440 This variable contains the final portion of a message's
12441 body while it is being delivered. The format and maximum size are as for
12442 &$message_body$&.
12443
12444 .vitem &$message_body_size$&
12445 .cindex "body of message" "size"
12446 .cindex "message body" "size"
12447 .vindex "&$message_body_size$&"
12448 When a message is being delivered, this variable contains the size of the body
12449 in bytes. The count starts from the character after the blank line that
12450 separates the body from the header. Newlines are included in the count. See
12451 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12452
12453 If the spool file is wireformat
12454 (see the &%spool_files_wireformat%& main option)
12455 the CRLF line-terminators are included in the count.
12456
12457 .vitem &$message_exim_id$&
12458 .vindex "&$message_exim_id$&"
12459 When a message is being received or delivered, this variable contains the
12460 unique message id that is generated and used by Exim to identify the message.
12461 An id is not created for a message until after its header has been successfully
12462 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12463 line; it is the local id that Exim assigns to the message, for example:
12464 &`1BXTIK-0001yO-VA`&.
12465
12466 .vitem &$message_headers$&
12467 .vindex &$message_headers$&
12468 This variable contains a concatenation of all the header lines when a message
12469 is being processed, except for lines added by routers or transports. The header
12470 lines are separated by newline characters. Their contents are decoded in the
12471 same way as a header line that is inserted by &%bheader%&.
12472
12473 .vitem &$message_headers_raw$&
12474 .vindex &$message_headers_raw$&
12475 This variable is like &$message_headers$& except that no processing of the
12476 contents of header lines is done.
12477
12478 .vitem &$message_id$&
12479 This is an old name for &$message_exim_id$&. It is now deprecated.
12480
12481 .vitem &$message_linecount$&
12482 .vindex "&$message_linecount$&"
12483 This variable contains the total number of lines in the header and body of the
12484 message. Compare &$body_linecount$&, which is the count for the body only.
12485 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12486 number of lines received. Before delivery happens (that is, before filters,
12487 routers, and transports run) the count is increased to include the
12488 &'Received:'& header line that Exim standardly adds, and also any other header
12489 lines that are added by ACLs. The blank line that separates the message header
12490 from the body is not counted.
12491
12492 As with the special case of &$message_size$&, during the expansion of the
12493 appendfile transport's maildir_tag option in maildir format, the value of
12494 &$message_linecount$& is the precise size of the number of newlines in the
12495 file that has been written (minus one for the blank line between the
12496 header and the body).
12497
12498 Here is an example of the use of this variable in a DATA ACL:
12499 .code
12500 deny message   = Too many lines in message header
12501      condition = \
12502       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12503 .endd
12504 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12505 message has not yet been received.
12506
12507 This variable is not valid if the &%spool_files_wireformat%& option is used.
12508
12509 .vitem &$message_size$&
12510 .cindex "size" "of message"
12511 .cindex "message" "size"
12512 .vindex "&$message_size$&"
12513 When a message is being processed, this variable contains its size in bytes. In
12514 most cases, the size includes those headers that were received with the
12515 message, but not those (such as &'Envelope-to:'&) that are added to individual
12516 deliveries as they are written. However, there is one special case: during the
12517 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12518 doing a delivery in maildir format, the value of &$message_size$& is the
12519 precise size of the file that has been written. See also
12520 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12521
12522 .cindex "RCPT" "value of &$message_size$&"
12523 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12524 contains the size supplied on the MAIL command, or -1 if no size was given. The
12525 value may not, of course, be truthful.
12526
12527 .vitem &$mime_$&&'xxx'&
12528 A number of variables whose names start with &$mime$& are
12529 available when Exim is compiled with the content-scanning extension. For
12530 details, see section &<<SECTscanmimepart>>&.
12531
12532 .vitem "&$n0$& &-- &$n9$&"
12533 These variables are counters that can be incremented by means
12534 of the &%add%& command in filter files.
12535
12536 .vitem &$original_domain$&
12537 .vindex "&$domain$&"
12538 .vindex "&$original_domain$&"
12539 When a top-level address is being processed for delivery, this contains the
12540 same value as &$domain$&. However, if a &"child"& address (for example,
12541 generated by an alias, forward, or filter file) is being processed, this
12542 variable contains the domain of the original address (lower cased). This
12543 differs from &$parent_domain$& only when there is more than one level of
12544 aliasing or forwarding. When more than one address is being delivered in a
12545 single transport run, &$original_domain$& is not set.
12546
12547 If a new address is created by means of a &%deliver%& command in a system
12548 filter, it is set up with an artificial &"parent"& address. This has the local
12549 part &'system-filter'& and the default qualify domain.
12550
12551 .vitem &$original_local_part$&
12552 .vindex "&$local_part$&"
12553 .vindex "&$original_local_part$&"
12554 When a top-level address is being processed for delivery, this contains the
12555 same value as &$local_part$&, unless a prefix or suffix was removed from the
12556 local part, because &$original_local_part$& always contains the full local
12557 part. When a &"child"& address (for example, generated by an alias, forward, or
12558 filter file) is being processed, this variable contains the full local part of
12559 the original address.
12560
12561 If the router that did the redirection processed the local part
12562 case-insensitively, the value in &$original_local_part$& is in lower case.
12563 This variable differs from &$parent_local_part$& only when there is more than
12564 one level of aliasing or forwarding. When more than one address is being
12565 delivered in a single transport run, &$original_local_part$& is not set.
12566
12567 If a new address is created by means of a &%deliver%& command in a system
12568 filter, it is set up with an artificial &"parent"& address. This has the local
12569 part &'system-filter'& and the default qualify domain.
12570
12571 .vitem &$originator_gid$&
12572 .cindex "gid (group id)" "of originating user"
12573 .cindex "sender" "gid"
12574 .vindex "&$caller_gid$&"
12575 .vindex "&$originator_gid$&"
12576 This variable contains the value of &$caller_gid$& that was set when the
12577 message was received. For messages received via the command line, this is the
12578 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12579 normally the gid of the Exim user.
12580
12581 .vitem &$originator_uid$&
12582 .cindex "uid (user id)" "of originating user"
12583 .cindex "sender" "uid"
12584 .vindex "&$caller_uid$&"
12585 .vindex "&$originator_uid$&"
12586 The value of &$caller_uid$& that was set when the message was received. For
12587 messages received via the command line, this is the uid of the sending user.
12588 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12589 user.
12590
12591 .vitem &$parent_domain$&
12592 .vindex "&$parent_domain$&"
12593 This variable is similar to &$original_domain$& (see
12594 above), except that it refers to the immediately preceding parent address.
12595
12596 .vitem &$parent_local_part$&
12597 .vindex "&$parent_local_part$&"
12598 This variable is similar to &$original_local_part$&
12599 (see above), except that it refers to the immediately preceding parent address.
12600
12601 .vitem &$pid$&
12602 .cindex "pid (process id)" "of current process"
12603 .vindex "&$pid$&"
12604 This variable contains the current process id.
12605
12606 .vitem &$pipe_addresses$&
12607 .cindex "filter" "transport filter"
12608 .cindex "transport" "filter"
12609 .vindex "&$pipe_addresses$&"
12610 This is not an expansion variable, but is mentioned here because the string
12611 &`$pipe_addresses`& is handled specially in the command specification for the
12612 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12613 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12614 It cannot be used in general expansion strings, and provokes an &"unknown
12615 variable"& error if encountered.
12616
12617 .vitem &$primary_hostname$&
12618 .vindex "&$primary_hostname$&"
12619 This variable contains the value set by &%primary_hostname%& in the
12620 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12621 a single-component name, Exim calls &[gethostbyname()]& (or
12622 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12623 qualified host name. See also &$smtp_active_hostname$&.
12624
12625
12626 .vitem &$proxy_external_address$& &&&
12627        &$proxy_external_port$& &&&
12628        &$proxy_local_address$& &&&
12629        &$proxy_local_port$& &&&
12630        &$proxy_session$&
12631 These variables are only available when built with Proxy Protocol
12632 or SOCKS5 support.
12633 For details see chapter &<<SECTproxyInbound>>&.
12634
12635 .vitem &$prdr_requested$&
12636 .cindex "PRDR" "variable for"
12637 This variable is set to &"yes"& if PRDR was requested by the client for the
12638 current message, otherwise &"no"&.
12639
12640 .vitem &$prvscheck_address$&
12641 This variable is used in conjunction with the &%prvscheck%& expansion item,
12642 which is described in sections &<<SECTexpansionitems>>& and
12643 &<<SECTverifyPRVS>>&.
12644
12645 .vitem &$prvscheck_keynum$&
12646 This variable is used in conjunction with the &%prvscheck%& expansion item,
12647 which is described in sections &<<SECTexpansionitems>>& and
12648 &<<SECTverifyPRVS>>&.
12649
12650 .vitem &$prvscheck_result$&
12651 This variable is used in conjunction with the &%prvscheck%& expansion item,
12652 which is described in sections &<<SECTexpansionitems>>& and
12653 &<<SECTverifyPRVS>>&.
12654
12655 .vitem &$qualify_domain$&
12656 .vindex "&$qualify_domain$&"
12657 The value set for the &%qualify_domain%& option in the configuration file.
12658
12659 .vitem &$qualify_recipient$&
12660 .vindex "&$qualify_recipient$&"
12661 The value set for the &%qualify_recipient%& option in the configuration file,
12662 or if not set, the value of &$qualify_domain$&.
12663
12664 .vitem &$queue_name$&
12665 .vindex &$queue_name$&
12666 .cindex "named queues"
12667 .cindex queues named
12668 The name of the spool queue in use; empty for the default queue.
12669
12670 .vitem &$rcpt_count$&
12671 .vindex "&$rcpt_count$&"
12672 When a message is being received by SMTP, this variable contains the number of
12673 RCPT commands received for the current message. If this variable is used in a
12674 RCPT ACL, its value includes the current command.
12675
12676 .vitem &$rcpt_defer_count$&
12677 .vindex "&$rcpt_defer_count$&"
12678 .cindex "4&'xx'& responses" "count of"
12679 When a message is being received by SMTP, this variable contains the number of
12680 RCPT commands in the current message that have previously been rejected with a
12681 temporary (4&'xx'&) response.
12682
12683 .vitem &$rcpt_fail_count$&
12684 .vindex "&$rcpt_fail_count$&"
12685 When a message is being received by SMTP, this variable contains the number of
12686 RCPT commands in the current message that have previously been rejected with a
12687 permanent (5&'xx'&) response.
12688
12689 .vitem &$received_count$&
12690 .vindex "&$received_count$&"
12691 This variable contains the number of &'Received:'& header lines in the message,
12692 including the one added by Exim (so its value is always greater than zero). It
12693 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12694 delivering.
12695
12696 .vitem &$received_for$&
12697 .vindex "&$received_for$&"
12698 If there is only a single recipient address in an incoming message, this
12699 variable contains that address when the &'Received:'& header line is being
12700 built. The value is copied after recipient rewriting has happened, but before
12701 the &[local_scan()]& function is run.
12702
12703 .vitem &$received_ip_address$&
12704 .vindex "&$received_ip_address$&"
12705 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12706 variable is set to the address of the local IP interface, and &$received_port$&
12707 is set to the local port number. (The remote IP address and port are in
12708 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12709 the port value is -1 unless it has been set using the &%-oMi%& command line
12710 option.
12711
12712 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12713 could be used, for example, to make the file name for a TLS certificate depend
12714 on which interface and/or port is being used for the incoming connection. The
12715 values of &$received_ip_address$& and &$received_port$& are saved with any
12716 messages that are received, thus making these variables available at delivery
12717 time.
12718 For outbound connections see &$sending_ip_address$&.
12719
12720 .vitem &$received_port$&
12721 .vindex "&$received_port$&"
12722 See &$received_ip_address$&.
12723
12724 .vitem &$received_protocol$&
12725 .vindex "&$received_protocol$&"
12726 When a message is being processed, this variable contains the name of the
12727 protocol by which it was received. Most of the names used by Exim are defined
12728 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12729 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12730 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12731 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12732 connection and the client was successfully authenticated.
12733
12734 Exim uses the protocol name &"smtps"& for the case when encryption is
12735 automatically set up on connection without the use of STARTTLS (see
12736 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12737 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12738 where the client initially uses EHLO, sets up an encrypted connection using
12739 STARTTLS, and then uses HELO afterwards.
12740
12741 The &%-oMr%& option provides a way of specifying a custom protocol name for
12742 messages that are injected locally by trusted callers. This is commonly used to
12743 identify messages that are being re-injected after some kind of scanning.
12744
12745 .vitem &$received_time$&
12746 .vindex "&$received_time$&"
12747 This variable contains the date and time when the current message was received,
12748 as a number of seconds since the start of the Unix epoch.
12749
12750 .vitem &$recipient_data$&
12751 .vindex "&$recipient_data$&"
12752 This variable is set after an indexing lookup success in an ACL &%recipients%&
12753 condition. It contains the data from the lookup, and the value remains set
12754 until the next &%recipients%& test. Thus, you can do things like this:
12755 .display
12756 &`require recipients  = cdb*@;/some/file`&
12757 &`deny    `&&'some further test involving'& &`$recipient_data`&
12758 .endd
12759 &*Warning*&: This variable is set only when a lookup is used as an indexing
12760 method in the address list, using the semicolon syntax as in the example above.
12761 The variable is not set for a lookup that is used as part of the string
12762 expansion that all such lists undergo before being interpreted.
12763
12764 .vitem &$recipient_verify_failure$&
12765 .vindex "&$recipient_verify_failure$&"
12766 In an ACL, when a recipient verification fails, this variable contains
12767 information about the failure. It is set to one of the following words:
12768
12769 .ilist
12770 &"qualify"&: The address was unqualified (no domain), and the message
12771 was neither local nor came from an exempted host.
12772
12773 .next
12774 &"route"&: Routing failed.
12775
12776 .next
12777 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12778 or before the MAIL command (that is, on initial connection, HELO, or
12779 MAIL).
12780
12781 .next
12782 &"recipient"&: The RCPT command in a callout was rejected.
12783 .next
12784
12785 &"postmaster"&: The postmaster check in a callout was rejected.
12786 .endlist
12787
12788 The main use of this variable is expected to be to distinguish between
12789 rejections of MAIL and rejections of RCPT.
12790
12791 .vitem &$recipients$&
12792 .vindex "&$recipients$&"
12793 This variable contains a list of envelope recipients for a message. A comma and
12794 a space separate the addresses in the replacement text. However, the variable
12795 is not generally available, to prevent exposure of Bcc recipients in
12796 unprivileged users' filter files. You can use &$recipients$& only in these
12797 cases:
12798
12799 .olist
12800 In a system filter file.
12801 .next
12802 In the ACLs associated with the DATA command and with non-SMTP messages, that
12803 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12804 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12805 &%acl_not_smtp_mime%&.
12806 .next
12807 From within a &[local_scan()]& function.
12808 .endlist
12809
12810
12811 .vitem &$recipients_count$&
12812 .vindex "&$recipients_count$&"
12813 When a message is being processed, this variable contains the number of
12814 envelope recipients that came with the message. Duplicates are not excluded
12815 from the count. While a message is being received over SMTP, the number
12816 increases for each accepted recipient. It can be referenced in an ACL.
12817
12818
12819 .vitem &$regex_match_string$&
12820 .vindex "&$regex_match_string$&"
12821 This variable is set to contain the matching regular expression after a
12822 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12823
12824 .vitem "&$regex1$&, &$regex2$&, etc"
12825 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12826 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12827 these variables contain the
12828 captured substrings identified by the regular expression.
12829
12830
12831 .vitem &$reply_address$&
12832 .vindex "&$reply_address$&"
12833 When a message is being processed, this variable contains the contents of the
12834 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12835 contents of the &'From:'& header line. Apart from the removal of leading
12836 white space, the value is not processed in any way. In particular, no RFC 2047
12837 decoding or character code translation takes place.
12838
12839 .vitem &$return_path$&
12840 .vindex "&$return_path$&"
12841 When a message is being delivered, this variable contains the return path &--
12842 the sender field that will be sent as part of the envelope. It is not enclosed
12843 in <> characters. At the start of routing an address, &$return_path$& has the
12844 same value as &$sender_address$&, but if, for example, an incoming message to a
12845 mailing list has been expanded by a router which specifies a different address
12846 for bounce messages, &$return_path$& subsequently contains the new bounce
12847 address, whereas &$sender_address$& always contains the original sender address
12848 that was received with the message. In other words, &$sender_address$& contains
12849 the incoming envelope sender, and &$return_path$& contains the outgoing
12850 envelope sender.
12851
12852 .vitem &$return_size_limit$&
12853 .vindex "&$return_size_limit$&"
12854 This is an obsolete name for &$bounce_return_size_limit$&.
12855
12856 .vitem &$router_name$&
12857 .cindex "router" "name"
12858 .cindex "name" "of router"
12859 .vindex "&$router_name$&"
12860 During the running of a router this variable contains its name.
12861
12862 .vitem &$runrc$&
12863 .cindex "return code" "from &%run%& expansion"
12864 .vindex "&$runrc$&"
12865 This variable contains the return code from a command that is run by the
12866 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12867 assume the order in which option values are expanded, except for those
12868 preconditions whose order of testing is documented. Therefore, you cannot
12869 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12870 another.
12871
12872 .vitem &$self_hostname$&
12873 .oindex "&%self%&" "value of host name"
12874 .vindex "&$self_hostname$&"
12875 When an address is routed to a supposedly remote host that turns out to be the
12876 local host, what happens is controlled by the &%self%& generic router option.
12877 One of its values causes the address to be passed to another router. When this
12878 happens, &$self_hostname$& is set to the name of the local host that the
12879 original router encountered. In other circumstances its contents are null.
12880
12881 .vitem &$sender_address$&
12882 .vindex "&$sender_address$&"
12883 When a message is being processed, this variable contains the sender's address
12884 that was received in the message's envelope. The case of letters in the address
12885 is retained, in both the local part and the domain. For bounce messages, the
12886 value of this variable is the empty string. See also &$return_path$&.
12887
12888 .vitem &$sender_address_data$&
12889 .vindex "&$address_data$&"
12890 .vindex "&$sender_address_data$&"
12891 If &$address_data$& is set when the routers are called from an ACL to verify a
12892 sender address, the final value is preserved in &$sender_address_data$&, to
12893 distinguish it from data from a recipient address. The value does not persist
12894 after the end of the current ACL statement. If you want to preserve it for
12895 longer, you can save it in an ACL variable.
12896
12897 .vitem &$sender_address_domain$&
12898 .vindex "&$sender_address_domain$&"
12899 The domain portion of &$sender_address$&.
12900
12901 .vitem &$sender_address_local_part$&
12902 .vindex "&$sender_address_local_part$&"
12903 The local part portion of &$sender_address$&.
12904
12905 .vitem &$sender_data$&
12906 .vindex "&$sender_data$&"
12907 This variable is set after a lookup success in an ACL &%senders%& condition or
12908 in a router &%senders%& option. It contains the data from the lookup, and the
12909 value remains set until the next &%senders%& test. Thus, you can do things like
12910 this:
12911 .display
12912 &`require senders      = cdb*@;/some/file`&
12913 &`deny    `&&'some further test involving'& &`$sender_data`&
12914 .endd
12915 &*Warning*&: This variable is set only when a lookup is used as an indexing
12916 method in the address list, using the semicolon syntax as in the example above.
12917 The variable is not set for a lookup that is used as part of the string
12918 expansion that all such lists undergo before being interpreted.
12919
12920 .vitem &$sender_fullhost$&
12921 .vindex "&$sender_fullhost$&"
12922 When a message is received from a remote host, this variable contains the host
12923 name and IP address in a single string. It ends with the IP address in square
12924 brackets, followed by a colon and a port number if the logging of ports is
12925 enabled. The format of the rest of the string depends on whether the host
12926 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12927 looking up its IP address. (Looking up the IP address can be forced by the
12928 &%host_lookup%& option, independent of verification.) A plain host name at the
12929 start of the string is a verified host name; if this is not present,
12930 verification either failed or was not requested. A host name in parentheses is
12931 the argument of a HELO or EHLO command. This is omitted if it is identical to
12932 the verified host name or to the host's IP address in square brackets.
12933
12934 .vitem &$sender_helo_dnssec$&
12935 .vindex "&$sender_helo_dnssec$&"
12936 This boolean variable is true if a successful HELO verification was
12937 .cindex "DNS" "DNSSEC"
12938 done using DNS information the resolver library stated was authenticated data.
12939
12940 .vitem &$sender_helo_name$&
12941 .vindex "&$sender_helo_name$&"
12942 When a message is received from a remote host that has issued a HELO or EHLO
12943 command, the argument of that command is placed in this variable. It is also
12944 set if HELO or EHLO is used when a message is received using SMTP locally via
12945 the &%-bs%& or &%-bS%& options.
12946
12947 .vitem &$sender_host_address$&
12948 .vindex "&$sender_host_address$&"
12949 When a message is received from a remote host using SMTP,
12950 this variable contains that
12951 host's IP address. For locally non-SMTP submitted messages, it is empty.
12952
12953 .vitem &$sender_host_authenticated$&
12954 .vindex "&$sender_host_authenticated$&"
12955 This variable contains the name (not the public name) of the authenticator
12956 driver that successfully authenticated the client from which the message was
12957 received. It is empty if there was no successful authentication. See also
12958 &$authenticated_id$&.
12959
12960 .vitem &$sender_host_dnssec$&
12961 .vindex "&$sender_host_dnssec$&"
12962 If an attempt to populate &$sender_host_name$& has been made
12963 (by reference, &%hosts_lookup%& or
12964 otherwise) then this boolean will have been set true if, and only if, the
12965 resolver library states that both
12966 the reverse and forward DNS were authenticated data.  At all
12967 other times, this variable is false.
12968
12969 .cindex "DNS" "DNSSEC"
12970 It is likely that you will need to coerce DNSSEC support on in the resolver
12971 library, by setting:
12972 .code
12973 dns_dnssec_ok = 1
12974 .endd
12975
12976 Exim does not perform DNSSEC validation itself, instead leaving that to a
12977 validating resolver (e.g. unbound, or bind with suitable configuration).
12978
12979 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12980 mechanism in the list, then this variable will be false.
12981
12982 This requires that your system resolver library support EDNS0 (and that
12983 DNSSEC flags exist in the system headers).  If the resolver silently drops
12984 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12985 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12986
12987
12988 .vitem &$sender_host_name$&
12989 .vindex "&$sender_host_name$&"
12990 When a message is received from a remote host, this variable contains the
12991 host's name as obtained by looking up its IP address. For messages received by
12992 other means, this variable is empty.
12993
12994 .vindex "&$host_lookup_failed$&"
12995 If the host name has not previously been looked up, a reference to
12996 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12997 A looked up name is accepted only if it leads back to the original IP address
12998 via a forward lookup. If either the reverse or the forward lookup fails to find
12999 any data, or if the forward lookup does not yield the original IP address,
13000 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13001
13002 .vindex "&$host_lookup_deferred$&"
13003 However, if either of the lookups cannot be completed (for example, there is a
13004 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13005 &$host_lookup_failed$& remains set to &"0"&.
13006
13007 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13008 host name again if there is a subsequent reference to &$sender_host_name$&
13009 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13010 is set to &"1"&.
13011
13012 Exim does not automatically look up every calling host's name. If you want
13013 maximum efficiency, you should arrange your configuration so that it avoids
13014 these lookups altogether. The lookup happens only if one or more of the
13015 following are true:
13016
13017 .ilist
13018 A string containing &$sender_host_name$& is expanded.
13019 .next
13020 The calling host matches the list in &%host_lookup%&. In the default
13021 configuration, this option is set to *, so it must be changed if lookups are
13022 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13023 .next
13024 Exim needs the host name in order to test an item in a host list. The items
13025 that require this are described in sections &<<SECThoslispatnam>>& and
13026 &<<SECThoslispatnamsk>>&.
13027 .next
13028 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13029 In this case, the host name is required to compare with the name quoted in any
13030 EHLO or HELO commands that the client issues.
13031 .next
13032 The remote host issues a EHLO or HELO command that quotes one of the
13033 domains in &%helo_lookup_domains%&. The default value of this option is
13034 . ==== As this is a nested list, any displays it contains must be indented
13035 . ==== as otherwise they are too far to the left.
13036 .code
13037   helo_lookup_domains = @ : @[]
13038 .endd
13039 which causes a lookup if a remote host (incorrectly) gives the server's name or
13040 IP address in an EHLO or HELO command.
13041 .endlist
13042
13043
13044 .vitem &$sender_host_port$&
13045 .vindex "&$sender_host_port$&"
13046 When a message is received from a remote host, this variable contains the port
13047 number that was used on the remote host.
13048
13049 .vitem &$sender_ident$&
13050 .vindex "&$sender_ident$&"
13051 When a message is received from a remote host, this variable contains the
13052 identification received in response to an RFC 1413 request. When a message has
13053 been received locally, this variable contains the login name of the user that
13054 called Exim.
13055
13056 .vitem &$sender_rate_$&&'xxx'&
13057 A number of variables whose names begin &$sender_rate_$& are set as part of the
13058 &%ratelimit%& ACL condition. Details are given in section
13059 &<<SECTratelimiting>>&.
13060
13061 .vitem &$sender_rcvhost$&
13062 .cindex "DNS" "reverse lookup"
13063 .cindex "reverse DNS lookup"
13064 .vindex "&$sender_rcvhost$&"
13065 This is provided specifically for use in &'Received:'& headers. It starts with
13066 either the verified host name (as obtained from a reverse DNS lookup) or, if
13067 there is no verified host name, the IP address in square brackets. After that
13068 there may be text in parentheses. When the first item is a verified host name,
13069 the first thing in the parentheses is the IP address in square brackets,
13070 followed by a colon and a port number if port logging is enabled. When the
13071 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13072 the parentheses.
13073
13074 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13075 was used and its argument was not identical to the real host name or IP
13076 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13077 all three items are present in the parentheses, a newline and tab are inserted
13078 into the string, to improve the formatting of the &'Received:'& header.
13079
13080 .vitem &$sender_verify_failure$&
13081 .vindex "&$sender_verify_failure$&"
13082 In an ACL, when a sender verification fails, this variable contains information
13083 about the failure. The details are the same as for
13084 &$recipient_verify_failure$&.
13085
13086 .vitem &$sending_ip_address$&
13087 .vindex "&$sending_ip_address$&"
13088 This variable is set whenever an outgoing SMTP connection to another host has
13089 been set up. It contains the IP address of the local interface that is being
13090 used. This is useful if a host that has more than one IP address wants to take
13091 on different personalities depending on which one is being used. For incoming
13092 connections, see &$received_ip_address$&.
13093
13094 .vitem &$sending_port$&
13095 .vindex "&$sending_port$&"
13096 This variable is set whenever an outgoing SMTP connection to another host has
13097 been set up. It contains the local port that is being used. For incoming
13098 connections, see &$received_port$&.
13099
13100 .vitem &$smtp_active_hostname$&
13101 .vindex "&$smtp_active_hostname$&"
13102 During an incoming SMTP session, this variable contains the value of the active
13103 host name, as specified by the &%smtp_active_hostname%& option. The value of
13104 &$smtp_active_hostname$& is saved with any message that is received, so its
13105 value can be consulted during routing and delivery.
13106
13107 .vitem &$smtp_command$&
13108 .vindex "&$smtp_command$&"
13109 During the processing of an incoming SMTP command, this variable contains the
13110 entire command. This makes it possible to distinguish between HELO and EHLO in
13111 the HELO ACL, and also to distinguish between commands such as these:
13112 .code
13113 MAIL FROM:<>
13114 MAIL FROM: <>
13115 .endd
13116 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13117 command, the address in &$smtp_command$& is the original address before any
13118 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13119 the address after SMTP-time rewriting.
13120
13121 .vitem &$smtp_command_argument$&
13122 .cindex "SMTP" "command, argument for"
13123 .vindex "&$smtp_command_argument$&"
13124 While an ACL is running to check an SMTP command, this variable contains the
13125 argument, that is, the text that follows the command name, with leading white
13126 space removed. Following the introduction of &$smtp_command$&, this variable is
13127 somewhat redundant, but is retained for backwards compatibility.
13128
13129 .vitem &$smtp_command_history$&
13130 .cindex SMTP "command history"
13131 .vindex "&$smtp_command_history$&"
13132 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13133 received, in time-order left to right.  Only a limited number of commands
13134 are remembered.
13135
13136 .vitem &$smtp_count_at_connection_start$&
13137 .vindex "&$smtp_count_at_connection_start$&"
13138 This variable is set greater than zero only in processes spawned by the Exim
13139 daemon for handling incoming SMTP connections. The name is deliberately long,
13140 in order to emphasize what the contents are. When the daemon accepts a new
13141 connection, it increments this variable. A copy of the variable is passed to
13142 the child process that handles the connection, but its value is fixed, and
13143 never changes. It is only an approximation of how many incoming connections
13144 there actually are, because many other connections may come and go while a
13145 single connection is being processed. When a child process terminates, the
13146 daemon decrements its copy of the variable.
13147
13148 .vitem "&$sn0$& &-- &$sn9$&"
13149 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13150 that were current at the end of the system filter file. This allows a system
13151 filter file to set values that can be tested in users' filter files. For
13152 example, a system filter could set a value indicating how likely it is that a
13153 message is junk mail.
13154
13155 .vitem &$spam_$&&'xxx'&
13156 A number of variables whose names start with &$spam$& are available when Exim
13157 is compiled with the content-scanning extension. For details, see section
13158 &<<SECTscanspamass>>&.
13159
13160 .vitem &$spf_header_comment$& &&&
13161        &$spf_received$& &&&
13162        &$spf_result$& &&&
13163        &$spf_result_guessed$& &&&
13164        &$spf_smtp_comment$&
13165 These variables are only available if Exim is built with SPF support.
13166 For details see section &<<SECSPF>>&.
13167
13168 .vitem &$spool_directory$&
13169 .vindex "&$spool_directory$&"
13170 The name of Exim's spool directory.
13171
13172 .vitem &$spool_inodes$&
13173 .vindex "&$spool_inodes$&"
13174 The number of free inodes in the disk partition where Exim's spool files are
13175 being written. The value is recalculated whenever the variable is referenced.
13176 If the relevant file system does not have the concept of inodes, the value of
13177 is -1. See also the &%check_spool_inodes%& option.
13178
13179 .vitem &$spool_space$&
13180 .vindex "&$spool_space$&"
13181 The amount of free space (as a number of kilobytes) in the disk partition where
13182 Exim's spool files are being written. The value is recalculated whenever the
13183 variable is referenced. If the operating system does not have the ability to
13184 find the amount of free space (only true for experimental systems), the space
13185 value is -1. For example, to check in an ACL that there is at least 50
13186 megabytes free on the spool, you could write:
13187 .code
13188 condition = ${if > {$spool_space}{50000}}
13189 .endd
13190 See also the &%check_spool_space%& option.
13191
13192
13193 .vitem &$thisaddress$&
13194 .vindex "&$thisaddress$&"
13195 This variable is set only during the processing of the &%foranyaddress%&
13196 command in a filter file. Its use is explained in the description of that
13197 command, which can be found in the separate document entitled &'Exim's
13198 interfaces to mail filtering'&.
13199
13200 .vitem &$tls_in_bits$&
13201 .vindex "&$tls_in_bits$&"
13202 Contains an approximation of the TLS cipher's bit-strength
13203 on the inbound connection; the meaning of
13204 this depends upon the TLS implementation used.
13205 If TLS has not been negotiated, the value will be 0.
13206 The value of this is automatically fed into the Cyrus SASL authenticator
13207 when acting as a server, to specify the "external SSF" (a SASL term).
13208
13209 The deprecated &$tls_bits$& variable refers to the inbound side
13210 except when used in the context of an outbound SMTP delivery, when it refers to
13211 the outbound.
13212
13213 .vitem &$tls_out_bits$&
13214 .vindex "&$tls_out_bits$&"
13215 Contains an approximation of the TLS cipher's bit-strength
13216 on an outbound SMTP connection; the meaning of
13217 this depends upon the TLS implementation used.
13218 If TLS has not been negotiated, the value will be 0.
13219
13220 .vitem &$tls_in_ourcert$&
13221 .vindex "&$tls_in_ourcert$&"
13222 .cindex certificate variables
13223 This variable refers to the certificate presented to the peer of an
13224 inbound connection when the message was received.
13225 It is only useful as the argument of a
13226 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13227 or a &%def%& condition.
13228
13229 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13230 when a list of more than one
13231 file is used for &%tls_certificate%&, this variable is not reliable.
13232
13233 .vitem &$tls_in_peercert$&
13234 .vindex "&$tls_in_peercert$&"
13235 This variable refers to the certificate presented by the peer of an
13236 inbound connection when the message was received.
13237 It is only useful as the argument of a
13238 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13239 or a &%def%& condition.
13240 If certificate verification fails it may refer to a failing chain element
13241 which is not the leaf.
13242
13243 .vitem &$tls_out_ourcert$&
13244 .vindex "&$tls_out_ourcert$&"
13245 This variable refers to the certificate presented to the peer of an
13246 outbound connection.  It is only useful as the argument of a
13247 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13248 or a &%def%& condition.
13249
13250 .vitem &$tls_out_peercert$&
13251 .vindex "&$tls_out_peercert$&"
13252 This variable refers to the certificate presented by the peer of an
13253 outbound connection.  It is only useful as the argument of a
13254 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13255 or a &%def%& condition.
13256 If certificate verification fails it may refer to a failing chain element
13257 which is not the leaf.
13258
13259 .vitem &$tls_in_certificate_verified$&
13260 .vindex "&$tls_in_certificate_verified$&"
13261 This variable is set to &"1"& if a TLS certificate was verified when the
13262 message was received, and &"0"& otherwise.
13263
13264 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13265 except when used in the context of an outbound SMTP delivery, when it refers to
13266 the outbound.
13267
13268 .vitem &$tls_out_certificate_verified$&
13269 .vindex "&$tls_out_certificate_verified$&"
13270 This variable is set to &"1"& if a TLS certificate was verified when an
13271 outbound SMTP connection was made,
13272 and &"0"& otherwise.
13273
13274 .vitem &$tls_in_cipher$&
13275 .vindex "&$tls_in_cipher$&"
13276 .vindex "&$tls_cipher$&"
13277 When a message is received from a remote host over an encrypted SMTP
13278 connection, this variable is set to the cipher suite that was negotiated, for
13279 example DES-CBC3-SHA. In other circumstances, in particular, for message
13280 received over unencrypted connections, the variable is empty. Testing
13281 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13282 non-encrypted connections during ACL processing.
13283
13284 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13285 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13286 becomes the same as &$tls_out_cipher$&.
13287
13288 .vitem &$tls_out_cipher$&
13289 .vindex "&$tls_out_cipher$&"
13290 This variable is
13291 cleared before any outgoing SMTP connection is made,
13292 and then set to the outgoing cipher suite if one is negotiated. See chapter
13293 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13294 details of the &(smtp)& transport.
13295
13296 .vitem &$tls_out_dane$&
13297 .vindex &$tls_out_dane$&
13298 DANE active status.  See section &<<SECDANE>>&.
13299
13300 .vitem &$tls_in_ocsp$&
13301 .vindex "&$tls_in_ocsp$&"
13302 When a message is received from a remote client connection
13303 the result of any OCSP request from the client is encoded in this variable:
13304 .code
13305 0 OCSP proof was not requested (default value)
13306 1 No response to request
13307 2 Response not verified
13308 3 Verification failed
13309 4 Verification succeeded
13310 .endd
13311
13312 .vitem &$tls_out_ocsp$&
13313 .vindex "&$tls_out_ocsp$&"
13314 When a message is sent to a remote host connection
13315 the result of any OCSP request made is encoded in this variable.
13316 See &$tls_in_ocsp$& for values.
13317
13318 .vitem &$tls_in_peerdn$&
13319 .vindex "&$tls_in_peerdn$&"
13320 .vindex "&$tls_peerdn$&"
13321 .cindex certificate "extracting fields"
13322 When a message is received from a remote host over an encrypted SMTP
13323 connection, and Exim is configured to request a certificate from the client,
13324 the value of the Distinguished Name of the certificate is made available in the
13325 &$tls_in_peerdn$& during subsequent processing.
13326 If certificate verification fails it may refer to a failing chain element
13327 which is not the leaf.
13328
13329 The deprecated &$tls_peerdn$& variable refers to the inbound side
13330 except when used in the context of an outbound SMTP delivery, when it refers to
13331 the outbound.
13332
13333 .vitem &$tls_out_peerdn$&
13334 .vindex "&$tls_out_peerdn$&"
13335 When a message is being delivered to a remote host over an encrypted SMTP
13336 connection, and Exim is configured to request a certificate from the server,
13337 the value of the Distinguished Name of the certificate is made available in the
13338 &$tls_out_peerdn$& during subsequent processing.
13339 If certificate verification fails it may refer to a failing chain element
13340 which is not the leaf.
13341
13342 .vitem &$tls_in_sni$&
13343 .vindex "&$tls_in_sni$&"
13344 .vindex "&$tls_sni$&"
13345 .cindex "TLS" "Server Name Indication"
13346 When a TLS session is being established, if the client sends the Server
13347 Name Indication extension, the value will be placed in this variable.
13348 If the variable appears in &%tls_certificate%& then this option and
13349 some others, described in &<<SECTtlssni>>&,
13350 will be re-expanded early in the TLS session, to permit
13351 a different certificate to be presented (and optionally a different key to be
13352 used) to the client, based upon the value of the SNI extension.
13353
13354 The deprecated &$tls_sni$& variable refers to the inbound side
13355 except when used in the context of an outbound SMTP delivery, when it refers to
13356 the outbound.
13357
13358 .vitem &$tls_out_sni$&
13359 .vindex "&$tls_out_sni$&"
13360 .cindex "TLS" "Server Name Indication"
13361 During outbound
13362 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13363 the transport.
13364
13365 .vitem &$tls_out_tlsa_usage$&
13366 .vindex &$tls_out_tlsa_usage$&
13367 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13368
13369 .vitem &$tod_bsdinbox$&
13370 .vindex "&$tod_bsdinbox$&"
13371 The time of day and the date, in the format required for BSD-style mailbox
13372 files, for example: Thu Oct 17 17:14:09 1995.
13373
13374 .vitem &$tod_epoch$&
13375 .vindex "&$tod_epoch$&"
13376 The time and date as a number of seconds since the start of the Unix epoch.
13377
13378 .vitem &$tod_epoch_l$&
13379 .vindex "&$tod_epoch_l$&"
13380 The time and date as a number of microseconds since the start of the Unix epoch.
13381
13382 .vitem &$tod_full$&
13383 .vindex "&$tod_full$&"
13384 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13385 +0100. The timezone is always given as a numerical offset from UTC, with
13386 positive values used for timezones that are ahead (east) of UTC, and negative
13387 values for those that are behind (west).
13388
13389 .vitem &$tod_log$&
13390 .vindex "&$tod_log$&"
13391 The time and date in the format used for writing Exim's log files, for example:
13392 1995-10-12 15:32:29, but without a timezone.
13393
13394 .vitem &$tod_logfile$&
13395 .vindex "&$tod_logfile$&"
13396 This variable contains the date in the format yyyymmdd. This is the format that
13397 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13398 flag.
13399
13400 .vitem &$tod_zone$&
13401 .vindex "&$tod_zone$&"
13402 This variable contains the numerical value of the local timezone, for example:
13403 -0500.
13404
13405 .vitem &$tod_zulu$&
13406 .vindex "&$tod_zulu$&"
13407 This variable contains the UTC date and time in &"Zulu"& format, as specified
13408 by ISO 8601, for example: 20030221154023Z.
13409
13410 .vitem &$transport_name$&
13411 .cindex "transport" "name"
13412 .cindex "name" "of transport"
13413 .vindex "&$transport_name$&"
13414 During the running of a transport, this variable contains its name.
13415
13416 .vitem &$value$&
13417 .vindex "&$value$&"
13418 This variable contains the result of an expansion lookup, extraction operation,
13419 or external command, as described above. It is also used during a
13420 &*reduce*& expansion.
13421
13422 .vitem &$verify_mode$&
13423 .vindex "&$verify_mode$&"
13424 While a router or transport is being run in verify mode or for cutthrough delivery,
13425 contains "S" for sender-verification or "R" for recipient-verification.
13426 Otherwise, empty.
13427
13428 .vitem &$version_number$&
13429 .vindex "&$version_number$&"
13430 The version number of Exim.
13431
13432 .vitem &$warn_message_delay$&
13433 .vindex "&$warn_message_delay$&"
13434 This variable is set only during the creation of a message warning about a
13435 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13436
13437 .vitem &$warn_message_recipients$&
13438 .vindex "&$warn_message_recipients$&"
13439 This variable is set only during the creation of a message warning about a
13440 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13441 .endlist
13442 .ecindex IIDstrexp
13443
13444
13445
13446 . ////////////////////////////////////////////////////////////////////////////
13447 . ////////////////////////////////////////////////////////////////////////////
13448
13449 .chapter "Embedded Perl" "CHAPperl"
13450 .scindex IIDperl "Perl" "calling from Exim"
13451 Exim can be built to include an embedded Perl interpreter. When this is done,
13452 Perl subroutines can be called as part of the string expansion process. To make
13453 use of the Perl support, you need version 5.004 or later of Perl installed on
13454 your system. To include the embedded interpreter in the Exim binary, include
13455 the line
13456 .code
13457 EXIM_PERL = perl.o
13458 .endd
13459 in your &_Local/Makefile_& and then build Exim in the normal way.
13460
13461
13462 .section "Setting up so Perl can be used" "SECID85"
13463 .oindex "&%perl_startup%&"
13464 Access to Perl subroutines is via a global configuration option called
13465 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13466 no &%perl_startup%& option in the Exim configuration file then no Perl
13467 interpreter is started and there is almost no overhead for Exim (since none of
13468 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13469 option then the associated value is taken to be Perl code which is executed in
13470 a newly created Perl interpreter.
13471
13472 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13473 need backslashes before any characters to escape special meanings. The option
13474 should usually be something like
13475 .code
13476 perl_startup = do '/etc/exim.pl'
13477 .endd
13478 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13479 use from Exim. Exim can be configured either to start up a Perl interpreter as
13480 soon as it is entered, or to wait until the first time it is needed. Starting
13481 the interpreter at the beginning ensures that it is done while Exim still has
13482 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13483 fact used in a particular run. Also, note that this does not mean that Exim is
13484 necessarily running as root when Perl is called at a later time. By default,
13485 the interpreter is started only when it is needed, but this can be changed in
13486 two ways:
13487
13488 .ilist
13489 .oindex "&%perl_at_start%&"
13490 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13491 a startup when Exim is entered.
13492 .next
13493 The command line option &%-ps%& also requests a startup when Exim is entered,
13494 overriding the setting of &%perl_at_start%&.
13495 .endlist
13496
13497 There is also a command line option &%-pd%& (for delay) which suppresses the
13498 initial startup, even if &%perl_at_start%& is set.
13499
13500 .ilist
13501 .oindex "&%perl_taintmode%&"
13502 .cindex "Perl" "taintmode"
13503 To provide more security executing Perl code via the embedded Perl
13504 interpreter, the &%perl_taintmode%& option can be set. This enables the
13505 taint mode of the Perl interpreter. You are encouraged to set this
13506 option to a true value. To avoid breaking existing installations, it
13507 defaults to false.
13508
13509
13510 .section "Calling Perl subroutines" "SECID86"
13511 When the configuration file includes a &%perl_startup%& option you can make use
13512 of the string expansion item to call the Perl subroutines that are defined
13513 by the &%perl_startup%& code. The operator is used in any of the following
13514 forms:
13515 .code
13516 ${perl{foo}}
13517 ${perl{foo}{argument}}
13518 ${perl{foo}{argument1}{argument2} ... }
13519 .endd
13520 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13521 arguments may be passed. Passing more than this results in an expansion failure
13522 with an error message of the form
13523 .code
13524 Too many arguments passed to Perl subroutine "foo" (max is 8)
13525 .endd
13526 The return value of the Perl subroutine is evaluated in a scalar context before
13527 it is passed back to Exim to be inserted into the expanded string. If the
13528 return value is &'undef'&, the expansion is forced to fail in the same way as
13529 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13530 by obeying Perl's &%die%& function, the expansion fails with the error message
13531 that was passed to &%die%&.
13532
13533
13534 .section "Calling Exim functions from Perl" "SECID87"
13535 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13536 is available to call back into Exim's string expansion function. For example,
13537 the Perl code
13538 .code
13539 my $lp = Exim::expand_string('$local_part');
13540 .endd
13541 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13542 Note those are single quotes and not double quotes to protect against
13543 &$local_part$& being interpolated as a Perl variable.
13544
13545 If the string expansion is forced to fail by a &"fail"& item, the result of
13546 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13547 expansion string, the Perl call from the original expansion string fails with
13548 an appropriate error message, in the same way as if &%die%& were used.
13549
13550 .cindex "debugging" "from embedded Perl"
13551 .cindex "log" "writing from embedded Perl"
13552 Two other Exim functions are available for use from within Perl code.
13553 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13554 debugging is enabled. If you want a newline at the end, you must supply it.
13555 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13556 timestamp. In this case, you should not supply a terminating newline.
13557
13558
13559 .section "Use of standard output and error by Perl" "SECID88"
13560 .cindex "Perl" "standard output and error"
13561 You should not write to the standard error or output streams from within your
13562 Perl code, as it is not defined how these are set up. In versions of Exim
13563 before 4.50, it is possible for the standard output or error to refer to the
13564 SMTP connection during message reception via the daemon. Writing to this stream
13565 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13566 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13567 avoided, but the output is lost.
13568
13569 .cindex "Perl" "use of &%warn%&"
13570 The Perl &%warn%& statement writes to the standard error stream by default.
13571 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13572 you have no control. When Exim starts up the Perl interpreter, it arranges for
13573 output from the &%warn%& statement to be written to the Exim main log. You can
13574 change this by including appropriate Perl magic somewhere in your Perl code.
13575 For example, to discard &%warn%& output completely, you need this:
13576 .code
13577 $SIG{__WARN__} = sub { };
13578 .endd
13579 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13580 example, the code for the subroutine is empty, so it does nothing, but you can
13581 include any Perl code that you like. The text of the &%warn%& message is passed
13582 as the first subroutine argument.
13583 .ecindex IIDperl
13584
13585
13586 . ////////////////////////////////////////////////////////////////////////////
13587 . ////////////////////////////////////////////////////////////////////////////
13588
13589 .chapter "Starting the daemon and the use of network interfaces" &&&
13590          "CHAPinterfaces" &&&
13591          "Starting the daemon"
13592 .cindex "daemon" "starting"
13593 .cindex "interface" "listening"
13594 .cindex "network interface"
13595 .cindex "interface" "network"
13596 .cindex "IP address" "for listening"
13597 .cindex "daemon" "listening IP addresses"
13598 .cindex "TCP/IP" "setting listening interfaces"
13599 .cindex "TCP/IP" "setting listening ports"
13600 A host that is connected to a TCP/IP network may have one or more physical
13601 hardware network interfaces. Each of these interfaces may be configured as one
13602 or more &"logical"& interfaces, which are the entities that a program actually
13603 works with. Each of these logical interfaces is associated with an IP address.
13604 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13605 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13606 knowledge about the host's interfaces for use in three different circumstances:
13607
13608 .olist
13609 When a listening daemon is started, Exim needs to know which interfaces
13610 and ports to listen on.
13611 .next
13612 When Exim is routing an address, it needs to know which IP addresses
13613 are associated with local interfaces. This is required for the correct
13614 processing of MX lists by removing the local host and others with the
13615 same or higher priority values. Also, Exim needs to detect cases
13616 when an address is routed to an IP address that in fact belongs to the
13617 local host. Unless the &%self%& router option or the &%allow_localhost%&
13618 option of the smtp transport is set (as appropriate), this is treated
13619 as an error situation.
13620 .next
13621 When Exim connects to a remote host, it may need to know which interface to use
13622 for the outgoing connection.
13623 .endlist
13624
13625
13626 Exim's default behaviour is likely to be appropriate in the vast majority
13627 of cases. If your host has only one interface, and you want all its IP
13628 addresses to be treated in the same way, and you are using only the
13629 standard SMTP port, you should not need to take any special action. The
13630 rest of this chapter does not apply to you.
13631
13632 In a more complicated situation you may want to listen only on certain
13633 interfaces, or on different ports, and for this reason there are a number of
13634 options that can be used to influence Exim's behaviour. The rest of this
13635 chapter describes how they operate.
13636
13637 When a message is received over TCP/IP, the interface and port that were
13638 actually used are set in &$received_ip_address$& and &$received_port$&.
13639
13640
13641
13642 .section "Starting a listening daemon" "SECID89"
13643 When a listening daemon is started (by means of the &%-bd%& command line
13644 option), the interfaces and ports on which it listens are controlled by the
13645 following options:
13646
13647 .ilist
13648 &%daemon_smtp_ports%& contains a list of default ports
13649 or service names.
13650 (For backward compatibility, this option can also be specified in the singular.)
13651 .next
13652 &%local_interfaces%& contains list of interface IP addresses on which to
13653 listen. Each item may optionally also specify a port.
13654 .endlist
13655
13656 The default list separator in both cases is a colon, but this can be changed as
13657 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13658 it is usually best to change the separator to avoid having to double all the
13659 colons. For example:
13660 .code
13661 local_interfaces = <; 127.0.0.1 ; \
13662                       192.168.23.65 ; \
13663                       ::1 ; \
13664                       3ffe:ffff:836f::fe86:a061
13665 .endd
13666 There are two different formats for specifying a port along with an IP address
13667 in &%local_interfaces%&:
13668
13669 .olist
13670 The port is added onto the address with a dot separator. For example, to listen
13671 on port 1234 on two different IP addresses:
13672 .code
13673 local_interfaces = <; 192.168.23.65.1234 ; \
13674                       3ffe:ffff:836f::fe86:a061.1234
13675 .endd
13676 .next
13677 The IP address is enclosed in square brackets, and the port is added
13678 with a colon separator, for example:
13679 .code
13680 local_interfaces = <; [192.168.23.65]:1234 ; \
13681                       [3ffe:ffff:836f::fe86:a061]:1234
13682 .endd
13683 .endlist
13684
13685 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13686 default setting contains just one port:
13687 .code
13688 daemon_smtp_ports = smtp
13689 .endd
13690 If more than one port is listed, each interface that does not have its own port
13691 specified listens on all of them. Ports that are listed in
13692 &%daemon_smtp_ports%& can be identified either by name (defined in
13693 &_/etc/services_&) or by number. However, when ports are given with individual
13694 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13695
13696
13697
13698 .section "Special IP listening addresses" "SECID90"
13699 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13700 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13701 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13702 instead of setting up separate listening sockets for each interface. The
13703 default value of &%local_interfaces%& is
13704 .code
13705 local_interfaces = 0.0.0.0
13706 .endd
13707 when Exim is built without IPv6 support; otherwise it is:
13708 .code
13709 local_interfaces = <; ::0 ; 0.0.0.0
13710 .endd
13711 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13712
13713
13714
13715 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13716 The &%-oX%& command line option can be used to override the values of
13717 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13718 instance. Another way of doing this would be to use macros and the &%-D%&
13719 option. However, &%-oX%& can be used by any admin user, whereas modification of
13720 the runtime configuration by &%-D%& is allowed only when the caller is root or
13721 exim.
13722
13723 The value of &%-oX%& is a list of items. The default colon separator can be
13724 changed in the usual way if required. If there are any items that do not
13725 contain dots or colons (that is, are not IP addresses), the value of
13726 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13727 items that do contain dots or colons, the value of &%local_interfaces%& is
13728 replaced by those items. Thus, for example,
13729 .code
13730 -oX 1225
13731 .endd
13732 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13733 whereas
13734 .code
13735 -oX 192.168.34.5.1125
13736 .endd
13737 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13738 (However, since &%local_interfaces%& now contains no items without ports, the
13739 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13740
13741
13742
13743 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13744 .cindex "submissions protocol"
13745 .cindex "ssmtp protocol"
13746 .cindex "smtps protocol"
13747 .cindex "SMTP" "ssmtp protocol"
13748 .cindex "SMTP" "smtps protocol"
13749 Exim supports the use of TLS-on-connect, used by mail clients in the
13750 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13751 For some years, IETF Standards Track documents only blessed the
13752 STARTTLS-based Submission service (port 587) while common practice was to support
13753 the same feature set on port 465, but using TLS-on-connect.
13754 If your installation needs to provide service to mail clients
13755 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13756 the 465 TCP ports.
13757
13758 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13759 service names, connections to those ports must first establish TLS, before
13760 proceeding to the application layer use of the SMTP protocol.
13761
13762 The common use of this option is expected to be
13763 .code
13764 tls_on_connect_ports = 465
13765 .endd
13766 per RFC 8314.
13767 There is also a command line option &%-tls-on-connect%&, which forces all ports
13768 to behave in this way when a daemon is started.
13769
13770 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13771 daemon to listen on those ports. You must still specify them in
13772 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13773 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13774 connections via the daemon.)
13775
13776
13777
13778
13779 .section "IPv6 address scopes" "SECID92"
13780 .cindex "IPv6" "address scopes"
13781 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13782 can, in principle, have the same link-local IPv6 address on different
13783 interfaces. Thus, additional information is needed, over and above the IP
13784 address, to distinguish individual interfaces. A convention of using a
13785 percent sign followed by something (often the interface name) has been
13786 adopted in some cases, leading to addresses like this:
13787 .code
13788 fe80::202:b3ff:fe03:45c1%eth0
13789 .endd
13790 To accommodate this usage, a percent sign followed by an arbitrary string is
13791 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13792 to convert a textual IPv6 address for actual use. This function recognizes the
13793 percent convention in operating systems that support it, and it processes the
13794 address appropriately. Unfortunately, some older libraries have problems with
13795 &[getaddrinfo()]&. If
13796 .code
13797 IPV6_USE_INET_PTON=yes
13798 .endd
13799 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13800 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13801 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13802 function.) Of course, this means that the additional functionality of
13803 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13804
13805 .section "Disabling IPv6" "SECID93"
13806 .cindex "IPv6" "disabling"
13807 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13808 run on a host whose kernel does not support IPv6. The binary will fall back to
13809 using IPv4, but it may waste resources looking up AAAA records, and trying to
13810 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13811 .oindex "&%disable_ipv6%&"
13812 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13813 activities take place. AAAA records are never looked up, and any IPv6 addresses
13814 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13815 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13816 to handle IPv6 literal addresses.
13817
13818 On the other hand, when IPv6 is in use, there may be times when you want to
13819 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13820 option to globally suppress the lookup of AAAA records for specified domains,
13821 and you can use the &%ignore_target_hosts%& generic router option to ignore
13822 IPv6 addresses in an individual router.
13823
13824
13825
13826 .section "Examples of starting a listening daemon" "SECID94"
13827 The default case in an IPv6 environment is
13828 .code
13829 daemon_smtp_ports = smtp
13830 local_interfaces = <; ::0 ; 0.0.0.0
13831 .endd
13832 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13833 Either one or two sockets may be used, depending on the characteristics of
13834 the TCP/IP stack. (This is complicated and messy; for more information,
13835 read the comments in the &_daemon.c_& source file.)
13836
13837 To specify listening on ports 25 and 26 on all interfaces:
13838 .code
13839 daemon_smtp_ports = 25 : 26
13840 .endd
13841 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13842 .code
13843 local_interfaces = <; ::0.25     ; ::0.26 \
13844                       0.0.0.0.25 ; 0.0.0.0.26
13845 .endd
13846 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13847 IPv4 loopback address only:
13848 .code
13849 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13850 .endd
13851 To specify listening on the default port on specific interfaces only:
13852 .code
13853 local_interfaces = 10.0.0.67 : 192.168.34.67
13854 .endd
13855 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13856
13857
13858
13859 .section "Recognizing the local host" "SECTreclocipadd"
13860 The &%local_interfaces%& option is also used when Exim needs to determine
13861 whether or not an IP address refers to the local host. That is, the IP
13862 addresses of all the interfaces on which a daemon is listening are always
13863 treated as local.
13864
13865 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13866 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13867 available interfaces from the operating system, and extracts the relevant
13868 (that is, IPv4 or IPv6) addresses to use for checking.
13869
13870 Some systems set up large numbers of virtual interfaces in order to provide
13871 many virtual web servers. In this situation, you may want to listen for
13872 email on only a few of the available interfaces, but nevertheless treat all
13873 interfaces as local when routing. You can do this by setting
13874 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13875 &"all"& wildcard values. These addresses are recognized as local, but are not
13876 used for listening. Consider this example:
13877 .code
13878 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13879                       192.168.53.235 ; \
13880                       3ffe:2101:12:1:a00:20ff:fe86:a061
13881
13882 extra_local_interfaces = <; ::0 ; 0.0.0.0
13883 .endd
13884 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13885 address, but all available interface addresses are treated as local when
13886 Exim is routing.
13887
13888 In some environments the local host name may be in an MX list, but with an IP
13889 address that is not assigned to any local interface. In other cases it may be
13890 desirable to treat other host names as if they referred to the local host. Both
13891 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13892 This contains host names rather than IP addresses. When a host is referenced
13893 during routing, either via an MX record or directly, it is treated as the local
13894 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13895 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13896
13897
13898
13899 .section "Delivering to a remote host" "SECID95"
13900 Delivery to a remote host is handled by the smtp transport. By default, it
13901 allows the system's TCP/IP functions to choose which interface to use (if
13902 there is more than one) when connecting to a remote host. However, the
13903 &%interface%& option can be set to specify which interface is used. See the
13904 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13905 details.
13906
13907
13908
13909
13910 . ////////////////////////////////////////////////////////////////////////////
13911 . ////////////////////////////////////////////////////////////////////////////
13912
13913 .chapter "Main configuration" "CHAPmainconfig"
13914 .scindex IIDconfima "configuration file" "main section"
13915 .scindex IIDmaiconf "main configuration"
13916 The first part of the run time configuration file contains three types of item:
13917
13918 .ilist
13919 Macro definitions: These lines start with an upper case letter. See section
13920 &<<SECTmacrodefs>>& for details of macro processing.
13921 .next
13922 Named list definitions: These lines start with one of the words &"domainlist"&,
13923 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13924 section &<<SECTnamedlists>>&.
13925 .next
13926 Main configuration settings: Each setting occupies one line of the file
13927 (with possible continuations). If any setting is preceded by the word
13928 &"hide"&, the &%-bP%& command line option displays its value to admin users
13929 only. See section &<<SECTcos>>& for a description of the syntax of these option
13930 settings.
13931 .endlist
13932
13933 This chapter specifies all the main configuration options, along with their
13934 types and default values. For ease of finding a particular option, they appear
13935 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13936 are now so many options, they are first listed briefly in functional groups, as
13937 an aid to finding the name of the option you are looking for. Some options are
13938 listed in more than one group.
13939
13940 .section "Miscellaneous" "SECID96"
13941 .table2
13942 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13943 .row &%debug_store%&                 "do extra internal checks"
13944 .row &%disable_ipv6%&                "do no IPv6 processing"
13945 .row &%keep_malformed%&              "for broken files &-- should not happen"
13946 .row &%localhost_number%&            "for unique message ids in clusters"
13947 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13948 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13949 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13950 .row &%print_topbitchars%&           "top-bit characters are printing"
13951 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
13952 .row &%timezone%&                    "force time zone"
13953 .endtable
13954
13955
13956 .section "Exim parameters" "SECID97"
13957 .table2
13958 .row &%exim_group%&                  "override compiled-in value"
13959 .row &%exim_path%&                   "override compiled-in value"
13960 .row &%exim_user%&                   "override compiled-in value"
13961 .row &%primary_hostname%&            "default from &[uname()]&"
13962 .row &%split_spool_directory%&       "use multiple directories"
13963 .row &%spool_directory%&             "override compiled-in value"
13964 .endtable
13965
13966
13967
13968 .section "Privilege controls" "SECID98"
13969 .table2
13970 .row &%admin_groups%&                "groups that are Exim admin users"
13971 .row &%commandline_checks_require_admin%& "require admin for various checks"
13972 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13973 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13974 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13975 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13976 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13977 .row &%never_users%&                 "do not run deliveries as these"
13978 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13979 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13980 .row &%trusted_groups%&              "groups that are trusted"
13981 .row &%trusted_users%&               "users that are trusted"
13982 .endtable
13983
13984
13985
13986 .section "Logging" "SECID99"
13987 .table2
13988 .row &%event_action%&                "custom logging"
13989 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13990 .row &%log_file_path%&               "override compiled-in value"
13991 .row &%log_selector%&                "set/unset optional logging"
13992 .row &%log_timezone%&                "add timezone to log lines"
13993 .row &%message_logs%&                "create per-message logs"
13994 .row &%preserve_message_logs%&       "after message completion"
13995 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13996 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13997 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13998 .row &%syslog_facility%&             "set syslog &""facility""& field"
13999 .row &%syslog_pid%&                  "pid in syslog lines"
14000 .row &%syslog_processname%&          "set syslog &""ident""& field"
14001 .row &%syslog_timestamp%&            "timestamp syslog lines"
14002 .row &%write_rejectlog%&             "control use of message log"
14003 .endtable
14004
14005
14006
14007 .section "Frozen messages" "SECID100"
14008 .table2
14009 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14010 .row &%freeze_tell%&                 "send message when freezing"
14011 .row &%move_frozen_messages%&        "to another directory"
14012 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14013 .endtable
14014
14015
14016
14017 .section "Data lookups" "SECID101"
14018 .table2
14019 .row &%ibase_servers%&               "InterBase servers"
14020 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14021 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14022 .row &%ldap_cert_file%&              "client cert file for LDAP"
14023 .row &%ldap_cert_key%&               "client key file for LDAP"
14024 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14025 .row &%ldap_default_servers%&        "used if no server in query"
14026 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14027 .row &%ldap_start_tls%&              "require TLS within LDAP"
14028 .row &%ldap_version%&                "set protocol version"
14029 .row &%lookup_open_max%&             "lookup files held open"
14030 .row &%mysql_servers%&               "default MySQL servers"
14031 .row &%oracle_servers%&              "Oracle servers"
14032 .row &%pgsql_servers%&               "default PostgreSQL servers"
14033 .row &%sqlite_lock_timeout%&         "as it says"
14034 .endtable
14035
14036
14037
14038 .section "Message ids" "SECID102"
14039 .table2
14040 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14041 .row &%message_id_header_text%&      "ditto"
14042 .endtable
14043
14044
14045
14046 .section "Embedded Perl Startup" "SECID103"
14047 .table2
14048 .row &%perl_at_start%&               "always start the interpreter"
14049 .row &%perl_startup%&                "code to obey when starting Perl"
14050 .row &%perl_taintmode%&              "enable taint mode in Perl"
14051 .endtable
14052
14053
14054
14055 .section "Daemon" "SECID104"
14056 .table2
14057 .row &%daemon_smtp_ports%&           "default ports"
14058 .row &%daemon_startup_retries%&      "number of times to retry"
14059 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14060 .row &%extra_local_interfaces%&      "not necessarily listened on"
14061 .row &%local_interfaces%&            "on which to listen, with optional ports"
14062 .row &%pid_file_path%&               "override compiled-in value"
14063 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14064 .endtable
14065
14066
14067
14068 .section "Resource control" "SECID105"
14069 .table2
14070 .row &%check_log_inodes%&            "before accepting a message"
14071 .row &%check_log_space%&             "before accepting a message"
14072 .row &%check_spool_inodes%&          "before accepting a message"
14073 .row &%check_spool_space%&           "before accepting a message"
14074 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14075 .row &%queue_only_load%&             "queue incoming if load high"
14076 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14077 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14078 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14079 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14080 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14081 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14082 .row &%smtp_accept_max_per_connection%& "messages per connection"
14083 .row &%smtp_accept_max_per_host%&    "connections from one host"
14084 .row &%smtp_accept_queue%&           "queue mail if more connections"
14085 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14086                                            connection"
14087 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14088 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14089 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14090 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14091 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14092 .endtable
14093
14094
14095
14096 .section "Policy controls" "SECID106"
14097 .table2
14098 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14099 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14100 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14101 .row &%acl_smtp_auth%&               "ACL for AUTH"
14102 .row &%acl_smtp_connect%&            "ACL for connection"
14103 .row &%acl_smtp_data%&               "ACL for DATA"
14104 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14105 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14106 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14107 .row &%acl_smtp_expn%&               "ACL for EXPN"
14108 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14109 .row &%acl_smtp_mail%&               "ACL for MAIL"
14110 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14111 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14112 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14113 .row &%acl_smtp_predata%&            "ACL for start of data"
14114 .row &%acl_smtp_quit%&               "ACL for QUIT"
14115 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14116 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14117 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14118 .row &%av_scanner%&                  "specify virus scanner"
14119 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14120                                       words""&"
14121 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14122 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14123 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14124 .row &%header_maxsize%&              "total size of message header"
14125 .row &%header_line_maxsize%&         "individual header line limit"
14126 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14127 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14128 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14129 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14130 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14131 .row &%host_lookup%&                 "host name looked up for these hosts"
14132 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14133 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14134 .row &%host_reject_connection%&      "reject connection from these hosts"
14135 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14136 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14137 .row &%message_size_limit%&          "for all messages"
14138 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14139 .row &%spamd_address%&               "set interface to SpamAssassin"
14140 .row &%strict_acl_vars%&             "object to unset ACL variables"
14141 .endtable
14142
14143
14144
14145 .section "Callout cache" "SECID107"
14146 .table2
14147 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14148                                          item"
14149 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14150                                          item"
14151 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14152 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14153 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14154 .endtable
14155
14156
14157
14158 .section "TLS" "SECID108"
14159 .table2
14160 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14161 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14162 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14163 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14164 .row &%tls_certificate%&             "location of server certificate"
14165 .row &%tls_crl%&                     "certificate revocation list"
14166 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14167 .row &%tls_dhparam%&                 "DH parameters for server"
14168 .row &%tls_eccurve%&                 "EC curve selection for server"
14169 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14170 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14171 .row &%tls_privatekey%&              "location of server private key"
14172 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14173 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14174 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14175 .row &%tls_verify_certificates%&     "expected client certificates"
14176 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14177 .endtable
14178
14179
14180
14181 .section "Local user handling" "SECID109"
14182 .table2
14183 .row &%finduser_retries%&            "useful in NIS environments"
14184 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14185 .row &%gecos_pattern%&               "ditto"
14186 .row &%max_username_length%&         "for systems that truncate"
14187 .row &%unknown_login%&               "used when no login name found"
14188 .row &%unknown_username%&            "ditto"
14189 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14190 .row &%uucp_from_sender%&            "ditto"
14191 .endtable
14192
14193
14194
14195 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14196 .table2
14197 .row &%header_maxsize%&              "total size of message header"
14198 .row &%header_line_maxsize%&         "individual header line limit"
14199 .row &%message_size_limit%&          "applies to all messages"
14200 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14201 .row &%received_header_text%&        "expanded to make &'Received:'&"
14202 .row &%received_headers_max%&        "for mail loop detection"
14203 .row &%recipients_max%&              "limit per message"
14204 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14205 .endtable
14206
14207
14208
14209
14210 .section "Non-SMTP incoming messages" "SECID111"
14211 .table2
14212 .row &%receive_timeout%&             "for non-SMTP messages"
14213 .endtable
14214
14215
14216
14217
14218
14219 .section "Incoming SMTP messages" "SECID112"
14220 See also the &'Policy controls'& section above.
14221
14222 .table2
14223 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
14224 .row &%host_lookup%&                 "host name looked up for these hosts"
14225 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14226 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14227 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14228 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14229 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14230 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14231 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14232 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14233 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14234 .row &%smtp_accept_max_per_connection%& "messages per connection"
14235 .row &%smtp_accept_max_per_host%&    "connections from one host"
14236 .row &%smtp_accept_queue%&           "queue mail if more connections"
14237 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14238                                            connection"
14239 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14240 .row &%smtp_active_hostname%&        "host name to use in messages"
14241 .row &%smtp_banner%&                 "text for welcome banner"
14242 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14243 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14244 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14245 .row &%smtp_etrn_command%&           "what to run for ETRN"
14246 .row &%smtp_etrn_serialize%&         "only one at once"
14247 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14248 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14249 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14250 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14251 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14252 .row &%smtp_receive_timeout%&        "per command or data line"
14253 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14254 .row &%smtp_return_error_details%&   "give detail on rejections"
14255 .endtable
14256
14257
14258
14259 .section "SMTP extensions" "SECID113"
14260 .table2
14261 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14262 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14263 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14264 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14265 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14266 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14267 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14268 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14269 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14270 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14271 .endtable
14272
14273
14274
14275 .section "Processing messages" "SECID114"
14276 .table2
14277 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14278 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14279 .row &%allow_utf8_domains%&          "in addresses"
14280 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14281                                       words""&"
14282 .row &%delivery_date_remove%&        "from incoming messages"
14283 .row &%envelope_to_remove%&          "from incoming messages"
14284 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14285 .row &%headers_charset%&             "default for translations"
14286 .row &%qualify_domain%&              "default for senders"
14287 .row &%qualify_recipient%&           "default for recipients"
14288 .row &%return_path_remove%&          "from incoming messages"
14289 .row &%strip_excess_angle_brackets%& "in addresses"
14290 .row &%strip_trailing_dot%&          "at end of addresses"
14291 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14292 .endtable
14293
14294
14295
14296 .section "System filter" "SECID115"
14297 .table2
14298 .row &%system_filter%&               "locate system filter"
14299 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14300                                             directory"
14301 .row &%system_filter_file_transport%& "transport for delivery to a file"
14302 .row &%system_filter_group%&         "group for filter running"
14303 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14304 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14305 .row &%system_filter_user%&          "user for filter running"
14306 .endtable
14307
14308
14309
14310 .section "Routing and delivery" "SECID116"
14311 .table2
14312 .row &%disable_ipv6%&                "do no IPv6 processing"
14313 .row &%dns_again_means_nonexist%&    "for broken domains"
14314 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14315 .row &%dns_dnssec_ok%&               "parameter for resolver"
14316 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14317 .row &%dns_retrans%&                 "parameter for resolver"
14318 .row &%dns_retry%&                   "parameter for resolver"
14319 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14320 .row &%dns_use_edns0%&               "parameter for resolver"
14321 .row &%hold_domains%&                "hold delivery for these domains"
14322 .row &%local_interfaces%&            "for routing checks"
14323 .row &%queue_domains%&               "no immediate delivery for these"
14324 .row &%queue_only%&                  "no immediate delivery at all"
14325 .row &%queue_only_file%&             "no immediate delivery if file exists"
14326 .row &%queue_only_load%&             "no immediate delivery if load is high"
14327 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14328 .row &%queue_only_override%&         "allow command line to override"
14329 .row &%queue_run_in_order%&          "order of arrival"
14330 .row &%queue_run_max%&               "of simultaneous queue runners"
14331 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14332 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14333 .row &%remote_sort_domains%&         "order of remote deliveries"
14334 .row &%retry_data_expire%&           "timeout for retry data"
14335 .row &%retry_interval_max%&          "safety net for retry rules"
14336 .endtable
14337
14338
14339
14340 .section "Bounce and warning messages" "SECID117"
14341 .table2
14342 .row &%bounce_message_file%&         "content of bounce"
14343 .row &%bounce_message_text%&         "content of bounce"
14344 .row &%bounce_return_body%&          "include body if returning message"
14345 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14346 .row &%bounce_return_message%&       "include original message in bounce"
14347 .row &%bounce_return_size_limit%&    "limit on returned message"
14348 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14349 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14350 .row &%errors_copy%&                 "copy bounce messages"
14351 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14352 .row &%delay_warning%&               "time schedule"
14353 .row &%delay_warning_condition%&     "condition for warning messages"
14354 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14355 .row &%smtp_return_error_details%&   "give detail on rejections"
14356 .row &%warn_message_file%&           "content of warning message"
14357 .endtable
14358
14359
14360
14361 .section "Alphabetical list of main options" "SECTalomo"
14362 Those options that undergo string expansion before use are marked with
14363 &dagger;.
14364
14365 .option accept_8bitmime main boolean true
14366 .cindex "8BITMIME"
14367 .cindex "8-bit characters"
14368 .cindex "log" "selectors"
14369 .cindex "log" "8BITMIME"
14370 This option causes Exim to send 8BITMIME in its response to an SMTP
14371 EHLO command, and to accept the BODY= parameter on MAIL commands.
14372 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14373 takes no steps to do anything special with messages received by this route.
14374
14375 Historically Exim kept this option off by default, but the maintainers
14376 feel that in today's Internet, this causes more problems than it solves.
14377 It now defaults to true.
14378 A more detailed analysis of the issues is provided by Dan Bernstein:
14379 .display
14380 &url(https://cr.yp.to/smtp/8bitmime.html)
14381 .endd
14382
14383 To log received 8BITMIME status use
14384 .code
14385 log_selector = +8bitmime
14386 .endd
14387
14388 .option acl_not_smtp main string&!! unset
14389 .cindex "&ACL;" "for non-SMTP messages"
14390 .cindex "non-SMTP messages" "ACLs for"
14391 This option defines the ACL that is run when a non-SMTP message has been
14392 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14393 further details.
14394
14395 .option acl_not_smtp_mime main string&!! unset
14396 This option defines the ACL that is run for individual MIME parts of non-SMTP
14397 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14398 SMTP messages.
14399
14400 .option acl_not_smtp_start main string&!! unset
14401 .cindex "&ACL;" "at start of non-SMTP message"
14402 .cindex "non-SMTP messages" "ACLs for"
14403 This option defines the ACL that is run before Exim starts reading a
14404 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14405
14406 .option acl_smtp_auth main string&!! unset
14407 .cindex "&ACL;" "setting up for SMTP commands"
14408 .cindex "AUTH" "ACL for"
14409 This option defines the ACL that is run when an SMTP AUTH command is
14410 received. See chapter &<<CHAPACL>>& for further details.
14411
14412 .option acl_smtp_connect main string&!! unset
14413 .cindex "&ACL;" "on SMTP connection"
14414 This option defines the ACL that is run when an SMTP connection is received.
14415 See chapter &<<CHAPACL>>& for further details.
14416
14417 .option acl_smtp_data main string&!! unset
14418 .cindex "DATA" "ACL for"
14419 This option defines the ACL that is run after an SMTP DATA command has been
14420 processed and the message itself has been received, but before the final
14421 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14422
14423 .option acl_smtp_data_prdr main string&!! accept
14424 .cindex "PRDR" "ACL for"
14425 .cindex "DATA" "PRDR ACL for"
14426 .cindex "&ACL;" "PRDR-related"
14427 .cindex "&ACL;" "per-user data processing"
14428 This option defines the ACL that,
14429 if the PRDR feature has been negotiated,
14430 is run for each recipient after an SMTP DATA command has been
14431 processed and the message itself has been received, but before the
14432 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14433
14434 .option acl_smtp_dkim main string&!! unset
14435 .cindex DKIM "ACL for"
14436 This option defines the ACL that is run for each DKIM signature
14437 (by default, or as specified in the dkim_verify_signers option)
14438 of a received message.
14439 See section &<<SECDKIMVFY>>& for further details.
14440
14441 .option acl_smtp_etrn main string&!! unset
14442 .cindex "ETRN" "ACL for"
14443 This option defines the ACL that is run when an SMTP ETRN command is
14444 received. See chapter &<<CHAPACL>>& for further details.
14445
14446 .option acl_smtp_expn main string&!! unset
14447 .cindex "EXPN" "ACL for"
14448 This option defines the ACL that is run when an SMTP EXPN command is
14449 received. See chapter &<<CHAPACL>>& for further details.
14450
14451 .option acl_smtp_helo main string&!! unset
14452 .cindex "EHLO" "ACL for"
14453 .cindex "HELO" "ACL for"
14454 This option defines the ACL that is run when an SMTP EHLO or HELO
14455 command is received. See chapter &<<CHAPACL>>& for further details.
14456
14457
14458 .option acl_smtp_mail main string&!! unset
14459 .cindex "MAIL" "ACL for"
14460 This option defines the ACL that is run when an SMTP MAIL command is
14461 received. See chapter &<<CHAPACL>>& for further details.
14462
14463 .option acl_smtp_mailauth main string&!! unset
14464 .cindex "AUTH" "on MAIL command"
14465 This option defines the ACL that is run when there is an AUTH parameter on
14466 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14467 &<<CHAPSMTPAUTH>>& for details of authentication.
14468
14469 .option acl_smtp_mime main string&!! unset
14470 .cindex "MIME content scanning" "ACL for"
14471 This option is available when Exim is built with the content-scanning
14472 extension. It defines the ACL that is run for each MIME part in a message. See
14473 section &<<SECTscanmimepart>>& for details.
14474
14475 .option acl_smtp_notquit main string&!! unset
14476 .cindex "not-QUIT, ACL for"
14477 This option defines the ACL that is run when an SMTP session
14478 ends without a QUIT command being received.
14479 See chapter &<<CHAPACL>>& for further details.
14480
14481 .option acl_smtp_predata main string&!! unset
14482 This option defines the ACL that is run when an SMTP DATA command is
14483 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14484 further details.
14485
14486 .option acl_smtp_quit main string&!! unset
14487 .cindex "QUIT, ACL for"
14488 This option defines the ACL that is run when an SMTP QUIT command is
14489 received. See chapter &<<CHAPACL>>& for further details.
14490
14491 .option acl_smtp_rcpt main string&!! unset
14492 .cindex "RCPT" "ACL for"
14493 This option defines the ACL that is run when an SMTP RCPT command is
14494 received. See chapter &<<CHAPACL>>& for further details.
14495
14496 .option acl_smtp_starttls main string&!! unset
14497 .cindex "STARTTLS, ACL for"
14498 This option defines the ACL that is run when an SMTP STARTTLS command is
14499 received. See chapter &<<CHAPACL>>& for further details.
14500
14501 .option acl_smtp_vrfy main string&!! unset
14502 .cindex "VRFY" "ACL for"
14503 This option defines the ACL that is run when an SMTP VRFY command is
14504 received. See chapter &<<CHAPACL>>& for further details.
14505
14506 .option add_environment main "string list" empty
14507 .cindex "environment" "set values"
14508 This option allows to set individual environment variables that the
14509 currently linked libraries and programs in child processes use.
14510 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14511
14512 .option admin_groups main "string list&!!" unset
14513 .cindex "admin user"
14514 This option is expanded just once, at the start of Exim's processing. If the
14515 current group or any of the supplementary groups of an Exim caller is in this
14516 colon-separated list, the caller has admin privileges. If all your system
14517 programmers are in a specific group, for example, you can give them all Exim
14518 admin privileges by putting that group in &%admin_groups%&. However, this does
14519 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14520 To permit this, you have to add individuals to the Exim group.
14521
14522 .option allow_domain_literals main boolean false
14523 .cindex "domain literal"
14524 If this option is set, the RFC 2822 domain literal format is permitted in
14525 email addresses. The option is not set by default, because the domain literal
14526 format is not normally required these days, and few people know about it. It
14527 has, however, been exploited by mail abusers.
14528
14529 Unfortunately, it seems that some DNS black list maintainers are using this
14530 format to report black listing to postmasters. If you want to accept messages
14531 addressed to your hosts by IP address, you need to set
14532 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14533 domains (defined in the named domain list &%local_domains%& in the default
14534 configuration). This &"magic string"& matches the domain literal form of all
14535 the local host's IP addresses.
14536
14537
14538 .option allow_mx_to_ip main boolean false
14539 .cindex "MX record" "pointing to IP address"
14540 It appears that more and more DNS zone administrators are breaking the rules
14541 and putting domain names that look like IP addresses on the right hand side of
14542 MX records. Exim follows the rules and rejects this, giving an error message
14543 that explains the misconfiguration. However, some other MTAs support this
14544 practice, so to avoid &"Why can't Exim do this?"& complaints,
14545 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14546 recommended, except when you have no other choice.
14547
14548 .option allow_utf8_domains main boolean false
14549 .cindex "domain" "UTF-8 characters in"
14550 .cindex "UTF-8" "in domain name"
14551 Lots of discussion is going on about internationalized domain names. One
14552 camp is strongly in favour of just using UTF-8 characters, and it seems
14553 that at least two other MTAs permit this. This option allows Exim users to
14554 experiment if they wish.
14555
14556 If it is set true, Exim's domain parsing function allows valid
14557 UTF-8 multicharacters to appear in domain name components, in addition to
14558 letters, digits, and hyphens. However, just setting this option is not
14559 enough; if you want to look up these domain names in the DNS, you must also
14560 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14561 suitable setting is:
14562 .code
14563 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14564   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14565 .endd
14566 Alternatively, you can just disable this feature by setting
14567 .code
14568 dns_check_names_pattern =
14569 .endd
14570 That is, set the option to an empty string so that no check is done.
14571
14572
14573 .option auth_advertise_hosts main "host list&!!" *
14574 .cindex "authentication" "advertising"
14575 .cindex "AUTH" "advertising"
14576 If any server authentication mechanisms are configured, Exim advertises them in
14577 response to an EHLO command only if the calling host matches this list.
14578 Otherwise, Exim does not advertise AUTH.
14579 Exim does not accept AUTH commands from clients to which it has not
14580 advertised the availability of AUTH. The advertising of individual
14581 authentication mechanisms can be controlled by the use of the
14582 &%server_advertise_condition%& generic authenticator option on the individual
14583 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14584
14585 Certain mail clients (for example, Netscape) require the user to provide a name
14586 and password for authentication if AUTH is advertised, even though it may
14587 not be needed (the host may accept messages from hosts on its local LAN without
14588 authentication, for example). The &%auth_advertise_hosts%& option can be used
14589 to make these clients more friendly by excluding them from the set of hosts to
14590 which Exim advertises AUTH.
14591
14592 .cindex "AUTH" "advertising when encrypted"
14593 If you want to advertise the availability of AUTH only when the connection
14594 is encrypted using TLS, you can make use of the fact that the value of this
14595 option is expanded, with a setting like this:
14596 .code
14597 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14598 .endd
14599 .vindex "&$tls_in_cipher$&"
14600 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14601 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14602 expansion is *, which matches all hosts.
14603
14604
14605 .option auto_thaw main time 0s
14606 .cindex "thawing messages"
14607 .cindex "unfreezing messages"
14608 If this option is set to a time greater than zero, a queue runner will try a
14609 new delivery attempt on any frozen message, other than a bounce message, if
14610 this much time has passed since it was frozen. This may result in the message
14611 being re-frozen if nothing has changed since the last attempt. It is a way of
14612 saying &"keep on trying, even though there are big problems"&.
14613
14614 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14615 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14616 thought to be very useful any more, and its use should probably be avoided.
14617
14618
14619 .option av_scanner main string "see below"
14620 This option is available if Exim is built with the content-scanning extension.
14621 It specifies which anti-virus scanner to use. The default value is:
14622 .code
14623 sophie:/var/run/sophie
14624 .endd
14625 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14626 before use. See section &<<SECTscanvirus>>& for further details.
14627
14628
14629 .option bi_command main string unset
14630 .oindex "&%-bi%&"
14631 This option supplies the name of a command that is run when Exim is called with
14632 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14633 just the command name, it is not a complete command line. If an argument is
14634 required, it must come from the &%-oA%& command line option.
14635
14636
14637 .option bounce_message_file main string unset
14638 .cindex "bounce message" "customizing"
14639 .cindex "customizing" "bounce message"
14640 This option defines a template file containing paragraphs of text to be used
14641 for constructing bounce messages.  Details of the file's contents are given in
14642 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14643
14644
14645 .option bounce_message_text main string unset
14646 When this option is set, its contents are included in the default bounce
14647 message immediately after &"This message was created automatically by mail
14648 delivery software."& It is not used if &%bounce_message_file%& is set.
14649
14650 .option bounce_return_body main boolean true
14651 .cindex "bounce message" "including body"
14652 This option controls whether the body of an incoming message is included in a
14653 bounce message when &%bounce_return_message%& is true. The default setting
14654 causes the entire message, both header and body, to be returned (subject to the
14655 value of &%bounce_return_size_limit%&). If this option is false, only the
14656 message header is included. In the case of a non-SMTP message containing an
14657 error that is detected during reception, only those header lines preceding the
14658 point at which the error was detected are returned.
14659 .cindex "bounce message" "including original"
14660
14661 .option bounce_return_linesize_limit main integer 998
14662 .cindex "size" "of bounce lines, limit"
14663 .cindex "bounce message" "line length limit"
14664 .cindex "limit" "bounce message line length"
14665 This option sets a limit in bytes on the line length of messages
14666 that are returned to senders due to delivery problems,
14667 when &%bounce_return_message%& is true.
14668 The default value corresponds to RFC limits.
14669 If the message being returned has lines longer than this value it is
14670 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14671
14672 The option also applies to bounces returned when an error is detected
14673 during reception of a message.
14674 In this case lines from the original are truncated.
14675
14676 The option does not apply to messages generated by an &(autoreply)& transport.
14677
14678
14679 .option bounce_return_message main boolean true
14680 If this option is set false, none of the original message is included in
14681 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14682 &%bounce_return_body%&.
14683
14684
14685 .option bounce_return_size_limit main integer 100K
14686 .cindex "size" "of bounce, limit"
14687 .cindex "bounce message" "size limit"
14688 .cindex "limit" "bounce message size"
14689 This option sets a limit in bytes on the size of messages that are returned to
14690 senders as part of bounce messages when &%bounce_return_message%& is true. The
14691 limit should be less than the value of the global &%message_size_limit%& and of
14692 any &%message_size_limit%& settings on transports, to allow for the bounce text
14693 that Exim generates. If this option is set to zero there is no limit.
14694
14695 When the body of any message that is to be included in a bounce message is
14696 greater than the limit, it is truncated, and a comment pointing this out is
14697 added at the top. The actual cutoff may be greater than the value given, owing
14698 to the use of buffering for transferring the message in chunks (typically 8K in
14699 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14700 messages.
14701
14702 .option bounce_sender_authentication main string unset
14703 .cindex "bounce message" "sender authentication"
14704 .cindex "authentication" "bounce message"
14705 .cindex "AUTH" "on bounce message"
14706 This option provides an authenticated sender address that is sent with any
14707 bounce messages generated by Exim that are sent over an authenticated SMTP
14708 connection. A typical setting might be:
14709 .code
14710 bounce_sender_authentication = mailer-daemon@my.domain.example
14711 .endd
14712 which would cause bounce messages to be sent using the SMTP command:
14713 .code
14714 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14715 .endd
14716 The value of &%bounce_sender_authentication%& must always be a complete email
14717 address.
14718
14719 .option callout_domain_negative_expire main time 3h
14720 .cindex "caching" "callout timeouts"
14721 .cindex "callout" "caching timeouts"
14722 This option specifies the expiry time for negative callout cache data for a
14723 domain. See section &<<SECTcallver>>& for details of callout verification, and
14724 section &<<SECTcallvercache>>& for details of the caching.
14725
14726
14727 .option callout_domain_positive_expire main time 7d
14728 This option specifies the expiry time for positive callout cache data for a
14729 domain. See section &<<SECTcallver>>& for details of callout verification, and
14730 section &<<SECTcallvercache>>& for details of the caching.
14731
14732
14733 .option callout_negative_expire main time 2h
14734 This option specifies the expiry time for negative callout cache data for an
14735 address. See section &<<SECTcallver>>& for details of callout verification, and
14736 section &<<SECTcallvercache>>& for details of the caching.
14737
14738
14739 .option callout_positive_expire main time 24h
14740 This option specifies the expiry time for positive callout cache data for an
14741 address. See section &<<SECTcallver>>& for details of callout verification, and
14742 section &<<SECTcallvercache>>& for details of the caching.
14743
14744
14745 .option callout_random_local_part main string&!! "see below"
14746 This option defines the &"random"& local part that can be used as part of
14747 callout verification. The default value is
14748 .code
14749 $primary_hostname-$tod_epoch-testing
14750 .endd
14751 See section &<<CALLaddparcall>>& for details of how this value is used.
14752
14753
14754 .option check_log_inodes main integer 100
14755 See &%check_spool_space%& below.
14756
14757
14758 .option check_log_space main integer 10M
14759 See &%check_spool_space%& below.
14760
14761 .oindex "&%check_rfc2047_length%&"
14762 .cindex "RFC 2047" "disabling length check"
14763 .option check_rfc2047_length main boolean true
14764 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14765 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14766 word; strings to be encoded that exceed this length are supposed to use
14767 multiple encoded words. By default, Exim does not recognize encoded words that
14768 exceed the maximum length. However, it seems that some software, in violation
14769 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14770 set false, Exim recognizes encoded words of any length.
14771
14772
14773 .option check_spool_inodes main integer 100
14774 See &%check_spool_space%& below.
14775
14776
14777 .option check_spool_space main integer 10M
14778 .cindex "checking disk space"
14779 .cindex "disk space, checking"
14780 .cindex "spool directory" "checking space"
14781 The four &%check_...%& options allow for checking of disk resources before a
14782 message is accepted.
14783
14784 .vindex "&$log_inodes$&"
14785 .vindex "&$log_space$&"
14786 .vindex "&$spool_inodes$&"
14787 .vindex "&$spool_space$&"
14788 When any of these options are nonzero, they apply to all incoming messages. If you
14789 want to apply different checks to different kinds of message, you can do so by
14790 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14791 &$spool_space$& in an ACL with appropriate additional conditions.
14792
14793
14794 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14795 either value is greater than zero, for example:
14796 .code
14797 check_spool_space = 100M
14798 check_spool_inodes = 100
14799 .endd
14800 The spool partition is the one that contains the directory defined by
14801 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14802 transit.
14803
14804 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14805 files are written if either is greater than zero. These should be set only if
14806 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14807
14808 If there is less space or fewer inodes than requested, Exim refuses to accept
14809 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14810 error response to the MAIL command. If ESMTP is in use and there was a
14811 SIZE parameter on the MAIL command, its value is added to the
14812 &%check_spool_space%& value, and the check is performed even if
14813 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14814
14815 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14816 number of kilobytes (though specified in bytes).
14817 If a non-multiple of 1024 is specified, it is rounded up.
14818
14819 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14820 failure a message is written to stderr and Exim exits with a non-zero code, as
14821 it obviously cannot send an error message of any kind.
14822
14823 There is a slight performance penalty for these checks.
14824 Versions of Exim preceding 4.88 had these disabled by default;
14825 high-rate installations confident they will never run out of resources
14826 may wish to deliberately disable them.
14827
14828 .option chunking_advertise_hosts main "host list&!!" *
14829 .cindex CHUNKING advertisement
14830 .cindex "RFC 3030" "CHUNKING"
14831 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14832 these hosts.
14833 Hosts may use the BDAT command as an alternate to DATA.
14834
14835 .option commandline_checks_require_admin main boolean &`false`&
14836 .cindex "restricting access to features"
14837 This option restricts various basic checking features to require an
14838 administrative user.
14839 This affects most of the &%-b*%& options, such as &%-be%&.
14840
14841 .option debug_store main boolean &`false`&
14842 .cindex debugging "memory corruption"
14843 .cindex memory debugging
14844 This option, when true, enables extra checking in Exim's internal memory
14845 management.  For use when a memory corruption issue is being investigated,
14846 it should normally be left as default.
14847
14848 .option daemon_smtp_ports main string &`smtp`&
14849 .cindex "port" "for daemon"
14850 .cindex "TCP/IP" "setting listening ports"
14851 This option specifies one or more default SMTP ports on which the Exim daemon
14852 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14853 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14854
14855 .option daemon_startup_retries main integer 9
14856 .cindex "daemon startup, retrying"
14857 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14858 the daemon at startup when it cannot immediately bind a listening socket
14859 (typically because the socket is already in use): &%daemon_startup_retries%&
14860 defines the number of retries after the first failure, and
14861 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14862
14863 .option daemon_startup_sleep main time 30s
14864 See &%daemon_startup_retries%&.
14865
14866 .option delay_warning main "time list" 24h
14867 .cindex "warning of delay"
14868 .cindex "delay warning, specifying"
14869 .cindex "queue" "delay warning"
14870 When a message is delayed, Exim sends a warning message to the sender at
14871 intervals specified by this option. The data is a colon-separated list of times
14872 after which to send warning messages. If the value of the option is an empty
14873 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14874 message has been on the queue for longer than the last time, the last interval
14875 between the times is used to compute subsequent warning times. For example,
14876 with
14877 .code
14878 delay_warning = 4h:8h:24h
14879 .endd
14880 the first message is sent after 4 hours, the second after 8 hours, and
14881 the third one after 24 hours. After that, messages are sent every 16 hours,
14882 because that is the interval between the last two times on the list. If you set
14883 just one time, it specifies the repeat interval. For example, with:
14884 .code
14885 delay_warning = 6h
14886 .endd
14887 messages are repeated every six hours. To stop warnings after a given time, set
14888 a very large time at the end of the list. For example:
14889 .code
14890 delay_warning = 2h:12h:99d
14891 .endd
14892 Note that the option is only evaluated at the time a delivery attempt fails,
14893 which depends on retry and queue-runner configuration.
14894 Typically retries will be configured more frequently than warning messages.
14895
14896 .option delay_warning_condition main string&!! "see below"
14897 .vindex "&$domain$&"
14898 The string is expanded at the time a warning message might be sent. If all the
14899 deferred addresses have the same domain, it is set in &$domain$& during the
14900 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14901 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14902 &"false"& (the comparison being done caselessly) then the warning message is
14903 not sent. The default is:
14904 .code
14905 delay_warning_condition = ${if or {\
14906   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14907   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14908   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14909   } {no}{yes}}
14910 .endd
14911 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14912 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14913 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14914 &"auto-replied"& in an &'Auto-Submitted:'& header.
14915
14916 .option deliver_drop_privilege main boolean false
14917 .cindex "unprivileged delivery"
14918 .cindex "delivery" "unprivileged"
14919 If this option is set true, Exim drops its root privilege at the start of a
14920 delivery process, and runs as the Exim user throughout. This severely restricts
14921 the kinds of local delivery that are possible, but is viable in certain types
14922 of configuration. There is a discussion about the use of root privilege in
14923 chapter &<<CHAPsecurity>>&.
14924
14925 .option deliver_queue_load_max main fixed-point unset
14926 .cindex "load average"
14927 .cindex "queue runner" "abandoning"
14928 When this option is set, a queue run is abandoned if the system load average
14929 becomes greater than the value of the option. The option has no effect on
14930 ancient operating systems on which Exim cannot determine the load average.
14931 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14932
14933
14934 .option delivery_date_remove main boolean true
14935 .cindex "&'Delivery-date:'& header line"
14936 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14937 message when it is delivered, in exactly the same way as &'Return-path:'& is
14938 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14939 should not be present in incoming messages, and this option causes them to be
14940 removed at the time the message is received, to avoid any problems that might
14941 occur when a delivered message is subsequently sent on to some other recipient.
14942
14943 .option disable_fsync main boolean false
14944 .cindex "&[fsync()]&, disabling"
14945 This option is available only if Exim was built with the compile-time option
14946 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14947 a runtime configuration generates an &"unknown option"& error. You should not
14948 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14949 really, really, really understand what you are doing. &'No pre-compiled
14950 distributions of Exim should ever make this option available.'&
14951
14952 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14953 updated files' data to be written to disc before continuing. Unexpected events
14954 such as crashes and power outages may cause data to be lost or scrambled.
14955 Here be Dragons. &*Beware.*&
14956
14957
14958 .option disable_ipv6 main boolean false
14959 .cindex "IPv6" "disabling"
14960 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14961 activities take place. AAAA records are never looked up, and any IPv6 addresses
14962 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14963 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14964 to handle IPv6 literal addresses.
14965
14966
14967 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14968 .cindex DKIM "controlling calls to the ACL"
14969 This option gives a list of DKIM domains for which the DKIM ACL is run.
14970 It is expanded after the message is received; by default it runs
14971 the ACL once for each signature in the message.
14972 See section &<<SECDKIMVFY>>&.
14973
14974
14975 .option dns_again_means_nonexist main "domain list&!!" unset
14976 .cindex "DNS" "&""try again""& response; overriding"
14977 DNS lookups give a &"try again"& response for the DNS errors
14978 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14979 keep trying to deliver a message, or to give repeated temporary errors to
14980 incoming mail. Sometimes the effect is caused by a badly set up name server and
14981 may persist for a long time. If a domain which exhibits this problem matches
14982 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14983 This option should be used with care. You can make it apply to reverse lookups
14984 by a setting such as this:
14985 .code
14986 dns_again_means_nonexist = *.in-addr.arpa
14987 .endd
14988 This option applies to all DNS lookups that Exim does. It also applies when the
14989 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14990 since these are most likely to be caused by DNS lookup problems. The
14991 &(dnslookup)& router has some options of its own for controlling what happens
14992 when lookups for MX or SRV records give temporary errors. These more specific
14993 options are applied after this global option.
14994
14995 .option dns_check_names_pattern main string "see below"
14996 .cindex "DNS" "pre-check of name syntax"
14997 When this option is set to a non-empty string, it causes Exim to check domain
14998 names for characters that are not allowed in host names before handing them to
14999 the DNS resolver, because some resolvers give temporary errors for names that
15000 contain unusual characters. If a domain name contains any unwanted characters,
15001 a &"not found"& result is forced, and the resolver is not called. The check is
15002 done by matching the domain name against a regular expression, which is the
15003 value of this option. The default pattern is
15004 .code
15005 dns_check_names_pattern = \
15006   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15007 .endd
15008 which permits only letters, digits, slashes, and hyphens in components, but
15009 they must start and end with a letter or digit. Slashes are not, in fact,
15010 permitted in host names, but they are found in certain NS records (which can be
15011 accessed in Exim by using a &%dnsdb%& lookup). If you set
15012 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15013 empty string.
15014
15015 .option dns_csa_search_limit main integer 5
15016 This option controls the depth of parental searching for CSA SRV records in the
15017 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15018
15019 .option dns_csa_use_reverse main boolean true
15020 This option controls whether or not an IP address, given as a CSA domain, is
15021 reversed and looked up in the reverse DNS, as described in more detail in
15022 section &<<SECTverifyCSA>>&.
15023
15024 .new
15025 .option dns_cname_loops main integer 1
15026 .cindex DNS "CNAME following"
15027 This option controls the following of CNAME chains, needed if the resolver does
15028 not do it internally.
15029 As of 2018 most should, and the default can be left.
15030 If you have an ancient one, a value of 10 is likely needed.
15031
15032 The default value of one CNAME-follow is needed
15033 thanks to the observed return for an MX request,
15034 given no MX presence but a CNAME to an A, of the CNAME.
15035 .wen
15036
15037
15038 .option dns_dnssec_ok main integer -1
15039 .cindex "DNS" "resolver options"
15040 .cindex "DNS" "DNSSEC"
15041 If this option is set to a non-negative number then Exim will initialise the
15042 DNS resolver library to either use or not use DNSSEC, overriding the system
15043 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15044
15045 If the resolver library does not support DNSSEC then this option has no effect.
15046
15047
15048 .option dns_ipv4_lookup main "domain list&!!" unset
15049 .cindex "IPv6" "DNS lookup for AAAA records"
15050 .cindex "DNS" "IPv6 lookup for AAAA records"
15051 .cindex DNS "IPv6 disabling"
15052 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15053 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15054 (A records) when trying to find IP addresses for hosts, unless the host's
15055 domain matches this list.
15056
15057 This is a fudge to help with name servers that give big delays or otherwise do
15058 not work for the AAAA record type. In due course, when the world's name
15059 servers have all been upgraded, there should be no need for this option.
15060
15061
15062 .option dns_retrans main time 0s
15063 .cindex "DNS" "resolver options"
15064 .cindex timeout "dns lookup"
15065 .cindex "DNS" timeout
15066 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15067 retransmission and retry parameters for DNS lookups. Values of zero (the
15068 defaults) leave the system default settings unchanged. The first value is the
15069 time between retries, and the second is the number of retries. It isn't
15070 totally clear exactly how these settings affect the total time a DNS lookup may
15071 take. I haven't found any documentation about timeouts on DNS lookups; these
15072 parameter values are available in the external resolver interface structure,
15073 but nowhere does it seem to describe how they are used or what you might want
15074 to set in them.
15075 See also the &%slow_lookup_log%& option.
15076
15077
15078 .option dns_retry main integer 0
15079 See &%dns_retrans%& above.
15080
15081
15082 .option dns_trust_aa main "domain list&!!" unset
15083 .cindex "DNS" "resolver options"
15084 .cindex "DNS" "DNSSEC"
15085 If this option is set then lookup results marked with the AA bit
15086 (Authoritative Answer) are trusted the same way as if they were
15087 DNSSEC-verified. The authority section's name of the answer must
15088 match with this expanded domain list.
15089
15090 Use this option only if you talk directly to a resolver that is
15091 authoritative for some zones and does not set the AD (Authentic Data)
15092 bit in the answer. Some DNS servers may have an configuration option to
15093 mark the answers from their own zones as verified (they set the AD bit).
15094 Others do not have this option. It is considered as poor practice using
15095 a resolver that is an authoritative server for some zones.
15096
15097 Use this option only if you really have to (e.g. if you want
15098 to use DANE for remote delivery to a server that is listed in the DNS
15099 zones that your resolver is authoritative for).
15100
15101 If the DNS answer packet has the AA bit set and contains resource record
15102 in the answer section, the name of the first NS record appearing in the
15103 authority section is compared against the list. If the answer packet is
15104 authoritative but the answer section is empty, the name of the first SOA
15105 record in the authoritative section is used instead.
15106
15107 .cindex "DNS" "resolver options"
15108 .option dns_use_edns0 main integer -1
15109 .cindex "DNS" "resolver options"
15110 .cindex "DNS" "EDNS0"
15111 .cindex "DNS" "OpenBSD
15112 If this option is set to a non-negative number then Exim will initialise the
15113 DNS resolver library to either use or not use EDNS0 extensions, overriding
15114 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15115 on.
15116
15117 If the resolver library does not support EDNS0 then this option has no effect.
15118
15119 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15120 means that DNSSEC will not work with Exim on that platform either, unless Exim
15121 is linked against an alternative DNS client library.
15122
15123
15124 .option drop_cr main boolean false
15125 This is an obsolete option that is now a no-op. It used to affect the way Exim
15126 handled CR and LF characters in incoming messages. What happens now is
15127 described in section &<<SECTlineendings>>&.
15128
15129 .option dsn_advertise_hosts main "host list&!!" unset
15130 .cindex "bounce messages" "success"
15131 .cindex "DSN" "success"
15132 .cindex "Delivery Status Notification" "success"
15133 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15134 and accepted from, these hosts.
15135 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15136 and RET and ORCPT options on MAIL FROM commands.
15137 A NOTIFY=SUCCESS option requests success-DSN messages.
15138 A NOTIFY= option with no argument requests that no delay or failure DSNs
15139 are sent.
15140
15141 .option dsn_from main "string&!!" "see below"
15142 .cindex "&'From:'& header line" "in bounces"
15143 .cindex "bounce messages" "&'From:'& line, specifying"
15144 This option can be used to vary the contents of &'From:'& header lines in
15145 bounces and other automatically generated messages (&"Delivery Status
15146 Notifications"& &-- hence the name of the option). The default setting is:
15147 .code
15148 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15149 .endd
15150 The value is expanded every time it is needed. If the expansion fails, a
15151 panic is logged, and the default value is used.
15152
15153 .option envelope_to_remove main boolean true
15154 .cindex "&'Envelope-to:'& header line"
15155 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15156 message when it is delivered, in exactly the same way as &'Return-path:'& is
15157 handled. &'Envelope-to:'& records the original recipient address from the
15158 message's envelope that caused the delivery to happen. Such headers should not
15159 be present in incoming messages, and this option causes them to be removed at
15160 the time the message is received, to avoid any problems that might occur when a
15161 delivered message is subsequently sent on to some other recipient.
15162
15163
15164 .option errors_copy main "string list&!!" unset
15165 .cindex "bounce message" "copy to other address"
15166 .cindex "copy of bounce message"
15167 Setting this option causes Exim to send bcc copies of bounce messages that it
15168 generates to other addresses. &*Note*&: This does not apply to bounce messages
15169 coming from elsewhere. The value of the option is a colon-separated list of
15170 items. Each item consists of a pattern, terminated by white space, followed by
15171 a comma-separated list of email addresses. If a pattern contains spaces, it
15172 must be enclosed in double quotes.
15173
15174 Each pattern is processed in the same way as a single item in an address list
15175 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15176 the bounce message, the message is copied to the addresses on the list. The
15177 items are scanned in order, and once a matching one is found, no further items
15178 are examined. For example:
15179 .code
15180 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15181               rqps@mydomain   hostmaster@mydomain.example,\
15182                               postmaster@mydomain.example
15183 .endd
15184 .vindex "&$domain$&"
15185 .vindex "&$local_part$&"
15186 The address list is expanded before use. The expansion variables &$local_part$&
15187 and &$domain$& are set from the original recipient of the error message, and if
15188 there was any wildcard matching in the pattern, the expansion
15189 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15190 variables &$0$&, &$1$&, etc. are set in the normal way.
15191
15192
15193 .option errors_reply_to main string unset
15194 .cindex "bounce message" "&'Reply-to:'& in"
15195 By default, Exim's bounce and delivery warning messages contain the header line
15196 .display
15197 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15198 .endd
15199 .oindex &%quota_warn_message%&
15200 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15201 A warning message that is generated by the &%quota_warn_message%& option in an
15202 &(appendfile)& transport may contain its own &'From:'& header line that
15203 overrides the default.
15204
15205 Experience shows that people reply to bounce messages. If the
15206 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15207 and warning messages. For example:
15208 .code
15209 errors_reply_to = postmaster@my.domain.example
15210 .endd
15211 The value of the option is not expanded. It must specify a valid RFC 2822
15212 address. However, if a warning message that is generated by the
15213 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15214 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15215 not used.
15216
15217
15218 .option event_action main string&!! unset
15219 .cindex events
15220 This option declares a string to be expanded for Exim's events mechanism.
15221 For details see chapter &<<CHAPevents>>&.
15222
15223
15224 .option exim_group main string "compile-time configured"
15225 .cindex "gid (group id)" "Exim's own"
15226 .cindex "Exim group"
15227 This option changes the gid under which Exim runs when it gives up root
15228 privilege. The default value is compiled into the binary. The value of this
15229 option is used only when &%exim_user%& is also set. Unless it consists entirely
15230 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15231 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15232 security issues.
15233
15234
15235 .option exim_path main string "see below"
15236 .cindex "Exim binary, path name"
15237 This option specifies the path name of the Exim binary, which is used when Exim
15238 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15239 the directory configured at compile time by the BIN_DIRECTORY setting. It
15240 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15241 other place.
15242 &*Warning*&: Do not use a macro to define the value of this option, because
15243 you will break those Exim utilities that scan the configuration file to find
15244 where the binary is. (They then use the &%-bP%& option to extract option
15245 settings such as the value of &%spool_directory%&.)
15246
15247
15248 .option exim_user main string "compile-time configured"
15249 .cindex "uid (user id)" "Exim's own"
15250 .cindex "Exim user"
15251 This option changes the uid under which Exim runs when it gives up root
15252 privilege. The default value is compiled into the binary. Ownership of the run
15253 time configuration file and the use of the &%-C%& and &%-D%& command line
15254 options is checked against the values in the binary, not what is set here.
15255
15256 Unless it consists entirely of digits, the string is looked up using
15257 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15258 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15259 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15260
15261
15262 .option extra_local_interfaces main "string list" unset
15263 This option defines network interfaces that are to be considered local when
15264 routing, but which are not used for listening by the daemon. See section
15265 &<<SECTreclocipadd>>& for details.
15266
15267
15268 . Allow this long option name to split; give it unsplit as a fifth argument
15269 . for the automatic .oindex that is generated by .option.
15270
15271 .option "extract_addresses_remove_arguments" main boolean true &&&
15272          extract_addresses_remove_arguments
15273 .oindex "&%-t%&"
15274 .cindex "command line" "addresses with &%-t%&"
15275 .cindex "Sendmail compatibility" "&%-t%& option"
15276 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15277 are present on the command line when the &%-t%& option is used to build an
15278 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15279 line addresses are removed from the recipients list. This is also how Smail
15280 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15281 command line addresses are added to those obtained from the header lines. When
15282 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15283 argument headers. If it is set false, Exim adds rather than removes argument
15284 addresses.
15285
15286
15287 .option finduser_retries main integer 0
15288 .cindex "NIS, retrying user lookups"
15289 On systems running NIS or other schemes in which user and group information is
15290 distributed from a remote system, there can be times when &[getpwnam()]& and
15291 related functions fail, even when given valid data, because things time out.
15292 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15293 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15294 many extra times to find a user or a group, waiting for one second between
15295 retries.
15296
15297 .cindex "&_/etc/passwd_&" "multiple reading of"
15298 You should not set this option greater than zero if your user information is in
15299 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15300 search the file multiple times for non-existent users, and also cause delay.
15301
15302
15303
15304 .option freeze_tell main "string list, comma separated" unset
15305 .cindex "freezing messages" "sending a message when freezing"
15306 On encountering certain errors, or when configured to do so in a system filter,
15307 ACL, or special router, Exim freezes a message. This means that no further
15308 delivery attempts take place until an administrator thaws the message, or the
15309 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15310 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15311 warning message whenever it freezes something, unless the message it is
15312 freezing is a locally-generated bounce message. (Without this exception there
15313 is the possibility of looping.) The warning message is sent to the addresses
15314 supplied as the comma-separated value of this option. If several of the
15315 message's addresses cause freezing, only a single message is sent. If the
15316 freezing was automatic, the reason(s) for freezing can be found in the message
15317 log. If you configure freezing in a filter or ACL, you must arrange for any
15318 logging that you require.
15319
15320
15321 .option gecos_name main string&!! unset
15322 .cindex "HP-UX"
15323 .cindex "&""gecos""& field, parsing"
15324 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15325 password file to hold other information in addition to users' real names. Exim
15326 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15327 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15328 of the field are used unchanged, except that, if an ampersand is encountered,
15329 it is replaced by the user's login name with the first character forced to
15330 upper case, since this is a convention that is observed on many systems.
15331
15332 When these options are set, &%gecos_pattern%& is treated as a regular
15333 expression that is to be applied to the field (again with && replaced by the
15334 login name), and if it matches, &%gecos_name%& is expanded and used as the
15335 user's name.
15336
15337 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15338 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15339 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15340 name terminates at the first comma, the following can be used:
15341 .code
15342 gecos_pattern = ([^,]*)
15343 gecos_name = $1
15344 .endd
15345
15346 .option gecos_pattern main string unset
15347 See &%gecos_name%& above.
15348
15349
15350 .option gnutls_compat_mode main boolean unset
15351 This option controls whether GnuTLS is used in compatibility mode in an Exim
15352 server. This reduces security slightly, but improves interworking with older
15353 implementations of TLS.
15354
15355
15356 .option gnutls_allow_auto_pkcs11 main boolean unset
15357 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15358 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15359
15360 See
15361 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15362 for documentation.
15363
15364
15365
15366 .option headers_charset main string "see below"
15367 This option sets a default character set for translating from encoded MIME
15368 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15369 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15370 ultimate default is ISO-8859-1. For more details see the description of header
15371 insertions in section &<<SECTexpansionitems>>&.
15372
15373
15374
15375 .option header_maxsize main integer "see below"
15376 .cindex "header section" "maximum size of"
15377 .cindex "limit" "size of message header section"
15378 This option controls the overall maximum size of a message's header
15379 section. The default is the value of HEADER_MAXSIZE in
15380 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15381 sections are rejected.
15382
15383
15384 .option header_line_maxsize main integer 0
15385 .cindex "header lines" "maximum size of"
15386 .cindex "limit" "size of one header line"
15387 This option limits the length of any individual header line in a message, after
15388 all the continuations have been joined together. Messages with individual
15389 header lines that are longer than the limit are rejected. The default value of
15390 zero means &"no limit"&.
15391
15392
15393
15394
15395 .option helo_accept_junk_hosts main "host list&!!" unset
15396 .cindex "HELO" "accepting junk data"
15397 .cindex "EHLO" "accepting junk data"
15398 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15399 mail, and gives an error response for invalid data. Unfortunately, there are
15400 some SMTP clients that send syntactic junk. They can be accommodated by setting
15401 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15402 if you want to do semantic checking.
15403 See also &%helo_allow_chars%& for a way of extending the permitted character
15404 set.
15405
15406
15407 .option helo_allow_chars main string unset
15408 .cindex "HELO" "underscores in"
15409 .cindex "EHLO" "underscores in"
15410 .cindex "underscore in EHLO/HELO"
15411 This option can be set to a string of rogue characters that are permitted in
15412 all EHLO and HELO names in addition to the standard letters, digits,
15413 hyphens, and dots. If you really must allow underscores, you can set
15414 .code
15415 helo_allow_chars = _
15416 .endd
15417 Note that the value is one string, not a list.
15418
15419
15420 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15421 .cindex "HELO" "forcing reverse lookup"
15422 .cindex "EHLO" "forcing reverse lookup"
15423 If the domain given by a client in a HELO or EHLO command matches this
15424 list, a reverse lookup is done in order to establish the host's true name. The
15425 default forces a lookup if the client host gives the server's name or any of
15426 its IP addresses (in brackets), something that broken clients have been seen to
15427 do.
15428
15429
15430 .option helo_try_verify_hosts main "host list&!!" unset
15431 .cindex "HELO verifying" "optional"
15432 .cindex "EHLO" "verifying, optional"
15433 By default, Exim just checks the syntax of HELO and EHLO commands (see
15434 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15435 to do more extensive checking of the data supplied by these commands. The ACL
15436 condition &`verify = helo`& is provided to make this possible.
15437 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15438 to force the check to occur. From release 4.53 onwards, this is no longer
15439 necessary. If the check has not been done before &`verify = helo`& is
15440 encountered, it is done at that time. Consequently, this option is obsolete.
15441 Its specification is retained here for backwards compatibility.
15442
15443 When an EHLO or HELO command is received, if the calling host matches
15444 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15445 EHLO command either:
15446
15447 .ilist
15448 is an IP literal matching the calling address of the host, or
15449 .next
15450 .cindex "DNS" "reverse lookup"
15451 .cindex "reverse DNS lookup"
15452 matches the host name that Exim obtains by doing a reverse lookup of the
15453 calling host address, or
15454 .next
15455 when looked up in DNS yields the calling host address.
15456 .endlist
15457
15458 However, the EHLO or HELO command is not rejected if any of the checks
15459 fail. Processing continues, but the result of the check is remembered, and can
15460 be detected later in an ACL by the &`verify = helo`& condition.
15461
15462 If DNS was used for successful verification, the variable
15463 .cindex "DNS" "DNSSEC"
15464 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15465
15466 .option helo_verify_hosts main "host list&!!" unset
15467 .cindex "HELO verifying" "mandatory"
15468 .cindex "EHLO" "verifying, mandatory"
15469 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15470 backwards compatibility. For hosts that match this option, Exim checks the host
15471 name given in the HELO or EHLO in the same way as for
15472 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15473 rejected with a 550 error, and entries are written to the main and reject logs.
15474 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15475 error.
15476
15477 .option hold_domains main "domain list&!!" unset
15478 .cindex "domain" "delaying delivery"
15479 .cindex "delivery" "delaying certain domains"
15480 This option allows mail for particular domains to be held on the queue
15481 manually. The option is overridden if a message delivery is forced with the
15482 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15483 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15484 item in &%hold_domains%&, no routing or delivery for that address is done, and
15485 it is deferred every time the message is looked at.
15486
15487 This option is intended as a temporary operational measure for delaying the
15488 delivery of mail while some problem is being sorted out, or some new
15489 configuration tested. If you just want to delay the processing of some
15490 domains until a queue run occurs, you should use &%queue_domains%& or
15491 &%queue_smtp_domains%&, not &%hold_domains%&.
15492
15493 A setting of &%hold_domains%& does not override Exim's code for removing
15494 messages from the queue if they have been there longer than the longest retry
15495 time in any retry rule. If you want to hold messages for longer than the normal
15496 retry times, insert a dummy retry rule with a long retry time.
15497
15498
15499 .option host_lookup main "host list&!!" unset
15500 .cindex "host name" "lookup, forcing"
15501 Exim does not look up the name of a calling host from its IP address unless it
15502 is required to compare against some host list, or the host matches
15503 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15504 option (which normally contains IP addresses rather than host names). The
15505 default configuration file contains
15506 .code
15507 host_lookup = *
15508 .endd
15509 which causes a lookup to happen for all hosts. If the expense of these lookups
15510 is felt to be too great, the setting can be changed or removed.
15511
15512 After a successful reverse lookup, Exim does a forward lookup on the name it
15513 has obtained, to verify that it yields the IP address that it started with. If
15514 this check fails, Exim behaves as if the name lookup failed.
15515
15516 .vindex "&$host_lookup_failed$&"
15517 .vindex "&$sender_host_name$&"
15518 After any kind of failure, the host name (in &$sender_host_name$&) remains
15519 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15520 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15521 &`verify = reverse_host_lookup`& in ACLs.
15522
15523
15524 .option host_lookup_order main "string list" &`bydns:byaddr`&
15525 This option specifies the order of different lookup methods when Exim is trying
15526 to find a host name from an IP address. The default is to do a DNS lookup
15527 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15528 if that fails. You can change the order of these lookups, or omit one entirely,
15529 if you want.
15530
15531 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15532 multiple PTR records in the DNS and the IP address is not listed in
15533 &_/etc/hosts_&. Different operating systems give different results in this
15534 case. That is why the default tries a DNS lookup first.
15535
15536
15537
15538 .option host_reject_connection main "host list&!!" unset
15539 .cindex "host" "rejecting connections from"
15540 If this option is set, incoming SMTP calls from the hosts listed are rejected
15541 as soon as the connection is made.
15542 This option is obsolete, and retained only for backward compatibility, because
15543 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15544 connections immediately.
15545
15546 The ability to give an immediate rejection (either by this option or using an
15547 ACL) is provided for use in unusual cases. Many hosts will just try again,
15548 sometimes without much delay. Normally, it is better to use an ACL to reject
15549 incoming messages at a later stage, such as after RCPT commands. See
15550 chapter &<<CHAPACL>>&.
15551
15552
15553 .option hosts_connection_nolog main "host list&!!" unset
15554 .cindex "host" "not logging connections from"
15555 This option defines a list of hosts for which connection logging does not
15556 happen, even though the &%smtp_connection%& log selector is set. For example,
15557 you might want not to log SMTP connections from local processes, or from
15558 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15559 the daemon; you should therefore strive to restrict its value to a short inline
15560 list of IP addresses and networks. To disable logging SMTP connections from
15561 local processes, you must create a host list with an empty item. For example:
15562 .code
15563 hosts_connection_nolog = :
15564 .endd
15565 If the &%smtp_connection%& log selector is not set, this option has no effect.
15566
15567
15568
15569 .option hosts_proxy main "host list&!!" unset
15570 .cindex proxy "proxy protocol"
15571 This option enables use of Proxy Protocol proxies for incoming
15572 connections.  For details see section &<<SECTproxyInbound>>&.
15573
15574
15575 .option hosts_treat_as_local main "domain list&!!" unset
15576 .cindex "local host" "domains treated as"
15577 .cindex "host" "treated as local"
15578 If this option is set, any host names that match the domain list are treated as
15579 if they were the local host when Exim is scanning host lists obtained from MX
15580 records
15581 or other sources. Note that the value of this option is a domain list, not a
15582 host list, because it is always used to check host names, not IP addresses.
15583
15584 This option also applies when Exim is matching the special items
15585 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15586 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15587 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15588 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15589 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15590 interfaces and recognizing the local host.
15591
15592
15593 .option ibase_servers main "string list" unset
15594 .cindex "InterBase" "server list"
15595 This option provides a list of InterBase servers and associated connection data,
15596 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15597 The option is available only if Exim has been built with InterBase support.
15598
15599
15600
15601 .option ignore_bounce_errors_after main time 10w
15602 .cindex "bounce message" "discarding"
15603 .cindex "discarding bounce message"
15604 This option affects the processing of bounce messages that cannot be delivered,
15605 that is, those that suffer a permanent delivery failure. (Bounce messages that
15606 suffer temporary delivery failures are of course retried in the usual way.)
15607
15608 After a permanent delivery failure, bounce messages are frozen,
15609 because there is no sender to whom they can be returned. When a frozen bounce
15610 message has been on the queue for more than the given time, it is unfrozen at
15611 the next queue run, and a further delivery is attempted. If delivery fails
15612 again, the bounce message is discarded. This makes it possible to keep failed
15613 bounce messages around for a shorter time than the normal maximum retry time
15614 for frozen messages. For example,
15615 .code
15616 ignore_bounce_errors_after = 12h
15617 .endd
15618 retries failed bounce message deliveries after 12 hours, discarding any further
15619 failures. If the value of this option is set to a zero time period, bounce
15620 failures are discarded immediately. Setting a very long time (as in the default
15621 value) has the effect of disabling this option. For ways of automatically
15622 dealing with other kinds of frozen message, see &%auto_thaw%& and
15623 &%timeout_frozen_after%&.
15624
15625
15626 .option ignore_fromline_hosts main "host list&!!" unset
15627 .cindex "&""From""& line"
15628 .cindex "UUCP" "&""From""& line"
15629 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15630 the headers of a message. By default this is treated as the start of the
15631 message's body, which means that any following headers are not recognized as
15632 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15633 match those hosts that insist on sending it. If the sender is actually a local
15634 process rather than a remote host, and is using &%-bs%& to inject the messages,
15635 &%ignore_fromline_local%& must be set to achieve this effect.
15636
15637
15638 .option ignore_fromline_local main boolean false
15639 See &%ignore_fromline_hosts%& above.
15640
15641 .option keep_environment main "string list" unset
15642 .cindex "environment" "values from"
15643 This option contains a string list of environment variables to keep.
15644 You have to trust these variables or you have to be sure that
15645 these variables do not impose any security risk. Keep in mind that
15646 during the startup phase Exim is running with an effective UID 0 in most
15647 installations. As the default value is an empty list, the default
15648 environment for using libraries, running embedded Perl code, or running
15649 external binaries is empty, and does not not even contain PATH or HOME.
15650
15651 Actually the list is interpreted as a list of patterns
15652 (&<<SECTlistexpand>>&), except that it is not expanded first.
15653
15654 WARNING: Macro substitution is still done first, so having a macro
15655 FOO and having FOO_HOME in your &%keep_environment%& option may have
15656 unexpected results. You may work around this using a regular expression
15657 that does not match the macro name: ^[F]OO_HOME$.
15658
15659 Current versions of Exim issue a warning during startup if you do not mention
15660 &%keep_environment%& in your runtime configuration file and if your
15661 current environment is not empty. Future versions may not issue that warning
15662 anymore.
15663
15664 See the &%add_environment%& main config option for a way to set
15665 environment variables to a fixed value.  The environment for &(pipe)&
15666 transports is handled separately, see section &<<SECTpipeenv>>& for
15667 details.
15668
15669
15670 .option keep_malformed main time 4d
15671 This option specifies the length of time to keep messages whose spool files
15672 have been corrupted in some way. This should, of course, never happen. At the
15673 next attempt to deliver such a message, it gets removed. The incident is
15674 logged.
15675
15676
15677 .option ldap_ca_cert_dir main string unset
15678 .cindex "LDAP", "TLS CA certificate directory"
15679 .cindex certificate "directory for LDAP"
15680 This option indicates which directory contains CA certificates for verifying
15681 a TLS certificate presented by an LDAP server.
15682 While Exim does not provide a default value, your SSL library may.
15683 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15684 and constrained to be a directory.
15685
15686
15687 .option ldap_ca_cert_file main string unset
15688 .cindex "LDAP", "TLS CA certificate file"
15689 .cindex certificate "file for LDAP"
15690 This option indicates which file contains CA certificates for verifying
15691 a TLS certificate presented by an LDAP server.
15692 While Exim does not provide a default value, your SSL library may.
15693 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15694 and constrained to be a file.
15695
15696
15697 .option ldap_cert_file main string unset
15698 .cindex "LDAP" "TLS client certificate file"
15699 .cindex certificate "file for LDAP"
15700 This option indicates which file contains an TLS client certificate which
15701 Exim should present to the LDAP server during TLS negotiation.
15702 Should be used together with &%ldap_cert_key%&.
15703
15704
15705 .option ldap_cert_key main string unset
15706 .cindex "LDAP" "TLS client key file"
15707 .cindex certificate "key for LDAP"
15708 This option indicates which file contains the secret/private key to use
15709 to prove identity to the LDAP server during TLS negotiation.
15710 Should be used together with &%ldap_cert_file%&, which contains the
15711 identity to be proven.
15712
15713
15714 .option ldap_cipher_suite main string unset
15715 .cindex "LDAP" "TLS cipher suite"
15716 This controls the TLS cipher-suite negotiation during TLS negotiation with
15717 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15718 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15719
15720
15721 .option ldap_default_servers main "string list" unset
15722 .cindex "LDAP" "default servers"
15723 This option provides a list of LDAP servers which are tried in turn when an
15724 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15725 details of LDAP queries. This option is available only when Exim has been built
15726 with LDAP support.
15727
15728
15729 .option ldap_require_cert main string unset.
15730 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15731 This should be one of the values "hard", "demand", "allow", "try" or "never".
15732 A value other than one of these is interpreted as "never".
15733 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15734 Although Exim does not set a default, the LDAP library probably defaults
15735 to hard/demand.
15736
15737
15738 .option ldap_start_tls main boolean false
15739 .cindex "LDAP" "whether or not to negotiate TLS"
15740 If set, Exim will attempt to negotiate TLS with the LDAP server when
15741 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15742 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15743 of SSL-on-connect.
15744 In the event of failure to negotiate TLS, the action taken is controlled
15745 by &%ldap_require_cert%&.
15746 This option is ignored for &`ldapi`& connections.
15747
15748
15749 .option ldap_version main integer unset
15750 .cindex "LDAP" "protocol version, forcing"
15751 This option can be used to force Exim to set a specific protocol version for
15752 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15753 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15754 the LDAP headers; otherwise it is 2. This option is available only when Exim
15755 has been built with LDAP support.
15756
15757
15758
15759 .option local_from_check main boolean true
15760 .cindex "&'Sender:'& header line" "disabling addition of"
15761 .cindex "&'From:'& header line" "disabling checking of"
15762 When a message is submitted locally (that is, not over a TCP/IP connection) by
15763 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15764 checks that the &'From:'& header line matches the login of the calling user and
15765 the domain specified by &%qualify_domain%&.
15766
15767 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15768 locally submitted message is automatically qualified by Exim, unless the
15769 &%-bnq%& command line option is used.
15770
15771 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15772 on the local part. If the &'From:'& header line does not match, Exim adds a
15773 &'Sender:'& header with an address constructed from the calling user's login
15774 and the default qualify domain.
15775
15776 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15777 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15778 &'Sender:'& header lines supplied by untrusted users, you must also set
15779 &%local_sender_retain%& to be true.
15780
15781 .cindex "envelope sender"
15782 These options affect only the header lines in the message. The envelope sender
15783 is still forced to be the login id at the qualify domain unless
15784 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15785
15786 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15787 request similar header line checking. See section &<<SECTthesenhea>>&, which
15788 has more details about &'Sender:'& processing.
15789
15790
15791
15792
15793 .option local_from_prefix main string unset
15794 When Exim checks the &'From:'& header line of locally submitted messages for
15795 matching the login id (see &%local_from_check%& above), it can be configured to
15796 ignore certain prefixes and suffixes in the local part of the address. This is
15797 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15798 appropriate lists, in the same form as the &%local_part_prefix%& and
15799 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15800 example, if
15801 .code
15802 local_from_prefix = *-
15803 .endd
15804 is set, a &'From:'& line containing
15805 .code
15806 From: anything-user@your.domain.example
15807 .endd
15808 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15809 matches the actual sender address that is constructed from the login name and
15810 qualify domain.
15811
15812
15813 .option local_from_suffix main string unset
15814 See &%local_from_prefix%& above.
15815
15816
15817 .option local_interfaces main "string list" "see below"
15818 This option controls which network interfaces are used by the daemon for
15819 listening; they are also used to identify the local host when routing. Chapter
15820 &<<CHAPinterfaces>>& contains a full description of this option and the related
15821 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15822 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15823 &%local_interfaces%& is
15824 .code
15825 local_interfaces = 0.0.0.0
15826 .endd
15827 when Exim is built without IPv6 support; otherwise it is
15828 .code
15829 local_interfaces = <; ::0 ; 0.0.0.0
15830 .endd
15831
15832 .option local_scan_timeout main time 5m
15833 .cindex "timeout" "for &[local_scan()]& function"
15834 .cindex "&[local_scan()]& function" "timeout"
15835 This timeout applies to the &[local_scan()]& function (see chapter
15836 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15837 the incoming message is rejected with a temporary error if it is an SMTP
15838 message. For a non-SMTP message, the message is dropped and Exim ends with a
15839 non-zero code. The incident is logged on the main and reject logs.
15840
15841
15842
15843 .option local_sender_retain main boolean false
15844 .cindex "&'Sender:'& header line" "retaining from local submission"
15845 When a message is submitted locally (that is, not over a TCP/IP connection) by
15846 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15847 do not want this to happen, you must set &%local_sender_retain%&, and you must
15848 also set &%local_from_check%& to be false (Exim will complain if you do not).
15849 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15850 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15851
15852
15853
15854
15855 .option localhost_number main string&!! unset
15856 .cindex "host" "locally unique number for"
15857 .cindex "message ids" "with multiple hosts"
15858 .vindex "&$localhost_number$&"
15859 Exim's message ids are normally unique only within the local host. If
15860 uniqueness among a set of hosts is required, each host must set a different
15861 value for the &%localhost_number%& option. The string is expanded immediately
15862 after reading the configuration file (so that a number can be computed from the
15863 host name, for example) and the result of the expansion must be a number in the
15864 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15865 systems). This is available in subsequent string expansions via the variable
15866 &$localhost_number$&. When &%localhost_number is set%&, the final two
15867 characters of the message id, instead of just being a fractional part of the
15868 time, are computed from the time and the local host number as described in
15869 section &<<SECTmessiden>>&.
15870
15871
15872
15873 .option log_file_path main "string list&!!" "set at compile time"
15874 .cindex "log" "file path for"
15875 This option sets the path which is used to determine the names of Exim's log
15876 files, or indicates that logging is to be to syslog, or both. It is expanded
15877 when Exim is entered, so it can, for example, contain a reference to the host
15878 name. If no specific path is set for the log files at compile or run time,
15879 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15880 they are written in a sub-directory called &_log_& in Exim's spool directory.
15881 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15882 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15883 used. If this string is fixed at your installation (contains no expansion
15884 variables) it is recommended that you do not set this option in the
15885 configuration file, but instead supply the path using LOG_FILE_PATH in
15886 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15887 early on &-- in particular, failure to read the configuration file.
15888
15889
15890 .option log_selector main string unset
15891 .cindex "log" "selectors"
15892 This option can be used to reduce or increase the number of things that Exim
15893 writes to its log files. Its argument is made up of names preceded by plus or
15894 minus characters. For example:
15895 .code
15896 log_selector = +arguments -retry_defer
15897 .endd
15898 A list of possible names and what they control is given in the chapter on
15899 logging, in section &<<SECTlogselector>>&.
15900
15901
15902 .option log_timezone main boolean false
15903 .cindex "log" "timezone for entries"
15904 .vindex "&$tod_log$&"
15905 .vindex "&$tod_zone$&"
15906 By default, the timestamps on log lines are in local time without the
15907 timezone. This means that if your timezone changes twice a year, the timestamps
15908 in log lines are ambiguous for an hour when the clocks go back. One way of
15909 avoiding this problem is to set the timezone to UTC. An alternative is to set
15910 &%log_timezone%& true. This turns on the addition of the timezone offset to
15911 timestamps in log lines. Turning on this option can add quite a lot to the size
15912 of log files because each line is extended by 6 characters. Note that the
15913 &$tod_log$& variable contains the log timestamp without the zone, but there is
15914 another variable called &$tod_zone$& that contains just the timezone offset.
15915
15916
15917 .option lookup_open_max main integer 25
15918 .cindex "too many open files"
15919 .cindex "open files, too many"
15920 .cindex "file" "too many open"
15921 .cindex "lookup" "maximum open files"
15922 .cindex "limit" "open files for lookups"
15923 This option limits the number of simultaneously open files for single-key
15924 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15925 Exim normally keeps these files open during routing, because often the same
15926 file is required several times. If the limit is reached, Exim closes the least
15927 recently used file. Note that if you are using the &'ndbm'& library, it
15928 actually opens two files for each logical DBM database, though it still counts
15929 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15930 open files"& errors with NDBM, you need to reduce the value of
15931 &%lookup_open_max%&.
15932
15933
15934 .option max_username_length main integer 0
15935 .cindex "length of login name"
15936 .cindex "user name" "maximum length"
15937 .cindex "limit" "user name length"
15938 Some operating systems are broken in that they truncate long arguments to
15939 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15940 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15941 an argument that is longer behaves as if &[getpwnam()]& failed.
15942
15943
15944 .option message_body_newlines main bool false
15945 .cindex "message body" "newlines in variables"
15946 .cindex "newline" "in message body variables"
15947 .vindex "&$message_body$&"
15948 .vindex "&$message_body_end$&"
15949 By default, newlines in the message body are replaced by spaces when setting
15950 the &$message_body$& and &$message_body_end$& expansion variables. If this
15951 option is set true, this no longer happens.
15952
15953
15954 .option message_body_visible main integer 500
15955 .cindex "body of message" "visible size"
15956 .cindex "message body" "visible size"
15957 .vindex "&$message_body$&"
15958 .vindex "&$message_body_end$&"
15959 This option specifies how much of a message's body is to be included in the
15960 &$message_body$& and &$message_body_end$& expansion variables.
15961
15962
15963 .option message_id_header_domain main string&!! unset
15964 .cindex "&'Message-ID:'& header line"
15965 If this option is set, the string is expanded and used as the right hand side
15966 (domain) of the &'Message-ID:'& header that Exim creates if a
15967 locally-originated incoming message does not have one. &"Locally-originated"&
15968 means &"not received over TCP/IP."&
15969 Otherwise, the primary host name is used.
15970 Only letters, digits, dot and hyphen are accepted; any other characters are
15971 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15972 empty string, the option is ignored.
15973
15974
15975 .option message_id_header_text main string&!! unset
15976 If this variable is set, the string is expanded and used to augment the text of
15977 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15978 message does not have one. The text of this header is required by RFC 2822 to
15979 take the form of an address. By default, Exim uses its internal message id as
15980 the local part, and the primary host name as the domain. If this option is set,
15981 it is expanded, and provided the expansion is not forced to fail, and does not
15982 yield an empty string, the result is inserted into the header immediately
15983 before the @, separated from the internal message id by a dot. Any characters
15984 that are illegal in an address are automatically converted into hyphens. This
15985 means that variables such as &$tod_log$& can be used, because the spaces and
15986 colons will become hyphens.
15987
15988
15989 .option message_logs main boolean true
15990 .cindex "message logs" "disabling"
15991 .cindex "log" "message log; disabling"
15992 If this option is turned off, per-message log files are not created in the
15993 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15994 Exim, by reducing the number of files involved in handling a message from a
15995 minimum of four (header spool file, body spool file, delivery journal, and
15996 per-message log) to three. The other major I/O activity is Exim's main log,
15997 which is not affected by this option.
15998
15999
16000 .option message_size_limit main string&!! 50M
16001 .cindex "message" "size limit"
16002 .cindex "limit" "message size"
16003 .cindex "size" "of message, limit"
16004 This option limits the maximum size of message that Exim will process. The
16005 value is expanded for each incoming connection so, for example, it can be made
16006 to depend on the IP address of the remote host for messages arriving via
16007 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16008 optionally followed by K or M.
16009
16010 &*Note*&: This limit cannot be made to depend on a message's sender or any
16011 other properties of an individual message, because it has to be advertised in
16012 the server's response to EHLO. String expansion failure causes a temporary
16013 error. A value of zero means no limit, but its use is not recommended. See also
16014 &%bounce_return_size_limit%&.
16015
16016 Incoming SMTP messages are failed with a 552 error if the limit is
16017 exceeded; locally-generated messages either get a stderr message or a delivery
16018 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16019 an oversized message is logged in both the main and the reject logs. See also
16020 the generic transport option &%message_size_limit%&, which limits the size of
16021 message that an individual transport can process.
16022
16023 If you use a virus-scanner and set this option to to a value larger than the
16024 maximum size that your virus-scanner is configured to support, you may get
16025 failures triggered by large mails.  The right size to configure for the
16026 virus-scanner depends upon what data is passed and the options in use but it's
16027 probably safest to just set it to a little larger than this value.  E.g., with a
16028 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16029 some problems may result.
16030
16031 A value of 0 will disable size limit checking; Exim will still advertise the
16032 SIZE extension in an EHLO response, but without a limit, so as to permit
16033 SMTP clients to still indicate the message size along with the MAIL verb.
16034
16035
16036 .option move_frozen_messages main boolean false
16037 .cindex "frozen messages" "moving"
16038 This option, which is available only if Exim has been built with the setting
16039 .code
16040 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16041 .endd
16042 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16043 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16044 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16045 standard utilities for handling such moved messages, and they do not show up in
16046 lists generated by &%-bp%& or by the Exim monitor.
16047
16048
16049 .option mua_wrapper main boolean false
16050 Setting this option true causes Exim to run in a very restrictive mode in which
16051 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16052 contains a full description of this facility.
16053
16054
16055
16056 .option mysql_servers main "string list" unset
16057 .cindex "MySQL" "server list"
16058 This option provides a list of MySQL servers and associated connection data, to
16059 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16060 option is available only if Exim has been built with MySQL support.
16061
16062
16063 .option never_users main "string list&!!" unset
16064 This option is expanded just once, at the start of Exim's processing. Local
16065 message deliveries are normally run in processes that are setuid to the
16066 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16067 It is usually desirable to prevent any deliveries from running as root, as a
16068 safety precaution.
16069
16070 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16071 list of users that must not be used for local deliveries. This list is fixed in
16072 the binary and cannot be overridden by the configuration file. By default, it
16073 contains just the single user name &"root"&. The &%never_users%& runtime option
16074 can be used to add more users to the fixed list.
16075
16076 If a message is to be delivered as one of the users on the fixed list or the
16077 &%never_users%& list, an error occurs, and delivery is deferred. A common
16078 example is
16079 .code
16080 never_users = root:daemon:bin
16081 .endd
16082 Including root is redundant if it is also on the fixed list, but it does no
16083 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16084 transport driver.
16085
16086
16087 .option openssl_options main "string list" "+no_sslv2 +single_dh_use +no_ticket"
16088 .cindex "OpenSSL "compatibility options"
16089 This option allows an administrator to adjust the SSL options applied
16090 by OpenSSL to connections.  It is given as a space-separated list of items,
16091 each one to be +added or -subtracted from the current value.
16092
16093 This option is only available if Exim is built against OpenSSL.  The values
16094 available for this option vary according to the age of your OpenSSL install.
16095 The &"all"& value controls a subset of flags which are available, typically
16096 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16097 list the values known on your system and Exim should support all the
16098 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16099 names lose the leading &"SSL_OP_"& and are lower-cased.
16100
16101 Note that adjusting the options can have severe impact upon the security of
16102 SSL as used by Exim.  It is possible to disable safety checks and shoot
16103 yourself in the foot in various unpleasant ways.  This option should not be
16104 adjusted lightly.  An unrecognised item will be detected at startup, by
16105 invoking Exim with the &%-bV%& flag.
16106
16107 The option affects Exim operating both as a server and as a client.
16108
16109 Historical note: prior to release 4.80, Exim defaulted this value to
16110 "+dont_insert_empty_fragments", which may still be needed for compatibility
16111 with some clients, but which lowers security by increasing exposure to
16112 some now infamous attacks.
16113
16114 Examples:
16115 .code
16116 # Make both old MS and old Eudora happy:
16117 openssl_options = -all +microsoft_big_sslv3_buffer \
16118                        +dont_insert_empty_fragments
16119
16120 # Disable older protocol versions:
16121 openssl_options = +no_sslv2 +no_sslv3
16122 .endd
16123
16124 Possible options may include:
16125 .ilist
16126 &`all`&
16127 .next
16128 &`allow_unsafe_legacy_renegotiation`&
16129 .next
16130 &`cipher_server_preference`&
16131 .next
16132 &`dont_insert_empty_fragments`&
16133 .next
16134 &`ephemeral_rsa`&
16135 .next
16136 &`legacy_server_connect`&
16137 .next
16138 &`microsoft_big_sslv3_buffer`&
16139 .next
16140 &`microsoft_sess_id_bug`&
16141 .next
16142 &`msie_sslv2_rsa_padding`&
16143 .next
16144 &`netscape_challenge_bug`&
16145 .next
16146 &`netscape_reuse_cipher_change_bug`&
16147 .next
16148 &`no_compression`&
16149 .next
16150 &`no_session_resumption_on_renegotiation`&
16151 .next
16152 &`no_sslv2`&
16153 .next
16154 &`no_sslv3`&
16155 .next
16156 &`no_ticket`&
16157 .next
16158 &`no_tlsv1`&
16159 .next
16160 &`no_tlsv1_1`&
16161 .next
16162 &`no_tlsv1_2`&
16163 .next
16164 &`safari_ecdhe_ecdsa_bug`&
16165 .next
16166 &`single_dh_use`&
16167 .next
16168 &`single_ecdh_use`&
16169 .next
16170 &`ssleay_080_client_dh_bug`&
16171 .next
16172 &`sslref2_reuse_cert_type_bug`&
16173 .next
16174 &`tls_block_padding_bug`&
16175 .next
16176 &`tls_d5_bug`&
16177 .next
16178 &`tls_rollback_bug`&
16179 .endlist
16180
16181 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16182 all clients connecting using the MacOS SecureTransport TLS facility prior
16183 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16184 to negotiate TLS then this option value might help, provided that your OpenSSL
16185 release is new enough to contain this work-around.  This may be a situation
16186 where you have to upgrade OpenSSL to get buggy clients working.
16187
16188
16189 .option oracle_servers main "string list" unset
16190 .cindex "Oracle" "server list"
16191 This option provides a list of Oracle servers and associated connection data,
16192 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16193 The option is available only if Exim has been built with Oracle support.
16194
16195
16196 .option percent_hack_domains main "domain list&!!" unset
16197 .cindex "&""percent hack""&"
16198 .cindex "source routing" "in email address"
16199 .cindex "address" "source-routed"
16200 The &"percent hack"& is the convention whereby a local part containing a
16201 percent sign is re-interpreted as a new email address, with the percent
16202 replaced by @. This is sometimes called &"source routing"&, though that term is
16203 also applied to RFC 2822 addresses that begin with an @ character. If this
16204 option is set, Exim implements the percent facility for those domains listed,
16205 but no others. This happens before an incoming SMTP address is tested against
16206 an ACL.
16207
16208 &*Warning*&: The &"percent hack"& has often been abused by people who are
16209 trying to get round relaying restrictions. For this reason, it is best avoided
16210 if at all possible. Unfortunately, a number of less security-conscious MTAs
16211 implement it unconditionally. If you are running Exim on a gateway host, and
16212 routing mail through to internal MTAs without processing the local parts, it is
16213 a good idea to reject recipient addresses with percent characters in their
16214 local parts. Exim's default configuration does this.
16215
16216
16217 .option perl_at_start main boolean false
16218 .cindex "Perl"
16219 This option is available only when Exim is built with an embedded Perl
16220 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16221
16222
16223 .option perl_startup main string unset
16224 .cindex "Perl"
16225 This option is available only when Exim is built with an embedded Perl
16226 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16227
16228 .option perl_startup main boolean false
16229 .cindex "Perl"
16230 This Option enables the taint mode of the embedded Perl interpreter.
16231
16232
16233 .option pgsql_servers main "string list" unset
16234 .cindex "PostgreSQL lookup type" "server list"
16235 This option provides a list of PostgreSQL servers and associated connection
16236 data, to be used in conjunction with &(pgsql)& lookups (see section
16237 &<<SECID72>>&). The option is available only if Exim has been built with
16238 PostgreSQL support.
16239
16240
16241 .option pid_file_path main string&!! "set at compile time"
16242 .cindex "daemon" "pid file path"
16243 .cindex "pid file, path for"
16244 This option sets the name of the file to which the Exim daemon writes its
16245 process id. The string is expanded, so it can contain, for example, references
16246 to the host name:
16247 .code
16248 pid_file_path = /var/log/$primary_hostname/exim.pid
16249 .endd
16250 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16251 spool directory.
16252 The value set by the option can be overridden by the &%-oP%& command line
16253 option. A pid file is not written if a &"non-standard"& daemon is run by means
16254 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16255
16256
16257 .option pipelining_advertise_hosts main "host list&!!" *
16258 .cindex "PIPELINING" "suppressing advertising"
16259 This option can be used to suppress the advertisement of the SMTP
16260 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16261 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16262 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16263 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16264 that clients will use it; &"out of order"& commands that are &"expected"& do
16265 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16266
16267
16268 .option prdr_enable main boolean false
16269 .cindex "PRDR" "enabling on server"
16270 This option can be used to enable the Per-Recipient Data Response extension
16271 to SMTP, defined by Eric Hall.
16272 If the option is set, PRDR is advertised by Exim when operating as a server.
16273 If the client requests PRDR, and more than one recipient, for a message
16274 an additional ACL is called for each recipient after the message content
16275 is received.  See section &<<SECTPRDRACL>>&.
16276
16277 .option preserve_message_logs main boolean false
16278 .cindex "message logs" "preserving"
16279 If this option is set, message log files are not deleted when messages are
16280 completed. Instead, they are moved to a sub-directory of the spool directory
16281 called &_msglog.OLD_&, where they remain available for statistical or debugging
16282 purposes. This is a dangerous option to set on systems with any appreciable
16283 volume of mail. Use with care!
16284
16285
16286 .option primary_hostname main string "see below"
16287 .cindex "name" "of local host"
16288 .cindex "host" "name of local"
16289 .cindex "local host" "name of"
16290 .vindex "&$primary_hostname$&"
16291 This specifies the name of the current host. It is used in the default EHLO or
16292 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16293 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16294 The value is also used by default in some SMTP response messages from an Exim
16295 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16296
16297 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16298 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16299 contains only one component, Exim passes it to &[gethostbyname()]& (or
16300 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16301 version. The variable &$primary_hostname$& contains the host name, whether set
16302 explicitly by this option, or defaulted.
16303
16304
16305 .option print_topbitchars main boolean false
16306 .cindex "printing characters"
16307 .cindex "8-bit characters"
16308 By default, Exim considers only those characters whose codes lie in the range
16309 32&--126 to be printing characters. In a number of circumstances (for example,
16310 when writing log entries) non-printing characters are converted into escape
16311 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16312 is set, code values of 128 and above are also considered to be printing
16313 characters.
16314
16315 This option also affects the header syntax checks performed by the
16316 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16317 the user's full name when constructing From: and Sender: addresses (as
16318 described in section &<<SECTconstr>>&). Setting this option can cause
16319 Exim to generate eight bit message headers that do not conform to the
16320 standards.
16321
16322
16323 .option process_log_path main string unset
16324 .cindex "process log path"
16325 .cindex "log" "process log"
16326 .cindex "&'exiwhat'&"
16327 This option sets the name of the file to which an Exim process writes its
16328 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16329 utility script. If this option is unset, the file called &_exim-process.info_&
16330 in Exim's spool directory is used. The ability to specify the name explicitly
16331 can be useful in environments where two different Exims are running, using
16332 different spool directories.
16333
16334
16335 .option prod_requires_admin main boolean true
16336 .cindex "restricting access to features"
16337 .oindex "&%-M%&"
16338 .oindex "&%-R%&"
16339 .oindex "&%-q%&"
16340 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16341 admin user unless &%prod_requires_admin%& is set false. See also
16342 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16343
16344
16345 .option qualify_domain main string "see below"
16346 .cindex "domain" "for qualifying addresses"
16347 .cindex "address" "qualification"
16348 This option specifies the domain name that is added to any envelope sender
16349 addresses that do not have a domain qualification. It also applies to
16350 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16351 are accepted by default only for locally-generated messages. Qualification is
16352 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16353 locally-generated messages, unless the &%-bnq%& command line option is used.
16354
16355 Messages from external sources must always contain fully qualified addresses,
16356 unless the sending host matches &%sender_unqualified_hosts%& or
16357 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16358 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16359 necessary. Internally, Exim always works with fully qualified envelope
16360 addresses. If &%qualify_domain%& is not set, it defaults to the
16361 &%primary_hostname%& value.
16362
16363
16364 .option qualify_recipient main string "see below"
16365 This option allows you to specify a different domain for qualifying recipient
16366 addresses to the one that is used for senders. See &%qualify_domain%& above.
16367
16368
16369
16370 .option queue_domains main "domain list&!!" unset
16371 .cindex "domain" "specifying non-immediate delivery"
16372 .cindex "queueing incoming messages"
16373 .cindex "message" "queueing certain domains"
16374 This option lists domains for which immediate delivery is not required.
16375 A delivery process is started whenever a message is received, but only those
16376 domains that do not match are processed. All other deliveries wait until the
16377 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16378
16379
16380 .option queue_list_requires_admin main boolean true
16381 .cindex "restricting access to features"
16382 .oindex "&%-bp%&"
16383 The &%-bp%& command-line option, which lists the messages that are on the
16384 queue, requires the caller to be an admin user unless
16385 &%queue_list_requires_admin%& is set false.
16386 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16387
16388
16389 .option queue_only main boolean false
16390 .cindex "queueing incoming messages"
16391 .cindex "message" "queueing unconditionally"
16392 If &%queue_only%& is set, a delivery process is not automatically started
16393 whenever a message is received. Instead, the message waits on the queue for the
16394 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16395 delivered immediately when certain conditions (such as heavy load) occur.
16396
16397 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16398 and &%-odi%& command line options override &%queue_only%& unless
16399 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16400 &%queue_only_load%&, and &%smtp_accept_queue%&.
16401
16402
16403 .option queue_only_file main string unset
16404 .cindex "queueing incoming messages"
16405 .cindex "message" "queueing by file existence"
16406 This option can be set to a colon-separated list of absolute path names, each
16407 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16408 it tests for the existence of each listed path using a call to &[stat()]&. For
16409 each path that exists, the corresponding queueing option is set.
16410 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16411 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16412 .code
16413 queue_only_file = smtp/some/file
16414 .endd
16415 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16416 &_/some/file_& exists.
16417
16418
16419 .option queue_only_load main fixed-point unset
16420 .cindex "load average"
16421 .cindex "queueing incoming messages"
16422 .cindex "message" "queueing by load"
16423 If the system load average is higher than this value, incoming messages from
16424 all sources are queued, and no automatic deliveries are started. If this
16425 happens during local or remote SMTP input, all subsequent messages received on
16426 the same SMTP connection are queued by default, whatever happens to the load in
16427 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16428 false.
16429
16430 Deliveries will subsequently be performed by queue runner processes. This
16431 option has no effect on ancient operating systems on which Exim cannot
16432 determine the load average. See also &%deliver_queue_load_max%& and
16433 &%smtp_load_reserve%&.
16434
16435
16436 .option queue_only_load_latch main boolean true
16437 .cindex "load average" "re-evaluating per message"
16438 When this option is true (the default), once one message has been queued
16439 because the load average is higher than the value set by &%queue_only_load%&,
16440 all subsequent messages received on the same SMTP connection are also queued.
16441 This is a deliberate choice; even though the load average may fall below the
16442 threshold, it doesn't seem right to deliver later messages on the same
16443 connection when not delivering earlier ones. However, there are special
16444 circumstances such as very long-lived connections from scanning appliances
16445 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16446 should be set false. This causes the value of the load average to be
16447 re-evaluated for each message.
16448
16449
16450 .option queue_only_override main boolean true
16451 .cindex "queueing incoming messages"
16452 When this option is true, the &%-od%&&'x'& command line options override the
16453 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16454 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16455 to override; they are accepted, but ignored.
16456
16457
16458 .option queue_run_in_order main boolean false
16459 .cindex "queue runner" "processing messages in order"
16460 If this option is set, queue runs happen in order of message arrival instead of
16461 in an arbitrary order. For this to happen, a complete list of the entire queue
16462 must be set up before the deliveries start. When the queue is all held in a
16463 single directory (the default), a single list is created for both the ordered
16464 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16465 single list is not created when &%queue_run_in_order%& is false. In this case,
16466 the sub-directories are processed one at a time (in a random order), and this
16467 avoids setting up one huge list for the whole queue. Thus, setting
16468 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16469 when the queue is large, because of the extra work in setting up the single,
16470 large list. In most situations, &%queue_run_in_order%& should not be set.
16471
16472
16473
16474 .option queue_run_max main integer&!! 5
16475 .cindex "queue runner" "maximum number of"
16476 This controls the maximum number of queue runner processes that an Exim daemon
16477 can run simultaneously. This does not mean that it starts them all at once,
16478 but rather that if the maximum number are still running when the time comes to
16479 start another one, it refrains from starting another one. This can happen with
16480 very large queues and/or very sluggish deliveries. This option does not,
16481 however, interlock with other processes, so additional queue runners can be
16482 started by other means, or by killing and restarting the daemon.
16483
16484 Setting this option to zero does not suppress queue runs; rather, it disables
16485 the limit, allowing any number of simultaneous queue runner processes to be
16486 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16487 the daemon's command line.
16488
16489 .cindex queues named
16490 .cindex "named queues"
16491 To set limits for different named queues use
16492 an expansion depending on the &$queue_name$& variable.
16493
16494 .option queue_smtp_domains main "domain list&!!" unset
16495 .cindex "queueing incoming messages"
16496 .cindex "message" "queueing remote deliveries"
16497 When this option is set, a delivery process is started whenever a message is
16498 received, routing is performed, and local deliveries take place.
16499 However, if any SMTP deliveries are required for domains that match
16500 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16501 message waits on the queue for the next queue run. Since routing of the message
16502 has taken place, Exim knows to which remote hosts it must be delivered, and so
16503 when the queue run happens, multiple messages for the same host are delivered
16504 over a single SMTP connection. The &%-odqs%& command line option causes all
16505 SMTP deliveries to be queued in this way, and is equivalent to setting
16506 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16507 &%queue_domains%&.
16508
16509
16510 .option receive_timeout main time 0s
16511 .cindex "timeout" "for non-SMTP input"
16512 This option sets the timeout for accepting a non-SMTP message, that is, the
16513 maximum time that Exim waits when reading a message on the standard input. If
16514 the value is zero, it will wait for ever. This setting is overridden by the
16515 &%-or%& command line option. The timeout for incoming SMTP messages is
16516 controlled by &%smtp_receive_timeout%&.
16517
16518 .option received_header_text main string&!! "see below"
16519 .cindex "customizing" "&'Received:'& header"
16520 .cindex "&'Received:'& header line" "customizing"
16521 This string defines the contents of the &'Received:'& message header that is
16522 added to each message, except for the timestamp, which is automatically added
16523 on at the end (preceded by a semicolon). The string is expanded each time it is
16524 used. If the expansion yields an empty string, no &'Received:'& header line is
16525 added to the message. Otherwise, the string should start with the text
16526 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16527 header lines. The default setting is:
16528
16529 .code
16530 received_header_text = Received: \
16531   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16532   {${if def:sender_ident \
16533   {from ${quote_local_part:$sender_ident} }}\
16534   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16535   by $primary_hostname \
16536   ${if def:received_protocol {with $received_protocol}} \
16537   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16538   (Exim $version_number)\n\t\
16539   ${if def:sender_address \
16540   {(envelope-from <$sender_address>)\n\t}}\
16541   id $message_exim_id\
16542   ${if def:received_for {\n\tfor $received_for}}
16543 .endd
16544
16545 The reference to the TLS cipher is omitted when Exim is built without TLS
16546 support. The use of conditional expansions ensures that this works for both
16547 locally generated messages and messages received from remote hosts, giving
16548 header lines such as the following:
16549 .code
16550 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16551 by marley.carol.example with esmtp (Exim 4.00)
16552 (envelope-from <bob@carol.example>)
16553 id 16IOWa-00019l-00
16554 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16555 Received: by scrooge.carol.example with local (Exim 4.00)
16556 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16557 .endd
16558 Until the body of the message has been received, the timestamp is the time when
16559 the message started to be received. Once the body has arrived, and all policy
16560 checks have taken place, the timestamp is updated to the time at which the
16561 message was accepted.
16562
16563
16564 .option received_headers_max main integer 30
16565 .cindex "loop" "prevention"
16566 .cindex "mail loop prevention"
16567 .cindex "&'Received:'& header line" "counting"
16568 When a message is to be delivered, the number of &'Received:'& headers is
16569 counted, and if it is greater than this parameter, a mail loop is assumed to
16570 have occurred, the delivery is abandoned, and an error message is generated.
16571 This applies to both local and remote deliveries.
16572
16573
16574 .option recipient_unqualified_hosts main "host list&!!" unset
16575 .cindex "unqualified addresses"
16576 .cindex "host" "unqualified addresses from"
16577 This option lists those hosts from which Exim is prepared to accept unqualified
16578 recipient addresses in message envelopes. The addresses are made fully
16579 qualified by the addition of the &%qualify_recipient%& value. This option also
16580 affects message header lines. Exim does not reject unqualified recipient
16581 addresses in headers, but it qualifies them only if the message came from a
16582 host that matches &%recipient_unqualified_hosts%&,
16583 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16584 option was not set.
16585
16586
16587 .option recipients_max main integer 0
16588 .cindex "limit" "number of recipients"
16589 .cindex "recipient" "maximum number"
16590 If this option is set greater than zero, it specifies the maximum number of
16591 original recipients for any message. Additional recipients that are generated
16592 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16593 all recipients over the limit; earlier recipients are delivered as normal.
16594 Non-SMTP messages with too many recipients are failed, and no deliveries are
16595 done.
16596
16597 .cindex "RCPT" "maximum number of incoming"
16598 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16599 RCPT commands in a single message.
16600
16601
16602 .option recipients_max_reject main boolean false
16603 If this option is set true, Exim rejects SMTP messages containing too many
16604 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16605 error to the eventual DATA command. Otherwise (the default) it gives a 452
16606 error to the surplus RCPT commands and accepts the message on behalf of the
16607 initial set of recipients. The remote server should then re-send the message
16608 for the remaining recipients at a later time.
16609
16610
16611 .option remote_max_parallel main integer 2
16612 .cindex "delivery" "parallelism for remote"
16613 This option controls parallel delivery of one message to a number of remote
16614 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16615 does all the remote deliveries for a message one by one. Otherwise, if a single
16616 message has to be delivered to more than one remote host, or if several copies
16617 have to be sent to the same remote host, up to &%remote_max_parallel%&
16618 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16619 deliveries are required, the maximum number of processes are started, and as
16620 each one finishes, another is begun. The order of starting processes is the
16621 same as if sequential delivery were being done, and can be controlled by the
16622 &%remote_sort_domains%& option. If parallel delivery takes place while running
16623 with debugging turned on, the debugging output from each delivery process is
16624 tagged with its process id.
16625
16626 This option controls only the maximum number of parallel deliveries for one
16627 message in one Exim delivery process. Because Exim has no central queue
16628 manager, there is no way of controlling the total number of simultaneous
16629 deliveries if the configuration allows a delivery attempt as soon as a message
16630 is received.
16631
16632 .cindex "number of deliveries"
16633 .cindex "delivery" "maximum number of"
16634 If you want to control the total number of deliveries on the system, you
16635 need to set the &%queue_only%& option. This ensures that all incoming messages
16636 are added to the queue without starting a delivery process. Then set up an Exim
16637 daemon to start queue runner processes at appropriate intervals (probably
16638 fairly often, for example, every minute), and limit the total number of queue
16639 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16640 delivers only one message at a time, the maximum number of deliveries that can
16641 then take place at once is &%queue_run_max%& multiplied by
16642 &%remote_max_parallel%&.
16643
16644 If it is purely remote deliveries you want to control, use
16645 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16646 doing the SMTP routing before queueing, so that several messages for the same
16647 host will eventually get delivered down the same connection.
16648
16649
16650 .option remote_sort_domains main "domain list&!!" unset
16651 .cindex "sorting remote deliveries"
16652 .cindex "delivery" "sorting remote"
16653 When there are a number of remote deliveries for a message, they are sorted by
16654 domain into the order given by this list. For example,
16655 .code
16656 remote_sort_domains = *.cam.ac.uk:*.uk
16657 .endd
16658 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16659 then to those in the &%uk%& domain, then to any others.
16660
16661
16662 .option retry_data_expire main time 7d
16663 .cindex "hints database" "data expiry"
16664 This option sets a &"use before"& time on retry information in Exim's hints
16665 database. Any older retry data is ignored. This means that, for example, once a
16666 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16667 past failures.
16668
16669
16670 .option retry_interval_max main time 24h
16671 .cindex "retry" "limit on interval"
16672 .cindex "limit" "on retry interval"
16673 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16674 intervals between delivery attempts for messages that cannot be delivered
16675 straight away. This option sets an overall limit to the length of time between
16676 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16677 the default value.
16678
16679
16680 .option return_path_remove main boolean true
16681 .cindex "&'Return-path:'& header line" "removing"
16682 RFC 2821, section 4.4, states that an SMTP server must insert a
16683 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16684 The &'Return-path:'& header preserves the sender address as received in the
16685 MAIL command. This description implies that this header should not be present
16686 in an incoming message. If &%return_path_remove%& is true, any existing
16687 &'Return-path:'& headers are removed from messages at the time they are
16688 received. Exim's transports have options for adding &'Return-path:'& headers at
16689 the time of delivery. They are normally used only for final local deliveries.
16690
16691
16692 .option return_size_limit main integer 100K
16693 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16694
16695
16696 .option rfc1413_hosts main "host list&!!" @[]
16697 .cindex "RFC 1413"
16698 .cindex "host" "for RFC 1413 calls"
16699 RFC 1413 identification calls are made to any client host which matches
16700 an item in the list.
16701 The default value specifies just this host, being any local interface
16702 for the system.
16703
16704 .option rfc1413_query_timeout main time 0s
16705 .cindex "RFC 1413" "query timeout"
16706 .cindex "timeout" "for RFC 1413 call"
16707 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16708 no RFC 1413 calls are ever made.
16709
16710
16711 .option sender_unqualified_hosts main "host list&!!" unset
16712 .cindex "unqualified addresses"
16713 .cindex "host" "unqualified addresses from"
16714 This option lists those hosts from which Exim is prepared to accept unqualified
16715 sender addresses. The addresses are made fully qualified by the addition of
16716 &%qualify_domain%&. This option also affects message header lines. Exim does
16717 not reject unqualified addresses in headers that contain sender addresses, but
16718 it qualifies them only if the message came from a host that matches
16719 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16720 using TCP/IP), and the &%-bnq%& option was not set.
16721
16722 .option set_environment main "string list" empty
16723 .cindex "environment"
16724 This option allows to set individual environment variables that the
16725 currently linked libraries and programs in child processes use. The
16726 default list is empty,
16727
16728
16729 .option slow_lookup_log main integer 0
16730 .cindex "logging" "slow lookups"
16731 .cindex "dns" "logging slow lookups"
16732 This option controls logging of slow lookups.
16733 If the value is nonzero it is taken as a number of milliseconds
16734 and lookups taking longer than this are logged.
16735 Currently this applies only to DNS lookups.
16736
16737
16738
16739 .option smtp_accept_keepalive main boolean true
16740 .cindex "keepalive" "on incoming connection"
16741 This option controls the setting of the SO_KEEPALIVE option on incoming
16742 TCP/IP socket connections. When set, it causes the kernel to probe idle
16743 connections periodically, by sending packets with &"old"& sequence numbers. The
16744 other end of the connection should send an acknowledgment if the connection is
16745 still okay or a reset if the connection has been aborted. The reason for doing
16746 this is that it has the beneficial effect of freeing up certain types of
16747 connection that can get stuck when the remote host is disconnected without
16748 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16749 hours to detect unreachable hosts.
16750
16751
16752
16753 .option smtp_accept_max main integer 20
16754 .cindex "limit" "incoming SMTP connections"
16755 .cindex "SMTP" "incoming connection count"
16756 .cindex "inetd"
16757 This option specifies the maximum number of simultaneous incoming SMTP calls
16758 that Exim will accept. It applies only to the listening daemon; there is no
16759 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16760 value is set to zero, no limit is applied. However, it is required to be
16761 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16762 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16763
16764 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16765 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16766 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16767 and &%smtp_load_reserve%& are then checked before accepting the connection.
16768
16769
16770 .option smtp_accept_max_nonmail main integer 10
16771 .cindex "limit" "non-mail SMTP commands"
16772 .cindex "SMTP" "limiting non-mail commands"
16773 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16774 the connection if there are too many. This option defines &"too many"&. The
16775 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16776 client looping sending EHLO, for example. The check is applied only if the
16777 client host matches &%smtp_accept_max_nonmail_hosts%&.
16778
16779 When a new message is expected, one occurrence of RSET is not counted. This
16780 allows a client to send one RSET between messages (this is not necessary,
16781 but some clients do it). Exim also allows one uncounted occurrence of HELO
16782 or EHLO, and one occurrence of STARTTLS between messages. After
16783 starting up a TLS session, another EHLO is expected, and so it too is not
16784 counted. The first occurrence of AUTH in a connection, or immediately
16785 following STARTTLS is not counted. Otherwise, all commands other than
16786 MAIL, RCPT, DATA, and QUIT are counted.
16787
16788
16789 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16790 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16791 check by setting this option. The default value makes it apply to all hosts. By
16792 changing the value, you can exclude any badly-behaved hosts that you have to
16793 live with.
16794
16795
16796 . Allow this long option name to split; give it unsplit as a fifth argument
16797 . for the automatic .oindex that is generated by .option.
16798 . We insert " &~&~" which is both pretty nasty visually and results in
16799 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16800 . zero-width-space, which would be nicer visually and results in (at least)
16801 . html that Firefox will split on when it's forced to reflow (rather than
16802 . inserting a horizontal scrollbar).  However, the text is still not
16803 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16804 . the option name to split.
16805
16806 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16807          smtp_accept_max_per_connection
16808 .cindex "SMTP" "limiting incoming message count"
16809 .cindex "limit" "messages per SMTP connection"
16810 The value of this option limits the number of MAIL commands that Exim is
16811 prepared to accept over a single SMTP connection, whether or not each command
16812 results in the transfer of a message. After the limit is reached, a 421
16813 response is given to subsequent MAIL commands. This limit is a safety
16814 precaution against a client that goes mad (incidents of this type have been
16815 seen).
16816
16817
16818 .option smtp_accept_max_per_host main string&!! unset
16819 .cindex "limit" "SMTP connections from one host"
16820 .cindex "host" "limiting SMTP connections from"
16821 This option restricts the number of simultaneous IP connections from a single
16822 host (strictly, from a single IP address) to the Exim daemon. The option is
16823 expanded, to enable different limits to be applied to different hosts by
16824 reference to &$sender_host_address$&. Once the limit is reached, additional
16825 connection attempts from the same host are rejected with error code 421. This
16826 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16827 of zero imposes no limit. If this option is set greater than zero, it is
16828 required that &%smtp_accept_max%& be non-zero.
16829
16830 &*Warning*&: When setting this option you should not use any expansion
16831 constructions that take an appreciable amount of time. The expansion and test
16832 happen in the main daemon loop, in order to reject additional connections
16833 without forking additional processes (otherwise a denial-of-service attack
16834 could cause a vast number or processes to be created). While the daemon is
16835 doing this processing, it cannot accept any other incoming connections.
16836
16837
16838
16839 .option smtp_accept_queue main integer 0
16840 .cindex "SMTP" "incoming connection count"
16841 .cindex "queueing incoming messages"
16842 .cindex "message" "queueing by SMTP connection count"
16843 If the number of simultaneous incoming SMTP connections being handled via the
16844 listening daemon exceeds this value, messages received by SMTP are just placed
16845 on the queue; no delivery processes are started automatically. The count is
16846 fixed at the start of an SMTP connection. It cannot be updated in the
16847 subprocess that receives messages, and so the queueing or not queueing applies
16848 to all messages received in the same connection.
16849
16850 A value of zero implies no limit, and clearly any non-zero value is useful only
16851 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16852 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16853 various &%-od%&&'x'& command line options.
16854
16855
16856 . See the comment on smtp_accept_max_per_connection
16857
16858 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16859          smtp_accept_queue_per_connection
16860 .cindex "queueing incoming messages"
16861 .cindex "message" "queueing by message count"
16862 This option limits the number of delivery processes that Exim starts
16863 automatically when receiving messages via SMTP, whether via the daemon or by
16864 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16865 and the number of messages received in a single SMTP session exceeds this
16866 number, subsequent messages are placed on the queue, but no delivery processes
16867 are started. This helps to limit the number of Exim processes when a server
16868 restarts after downtime and there is a lot of mail waiting for it on other
16869 systems. On large systems, the default should probably be increased, and on
16870 dial-in client systems it should probably be set to zero (that is, disabled).
16871
16872
16873 .option smtp_accept_reserve main integer 0
16874 .cindex "SMTP" "incoming call count"
16875 .cindex "host" "reserved"
16876 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16877 number of SMTP connections that are reserved for connections from the hosts
16878 that are specified in &%smtp_reserve_hosts%&. The value set in
16879 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16880 restricted to this number of connections; the option specifies a minimum number
16881 of connection slots for them, not a maximum. It is a guarantee that this group
16882 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16883 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16884 individual host.
16885
16886 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16887 set to 5, once there are 45 active connections (from any hosts), new
16888 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16889 provided the other criteria for acceptance are met.
16890
16891
16892 .option smtp_active_hostname main string&!! unset
16893 .cindex "host" "name in SMTP responses"
16894 .cindex "SMTP" "host name in responses"
16895 .vindex "&$primary_hostname$&"
16896 This option is provided for multi-homed servers that want to masquerade as
16897 several different hosts. At the start of an incoming SMTP connection, its value
16898 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16899 responses. For example, it is used as domain name in the response to an
16900 incoming HELO or EHLO command.
16901
16902 .vindex "&$smtp_active_hostname$&"
16903 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16904 is saved with any messages that are received. It is therefore available for use
16905 in routers and transports when the message is later delivered.
16906
16907 If this option is unset, or if its expansion is forced to fail, or if the
16908 expansion results in an empty string, the value of &$primary_hostname$& is
16909 used. Other expansion failures cause a message to be written to the main and
16910 panic logs, and the SMTP command receives a temporary error. Typically, the
16911 value of &%smtp_active_hostname%& depends on the incoming interface address.
16912 For example:
16913 .code
16914 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16915   {cox.mydomain}{box.mydomain}}
16916 .endd
16917
16918 Although &$smtp_active_hostname$& is primarily concerned with incoming
16919 messages, it is also used as the default for HELO commands in callout
16920 verification if there is no remote transport from which to obtain a
16921 &%helo_data%& value.
16922
16923 .option smtp_banner main string&!! "see below"
16924 .cindex "SMTP" "welcome banner"
16925 .cindex "banner for SMTP"
16926 .cindex "welcome banner for SMTP"
16927 .cindex "customizing" "SMTP banner"
16928 This string, which is expanded every time it is used, is output as the initial
16929 positive response to an SMTP connection. The default setting is:
16930 .code
16931 smtp_banner = $smtp_active_hostname ESMTP Exim \
16932   $version_number $tod_full
16933 .endd
16934 Failure to expand the string causes a panic error. If you want to create a
16935 multiline response to the initial SMTP connection, use &"\n"& in the string at
16936 appropriate points, but not at the end. Note that the 220 code is not included
16937 in this string. Exim adds it automatically (several times in the case of a
16938 multiline response).
16939
16940
16941 .option smtp_check_spool_space main boolean true
16942 .cindex "checking disk space"
16943 .cindex "disk space, checking"
16944 .cindex "spool directory" "checking space"
16945 When this option is set, if an incoming SMTP session encounters the SIZE
16946 option on a MAIL command, it checks that there is enough space in the
16947 spool directory's partition to accept a message of that size, while still
16948 leaving free the amount specified by &%check_spool_space%& (even if that value
16949 is zero). If there isn't enough space, a temporary error code is returned.
16950
16951
16952 .option smtp_connect_backlog main integer 20
16953 .cindex "connection backlog"
16954 .cindex "SMTP" "connection backlog"
16955 .cindex "backlog of connections"
16956 This option specifies a maximum number of waiting SMTP connections. Exim passes
16957 this value to the TCP/IP system when it sets up its listener. Once this number
16958 of connections are waiting for the daemon's attention, subsequent connection
16959 attempts are refused at the TCP/IP level. At least, that is what the manuals
16960 say; in some circumstances such connection attempts have been observed to time
16961 out instead. For large systems it is probably a good idea to increase the
16962 value (to 50, say). It also gives some protection against denial-of-service
16963 attacks by SYN flooding.
16964
16965
16966 .option smtp_enforce_sync main boolean true
16967 .cindex "SMTP" "synchronization checking"
16968 .cindex "synchronization checking in SMTP"
16969 The SMTP protocol specification requires the client to wait for a response from
16970 the server at certain points in the dialogue. Without PIPELINING these
16971 synchronization points are after every command; with PIPELINING they are
16972 fewer, but they still exist.
16973
16974 Some spamming sites send out a complete set of SMTP commands without waiting
16975 for any response. Exim protects against this by rejecting a message if the
16976 client has sent further input when it should not have. The error response &"554
16977 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16978 for this error cannot be perfect because of transmission delays (unexpected
16979 input may be on its way but not yet received when Exim checks). However, it
16980 does detect many instances.
16981
16982 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16983 If you want to disable the check selectively (for example, only for certain
16984 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16985 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16986
16987
16988
16989 .option smtp_etrn_command main string&!! unset
16990 .cindex "ETRN" "command to be run"
16991 .vindex "&$domain$&"
16992 If this option is set, the given command is run whenever an SMTP ETRN
16993 command is received from a host that is permitted to issue such commands (see
16994 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16995 are independently expanded. The expansion variable &$domain$& is set to the
16996 argument of the ETRN command, and no syntax checking is done on it. For
16997 example:
16998 .code
16999 smtp_etrn_command = /etc/etrn_command $domain \
17000                     $sender_host_address
17001 .endd
17002 A new process is created to run the command, but Exim does not wait for it to
17003 complete. Consequently, its status cannot be checked. If the command cannot be
17004 run, a line is written to the panic log, but the ETRN caller still receives
17005 a 250 success response. Exim is normally running under its own uid when
17006 receiving SMTP, so it is not possible for it to change the uid before running
17007 the command.
17008
17009
17010 .option smtp_etrn_serialize main boolean true
17011 .cindex "ETRN" "serializing"
17012 When this option is set, it prevents the simultaneous execution of more than
17013 one identical command as a result of ETRN in an SMTP connection. See
17014 section &<<SECTETRN>>& for details.
17015
17016
17017 .option smtp_load_reserve main fixed-point unset
17018 .cindex "load average"
17019 If the system load average ever gets higher than this, incoming SMTP calls are
17020 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17021 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17022 the load is over the limit. The option has no effect on ancient operating
17023 systems on which Exim cannot determine the load average. See also
17024 &%deliver_queue_load_max%& and &%queue_only_load%&.
17025
17026
17027
17028 .option smtp_max_synprot_errors main integer 3
17029 .cindex "SMTP" "limiting syntax and protocol errors"
17030 .cindex "limit" "SMTP syntax and protocol errors"
17031 Exim rejects SMTP commands that contain syntax or protocol errors. In
17032 particular, a syntactically invalid email address, as in this command:
17033 .code
17034 RCPT TO:<abc xyz@a.b.c>
17035 .endd
17036 causes immediate rejection of the command, before any other tests are done.
17037 (The ACL cannot be run if there is no valid address to set up for it.) An
17038 example of a protocol error is receiving RCPT before MAIL. If there are
17039 too many syntax or protocol errors in one SMTP session, the connection is
17040 dropped. The limit is set by this option.
17041
17042 .cindex "PIPELINING" "expected errors"
17043 When the PIPELINING extension to SMTP is in use, some protocol errors are
17044 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17045 Exim assumes that PIPELINING will be used if it advertises it (see
17046 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17047 not count towards the limit.
17048
17049
17050
17051 .option smtp_max_unknown_commands main integer 3
17052 .cindex "SMTP" "limiting unknown commands"
17053 .cindex "limit" "unknown SMTP commands"
17054 If there are too many unrecognized commands in an incoming SMTP session, an
17055 Exim server drops the connection. This is a defence against some kinds of abuse
17056 that subvert web
17057 clients
17058 into making connections to SMTP ports; in these circumstances, a number of
17059 non-SMTP command lines are sent first.
17060
17061
17062
17063 .option smtp_ratelimit_hosts main "host list&!!" unset
17064 .cindex "SMTP" "rate limiting"
17065 .cindex "limit" "rate of message arrival"
17066 .cindex "RCPT" "rate limiting"
17067 Some sites find it helpful to be able to limit the rate at which certain hosts
17068 can send them messages, and the rate at which an individual message can specify
17069 recipients.
17070
17071 Exim has two rate-limiting facilities. This section describes the older
17072 facility, which can limit rates within a single connection. The newer
17073 &%ratelimit%& ACL condition can limit rates across all connections. See section
17074 &<<SECTratelimiting>>& for details of the newer facility.
17075
17076 When a host matches &%smtp_ratelimit_hosts%&, the values of
17077 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17078 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17079 respectively. Each option, if set, must contain a set of four comma-separated
17080 values:
17081
17082 .ilist
17083 A threshold, before which there is no rate limiting.
17084 .next
17085 An initial time delay. Unlike other times in Exim, numbers with decimal
17086 fractional parts are allowed here.
17087 .next
17088 A factor by which to increase the delay each time.
17089 .next
17090 A maximum value for the delay. This should normally be less than 5 minutes,
17091 because after that time, the client is liable to timeout the SMTP command.
17092 .endlist
17093
17094 For example, these settings have been used successfully at the site which
17095 first suggested this feature, for controlling mail from their customers:
17096 .code
17097 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17098 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17099 .endd
17100 The first setting specifies delays that are applied to MAIL commands after
17101 two have been received over a single connection. The initial delay is 0.5
17102 seconds, increasing by a factor of 1.05 each time. The second setting applies
17103 delays to RCPT commands when more than four occur in a single message.
17104
17105
17106 .option smtp_ratelimit_mail main string unset
17107 See &%smtp_ratelimit_hosts%& above.
17108
17109
17110 .option smtp_ratelimit_rcpt main string unset
17111 See &%smtp_ratelimit_hosts%& above.
17112
17113
17114 .option smtp_receive_timeout main time&!! 5m
17115 .cindex "timeout" "for SMTP input"
17116 .cindex "SMTP" "input timeout"
17117 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17118 input, including batch SMTP. If a line of input (either an SMTP command or a
17119 data line) is not received within this time, the SMTP connection is dropped and
17120 the message is abandoned.
17121 A line is written to the log containing one of the following messages:
17122 .code
17123 SMTP command timeout on connection from...
17124 SMTP data timeout on connection from...
17125 .endd
17126 The former means that Exim was expecting to read an SMTP command; the latter
17127 means that it was in the DATA phase, reading the contents of a message.
17128
17129 If the first character of the option is a &"$"& the option is
17130 expanded before use and may depend on
17131 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17132
17133
17134 .oindex "&%-os%&"
17135 The value set by this option can be overridden by the
17136 &%-os%& command-line option. A setting of zero time disables the timeout, but
17137 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17138 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17139 timeout is controlled by &%receive_timeout%& and &%-or%&.
17140
17141
17142 .option smtp_reserve_hosts main "host list&!!" unset
17143 This option defines hosts for which SMTP connections are reserved; see
17144 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17145
17146
17147 .option smtp_return_error_details main boolean false
17148 .cindex "SMTP" "details policy failures"
17149 .cindex "policy control" "rejection, returning details"
17150 In the default state, Exim uses bland messages such as
17151 &"Administrative prohibition"& when it rejects SMTP commands for policy
17152 reasons. Many sysadmins like this because it gives away little information
17153 to spammers. However, some other sysadmins who are applying strict checking
17154 policies want to give out much fuller information about failures. Setting
17155 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17156 example, instead of &"Administrative prohibition"&, it might give:
17157 .code
17158 550-Rejected after DATA: '>' missing at end of address:
17159 550 failing address in "From" header is: <user@dom.ain
17160 .endd
17161
17162
17163 .option smtputf8_advertise_hosts main "host list&!!" *
17164 .cindex "SMTPUTF8" "advertising"
17165 When Exim is built with support for internationalised mail names,
17166 the availability thereof is advertised in
17167 response to EHLO only to those client hosts that match this option. See
17168 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17169
17170
17171 .option spamd_address main string "127.0.0.1 783"
17172 This option is available when Exim is compiled with the content-scanning
17173 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17174 See section &<<SECTscanspamass>>& for more details.
17175
17176
17177
17178 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17179 This option is available when Exim is compiled with SPF support.
17180 See section &<<SECSPF>>& for more details.
17181
17182
17183
17184 .option split_spool_directory main boolean false
17185 .cindex "multiple spool directories"
17186 .cindex "spool directory" "split"
17187 .cindex "directories, multiple"
17188 If this option is set, it causes Exim to split its input directory into 62
17189 subdirectories, each with a single alphanumeric character as its name. The
17190 sixth character of the message id is used to allocate messages to
17191 subdirectories; this is the least significant base-62 digit of the time of
17192 arrival of the message.
17193
17194 Splitting up the spool in this way may provide better performance on systems
17195 where there are long mail queues, by reducing the number of files in any one
17196 directory. The msglog directory is also split up in a similar way to the input
17197 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17198 are still placed in the single directory &_msglog.OLD_&.
17199
17200 It is not necessary to take any special action for existing messages when
17201 changing &%split_spool_directory%&. Exim notices messages that are in the
17202 &"wrong"& place, and continues to process them. If the option is turned off
17203 after a period of being on, the subdirectories will eventually empty and be
17204 automatically deleted.
17205
17206 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17207 changes. Instead of creating a list of all messages in the queue, and then
17208 trying to deliver each one in turn, it constructs a list of those in one
17209 sub-directory and tries to deliver them, before moving on to the next
17210 sub-directory. The sub-directories are processed in a random order. This
17211 spreads out the scanning of the input directories, and uses less memory. It is
17212 particularly beneficial when there are lots of messages on the queue. However,
17213 if &%queue_run_in_order%& is set, none of this new processing happens. The
17214 entire queue has to be scanned and sorted before any deliveries can start.
17215
17216
17217 .option spool_directory main string&!! "set at compile time"
17218 .cindex "spool directory" "path to"
17219 This defines the directory in which Exim keeps its spool, that is, the messages
17220 it is waiting to deliver. The default value is taken from the compile-time
17221 configuration setting, if there is one. If not, this option must be set. The
17222 string is expanded, so it can contain, for example, a reference to
17223 &$primary_hostname$&.
17224
17225 If the spool directory name is fixed on your installation, it is recommended
17226 that you set it at build time rather than from this option, particularly if the
17227 log files are being written to the spool directory (see &%log_file_path%&).
17228 Otherwise log files cannot be used for errors that are detected early on, such
17229 as failures in the configuration file.
17230
17231 By using this option to override the compiled-in path, it is possible to run
17232 tests of Exim without using the standard spool.
17233
17234 .option spool_wireformat main boolean false
17235 .cindex "spool directory" "file formats"
17236 If this option is set, Exim may for some messages use an alternative format
17237 for data-files in the spool which matches the wire format.
17238 Doing this permits more efficient message reception and transmission.
17239 Currently it is only done for messages received using the ESMTP CHUNKING
17240 option.
17241
17242 The following variables will not have useful values:
17243 .code
17244 $max_received_linelength
17245 $body_linecount
17246 $body_zerocount
17247 .endd
17248
17249 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17250 and any external programs which are passed a reference to a message data file
17251 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17252 will need to be aware of the different formats potentially available.
17253
17254 Using any of the ACL conditions noted will negate the reception benefit
17255 (as a Unix-mbox-format file is constructed for them).
17256 The transmission benefit is maintained.
17257
17258 .option sqlite_lock_timeout main time 5s
17259 .cindex "sqlite lookup type" "lock timeout"
17260 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17261 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17262
17263 .option strict_acl_vars main boolean false
17264 .cindex "&ACL;" "variables, handling unset"
17265 This option controls what happens if a syntactically valid but undefined ACL
17266 variable is referenced. If it is false (the default), an empty string
17267 is substituted; if it is true, an error is generated. See section
17268 &<<SECTaclvariables>>& for details of ACL variables.
17269
17270 .option strip_excess_angle_brackets main boolean false
17271 .cindex "angle brackets, excess"
17272 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17273 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17274 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17275 passed on to another MTA, the excess angle brackets are not passed on. If this
17276 option is not set, multiple pairs of angle brackets cause a syntax error.
17277
17278
17279 .option strip_trailing_dot main boolean false
17280 .cindex "trailing dot on domain"
17281 .cindex "dot" "trailing on domain"
17282 If this option is set, a trailing dot at the end of a domain in an address is
17283 ignored. If this is in the envelope and the message is passed on to another
17284 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17285 domain causes a syntax error.
17286 However, addresses in header lines are checked only when an ACL requests header
17287 syntax checking.
17288
17289
17290 .option syslog_duplication main boolean true
17291 .cindex "syslog" "duplicate log lines; suppressing"
17292 When Exim is logging to syslog, it writes the log lines for its three
17293 separate logs at different syslog priorities so that they can in principle
17294 be separated on the logging hosts. Some installations do not require this
17295 separation, and in those cases, the duplication of certain log lines is a
17296 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17297 particular log line is written to syslog. For lines that normally go to
17298 both the main log and the reject log, the reject log version (possibly
17299 containing message header lines) is written, at LOG_NOTICE priority.
17300 Lines that normally go to both the main and the panic log are written at
17301 the LOG_ALERT priority.
17302
17303
17304 .option syslog_facility main string unset
17305 .cindex "syslog" "facility; setting"
17306 This option sets the syslog &"facility"& name, used when Exim is logging to
17307 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17308 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17309 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17310 details of Exim's logging.
17311
17312
17313 .option syslog_pid main boolean true
17314 .cindex "syslog" "pid"
17315 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17316 omitted when these lines are sent to syslog. (Syslog normally prefixes
17317 the log lines with the PID of the logging process automatically.) You need
17318 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17319 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17320
17321
17322
17323 .option syslog_processname main string &`exim`&
17324 .cindex "syslog" "process name; setting"
17325 This option sets the syslog &"ident"& name, used when Exim is logging to
17326 syslog. The value must be no longer than 32 characters. See chapter
17327 &<<CHAPlog>>& for details of Exim's logging.
17328
17329
17330
17331 .option syslog_timestamp main boolean true
17332 .cindex "syslog" "timestamps"
17333 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17334 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17335 details of Exim's logging.
17336
17337
17338 .option system_filter main string&!! unset
17339 .cindex "filter" "system filter"
17340 .cindex "system filter" "specifying"
17341 .cindex "Sieve filter" "not available for system filter"
17342 This option specifies an Exim filter file that is applied to all messages at
17343 the start of each delivery attempt, before any routing is done. System filters
17344 must be Exim filters; they cannot be Sieve filters. If the system filter
17345 generates any deliveries to files or pipes, or any new mail messages, the
17346 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17347 which transports are to be used. Details of this facility are given in chapter
17348 &<<CHAPsystemfilter>>&.
17349 A forced expansion failure results in no filter operation.
17350
17351
17352 .option system_filter_directory_transport main string&!! unset
17353 .vindex "&$address_file$&"
17354 This sets the name of the transport driver that is to be used when the
17355 &%save%& command in a system message filter specifies a path ending in &"/"&,
17356 implying delivery of each message into a separate file in some directory.
17357 During the delivery, the variable &$address_file$& contains the path name.
17358
17359
17360 .option system_filter_file_transport main string&!! unset
17361 .cindex "file" "transport for system filter"
17362 This sets the name of the transport driver that is to be used when the &%save%&
17363 command in a system message filter specifies a path not ending in &"/"&. During
17364 the delivery, the variable &$address_file$& contains the path name.
17365
17366 .option system_filter_group main string unset
17367 .cindex "gid (group id)" "system filter"
17368 This option is used only when &%system_filter_user%& is also set. It sets the
17369 gid under which the system filter is run, overriding any gid that is associated
17370 with the user. The value may be numerical or symbolic.
17371
17372 .option system_filter_pipe_transport main string&!! unset
17373 .cindex "&(pipe)& transport" "for system filter"
17374 .vindex "&$address_pipe$&"
17375 This specifies the transport driver that is to be used when a &%pipe%& command
17376 is used in a system filter. During the delivery, the variable &$address_pipe$&
17377 contains the pipe command.
17378
17379
17380 .option system_filter_reply_transport main string&!! unset
17381 .cindex "&(autoreply)& transport" "for system filter"
17382 This specifies the transport driver that is to be used when a &%mail%& command
17383 is used in a system filter.
17384
17385
17386 .option system_filter_user main string unset
17387 .cindex "uid (user id)" "system filter"
17388 If this option is set to root, the system filter is run in the main Exim
17389 delivery process, as root.  Otherwise, the system filter runs in a separate
17390 process, as the given user, defaulting to the Exim run-time user.
17391 Unless the string consists entirely of digits, it
17392 is looked up in the password data. Failure to find the named user causes a
17393 configuration error. The gid is either taken from the password data, or
17394 specified by &%system_filter_group%&. When the uid is specified numerically,
17395 &%system_filter_group%& is required to be set.
17396
17397 If the system filter generates any pipe, file, or reply deliveries, the uid
17398 under which the filter is run is used when transporting them, unless a
17399 transport option overrides.
17400
17401
17402 .option tcp_nodelay main boolean true
17403 .cindex "daemon" "TCP_NODELAY on sockets"
17404 .cindex "Nagle algorithm"
17405 .cindex "TCP_NODELAY on listening sockets"
17406 If this option is set false, it stops the Exim daemon setting the
17407 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17408 turns off the &"Nagle algorithm"&, which is a way of improving network
17409 performance in interactive (character-by-character) situations. Turning it off
17410 should improve Exim's performance a bit, so that is what happens by default.
17411 However, it appears that some broken clients cannot cope, and time out. Hence
17412 this option. It affects only those sockets that are set up for listening by the
17413 daemon. Sockets created by the smtp transport for delivering mail always set
17414 TCP_NODELAY.
17415
17416
17417 .option timeout_frozen_after main time 0s
17418 .cindex "frozen messages" "timing out"
17419 .cindex "timeout" "frozen messages"
17420 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17421 message of any kind that has been on the queue for longer than the given time
17422 is automatically cancelled at the next queue run. If the frozen message is a
17423 bounce message, it is just discarded; otherwise, a bounce is sent to the
17424 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17425 If you want to timeout frozen bounce messages earlier than other kinds of
17426 frozen message, see &%ignore_bounce_errors_after%&.
17427
17428 &*Note:*& the default value of zero means no timeouts; with this setting,
17429 frozen messages remain on the queue forever (except for any frozen bounce
17430 messages that are released by &%ignore_bounce_errors_after%&).
17431
17432
17433 .option timezone main string unset
17434 .cindex "timezone, setting"
17435 .cindex "environment" "values from"
17436 The value of &%timezone%& is used to set the environment variable TZ while
17437 running Exim (if it is different on entry). This ensures that all timestamps
17438 created by Exim are in the required timezone. If you want all your timestamps
17439 to be in UTC (aka GMT) you should set
17440 .code
17441 timezone = UTC
17442 .endd
17443 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17444 or, if that is not set, from the value of the TZ environment variable when Exim
17445 is built. If &%timezone%& is set to the empty string, either at build or run
17446 time, any existing TZ variable is removed from the environment when Exim
17447 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17448 unfortunately not all, operating systems.
17449
17450
17451 .option tls_advertise_hosts main "host list&!!" *
17452 .cindex "TLS" "advertising"
17453 .cindex "encryption" "on SMTP connection"
17454 .cindex "SMTP" "encrypted connection"
17455 When Exim is built with support for TLS encrypted connections, the availability
17456 of the STARTTLS command to set up an encrypted session is advertised in
17457 response to EHLO only to those client hosts that match this option. See
17458 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17459 Note that the default value requires that a certificate be supplied
17460 using the &%tls_certificate%& option.  If TLS support for incoming connections
17461 is not required the &%tls_advertise_hosts%& option should be set empty.
17462
17463
17464 .option tls_certificate main string list&!! unset
17465 .cindex "TLS" "server certificate; location of"
17466 .cindex "certificate" "server, location of"
17467 The value of this option is expanded, and must then be a list of absolute paths to
17468 files which contains the server's certificates.  Commonly only one file is
17469 needed.
17470 The server's private key is also
17471 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17472 &<<CHAPTLS>>& for further details.
17473
17474 &*Note*&: The certificates defined by this option are used only when Exim is
17475 receiving incoming messages as a server. If you want to supply certificates for
17476 use when sending messages as a client, you must set the &%tls_certificate%&
17477 option in the relevant &(smtp)& transport.
17478
17479 &*Note*&: If you use filenames based on IP addresses, change the list
17480 separator in the usual way to avoid confusion under IPv6.
17481
17482 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17483 when a list of more than one
17484 file is used, the &$tls_in_ourcert$& variable is unreliable.
17485
17486 &*Note*&: OCSP stapling is not usable under OpenSSL
17487 when a list of more than one file is used.
17488
17489 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17490 if the OpenSSL build supports TLS extensions and the TLS client sends the
17491 Server Name Indication extension, then this option and others documented in
17492 &<<SECTtlssni>>& will be re-expanded.
17493
17494 If this option is unset or empty a fresh self-signed certificate will be
17495 generated for every connection.
17496
17497 .option tls_crl main string&!! unset
17498 .cindex "TLS" "server certificate revocation list"
17499 .cindex "certificate" "revocation list for server"
17500 This option specifies a certificate revocation list. The expanded value must
17501 be the name of a file that contains CRLs in PEM format.
17502
17503 Under OpenSSL the option can specify a directory with CRL files.
17504
17505 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17506 for each signing element of the certificate chain (i.e. all but the leaf).
17507 For the file variant this can be multiple PEM blocks in the one file.
17508
17509 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17510
17511
17512 .option tls_dh_max_bits main integer 2236
17513 .cindex "TLS" "D-H bit count"
17514 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17515 the chosen TLS library.  That value might prove to be too high for
17516 interoperability.  This option provides a maximum clamp on the value
17517 suggested, trading off security for interoperability.
17518
17519 The value must be at least 1024.
17520
17521 The value 2236 was chosen because, at time of adding the option, it was the
17522 hard-coded maximum value supported by the NSS cryptographic library, as used
17523 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17524
17525 If you prefer more security and are willing to break some clients, raise this
17526 number.
17527
17528 Note that the value passed to GnuTLS for *generating* a new prime may be a
17529 little less than this figure, because GnuTLS is inexact and may produce a
17530 larger prime than requested.
17531
17532
17533 .option tls_dhparam main string&!! unset
17534 .cindex "TLS" "D-H parameters for server"
17535 The value of this option is expanded and indicates the source of DH parameters
17536 to be used by Exim.
17537
17538 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17539 local DH parameters*&, which has been supported across all versions of Exim.  The
17540 other specific constants available are a fallback so that even when
17541 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17542
17543 If &%tls_dhparam%& is a filename starting with a &`/`&,
17544 then it names a file from which DH
17545 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17546 PKCS#3 representation of the DH prime.  If the file does not exist, for
17547 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17548 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17549 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17550 and treated as though the &%tls_dhparam%& were set to "none".
17551
17552 If this option expands to the string "none", then no DH parameters will be
17553 loaded by Exim.
17554
17555 If this option expands to the string "historic" and Exim is using GnuTLS, then
17556 Exim will attempt to load a file from inside the spool directory.  If the file
17557 does not exist, Exim will attempt to create it.
17558 See section &<<SECTgnutlsparam>>& for further details.
17559
17560 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17561 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17562
17563 In older versions of Exim the default was the 2048 bit prime described in section
17564 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17565 in IKE is assigned number 23.
17566
17567 Otherwise, the option must expand to the name used by Exim for any of a number
17568 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17569 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17570 the number used by IKE, or "default" which corresponds to
17571 &`exim.dev.20160529.3`&.
17572
17573 The available standard primes are:
17574 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17575 &`ike1`&, &`ike2`&, &`ike5`&,
17576 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17577 &`ike22`&, &`ike23`& and &`ike24`&.
17578
17579 The available additional primes are:
17580 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17581
17582 Some of these will be too small to be accepted by clients.
17583 Some may be too large to be accepted by clients.
17584 The open cryptographic community has suspicions about the integrity of some
17585 of the later IKE values, which led into RFC7919 providing new fixed constants
17586 (the "ffdhe" identifiers).
17587
17588 At this point, all of the "ike" values should be considered obsolete;
17589 they're still in Exim to avoid breaking unusual configurations, but are
17590 candidates for removal the next time we have backwards-incompatible changes.
17591
17592 The TLS protocol does not negotiate an acceptable size for this; clients tend
17593 to hard-drop connections if what is offered by the server is unacceptable,
17594 whether too large or too small, and there's no provision for the client to
17595 tell the server what these constraints are.  Thus, as a server operator, you
17596 need to make an educated guess as to what is most likely to work for your
17597 userbase.
17598
17599 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17600 is most likely to maximise interoperability.  The upper bound comes from
17601 applications using the Mozilla Network Security Services (NSS) library, which
17602 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17603 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17604 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17605 acceptable bound from 1024 to 2048.
17606
17607
17608 .option tls_eccurve main string&!! &`auto`&
17609 .cindex TLS "EC cryptography"
17610 This option selects a EC curve for use by Exim when used with OpenSSL.
17611 It has no effect when Exim is used with GnuTLS.
17612
17613 After expansion it must contain a valid EC curve parameter, such as
17614 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17615 for valid selections.
17616
17617 For OpenSSL versions before (and not including) 1.0.2, the string
17618 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17619 &`auto`& tells the library to choose.
17620
17621 If the option expands to an empty string, no EC curves will be enabled.
17622
17623
17624 .option tls_ocsp_file main string&!! unset
17625 .cindex TLS "certificate status"
17626 .cindex TLS "OCSP proof file"
17627 This option
17628 must if set expand to the absolute path to a file which contains a current
17629 status proof for the server's certificate, as obtained from the
17630 Certificate Authority.
17631
17632 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17633
17634 For GnuTLS 3.5.6 or later the expanded value of this option can be a list
17635 of files, to match a list given for the &%tls_certificate%& option.
17636 The ordering of the two lists must match.
17637
17638
17639 .option tls_on_connect_ports main "string list" unset
17640 .cindex SSMTP
17641 .cindex SMTPS
17642 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17643 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17644 set up without waiting for the client to issue a STARTTLS command. For
17645 further details, see section &<<SECTsupobssmt>>&.
17646
17647
17648
17649 .option tls_privatekey main string list&!! unset
17650 .cindex "TLS" "server private key; location of"
17651 The value of this option is expanded, and must then be a list of absolute paths to
17652 files which contains the server's private keys.
17653 If this option is unset, or if
17654 the expansion is forced to fail, or the result is an empty string, the private
17655 key is assumed to be in the same file as the server's certificates. See chapter
17656 &<<CHAPTLS>>& for further details.
17657
17658 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17659
17660
17661 .option tls_remember_esmtp main boolean false
17662 .cindex "TLS" "esmtp state; remembering"
17663 .cindex "TLS" "broken clients"
17664 If this option is set true, Exim violates the RFCs by remembering that it is in
17665 &"esmtp"& state after successfully negotiating a TLS session. This provides
17666 support for broken clients that fail to send a new EHLO after starting a
17667 TLS session.
17668
17669
17670 .option tls_require_ciphers main string&!! unset
17671 .cindex "TLS" "requiring specific ciphers"
17672 .cindex "cipher" "requiring specific"
17673 This option controls which ciphers can be used for incoming TLS connections.
17674 The &(smtp)& transport has an option of the same name for controlling outgoing
17675 connections. This option is expanded for each connection, so can be varied for
17676 different clients if required. The value of this option must be a list of
17677 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17678 in somewhat different ways. If GnuTLS is being used, the client controls the
17679 preference order of the available ciphers. Details are given in sections
17680 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17681
17682
17683 .option tls_try_verify_hosts main "host list&!!" unset
17684 .cindex "TLS" "client certificate verification"
17685 .cindex "certificate" "verification of client"
17686 See &%tls_verify_hosts%& below.
17687
17688
17689 .option tls_verify_certificates main string&!! system
17690 .cindex "TLS" "client certificate verification"
17691 .cindex "certificate" "verification of client"
17692 The value of this option is expanded, and must then be either the
17693 word "system"
17694 or the absolute path to
17695 a file or directory containing permitted certificates for clients that
17696 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17697
17698 The "system" value for the option will use a
17699 system default location compiled into the SSL library.
17700 This is not available for GnuTLS versions preceding 3.0.20,
17701 and will be taken as empty; an explicit location
17702 must be specified.
17703
17704 The use of a directory for the option value is not available for GnuTLS versions
17705 preceding 3.3.6 and a single file must be used.
17706
17707 With OpenSSL the certificates specified
17708 explicitly
17709 either by file or directory
17710 are added to those given by the system default location.
17711
17712 These certificates should be for the certificate authorities trusted, rather
17713 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17714 the value is a file then the certificates are sent by Exim as a server to
17715 connecting clients, defining the list of accepted certificate authorities.
17716 Thus the values defined should be considered public data.  To avoid this,
17717 use the explicit directory version.
17718
17719 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17720
17721 A forced expansion failure or setting to an empty string is equivalent to
17722 being unset.
17723
17724
17725 .option tls_verify_hosts main "host list&!!" unset
17726 .cindex "TLS" "client certificate verification"
17727 .cindex "certificate" "verification of client"
17728 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17729 certificates from clients. The expected certificates are defined by
17730 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17731 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17732 &%tls_verify_certificates%& is not set.
17733
17734 Any client that matches &%tls_verify_hosts%& is constrained by
17735 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17736 present one of the listed certificates. If it does not, the connection is
17737 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17738 the host to use TLS. It can still send SMTP commands through unencrypted
17739 connections. Forcing a client to use TLS has to be done separately using an
17740 ACL to reject inappropriate commands when the connection is not encrypted.
17741
17742 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17743 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17744 certificate and checks it against &%tls_verify_certificates%&, but does not
17745 abort the connection if there is no certificate or if it does not match. This
17746 state can be detected in an ACL, which makes it possible to implement policies
17747 such as &"accept for relay only if a verified certificate has been received,
17748 but accept for local delivery if encrypted, even without a verified
17749 certificate"&.
17750
17751 Client hosts that match neither of these lists are not asked to present
17752 certificates.
17753
17754
17755 .option trusted_groups main "string list&!!" unset
17756 .cindex "trusted groups"
17757 .cindex "groups" "trusted"
17758 This option is expanded just once, at the start of Exim's processing. If this
17759 option is set, any process that is running in one of the listed groups, or
17760 which has one of them as a supplementary group, is trusted. The groups can be
17761 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17762 details of what trusted callers are permitted to do. If neither
17763 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17764 are trusted.
17765
17766 .option trusted_users main "string list&!!" unset
17767 .cindex "trusted users"
17768 .cindex "user" "trusted"
17769 This option is expanded just once, at the start of Exim's processing. If this
17770 option is set, any process that is running as one of the listed users is
17771 trusted. The users can be specified numerically or by name. See section
17772 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17773 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17774 Exim user are trusted.
17775
17776 .option unknown_login main string&!! unset
17777 .cindex "uid (user id)" "unknown caller"
17778 .vindex "&$caller_uid$&"
17779 This is a specialized feature for use in unusual configurations. By default, if
17780 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17781 gives up. The &%unknown_login%& option can be used to set a login name to be
17782 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17783 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17784 is used for the user's real name (gecos field), unless this has been set by the
17785 &%-F%& option.
17786
17787 .option unknown_username main string unset
17788 See &%unknown_login%&.
17789
17790 .option untrusted_set_sender main "address list&!!" unset
17791 .cindex "trusted users"
17792 .cindex "sender" "setting by untrusted user"
17793 .cindex "untrusted user setting sender"
17794 .cindex "user" "untrusted setting sender"
17795 .cindex "envelope sender"
17796 When an untrusted user submits a message to Exim using the standard input, Exim
17797 normally creates an envelope sender address from the user's login and the
17798 default qualification domain. Data from the &%-f%& option (for setting envelope
17799 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17800 is used) is ignored.
17801
17802 However, untrusted users are permitted to set an empty envelope sender address,
17803 to declare that a message should never generate any bounces. For example:
17804 .code
17805 exim -f '<>' user@domain.example
17806 .endd
17807 .vindex "&$sender_ident$&"
17808 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17809 other envelope sender addresses in a controlled way. When it is set, untrusted
17810 users are allowed to set envelope sender addresses that match any of the
17811 patterns in the list. Like all address lists, the string is expanded. The
17812 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17813 users to setting senders that start with their login ids
17814 followed by a hyphen
17815 by a setting like this:
17816 .code
17817 untrusted_set_sender = ^$sender_ident-
17818 .endd
17819 If you want to allow untrusted users to set envelope sender addresses without
17820 restriction, you can use
17821 .code
17822 untrusted_set_sender = *
17823 .endd
17824 The &%untrusted_set_sender%& option applies to all forms of local input, but
17825 only to the setting of the envelope sender. It does not permit untrusted users
17826 to use the other options which trusted user can use to override message
17827 parameters. Furthermore, it does not stop Exim from removing an existing
17828 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17829 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17830 overriding these actions. The handling of the &'Sender:'& header is also
17831 described in section &<<SECTthesenhea>>&.
17832
17833 The log line for a message's arrival shows the envelope sender following
17834 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17835 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17836 envelope sender address, the user's login is shown in parentheses after the
17837 sender address.
17838
17839
17840 .option uucp_from_pattern main string "see below"
17841 .cindex "&""From""& line"
17842 .cindex "UUCP" "&""From""& line"
17843 Some applications that pass messages to an MTA via a command line interface use
17844 an initial line starting with &"From&~"& to pass the envelope sender. In
17845 particular, this is used by UUCP software. Exim recognizes such a line by means
17846 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17847 matches, the sender address is constructed by expanding the contents of
17848 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17849 default pattern recognizes lines in the following two forms:
17850 .code
17851 From ph10 Fri Jan  5 12:35 GMT 1996
17852 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17853 .endd
17854 The pattern can be seen by running
17855 .code
17856 exim -bP uucp_from_pattern
17857 .endd
17858 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17859 year in the second case. The first word after &"From&~"& is matched in the
17860 regular expression by a parenthesized subpattern. The default value for
17861 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17862 (&"ph10"& in the example above) as the message's sender. See also
17863 &%ignore_fromline_hosts%&.
17864
17865
17866 .option uucp_from_sender main string&!! &`$1`&
17867 See &%uucp_from_pattern%& above.
17868
17869
17870 .option warn_message_file main string unset
17871 .cindex "warning of delay" "customizing the message"
17872 .cindex "customizing" "warning message"
17873 This option defines a template file containing paragraphs of text to be used
17874 for constructing the warning message which is sent by Exim when a message has
17875 been on the queue for a specified amount of time, as specified by
17876 &%delay_warning%&. Details of the file's contents are given in chapter
17877 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17878
17879
17880 .option write_rejectlog main boolean true
17881 .cindex "reject log" "disabling"
17882 If this option is set false, Exim no longer writes anything to the reject log.
17883 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17884 .ecindex IIDconfima
17885 .ecindex IIDmaiconf
17886
17887
17888
17889
17890 . ////////////////////////////////////////////////////////////////////////////
17891 . ////////////////////////////////////////////////////////////////////////////
17892
17893 .chapter "Generic options for routers" "CHAProutergeneric"
17894 .scindex IIDgenoprou1 "options" "generic; for routers"
17895 .scindex IIDgenoprou2 "generic options" "router"
17896 This chapter describes the generic options that apply to all routers.
17897 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17898
17899 For a general description of how a router operates, see sections
17900 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17901 which the preconditions are tested. The order of expansion of the options that
17902 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17903 &%headers_remove%&, &%transport%&.
17904
17905
17906
17907 .option address_data routers string&!! unset
17908 .cindex "router" "data attached to address"
17909 The string is expanded just before the router is run, that is, after all the
17910 precondition tests have succeeded. If the expansion is forced to fail, the
17911 router declines, the value of &%address_data%& remains unchanged, and the
17912 &%more%& option controls what happens next. Other expansion failures cause
17913 delivery of the address to be deferred.
17914
17915 .vindex "&$address_data$&"
17916 When the expansion succeeds, the value is retained with the address, and can be
17917 accessed using the variable &$address_data$& in the current router, subsequent
17918 routers, and the eventual transport.
17919
17920 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17921 that runs a user's filter file, the contents of &$address_data$& are accessible
17922 in the filter. This is not normally a problem, because such data is usually
17923 either not confidential or it &"belongs"& to the current user, but if you do
17924 put confidential data into &$address_data$& you need to remember this point.
17925
17926 Even if the router declines or passes, the value of &$address_data$& remains
17927 with the address, though it can be changed by another &%address_data%& setting
17928 on a subsequent router. If a router generates child addresses, the value of
17929 &$address_data$& propagates to them. This also applies to the special kind of
17930 &"child"& that is generated by a router with the &%unseen%& option.
17931
17932 The idea of &%address_data%& is that you can use it to look up a lot of data
17933 for the address once, and then pick out parts of the data later. For example,
17934 you could use a single LDAP lookup to return a string of the form
17935 .code
17936 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17937 .endd
17938 In the transport you could pick out the mailbox by a setting such as
17939 .code
17940 file = ${extract{mailbox}{$address_data}}
17941 .endd
17942 This makes the configuration file less messy, and also reduces the number of
17943 lookups (though Exim does cache lookups).
17944
17945 .vindex "&$sender_address_data$&"
17946 .vindex "&$address_data$&"
17947 The &%address_data%& facility is also useful as a means of passing information
17948 from one router to another, and from a router to a transport. In addition, if
17949 &$address_data$& is set by a router when verifying a recipient address from an
17950 ACL, it remains available for use in the rest of the ACL statement. After
17951 verifying a sender, the value is transferred to &$sender_address_data$&.
17952
17953
17954
17955 .option address_test routers&!? boolean true
17956 .oindex "&%-bt%&"
17957 .cindex "router" "skipping when address testing"
17958 If this option is set false, the router is skipped when routing is being tested
17959 by means of the &%-bt%& command line option. This can be a convenience when
17960 your first router sends messages to an external scanner, because it saves you
17961 having to set the &"already scanned"& indicator when testing real address
17962 routing.
17963
17964
17965
17966 .option cannot_route_message routers string&!! unset
17967 .cindex "router" "customizing &""cannot route""& message"
17968 .cindex "customizing" "&""cannot route""& message"
17969 This option specifies a text message that is used when an address cannot be
17970 routed because Exim has run out of routers. The default message is
17971 &"Unrouteable address"&. This option is useful only on routers that have
17972 &%more%& set false, or on the very last router in a configuration, because the
17973 value that is used is taken from the last router that is considered. This
17974 includes a router that is skipped because its preconditions are not met, as
17975 well as a router that declines. For example, using the default configuration,
17976 you could put:
17977 .code
17978 cannot_route_message = Remote domain not found in DNS
17979 .endd
17980 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17981 and
17982 .code
17983 cannot_route_message = Unknown local user
17984 .endd
17985 on the final router that checks for local users. If string expansion fails for
17986 this option, the default message is used. Unless the expansion failure was
17987 explicitly forced, a message about the failure is written to the main and panic
17988 logs, in addition to the normal message about the routing failure.
17989
17990
17991 .option caseful_local_part routers boolean false
17992 .cindex "case of local parts"
17993 .cindex "router" "case of local parts"
17994 By default, routers handle the local parts of addresses in a case-insensitive
17995 manner, though the actual case is preserved for transmission with the message.
17996 If you want the case of letters to be significant in a router, you must set
17997 this option true. For individual router options that contain address or local
17998 part lists (for example, &%local_parts%&), case-sensitive matching can be
17999 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18000 more details.
18001
18002 .vindex "&$local_part$&"
18003 .vindex "&$original_local_part$&"
18004 .vindex "&$parent_local_part$&"
18005 The value of the &$local_part$& variable is forced to lower case while a
18006 router is running unless &%caseful_local_part%& is set. When a router assigns
18007 an address to a transport, the value of &$local_part$& when the transport runs
18008 is the same as it was in the router. Similarly, when a router generates child
18009 addresses by aliasing or forwarding, the values of &$original_local_part$&
18010 and &$parent_local_part$& are those that were used by the redirecting router.
18011
18012 This option applies to the processing of an address by a router. When a
18013 recipient address is being processed in an ACL, there is a separate &%control%&
18014 modifier that can be used to specify case-sensitive processing within the ACL
18015 (see section &<<SECTcontrols>>&).
18016
18017
18018
18019 .option check_local_user routers&!? boolean false
18020 .cindex "local user, checking in router"
18021 .cindex "router" "checking for local user"
18022 .cindex "&_/etc/passwd_&"
18023 .vindex "&$home$&"
18024 When this option is true, Exim checks that the local part of the recipient
18025 address (with affixes removed if relevant) is the name of an account on the
18026 local system. The check is done by calling the &[getpwnam()]& function rather
18027 than trying to read &_/etc/passwd_& directly. This means that other methods of
18028 holding password data (such as NIS) are supported. If the local part is a local
18029 user, &$home$& is set from the password data, and can be tested in other
18030 preconditions that are evaluated after this one (the order of evaluation is
18031 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18032 overridden by &%router_home_directory%&. If the local part is not a local user,
18033 the router is skipped.
18034
18035 If you want to check that the local part is either the name of a local user
18036 or matches something else, you cannot combine &%check_local_user%& with a
18037 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18038 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18039 setting to achieve this. For example:
18040 .code
18041 local_parts = passwd;$local_part : lsearch;/etc/other/users
18042 .endd
18043 Note, however, that the side effects of &%check_local_user%& (such as setting
18044 up a home directory) do not occur when a &(passwd)& lookup is used in a
18045 &%local_parts%& (or any other) precondition.
18046
18047
18048
18049 .option condition routers&!? string&!! unset
18050 .cindex "router" "customized precondition"
18051 This option specifies a general precondition test that has to succeed for the
18052 router to be called. The &%condition%& option is the last precondition to be
18053 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18054 result is a forced failure, or an empty string, or one of the strings &"0"& or
18055 &"no"& or &"false"& (checked without regard to the case of the letters), the
18056 router is skipped, and the address is offered to the next one.
18057
18058 If the result is any other value, the router is run (as this is the last
18059 precondition to be evaluated, all the other preconditions must be true).
18060
18061 This option is unusual in that multiple &%condition%& options may be present.
18062 All &%condition%& options must succeed.
18063
18064 The &%condition%& option provides a means of applying custom conditions to the
18065 running of routers. Note that in the case of a simple conditional expansion,
18066 the default expansion values are exactly what is wanted. For example:
18067 .code
18068 condition = ${if >{$message_age}{600}}
18069 .endd
18070 Because of the default behaviour of the string expansion, this is equivalent to
18071 .code
18072 condition = ${if >{$message_age}{600}{true}{}}
18073 .endd
18074
18075 A multiple condition example, which succeeds:
18076 .code
18077 condition = ${if >{$message_age}{600}}
18078 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18079 condition = foobar
18080 .endd
18081
18082 If the expansion fails (other than forced failure) delivery is deferred. Some
18083 of the other precondition options are common special cases that could in fact
18084 be specified using &%condition%&.
18085
18086 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18087 are far older, and use one set of semantics.  ACLs are newer and when
18088 they were created, the ACL &%condition%& process was given far stricter
18089 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18090 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18091 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18092 Router rules processing behavior.
18093
18094 This is best illustrated in an example:
18095 .code
18096 # If used in an ACL condition will fail with a syntax error, but
18097 # in a router condition any extra characters are treated as a string
18098
18099 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18100 true {yes} {no}}
18101
18102 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18103  {yes} {no}}
18104 .endd
18105 In each example above, the &%if%& statement actually ends after
18106 &"{google.com}}"&.  Since no true or false braces were defined, the
18107 default &%if%& behavior is to return a boolean true or a null answer
18108 (which evaluates to false). The rest of the line is then treated as a
18109 string. So the first example resulted in the boolean answer &"true"&
18110 with the string &" {yes} {no}}"& appended to it. The second example
18111 resulted in the null output (indicating false) with the string
18112 &" {yes} {no}}"& appended to it.
18113
18114 In fact you can put excess forward braces in too.  In the router
18115 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18116 mean something, like after a &"$"& or when required as part of a
18117 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18118 string characters.
18119
18120 Thus, in a Router, the above expansion strings will both always evaluate
18121 true, as the result of expansion is a non-empty string which doesn't
18122 match an explicit false value.  This can be tricky to debug.  By
18123 contrast, in an ACL either of those strings will always result in an
18124 expansion error because the result doesn't look sufficiently boolean.
18125
18126
18127 .option debug_print routers string&!! unset
18128 .cindex "testing" "variables in drivers"
18129 If this option is set and debugging is enabled (see the &%-d%& command line
18130 option) or in address-testing mode (see the &%-bt%& command line option),
18131 the string is expanded and included in the debugging output.
18132 If expansion of the string fails, the error message is written to the debugging
18133 output, and Exim carries on processing.
18134 This option is provided to help with checking out the values of variables and
18135 so on when debugging router configurations. For example, if a &%condition%&
18136 option appears not to be working, &%debug_print%& can be used to output the
18137 variables it references. The output happens after checks for &%domains%&,
18138 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18139 are tested. A newline is added to the text if it does not end with one.
18140 The variable &$router_name$& contains the name of the router.
18141
18142
18143
18144 .option disable_logging routers boolean false
18145 If this option is set true, nothing is logged for any routing errors
18146 or for any deliveries caused by this router. You should not set this option
18147 unless you really, really know what you are doing. See also the generic
18148 transport option of the same name.
18149
18150 .option dnssec_request_domains routers "domain list&!!" unset
18151 .cindex "MX record" "security"
18152 .cindex "DNSSEC" "MX lookup"
18153 .cindex "security" "MX lookup"
18154 .cindex "DNS" "DNSSEC"
18155 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18156 the dnssec request bit set.
18157 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18158
18159 .option dnssec_require_domains routers "domain list&!!" unset
18160 .cindex "MX record" "security"
18161 .cindex "DNSSEC" "MX lookup"
18162 .cindex "security" "MX lookup"
18163 .cindex "DNS" "DNSSEC"
18164 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18165 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18166 (AD bit) set will be ignored and logged as a host-lookup failure.
18167 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18168
18169
18170 .option domains routers&!? "domain list&!!" unset
18171 .cindex "router" "restricting to specific domains"
18172 .vindex "&$domain_data$&"
18173 If this option is set, the router is skipped unless the current domain matches
18174 the list. If the match is achieved by means of a file lookup, the data that the
18175 lookup returned for the domain is placed in &$domain_data$& for use in string
18176 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18177 a list of the order in which preconditions are evaluated.
18178
18179
18180
18181 .option driver routers string unset
18182 This option must always be set. It specifies which of the available routers is
18183 to be used.
18184
18185
18186 .option dsn_lasthop routers boolean false
18187 .cindex "DSN" "success"
18188 .cindex "Delivery Status Notification" "success"
18189 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18190 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18191 instead send a success DSN as if the next hop does not support DSN.
18192 Not effective on redirect routers.
18193
18194
18195
18196 .option errors_to routers string&!! unset
18197 .cindex "envelope sender"
18198 .cindex "router" "changing address for errors"
18199 If a router successfully handles an address, it may assign the address to a
18200 transport for delivery or it may generate child addresses. In both cases, if
18201 there is a delivery problem during later processing, the resulting bounce
18202 message is sent to the address that results from expanding this string,
18203 provided that the address verifies successfully. The &%errors_to%& option is
18204 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18205
18206 The &%errors_to%& setting associated with an address can be overridden if it
18207 subsequently passes through other routers that have their own &%errors_to%&
18208 settings, or if the message is delivered by a transport with a &%return_path%&
18209 setting.
18210
18211 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18212 the expansion fails to verify, the errors address associated with the incoming
18213 address is used. At top level, this is the envelope sender. A non-forced
18214 expansion failure causes delivery to be deferred.
18215
18216 If an address for which &%errors_to%& has been set ends up being delivered over
18217 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18218 any bounces that are generated by other MTAs on the delivery route are also
18219 sent there. You can set &%errors_to%& to the empty string by either of these
18220 settings:
18221 .code
18222 errors_to =
18223 errors_to = ""
18224 .endd
18225 An expansion item that yields an empty string has the same effect. If you do
18226 this, a locally detected delivery error for addresses processed by this router
18227 no longer gives rise to a bounce message; the error is discarded. If the
18228 address is delivered to a remote host, the return path is set to &`<>`&, unless
18229 overridden by the &%return_path%& option on the transport.
18230
18231 .vindex "&$address_data$&"
18232 If for some reason you want to discard local errors, but use a non-empty
18233 MAIL command for remote delivery, you can preserve the original return
18234 path in &$address_data$& in the router, and reinstate it in the transport by
18235 setting &%return_path%&.
18236
18237 The most common use of &%errors_to%& is to direct mailing list bounces to the
18238 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18239 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18240
18241
18242
18243 .option expn routers&!? boolean true
18244 .cindex "address" "testing"
18245 .cindex "testing" "addresses"
18246 .cindex "EXPN" "router skipping"
18247 .cindex "router" "skipping for EXPN"
18248 If this option is turned off, the router is skipped when testing an address
18249 as a result of processing an SMTP EXPN command. You might, for example,
18250 want to turn it off on a router for users' &_.forward_& files, while leaving it
18251 on for the system alias file.
18252 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18253 are evaluated.
18254
18255 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18256 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18257 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18258
18259
18260
18261 .option fail_verify routers boolean false
18262 .cindex "router" "forcing verification failure"
18263 Setting this option has the effect of setting both &%fail_verify_sender%& and
18264 &%fail_verify_recipient%& to the same value.
18265
18266
18267
18268 .option fail_verify_recipient routers boolean false
18269 If this option is true and an address is accepted by this router when
18270 verifying a recipient, verification fails.
18271
18272
18273
18274 .option fail_verify_sender routers boolean false
18275 If this option is true and an address is accepted by this router when
18276 verifying a sender, verification fails.
18277
18278
18279
18280 .option fallback_hosts routers "string list" unset
18281 .cindex "router" "fallback hosts"
18282 .cindex "fallback" "hosts specified on router"
18283 String expansion is not applied to this option. The argument must be a
18284 colon-separated list of host names or IP addresses. The list separator can be
18285 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
18286 each name or address. In fact, the format of each item is exactly the same as
18287 defined for the list of hosts in a &(manualroute)& router (see section
18288 &<<SECTformatonehostitem>>&).
18289
18290 If a router queues an address for a remote transport, this host list is
18291 associated with the address, and used instead of the transport's fallback host
18292 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18293 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18294 transport for further details.
18295
18296
18297 .option group routers string&!! "see below"
18298 .cindex "gid (group id)" "local delivery"
18299 .cindex "local transports" "uid and gid"
18300 .cindex "transport" "local"
18301 .cindex "router" "setting group"
18302 When a router queues an address for a transport, and the transport does not
18303 specify a group, the group given here is used when running the delivery
18304 process.
18305 The group may be specified numerically or by name. If expansion fails, the
18306 error is logged and delivery is deferred.
18307 The default is unset, unless &%check_local_user%& is set, when the default
18308 is taken from the password information. See also &%initgroups%& and &%user%&
18309 and the discussion in chapter &<<CHAPenvironment>>&.
18310
18311
18312
18313 .option headers_add routers list&!! unset
18314 .cindex "header lines" "adding"
18315 .cindex "router" "adding header lines"
18316 This option specifies a list of text headers,
18317 newline-separated (by default, changeable in the usual way),
18318 that is associated with any addresses that are accepted by the router.
18319 Each item is separately expanded, at routing time.  However, this
18320 option has no effect when an address is just being verified. The way in which
18321 the text is used to add header lines at transport time is described in section
18322 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18323 message is in the process of being transported. This means that references to
18324 header lines in string expansions in the transport's configuration do not
18325 &"see"& the added header lines.
18326
18327 The &%headers_add%& option is expanded after &%errors_to%&, but before
18328 &%headers_remove%& and &%transport%&. If an item is empty, or if
18329 an item expansion is forced to fail, the item has no effect. Other expansion
18330 failures are treated as configuration errors.
18331
18332 Unlike most options, &%headers_add%& can be specified multiple times
18333 for a router; all listed headers are added.
18334
18335 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18336 router that has the &%one_time%& option set.
18337
18338 .cindex "duplicate addresses"
18339 .oindex "&%unseen%&"
18340 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18341 additions are deleted when the address is passed on to subsequent routers.
18342 For a &%redirect%& router, if a generated address is the same as the incoming
18343 address, this can lead to duplicate addresses with different header
18344 modifications. Exim does not do duplicate deliveries (except, in certain
18345 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18346 which of the duplicates is discarded, so this ambiguous situation should be
18347 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18348
18349
18350
18351 .option headers_remove routers list&!! unset
18352 .cindex "header lines" "removing"
18353 .cindex "router" "removing header lines"
18354 This option specifies a list of text headers,
18355 colon-separated (by default, changeable in the usual way),
18356 that is associated with any addresses that are accepted by the router.
18357 Each item is separately expanded, at routing time.  However, this
18358 option has no effect when an address is just being verified. The way in which
18359 the text is used to remove header lines at transport time is described in
18360 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18361 the message is in the process of being transported. This means that references
18362 to header lines in string expansions in the transport's configuration still
18363 &"see"& the original header lines.
18364
18365 The &%headers_remove%& option is expanded after &%errors_to%& and
18366 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18367 the item has no effect. Other expansion failures are treated as configuration
18368 errors.
18369
18370 Unlike most options, &%headers_remove%& can be specified multiple times
18371 for a router; all listed headers are removed.
18372
18373 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18374 router that has the &%one_time%& option set.
18375
18376 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18377 removal requests are deleted when the address is passed on to subsequent
18378 routers, and this can lead to problems with duplicates -- see the similar
18379 warning for &%headers_add%& above.
18380
18381 &*Warning 3*&: Because of the separate expansion of the list items,
18382 items that contain a list separator must have it doubled.
18383 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18384
18385
18386
18387 .option ignore_target_hosts routers "host list&!!" unset
18388 .cindex "IP address" "discarding"
18389 .cindex "router" "discarding IP addresses"
18390 Although this option is a host list, it should normally contain IP address
18391 entries rather than names. If any host that is looked up by the router has an
18392 IP address that matches an item in this list, Exim behaves as if that IP
18393 address did not exist. This option allows you to cope with rogue DNS entries
18394 like
18395 .code
18396 remote.domain.example.  A  127.0.0.1
18397 .endd
18398 by setting
18399 .code
18400 ignore_target_hosts = 127.0.0.1
18401 .endd
18402 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18403 discarded in this way, the router declines. In a conventional configuration, an
18404 attempt to mail to such a domain would normally provoke the &"unrouteable
18405 domain"& error, and an attempt to verify an address in the domain would fail.
18406 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18407 router declines if presented with one of the listed addresses.
18408
18409 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18410 means of the first or the second of the following settings, respectively:
18411 .code
18412 ignore_target_hosts = 0.0.0.0/0
18413 ignore_target_hosts = <; 0::0/0
18414 .endd
18415 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18416 in the second line matches all IPv6 addresses.
18417
18418 This option may also be useful for ignoring link-local and site-local IPv6
18419 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18420 is expanded before use as a list, it is possible to make it dependent on the
18421 domain that is being routed.
18422
18423 .vindex "&$host_address$&"
18424 During its expansion, &$host_address$& is set to the IP address that is being
18425 checked.
18426
18427 .option initgroups routers boolean false
18428 .cindex "additional groups"
18429 .cindex "groups" "additional"
18430 .cindex "local transports" "uid and gid"
18431 .cindex "transport" "local"
18432 If the router queues an address for a transport, and this option is true, and
18433 the uid supplied by the router is not overridden by the transport, the
18434 &[initgroups()]& function is called when running the transport to ensure that
18435 any additional groups associated with the uid are set up. See also &%group%&
18436 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18437
18438
18439
18440 .option local_part_prefix routers&!? "string list" unset
18441 .cindex affix "router precondition"
18442 .cindex "router" "prefix for local part"
18443 .cindex "prefix" "for local part, used in router"
18444 If this option is set, the router is skipped unless the local part starts with
18445 one of the given strings, or &%local_part_prefix_optional%& is true. See
18446 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18447 evaluated.
18448
18449 The list is scanned from left to right, and the first prefix that matches is
18450 used. A limited form of wildcard is available; if the prefix begins with an
18451 asterisk, it matches the longest possible sequence of arbitrary characters at
18452 the start of the local part. An asterisk should therefore always be followed by
18453 some character that does not occur in normal local parts.
18454 .cindex "multiple mailboxes"
18455 .cindex "mailbox" "multiple"
18456 Wildcarding can be used to set up multiple user mailboxes, as described in
18457 section &<<SECTmulbox>>&.
18458
18459 .vindex "&$local_part$&"
18460 .vindex "&$local_part_prefix$&"
18461 During the testing of the &%local_parts%& option, and while the router is
18462 running, the prefix is removed from the local part, and is available in the
18463 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18464 the router accepts the address, this remains true during subsequent delivery by
18465 a transport. In particular, the local part that is transmitted in the RCPT
18466 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18467 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18468 the relevant transport.
18469
18470 When an address is being verified, &%local_part_prefix%& affects only the
18471 behaviour of the router. If the callout feature of verification is in use, this
18472 means that the full address, including the prefix, will be used during the
18473 callout.
18474
18475 The prefix facility is commonly used to handle local parts of the form
18476 &%owner-something%&. Another common use is to support local parts of the form
18477 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18478 to tell a user their forwarding is broken &-- by placing a router like this one
18479 immediately before the router that handles &_.forward_& files:
18480 .code
18481 real_localuser:
18482   driver = accept
18483   local_part_prefix = real-
18484   check_local_user
18485   transport = local_delivery
18486 .endd
18487 For security, it would probably be a good idea to restrict the use of this
18488 router to locally-generated messages, using a condition such as this:
18489 .code
18490   condition = ${if match {$sender_host_address}\
18491                          {\N^(|127\.0\.0\.1)$\N}}
18492 .endd
18493
18494 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18495 both conditions must be met if not optional. Care must be taken if wildcards
18496 are used in both a prefix and a suffix on the same router. Different
18497 separator characters must be used to avoid ambiguity.
18498
18499
18500 .option local_part_prefix_optional routers boolean false
18501 See &%local_part_prefix%& above.
18502
18503
18504
18505 .option local_part_suffix routers&!? "string list" unset
18506 .cindex "router" "suffix for local part"
18507 .cindex "suffix for local part" "used in router"
18508 This option operates in the same way as &%local_part_prefix%&, except that the
18509 local part must end (rather than start) with the given string, the
18510 &%local_part_suffix_optional%& option determines whether the suffix is
18511 mandatory, and the wildcard * character, if present, must be the last
18512 character of the suffix. This option facility is commonly used to handle local
18513 parts of the form &%something-request%& and multiple user mailboxes of the form
18514 &%username-foo%&.
18515
18516
18517 .option local_part_suffix_optional routers boolean false
18518 See &%local_part_suffix%& above.
18519
18520
18521
18522 .option local_parts routers&!? "local part list&!!" unset
18523 .cindex "router" "restricting to specific local parts"
18524 .cindex "local part" "checking in router"
18525 The router is run only if the local part of the address matches the list.
18526 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18527 are evaluated, and
18528 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18529 string is expanded, it is possible to make it depend on the domain, for
18530 example:
18531 .code
18532 local_parts = dbm;/usr/local/specials/$domain
18533 .endd
18534 .vindex "&$local_part_data$&"
18535 If the match is achieved by a lookup, the data that the lookup returned
18536 for the local part is placed in the variable &$local_part_data$& for use in
18537 expansions of the router's private options. You might use this option, for
18538 example, if you have a large number of local virtual domains, and you want to
18539 send all postmaster mail to the same place without having to set up an alias in
18540 each virtual domain:
18541 .code
18542 postmaster:
18543   driver = redirect
18544   local_parts = postmaster
18545   data = postmaster@real.domain.example
18546 .endd
18547
18548
18549 .option log_as_local routers boolean "see below"
18550 .cindex "log" "delivery line"
18551 .cindex "delivery" "log line format"
18552 Exim has two logging styles for delivery, the idea being to make local
18553 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18554 recipient address is given just as the local part, without a domain. The use of
18555 this style is controlled by this option. It defaults to true for the &(accept)&
18556 router, and false for all the others. This option applies only when a
18557 router assigns an address to a transport. It has no effect on routers that
18558 redirect addresses.
18559
18560
18561
18562 .option more routers boolean&!! true
18563 The result of string expansion for this option must be a valid boolean value,
18564 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18565 result causes an error, and delivery is deferred. If the expansion is forced to
18566 fail, the default value for the option (true) is used. Other failures cause
18567 delivery to be deferred.
18568
18569 If this option is set false, and the router declines to handle the address, no
18570 further routers are tried, routing fails, and the address is bounced.
18571 .oindex "&%self%&"
18572 However, if the router explicitly passes an address to the following router by
18573 means of the setting
18574 .code
18575 self = pass
18576 .endd
18577 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18578 does not affect the behaviour if one of the precondition tests fails. In that
18579 case, the address is always passed to the next router.
18580
18581 Note that &%address_data%& is not considered to be a precondition. If its
18582 expansion is forced to fail, the router declines, and the value of &%more%&
18583 controls what happens next.
18584
18585
18586 .option pass_on_timeout routers boolean false
18587 .cindex "timeout" "of router"
18588 .cindex "router" "timeout"
18589 If a router times out during a host lookup, it normally causes deferral of the
18590 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18591 router, overriding &%no_more%&. This may be helpful for systems that are
18592 intermittently connected to the Internet, or those that want to pass to a smart
18593 host any messages that cannot immediately be delivered.
18594
18595 There are occasional other temporary errors that can occur while doing DNS
18596 lookups. They are treated in the same way as a timeout, and this option
18597 applies to all of them.
18598
18599
18600
18601 .option pass_router routers string unset
18602 .cindex "router" "go to after &""pass""&"
18603 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18604 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18605 routing to continue, and overriding a false setting of &%more%&. When one of
18606 these routers returns &"pass"&, the address is normally handed on to the next
18607 router in sequence. This can be changed by setting &%pass_router%& to the name
18608 of another router. However (unlike &%redirect_router%&) the named router must
18609 be below the current router, to avoid loops. Note that this option applies only
18610 to the special case of &"pass"&. It does not apply when a router returns
18611 &"decline"& because it cannot handle an address.
18612
18613
18614
18615 .option redirect_router routers string unset
18616 .cindex "router" "start at after redirection"
18617 Sometimes an administrator knows that it is pointless to reprocess addresses
18618 generated from alias or forward files with the same router again. For
18619 example, if an alias file translates real names into login ids there is no
18620 point searching the alias file a second time, especially if it is a large file.
18621
18622 The &%redirect_router%& option can be set to the name of any router instance.
18623 It causes the routing of any generated addresses to start at the named router
18624 instead of at the first router. This option has no effect if the router in
18625 which it is set does not generate new addresses.
18626
18627
18628
18629 .option require_files routers&!? "string list&!!" unset
18630 .cindex "file" "requiring for router"
18631 .cindex "router" "requiring file existence"
18632 This option provides a general mechanism for predicating the running of a
18633 router on the existence or non-existence of certain files or directories.
18634 Before running a router, as one of its precondition tests, Exim works its way
18635 through the &%require_files%& list, expanding each item separately.
18636
18637 Because the list is split before expansion, any colons in expansion items must
18638 be doubled, or the facility for using a different list separator must be used.
18639 If any expansion is forced to fail, the item is ignored. Other expansion
18640 failures cause routing of the address to be deferred.
18641
18642 If any expanded string is empty, it is ignored. Otherwise, except as described
18643 below, each string must be a fully qualified file path, optionally preceded by
18644 &"!"&. The paths are passed to the &[stat()]& function to test for the
18645 existence of the files or directories. The router is skipped if any paths not
18646 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18647
18648 .cindex "NFS"
18649 If &[stat()]& cannot determine whether a file exists or not, delivery of
18650 the message is deferred. This can happen when NFS-mounted filesystems are
18651 unavailable.
18652
18653 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18654 options, so you cannot use it to check for the existence of a file in which to
18655 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18656 full list of the order in which preconditions are evaluated.) However, as
18657 these options are all expanded, you can use the &%exists%& expansion condition
18658 to make such tests. The &%require_files%& option is intended for checking files
18659 that the router may be going to use internally, or which are needed by a
18660 transport (for example &_.procmailrc_&).
18661
18662 During delivery, the &[stat()]& function is run as root, but there is a
18663 facility for some checking of the accessibility of a file by another user.
18664 This is not a proper permissions check, but just a &"rough"& check that
18665 operates as follows:
18666
18667 If an item in a &%require_files%& list does not contain any forward slash
18668 characters, it is taken to be the user (and optional group, separated by a
18669 comma) to be checked for subsequent files in the list. If no group is specified
18670 but the user is specified symbolically, the gid associated with the uid is
18671 used. For example:
18672 .code
18673 require_files = mail:/some/file
18674 require_files = $local_part:$home/.procmailrc
18675 .endd
18676 If a user or group name in a &%require_files%& list does not exist, the
18677 &%require_files%& condition fails.
18678
18679 Exim performs the check by scanning along the components of the file path, and
18680 checking the access for the given uid and gid. It checks for &"x"& access on
18681 directories, and &"r"& access on the final file. Note that this means that file
18682 access control lists, if the operating system has them, are ignored.
18683
18684 &*Warning 1*&: When the router is being run to verify addresses for an
18685 incoming SMTP message, Exim is not running as root, but under its own uid. This
18686 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18687 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18688 user is not permitted to read one of the directories on the file's path.
18689
18690 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18691 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18692 without root access. In this case, if a check for access by a particular user
18693 is requested, Exim creates a subprocess that runs as that user, and tries the
18694 check again in that process.
18695
18696 The default action for handling an unresolved EACCES is to consider it to
18697 be caused by a configuration error, and routing is deferred because the
18698 existence or non-existence of the file cannot be determined. However, in some
18699 circumstances it may be desirable to treat this condition as if the file did
18700 not exist. If the file name (or the exclamation mark that precedes the file
18701 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18702 as if the file did not exist. For example:
18703 .code
18704 require_files = +/some/file
18705 .endd
18706 If the router is not an essential part of verification (for example, it
18707 handles users' &_.forward_& files), another solution is to set the &%verify%&
18708 option false so that the router is skipped when verifying.
18709
18710
18711
18712 .option retry_use_local_part routers boolean "see below"
18713 .cindex "hints database" "retry keys"
18714 .cindex "local part" "in retry keys"
18715 When a delivery suffers a temporary routing failure, a retry record is created
18716 in Exim's hints database. For addresses whose routing depends only on the
18717 domain, the key for the retry record should not involve the local part, but for
18718 other addresses, both the domain and the local part should be included.
18719 Usually, remote routing is of the former kind, and local routing is of the
18720 latter kind.
18721
18722 This option controls whether the local part is used to form the key for retry
18723 hints for addresses that suffer temporary errors while being handled by this
18724 router. The default value is true for any router that has &%check_local_user%&
18725 set, and false otherwise. Note that this option does not apply to hints keys
18726 for transport delays; they are controlled by a generic transport option of the
18727 same name.
18728
18729 The setting of &%retry_use_local_part%& applies only to the router on which it
18730 appears. If the router generates child addresses, they are routed
18731 independently; this setting does not become attached to them.
18732
18733
18734
18735 .option router_home_directory routers string&!! unset
18736 .cindex "router" "home directory for"
18737 .cindex "home directory" "for router"
18738 .vindex "&$home$&"
18739 This option sets a home directory for use while the router is running. (Compare
18740 &%transport_home_directory%&, which sets a home directory for later
18741 transporting.) In particular, if used on a &(redirect)& router, this option
18742 sets a value for &$home$& while a filter is running. The value is expanded;
18743 forced expansion failure causes the option to be ignored &-- other failures
18744 cause the router to defer.
18745
18746 Expansion of &%router_home_directory%& happens immediately after the
18747 &%check_local_user%& test (if configured), before any further expansions take
18748 place.
18749 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18750 are evaluated.)
18751 While the router is running, &%router_home_directory%& overrides the value of
18752 &$home$& that came from &%check_local_user%&.
18753
18754 When a router accepts an address and assigns it to a local transport (including
18755 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18756 delivery), the home directory setting for the transport is taken from the first
18757 of these values that is set:
18758
18759 .ilist
18760 The &%home_directory%& option on the transport;
18761 .next
18762 The &%transport_home_directory%& option on the router;
18763 .next
18764 The password data if &%check_local_user%& is set on the router;
18765 .next
18766 The &%router_home_directory%& option on the router.
18767 .endlist
18768
18769 In other words, &%router_home_directory%& overrides the password data for the
18770 router, but not for the transport.
18771
18772
18773
18774 .option self routers string freeze
18775 .cindex "MX record" "pointing to local host"
18776 .cindex "local host" "MX pointing to"
18777 This option applies to those routers that use a recipient address to find a
18778 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18779 and &(manualroute)& routers.
18780 Certain configurations of the &(queryprogram)& router can also specify a list
18781 of remote hosts.
18782 Usually such routers are configured to send the message to a remote host via an
18783 &(smtp)& transport. The &%self%& option specifies what happens when the first
18784 host on the list turns out to be the local host.
18785 The way in which Exim checks for the local host is described in section
18786 &<<SECTreclocipadd>>&.
18787
18788 Normally this situation indicates either an error in Exim's configuration (for
18789 example, the router should be configured not to process this domain), or an
18790 error in the DNS (for example, the MX should not point to this host). For this
18791 reason, the default action is to log the incident, defer the address, and
18792 freeze the message. The following alternatives are provided for use in special
18793 cases:
18794
18795 .vlist
18796 .vitem &%defer%&
18797 Delivery of the message is tried again later, but the message is not frozen.
18798
18799 .vitem "&%reroute%&: <&'domain'&>"
18800 The domain is changed to the given domain, and the address is passed back to
18801 be reprocessed by the routers. No rewriting of headers takes place. This
18802 behaviour is essentially a redirection.
18803
18804 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18805 The domain is changed to the given domain, and the address is passed back to be
18806 reprocessed by the routers. Any headers that contain the original domain are
18807 rewritten.
18808
18809 .vitem &%pass%&
18810 .oindex "&%more%&"
18811 .vindex "&$self_hostname$&"
18812 The router passes the address to the next router, or to the router named in the
18813 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18814 subsequent routing and delivery, the variable &$self_hostname$& contains the
18815 name of the local host that the router encountered. This can be used to
18816 distinguish between different cases for hosts with multiple names. The
18817 combination
18818 .code
18819 self = pass
18820 no_more
18821 .endd
18822 ensures that only those addresses that routed to the local host are passed on.
18823 Without &%no_more%&, addresses that were declined for other reasons would also
18824 be passed to the next router.
18825
18826 .vitem &%fail%&
18827 Delivery fails and an error report is generated.
18828
18829 .vitem &%send%&
18830 .cindex "local host" "sending to"
18831 The anomaly is ignored and the address is queued for the transport. This
18832 setting should be used with extreme caution. For an &(smtp)& transport, it
18833 makes sense only in cases where the program that is listening on the SMTP port
18834 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18835 different configuration file that handles the domain in another way.
18836 .endlist
18837
18838
18839
18840 .option senders routers&!? "address list&!!" unset
18841 .cindex "router" "checking senders"
18842 If this option is set, the router is skipped unless the message's sender
18843 address matches something on the list.
18844 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18845 are evaluated.
18846
18847 There are issues concerning verification when the running of routers is
18848 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18849 setting, it sets the sender to the null string. When using the &%-bt%& option
18850 to check a configuration file, it is necessary also to use the &%-f%& option to
18851 set an appropriate sender. For incoming mail, the sender is unset when
18852 verifying the sender, but is available when verifying any recipients. If the
18853 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18854 matters.
18855
18856
18857 .option translate_ip_address routers string&!! unset
18858 .cindex "IP address" "translating"
18859 .cindex "packet radio"
18860 .cindex "router" "IP address translation"
18861 There exist some rare networking situations (for example, packet radio) where
18862 it is helpful to be able to translate IP addresses generated by normal routing
18863 mechanisms into other IP addresses, thus performing a kind of manual IP
18864 routing. This should be done only if the normal IP routing of the TCP/IP stack
18865 is inadequate or broken. Because this is an extremely uncommon requirement, the
18866 code to support this option is not included in the Exim binary unless
18867 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18868
18869 .vindex "&$host_address$&"
18870 The &%translate_ip_address%& string is expanded for every IP address generated
18871 by the router, with the generated address set in &$host_address$&. If the
18872 expansion is forced to fail, no action is taken.
18873 For any other expansion error, delivery of the message is deferred.
18874 If the result of the expansion is an IP address, that replaces the original
18875 address; otherwise the result is assumed to be a host name &-- this is looked
18876 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18877 produce one or more replacement IP addresses. For example, to subvert all IP
18878 addresses in some specific networks, this could be added to a router:
18879 .code
18880 translate_ip_address = \
18881   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18882     {$value}fail}}
18883 .endd
18884 The file would contain lines like
18885 .code
18886 10.2.3.128/26    some.host
18887 10.8.4.34/26     10.44.8.15
18888 .endd
18889 You should not make use of this facility unless you really understand what you
18890 are doing.
18891
18892
18893
18894 .option transport routers string&!! unset
18895 This option specifies the transport to be used when a router accepts an address
18896 and sets it up for delivery. A transport is never needed if a router is used
18897 only for verification. The value of the option is expanded at routing time,
18898 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18899 and result must be the name of one of the configured transports. If it is not,
18900 delivery is deferred.
18901
18902 The &%transport%& option is not used by the &(redirect)& router, but it does
18903 have some private options that set up transports for pipe and file deliveries
18904 (see chapter &<<CHAPredirect>>&).
18905
18906
18907
18908 .option transport_current_directory routers string&!! unset
18909 .cindex "current directory for local transport"
18910 This option associates a current directory with any address that is routed
18911 to a local transport. This can happen either because a transport is
18912 explicitly configured for the router, or because it generates a delivery to a
18913 file or a pipe. During the delivery process (that is, at transport time), this
18914 option string is expanded and is set as the current directory, unless
18915 overridden by a setting on the transport.
18916 If the expansion fails for any reason, including forced failure, an error is
18917 logged, and delivery is deferred.
18918 See chapter &<<CHAPenvironment>>& for details of the local delivery
18919 environment.
18920
18921
18922
18923
18924 .option transport_home_directory routers string&!! "see below"
18925 .cindex "home directory" "for local transport"
18926 This option associates a home directory with any address that is routed to a
18927 local transport. This can happen either because a transport is explicitly
18928 configured for the router, or because it generates a delivery to a file or a
18929 pipe. During the delivery process (that is, at transport time), the option
18930 string is expanded and is set as the home directory, unless overridden by a
18931 setting of &%home_directory%& on the transport.
18932 If the expansion fails for any reason, including forced failure, an error is
18933 logged, and delivery is deferred.
18934
18935 If the transport does not specify a home directory, and
18936 &%transport_home_directory%& is not set for the router, the home directory for
18937 the transport is taken from the password data if &%check_local_user%& is set for
18938 the router. Otherwise it is taken from &%router_home_directory%& if that option
18939 is set; if not, no home directory is set for the transport.
18940
18941 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18942 environment.
18943
18944
18945
18946
18947 .option unseen routers boolean&!! false
18948 .cindex "router" "carrying on after success"
18949 The result of string expansion for this option must be a valid boolean value,
18950 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18951 result causes an error, and delivery is deferred. If the expansion is forced to
18952 fail, the default value for the option (false) is used. Other failures cause
18953 delivery to be deferred.
18954
18955 When this option is set true, routing does not cease if the router accepts the
18956 address. Instead, a copy of the incoming address is passed to the next router,
18957 overriding a false setting of &%more%&. There is little point in setting
18958 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18959 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18960 sometimes true and sometimes false).
18961
18962 .cindex "copy of message (&%unseen%& option)"
18963 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18964 qualifier in filter files. It can be used to cause copies of messages to be
18965 delivered to some other destination, while also carrying out a normal delivery.
18966 In effect, the current address is made into a &"parent"& that has two children
18967 &-- one that is delivered as specified by this router, and a clone that goes on
18968 to be routed further. For this reason, &%unseen%& may not be combined with the
18969 &%one_time%& option in a &(redirect)& router.
18970
18971 &*Warning*&: Header lines added to the address (or specified for removal) by
18972 this router or by previous routers affect the &"unseen"& copy of the message
18973 only. The clone that continues to be processed by further routers starts with
18974 no added headers and none specified for removal. For a &%redirect%& router, if
18975 a generated address is the same as the incoming address, this can lead to
18976 duplicate addresses with different header modifications. Exim does not do
18977 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18978 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18979 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18980 &%redirect%& router may be of help.
18981
18982 Unlike the handling of header modifications, any data that was set by the
18983 &%address_data%& option in the current or previous routers &'is'& passed on to
18984 subsequent routers.
18985
18986
18987 .option user routers string&!! "see below"
18988 .cindex "uid (user id)" "local delivery"
18989 .cindex "local transports" "uid and gid"
18990 .cindex "transport" "local"
18991 .cindex "router" "user for filter processing"
18992 .cindex "filter" "user for processing"
18993 When a router queues an address for a transport, and the transport does not
18994 specify a user, the user given here is used when running the delivery process.
18995 The user may be specified numerically or by name. If expansion fails, the
18996 error is logged and delivery is deferred.
18997 This user is also used by the &(redirect)& router when running a filter file.
18998 The default is unset, except when &%check_local_user%& is set. In this case,
18999 the default is taken from the password information. If the user is specified as
19000 a name, and &%group%& is not set, the group associated with the user is used.
19001 See also &%initgroups%& and &%group%& and the discussion in chapter
19002 &<<CHAPenvironment>>&.
19003
19004
19005
19006 .option verify routers&!? boolean true
19007 Setting this option has the effect of setting &%verify_sender%& and
19008 &%verify_recipient%& to the same value.
19009
19010
19011 .option verify_only routers&!? boolean false
19012 .cindex "EXPN" "with &%verify_only%&"
19013 .oindex "&%-bv%&"
19014 .cindex "router" "used only when verifying"
19015 If this option is set, the router is used only when verifying an address,
19016 delivering in cutthrough mode or
19017 testing with the &%-bv%& option, not when actually doing a delivery, testing
19018 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19019 restricted to verifying only senders or recipients by means of
19020 &%verify_sender%& and &%verify_recipient%&.
19021
19022 &*Warning*&: When the router is being run to verify addresses for an incoming
19023 SMTP message, Exim is not running as root, but under its own uid. If the router
19024 accesses any files, you need to make sure that they are accessible to the Exim
19025 user or group.
19026
19027
19028 .option verify_recipient routers&!? boolean true
19029 If this option is false, the router is skipped when verifying recipient
19030 addresses,
19031 delivering in cutthrough mode
19032 or testing recipient verification using &%-bv%&.
19033 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19034 are evaluated.
19035 See also the &$verify_mode$& variable.
19036
19037
19038 .option verify_sender routers&!? boolean true
19039 If this option is false, the router is skipped when verifying sender addresses
19040 or testing sender verification using &%-bvs%&.
19041 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19042 are evaluated.
19043 See also the &$verify_mode$& variable.
19044 .ecindex IIDgenoprou1
19045 .ecindex IIDgenoprou2
19046
19047
19048
19049
19050
19051
19052 . ////////////////////////////////////////////////////////////////////////////
19053 . ////////////////////////////////////////////////////////////////////////////
19054
19055 .chapter "The accept router" "CHID4"
19056 .cindex "&(accept)& router"
19057 .cindex "routers" "&(accept)&"
19058 The &(accept)& router has no private options of its own. Unless it is being
19059 used purely for verification (see &%verify_only%&) a transport is required to
19060 be defined by the generic &%transport%& option. If the preconditions that are
19061 specified by generic options are met, the router accepts the address and queues
19062 it for the given transport. The most common use of this router is for setting
19063 up deliveries to local mailboxes. For example:
19064 .code
19065 localusers:
19066   driver = accept
19067   domains = mydomain.example
19068   check_local_user
19069   transport = local_delivery
19070 .endd
19071 The &%domains%& condition in this example checks the domain of the address, and
19072 &%check_local_user%& checks that the local part is the login of a local user.
19073 When both preconditions are met, the &(accept)& router runs, and queues the
19074 address for the &(local_delivery)& transport.
19075
19076
19077
19078
19079
19080
19081 . ////////////////////////////////////////////////////////////////////////////
19082 . ////////////////////////////////////////////////////////////////////////////
19083
19084 .chapter "The dnslookup router" "CHAPdnslookup"
19085 .scindex IIDdnsrou1 "&(dnslookup)& router"
19086 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19087 The &(dnslookup)& router looks up the hosts that handle mail for the
19088 recipient's domain in the DNS. A transport must always be set for this router,
19089 unless &%verify_only%& is set.
19090
19091 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19092 SRV records. If none are found, or if SRV support is not configured,
19093 MX records are looked up. If no MX records exist, address records are sought.
19094 However, &%mx_domains%& can be set to disable the direct use of address
19095 records.
19096
19097 MX records of equal priority are sorted by Exim into a random order. Exim then
19098 looks for address records for the host names obtained from MX or SRV records.
19099 When a host has more than one IP address, they are sorted into a random order,
19100 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19101 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19102 generic option, the router declines.
19103
19104 Unless they have the highest priority (lowest MX value), MX records that point
19105 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19106 are discarded, together with any other MX records of equal or lower priority.
19107
19108 .cindex "MX record" "pointing to local host"
19109 .cindex "local host" "MX pointing to"
19110 .oindex "&%self%&" "in &(dnslookup)& router"
19111 If the host pointed to by the highest priority MX record, or looked up as an
19112 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19113 happens is controlled by the generic &%self%& option.
19114
19115
19116 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19117 There have been problems with DNS servers when SRV records are looked up.
19118 Some misbehaving servers return a DNS error or timeout when a non-existent
19119 SRV record is sought. Similar problems have in the past been reported for
19120 MX records. The global &%dns_again_means_nonexist%& option can help with this
19121 problem, but it is heavy-handed because it is a global option.
19122
19123 For this reason, there are two options, &%srv_fail_domains%& and
19124 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19125 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19126 an attempt to look up an SRV or MX record causes one of these results, and the
19127 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19128 such record"&. In the case of an SRV lookup, this means that the router
19129 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19130 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19131 case routing fails.
19132
19133
19134 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19135 .cindex "&(dnslookup)& router" "declines"
19136 There are a few cases where a &(dnslookup)& router will decline to accept
19137 an address; if such a router is expected to handle "all remaining non-local
19138 domains", then it is important to set &%no_more%&.
19139
19140 The router will defer rather than decline if the domain
19141 is found in the &%fail_defer_domains%& router option.
19142
19143 Reasons for a &(dnslookup)& router to decline currently include:
19144 .ilist
19145 The domain does not exist in DNS
19146 .next
19147 The domain exists but the MX record's host part is just "."; this is a common
19148 convention (borrowed from SRV) used to indicate that there is no such service
19149 for this domain and to not fall back to trying A/AAAA records.
19150 .next
19151 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19152 .next
19153 MX record points to a non-existent host.
19154 .next
19155 MX record points to an IP address and the main section option
19156 &%allow_mx_to_ip%& is not set.
19157 .next
19158 MX records exist and point to valid hosts, but all hosts resolve only to
19159 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19160 .next
19161 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19162 &%dns_check_names_pattern%& for handling one variant of this)
19163 .next
19164 &%check_secondary_mx%& is set on this router but the local host can
19165 not be found in the MX records (see below)
19166 .endlist
19167
19168
19169
19170
19171 .section "Private options for dnslookup" "SECID118"
19172 .cindex "options" "&(dnslookup)& router"
19173 The private options for the &(dnslookup)& router are as follows:
19174
19175 .option check_secondary_mx dnslookup boolean false
19176 .cindex "MX record" "checking for secondary"
19177 If this option is set, the router declines unless the local host is found in
19178 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19179 process domains for which the local host is a secondary mail exchanger
19180 differently to other domains. The way in which Exim decides whether a host is
19181 the local host is described in section &<<SECTreclocipadd>>&.
19182
19183
19184 .option check_srv dnslookup string&!! unset
19185 .cindex "SRV record" "enabling use of"
19186 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19187 addition to MX and address records. The support is disabled by default. To
19188 enable SRV support, set the &%check_srv%& option to the name of the service
19189 required. For example,
19190 .code
19191 check_srv = smtp
19192 .endd
19193 looks for SRV records that refer to the normal smtp service. The option is
19194 expanded, so the service name can vary from message to message or address
19195 to address. This might be helpful if SRV records are being used for a
19196 submission service. If the expansion is forced to fail, the &%check_srv%&
19197 option is ignored, and the router proceeds to look for MX records in the
19198 normal way.
19199
19200 When the expansion succeeds, the router searches first for SRV records for
19201 the given service (it assumes TCP protocol). A single SRV record with a
19202 host name that consists of just a single dot indicates &"no such service for
19203 this domain"&; if this is encountered, the router declines. If other kinds of
19204 SRV record are found, they are used to construct a host list for delivery
19205 according to the rules of RFC 2782. MX records are not sought in this case.
19206
19207 When no SRV records are found, MX records (and address records) are sought in
19208 the traditional way. In other words, SRV records take precedence over MX
19209 records, just as MX records take precedence over address records. Note that
19210 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19211 defined it. It is apparently believed that MX records are sufficient for email
19212 and that SRV records should not be used for this purpose. However, SRV records
19213 have an additional &"weight"& feature which some people might find useful when
19214 trying to split an SMTP load between hosts of different power.
19215
19216 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19217 when there is a DNS lookup error.
19218
19219
19220
19221
19222 .option fail_defer_domains dnslookup "domain list&!!" unset
19223 .cindex "MX record" "not found"
19224 DNS lookups for domains matching &%fail_defer_domains%&
19225 which find no matching record will cause the router to defer
19226 rather than the default behaviour of decline.
19227 This maybe be useful for queueing messages for a newly created
19228 domain while the DNS configuration is not ready.
19229 However, it will result in any message with mistyped domains
19230 also being queued.
19231
19232
19233 .option ipv4_only "string&!!" unset
19234 .cindex IPv6 disabling
19235 .cindex DNS "IPv6 disabling"
19236 The string is expanded, and if the result is anything but a forced failure,
19237 or an empty string, or one of the strings “0” or “no” or “false”
19238 (checked without regard to the case of the letters),
19239 only A records are used.
19240
19241 .option ipv4_prefer "string&!!" unset
19242 .cindex IPv4 preference
19243 .cindex DNS "IPv4 preference"
19244 The string is expanded, and if the result is anything but a forced failure,
19245 or an empty string, or one of the strings “0” or “no” or “false”
19246 (checked without regard to the case of the letters),
19247 A records are sorted before AAAA records (inverting the default).
19248
19249 .option mx_domains dnslookup "domain list&!!" unset
19250 .cindex "MX record" "required to exist"
19251 .cindex "SRV record" "required to exist"
19252 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19253 record in order to be recognized. (The name of this option could be improved.)
19254 For example, if all the mail hosts in &'fict.example'& are known to have MX
19255 records, except for those in &'discworld.fict.example'&, you could use this
19256 setting:
19257 .code
19258 mx_domains = ! *.discworld.fict.example : *.fict.example
19259 .endd
19260 This specifies that messages addressed to a domain that matches the list but
19261 has no MX record should be bounced immediately instead of being routed using
19262 the address record.
19263
19264
19265 .option mx_fail_domains dnslookup "domain list&!!" unset
19266 If the DNS lookup for MX records for one of the domains in this list causes a
19267 DNS lookup error, Exim behaves as if no MX records were found. See section
19268 &<<SECTprowitdnsloo>>& for more discussion.
19269
19270
19271
19272
19273 .option qualify_single dnslookup boolean true
19274 .cindex "DNS" "resolver options"
19275 .cindex "DNS" "qualifying single-component names"
19276 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19277 lookups. Typically, but not standardly, this causes the resolver to qualify
19278 single-component names with the default domain. For example, on a machine
19279 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19280 &'thesaurus.ref.example'& inside the resolver. For details of what your
19281 resolver actually does, consult your man pages for &'resolver'& and
19282 &'resolv.conf'&.
19283
19284
19285
19286 .option rewrite_headers dnslookup boolean true
19287 .cindex "rewriting" "header lines"
19288 .cindex "header lines" "rewriting"
19289 If the domain name in the address that is being processed is not fully
19290 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19291 an address is specified as &'dormouse@teaparty'&, the domain might be
19292 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19293 occur as a result of setting the &%widen_domains%& option. If
19294 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19295 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19296 header lines of the message are rewritten with the full domain name.
19297
19298 This option should be turned off only when it is known that no message is
19299 ever going to be sent outside an environment where the abbreviation makes
19300 sense.
19301
19302 When an MX record is looked up in the DNS and matches a wildcard record, name
19303 servers normally return a record containing the name that has been looked up,
19304 making it impossible to detect whether a wildcard was present or not. However,
19305 some name servers have recently been seen to return the wildcard entry. If the
19306 name returned by a DNS lookup begins with an asterisk, it is not used for
19307 header rewriting.
19308
19309
19310 .option same_domain_copy_routing dnslookup boolean false
19311 .cindex "address" "copying routing"
19312 Addresses with the same domain are normally routed by the &(dnslookup)& router
19313 to the same list of hosts. However, this cannot be presumed, because the router
19314 options and preconditions may refer to the local part of the address. By
19315 default, therefore, Exim routes each address in a message independently. DNS
19316 servers run caches, so repeated DNS lookups are not normally expensive, and in
19317 any case, personal messages rarely have more than a few recipients.
19318
19319 If you are running mailing lists with large numbers of subscribers at the same
19320 domain, and you are using a &(dnslookup)& router which is independent of the
19321 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19322 lookups for identical domains in one message. In this case, when &(dnslookup)&
19323 routes an address to a remote transport, any other unrouted addresses in the
19324 message that have the same domain are automatically given the same routing
19325 without processing them independently,
19326 provided the following conditions are met:
19327
19328 .ilist
19329 No router that processed the address specified &%headers_add%& or
19330 &%headers_remove%&.
19331 .next
19332 The router did not change the address in any way, for example, by &"widening"&
19333 the domain.
19334 .endlist
19335
19336
19337
19338
19339 .option search_parents dnslookup boolean false
19340 .cindex "DNS" "resolver options"
19341 When this option is true, the resolver option RES_DNSRCH is set for DNS
19342 lookups. This is different from the &%qualify_single%& option in that it
19343 applies to domains containing dots. Typically, but not standardly, it causes
19344 the resolver to search for the name in the current domain and in parent
19345 domains. For example, on a machine in the &'fict.example'& domain, if looking
19346 up &'teaparty.wonderland'& failed, the resolver would try
19347 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19348 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19349
19350 Setting this option true can cause problems in domains that have a wildcard MX
19351 record, because any domain that does not have its own MX record matches the
19352 local wildcard.
19353
19354
19355
19356 .option srv_fail_domains dnslookup "domain list&!!" unset
19357 If the DNS lookup for SRV records for one of the domains in this list causes a
19358 DNS lookup error, Exim behaves as if no SRV records were found. See section
19359 &<<SECTprowitdnsloo>>& for more discussion.
19360
19361
19362
19363
19364 .option widen_domains dnslookup "string list" unset
19365 .cindex "domain" "partial; widening"
19366 If a DNS lookup fails and this option is set, each of its strings in turn is
19367 added onto the end of the domain, and the lookup is tried again. For example,
19368 if
19369 .code
19370 widen_domains = fict.example:ref.example
19371 .endd
19372 is set and a lookup of &'klingon.dictionary'& fails,
19373 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19374 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19375 and &%search_parents%& options can cause some widening to be undertaken inside
19376 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19377 when verifying, unless &%rewrite_headers%& is false (not the default).
19378
19379
19380 .section "Effect of qualify_single and search_parents" "SECID119"
19381 When a domain from an envelope recipient is changed by the resolver as a result
19382 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19383 corresponding address in the message's header lines unless &%rewrite_headers%&
19384 is set false. Exim then re-routes the address, using the full domain.
19385
19386 These two options affect only the DNS lookup that takes place inside the router
19387 for the domain of the address that is being routed. They do not affect lookups
19388 such as that implied by
19389 .code
19390 domains = @mx_any
19391 .endd
19392 that may happen while processing a router precondition before the router is
19393 entered. No widening ever takes place for these lookups.
19394 .ecindex IIDdnsrou1
19395 .ecindex IIDdnsrou2
19396
19397
19398
19399
19400
19401
19402
19403
19404
19405 . ////////////////////////////////////////////////////////////////////////////
19406 . ////////////////////////////////////////////////////////////////////////////
19407
19408 .chapter "The ipliteral router" "CHID5"
19409 .cindex "&(ipliteral)& router"
19410 .cindex "domain literal" "routing"
19411 .cindex "routers" "&(ipliteral)&"
19412 This router has no private options. Unless it is being used purely for
19413 verification (see &%verify_only%&) a transport is required to be defined by the
19414 generic &%transport%& option. The router accepts the address if its domain part
19415 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19416 router handles the address
19417 .code
19418 root@[192.168.1.1]
19419 .endd
19420 by setting up delivery to the host with that IP address. IPv4 domain literals
19421 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19422 are similar, but the address is preceded by &`ipv6:`&. For example:
19423 .code
19424 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19425 .endd
19426 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19427 grounds that sooner or later somebody will try it.
19428
19429 .oindex "&%self%&" "in &(ipliteral)& router"
19430 If the IP address matches something in &%ignore_target_hosts%&, the router
19431 declines. If an IP literal turns out to refer to the local host, the generic
19432 &%self%& option determines what happens.
19433
19434 The RFCs require support for domain literals; however, their use is
19435 controversial in today's Internet. If you want to use this router, you must
19436 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19437 Exim will not recognize the domain literal syntax in addresses.
19438
19439
19440
19441 . ////////////////////////////////////////////////////////////////////////////
19442 . ////////////////////////////////////////////////////////////////////////////
19443
19444 .chapter "The iplookup router" "CHID6"
19445 .cindex "&(iplookup)& router"
19446 .cindex "routers" "&(iplookup)&"
19447 The &(iplookup)& router was written to fulfil a specific requirement in
19448 Cambridge University (which in fact no longer exists). For this reason, it is
19449 not included in the binary of Exim by default. If you want to include it, you
19450 must set
19451 .code
19452 ROUTER_IPLOOKUP=yes
19453 .endd
19454 in your &_Local/Makefile_& configuration file.
19455
19456 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19457 connection to one or more specific hosts. The host can then return the same or
19458 a different address &-- in effect rewriting the recipient address in the
19459 message's envelope. The new address is then passed on to subsequent routers. If
19460 this process fails, the address can be passed on to other routers, or delivery
19461 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19462 must not be specified for it.
19463
19464 .cindex "options" "&(iplookup)& router"
19465 .option hosts iplookup string unset
19466 This option must be supplied. Its value is a colon-separated list of host
19467 names. The hosts are looked up using &[gethostbyname()]&
19468 (or &[getipnodebyname()]& when available)
19469 and are tried in order until one responds to the query. If none respond, what
19470 happens is controlled by &%optional%&.
19471
19472
19473 .option optional iplookup boolean false
19474 If &%optional%& is true, if no response is obtained from any host, the address
19475 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19476 delivery to the address is deferred.
19477
19478
19479 .option port iplookup integer 0
19480 .cindex "port" "&(iplookup)& router"
19481 This option must be supplied. It specifies the port number for the TCP or UDP
19482 call.
19483
19484
19485 .option protocol iplookup string udp
19486 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19487 protocols is to be used.
19488
19489
19490 .option query iplookup string&!! "see below"
19491 This defines the content of the query that is sent to the remote hosts. The
19492 default value is:
19493 .code
19494 $local_part@$domain $local_part@$domain
19495 .endd
19496 The repetition serves as a way of checking that a response is to the correct
19497 query in the default case (see &%response_pattern%& below).
19498
19499
19500 .option reroute iplookup string&!! unset
19501 If this option is not set, the rerouted address is precisely the byte string
19502 returned by the remote host, up to the first white space, if any. If set, the
19503 string is expanded to form the rerouted address. It can include parts matched
19504 in the response by &%response_pattern%& by means of numeric variables such as
19505 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19506 whether or not a pattern is in use. In all cases, the rerouted address must end
19507 up in the form &'local_part@domain'&.
19508
19509
19510 .option response_pattern iplookup string unset
19511 This option can be set to a regular expression that is applied to the string
19512 returned from the remote host. If the pattern does not match the response, the
19513 router declines. If &%response_pattern%& is not set, no checking of the
19514 response is done, unless the query was defaulted, in which case there is a
19515 check that the text returned after the first white space is the original
19516 address. This checks that the answer that has been received is in response to
19517 the correct question. For example, if the response is just a new domain, the
19518 following could be used:
19519 .code
19520 response_pattern = ^([^@]+)$
19521 reroute = $local_part@$1
19522 .endd
19523
19524 .option timeout iplookup time 5s
19525 This specifies the amount of time to wait for a response from the remote
19526 machine. The same timeout is used for the &[connect()]& function for a TCP
19527 call. It does not apply to UDP.
19528
19529
19530
19531
19532 . ////////////////////////////////////////////////////////////////////////////
19533 . ////////////////////////////////////////////////////////////////////////////
19534
19535 .chapter "The manualroute router" "CHID7"
19536 .scindex IIDmanrou1 "&(manualroute)& router"
19537 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19538 .cindex "domain" "manually routing"
19539 The &(manualroute)& router is so-called because it provides a way of manually
19540 routing an address according to its domain. It is mainly used when you want to
19541 route addresses to remote hosts according to your own rules, bypassing the
19542 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19543 route to local transports, a facility that may be useful if you want to save
19544 messages for dial-in hosts in local files.
19545
19546 The &(manualroute)& router compares a list of domain patterns with the domain
19547 it is trying to route. If there is no match, the router declines. Each pattern
19548 has associated with it a list of hosts and some other optional data, which may
19549 include a transport. The combination of a pattern and its data is called a
19550 &"routing rule"&. For patterns that do not have an associated transport, the
19551 generic &%transport%& option must specify a transport, unless the router is
19552 being used purely for verification (see &%verify_only%&).
19553
19554 .vindex "&$host$&"
19555 In the case of verification, matching the domain pattern is sufficient for the
19556 router to accept the address. When actually routing an address for delivery,
19557 an address that matches a domain pattern is queued for the associated
19558 transport. If the transport is not a local one, a host list must be associated
19559 with the pattern; IP addresses are looked up for the hosts, and these are
19560 passed to the transport along with the mail address. For local transports, a
19561 host list is optional. If it is present, it is passed in &$host$& as a single
19562 text string.
19563
19564 The list of routing rules can be provided as an inline string in
19565 &%route_list%&, or the data can be obtained by looking up the domain in a file
19566 or database by setting &%route_data%&. Only one of these settings may appear in
19567 any one instance of &(manualroute)&. The format of routing rules is described
19568 below, following the list of private options.
19569
19570
19571 .section "Private options for manualroute" "SECTprioptman"
19572
19573 .cindex "options" "&(manualroute)& router"
19574 The private options for the &(manualroute)& router are as follows:
19575
19576 .option host_all_ignored manualroute string defer
19577 See &%host_find_failed%&.
19578
19579 .option host_find_failed manualroute string freeze
19580 This option controls what happens when &(manualroute)& tries to find an IP
19581 address for a host, and the host does not exist. The option can be set to one
19582 of the following values:
19583 .code
19584 decline
19585 defer
19586 fail
19587 freeze
19588 ignore
19589 pass
19590 .endd
19591 The default (&"freeze"&) assumes that this state is a serious configuration
19592 error. The difference between &"pass"& and &"decline"& is that the former
19593 forces the address to be passed to the next router (or the router defined by
19594 &%pass_router%&),
19595 .oindex "&%more%&"
19596 overriding &%no_more%&, whereas the latter passes the address to the next
19597 router only if &%more%& is true.
19598
19599 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19600 cannot be found. If all the hosts in the list are ignored, the behaviour is
19601 controlled by the &%host_all_ignored%& option. This takes the same values
19602 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19603
19604 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19605 state; if a host lookup gets a temporary error, delivery is deferred unless the
19606 generic &%pass_on_timeout%& option is set.
19607
19608
19609 .option hosts_randomize manualroute boolean false
19610 .cindex "randomized host list"
19611 .cindex "host" "list of; randomized"
19612 If this option is set, the order of the items in a host list in a routing rule
19613 is randomized each time the list is used, unless an option in the routing rule
19614 overrides (see below). Randomizing the order of a host list can be used to do
19615 crude load sharing. However, if more than one mail address is routed by the
19616 same router to the same host list, the host lists are considered to be the same
19617 (even though they may be randomized into different orders) for the purpose of
19618 deciding whether to batch the deliveries into a single SMTP transaction.
19619
19620 When &%hosts_randomize%& is true, a host list may be split
19621 into groups whose order is separately randomized. This makes it possible to
19622 set up MX-like behaviour. The boundaries between groups are indicated by an
19623 item that is just &`+`& in the host list. For example:
19624 .code
19625 route_list = * host1:host2:host3:+:host4:host5
19626 .endd
19627 The order of the first three hosts and the order of the last two hosts is
19628 randomized for each use, but the first three always end up before the last two.
19629 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19630 randomized host list is passed to an &(smtp)& transport that also has
19631 &%hosts_randomize set%&, the list is not re-randomized.
19632
19633
19634 .option route_data manualroute string&!! unset
19635 If this option is set, it must expand to yield the data part of a routing rule.
19636 Typically, the expansion string includes a lookup based on the domain. For
19637 example:
19638 .code
19639 route_data = ${lookup{$domain}dbm{/etc/routes}}
19640 .endd
19641 If the expansion is forced to fail, or the result is an empty string, the
19642 router declines. Other kinds of expansion failure cause delivery to be
19643 deferred.
19644
19645
19646 .option route_list manualroute "string list" unset
19647 This string is a list of routing rules, in the form defined below. Note that,
19648 unlike most string lists, the items are separated by semicolons. This is so
19649 that they may contain colon-separated host lists.
19650
19651
19652 .option same_domain_copy_routing manualroute boolean false
19653 .cindex "address" "copying routing"
19654 Addresses with the same domain are normally routed by the &(manualroute)&
19655 router to the same list of hosts. However, this cannot be presumed, because the
19656 router options and preconditions may refer to the local part of the address. By
19657 default, therefore, Exim routes each address in a message independently. DNS
19658 servers run caches, so repeated DNS lookups are not normally expensive, and in
19659 any case, personal messages rarely have more than a few recipients.
19660
19661 If you are running mailing lists with large numbers of subscribers at the same
19662 domain, and you are using a &(manualroute)& router which is independent of the
19663 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19664 lookups for identical domains in one message. In this case, when
19665 &(manualroute)& routes an address to a remote transport, any other unrouted
19666 addresses in the message that have the same domain are automatically given the
19667 same routing without processing them independently. However, this is only done
19668 if &%headers_add%& and &%headers_remove%& are unset.
19669
19670
19671
19672
19673 .section "Routing rules in route_list" "SECID120"
19674 The value of &%route_list%& is a string consisting of a sequence of routing
19675 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19676 entered as two semicolons. Alternatively, the list separator can be changed as
19677 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19678 Empty rules are ignored. The format of each rule is
19679 .display
19680 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19681 .endd
19682 The following example contains two rules, each with a simple domain pattern and
19683 no options:
19684 .code
19685 route_list = \
19686   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19687   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19688 .endd
19689 The three parts of a rule are separated by white space. The pattern and the
19690 list of hosts can be enclosed in quotes if necessary, and if they are, the
19691 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19692 single domain pattern, which is the only mandatory item in the rule. The
19693 pattern is in the same format as one item in a domain list (see section
19694 &<<SECTdomainlist>>&),
19695 except that it may not be the name of an interpolated file.
19696 That is, it may be wildcarded, or a regular expression, or a file or database
19697 lookup (with semicolons doubled, because of the use of semicolon as a separator
19698 in a &%route_list%&).
19699
19700 The rules in &%route_list%& are searched in order until one of the patterns
19701 matches the domain that is being routed. The list of hosts and then options are
19702 then used as described below. If there is no match, the router declines. When
19703 &%route_list%& is set, &%route_data%& must not be set.
19704
19705
19706
19707 .section "Routing rules in route_data" "SECID121"
19708 The use of &%route_list%& is convenient when there are only a small number of
19709 routing rules. For larger numbers, it is easier to use a file or database to
19710 hold the routing information, and use the &%route_data%& option instead.
19711 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19712 Most commonly, &%route_data%& is set as a string that contains an
19713 expansion lookup. For example, suppose we place two routing rules in a file
19714 like this:
19715 .code
19716 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19717 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19718 .endd
19719 This data can be accessed by setting
19720 .code
19721 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19722 .endd
19723 Failure of the lookup results in an empty string, causing the router to
19724 decline. However, you do not have to use a lookup in &%route_data%&. The only
19725 requirement is that the result of expanding the string is a list of hosts,
19726 possibly followed by options, separated by white space. The list of hosts must
19727 be enclosed in quotes if it contains white space.
19728
19729
19730
19731
19732 .section "Format of the list of hosts" "SECID122"
19733 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19734 always separately expanded before use. If the expansion fails, the router
19735 declines. The result of the expansion must be a colon-separated list of names
19736 and/or IP addresses, optionally also including ports.
19737 If the list is written with spaces, it must be protected with quotes.
19738 The format of each item
19739 in the list is described in the next section. The list separator can be changed
19740 as described in section &<<SECTlistconstruct>>&.
19741
19742 If the list of hosts was obtained from a &%route_list%& item, the following
19743 variables are set during its expansion:
19744
19745 .ilist
19746 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19747 If the domain was matched against a regular expression, the numeric variables
19748 &$1$&, &$2$&, etc. may be set. For example:
19749 .code
19750 route_list = ^domain(\d+)   host-$1.text.example
19751 .endd
19752 .next
19753 &$0$& is always set to the entire domain.
19754 .next
19755 &$1$& is also set when partial matching is done in a file lookup.
19756
19757 .next
19758 .vindex "&$value$&"
19759 If the pattern that matched the domain was a lookup item, the data that was
19760 looked up is available in the expansion variable &$value$&. For example:
19761 .code
19762 route_list = lsearch;;/some/file.routes  $value
19763 .endd
19764 .endlist
19765
19766 Note the doubling of the semicolon in the pattern that is necessary because
19767 semicolon is the default route list separator.
19768
19769
19770
19771 .section "Format of one host item" "SECTformatonehostitem"
19772 Each item in the list of hosts is either a host name or an IP address,
19773 optionally with an attached port number. When no port is given, an IP address
19774 is not enclosed in brackets. When a port is specified, it overrides the port
19775 specification on the transport. The port is separated from the name or address
19776 by a colon. This leads to some complications:
19777
19778 .ilist
19779 Because colon is the default separator for the list of hosts, either
19780 the colon that specifies a port must be doubled, or the list separator must
19781 be changed. The following two examples have the same effect:
19782 .code
19783 route_list = * "host1.tld::1225 : host2.tld::1226"
19784 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19785 .endd
19786 .next
19787 When IPv6 addresses are involved, it gets worse, because they contain
19788 colons of their own. To make this case easier, it is permitted to
19789 enclose an IP address (either v4 or v6) in square brackets if a port
19790 number follows. For example:
19791 .code
19792 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19793 .endd
19794 .endlist
19795
19796 .section "How the list of hosts is used" "SECThostshowused"
19797 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19798 the hosts is tried, in the order specified, when carrying out the SMTP
19799 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19800 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19801 transport.
19802
19803 Hosts may be listed by name or by IP address. An unadorned name in the list of
19804 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19805 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19806 records in the DNS. For example:
19807 .code
19808 route_list = *  x.y.z:p.q.r/MX:e.f.g
19809 .endd
19810 If this feature is used with a port specifier, the port must come last. For
19811 example:
19812 .code
19813 route_list = *  dom1.tld/mx::1225
19814 .endd
19815 If the &%hosts_randomize%& option is set, the order of the items in the list is
19816 randomized before any lookups are done. Exim then scans the list; for any name
19817 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19818 be an interface on the local host and the item is not the first in the list,
19819 Exim discards it and any subsequent items. If it is the first item, what
19820 happens is controlled by the
19821 .oindex "&%self%&" "in &(manualroute)& router"
19822 &%self%& option of the router.
19823
19824 A name on the list that is followed by &`/MX`& is replaced with the list of
19825 hosts obtained by looking up MX records for the name. This is always a DNS
19826 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19827 below) are not relevant here. The order of these hosts is determined by the
19828 preference values in the MX records, according to the usual rules. Because
19829 randomizing happens before the MX lookup, it does not affect the order that is
19830 defined by MX preferences.
19831
19832 If the local host is present in the sublist obtained from MX records, but is
19833 not the most preferred host in that list, it and any equally or less
19834 preferred hosts are removed before the sublist is inserted into the main list.
19835
19836 If the local host is the most preferred host in the MX list, what happens
19837 depends on where in the original list of hosts the &`/MX`& item appears. If it
19838 is not the first item (that is, there are previous hosts in the main list),
19839 Exim discards this name and any subsequent items in the main list.
19840
19841 If the MX item is first in the list of hosts, and the local host is the
19842 most preferred host, what happens is controlled by the &%self%& option of the
19843 router.
19844
19845 DNS failures when lookup up the MX records are treated in the same way as DNS
19846 failures when looking up IP addresses: &%pass_on_timeout%& and
19847 &%host_find_failed%& are used when relevant.
19848
19849 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19850 whether obtained from an MX lookup or not.
19851
19852
19853
19854 .section "How the options are used" "SECThowoptused"
19855 The options are a sequence of words, space-separated.
19856 One of the words can be the name of a transport; this overrides the
19857 &%transport%& option on the router for this particular routing rule only. The
19858 other words (if present) control randomization of the list of hosts on a
19859 per-rule basis, and how the IP addresses of the hosts are to be found when
19860 routing to a remote transport. These options are as follows:
19861
19862 .ilist
19863 &%randomize%&: randomize the order of the hosts in this list, overriding the
19864 setting of &%hosts_randomize%& for this routing rule only.
19865 .next
19866 &%no_randomize%&: do not randomize the order of the hosts in this list,
19867 overriding the setting of &%hosts_randomize%& for this routing rule only.
19868 .next
19869 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19870 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19871 also look in &_/etc/hosts_& or other sources of information.
19872 .next
19873 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19874 no address records are found. If there is a temporary DNS error (such as a
19875 timeout), delivery is deferred.
19876 .next
19877 &%ipv4_only%&: in direct DNS lookups, look up only A records.
19878 .next
19879 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
19880 .endlist
19881
19882 For example:
19883 .code
19884 route_list = domain1  host1:host2:host3  randomize bydns;\
19885              domain2  host4:host5
19886 .endd
19887 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19888 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19889 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19890 or &[gethostbyname()]&, and the result of the lookup is the result of that
19891 call.
19892
19893 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19894 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19895 instead of TRY_AGAIN. That is why the default action is to try a DNS
19896 lookup first. Only if that gives a definite &"no such host"& is the local
19897 function called.
19898
19899 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
19900 inadvertent constraint that a transport name as an option had to be the last
19901 option specified.
19902
19903
19904
19905 If no IP address for a host can be found, what happens is controlled by the
19906 &%host_find_failed%& option.
19907
19908 .vindex "&$host$&"
19909 When an address is routed to a local transport, IP addresses are not looked up.
19910 The host list is passed to the transport in the &$host$& variable.
19911
19912
19913
19914 .section "Manualroute examples" "SECID123"
19915 In some of the examples that follow, the presence of the &%remote_smtp%&
19916 transport, as defined in the default configuration file, is assumed:
19917
19918 .ilist
19919 .cindex "smart host" "example router"
19920 The &(manualroute)& router can be used to forward all external mail to a
19921 &'smart host'&. If you have set up, in the main part of the configuration, a
19922 named domain list that contains your local domains, for example:
19923 .code
19924 domainlist local_domains = my.domain.example
19925 .endd
19926 You can arrange for all other domains to be routed to a smart host by making
19927 your first router something like this:
19928 .code
19929 smart_route:
19930   driver = manualroute
19931   domains = !+local_domains
19932   transport = remote_smtp
19933   route_list = * smarthost.ref.example
19934 .endd
19935 This causes all non-local addresses to be sent to the single host
19936 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19937 they are tried in order
19938 (but you can use &%hosts_randomize%& to vary the order each time).
19939 Another way of configuring the same thing is this:
19940 .code
19941 smart_route:
19942   driver = manualroute
19943   transport = remote_smtp
19944   route_list = !+local_domains  smarthost.ref.example
19945 .endd
19946 There is no difference in behaviour between these two routers as they stand.
19947 However, they behave differently if &%no_more%& is added to them. In the first
19948 example, the router is skipped if the domain does not match the &%domains%&
19949 precondition; the following router is always tried. If the router runs, it
19950 always matches the domain and so can never decline. Therefore, &%no_more%&
19951 would have no effect. In the second case, the router is never skipped; it
19952 always runs. However, if it doesn't match the domain, it declines. In this case
19953 &%no_more%& would prevent subsequent routers from running.
19954
19955 .next
19956 .cindex "mail hub example"
19957 A &'mail hub'& is a host which receives mail for a number of domains via MX
19958 records in the DNS and delivers it via its own private routing mechanism. Often
19959 the final destinations are behind a firewall, with the mail hub being the one
19960 machine that can connect to machines both inside and outside the firewall. The
19961 &(manualroute)& router is usually used on a mail hub to route incoming messages
19962 to the correct hosts. For a small number of domains, the routing can be inline,
19963 using the &%route_list%& option, but for a larger number a file or database
19964 lookup is easier to manage.
19965
19966 If the domain names are in fact the names of the machines to which the mail is
19967 to be sent by the mail hub, the configuration can be quite simple. For
19968 example:
19969 .code
19970 hub_route:
19971   driver = manualroute
19972   transport = remote_smtp
19973   route_list = *.rhodes.tvs.example  $domain
19974 .endd
19975 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19976 whose names are the same as the mail domains. A similar approach can be taken
19977 if the host name can be obtained from the domain name by a string manipulation
19978 that the expansion facilities can handle. Otherwise, a lookup based on the
19979 domain can be used to find the host:
19980 .code
19981 through_firewall:
19982   driver = manualroute
19983   transport = remote_smtp
19984   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19985 .endd
19986 The result of the lookup must be the name or IP address of the host (or
19987 hosts) to which the address is to be routed. If the lookup fails, the route
19988 data is empty, causing the router to decline. The address then passes to the
19989 next router.
19990
19991 .next
19992 .cindex "batched SMTP output example"
19993 .cindex "SMTP" "batched outgoing; example"
19994 You can use &(manualroute)& to deliver messages to pipes or files in batched
19995 SMTP format for onward transportation by some other means. This is one way of
19996 storing mail for a dial-up host when it is not connected. The route list entry
19997 can be as simple as a single domain name in a configuration like this:
19998 .code
19999 save_in_file:
20000   driver = manualroute
20001   transport = batchsmtp_appendfile
20002   route_list = saved.domain.example
20003 .endd
20004 though often a pattern is used to pick up more than one domain. If there are
20005 several domains or groups of domains with different transport requirements,
20006 different transports can be listed in the routing information:
20007 .code
20008 save_in_file:
20009   driver = manualroute
20010   route_list = \
20011     *.saved.domain1.example  $domain  batch_appendfile; \
20012     *.saved.domain2.example  \
20013       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20014       batch_pipe
20015 .endd
20016 .vindex "&$domain$&"
20017 .vindex "&$host$&"
20018 The first of these just passes the domain in the &$host$& variable, which
20019 doesn't achieve much (since it is also in &$domain$&), but the second does a
20020 file lookup to find a value to pass, causing the router to decline to handle
20021 the address if the lookup fails.
20022
20023 .next
20024 .cindex "UUCP" "example of router for"
20025 Routing mail directly to UUCP software is a specific case of the use of
20026 &(manualroute)& in a gateway to another mail environment. This is an example of
20027 one way it can be done:
20028 .code
20029 # Transport
20030 uucp:
20031   driver = pipe
20032   user = nobody
20033   command = /usr/local/bin/uux -r - \
20034     ${substr_-5:$host}!rmail ${local_part}
20035   return_fail_output = true
20036
20037 # Router
20038 uucphost:
20039   transport = uucp
20040   driver = manualroute
20041   route_data = \
20042     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20043 .endd
20044 The file &_/usr/local/exim/uucphosts_& contains entries like
20045 .code
20046 darksite.ethereal.example:           darksite.UUCP
20047 .endd
20048 It can be set up more simply without adding and removing &".UUCP"& but this way
20049 makes clear the distinction between the domain name
20050 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20051 .endlist
20052 .ecindex IIDmanrou1
20053 .ecindex IIDmanrou2
20054
20055
20056
20057
20058
20059
20060
20061
20062 . ////////////////////////////////////////////////////////////////////////////
20063 . ////////////////////////////////////////////////////////////////////////////
20064
20065 .chapter "The queryprogram router" "CHAPdriverlast"
20066 .scindex IIDquerou1 "&(queryprogram)& router"
20067 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20068 .cindex "routing" "by external program"
20069 The &(queryprogram)& router routes an address by running an external command
20070 and acting on its output. This is an expensive way to route, and is intended
20071 mainly for use in lightly-loaded systems, or for performing experiments.
20072 However, if it is possible to use the precondition options (&%domains%&,
20073 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20074 be used in special cases, even on a busy host. There are the following private
20075 options:
20076 .cindex "options" "&(queryprogram)& router"
20077
20078 .option command queryprogram string&!! unset
20079 This option must be set. It specifies the command that is to be run. The
20080 command is split up into a command name and arguments, and then each is
20081 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20082 &<<CHAPpipetransport>>&).
20083
20084
20085 .option command_group queryprogram string unset
20086 .cindex "gid (group id)" "in &(queryprogram)& router"
20087 This option specifies a gid to be set when running the command while routing an
20088 address for deliver. It must be set if &%command_user%& specifies a numerical
20089 uid. If it begins with a digit, it is interpreted as the numerical value of the
20090 gid. Otherwise it is looked up using &[getgrnam()]&.
20091
20092
20093 .option command_user queryprogram string unset
20094 .cindex "uid (user id)" "for &(queryprogram)&"
20095 This option must be set. It specifies the uid which is set when running the
20096 command while routing an address for delivery. If the value begins with a digit,
20097 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20098 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20099 not set, a value for the gid also.
20100
20101 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20102 root, which it does during a normal delivery in a conventional configuration.
20103 However, when an address is being verified during message reception, Exim is
20104 usually running as the Exim user, not as root. If the &(queryprogram)& router
20105 is called from a non-root process, Exim cannot change uid or gid before running
20106 the command. In this circumstance the command runs under the current uid and
20107 gid.
20108
20109
20110 .option current_directory queryprogram string /
20111 This option specifies an absolute path which is made the current directory
20112 before running the command.
20113
20114
20115 .option timeout queryprogram time 1h
20116 If the command does not complete within the timeout period, its process group
20117 is killed and the message is frozen. A value of zero time specifies no
20118 timeout.
20119
20120
20121 The standard output of the command is connected to a pipe, which is read when
20122 the command terminates. It should consist of a single line of output,
20123 containing up to five fields, separated by white space. The maximum length of
20124 the line is 1023 characters. Longer lines are silently truncated. The first
20125 field is one of the following words (case-insensitive):
20126
20127 .ilist
20128 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20129 below).
20130 .next
20131 &'Decline'&: the router declines; pass the address to the next router, unless
20132 &%no_more%& is set.
20133 .next
20134 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20135 subsequent text on the line is an error message. If the router is run as part
20136 of address verification during an incoming SMTP message, the message is
20137 included in the SMTP response.
20138 .next
20139 &'Defer'&: routing could not be completed at this time; try again later. Any
20140 subsequent text on the line is an error message which is logged. It is not
20141 included in any SMTP response.
20142 .next
20143 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20144 .next
20145 &'Pass'&: pass the address to the next router (or the router specified by
20146 &%pass_router%&), overriding &%no_more%&.
20147 .next
20148 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20149 new addresses, which are routed independently, starting with the first router,
20150 or the router specified by &%redirect_router%&, if set.
20151 .endlist
20152
20153 When the first word is &'accept'&, the remainder of the line consists of a
20154 number of keyed data values, as follows (split into two lines here, to fit on
20155 the page):
20156 .code
20157 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20158 LOOKUP=byname|bydns DATA=<text>
20159 .endd
20160 The data items can be given in any order, and all are optional. If no transport
20161 is included, the transport specified by the generic &%transport%& option is
20162 used. The list of hosts and the lookup type are needed only if the transport is
20163 an &(smtp)& transport that does not itself supply a list of hosts.
20164
20165 The format of the list of hosts is the same as for the &(manualroute)& router.
20166 As well as host names and IP addresses with optional port numbers, as described
20167 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20168 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20169 (see section &<<SECThostshowused>>&).
20170
20171 If the lookup type is not specified, Exim behaves as follows when trying to
20172 find an IP address for each host: First, a DNS lookup is done. If this yields
20173 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20174 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20175 result of the lookup is the result of that call.
20176
20177 .vindex "&$address_data$&"
20178 If the DATA field is set, its value is placed in the &$address_data$&
20179 variable. For example, this return line
20180 .code
20181 accept hosts=x1.y.example:x2.y.example data="rule1"
20182 .endd
20183 routes the address to the default transport, passing a list of two hosts. When
20184 the transport runs, the string &"rule1"& is in &$address_data$&.
20185 .ecindex IIDquerou1
20186 .ecindex IIDquerou2
20187
20188
20189
20190
20191 . ////////////////////////////////////////////////////////////////////////////
20192 . ////////////////////////////////////////////////////////////////////////////
20193
20194 .chapter "The redirect router" "CHAPredirect"
20195 .scindex IIDredrou1 "&(redirect)& router"
20196 .scindex IIDredrou2 "routers" "&(redirect)&"
20197 .cindex "alias file" "in a &(redirect)& router"
20198 .cindex "address redirection" "&(redirect)& router"
20199 The &(redirect)& router handles several kinds of address redirection. Its most
20200 common uses are for resolving local part aliases from a central alias file
20201 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20202 files, but it has many other potential uses. The incoming address can be
20203 redirected in several different ways:
20204
20205 .ilist
20206 It can be replaced by one or more new addresses which are themselves routed
20207 independently.
20208 .next
20209 It can be routed to be delivered to a given file or directory.
20210 .next
20211 It can be routed to be delivered to a specified pipe command.
20212 .next
20213 It can cause an automatic reply to be generated.
20214 .next
20215 It can be forced to fail, optionally with a custom error message.
20216 .next
20217 It can be temporarily deferred, optionally with a custom message.
20218 .next
20219 It can be discarded.
20220 .endlist
20221
20222 The generic &%transport%& option must not be set for &(redirect)& routers.
20223 However, there are some private options which define transports for delivery to
20224 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20225 &%pipe_transport%& and &%reply_transport%& descriptions below.
20226
20227 If success DSNs have been requested
20228 .cindex "DSN" "success"
20229 .cindex "Delivery Status Notification" "success"
20230 redirection triggers one and the DSN options are not passed any further.
20231
20232
20233
20234 .section "Redirection data" "SECID124"
20235 The router operates by interpreting a text string which it obtains either by
20236 expanding the contents of the &%data%& option, or by reading the entire
20237 contents of a file whose name is given in the &%file%& option. These two
20238 options are mutually exclusive. The first is commonly used for handling system
20239 aliases, in a configuration like this:
20240 .code
20241 system_aliases:
20242   driver = redirect
20243   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20244 .endd
20245 If the lookup fails, the expanded string in this example is empty. When the
20246 expansion of &%data%& results in an empty string, the router declines. A forced
20247 expansion failure also causes the router to decline; other expansion failures
20248 cause delivery to be deferred.
20249
20250 A configuration using &%file%& is commonly used for handling users'
20251 &_.forward_& files, like this:
20252 .code
20253 userforward:
20254   driver = redirect
20255   check_local_user
20256   file = $home/.forward
20257   no_verify
20258 .endd
20259 If the file does not exist, or causes no action to be taken (for example, it is
20260 empty or consists only of comments), the router declines. &*Warning*&: This
20261 is not the case when the file contains syntactically valid items that happen to
20262 yield empty addresses, for example, items containing only RFC 2822 address
20263 comments.
20264
20265
20266
20267 .section "Forward files and address verification" "SECID125"
20268 .cindex "address redirection" "while verifying"
20269 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20270 &_.forward_& files, as in the example above. There are two reasons for this:
20271
20272 .ilist
20273 When Exim is receiving an incoming SMTP message from a remote host, it is
20274 running under the Exim uid, not as root. Exim is unable to change uid to read
20275 the file as the user, and it may not be able to read it as the Exim user. So in
20276 practice the router may not be able to operate.
20277 .next
20278 However, even when the router can operate, the existence of a &_.forward_& file
20279 is unimportant when verifying an address. What should be checked is whether the
20280 local part is a valid user name or not. Cutting out the redirection processing
20281 saves some resources.
20282 .endlist
20283
20284
20285
20286
20287
20288
20289 .section "Interpreting redirection data" "SECID126"
20290 .cindex "Sieve filter" "specifying in redirection data"
20291 .cindex "filter" "specifying in redirection data"
20292 The contents of the data string, whether obtained from &%data%& or &%file%&,
20293 can be interpreted in two different ways:
20294
20295 .ilist
20296 If the &%allow_filter%& option is set true, and the data begins with the text
20297 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20298 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20299 respectively. Details of the syntax and semantics of filter files are described
20300 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20301 document is intended for use by end users.
20302 .next
20303 Otherwise, the data must be a comma-separated list of redirection items, as
20304 described in the next section.
20305 .endlist
20306
20307 When a message is redirected to a file (a &"mail folder"&), the file name given
20308 in a non-filter redirection list must always be an absolute path. A filter may
20309 generate a relative path &-- how this is handled depends on the transport's
20310 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20311 for the &(appendfile)& transport.
20312
20313
20314
20315 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20316 .cindex "address redirection" "non-filter list items"
20317 When the redirection data is not an Exim or Sieve filter, for example, if it
20318 comes from a conventional alias or forward file, it consists of a list of
20319 addresses, file names, pipe commands, or certain special items (see section
20320 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20321 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20322 depending on their default values. The items in the list are separated by
20323 commas or newlines.
20324 If a comma is required in an item, the entire item must be enclosed in double
20325 quotes.
20326
20327 Lines starting with a # character are comments, and are ignored, and # may
20328 also appear following a comma, in which case everything between the # and the
20329 next newline character is ignored.
20330
20331 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20332 double quotes are retained because some forms of mail address require their use
20333 (but never to enclose the entire address). In the following description,
20334 &"item"& refers to what remains after any surrounding double quotes have been
20335 removed.
20336
20337 .vindex "&$local_part$&"
20338 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20339 and the expansion contains a reference to &$local_part$&, you should make use
20340 of the &%quote_local_part%& expansion operator, in case the local part contains
20341 special characters. For example, to redirect all mail for the domain
20342 &'obsolete.example'&, retaining the existing local part, you could use this
20343 setting:
20344 .code
20345 data = ${quote_local_part:$local_part}@newdomain.example
20346 .endd
20347
20348
20349 .section "Redirecting to a local mailbox" "SECTredlocmai"
20350 .cindex "routing" "loops in"
20351 .cindex "loop" "while routing, avoidance of"
20352 .cindex "address redirection" "to local mailbox"
20353 A redirection item may safely be the same as the address currently under
20354 consideration. This does not cause a routing loop, because a router is
20355 automatically skipped if any ancestor of the address that is being processed
20356 is the same as the current address and was processed by the current router.
20357 Such an address is therefore passed to the following routers, so it is handled
20358 as if there were no redirection. When making this loop-avoidance test, the
20359 complete local part, including any prefix or suffix, is used.
20360
20361 .cindex "address redirection" "local part without domain"
20362 Specifying the same local part without a domain is a common usage in personal
20363 filter files when the user wants to have messages delivered to the local
20364 mailbox and also forwarded elsewhere. For example, the user whose login is
20365 &'cleo'& might have a &_.forward_& file containing this:
20366 .code
20367 cleo, cleopatra@egypt.example
20368 .endd
20369 .cindex "backslash in alias file"
20370 .cindex "alias file" "backslash in"
20371 For compatibility with other MTAs, such unqualified local parts may be
20372 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20373 it does make a difference if more than one domain is being handled
20374 synonymously.
20375
20376 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20377 2822 address that does not include a domain, the item is qualified using the
20378 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20379 addresses are qualified using the value in &%qualify_recipient%&, but you can
20380 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20381
20382 Care must be taken if there are alias names for local users.
20383 Consider an MTA handling a single local domain where the system alias file
20384 contains:
20385 .code
20386 Sam.Reman: spqr
20387 .endd
20388 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20389 messages in the local mailbox, and also forward copies elsewhere. He creates
20390 this forward file:
20391 .code
20392 Sam.Reman, spqr@reme.elsewhere.example
20393 .endd
20394 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20395 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20396 second time round, because it has previously routed it,
20397 and the following routers presumably cannot handle the alias. The forward file
20398 should really contain
20399 .code
20400 spqr, spqr@reme.elsewhere.example
20401 .endd
20402 but because this is such a common error, the &%check_ancestor%& option (see
20403 below) exists to provide a way to get round it. This is normally set on a
20404 &(redirect)& router that is handling users' &_.forward_& files.
20405
20406
20407
20408 .section "Special items in redirection lists" "SECTspecitredli"
20409 In addition to addresses, the following types of item may appear in redirection
20410 lists (that is, in non-filter redirection data):
20411
20412 .ilist
20413 .cindex "pipe" "in redirection list"
20414 .cindex "address redirection" "to pipe"
20415 An item is treated as a pipe command if it begins with &"|"& and does not parse
20416 as a valid RFC 2822 address that includes a domain. A transport for running the
20417 command must be specified by the &%pipe_transport%& option.
20418 Normally, either the router or the transport specifies a user and a group under
20419 which to run the delivery. The default is to use the Exim user and group.
20420
20421 Single or double quotes can be used for enclosing the individual arguments of
20422 the pipe command; no interpretation of escapes is done for single quotes. If
20423 the command contains a comma character, it is necessary to put the whole item
20424 in double quotes, for example:
20425 .code
20426 "|/some/command ready,steady,go"
20427 .endd
20428 since items in redirection lists are terminated by commas. Do not, however,
20429 quote just the command. An item such as
20430 .code
20431 |"/some/command ready,steady,go"
20432 .endd
20433 is interpreted as a pipe with a rather strange command name, and no arguments.
20434
20435 Note that the above example assumes that the text comes from a lookup source
20436 of some sort, so that the quotes are part of the data.  If composing a
20437 redirect router with a &%data%& option directly specifying this command, the
20438 quotes will be used by the configuration parser to define the extent of one
20439 string, but will not be passed down into the redirect router itself.  There
20440 are two main approaches to get around this: escape quotes to be part of the
20441 data itself, or avoid using this mechanism and instead create a custom
20442 transport with the &%command%& option set and reference that transport from
20443 an &%accept%& router.
20444
20445 .next
20446 .cindex "file" "in redirection list"
20447 .cindex "address redirection" "to file"
20448 An item is interpreted as a path name if it begins with &"/"& and does not
20449 parse as a valid RFC 2822 address that includes a domain. For example,
20450 .code
20451 /home/world/minbari
20452 .endd
20453 is treated as a file name, but
20454 .code
20455 /s=molari/o=babylon/@x400gate.way
20456 .endd
20457 is treated as an address. For a file name, a transport must be specified using
20458 the &%file_transport%& option. However, if the generated path name ends with a
20459 forward slash character, it is interpreted as a directory name rather than a
20460 file name, and &%directory_transport%& is used instead.
20461
20462 Normally, either the router or the transport specifies a user and a group under
20463 which to run the delivery. The default is to use the Exim user and group.
20464
20465 .cindex "&_/dev/null_&"
20466 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20467 bypassed at a high level, and the log entry shows &"**bypassed**"&
20468 instead of a transport name. In this case the user and group are not used.
20469
20470 .next
20471 .cindex "included address list"
20472 .cindex "address redirection" "included external list"
20473 If an item is of the form
20474 .code
20475 :include:<path name>
20476 .endd
20477 a list of further items is taken from the given file and included at that
20478 point. &*Note*&: Such a file can not be a filter file; it is just an
20479 out-of-line addition to the list. The items in the included list are separated
20480 by commas or newlines and are not subject to expansion. If this is the first
20481 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20482 the alias name. This example is incorrect:
20483 .code
20484 list1    :include:/opt/lists/list1
20485 .endd
20486 It must be given as
20487 .code
20488 list1:   :include:/opt/lists/list1
20489 .endd
20490 .next
20491 .cindex "address redirection" "to black hole"
20492 .cindex "delivery" "discard"
20493 .cindex "delivery" "blackhole"
20494 .cindex "black hole"
20495 .cindex "abandoning mail"
20496 Sometimes you want to throw away mail to a particular local part.  Making the
20497 &%data%& option expand to an empty string does not work, because that causes
20498 the router to decline. Instead, the alias item
20499 .code
20500 :blackhole:
20501 .endd
20502 can be used. It does what its name implies. No delivery is
20503 done, and no error message is generated. This has the same effect as specifying
20504 &_/dev/null_& as a destination, but it can be independently disabled.
20505
20506 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20507 delivery is done for the original local part, even if other redirection items
20508 are present. If you are generating a multi-item list (for example, by reading a
20509 database) and need the ability to provide a no-op item, you must use
20510 &_/dev/null_&.
20511
20512 .next
20513 .cindex "delivery" "forcing failure"
20514 .cindex "delivery" "forcing deferral"
20515 .cindex "failing delivery" "forcing"
20516 .cindex "deferred delivery, forcing"
20517 .cindex "customizing" "failure message"
20518 An attempt to deliver a particular address can be deferred or forced to fail by
20519 redirection items of the form
20520 .code
20521 :defer:
20522 :fail:
20523 .endd
20524 respectively. When a redirection list contains such an item, it applies
20525 to the entire redirection; any other items in the list are ignored. Any
20526 text following &':fail:'& or &':defer:'& is placed in the error text
20527 associated with the failure. For example, an alias file might contain:
20528 .code
20529 X.Employee:  :fail: Gone away, no forwarding address
20530 .endd
20531 In the case of an address that is being verified from an ACL or as the subject
20532 of a
20533 .cindex "VRFY" "error text, display of"
20534 VRFY command, the text is included in the SMTP error response by
20535 default.
20536 .cindex "EXPN" "error text, display of"
20537 The text is not included in the response to an EXPN command. In non-SMTP cases
20538 the text is included in the error message that Exim generates.
20539
20540 .cindex "SMTP" "error codes"
20541 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20542 &':fail:'&. However, if the message starts with three digits followed by a
20543 space, optionally followed by an extended code of the form &'n.n.n'&, also
20544 followed by a space, and the very first digit is the same as the default error
20545 code, the code from the message is used instead. If the very first digit is
20546 incorrect, a panic error is logged, and the default code is used. You can
20547 suppress the use of the supplied code in a redirect router by setting the
20548 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20549 ignored.
20550
20551 .vindex "&$acl_verify_message$&"
20552 In an ACL, an explicitly provided message overrides the default, but the
20553 default message is available in the variable &$acl_verify_message$& and can
20554 therefore be included in a custom message if this is desired.
20555
20556 Normally the error text is the rest of the redirection list &-- a comma does
20557 not terminate it &-- but a newline does act as a terminator. Newlines are not
20558 normally present in alias expansions. In &(lsearch)& lookups they are removed
20559 as part of the continuation process, but they may exist in other kinds of
20560 lookup and in &':include:'& files.
20561
20562 During routing for message delivery (as opposed to verification), a redirection
20563 containing &':fail:'& causes an immediate failure of the incoming address,
20564 whereas &':defer:'& causes the message to remain on the queue so that a
20565 subsequent delivery attempt can happen at a later time. If an address is
20566 deferred for too long, it will ultimately fail, because the normal retry
20567 rules still apply.
20568
20569 .next
20570 .cindex "alias file" "exception to default"
20571 Sometimes it is useful to use a single-key search type with a default (see
20572 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20573 for exceptions to the default. These can be handled by aliasing them to
20574 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20575 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20576 results in an empty redirection list has the same effect.
20577 .endlist
20578
20579
20580 .section "Duplicate addresses" "SECTdupaddr"
20581 .cindex "duplicate addresses"
20582 .cindex "address duplicate, discarding"
20583 .cindex "pipe" "duplicated"
20584 Exim removes duplicate addresses from the list to which it is delivering, so as
20585 to deliver just one copy to each address. This does not apply to deliveries
20586 routed to pipes by different immediate parent addresses, but an indirect
20587 aliasing scheme of the type
20588 .code
20589 pipe:       |/some/command $local_part
20590 localpart1: pipe
20591 localpart2: pipe
20592 .endd
20593 does not work with a message that is addressed to both local parts, because
20594 when the second is aliased to the intermediate local part &"pipe"& it gets
20595 discarded as being the same as a previously handled address. However, a scheme
20596 such as
20597 .code
20598 localpart1: |/some/command $local_part
20599 localpart2: |/some/command $local_part
20600 .endd
20601 does result in two different pipe deliveries, because the immediate parents of
20602 the pipes are distinct.
20603
20604
20605
20606 .section "Repeated redirection expansion" "SECID128"
20607 .cindex "repeated redirection expansion"
20608 .cindex "address redirection" "repeated for each delivery attempt"
20609 When a message cannot be delivered to all of its recipients immediately,
20610 leading to two or more delivery attempts, redirection expansion is carried out
20611 afresh each time for those addresses whose children were not all previously
20612 delivered. If redirection is being used as a mailing list, this can lead to new
20613 members of the list receiving copies of old messages. The &%one_time%& option
20614 can be used to avoid this.
20615
20616
20617 .section "Errors in redirection lists" "SECID129"
20618 .cindex "address redirection" "errors"
20619 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20620 error is skipped, and an entry is written to the main log. This may be useful
20621 for mailing lists that are automatically managed. Otherwise, if an error is
20622 detected while generating the list of new addresses, the original address is
20623 deferred. See also &%syntax_errors_to%&.
20624
20625
20626
20627 .section "Private options for the redirect router" "SECID130"
20628
20629 .cindex "options" "&(redirect)& router"
20630 The private options for the &(redirect)& router are as follows:
20631
20632
20633 .option allow_defer redirect boolean false
20634 Setting this option allows the use of &':defer:'& in non-filter redirection
20635 data, or the &%defer%& command in an Exim filter file.
20636
20637
20638 .option allow_fail redirect boolean false
20639 .cindex "failing delivery" "from filter"
20640 If this option is true, the &':fail:'& item can be used in a redirection list,
20641 and the &%fail%& command may be used in an Exim filter file.
20642
20643
20644 .option allow_filter redirect boolean false
20645 .cindex "filter" "enabling use of"
20646 .cindex "Sieve filter" "enabling use of"
20647 Setting this option allows Exim to interpret redirection data that starts with
20648 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20649 are some features of Exim filter files that some administrators may wish to
20650 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20651
20652 It is also possible to lock out Exim filters or Sieve filters while allowing
20653 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20654
20655
20656 The filter is run using the uid and gid set by the generic &%user%& and
20657 &%group%& options. These take their defaults from the password data if
20658 &%check_local_user%& is set, so in the normal case of users' personal filter
20659 files, the filter is run as the relevant user. When &%allow_filter%& is set
20660 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20661
20662
20663
20664 .option allow_freeze redirect boolean false
20665 .cindex "freezing messages" "allowing in filter"
20666 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20667 This command is more normally encountered in system filters, and is disabled by
20668 default for redirection filters because it isn't something you usually want to
20669 let ordinary users do.
20670
20671
20672
20673 .option check_ancestor redirect boolean false
20674 This option is concerned with handling generated addresses that are the same
20675 as some address in the list of redirection ancestors of the current address.
20676 Although it is turned off by default in the code, it is set in the default
20677 configuration file for handling users' &_.forward_& files. It is recommended
20678 for this use of the &(redirect)& router.
20679
20680 When &%check_ancestor%& is set, if a generated address (including the domain)
20681 is the same as any ancestor of the current address, it is replaced by a copy of
20682 the current address. This helps in the case where local part A is aliased to B,
20683 and B has a &_.forward_& file pointing back to A. For example, within a single
20684 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20685 &_&~jb/.forward_& contains:
20686 .code
20687 \Joe.Bloggs, <other item(s)>
20688 .endd
20689 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20690 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20691 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20692 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20693 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20694 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20695 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20696 original address. See also the &%repeat_use%& option below.
20697
20698
20699 .option check_group redirect boolean "see below"
20700 When the &%file%& option is used, the group owner of the file is checked only
20701 when this option is set. The permitted groups are those listed in the
20702 &%owngroups%& option, together with the user's default group if
20703 &%check_local_user%& is set. If the file has the wrong group, routing is
20704 deferred. The default setting for this option is true if &%check_local_user%&
20705 is set and the &%modemask%& option permits the group write bit, or if the
20706 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20707
20708
20709
20710 .option check_owner redirect boolean "see below"
20711 When the &%file%& option is used, the owner of the file is checked only when
20712 this option is set. If &%check_local_user%& is set, the local user is
20713 permitted; otherwise the owner must be one of those listed in the &%owners%&
20714 option. The default value for this option is true if &%check_local_user%& or
20715 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20716
20717
20718 .option data redirect string&!! unset
20719 This option is mutually exclusive with &%file%&. One or other of them must be
20720 set, but not both. The contents of &%data%& are expanded, and then used as the
20721 list of forwarding items, or as a set of filtering instructions. If the
20722 expansion is forced to fail, or the result is an empty string or a string that
20723 has no effect (consists entirely of comments), the router declines.
20724
20725 When filtering instructions are used, the string must begin with &"#Exim
20726 filter"&, and all comments in the string, including this initial one, must be
20727 terminated with newline characters. For example:
20728 .code
20729 data = #Exim filter\n\
20730        if $h_to: contains Exim then save $home/mail/exim endif
20731 .endd
20732 If you are reading the data from a database where newlines cannot be included,
20733 you can use the &${sg}$& expansion item to turn the escape string of your
20734 choice into a newline.
20735
20736
20737 .option directory_transport redirect string&!! unset
20738 A &(redirect)& router sets up a direct delivery to a directory when a path name
20739 ending with a slash is specified as a new &"address"&. The transport used is
20740 specified by this option, which, after expansion, must be the name of a
20741 configured transport. This should normally be an &(appendfile)& transport.
20742
20743
20744 .option file redirect string&!! unset
20745 This option specifies the name of a file that contains the redirection data. It
20746 is mutually exclusive with the &%data%& option. The string is expanded before
20747 use; if the expansion is forced to fail, the router declines. Other expansion
20748 failures cause delivery to be deferred. The result of a successful expansion
20749 must be an absolute path. The entire file is read and used as the redirection
20750 data. If the data is an empty string or a string that has no effect (consists
20751 entirely of comments), the router declines.
20752
20753 .cindex "NFS" "checking for file existence"
20754 If the attempt to open the file fails with a &"does not exist"& error, Exim
20755 runs a check on the containing directory,
20756 unless &%ignore_enotdir%& is true (see below).
20757 If the directory does not appear to exist, delivery is deferred. This can
20758 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20759 is a mount problem. If the containing directory does exist, but the file does
20760 not, the router declines.
20761
20762
20763 .option file_transport redirect string&!! unset
20764 .vindex "&$address_file$&"
20765 A &(redirect)& router sets up a direct delivery to a file when a path name not
20766 ending in a slash is specified as a new &"address"&. The transport used is
20767 specified by this option, which, after expansion, must be the name of a
20768 configured transport. This should normally be an &(appendfile)& transport. When
20769 it is running, the file name is in &$address_file$&.
20770
20771
20772 .option filter_prepend_home redirect boolean true
20773 When this option is true, if a &(save)& command in an Exim filter specifies a
20774 relative path, and &$home$& is defined, it is automatically prepended to the
20775 relative path. If this option is set false, this action does not happen. The
20776 relative path is then passed to the transport unmodified.
20777
20778
20779 .option forbid_blackhole redirect boolean false
20780 .cindex "restricting access to features"
20781 .cindex "filter" "locking out certain features"
20782 If this option is true, the &':blackhole:'& item may not appear in a
20783 redirection list.
20784
20785
20786 .option forbid_exim_filter redirect boolean false
20787 .cindex "restricting access to features"
20788 .cindex "filter" "locking out certain features"
20789 If this option is set true, only Sieve filters are permitted when
20790 &%allow_filter%& is true.
20791
20792
20793
20794
20795 .option forbid_file redirect boolean false
20796 .cindex "restricting access to features"
20797 .cindex "delivery" "to file; forbidding"
20798 .cindex "filter" "locking out certain features"
20799 .cindex "Sieve filter" "forbidding delivery to a file"
20800 .cindex "Sieve filter" "&""keep""& facility; disabling"
20801 If this option is true, this router may not generate a new address that
20802 specifies delivery to a local file or directory, either from a filter or from a
20803 conventional forward file. This option is forced to be true if &%one_time%& is
20804 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20805 locks out the Sieve's &"keep"& facility.
20806
20807
20808 .option forbid_filter_dlfunc redirect boolean false
20809 .cindex "restricting access to features"
20810 .cindex "filter" "locking out certain features"
20811 If this option is true, string expansions in Exim filters are not allowed to
20812 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20813 functions.
20814
20815 .option forbid_filter_existstest redirect boolean false
20816 .cindex "restricting access to features"
20817 .cindex "filter" "locking out certain features"
20818 .cindex "expansion" "statting a file"
20819 If this option is true, string expansions in Exim filters are not allowed to
20820 make use of the &%exists%& condition or the &%stat%& expansion item.
20821
20822 .option forbid_filter_logwrite redirect boolean false
20823 .cindex "restricting access to features"
20824 .cindex "filter" "locking out certain features"
20825 If this option is true, use of the logging facility in Exim filters is not
20826 permitted. Logging is in any case available only if the filter is being run
20827 under some unprivileged uid (which is normally the case for ordinary users'
20828 &_.forward_& files).
20829
20830
20831 .option forbid_filter_lookup redirect boolean false
20832 .cindex "restricting access to features"
20833 .cindex "filter" "locking out certain features"
20834 If this option is true, string expansions in Exim filter files are not allowed
20835 to make use of &%lookup%& items.
20836
20837
20838 .option forbid_filter_perl redirect boolean false
20839 .cindex "restricting access to features"
20840 .cindex "filter" "locking out certain features"
20841 This option has an effect only if Exim is built with embedded Perl support. If
20842 it is true, string expansions in Exim filter files are not allowed to make use
20843 of the embedded Perl support.
20844
20845
20846 .option forbid_filter_readfile redirect boolean false
20847 .cindex "restricting access to features"
20848 .cindex "filter" "locking out certain features"
20849 If this option is true, string expansions in Exim filter files are not allowed
20850 to make use of &%readfile%& items.
20851
20852
20853 .option forbid_filter_readsocket redirect boolean false
20854 .cindex "restricting access to features"
20855 .cindex "filter" "locking out certain features"
20856 If this option is true, string expansions in Exim filter files are not allowed
20857 to make use of &%readsocket%& items.
20858
20859
20860 .option forbid_filter_reply redirect boolean false
20861 .cindex "restricting access to features"
20862 .cindex "filter" "locking out certain features"
20863 If this option is true, this router may not generate an automatic reply
20864 message. Automatic replies can be generated only from Exim or Sieve filter
20865 files, not from traditional forward files. This option is forced to be true if
20866 &%one_time%& is set.
20867
20868
20869 .option forbid_filter_run redirect boolean false
20870 .cindex "restricting access to features"
20871 .cindex "filter" "locking out certain features"
20872 If this option is true, string expansions in Exim filter files are not allowed
20873 to make use of &%run%& items.
20874
20875
20876 .option forbid_include redirect boolean false
20877 .cindex "restricting access to features"
20878 .cindex "filter" "locking out certain features"
20879 If this option is true, items of the form
20880 .code
20881 :include:<path name>
20882 .endd
20883 are not permitted in non-filter redirection lists.
20884
20885
20886 .option forbid_pipe redirect boolean false
20887 .cindex "restricting access to features"
20888 .cindex "filter" "locking out certain features"
20889 .cindex "delivery" "to pipe; forbidding"
20890 If this option is true, this router may not generate a new address which
20891 specifies delivery to a pipe, either from an Exim filter or from a conventional
20892 forward file. This option is forced to be true if &%one_time%& is set.
20893
20894
20895 .option forbid_sieve_filter redirect boolean false
20896 .cindex "restricting access to features"
20897 .cindex "filter" "locking out certain features"
20898 If this option is set true, only Exim filters are permitted when
20899 &%allow_filter%& is true.
20900
20901
20902 .cindex "SMTP" "error codes"
20903 .option forbid_smtp_code redirect boolean false
20904 If this option is set true, any SMTP error codes that are present at the start
20905 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20906 the default codes (451 and 550, respectively) are always used.
20907
20908
20909
20910
20911 .option hide_child_in_errmsg redirect boolean false
20912 .cindex "bounce message" "redirection details; suppressing"
20913 If this option is true, it prevents Exim from quoting a child address if it
20914 generates a bounce or delay message for it. Instead it says &"an address
20915 generated from <&'the top level address'&>"&. Of course, this applies only to
20916 bounces generated locally. If a message is forwarded to another host, &'its'&
20917 bounce may well quote the generated address.
20918
20919
20920 .option ignore_eacces redirect boolean false
20921 .cindex "EACCES"
20922 If this option is set and an attempt to open a redirection file yields the
20923 EACCES error (permission denied), the &(redirect)& router behaves as if the
20924 file did not exist.
20925
20926
20927 .option ignore_enotdir redirect boolean false
20928 .cindex "ENOTDIR"
20929 If this option is set and an attempt to open a redirection file yields the
20930 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20931 router behaves as if the file did not exist.
20932
20933 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20934 router that has the &%file%& option set discovers that the file does not exist
20935 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20936 against unmounted NFS directories. If the parent can not be statted, delivery
20937 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20938 is set, because that option tells Exim to ignore &"something on the path is not
20939 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20940 that some operating systems give ENOENT where others give ENOTDIR.
20941
20942
20943
20944 .option include_directory redirect string unset
20945 If this option is set, the path names of any &':include:'& items in a
20946 redirection list must start with this directory.
20947
20948
20949 .option modemask redirect "octal integer" 022
20950 This specifies mode bits which must not be set for a file specified by the
20951 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20952
20953
20954 .option one_time redirect boolean false
20955 .cindex "one-time aliasing/forwarding expansion"
20956 .cindex "alias file" "one-time expansion"
20957 .cindex "forward file" "one-time expansion"
20958 .cindex "mailing lists" "one-time expansion"
20959 .cindex "address redirection" "one-time expansion"
20960 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20961 files each time it tries to deliver a message causes a problem when one or more
20962 of the generated addresses fails be delivered at the first attempt. The problem
20963 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20964 but of what happens when the redirection list changes during the time that the
20965 message is on Exim's queue. This is particularly true in the case of mailing
20966 lists, where new subscribers might receive copies of messages that were posted
20967 before they subscribed.
20968
20969 If &%one_time%& is set and any addresses generated by the router fail to
20970 deliver at the first attempt, the failing addresses are added to the message as
20971 &"top level"& addresses, and the parent address that generated them is marked
20972 &"delivered"&. Thus, redirection does not happen again at the next delivery
20973 attempt.
20974
20975 &*Warning 1*&: Any header line addition or removal that is specified by this
20976 router would be lost if delivery did not succeed at the first attempt. For this
20977 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20978 permitted when &%one_time%& is set.
20979
20980 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20981 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20982 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20983
20984 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20985 &%one_time%&.
20986
20987 The original top-level address is remembered with each of the generated
20988 addresses, and is output in any log messages. However, any intermediate parent
20989 addresses are not recorded. This makes a difference to the log only if
20990 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20991 typically be used for mailing lists, where there is normally just one level of
20992 expansion.
20993
20994
20995 .option owners redirect "string list" unset
20996 .cindex "ownership" "alias file"
20997 .cindex "ownership" "forward file"
20998 .cindex "alias file" "ownership"
20999 .cindex "forward file" "ownership"
21000 This specifies a list of permitted owners for the file specified by &%file%&.
21001 This list is in addition to the local user when &%check_local_user%& is set.
21002 See &%check_owner%& above.
21003
21004
21005 .option owngroups redirect "string list" unset
21006 This specifies a list of permitted groups for the file specified by &%file%&.
21007 The list is in addition to the local user's primary group when
21008 &%check_local_user%& is set. See &%check_group%& above.
21009
21010
21011 .option pipe_transport redirect string&!! unset
21012 .vindex "&$address_pipe$&"
21013 A &(redirect)& router sets up a direct delivery to a pipe when a string
21014 starting with a vertical bar character is specified as a new &"address"&. The
21015 transport used is specified by this option, which, after expansion, must be the
21016 name of a configured transport. This should normally be a &(pipe)& transport.
21017 When the transport is run, the pipe command is in &$address_pipe$&.
21018
21019
21020 .option qualify_domain redirect string&!! unset
21021 .vindex "&$qualify_recipient$&"
21022 If this option is set, and an unqualified address (one without a domain) is
21023 generated, and that address would normally be qualified by the global setting
21024 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21025 expanding this string. If the expansion fails, the router declines. If you want
21026 to revert to the default, you can have the expansion generate
21027 &$qualify_recipient$&.
21028
21029 This option applies to all unqualified addresses generated by Exim filters,
21030 but for traditional &_.forward_& files, it applies only to addresses that are
21031 not preceded by a backslash. Sieve filters cannot generate unqualified
21032 addresses.
21033
21034 .option qualify_preserve_domain redirect boolean false
21035 .cindex "domain" "in redirection; preserving"
21036 .cindex "preserving domain in redirection"
21037 .cindex "address redirection" "domain; preserving"
21038 If this option is set, the router's local &%qualify_domain%& option must not be
21039 set (a configuration error occurs if it is). If an unqualified address (one
21040 without a domain) is generated, it is qualified with the domain of the parent
21041 address (the immediately preceding ancestor) instead of the global
21042 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21043 this applies whether or not the address is preceded by a backslash.
21044
21045
21046 .option repeat_use redirect boolean true
21047 If this option is set false, the router is skipped for a child address that has
21048 any ancestor that was routed by this router. This test happens before any of
21049 the other preconditions are tested. Exim's default anti-looping rules skip
21050 only when the ancestor is the same as the current address. See also
21051 &%check_ancestor%& above and the generic &%redirect_router%& option.
21052
21053
21054 .option reply_transport redirect string&!! unset
21055 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21056 &%vacation%& command is used in a filter file. The transport used is specified
21057 by this option, which, after expansion, must be the name of a configured
21058 transport. This should normally be an &(autoreply)& transport. Other transports
21059 are unlikely to do anything sensible or useful.
21060
21061
21062 .option rewrite redirect boolean true
21063 .cindex "address redirection" "disabling rewriting"
21064 If this option is set false, addresses generated by the router are not
21065 subject to address rewriting. Otherwise, they are treated like new addresses
21066 and are rewritten according to the global rewriting rules.
21067
21068
21069 .option sieve_subaddress redirect string&!! unset
21070 The value of this option is passed to a Sieve filter to specify the
21071 :subaddress part of an address.
21072
21073 .option sieve_useraddress redirect string&!! unset
21074 The value of this option is passed to a Sieve filter to specify the :user part
21075 of an address. However, if it is unset, the entire original local part
21076 (including any prefix or suffix) is used for :user.
21077
21078
21079 .option sieve_vacation_directory redirect string&!! unset
21080 .cindex "Sieve filter" "vacation directory"
21081 To enable the &"vacation"& extension for Sieve filters, you must set
21082 &%sieve_vacation_directory%& to the directory where vacation databases are held
21083 (do not put anything else in that directory), and ensure that the
21084 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21085 needs their own directory; Exim will create it if necessary.
21086
21087
21088
21089 .option skip_syntax_errors redirect boolean false
21090 .cindex "forward file" "broken"
21091 .cindex "address redirection" "broken files"
21092 .cindex "alias file" "broken"
21093 .cindex "broken alias or forward files"
21094 .cindex "ignoring faulty addresses"
21095 .cindex "skipping faulty addresses"
21096 .cindex "error" "skipping bad syntax"
21097 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21098 non-filter redirection data are skipped, and each failing address is logged. If
21099 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21100 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21101 are expanded and placed at the head of the error message generated by
21102 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21103 be the same address as the generic &%errors_to%& option. The
21104 &%skip_syntax_errors%& option is often used when handling mailing lists.
21105
21106 If all the addresses in a redirection list are skipped because of syntax
21107 errors, the router declines to handle the original address, and it is passed to
21108 the following routers.
21109
21110 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21111 error in the filter causes filtering to be abandoned without any action being
21112 taken. The incident is logged, and the router declines to handle the address,
21113 so it is passed to the following routers.
21114
21115 .cindex "Sieve filter" "syntax errors in"
21116 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21117 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21118 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21119
21120 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21121 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21122 option, used with an address that does not get redirected, can be used to
21123 notify users of these errors, by means of a router like this:
21124 .code
21125 userforward:
21126   driver = redirect
21127   allow_filter
21128   check_local_user
21129   file = $home/.forward
21130   file_transport = address_file
21131   pipe_transport = address_pipe
21132   reply_transport = address_reply
21133   no_verify
21134   skip_syntax_errors
21135   syntax_errors_to = real-$local_part@$domain
21136   syntax_errors_text = \
21137    This is an automatically generated message. An error has\n\
21138    been found in your .forward file. Details of the error are\n\
21139    reported below. While this error persists, you will receive\n\
21140    a copy of this message for every message that is addressed\n\
21141    to you. If your .forward file is a filter file, or if it is\n\
21142    a non-filter file containing no valid forwarding addresses,\n\
21143    a copy of each incoming message will be put in your normal\n\
21144    mailbox. If a non-filter file contains at least one valid\n\
21145    forwarding address, forwarding to the valid addresses will\n\
21146    happen, and those will be the only deliveries that occur.
21147 .endd
21148 You also need a router to ensure that local addresses that are prefixed by
21149 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21150 put this immediately before the &(userforward)& router:
21151 .code
21152 real_localuser:
21153   driver = accept
21154   check_local_user
21155   local_part_prefix = real-
21156   transport = local_delivery
21157 .endd
21158 For security, it would probably be a good idea to restrict the use of this
21159 router to locally-generated messages, using a condition such as this:
21160 .code
21161   condition = ${if match {$sender_host_address}\
21162                          {\N^(|127\.0\.0\.1)$\N}}
21163 .endd
21164
21165
21166 .option syntax_errors_text redirect string&!! unset
21167 See &%skip_syntax_errors%& above.
21168
21169
21170 .option syntax_errors_to redirect string unset
21171 See &%skip_syntax_errors%& above.
21172 .ecindex IIDredrou1
21173 .ecindex IIDredrou2
21174
21175
21176
21177
21178
21179
21180 . ////////////////////////////////////////////////////////////////////////////
21181 . ////////////////////////////////////////////////////////////////////////////
21182
21183 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21184          "Environment for local transports"
21185 .scindex IIDenvlotra1 "local transports" "environment for"
21186 .scindex IIDenvlotra2 "environment" "local transports"
21187 .scindex IIDenvlotra3 "transport" "local; environment for"
21188 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21189 transport can be thought of as similar to a pipe.) Exim always runs transports
21190 in subprocesses, under specified uids and gids. Typical deliveries to local
21191 mailboxes run under the uid and gid of the local user.
21192
21193 Exim also sets a specific current directory while running the transport; for
21194 some transports a home directory setting is also relevant. The &(pipe)&
21195 transport is the only one that sets up environment variables; see section
21196 &<<SECTpipeenv>>& for details.
21197
21198 The values used for the uid, gid, and the directories may come from several
21199 different places. In many cases, the router that handles the address associates
21200 settings with that address as a result of its &%check_local_user%&, &%group%&,
21201 or &%user%& options. However, values may also be given in the transport's own
21202 configuration, and these override anything that comes from the router.
21203
21204
21205
21206 .section "Concurrent deliveries" "SECID131"
21207 .cindex "concurrent deliveries"
21208 .cindex "simultaneous deliveries"
21209 If two different messages for the same local recipient arrive more or less
21210 simultaneously, the two delivery processes are likely to run concurrently. When
21211 the &(appendfile)& transport is used to write to a file, Exim applies locking
21212 rules to stop concurrent processes from writing to the same file at the same
21213 time.
21214
21215 However, when you use a &(pipe)& transport, it is up to you to arrange any
21216 locking that is needed. Here is a silly example:
21217 .code
21218 my_transport:
21219   driver = pipe
21220   command = /bin/sh -c 'cat >>/some/file'
21221 .endd
21222 This is supposed to write the message at the end of the file. However, if two
21223 messages arrive at the same time, the file will be scrambled. You can use the
21224 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21225 file using the same algorithm that Exim itself uses.
21226
21227
21228
21229
21230 .section "Uids and gids" "SECTenvuidgid"
21231 .cindex "local transports" "uid and gid"
21232 .cindex "transport" "local; uid and gid"
21233 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21234 overrides any group that the router set in the address, even if &%user%& is not
21235 set for the transport. This makes it possible, for example, to run local mail
21236 delivery under the uid of the recipient (set by the router), but in a special
21237 group (set by the transport). For example:
21238 .code
21239 # Routers ...
21240 # User/group are set by check_local_user in this router
21241 local_users:
21242   driver = accept
21243   check_local_user
21244   transport = group_delivery
21245
21246 # Transports ...
21247 # This transport overrides the group
21248 group_delivery:
21249   driver = appendfile
21250   file = /var/spool/mail/$local_part
21251   group = mail
21252 .endd
21253 If &%user%& is set for a transport, its value overrides what is set in the
21254 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21255 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21256 set.
21257
21258 .oindex "&%initgroups%&"
21259 When the uid is taken from the transport's configuration, the &[initgroups()]&
21260 function is called for the groups associated with that uid if the
21261 &%initgroups%& option is set for the transport. When the uid is not specified
21262 by the transport, but is associated with the address by a router, the option
21263 for calling &[initgroups()]& is taken from the router configuration.
21264
21265 .cindex "&(pipe)& transport" "uid for"
21266 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21267 is set and &%user%& is not set, the uid of the process that called Exim to
21268 receive the message is used, and if &%group%& is not set, the corresponding
21269 original gid is also used.
21270
21271 This is the detailed preference order for obtaining a gid; the first of the
21272 following that is set is used:
21273
21274 .ilist
21275 A &%group%& setting of the transport;
21276 .next
21277 A &%group%& setting of the router;
21278 .next
21279 A gid associated with a user setting of the router, either as a result of
21280 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21281 .next
21282 The group associated with a non-numeric &%user%& setting of the transport;
21283 .next
21284 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21285 the uid is the creator's uid;
21286 .next
21287 The Exim gid if the Exim uid is being used as a default.
21288 .endlist
21289
21290 If, for example, the user is specified numerically on the router and there are
21291 no group settings, no gid is available. In this situation, an error occurs.
21292 This is different for the uid, for which there always is an ultimate default.
21293 The first of the following that is set is used:
21294
21295 .ilist
21296 A &%user%& setting of the transport;
21297 .next
21298 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21299 .next
21300 A &%user%& setting of the router;
21301 .next
21302 A &%check_local_user%& setting of the router;
21303 .next
21304 The Exim uid.
21305 .endlist
21306
21307 Of course, an error will still occur if the uid that is chosen is on the
21308 &%never_users%& list.
21309
21310
21311
21312
21313
21314 .section "Current and home directories" "SECID132"
21315 .cindex "current directory for local transport"
21316 .cindex "home directory" "for local transport"
21317 .cindex "transport" "local; home directory for"
21318 .cindex "transport" "local; current directory for"
21319 Routers may set current and home directories for local transports by means of
21320 the &%transport_current_directory%& and &%transport_home_directory%& options.
21321 However, if the transport's &%current_directory%& or &%home_directory%& options
21322 are set, they override the router's values. In detail, the home directory
21323 for a local transport is taken from the first of these values that is set:
21324
21325 .ilist
21326 The &%home_directory%& option on the transport;
21327 .next
21328 The &%transport_home_directory%& option on the router;
21329 .next
21330 The password data if &%check_local_user%& is set on the router;
21331 .next
21332 The &%router_home_directory%& option on the router.
21333 .endlist
21334
21335 The current directory is taken from the first of these values that is set:
21336
21337 .ilist
21338 The &%current_directory%& option on the transport;
21339 .next
21340 The &%transport_current_directory%& option on the router.
21341 .endlist
21342
21343
21344 If neither the router nor the transport sets a current directory, Exim uses the
21345 value of the home directory, if it is set. Otherwise it sets the current
21346 directory to &_/_& before running a local transport.
21347
21348
21349
21350 .section "Expansion variables derived from the address" "SECID133"
21351 .vindex "&$domain$&"
21352 .vindex "&$local_part$&"
21353 .vindex "&$original_domain$&"
21354 Normally a local delivery is handling a single address, and in that case the
21355 variables such as &$domain$& and &$local_part$& are set during local
21356 deliveries. However, in some circumstances more than one address may be handled
21357 at once (for example, while writing batch SMTP for onward transmission by some
21358 other means). In this case, the variables associated with the local part are
21359 never set, &$domain$& is set only if all the addresses have the same domain,
21360 and &$original_domain$& is never set.
21361 .ecindex IIDenvlotra1
21362 .ecindex IIDenvlotra2
21363 .ecindex IIDenvlotra3
21364
21365
21366
21367
21368
21369
21370
21371 . ////////////////////////////////////////////////////////////////////////////
21372 . ////////////////////////////////////////////////////////////////////////////
21373
21374 .chapter "Generic options for transports" "CHAPtransportgeneric"
21375 .scindex IIDgenoptra1 "generic options" "transport"
21376 .scindex IIDgenoptra2 "options" "generic; for transports"
21377 .scindex IIDgenoptra3 "transport" "generic options for"
21378 The following generic options apply to all transports:
21379
21380
21381 .option body_only transports boolean false
21382 .cindex "transport" "body only"
21383 .cindex "message" "transporting body only"
21384 .cindex "body of message" "transporting"
21385 If this option is set, the message's headers are not transported. It is
21386 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21387 or &(pipe)& transports, the settings of &%message_prefix%& and
21388 &%message_suffix%& should be checked, because this option does not
21389 automatically suppress them.
21390
21391
21392 .option current_directory transports string&!! unset
21393 .cindex "transport" "current directory for"
21394 This specifies the current directory that is to be set while running the
21395 transport, overriding any value that may have been set by the router.
21396 If the expansion fails for any reason, including forced failure, an error is
21397 logged, and delivery is deferred.
21398
21399
21400 .option disable_logging transports boolean false
21401 If this option is set true, nothing is logged for any
21402 deliveries by the transport or for any
21403 transport errors. You should not set this option unless you really, really know
21404 what you are doing.
21405
21406
21407 .option debug_print transports string&!! unset
21408 .cindex "testing" "variables in drivers"
21409 If this option is set and debugging is enabled (see the &%-d%& command line
21410 option), the string is expanded and included in the debugging output when the
21411 transport is run.
21412 If expansion of the string fails, the error message is written to the debugging
21413 output, and Exim carries on processing.
21414 This facility is provided to help with checking out the values of variables and
21415 so on when debugging driver configurations. For example, if a &%headers_add%&
21416 option is not working properly, &%debug_print%& could be used to output the
21417 variables it references. A newline is added to the text if it does not end with
21418 one.
21419 The variables &$transport_name$& and &$router_name$& contain the name of the
21420 transport and the router that called it.
21421
21422 .option delivery_date_add transports boolean false
21423 .cindex "&'Delivery-date:'& header line"
21424 If this option is true, a &'Delivery-date:'& header is added to the message.
21425 This gives the actual time the delivery was made. As this is not a standard
21426 header, Exim has a configuration option (&%delivery_date_remove%&) which
21427 requests its removal from incoming messages, so that delivered messages can
21428 safely be resent to other recipients.
21429
21430
21431 .option driver transports string unset
21432 This specifies which of the available transport drivers is to be used.
21433 There is no default, and this option must be set for every transport.
21434
21435
21436 .option envelope_to_add transports boolean false
21437 .cindex "&'Envelope-to:'& header line"
21438 If this option is true, an &'Envelope-to:'& header is added to the message.
21439 This gives the original address(es) in the incoming envelope that caused this
21440 delivery to happen. More than one address may be present if the transport is
21441 configured to handle several addresses at once, or if more than one original
21442 address was redirected to the same final address. As this is not a standard
21443 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21444 its removal from incoming messages, so that delivered messages can safely be
21445 resent to other recipients.
21446
21447
21448 .option event_action transports string&!! unset
21449 .cindex events
21450 This option declares a string to be expanded for Exim's events mechanism.
21451 For details see chapter &<<CHAPevents>>&.
21452
21453
21454 .option group transports string&!! "Exim group"
21455 .cindex "transport" "group; specifying"
21456 This option specifies a gid for running the transport process, overriding any
21457 value that the router supplies, and also overriding any value associated with
21458 &%user%& (see below).
21459
21460
21461 .option headers_add transports list&!! unset
21462 .cindex "header lines" "adding in transport"
21463 .cindex "transport" "header lines; adding"
21464 This option specifies a list of text headers,
21465 newline-separated (by default, changeable in the usual way),
21466 which are (separately) expanded and added to the header
21467 portion of a message as it is transported, as described in section
21468 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21469 routers. If the result of the expansion is an empty string, or if the expansion
21470 is forced to fail, no action is taken. Other expansion failures are treated as
21471 errors and cause the delivery to be deferred.
21472
21473 Unlike most options, &%headers_add%& can be specified multiple times
21474 for a transport; all listed headers are added.
21475
21476
21477 .option headers_only transports boolean false
21478 .cindex "transport" "header lines only"
21479 .cindex "message" "transporting headers only"
21480 .cindex "header lines" "transporting"
21481 If this option is set, the message's body is not transported. It is mutually
21482 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21483 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21484 checked, since this option does not automatically suppress them.
21485
21486
21487 .option headers_remove transports list&!! unset
21488 .cindex "header lines" "removing"
21489 .cindex "transport" "header lines; removing"
21490 This option specifies a list of header names,
21491 colon-separated (by default, changeable in the usual way);
21492 these headers are omitted from the message as it is transported, as described
21493 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21494 routers.
21495 Each list item is separately expanded.
21496 If the result of the expansion is an empty string, or if the expansion
21497 is forced to fail, no action is taken. Other expansion failures are treated as
21498 errors and cause the delivery to be deferred.
21499
21500 Unlike most options, &%headers_remove%& can be specified multiple times
21501 for a transport; all listed headers are removed.
21502
21503 &*Warning*&: Because of the separate expansion of the list items,
21504 items that contain a list separator must have it doubled.
21505 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21506
21507
21508
21509 .option headers_rewrite transports string unset
21510 .cindex "transport" "header lines; rewriting"
21511 .cindex "rewriting" "at transport time"
21512 This option allows addresses in header lines to be rewritten at transport time,
21513 that is, as the message is being copied to its destination. The contents of the
21514 option are a colon-separated list of rewriting rules. Each rule is in exactly
21515 the same form as one of the general rewriting rules that are applied when a
21516 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21517 example,
21518 .code
21519 headers_rewrite = a@b c@d f : \
21520                   x@y w@z
21521 .endd
21522 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21523 &'w@z'& in all address-bearing header lines. The rules are applied to the
21524 header lines just before they are written out at transport time, so they affect
21525 only those copies of the message that pass through the transport. However, only
21526 the message's original header lines, and any that were added by a system
21527 filter, are rewritten. If a router or transport adds header lines, they are not
21528 affected by this option. These rewriting rules are &'not'& applied to the
21529 envelope. You can change the return path using &%return_path%&, but you cannot
21530 change envelope recipients at this time.
21531
21532
21533 .option home_directory transports string&!! unset
21534 .cindex "transport" "home directory for"
21535 .vindex "&$home$&"
21536 This option specifies a home directory setting for a local transport,
21537 overriding any value that may be set by the router. The home directory is
21538 placed in &$home$& while expanding the transport's private options. It is also
21539 used as the current directory if no current directory is set by the
21540 &%current_directory%& option on the transport or the
21541 &%transport_current_directory%& option on the router. If the expansion fails
21542 for any reason, including forced failure, an error is logged, and delivery is
21543 deferred.
21544
21545
21546 .option initgroups transports boolean false
21547 .cindex "additional groups"
21548 .cindex "groups" "additional"
21549 .cindex "transport" "group; additional"
21550 If this option is true and the uid for the delivery process is provided by the
21551 transport, the &[initgroups()]& function is called when running the transport
21552 to ensure that any additional groups associated with the uid are set up.
21553
21554
21555 .option max_parallel transports integer&!! unset
21556 .cindex limit "transport parallelism"
21557 .cindex transport "parallel processes"
21558 .cindex transport "concurrency limit"
21559 .cindex "delivery" "parallelism for transport"
21560 If this option is set and expands to an integer greater than zero
21561 it limits the number of concurrent runs of the transport.
21562 The control does not apply to shadow transports.
21563
21564 .cindex "hints database" "transport concurrency control"
21565 Exim implements this control by means of a hints database in which a record is
21566 incremented whenever a transport process is being created. The record
21567 is decremented and possibly removed when the process terminates.
21568 Obviously there is scope for
21569 records to get left lying around if there is a system or program crash. To
21570 guard against this, Exim ignores any records that are more than six hours old.
21571
21572 If you use this option, you should also arrange to delete the
21573 relevant hints database whenever your system reboots. The names of the files
21574 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21575 may be one or two files, depending on the type of DBM in use. The same files
21576 are used for ETRN and smtp transport serialization.
21577
21578
21579 .option message_size_limit transports string&!! 0
21580 .cindex "limit" "message size per transport"
21581 .cindex "size" "of message, limit"
21582 .cindex "transport" "message size; limiting"
21583 This option controls the size of messages passed through the transport. It is
21584 expanded before use; the result of the expansion must be a sequence of decimal
21585 digits, optionally followed by K or M. If the expansion fails for any reason,
21586 including forced failure, or if the result is not of the required form,
21587 delivery is deferred. If the value is greater than zero and the size of a
21588 message exceeds this limit, the address is failed. If there is any chance that
21589 the resulting bounce message could be routed to the same transport, you should
21590 ensure that &%return_size_limit%& is less than the transport's
21591 &%message_size_limit%&, as otherwise the bounce message will fail to get
21592 delivered.
21593
21594
21595
21596 .option rcpt_include_affixes transports boolean false
21597 .cindex "prefix" "for local part, including in envelope"
21598 .cindex "suffix for local part" "including in envelope"
21599 .cindex "local part" "prefix"
21600 .cindex "local part" "suffix"
21601 When this option is false (the default), and an address that has had any
21602 affixes (prefixes or suffixes) removed from the local part is delivered by any
21603 form of SMTP or LMTP, the affixes are not included. For example, if a router
21604 that contains
21605 .code
21606 local_part_prefix = *-
21607 .endd
21608 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21609 is delivered with
21610 .code
21611 RCPT TO:<xyz@some.domain>
21612 .endd
21613 This is also the case when an ACL-time callout is being used to verify a
21614 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21615 whole local part is included in the RCPT command. This option applies to BSMTP
21616 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21617 &(lmtp)& and &(smtp)& transports.
21618
21619
21620 .option retry_use_local_part transports boolean "see below"
21621 .cindex "hints database" "retry keys"
21622 When a delivery suffers a temporary failure, a retry record is created
21623 in Exim's hints database. For remote deliveries, the key for the retry record
21624 is based on the name and/or IP address of the failing remote host. For local
21625 deliveries, the key is normally the entire address, including both the local
21626 part and the domain. This is suitable for most common cases of local delivery
21627 temporary failure &-- for example, exceeding a mailbox quota should delay only
21628 deliveries to that mailbox, not to the whole domain.
21629
21630 However, in some special cases you may want to treat a temporary local delivery
21631 as a failure associated with the domain, and not with a particular local part.
21632 (For example, if you are storing all mail for some domain in files.) You can do
21633 this by setting &%retry_use_local_part%& false.
21634
21635 For all the local transports, its default value is true. For remote transports,
21636 the default value is false for tidiness, but changing the value has no effect
21637 on a remote transport in the current implementation.
21638
21639
21640 .option return_path transports string&!! unset
21641 .cindex "envelope sender"
21642 .cindex "transport" "return path; changing"
21643 .cindex "return path" "changing in transport"
21644 If this option is set, the string is expanded at transport time and replaces
21645 the existing return path (envelope sender) value in the copy of the message
21646 that is being delivered. An empty return path is permitted. This feature is
21647 designed for remote deliveries, where the value of this option is used in the
21648 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21649 only effect is to change the address that is placed in the &'Return-path:'&
21650 header line, if one is added to the message (see the next option).
21651
21652 &*Note:*& A changed return path is not logged unless you add
21653 &%return_path_on_delivery%& to the log selector.
21654
21655 .vindex "&$return_path$&"
21656 The expansion can refer to the existing value via &$return_path$&. This is
21657 either the message's envelope sender, or an address set by the
21658 &%errors_to%& option on a router. If the expansion is forced to fail, no
21659 replacement occurs; if it fails for another reason, delivery is deferred. This
21660 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21661 section &<<SECTverp>>&.
21662
21663 &*Note*&: If a delivery error is detected locally, including the case when a
21664 remote server rejects a message at SMTP time, the bounce message is not sent to
21665 the value of this option. It is sent to the previously set errors address.
21666 This defaults to the incoming sender address, but can be changed by setting
21667 &%errors_to%& in a router.
21668
21669
21670
21671 .option return_path_add transports boolean false
21672 .cindex "&'Return-path:'& header line"
21673 If this option is true, a &'Return-path:'& header is added to the message.
21674 Although the return path is normally available in the prefix line of BSD
21675 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21676 have easy access to it.
21677
21678 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21679 the delivery SMTP server makes the final delivery"&. This implies that this
21680 header should not be present in incoming messages. Exim has a configuration
21681 option, &%return_path_remove%&, which requests removal of this header from
21682 incoming messages, so that delivered messages can safely be resent to other
21683 recipients.
21684
21685
21686 .option shadow_condition transports string&!! unset
21687 See &%shadow_transport%& below.
21688
21689
21690 .option shadow_transport transports string unset
21691 .cindex "shadow transport"
21692 .cindex "transport" "shadow"
21693 A local transport may set the &%shadow_transport%& option to the name of
21694 another local transport. Shadow remote transports are not supported.
21695
21696 Whenever a delivery to the main transport succeeds, and either
21697 &%shadow_condition%& is unset, or its expansion does not result in the empty
21698 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21699 passed to the shadow transport, with the same delivery address or addresses. If
21700 expansion fails, no action is taken except that non-forced expansion failures
21701 cause a log line to be written.
21702
21703 The result of the shadow transport is discarded and does not affect the
21704 subsequent processing of the message. Only a single level of shadowing is
21705 provided; the &%shadow_transport%& option is ignored on any transport when it
21706 is running as a shadow. Options concerned with output from pipes are also
21707 ignored. The log line for the successful delivery has an item added on the end,
21708 of the form
21709 .code
21710 ST=<shadow transport name>
21711 .endd
21712 If the shadow transport did not succeed, the error message is put in
21713 parentheses afterwards. Shadow transports can be used for a number of different
21714 purposes, including keeping more detailed log information than Exim normally
21715 provides, and implementing automatic acknowledgment policies based on message
21716 headers that some sites insist on.
21717
21718
21719 .option transport_filter transports string&!! unset
21720 .cindex "transport" "filter"
21721 .cindex "filter" "transport filter"
21722 This option sets up a filtering (in the Unix shell sense) process for messages
21723 at transport time. It should not be confused with mail filtering as set up by
21724 individual users or via a system filter.
21725 If unset, or expanding to an empty string, no filtering is done.
21726
21727 When the message is about to be written out, the command specified by
21728 &%transport_filter%& is started up in a separate, parallel process, and
21729 the entire message, including the header lines, is passed to it on its standard
21730 input (this in fact is done from a third process, to avoid deadlock). The
21731 command must be specified as an absolute path.
21732
21733 The lines of the message that are written to the transport filter are
21734 terminated by newline (&"\n"&). The message is passed to the filter before any
21735 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21736 lines beginning with a dot, and also before any processing implied by the
21737 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21738 &(pipe)& transports.
21739
21740 The standard error for the filter process is set to the same destination as its
21741 standard output; this is read and written to the message's ultimate
21742 destination. The process that writes the message to the filter, the
21743 filter itself, and the original process that reads the result and delivers it
21744 are all run in parallel, like a shell pipeline.
21745
21746 The filter can perform any transformations it likes, but of course should take
21747 care not to break RFC 2822 syntax. Exim does not check the result, except to
21748 test for a final newline when SMTP is in use. All messages transmitted over
21749 SMTP must end with a newline, so Exim supplies one if it is missing.
21750
21751 .cindex "content scanning" "per user"
21752 A transport filter can be used to provide content-scanning on a per-user basis
21753 at delivery time if the only required effect of the scan is to modify the
21754 message. For example, a content scan could insert a new header line containing
21755 a spam score. This could be interpreted by a filter in the user's MUA. It is
21756 not possible to discard a message at this stage.
21757
21758 .cindex "SMTP" "SIZE"
21759 A problem might arise if the filter increases the size of a message that is
21760 being sent down an SMTP connection. If the receiving SMTP server has indicated
21761 support for the SIZE parameter, Exim will have sent the size of the message
21762 at the start of the SMTP session. If what is actually sent is substantially
21763 more, the server might reject the message. This can be worked round by setting
21764 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21765 additions to the message, or to disable the use of SIZE altogether.
21766
21767 .vindex "&$pipe_addresses$&"
21768 The value of the &%transport_filter%& option is the command string for starting
21769 the filter, which is run directly from Exim, not under a shell. The string is
21770 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21771 Exim breaks it up into arguments and then expands each argument separately (see
21772 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21773 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21774 of arguments, one for each address that applies to this delivery. (This isn't
21775 an ideal name for this feature here, but as it was already implemented for the
21776 &(pipe)& transport, it seemed sensible not to change it.)
21777
21778 .vindex "&$host$&"
21779 .vindex "&$host_address$&"
21780 The expansion variables &$host$& and &$host_address$& are available when the
21781 transport is a remote one. They contain the name and IP address of the host to
21782 which the message is being sent. For example:
21783 .code
21784 transport_filter = /some/directory/transport-filter.pl \
21785   $host $host_address $sender_address $pipe_addresses
21786 .endd
21787
21788 Two problems arise if you want to use more complicated expansion items to
21789 generate transport filter commands, both of which due to the fact that the
21790 command is split up &'before'& expansion.
21791 .ilist
21792 If an expansion item contains white space, you must quote it, so that it is all
21793 part of the same command item. If the entire option setting is one such
21794 expansion item, you have to take care what kind of quoting you use. For
21795 example:
21796 .code
21797 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21798 .endd
21799 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21800 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21801 stripped by Exim when it read the option's value. When the value is used, if
21802 the single quotes were missing, the line would be split into two items,
21803 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21804 Exim tried to expand the first one.
21805 .next
21806 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21807 expansion cannot generate multiple arguments, or a command name followed by
21808 arguments. Consider this example:
21809 .code
21810 transport_filter = ${lookup{$host}lsearch{/a/file}\
21811                     {$value}{/bin/cat}}
21812 .endd
21813 The result of the lookup is interpreted as the name of the command, even
21814 if it contains white space. The simplest way round this is to use a shell:
21815 .code
21816 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21817                                {$value}{/bin/cat}}
21818 .endd
21819 .endlist
21820
21821 The filter process is run under the same uid and gid as the normal delivery.
21822 For remote deliveries this is the Exim uid/gid by default. The command should
21823 normally yield a zero return code. Transport filters are not supposed to fail.
21824 A non-zero code is taken to mean that the transport filter encountered some
21825 serious problem. Delivery of the message is deferred; the message remains on
21826 the queue and is tried again later. It is not possible to cause a message to be
21827 bounced from a transport filter.
21828
21829 If a transport filter is set on an autoreply transport, the original message is
21830 passed through the filter as it is being copied into the newly generated
21831 message, which happens if the &%return_message%& option is set.
21832
21833
21834 .option transport_filter_timeout transports time 5m
21835 .cindex "transport" "filter, timeout"
21836 When Exim is reading the output of a transport filter, it applies a timeout
21837 that can be set by this option. Exceeding the timeout is normally treated as a
21838 temporary delivery failure. However, if a transport filter is used with a
21839 &(pipe)& transport, a timeout in the transport filter is treated in the same
21840 way as a timeout in the pipe command itself. By default, a timeout is a hard
21841 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21842 becomes a temporary error.
21843
21844
21845 .option user transports string&!! "Exim user"
21846 .cindex "uid (user id)" "local delivery"
21847 .cindex "transport" "user, specifying"
21848 This option specifies the user under whose uid the delivery process is to be
21849 run, overriding any uid that may have been set by the router. If the user is
21850 given as a name, the uid is looked up from the password data, and the
21851 associated group is taken as the value of the gid to be used if the &%group%&
21852 option is not set.
21853
21854 For deliveries that use local transports, a user and group are normally
21855 specified explicitly or implicitly (for example, as a result of
21856 &%check_local_user%&) by the router or transport.
21857
21858 .cindex "hints database" "access by remote transport"
21859 For remote transports, you should leave this option unset unless you really are
21860 sure you know what you are doing. When a remote transport is running, it needs
21861 to be able to access Exim's hints databases, because each host may have its own
21862 retry data.
21863 .ecindex IIDgenoptra1
21864 .ecindex IIDgenoptra2
21865 .ecindex IIDgenoptra3
21866
21867
21868
21869
21870
21871
21872 . ////////////////////////////////////////////////////////////////////////////
21873 . ////////////////////////////////////////////////////////////////////////////
21874
21875 .chapter "Address batching in local transports" "CHAPbatching" &&&
21876          "Address batching"
21877 .cindex "transport" "local; address batching in"
21878 The only remote transport (&(smtp)&) is normally configured to handle more than
21879 one address at a time, so that when several addresses are routed to the same
21880 remote host, just one copy of the message is sent. Local transports, however,
21881 normally handle one address at a time. That is, a separate instance of the
21882 transport is run for each address that is routed to the transport. A separate
21883 copy of the message is delivered each time.
21884
21885 .cindex "batched local delivery"
21886 .oindex "&%batch_max%&"
21887 .oindex "&%batch_id%&"
21888 In special cases, it may be desirable to handle several addresses at once in a
21889 local transport, for example:
21890
21891 .ilist
21892 In an &(appendfile)& transport, when storing messages in files for later
21893 delivery by some other means, a single copy of the message with multiple
21894 recipients saves space.
21895 .next
21896 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21897 a single copy saves time, and is the normal way LMTP is expected to work.
21898 .next
21899 In a &(pipe)& transport, when passing the message
21900 to a scanner program or
21901 to some other delivery mechanism such as UUCP, multiple recipients may be
21902 acceptable.
21903 .endlist
21904
21905 These three local transports all have the same options for controlling multiple
21906 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21907 repeating the information for each transport, these options are described here.
21908
21909 The &%batch_max%& option specifies the maximum number of addresses that can be
21910 delivered together in a single run of the transport. Its default value is one
21911 (no batching). When more than one address is routed to a transport that has a
21912 &%batch_max%& value greater than one, the addresses are delivered in a batch
21913 (that is, in a single run of the transport with multiple recipients), subject
21914 to certain conditions:
21915
21916 .ilist
21917 .vindex "&$local_part$&"
21918 If any of the transport's options contain a reference to &$local_part$&, no
21919 batching is possible.
21920 .next
21921 .vindex "&$domain$&"
21922 If any of the transport's options contain a reference to &$domain$&, only
21923 addresses with the same domain are batched.
21924 .next
21925 .cindex "customizing" "batching condition"
21926 If &%batch_id%& is set, it is expanded for each address, and only those
21927 addresses with the same expanded value are batched. This allows you to specify
21928 customized batching conditions. Failure of the expansion for any reason,
21929 including forced failure, disables batching, but it does not stop the delivery
21930 from taking place.
21931 .next
21932 Batched addresses must also have the same errors address (where to send
21933 delivery errors), the same header additions and removals, the same user and
21934 group for the transport, and if a host list is present, the first host must
21935 be the same.
21936 .endlist
21937
21938 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21939 both when the file or pipe command is specified in the transport, and when it
21940 is specified by a &(redirect)& router, but all the batched addresses must of
21941 course be routed to the same file or pipe command. These two transports have an
21942 option called &%use_bsmtp%&, which causes them to deliver the message in
21943 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21944 &%check_string%& and &%escape_string%& options are forced to the values
21945 .code
21946 check_string = "."
21947 escape_string = ".."
21948 .endd
21949 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21950 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21951 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21952
21953 .cindex "&'Envelope-to:'& header line"
21954 If the generic &%envelope_to_add%& option is set for a batching transport, the
21955 &'Envelope-to:'& header that is added to the message contains all the addresses
21956 that are being processed together. If you are using a batching &(appendfile)&
21957 transport without &%use_bsmtp%&, the only way to preserve the recipient
21958 addresses is to set the &%envelope_to_add%& option.
21959
21960 .cindex "&(pipe)& transport" "with multiple addresses"
21961 .vindex "&$pipe_addresses$&"
21962 If you are using a &(pipe)& transport without BSMTP, and setting the
21963 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21964 the command. This is not a true variable; it is a bit of magic that causes each
21965 of the recipient addresses to be inserted into the command as a separate
21966 argument. This provides a way of accessing all the addresses that are being
21967 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21968 are specified by a &(redirect)& router.
21969
21970
21971
21972
21973 . ////////////////////////////////////////////////////////////////////////////
21974 . ////////////////////////////////////////////////////////////////////////////
21975
21976 .chapter "The appendfile transport" "CHAPappendfile"
21977 .scindex IIDapptra1 "&(appendfile)& transport"
21978 .scindex IIDapptra2 "transports" "&(appendfile)&"
21979 .cindex "directory creation"
21980 .cindex "creating directories"
21981 The &(appendfile)& transport delivers a message by appending it to an existing
21982 file, or by creating an entirely new file in a specified directory. Single
21983 files to which messages are appended can be in the traditional Unix mailbox
21984 format, or optionally in the MBX format supported by the Pine MUA and
21985 University of Washington IMAP daemon, &'inter alia'&. When each message is
21986 being delivered as a separate file, &"maildir"& format can optionally be used
21987 to give added protection against failures that happen part-way through the
21988 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21989 supported. For all file formats, Exim attempts to create as many levels of
21990 directory as necessary, provided that &%create_directory%& is set.
21991
21992 The code for the optional formats is not included in the Exim binary by
21993 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21994 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21995 included.
21996
21997 .cindex "quota" "system"
21998 Exim recognizes system quota errors, and generates an appropriate message. Exim
21999 also supports its own quota control within the transport, for use when the
22000 system facility is unavailable or cannot be used for some reason.
22001
22002 If there is an error while appending to a file (for example, quota exceeded or
22003 partition filled), Exim attempts to reset the file's length and last
22004 modification time back to what they were before. If there is an error while
22005 creating an entirely new file, the new file is removed.
22006
22007 Before appending to a file, a number of security checks are made, and the
22008 file is locked. A detailed description is given below, after the list of
22009 private options.
22010
22011 The &(appendfile)& transport is most commonly used for local deliveries to
22012 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22013 putting messages into files for remote delivery by some means other than Exim.
22014 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22015 option).
22016
22017
22018
22019 .section "The file and directory options" "SECTfildiropt"
22020 The &%file%& option specifies a single file, to which the message is appended;
22021 the &%directory%& option specifies a directory, in which a new file containing
22022 the message is created. Only one of these two options can be set, and for
22023 normal deliveries to mailboxes, one of them &'must'& be set.
22024
22025 .vindex "&$address_file$&"
22026 .vindex "&$local_part$&"
22027 However, &(appendfile)& is also used for delivering messages to files or
22028 directories whose names (or parts of names) are obtained from alias,
22029 forwarding, or filtering operations (for example, a &%save%& command in a
22030 user's Exim filter). When such a transport is running, &$local_part$& contains
22031 the local part that was aliased or forwarded, and &$address_file$& contains the
22032 name (or partial name) of the file or directory generated by the redirection
22033 operation. There are two cases:
22034
22035 .ilist
22036 If neither &%file%& nor &%directory%& is set, the redirection operation
22037 must specify an absolute path (one that begins with &`/`&). This is the most
22038 common case when users with local accounts use filtering to sort mail into
22039 different folders. See for example, the &(address_file)& transport in the
22040 default configuration. If the path ends with a slash, it is assumed to be the
22041 name of a directory. A delivery to a directory can also be forced by setting
22042 &%maildir_format%& or &%mailstore_format%&.
22043 .next
22044 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22045 used to determine the file or directory name for the delivery. Normally, the
22046 contents of &$address_file$& are used in some way in the string expansion.
22047 .endlist
22048
22049
22050 .cindex "Sieve filter" "configuring &(appendfile)&"
22051 .cindex "Sieve filter" "relative mailbox path handling"
22052 As an example of the second case, consider an environment where users do not
22053 have home directories. They may be permitted to use Exim filter commands of the
22054 form:
22055 .code
22056 save folder23
22057 .endd
22058 or Sieve filter commands of the form:
22059 .code
22060 require "fileinto";
22061 fileinto "folder23";
22062 .endd
22063 In this situation, the expansion of &%file%& or &%directory%& in the transport
22064 must transform the relative path into an appropriate absolute file name. In the
22065 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22066 is used as a result of a &"keep"& action in the filter. This example shows one
22067 way of handling this requirement:
22068 .code
22069 file = ${if eq{$address_file}{inbox} \
22070             {/var/mail/$local_part} \
22071             {${if eq{${substr_0_1:$address_file}}{/} \
22072                   {$address_file} \
22073                   {$home/mail/$address_file} \
22074             }} \
22075        }
22076 .endd
22077 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22078 location, absolute paths are used without change, and other folders are in the
22079 &_mail_& directory within the home directory.
22080
22081 &*Note 1*&: While processing an Exim filter, a relative path such as
22082 &_folder23_& is turned into an absolute path if a home directory is known to
22083 the router. In particular, this is the case if &%check_local_user%& is set. If
22084 you want to prevent this happening at routing time, you can set
22085 &%router_home_directory%& empty. This forces the router to pass the relative
22086 path to the transport.
22087
22088 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22089 the &%file%& or &%directory%& option is still used if it is set.
22090
22091
22092
22093
22094 .section "Private options for appendfile" "SECID134"
22095 .cindex "options" "&(appendfile)& transport"
22096
22097
22098
22099 .option allow_fifo appendfile boolean false
22100 .cindex "fifo (named pipe)"
22101 .cindex "named pipe (fifo)"
22102 .cindex "pipe" "named (fifo)"
22103 Setting this option permits delivery to named pipes (FIFOs) as well as to
22104 regular files. If no process is reading the named pipe at delivery time, the
22105 delivery is deferred.
22106
22107
22108 .option allow_symlink appendfile boolean false
22109 .cindex "symbolic link" "to mailbox"
22110 .cindex "mailbox" "symbolic link"
22111 By default, &(appendfile)& will not deliver if the path name for the file is
22112 that of a symbolic link. Setting this option relaxes that constraint, but there
22113 are security issues involved in the use of symbolic links. Be sure you know
22114 what you are doing if you set this. Details of exactly what this option affects
22115 are included in the discussion which follows this list of options.
22116
22117
22118 .option batch_id appendfile string&!! unset
22119 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22120 However, batching is automatically disabled for &(appendfile)& deliveries that
22121 happen as a result of forwarding or aliasing or other redirection directly to a
22122 file.
22123
22124
22125 .option batch_max appendfile integer 1
22126 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22127
22128
22129 .option check_group appendfile boolean false
22130 When this option is set, the group owner of the file defined by the &%file%&
22131 option is checked to see that it is the same as the group under which the
22132 delivery process is running. The default setting is false because the default
22133 file mode is 0600, which means that the group is irrelevant.
22134
22135
22136 .option check_owner appendfile boolean true
22137 When this option is set, the owner of the file defined by the &%file%& option
22138 is checked to ensure that it is the same as the user under which the delivery
22139 process is running.
22140
22141
22142 .option check_string appendfile string "see below"
22143 .cindex "&""From""& line"
22144 As &(appendfile)& writes the message, the start of each line is tested for
22145 matching &%check_string%&, and if it does, the initial matching characters are
22146 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22147 a literal string, not a regular expression, and the case of any letters it
22148 contains is significant.
22149
22150 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22151 are forced to &"."& and &".."& respectively, and any settings in the
22152 configuration are ignored. Otherwise, they default to &"From&~"& and
22153 &">From&~"& when the &%file%& option is set, and unset when any of the
22154 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22155
22156 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22157 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22158 &"From&~"& indicates the start of a new message. All four options need changing
22159 if another format is used. For example, to deliver to mailboxes in MMDF format:
22160 .cindex "MMDF format mailbox"
22161 .cindex "mailbox" "MMDF format"
22162 .code
22163 check_string = "\1\1\1\1\n"
22164 escape_string = "\1\1\1\1 \n"
22165 message_prefix = "\1\1\1\1\n"
22166 message_suffix = "\1\1\1\1\n"
22167 .endd
22168 .option create_directory appendfile boolean true
22169 .cindex "directory creation"
22170 When this option is true, Exim attempts to create any missing superior
22171 directories for the file that it is about to write. A created directory's mode
22172 is given by the &%directory_mode%& option.
22173
22174 The group ownership of a newly created directory is highly dependent on the
22175 operating system (and possibly the file system) that is being used. For
22176 example, in Solaris, if the parent directory has the setgid bit set, its group
22177 is propagated to the child; if not, the currently set group is used. However,
22178 in FreeBSD, the parent's group is always used.
22179
22180
22181
22182 .option create_file appendfile string anywhere
22183 This option constrains the location of files and directories that are created
22184 by this transport. It applies to files defined by the &%file%& option and
22185 directories defined by the &%directory%& option. In the case of maildir
22186 delivery, it applies to the top level directory, not the maildir directories
22187 beneath.
22188
22189 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22190 &"belowhome"&. In the second and third cases, a home directory must have been
22191 set for the transport. This option is not useful when an explicit file name is
22192 given for normal mailbox deliveries. It is intended for the case when file
22193 names are generated from users' &_.forward_& files. These are usually handled
22194 by an &(appendfile)& transport called &%address_file%&. See also
22195 &%file_must_exist%&.
22196
22197
22198 .option directory appendfile string&!! unset
22199 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22200 or &%directory%& must be set, unless the delivery is the direct result of a
22201 redirection (see section &<<SECTfildiropt>>&).
22202
22203 When &%directory%& is set, the string is expanded, and the message is delivered
22204 into a new file or files in or below the given directory, instead of being
22205 appended to a single mailbox file. A number of different formats are provided
22206 (see &%maildir_format%& and &%mailstore_format%&), and see section
22207 &<<SECTopdir>>& for further details of this form of delivery.
22208
22209
22210 .option directory_file appendfile string&!! "see below"
22211 .cindex "base62"
22212 .vindex "&$inode$&"
22213 When &%directory%& is set, but neither &%maildir_format%& nor
22214 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22215 whose name is obtained by expanding this string. The default value is:
22216 .code
22217 q${base62:$tod_epoch}-$inode
22218 .endd
22219 This generates a unique name from the current time, in base 62 form, and the
22220 inode of the file. The variable &$inode$& is available only when expanding this
22221 option.
22222
22223
22224 .option directory_mode appendfile "octal integer" 0700
22225 If &(appendfile)& creates any directories as a result of the
22226 &%create_directory%& option, their mode is specified by this option.
22227
22228
22229 .option escape_string appendfile string "see description"
22230 See &%check_string%& above.
22231
22232
22233 .option file appendfile string&!! unset
22234 This option is mutually exclusive with the &%directory%& option, but one of
22235 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22236 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22237 specifies a single file, to which the message is appended. One or more of
22238 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22239 &%file%&.
22240
22241 .cindex "NFS" "lock file"
22242 .cindex "locking files"
22243 .cindex "lock files"
22244 If you are using more than one host to deliver over NFS into the same
22245 mailboxes, you should always use lock files.
22246
22247 The string value is expanded for each delivery, and must yield an absolute
22248 path. The most common settings of this option are variations on one of these
22249 examples:
22250 .code
22251 file = /var/spool/mail/$local_part
22252 file = /home/$local_part/inbox
22253 file = $home/inbox
22254 .endd
22255 .cindex "&""sticky""& bit"
22256 In the first example, all deliveries are done into the same directory. If Exim
22257 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22258 create a file in the directory, so the &"sticky"& bit must be turned on for
22259 deliveries to be possible, or alternatively the &%group%& option can be used to
22260 run the delivery under a group id which has write access to the directory.
22261
22262
22263
22264 .option file_format appendfile string unset
22265 .cindex "file" "mailbox; checking existing format"
22266 This option requests the transport to check the format of an existing file
22267 before adding to it. The check consists of matching a specific string at the
22268 start of the file. The value of the option consists of an even number of
22269 colon-separated strings. The first of each pair is the test string, and the
22270 second is the name of a transport. If the transport associated with a matched
22271 string is not the current transport, control is passed over to the other
22272 transport. For example, suppose the standard &(local_delivery)& transport has
22273 this added to it:
22274 .code
22275 file_format = "From       : local_delivery :\
22276                \1\1\1\1\n : local_mmdf_delivery"
22277 .endd
22278 Mailboxes that begin with &"From"& are still handled by this transport, but if
22279 a mailbox begins with four binary ones followed by a newline, control is passed
22280 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22281 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22282 is assumed to match the current transport. If the start of a mailbox doesn't
22283 match any string, or if the transport named for a given string is not defined,
22284 delivery is deferred.
22285
22286
22287 .option file_must_exist appendfile boolean false
22288 If this option is true, the file specified by the &%file%& option must exist.
22289 A temporary error occurs if it does not, causing delivery to be deferred.
22290 If this option is false, the file is created if it does not exist.
22291
22292
22293 .option lock_fcntl_timeout appendfile time 0s
22294 .cindex "timeout" "mailbox locking"
22295 .cindex "mailbox" "locking, blocking and non-blocking"
22296 .cindex "locking files"
22297 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22298 when locking an open mailbox file. If the call fails, the delivery process
22299 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22300 Non-blocking calls are used so that the file is not kept open during the wait
22301 for the lock; the reason for this is to make it as safe as possible for
22302 deliveries over NFS in the case when processes might be accessing an NFS
22303 mailbox without using a lock file. This should not be done, but
22304 misunderstandings and hence misconfigurations are not unknown.
22305
22306 On a busy system, however, the performance of a non-blocking lock approach is
22307 not as good as using a blocking lock with a timeout. In this case, the waiting
22308 is done inside the system call, and Exim's delivery process acquires the lock
22309 and can proceed as soon as the previous lock holder releases it.
22310
22311 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22312 timeout, are used. There may still be some retrying: the maximum number of
22313 retries is
22314 .code
22315 (lock_retries * lock_interval) / lock_fcntl_timeout
22316 .endd
22317 rounded up to the next whole number. In other words, the total time during
22318 which &(appendfile)& is trying to get a lock is roughly the same, unless
22319 &%lock_fcntl_timeout%& is set very large.
22320
22321 You should consider setting this option if you are getting a lot of delayed
22322 local deliveries because of errors of the form
22323 .code
22324 failed to lock mailbox /some/file (fcntl)
22325 .endd
22326
22327 .option lock_flock_timeout appendfile time 0s
22328 This timeout applies to file locking when using &[flock()]& (see
22329 &%use_flock%&); the timeout operates in a similar manner to
22330 &%lock_fcntl_timeout%&.
22331
22332
22333 .option lock_interval appendfile time 3s
22334 This specifies the time to wait between attempts to lock the file. See below
22335 for details of locking.
22336
22337
22338 .option lock_retries appendfile integer 10
22339 This specifies the maximum number of attempts to lock the file. A value of zero
22340 is treated as 1. See below for details of locking.
22341
22342
22343 .option lockfile_mode appendfile "octal integer" 0600
22344 This specifies the mode of the created lock file, when a lock file is being
22345 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22346
22347
22348 .option lockfile_timeout appendfile time 30m
22349 .cindex "timeout" "mailbox locking"
22350 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22351 exists and is older than this value, it is assumed to have been left behind by
22352 accident, and Exim attempts to remove it.
22353
22354
22355 .option mailbox_filecount appendfile string&!! unset
22356 .cindex "mailbox" "specifying size of"
22357 .cindex "size" "of mailbox"
22358 If this option is set, it is expanded, and the result is taken as the current
22359 number of files in the mailbox. It must be a decimal number, optionally
22360 followed by K or M. This provides a way of obtaining this information from an
22361 external source that maintains the data.
22362
22363
22364 .option mailbox_size appendfile string&!! unset
22365 .cindex "mailbox" "specifying size of"
22366 .cindex "size" "of mailbox"
22367 If this option is set, it is expanded, and the result is taken as the current
22368 size the mailbox. It must be a decimal number, optionally followed by K or M.
22369 This provides a way of obtaining this information from an external source that
22370 maintains the data. This is likely to be helpful for maildir deliveries where
22371 it is computationally expensive to compute the size of a mailbox.
22372
22373
22374
22375 .option maildir_format appendfile boolean false
22376 .cindex "maildir format" "specifying"
22377 If this option is set with the &%directory%& option, the delivery is into a new
22378 file, in the &"maildir"& format that is used by other mail software. When the
22379 transport is activated directly from a &(redirect)& router (for example, the
22380 &(address_file)& transport in the default configuration), setting
22381 &%maildir_format%& causes the path received from the router to be treated as a
22382 directory, whether or not it ends with &`/`&. This option is available only if
22383 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22384 &<<SECTmaildirdelivery>>& below for further details.
22385
22386
22387 .option maildir_quota_directory_regex appendfile string "See below"
22388 .cindex "maildir format" "quota; directories included in"
22389 .cindex "quota" "maildir; directories included in"
22390 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22391 a regular expression for specifying directories, relative to the quota
22392 directory (see &%quota_directory%&), that should be included in the quota
22393 calculation. The default value is:
22394 .code
22395 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22396 .endd
22397 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22398 (directories whose names begin with a dot). If you want to exclude the
22399 &_Trash_&
22400 folder from the count (as some sites do), you need to change this setting to
22401 .code
22402 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22403 .endd
22404 This uses a negative lookahead in the regular expression to exclude the
22405 directory whose name is &_.Trash_&. When a directory is excluded from quota
22406 calculations, quota processing is bypassed for any messages that are delivered
22407 directly into that directory.
22408
22409
22410 .option maildir_retries appendfile integer 10
22411 This option specifies the number of times to retry when writing a file in
22412 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22413
22414
22415 .option maildir_tag appendfile string&!! unset
22416 This option applies only to deliveries in maildir format, and is described in
22417 section &<<SECTmaildirdelivery>>& below.
22418
22419
22420 .option maildir_use_size_file appendfile&!! boolean false
22421 .cindex "maildir format" "&_maildirsize_& file"
22422 The result of string expansion for this option must be a valid boolean value.
22423 If it is true, it enables support for &_maildirsize_& files. Exim
22424 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22425 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22426 value is zero. See &%maildir_quota_directory_regex%& above and section
22427 &<<SECTmaildirdelivery>>& below for further details.
22428
22429 .option maildirfolder_create_regex appendfile string unset
22430 .cindex "maildir format" "&_maildirfolder_& file"
22431 .cindex "&_maildirfolder_&, creating"
22432 The value of this option is a regular expression. If it is unset, it has no
22433 effect. Otherwise, before a maildir delivery takes place, the pattern is
22434 matched against the name of the maildir directory, that is, the directory
22435 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22436 delivery. If there is a match, Exim checks for the existence of a file called
22437 &_maildirfolder_& in the directory, and creates it if it does not exist.
22438 See section &<<SECTmaildirdelivery>>& for more details.
22439
22440
22441 .option mailstore_format appendfile boolean false
22442 .cindex "mailstore format" "specifying"
22443 If this option is set with the &%directory%& option, the delivery is into two
22444 new files in  &"mailstore"& format. The option is available only if
22445 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22446 below for further details.
22447
22448
22449 .option mailstore_prefix appendfile string&!! unset
22450 This option applies only to deliveries in mailstore format, and is described in
22451 section &<<SECTopdir>>& below.
22452
22453
22454 .option mailstore_suffix appendfile string&!! unset
22455 This option applies only to deliveries in mailstore format, and is described in
22456 section &<<SECTopdir>>& below.
22457
22458
22459 .option mbx_format appendfile boolean false
22460 .cindex "locking files"
22461 .cindex "file" "locking"
22462 .cindex "file" "MBX format"
22463 .cindex "MBX format, specifying"
22464 This option is available only if Exim has been compiled with SUPPORT_MBX
22465 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22466 the message is appended to the mailbox file in MBX format instead of
22467 traditional Unix format. This format is supported by Pine4 and its associated
22468 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22469
22470 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22471 automatically changed by the use of &%mbx_format%&. They should normally be set
22472 empty when using MBX format, so this option almost always appears in this
22473 combination:
22474 .code
22475 mbx_format = true
22476 message_prefix =
22477 message_suffix =
22478 .endd
22479 If none of the locking options are mentioned in the configuration,
22480 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22481 is possible to specify the other kinds of locking with &%mbx_format%&, but
22482 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22483 interworks with &'c-client'&, providing for shared access to the mailbox. It
22484 should not be used if any program that does not use this form of locking is
22485 going to access the mailbox, nor should it be used if the mailbox file is NFS
22486 mounted, because it works only when the mailbox is accessed from a single host.
22487
22488 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22489 the standard version of &'c-client'&, because as long as it has a mailbox open
22490 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22491 append messages to it.
22492
22493
22494 .option message_prefix appendfile string&!! "see below"
22495 .cindex "&""From""& line"
22496 The string specified here is expanded and output at the start of every message.
22497 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22498 in which case it is:
22499 .code
22500 message_prefix = "From ${if def:return_path{$return_path}\
22501   {MAILER-DAEMON}} $tod_bsdinbox\n"
22502 .endd
22503 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22504 &`\n`& to &`\r\n`& in &%message_prefix%&.
22505
22506 .option message_suffix appendfile string&!! "see below"
22507 The string specified here is expanded and output at the end of every message.
22508 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22509 in which case it is a single newline character. The suffix can be suppressed by
22510 setting
22511 .code
22512 message_suffix =
22513 .endd
22514 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22515 &`\n`& to &`\r\n`& in &%message_suffix%&.
22516
22517 .option mode appendfile "octal integer" 0600
22518 If the output file is created, it is given this mode. If it already exists and
22519 has wider permissions, they are reduced to this mode. If it has narrower
22520 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22521 if the delivery is the result of a &%save%& command in a filter file specifying
22522 a particular mode, the mode of the output file is always forced to take that
22523 value, and this option is ignored.
22524
22525
22526 .option mode_fail_narrower appendfile boolean true
22527 This option applies in the case when an existing mailbox file has a narrower
22528 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22529 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22530 continues with the delivery attempt, using the existing mode of the file.
22531
22532
22533 .option notify_comsat appendfile boolean false
22534 If this option is true, the &'comsat'& daemon is notified after every
22535 successful delivery to a user mailbox. This is the daemon that notifies logged
22536 on users about incoming mail.
22537
22538
22539 .option quota appendfile string&!! unset
22540 .cindex "quota" "imposed by Exim"
22541 This option imposes a limit on the size of the file to which Exim is appending,
22542 or to the total space used in the directory tree when the &%directory%& option
22543 is set. In the latter case, computation of the space used is expensive, because
22544 all the files in the directory (and any sub-directories) have to be
22545 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22546 &%maildir_use_size_file%& for ways to avoid this in environments where users
22547 have no shell access to their mailboxes).
22548
22549 As there is no interlock against two simultaneous deliveries into a
22550 multi-file mailbox, it is possible for the quota to be overrun in this case.
22551 For single-file mailboxes, of course, an interlock is a necessity.
22552
22553 A file's size is taken as its &'used'& value. Because of blocking effects, this
22554 may be a lot less than the actual amount of disk space allocated to the file.
22555 If the sizes of a number of files are being added up, the rounding effect can
22556 become quite noticeable, especially on systems that have large block sizes.
22557 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22558 the obvious value which users understand most easily.
22559
22560 The value of the option is expanded, and must then be a numerical value
22561 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22562 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22563 and further option modifiers. If Exim is running on a system with
22564 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22565 be handled.
22566
22567 The option modifier &%no_check%& can be used to force delivery even if the over
22568 quota condition is met. The quota gets updated as usual.
22569
22570 &*Note*&: A value of zero is interpreted as &"no quota"&.
22571
22572 The expansion happens while Exim is running as root, before it changes uid for
22573 the delivery. This means that files that are inaccessible to the end user can
22574 be used to hold quota values that are looked up in the expansion. When delivery
22575 fails because this quota is exceeded, the handling of the error is as for
22576 system quota failures.
22577
22578 By default, Exim's quota checking mimics system quotas, and restricts the
22579 mailbox to the specified maximum size, though the value is not accurate to the
22580 last byte, owing to separator lines and additional headers that may get added
22581 during message delivery. When a mailbox is nearly full, large messages may get
22582 refused even though small ones are accepted, because the size of the current
22583 message is added to the quota when the check is made. This behaviour can be
22584 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22585 for exceeding the quota does not include the current message. Thus, deliveries
22586 continue until the quota has been exceeded; thereafter, no further messages are
22587 delivered. See also &%quota_warn_threshold%&.
22588
22589
22590 .option quota_directory appendfile string&!! unset
22591 This option defines the directory to check for quota purposes when delivering
22592 into individual files. The default is the delivery directory, or, if a file
22593 called &_maildirfolder_& exists in a maildir directory, the parent of the
22594 delivery directory.
22595
22596
22597 .option quota_filecount appendfile string&!! 0
22598 This option applies when the &%directory%& option is set. It limits the total
22599 number of files in the directory (compare the inode limit in system quotas). It
22600 can only be used if &%quota%& is also set. The value is expanded; an expansion
22601 failure causes delivery to be deferred. A value of zero is interpreted as
22602 &"no quota"&.
22603
22604 The option modifier &%no_check%& can be used to force delivery even if the over
22605 quota condition is met. The quota gets updated as usual.
22606
22607 .option quota_is_inclusive appendfile boolean true
22608 See &%quota%& above.
22609
22610
22611 .option quota_size_regex appendfile string unset
22612 This option applies when one of the delivery modes that writes a separate file
22613 for each message is being used. When Exim wants to find the size of one of
22614 these files in order to test the quota, it first checks &%quota_size_regex%&.
22615 If this is set to a regular expression that matches the file name, and it
22616 captures one string, that string is interpreted as a representation of the
22617 file's size. The value of &%quota_size_regex%& is not expanded.
22618
22619 This feature is useful only when users have no shell access to their mailboxes
22620 &-- otherwise they could defeat the quota simply by renaming the files. This
22621 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22622 the file length to the file name. For example:
22623 .code
22624 maildir_tag = ,S=$message_size
22625 quota_size_regex = ,S=(\d+)
22626 .endd
22627 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22628 number of lines in the message.
22629
22630 The regular expression should not assume that the length is at the end of the
22631 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22632 sometimes add other information onto the ends of message file names.
22633
22634 Section &<<SECID136>>& contains further information.
22635
22636
22637 .option quota_warn_message appendfile string&!! "see below"
22638 See below for the use of this option. If it is not set when
22639 &%quota_warn_threshold%& is set, it defaults to
22640 .code
22641 quota_warn_message = "\
22642   To: $local_part@$domain\n\
22643   Subject: Your mailbox\n\n\
22644   This message is automatically created \
22645   by mail delivery software.\n\n\
22646   The size of your mailbox has exceeded \
22647   a warning threshold that is\n\
22648   set by the system administrator.\n"
22649 .endd
22650
22651
22652 .option quota_warn_threshold appendfile string&!! 0
22653 .cindex "quota" "warning threshold"
22654 .cindex "mailbox" "size warning"
22655 .cindex "size" "of mailbox"
22656 This option is expanded in the same way as &%quota%& (see above). If the
22657 resulting value is greater than zero, and delivery of the message causes the
22658 size of the file or total space in the directory tree to cross the given
22659 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22660 may be specified as a percentage of it by following the value with a percent
22661 sign. For example:
22662 .code
22663 quota = 10M
22664 quota_warn_threshold = 75%
22665 .endd
22666 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22667 percent sign is ignored.
22668
22669 The warning message itself is specified by the &%quota_warn_message%& option,
22670 and it must start with a &'To:'& header line containing the recipient(s) of the
22671 warning message. These do not necessarily have to include the recipient(s) of
22672 the original message. A &'Subject:'& line should also normally be supplied. You
22673 can include any other header lines that you want. If you do not include a
22674 &'From:'& line, the default is:
22675 .code
22676 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22677 .endd
22678 .oindex &%errors_reply_to%&
22679 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22680 option.
22681
22682 The &%quota%& option does not have to be set in order to use this option; they
22683 are independent of one another except when the threshold is specified as a
22684 percentage.
22685
22686
22687 .option use_bsmtp appendfile boolean false
22688 .cindex "envelope sender"
22689 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22690 format, with the envelope sender and recipient(s) included as SMTP commands. If
22691 you want to include a leading HELO command with such messages, you can do
22692 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22693 for details of batch SMTP.
22694
22695
22696 .option use_crlf appendfile boolean false
22697 .cindex "carriage return"
22698 .cindex "linefeed"
22699 This option causes lines to be terminated with the two-character CRLF sequence
22700 (carriage return, linefeed) instead of just a linefeed character. In the case
22701 of batched SMTP, the byte sequence written to the file is then an exact image
22702 of what would be sent down a real SMTP connection.
22703
22704 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22705 (which are used to supply the traditional &"From&~"& and blank line separators
22706 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22707 carriage return characters if these are needed. In cases where these options
22708 have non-empty defaults, the values end with a single linefeed, so they must be
22709 changed to end with &`\r\n`& if &%use_crlf%& is set.
22710
22711
22712 .option use_fcntl_lock appendfile boolean "see below"
22713 This option controls the use of the &[fcntl()]& function to lock a file for
22714 exclusive use when a message is being appended. It is set by default unless
22715 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22716 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22717 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22718
22719
22720 .option use_flock_lock appendfile boolean false
22721 This option is provided to support the use of &[flock()]& for file locking, for
22722 the few situations where it is needed. Most modern operating systems support
22723 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22724 each other. Exim uses &[fcntl()]& locking by default.
22725
22726 This option is required only if you are using an operating system where
22727 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22728 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22729 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22730
22731 .cindex "Solaris" "&[flock()]& support"
22732 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22733 have it (and some, I think, provide a not quite right version built on top of
22734 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22735 the ability to use it, and any attempt to do so will cause a configuration
22736 error.
22737
22738 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22739 is just being mapped onto &[fcntl()]& by the OS).
22740
22741
22742 .option use_lockfile appendfile boolean "see below"
22743 If this option is turned off, Exim does not attempt to create a lock file when
22744 appending to a mailbox file. In this situation, the only locking is by
22745 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22746 sure that every MUA that is ever going to look at your users' mailboxes uses
22747 &[fcntl()]& rather than a lock file, and even then only when you are not
22748 delivering over NFS from more than one host.
22749
22750 .cindex "NFS" "lock file"
22751 In order to append to an NFS file safely from more than one host, it is
22752 necessary to take out a lock &'before'& opening the file, and the lock file
22753 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22754 file corruption.
22755
22756 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22757 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22758 except when &%mbx_format%& is set.
22759
22760
22761 .option use_mbx_lock appendfile boolean "see below"
22762 This option is available only if Exim has been compiled with SUPPORT_MBX
22763 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22764 locking rules be used. It is set by default if &%mbx_format%& is set and none
22765 of the locking options are mentioned in the configuration. The locking rules
22766 are the same as are used by the &'c-client'& library that underlies Pine and
22767 the IMAP4 and POP daemons that come with it (see the discussion below). The
22768 rules allow for shared access to the mailbox. However, this kind of locking
22769 does not work when the mailbox is NFS mounted.
22770
22771 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22772 &%use_flock_lock%& to control what kind of locking is used in implementing the
22773 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22774 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22775
22776
22777
22778
22779 .section "Operational details for appending" "SECTopappend"
22780 .cindex "appending to a file"
22781 .cindex "file" "appending"
22782 Before appending to a file, the following preparations are made:
22783
22784 .ilist
22785 If the name of the file is &_/dev/null_&, no action is taken, and a success
22786 return is given.
22787
22788 .next
22789 .cindex "directory creation"
22790 If any directories on the file's path are missing, Exim creates them if the
22791 &%create_directory%& option is set. A created directory's mode is given by the
22792 &%directory_mode%& option.
22793
22794 .next
22795 If &%file_format%& is set, the format of an existing file is checked. If this
22796 indicates that a different transport should be used, control is passed to that
22797 transport.
22798
22799 .next
22800 .cindex "file" "locking"
22801 .cindex "locking files"
22802 .cindex "NFS" "lock file"
22803 If &%use_lockfile%& is set, a lock file is built in a way that will work
22804 reliably over NFS, as follows:
22805
22806 .olist
22807 Create a &"hitching post"& file whose name is that of the lock file with the
22808 current time, primary host name, and process id added, by opening for writing
22809 as a new file. If this fails with an access error, delivery is deferred.
22810 .next
22811 Close the hitching post file, and hard link it to the lock file name.
22812 .next
22813 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22814 Unlink the hitching post name.
22815 .next
22816 Otherwise, use &[stat()]& to get information about the hitching post file, and
22817 then unlink hitching post name. If the number of links is exactly two, creation
22818 of the lock file succeeded but something (for example, an NFS server crash and
22819 restart) caused this fact not to be communicated to the &[link()]& call.
22820 .next
22821 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22822 up to &%lock_retries%& times. However, since any program that writes to a
22823 mailbox should complete its task very quickly, it is reasonable to time out old
22824 lock files that are normally the result of user agent and system crashes. If an
22825 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22826 it before trying again.
22827 .endlist olist
22828
22829 .next
22830 A call is made to &[lstat()]& to discover whether the main file exists, and if
22831 so, what its characteristics are. If &[lstat()]& fails for any reason other
22832 than non-existence, delivery is deferred.
22833
22834 .next
22835 .cindex "symbolic link" "to mailbox"
22836 .cindex "mailbox" "symbolic link"
22837 If the file does exist and is a symbolic link, delivery is deferred, unless the
22838 &%allow_symlink%& option is set, in which case the ownership of the link is
22839 checked, and then &[stat()]& is called to find out about the real file, which
22840 is then subjected to the checks below. The check on the top-level link
22841 ownership prevents one user creating a link for another's mailbox in a sticky
22842 directory, though allowing symbolic links in this case is definitely not a good
22843 idea. If there is a chain of symbolic links, the intermediate ones are not
22844 checked.
22845
22846 .next
22847 If the file already exists but is not a regular file, or if the file's owner
22848 and group (if the group is being checked &-- see &%check_group%& above) are
22849 different from the user and group under which the delivery is running,
22850 delivery is deferred.
22851
22852 .next
22853 If the file's permissions are more generous than specified, they are reduced.
22854 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22855 is set false, in which case the delivery is tried using the existing
22856 permissions.
22857
22858 .next
22859 The file's inode number is saved, and the file is then opened for appending.
22860 If this fails because the file has vanished, &(appendfile)& behaves as if it
22861 hadn't existed (see below). For any other failures, delivery is deferred.
22862
22863 .next
22864 If the file is opened successfully, check that the inode number hasn't
22865 changed, that it is still a regular file, and that the owner and permissions
22866 have not changed. If anything is wrong, defer delivery and freeze the message.
22867
22868 .next
22869 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22870 option is set. Otherwise, check that the file is being created in a permitted
22871 directory if the &%create_file%& option is set (deferring on failure), and then
22872 open for writing as a new file, with the O_EXCL and O_CREAT options,
22873 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22874 set). In this case, which can happen if the link points to a non-existent file,
22875 the file is opened for writing using O_CREAT but not O_EXCL, because
22876 that prevents link following.
22877
22878 .next
22879 .cindex "loop" "while file testing"
22880 If opening fails because the file exists, obey the tests given above for
22881 existing files. However, to avoid looping in a situation where the file is
22882 being continuously created and destroyed, the exists/not-exists loop is broken
22883 after 10 repetitions, and the message is then frozen.
22884
22885 .next
22886 If opening fails with any other error, defer delivery.
22887
22888 .next
22889 .cindex "file" "locking"
22890 .cindex "locking files"
22891 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22892 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22893 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22894 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22895 file, and an exclusive lock on the file whose name is
22896 .code
22897 /tmp/.<device-number>.<inode-number>
22898 .endd
22899 using the device and inode numbers of the open mailbox file, in accordance with
22900 the MBX locking rules. This file is created with a mode that is specified by
22901 the &%lockfile_mode%& option.
22902
22903 If Exim fails to lock the file, there are two possible courses of action,
22904 depending on the value of the locking timeout. This is obtained from
22905 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22906
22907 If the timeout value is zero, the file is closed, Exim waits for
22908 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22909 to lock it again. This happens up to &%lock_retries%& times, after which the
22910 delivery is deferred.
22911
22912 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22913 &[flock()]& are used (with the given timeout), so there has already been some
22914 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22915 immediately. It retries up to
22916 .code
22917 (lock_retries * lock_interval) / <timeout>
22918 .endd
22919 times (rounded up).
22920 .endlist
22921
22922 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22923 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22924
22925
22926 .section "Operational details for delivery to a new file" "SECTopdir"
22927 .cindex "delivery" "to single file"
22928 .cindex "&""From""& line"
22929 When the &%directory%& option is set instead of &%file%&, each message is
22930 delivered into a newly-created file or set of files. When &(appendfile)& is
22931 activated directly from a &(redirect)& router, neither &%file%& nor
22932 &%directory%& is normally set, because the path for delivery is supplied by the
22933 router. (See for example, the &(address_file)& transport in the default
22934 configuration.) In this case, delivery is to a new file if either the path name
22935 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22936
22937 No locking is required while writing the message to a new file, so the various
22938 locking options of the transport are ignored. The &"From"& line that by default
22939 separates messages in a single file is not normally needed, nor is the escaping
22940 of message lines that start with &"From"&, and there is no need to ensure a
22941 newline at the end of each message. Consequently, the default values for
22942 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22943 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22944
22945 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22946 the files in the delivery directory by default. However, you can specify a
22947 different directory by setting &%quota_directory%&. Also, for maildir
22948 deliveries (see below) the &_maildirfolder_& convention is honoured.
22949
22950
22951 .cindex "maildir format"
22952 .cindex "mailstore format"
22953 There are three different ways in which delivery to individual files can be
22954 done, controlled by the settings of the &%maildir_format%& and
22955 &%mailstore_format%& options. Note that code to support maildir or mailstore
22956 formats is not included in the binary unless SUPPORT_MAILDIR or
22957 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22958
22959 .cindex "directory creation"
22960 In all three cases an attempt is made to create the directory and any necessary
22961 sub-directories if they do not exist, provided that the &%create_directory%&
22962 option is set (the default). The location of a created directory can be
22963 constrained by setting &%create_file%&. A created directory's mode is given by
22964 the &%directory_mode%& option. If creation fails, or if the
22965 &%create_directory%& option is not set when creation is required, delivery is
22966 deferred.
22967
22968
22969
22970 .section "Maildir delivery" "SECTmaildirdelivery"
22971 .cindex "maildir format" "description of"
22972 If the &%maildir_format%& option is true, Exim delivers each message by writing
22973 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22974 directory that is defined by the &%directory%& option (the &"delivery
22975 directory"&). If the delivery is successful, the file is renamed into the
22976 &_new_& subdirectory.
22977
22978 In the file name, <&'stime'&> is the current time of day in seconds, and
22979 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22980 Exim checks that the time-of-day clock has moved on by at least one microsecond
22981 before terminating the delivery process. This guarantees uniqueness for the
22982 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22983 opening it. If any response other than ENOENT (does not exist) is given,
22984 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22985
22986 Before Exim carries out a maildir delivery, it ensures that subdirectories
22987 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22988 do not exist, Exim tries to create them and any superior directories in their
22989 path, subject to the &%create_directory%& and &%create_file%& options. If the
22990 &%maildirfolder_create_regex%& option is set, and the regular expression it
22991 contains matches the delivery directory, Exim also ensures that a file called
22992 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22993 &_maildirfolder_& file cannot be created, delivery is deferred.
22994
22995 These features make it possible to use Exim to create all the necessary files
22996 and directories in a maildir mailbox, including subdirectories for maildir++
22997 folders. Consider this example:
22998 .code
22999 maildir_format = true
23000 directory = /var/mail/$local_part\
23001            ${if eq{$local_part_suffix}{}{}\
23002            {/.${substr_1:$local_part_suffix}}}
23003 maildirfolder_create_regex = /\.[^/]+$
23004 .endd
23005 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23006 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23007 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23008 not match this name, so Exim will not look for or create the file
23009 &_/var/mail/pimbo/maildirfolder_&, though it will create
23010 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23011
23012 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23013 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23014 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23015 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23016 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23017
23018 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23019 not inadvertently match the toplevel maildir directory, because a
23020 &_maildirfolder_& file at top level would completely break quota calculations.
23021
23022 .cindex "quota" "in maildir delivery"
23023 .cindex "maildir++"
23024 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23025 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23026 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23027 Exim assumes the directory is a maildir++ folder directory, which is one level
23028 down from the user's top level mailbox directory. This causes it to start at
23029 the parent directory instead of the current directory when calculating the
23030 amount of space used.
23031
23032 One problem with delivering into a multi-file mailbox is that it is
23033 computationally expensive to compute the size of the mailbox for quota
23034 checking. Various approaches have been taken to reduce the amount of work
23035 needed. The next two sections describe two of them. A third alternative is to
23036 use some external process for maintaining the size data, and use the expansion
23037 of the &%mailbox_size%& option as a way of importing it into Exim.
23038
23039
23040
23041
23042 .section "Using tags to record message sizes" "SECID135"
23043 If &%maildir_tag%& is set, the string is expanded for each delivery.
23044 When the maildir file is renamed into the &_new_& sub-directory, the
23045 tag is added to its name. However, if adding the tag takes the length of the
23046 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23047 the tag is dropped and the maildir file is created with no tag.
23048
23049
23050 .vindex "&$message_size$&"
23051 Tags can be used to encode the size of files in their names; see
23052 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23053 happens after the message has been written. The value of the &$message_size$&
23054 variable is set to the number of bytes actually written. If the expansion is
23055 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23056 be deferred. The expanded tag may contain any printing characters except &"/"&.
23057 Non-printing characters in the string are ignored; if the resulting string is
23058 empty, it is ignored. If it starts with an alphanumeric character, a leading
23059 colon is inserted; this default has not proven to be the path that popular
23060 maildir implementations have chosen (but changing it in Exim would break
23061 backwards compatibility).
23062
23063 For one common implementation, you might set:
23064 .code
23065 maildir_tag = ,S=${message_size}
23066 .endd
23067 but you should check the documentation of the other software to be sure.
23068
23069 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23070 as this allows Exim to extract the size from your tag, instead of having to
23071 &[stat()]& each message file.
23072
23073
23074 .section "Using a maildirsize file" "SECID136"
23075 .cindex "quota" "in maildir delivery"
23076 .cindex "maildir format" "&_maildirsize_& file"
23077 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23078 storing quota and message size information in a file called &_maildirsize_&
23079 within the toplevel maildir directory. If this file does not exist, Exim
23080 creates it, setting the quota from the &%quota%& option of the transport. If
23081 the maildir directory itself does not exist, it is created before any attempt
23082 to write a &_maildirsize_& file.
23083
23084 The &_maildirsize_& file is used to hold information about the sizes of
23085 messages in the maildir, thus speeding up quota calculations. The quota value
23086 in the file is just a cache; if the quota is changed in the transport, the new
23087 value overrides the cached value when the next message is delivered. The cache
23088 is maintained for the benefit of other programs that access the maildir and
23089 need to know the quota.
23090
23091 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23092 file is maintained (with a zero quota setting), but no quota is imposed.
23093
23094 A regular expression is available for controlling which directories in the
23095 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23096 See the description of the &%maildir_quota_directory_regex%& option above for
23097 details.
23098
23099
23100 .section "Mailstore delivery" "SECID137"
23101 .cindex "mailstore format" "description of"
23102 If the &%mailstore_format%& option is true, each message is written as two
23103 files in the given directory. A unique base name is constructed from the
23104 message id and the current delivery process, and the files that are written use
23105 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23106 contains the message's envelope, and the &_.msg_& file contains the message
23107 itself. The base name is placed in the variable &$mailstore_basename$&.
23108
23109 During delivery, the envelope is first written to a file with the suffix
23110 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23111 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23112 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23113 file before accessing either of them. An alternative approach is to wait for
23114 the absence of a &_.tmp_& file.
23115
23116 The envelope file starts with any text defined by the &%mailstore_prefix%&
23117 option, expanded and terminated by a newline if there isn't one. Then follows
23118 the sender address on one line, then all the recipient addresses, one per line.
23119 There can be more than one recipient only if the &%batch_max%& option is set
23120 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23121 appended to the file, followed by a newline if it does not end with one.
23122
23123 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23124 failure, it is ignored. Other expansion errors are treated as serious
23125 configuration errors, and delivery is deferred. The variable
23126 &$mailstore_basename$& is available for use during these expansions.
23127
23128
23129 .section "Non-special new file delivery" "SECID138"
23130 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23131 file is created directly in the named directory. For example, when delivering
23132 messages into files in batched SMTP format for later delivery to some host (see
23133 section &<<SECTbatchSMTP>>&), a setting such as
23134 .code
23135 directory = /var/bsmtp/$host
23136 .endd
23137 might be used. A message is written to a file with a temporary name, which is
23138 then renamed when the delivery is complete. The final name is obtained by
23139 expanding the contents of the &%directory_file%& option.
23140 .ecindex IIDapptra1
23141 .ecindex IIDapptra2
23142
23143
23144
23145
23146
23147
23148 . ////////////////////////////////////////////////////////////////////////////
23149 . ////////////////////////////////////////////////////////////////////////////
23150
23151 .chapter "The autoreply transport" "CHID8"
23152 .scindex IIDauttra1 "transports" "&(autoreply)&"
23153 .scindex IIDauttra2 "&(autoreply)& transport"
23154 The &(autoreply)& transport is not a true transport in that it does not cause
23155 the message to be transmitted. Instead, it generates a new mail message as an
23156 automatic reply to the incoming message. &'References:'& and
23157 &'Auto-Submitted:'& header lines are included. These are constructed according
23158 to the rules in RFCs 2822 and 3834, respectively.
23159
23160 If the router that passes the message to this transport does not have the
23161 &%unseen%& option set, the original message (for the current recipient) is not
23162 delivered anywhere. However, when the &%unseen%& option is set on the router
23163 that passes the message to this transport, routing of the address continues, so
23164 another router can set up a normal message delivery.
23165
23166
23167 The &(autoreply)& transport is usually run as the result of mail filtering, a
23168 &"vacation"& message being the standard example. However, it can also be run
23169 directly from a router like any other transport. To reduce the possibility of
23170 message cascades, messages created by the &(autoreply)& transport always have
23171 empty envelope sender addresses, like bounce messages.
23172
23173 The parameters of the message to be sent can be specified in the configuration
23174 by options described below. However, these are used only when the address
23175 passed to the transport does not contain its own reply information. When the
23176 transport is run as a consequence of a
23177 &%mail%&
23178 or &%vacation%& command in a filter file, the parameters of the message are
23179 supplied by the filter, and passed with the address. The transport's options
23180 that define the message are then ignored (so they are not usually set in this
23181 case). The message is specified entirely by the filter or by the transport; it
23182 is never built from a mixture of options. However, the &%file_optional%&,
23183 &%mode%&, and &%return_message%& options apply in all cases.
23184
23185 &(Autoreply)& is implemented as a local transport. When used as a result of a
23186 command in a user's filter file, &(autoreply)& normally runs under the uid and
23187 gid of the user, and with appropriate current and home directories (see chapter
23188 &<<CHAPenvironment>>&).
23189
23190 There is a subtle difference between routing a message to a &(pipe)& transport
23191 that generates some text to be returned to the sender, and routing it to an
23192 &(autoreply)& transport. This difference is noticeable only if more than one
23193 address from the same message is so handled. In the case of a pipe, the
23194 separate outputs from the different addresses are gathered up and returned to
23195 the sender in a single message, whereas if &(autoreply)& is used, a separate
23196 message is generated for each address that is passed to it.
23197
23198 Non-printing characters are not permitted in the header lines generated for the
23199 message that &(autoreply)& creates, with the exception of newlines that are
23200 immediately followed by white space. If any non-printing characters are found,
23201 the transport defers.
23202 Whether characters with the top bit set count as printing characters or not is
23203 controlled by the &%print_topbitchars%& global option.
23204
23205 If any of the generic options for manipulating headers (for example,
23206 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23207 of the original message that is included in the generated message when
23208 &%return_message%& is set. They do not apply to the generated message itself.
23209
23210 .vindex "&$sender_address$&"
23211 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23212 the message, indicating that there were no recipients, it does not treat this
23213 as an error. This means that autoreplies sent to &$sender_address$& when this
23214 is empty (because the incoming message is a bounce message) do not cause
23215 problems. They are just discarded.
23216
23217
23218
23219 .section "Private options for autoreply" "SECID139"
23220 .cindex "options" "&(autoreply)& transport"
23221
23222 .option bcc autoreply string&!! unset
23223 This specifies the addresses that are to receive &"blind carbon copies"& of the
23224 message when the message is specified by the transport.
23225
23226
23227 .option cc autoreply string&!! unset
23228 This specifies recipients of the message and the contents of the &'Cc:'& header
23229 when the message is specified by the transport.
23230
23231
23232 .option file autoreply string&!! unset
23233 The contents of the file are sent as the body of the message when the message
23234 is specified by the transport. If both &%file%& and &%text%& are set, the text
23235 string comes first.
23236
23237
23238 .option file_expand autoreply boolean false
23239 If this is set, the contents of the file named by the &%file%& option are
23240 subjected to string expansion as they are added to the message.
23241
23242
23243 .option file_optional autoreply boolean false
23244 If this option is true, no error is generated if the file named by the &%file%&
23245 option or passed with the address does not exist or cannot be read.
23246
23247
23248 .option from autoreply string&!! unset
23249 This specifies the contents of the &'From:'& header when the message is
23250 specified by the transport.
23251
23252
23253 .option headers autoreply string&!! unset
23254 This specifies additional RFC 2822 headers that are to be added to the message
23255 when the message is specified by the transport. Several can be given by using
23256 &"\n"& to separate them. There is no check on the format.
23257
23258
23259 .option log autoreply string&!! unset
23260 This option names a file in which a record of every message sent is logged when
23261 the message is specified by the transport.
23262
23263
23264 .option mode autoreply "octal integer" 0600
23265 If either the log file or the &"once"& file has to be created, this mode is
23266 used.
23267
23268
23269 .option never_mail autoreply "address list&!!" unset
23270 If any run of the transport creates a message with a recipient that matches any
23271 item in the list, that recipient is quietly discarded. If all recipients are
23272 discarded, no message is created. This applies both when the recipients are
23273 generated by a filter and when they are specified in the transport.
23274
23275
23276
23277 .option once autoreply string&!! unset
23278 This option names a file or DBM database in which a record of each &'To:'&
23279 recipient is kept when the message is specified by the transport. &*Note*&:
23280 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23281
23282 If &%once%& is unset, or is set to an empty string, the message is always sent.
23283 By default, if &%once%& is set to a non-empty file name, the message
23284 is not sent if a potential recipient is already listed in the database.
23285 However, if the &%once_repeat%& option specifies a time greater than zero, the
23286 message is sent if that much time has elapsed since a message was last sent to
23287 this recipient. A setting of zero time for &%once_repeat%& (the default)
23288 prevents a message from being sent a second time &-- in this case, zero means
23289 infinity.
23290
23291 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23292 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23293 greater than zero, it changes the way Exim implements the &%once%& option.
23294 Instead of using a DBM file to record every recipient it sends to, it uses a
23295 regular file, whose size will never get larger than the given value.
23296
23297 In the file, Exim keeps a linear list of recipient addresses and the times at
23298 which they were sent messages. If the file is full when a new address needs to
23299 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23300 means that a given recipient may receive multiple messages, but at
23301 unpredictable intervals that depend on the rate of turnover of addresses in the
23302 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23303
23304
23305 .option once_file_size autoreply integer 0
23306 See &%once%& above.
23307
23308
23309 .option once_repeat autoreply time&!! 0s
23310 See &%once%& above.
23311 After expansion, the value of this option must be a valid time value.
23312
23313
23314 .option reply_to autoreply string&!! unset
23315 This specifies the contents of the &'Reply-To:'& header when the message is
23316 specified by the transport.
23317
23318
23319 .option return_message autoreply boolean false
23320 If this is set, a copy of the original message is returned with the new
23321 message, subject to the maximum size set in the &%return_size_limit%& global
23322 configuration option.
23323
23324
23325 .option subject autoreply string&!! unset
23326 This specifies the contents of the &'Subject:'& header when the message is
23327 specified by the transport. It is tempting to quote the original subject in
23328 automatic responses. For example:
23329 .code
23330 subject = Re: $h_subject:
23331 .endd
23332 There is a danger in doing this, however. It may allow a third party to
23333 subscribe your users to an opt-in mailing list, provided that the list accepts
23334 bounce messages as subscription confirmations. Well-managed lists require a
23335 non-bounce message to confirm a subscription, so the danger is relatively
23336 small.
23337
23338
23339
23340 .option text autoreply string&!! unset
23341 This specifies a single string to be used as the body of the message when the
23342 message is specified by the transport. If both &%text%& and &%file%& are set,
23343 the text comes first.
23344
23345
23346 .option to autoreply string&!! unset
23347 This specifies recipients of the message and the contents of the &'To:'& header
23348 when the message is specified by the transport.
23349 .ecindex IIDauttra1
23350 .ecindex IIDauttra2
23351
23352
23353
23354
23355 . ////////////////////////////////////////////////////////////////////////////
23356 . ////////////////////////////////////////////////////////////////////////////
23357
23358 .chapter "The lmtp transport" "CHAPLMTP"
23359 .cindex "transports" "&(lmtp)&"
23360 .cindex "&(lmtp)& transport"
23361 .cindex "LMTP" "over a pipe"
23362 .cindex "LMTP" "over a socket"
23363 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23364 specified command
23365 or by interacting with a Unix domain socket.
23366 This transport is something of a cross between the &(pipe)& and &(smtp)&
23367 transports. Exim also has support for using LMTP over TCP/IP; this is
23368 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23369 to be of minority interest, the default build-time configure in &_src/EDITME_&
23370 has it commented out. You need to ensure that
23371 .code
23372 TRANSPORT_LMTP=yes
23373 .endd
23374 .cindex "options" "&(lmtp)& transport"
23375 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23376 included in the Exim binary. The private options of the &(lmtp)& transport are
23377 as follows:
23378
23379 .option batch_id lmtp string&!! unset
23380 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23381
23382
23383 .option batch_max lmtp integer 1
23384 This limits the number of addresses that can be handled in a single delivery.
23385 Most LMTP servers can handle several addresses at once, so it is normally a
23386 good idea to increase this value. See the description of local delivery
23387 batching in chapter &<<CHAPbatching>>&.
23388
23389
23390 .option command lmtp string&!! unset
23391 This option must be set if &%socket%& is not set. The string is a command which
23392 is run in a separate process. It is split up into a command name and list of
23393 arguments, each of which is separately expanded (so expansion cannot change the
23394 number of arguments). The command is run directly, not via a shell. The message
23395 is passed to the new process using the standard input and output to operate the
23396 LMTP protocol.
23397
23398 .option ignore_quota lmtp boolean false
23399 .cindex "LMTP" "ignoring quota errors"
23400 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23401 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23402 in its response to the LHLO command.
23403
23404 .option socket lmtp string&!! unset
23405 This option must be set if &%command%& is not set. The result of expansion must
23406 be the name of a Unix domain socket. The transport connects to the socket and
23407 delivers the message to it using the LMTP protocol.
23408
23409
23410 .option timeout lmtp time 5m
23411 The transport is aborted if the created process or Unix domain socket does not
23412 respond to LMTP commands or message input within this timeout. Delivery
23413 is deferred, and will be tried again later. Here is an example of a typical
23414 LMTP transport:
23415 .code
23416 lmtp:
23417   driver = lmtp
23418   command = /some/local/lmtp/delivery/program
23419   batch_max = 20
23420   user = exim
23421 .endd
23422 This delivers up to 20 addresses at a time, in a mixture of domains if
23423 necessary, running as the user &'exim'&.
23424
23425
23426
23427 . ////////////////////////////////////////////////////////////////////////////
23428 . ////////////////////////////////////////////////////////////////////////////
23429
23430 .chapter "The pipe transport" "CHAPpipetransport"
23431 .scindex IIDpiptra1 "transports" "&(pipe)&"
23432 .scindex IIDpiptra2 "&(pipe)& transport"
23433 The &(pipe)& transport is used to deliver messages via a pipe to a command
23434 running in another process. One example is the use of &(pipe)& as a
23435 pseudo-remote transport for passing messages to some other delivery mechanism
23436 (such as UUCP). Another is the use by individual users to automatically process
23437 their incoming messages. The &(pipe)& transport can be used in one of the
23438 following ways:
23439
23440 .ilist
23441 .vindex "&$local_part$&"
23442 A router routes one address to a transport in the normal way, and the
23443 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23444 contains the local part of the address (as usual), and the command that is run
23445 is specified by the &%command%& option on the transport.
23446 .next
23447 .vindex "&$pipe_addresses$&"
23448 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23449 transport can handle more than one address in a single run. In this case, when
23450 more than one address is routed to the transport, &$local_part$& is not set
23451 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23452 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23453 that are routed to the transport.
23454 .next
23455 .vindex "&$address_pipe$&"
23456 A router redirects an address directly to a pipe command (for example, from an
23457 alias or forward file). In this case, &$address_pipe$& contains the text of the
23458 pipe command, and the &%command%& option on the transport is ignored unless
23459 &%force_command%& is set. If only one address is being transported
23460 (&%batch_max%& is not greater than one, or only one address was redirected to
23461 this pipe command), &$local_part$& contains the local part that was redirected.
23462 .endlist
23463
23464
23465 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23466 deliver messages over pipes using the LMTP interactive protocol. This is
23467 implemented by the &(lmtp)& transport.
23468
23469 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23470 &_.forward_& file, the command runs under the uid and gid of that user. In
23471 other cases, the uid and gid have to be specified explicitly, either on the
23472 transport or on the router that handles the address. Current and &"home"&
23473 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23474 details of the local delivery environment and chapter &<<CHAPbatching>>&
23475 for a discussion of local delivery batching.
23476
23477
23478 .section "Concurrent delivery" "SECID140"
23479 If two messages arrive at almost the same time, and both are routed to a pipe
23480 delivery, the two pipe transports may be run concurrently. You must ensure that
23481 any pipe commands you set up are robust against this happening. If the commands
23482 write to a file, the &%exim_lock%& utility might be of use.
23483 Alternatively the &%max_parallel%& option could be used with a value
23484 of "1" to enforce serialization.
23485
23486
23487
23488
23489 .section "Returned status and data" "SECID141"
23490 .cindex "&(pipe)& transport" "returned data"
23491 If the command exits with a non-zero return code, the delivery is deemed to
23492 have failed, unless either the &%ignore_status%& option is set (in which case
23493 the return code is treated as zero), or the return code is one of those listed
23494 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23495 later"&. In this case, delivery is deferred. Details of a permanent failure are
23496 logged, but are not included in the bounce message, which merely contains
23497 &"local delivery failed"&.
23498
23499 If the command exits on a signal and the &%freeze_signal%& option is set then
23500 the message will be frozen in the queue. If that option is not set, a bounce
23501 will be sent as normal.
23502
23503 If the return code is greater than 128 and the command being run is a shell
23504 script, it normally means that the script was terminated by a signal whose
23505 value is the return code minus 128. The &%freeze_signal%& option does not
23506 apply in this case.
23507
23508 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23509 return code is set to 127. This is the value that a shell returns if it is
23510 asked to run a non-existent command. The wording for the log line suggests that
23511 a non-existent command may be the problem.
23512
23513 The &%return_output%& option can affect the result of a pipe delivery. If it is
23514 set and the command produces any output on its standard output or standard
23515 error streams, the command is considered to have failed, even if it gave a zero
23516 return code or if &%ignore_status%& is set. The output from the command is
23517 included as part of the bounce message. The &%return_fail_output%& option is
23518 similar, except that output is returned only when the command exits with a
23519 failure return code, that is, a value other than zero or a code that matches
23520 &%temp_errors%&.
23521
23522
23523
23524 .section "How the command is run" "SECThowcommandrun"
23525 .cindex "&(pipe)& transport" "path for command"
23526 The command line is (by default) broken down into a command name and arguments
23527 by the &(pipe)& transport itself. The &%allow_commands%& and
23528 &%restrict_to_path%& options can be used to restrict the commands that may be
23529 run.
23530
23531 .cindex "quoting" "in pipe command"
23532 Unquoted arguments are delimited by white space. If an argument appears in
23533 double quotes, backslash is interpreted as an escape character in the usual
23534 way. If an argument appears in single quotes, no escaping is done.
23535
23536 String expansion is applied to the command line except when it comes from a
23537 traditional &_.forward_& file (commands from a filter file are expanded). The
23538 expansion is applied to each argument in turn rather than to the whole line.
23539 For this reason, any string expansion item that contains white space must be
23540 quoted so as to be contained within a single argument. A setting such as
23541 .code
23542 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23543 .endd
23544 will not work, because the expansion item gets split between several
23545 arguments. You have to write
23546 .code
23547 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23548 .endd
23549 to ensure that it is all in one argument. The expansion is done in this way,
23550 argument by argument, so that the number of arguments cannot be changed as a
23551 result of expansion, and quotes or backslashes in inserted variables do not
23552 interact with external quoting. However, this leads to problems if you want to
23553 generate multiple arguments (or the command name plus arguments) from a single
23554 expansion. In this situation, the simplest solution is to use a shell. For
23555 example:
23556 .code
23557 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23558 .endd
23559
23560 .cindex "transport" "filter"
23561 .cindex "filter" "transport filter"
23562 .vindex "&$pipe_addresses$&"
23563 Special handling takes place when an argument consists of precisely the text
23564 &`$pipe_addresses`&. This is not a general expansion variable; the only
23565 place this string is recognized is when it appears as an argument for a pipe or
23566 transport filter command. It causes each address that is being handled to be
23567 inserted in the argument list at that point &'as a separate argument'&. This
23568 avoids any problems with spaces or shell metacharacters, and is of use when a
23569 &(pipe)& transport is handling groups of addresses in a batch.
23570
23571 If &%force_command%& is enabled on the transport, Special handling takes place
23572 for an argument that consists of precisely the text &`$address_pipe`&.  It
23573 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23574 argument is inserted in the argument list at that point
23575 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23576 the only item in the argument; in fact, if it were then &%force_command%&
23577 should behave as a no-op.  Rather, it should be used to adjust the command
23578 run while preserving the argument vector separation.
23579
23580 After splitting up into arguments and expansion, the resulting command is run
23581 in a subprocess directly from the transport, &'not'& under a shell. The
23582 message that is being delivered is supplied on the standard input, and the
23583 standard output and standard error are both connected to a single pipe that is
23584 read by Exim. The &%max_output%& option controls how much output the command
23585 may produce, and the &%return_output%& and &%return_fail_output%& options
23586 control what is done with it.
23587
23588 Not running the command under a shell (by default) lessens the security risks
23589 in cases when a command from a user's filter file is built out of data that was
23590 taken from an incoming message. If a shell is required, it can of course be
23591 explicitly specified as the command to be run. However, there are circumstances
23592 where existing commands (for example, in &_.forward_& files) expect to be run
23593 under a shell and cannot easily be modified. To allow for these cases, there is
23594 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23595 works. Instead of breaking up the command line as just described, it expands it
23596 as a single string and passes the result to &_/bin/sh_&. The
23597 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23598 with &%use_shell%&, and the whole mechanism is inherently less secure.
23599
23600
23601
23602 .section "Environment variables" "SECTpipeenv"
23603 .cindex "&(pipe)& transport" "environment for command"
23604 .cindex "environment" "&(pipe)& transport"
23605 The environment variables listed below are set up when the command is invoked.
23606 This list is a compromise for maximum compatibility with other MTAs. Note that
23607 the &%environment%& option can be used to add additional variables to this
23608 environment. The environment for the &(pipe)& transport is not subject
23609 to the &%add_environment%& and &%keep_environment%& main config options.
23610 .display
23611 &`DOMAIN            `&   the domain of the address
23612 &`HOME              `&   the home directory, if set
23613 &`HOST              `&   the host name when called from a router (see below)
23614 &`LOCAL_PART        `&   see below
23615 &`LOCAL_PART_PREFIX `&   see below
23616 &`LOCAL_PART_SUFFIX `&   see below
23617 &`LOGNAME           `&   see below
23618 &`MESSAGE_ID        `&   Exim's local ID for the message
23619 &`PATH              `&   as specified by the &%path%& option below
23620 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23621 &`RECIPIENT         `&   the complete recipient address
23622 &`SENDER            `&   the sender of the message (empty if a bounce)
23623 &`SHELL             `&   &`/bin/sh`&
23624 &`TZ                `&   the value of the &%timezone%& option, if set
23625 &`USER              `&   see below
23626 .endd
23627 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23628 router, LOCAL_PART is set to the local part of the address. When it is
23629 called as a result of a forward or alias expansion, LOCAL_PART is set to
23630 the local part of the address that was expanded. In both cases, any affixes are
23631 removed from the local part, and made available in LOCAL_PART_PREFIX and
23632 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23633 same value as LOCAL_PART for compatibility with other MTAs.
23634
23635 .cindex "HOST"
23636 HOST is set only when a &(pipe)& transport is called from a router that
23637 associates hosts with an address, typically when using &(pipe)& as a
23638 pseudo-remote transport. HOST is set to the first host name specified by
23639 the router.
23640
23641 .cindex "HOME"
23642 If the transport's generic &%home_directory%& option is set, its value is used
23643 for the HOME environment variable. Otherwise, a home directory may be set
23644 by the router's &%transport_home_directory%& option, which defaults to the
23645 user's home directory if &%check_local_user%& is set.
23646
23647
23648 .section "Private options for pipe" "SECID142"
23649 .cindex "options" "&(pipe)& transport"
23650
23651
23652
23653 .option allow_commands pipe "string list&!!" unset
23654 .cindex "&(pipe)& transport" "permitted commands"
23655 The string is expanded, and is then interpreted as a colon-separated list of
23656 permitted commands. If &%restrict_to_path%& is not set, the only commands
23657 permitted are those in the &%allow_commands%& list. They need not be absolute
23658 paths; the &%path%& option is still used for relative paths. If
23659 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23660 in the &%allow_commands%& list, or a name without any slashes that is found on
23661 the path. In other words, if neither &%allow_commands%& nor
23662 &%restrict_to_path%& is set, there is no restriction on the command, but
23663 otherwise only commands that are permitted by one or the other are allowed. For
23664 example, if
23665 .code
23666 allow_commands = /usr/bin/vacation
23667 .endd
23668 and &%restrict_to_path%& is not set, the only permitted command is
23669 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23670 &%use_shell%& is set.
23671
23672
23673 .option batch_id pipe string&!! unset
23674 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23675
23676
23677 .option batch_max pipe integer 1
23678 This limits the number of addresses that can be handled in a single delivery.
23679 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23680
23681
23682 .option check_string pipe string unset
23683 As &(pipe)& writes the message, the start of each line is tested for matching
23684 &%check_string%&, and if it does, the initial matching characters are replaced
23685 by the contents of &%escape_string%&, provided both are set. The value of
23686 &%check_string%& is a literal string, not a regular expression, and the case of
23687 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23688 of &%check_string%& and &%escape_string%& are forced to values that implement
23689 the SMTP escaping protocol. Any settings made in the configuration file are
23690 ignored.
23691
23692
23693 .option command pipe string&!! unset
23694 This option need not be set when &(pipe)& is being used to deliver to pipes
23695 obtained directly from address redirections. In other cases, the option must be
23696 set, to provide a command to be run. It need not yield an absolute path (see
23697 the &%path%& option below). The command is split up into separate arguments by
23698 Exim, and each argument is separately expanded, as described in section
23699 &<<SECThowcommandrun>>& above.
23700
23701
23702 .option environment pipe string&!! unset
23703 .cindex "&(pipe)& transport" "environment for command"
23704 .cindex "environment" "&(pipe)& transport"
23705 This option is used to add additional variables to the environment in which the
23706 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23707 a string which is expanded, and then interpreted as a colon-separated list of
23708 environment settings of the form <&'name'&>=<&'value'&>.
23709
23710
23711 .option escape_string pipe string unset
23712 See &%check_string%& above.
23713
23714
23715 .option freeze_exec_fail pipe boolean false
23716 .cindex "exec failure"
23717 .cindex "failure of exec"
23718 .cindex "&(pipe)& transport" "failure of exec"
23719 Failure to exec the command in a pipe transport is by default treated like
23720 any other failure while running the command. However, if &%freeze_exec_fail%&
23721 is set, failure to exec is treated specially, and causes the message to be
23722 frozen, whatever the setting of &%ignore_status%&.
23723
23724
23725 .option freeze_signal pipe boolean false
23726 .cindex "signal exit"
23727 .cindex "&(pipe)& transport", "signal exit"
23728 Normally if the process run by a command in a pipe transport exits on a signal,
23729 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23730 frozen in Exim's queue instead.
23731
23732
23733 .option force_command pipe boolean false
23734 .cindex "force command"
23735 .cindex "&(pipe)& transport", "force command"
23736 Normally when a router redirects an address directly to a pipe command
23737 the &%command%& option on the transport is ignored.  If &%force_command%&
23738 is set, the &%command%& option will used. This is especially
23739 useful for forcing a wrapper or additional argument to be added to the
23740 command. For example:
23741 .code
23742 command = /usr/bin/remote_exec myhost -- $address_pipe
23743 force_command
23744 .endd
23745
23746 Note that &$address_pipe$& is handled specially in &%command%& when
23747 &%force_command%& is set, expanding out to the original argument vector as
23748 separate items, similarly to a Unix shell &`"$@"`& construct.
23749
23750
23751 .option ignore_status pipe boolean false
23752 If this option is true, the status returned by the subprocess that is set up to
23753 run the command is ignored, and Exim behaves as if zero had been returned.
23754 Otherwise, a non-zero status or termination by signal causes an error return
23755 from the transport unless the status value is one of those listed in
23756 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23757
23758 &*Note*&: This option does not apply to timeouts, which do not return a status.
23759 See the &%timeout_defer%& option for how timeouts are handled.
23760
23761
23762 .option log_defer_output pipe boolean false
23763 .cindex "&(pipe)& transport" "logging output"
23764 If this option is set, and the status returned by the command is
23765 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23766 and any output was produced on stdout or stderr, the first line of it is
23767 written to the main log.
23768
23769
23770 .option log_fail_output pipe boolean false
23771 If this option is set, and the command returns any output on stdout or
23772 stderr, and also ends with a return code that is neither zero nor one of
23773 the return codes listed in &%temp_errors%& (that is, the delivery
23774 failed), the first line of output is written to the main log. This
23775 option and &%log_output%& are mutually exclusive.  Only one of them may
23776 be set.
23777
23778
23779 .option log_output pipe boolean false
23780 If this option is set and the command returns any output on stdout or
23781 stderr, the first line of output is written to the main log, whatever
23782 the return code. This option and &%log_fail_output%& are mutually
23783 exclusive. Only one of them may be set.
23784
23785
23786 .option max_output pipe integer 20K
23787 This specifies the maximum amount of output that the command may produce on its
23788 standard output and standard error file combined. If the limit is exceeded, the
23789 process running the command is killed. This is intended as a safety measure to
23790 catch runaway processes. The limit is applied independently of the settings of
23791 the options that control what is done with such output (for example,
23792 &%return_output%&). Because of buffering effects, the amount of output may
23793 exceed the limit by a small amount before Exim notices.
23794
23795
23796 .option message_prefix pipe string&!! "see below"
23797 The string specified here is expanded and output at the start of every message.
23798 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23799 .code
23800 message_prefix = \
23801   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23802   ${tod_bsdinbox}\n
23803 .endd
23804 .cindex "Cyrus"
23805 .cindex "&%tmail%&"
23806 .cindex "&""From""& line"
23807 This is required by the commonly used &_/usr/bin/vacation_& program.
23808 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23809 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23810 setting
23811 .code
23812 message_prefix =
23813 .endd
23814 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23815 &`\n`& to &`\r\n`& in &%message_prefix%&.
23816
23817
23818 .option message_suffix pipe string&!! "see below"
23819 The string specified here is expanded and output at the end of every message.
23820 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23821 The suffix can be suppressed by setting
23822 .code
23823 message_suffix =
23824 .endd
23825 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23826 &`\n`& to &`\r\n`& in &%message_suffix%&.
23827
23828
23829 .option path pipe string&!! "/bin:/usr/bin"
23830 This option is expanded and
23831 specifies the string that is set up in the PATH environment
23832 variable of the subprocess.
23833 If the &%command%& option does not yield an absolute path name, the command is
23834 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23835 apply to a command specified as a transport filter.
23836
23837
23838 .option permit_coredump pipe boolean false
23839 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23840 a core-dump of a pipe command, enable this command.  This enables core-dumps
23841 during delivery and affects both the Exim binary and the pipe command run.
23842 It is recommended that this option remain off unless and until you have a need
23843 for it and that this only be enabled when needed, as the risk of excessive
23844 resource consumption can be quite high.  Note also that Exim is typically
23845 installed as a setuid binary and most operating systems will inhibit coredumps
23846 of these by default, so further OS-specific action may be required.
23847
23848
23849 .option pipe_as_creator pipe boolean false
23850 .cindex "uid (user id)" "local delivery"
23851 If the generic &%user%& option is not set and this option is true, the delivery
23852 process is run under the uid that was in force when Exim was originally called
23853 to accept the message. If the group id is not otherwise set (via the generic
23854 &%group%& option), the gid that was in force when Exim was originally called to
23855 accept the message is used.
23856
23857
23858 .option restrict_to_path pipe boolean false
23859 When this option is set, any command name not listed in &%allow_commands%& must
23860 contain no slashes. The command is searched for only in the directories listed
23861 in the &%path%& option. This option is intended for use in the case when a pipe
23862 command has been generated from a user's &_.forward_& file. This is usually
23863 handled by a &(pipe)& transport called &%address_pipe%&.
23864
23865
23866 .option return_fail_output pipe boolean false
23867 If this option is true, and the command produced any output and ended with a
23868 return code other than zero or one of the codes listed in &%temp_errors%& (that
23869 is, the delivery failed), the output is returned in the bounce message.
23870 However, if the message has a null sender (that is, it is itself a bounce
23871 message), output from the command is discarded. This option and
23872 &%return_output%& are mutually exclusive. Only one of them may be set.
23873
23874
23875
23876 .option return_output pipe boolean false
23877 If this option is true, and the command produced any output, the delivery is
23878 deemed to have failed whatever the return code from the command, and the output
23879 is returned in the bounce message. Otherwise, the output is just discarded.
23880 However, if the message has a null sender (that is, it is a bounce message),
23881 output from the command is always discarded, whatever the setting of this
23882 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23883 of them may be set.
23884
23885
23886
23887 .option temp_errors pipe "string list" "see below"
23888 .cindex "&(pipe)& transport" "temporary failure"
23889 This option contains either a colon-separated list of numbers, or a single
23890 asterisk. If &%ignore_status%& is false
23891 and &%return_output%& is not set,
23892 and the command exits with a non-zero return code, the failure is treated as
23893 temporary and the delivery is deferred if the return code matches one of the
23894 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23895 codes are treated as permanent errors. The default setting contains the codes
23896 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23897 compiled on a system that does not define these macros, it assumes values of 75
23898 and 73, respectively.
23899
23900
23901 .option timeout pipe time 1h
23902 If the command fails to complete within this time, it is killed. This normally
23903 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23904 specifies no timeout. In order to ensure that any subprocesses created by the
23905 command are also killed, Exim makes the initial process a process group leader,
23906 and kills the whole process group on a timeout. However, this can be defeated
23907 if one of the processes starts a new process group.
23908
23909 .option timeout_defer pipe boolean false
23910 A timeout in a &(pipe)& transport, either in the command that the transport
23911 runs, or in a transport filter that is associated with it, is by default
23912 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23913 is set true, both kinds of timeout become temporary errors, causing the
23914 delivery to be deferred.
23915
23916 .option umask pipe "octal integer" 022
23917 This specifies the umask setting for the subprocess that runs the command.
23918
23919
23920 .option use_bsmtp pipe boolean false
23921 .cindex "envelope sender"
23922 If this option is set true, the &(pipe)& transport writes messages in &"batch
23923 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23924 commands. If you want to include a leading HELO command with such messages,
23925 you can do so by setting the &%message_prefix%& option. See section
23926 &<<SECTbatchSMTP>>& for details of batch SMTP.
23927
23928 .option use_classresources pipe boolean false
23929 .cindex "class resources (BSD)"
23930 This option is available only when Exim is running on FreeBSD, NetBSD, or
23931 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23932 resource limits when a &(pipe)& transport is run to perform a delivery. The
23933 limits for the uid under which the pipe is to run are obtained from the login
23934 class database.
23935
23936
23937 .option use_crlf pipe boolean false
23938 .cindex "carriage return"
23939 .cindex "linefeed"
23940 This option causes lines to be terminated with the two-character CRLF sequence
23941 (carriage return, linefeed) instead of just a linefeed character. In the case
23942 of batched SMTP, the byte sequence written to the pipe is then an exact image
23943 of what would be sent down a real SMTP connection.
23944
23945 The contents of the &%message_prefix%& and &%message_suffix%& options are
23946 written verbatim, so must contain their own carriage return characters if these
23947 are needed. When &%use_bsmtp%& is not set, the default values for both
23948 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23949 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23950
23951
23952 .option use_shell pipe boolean false
23953 .vindex "&$pipe_addresses$&"
23954 If this option is set, it causes the command to be passed to &_/bin/sh_&
23955 instead of being run directly from the transport, as described in section
23956 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23957 where the command is expected to be run under a shell and cannot easily be
23958 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23959 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23960 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23961 its &%-c%& option.
23962
23963
23964
23965 .section "Using an external local delivery agent" "SECID143"
23966 .cindex "local delivery" "using an external agent"
23967 .cindex "&'procmail'&"
23968 .cindex "external local delivery"
23969 .cindex "delivery" "&'procmail'&"
23970 .cindex "delivery" "by external agent"
23971 The &(pipe)& transport can be used to pass all messages that require local
23972 delivery to a separate local delivery agent such as &%procmail%&. When doing
23973 this, care must be taken to ensure that the pipe is run under an appropriate
23974 uid and gid. In some configurations one wants this to be a uid that is trusted
23975 by the delivery agent to supply the correct sender of the message. It may be
23976 necessary to recompile or reconfigure the delivery agent so that it trusts an
23977 appropriate user. The following is an example transport and router
23978 configuration for &%procmail%&:
23979 .code
23980 # transport
23981 procmail_pipe:
23982   driver = pipe
23983   command = /usr/local/bin/procmail -d $local_part
23984   return_path_add
23985   delivery_date_add
23986   envelope_to_add
23987   check_string = "From "
23988   escape_string = ">From "
23989   umask = 077
23990   user = $local_part
23991   group = mail
23992
23993 # router
23994 procmail:
23995   driver = accept
23996   check_local_user
23997   transport = procmail_pipe
23998 .endd
23999 In this example, the pipe is run as the local user, but with the group set to
24000 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24001 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24002 user to supply a correct sender address. If you do not specify either a
24003 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24004 home directory is the user's home directory by default.
24005
24006 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24007 .code
24008 IFS=" "
24009 .endd
24010 as shown in some &%procmail%& documentation, because Exim does not by default
24011 use a shell to run pipe commands.
24012
24013 .cindex "Cyrus"
24014 The next example shows a transport and a router for a system where local
24015 deliveries are handled by the Cyrus IMAP server.
24016 .code
24017 # transport
24018 local_delivery_cyrus:
24019   driver = pipe
24020   command = /usr/cyrus/bin/deliver \
24021             -m ${substr_1:$local_part_suffix} -- $local_part
24022   user = cyrus
24023   group = mail
24024   return_output
24025   log_output
24026   message_prefix =
24027   message_suffix =
24028
24029 # router
24030 local_user_cyrus:
24031   driver = accept
24032   check_local_user
24033   local_part_suffix = .*
24034   transport = local_delivery_cyrus
24035 .endd
24036 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24037 &%return_output%& to cause any text written by Cyrus to be returned to the
24038 sender.
24039 .ecindex IIDpiptra1
24040 .ecindex IIDpiptra2
24041
24042
24043 . ////////////////////////////////////////////////////////////////////////////
24044 . ////////////////////////////////////////////////////////////////////////////
24045
24046 .chapter "The smtp transport" "CHAPsmtptrans"
24047 .scindex IIDsmttra1 "transports" "&(smtp)&"
24048 .scindex IIDsmttra2 "&(smtp)& transport"
24049 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24050 or LMTP protocol. The list of hosts to try can either be taken from the address
24051 that is being processed (having been set up by the router), or specified
24052 explicitly for the transport. Timeout and retry processing (see chapter
24053 &<<CHAPretry>>&) is applied to each IP address independently.
24054
24055
24056 .section "Multiple messages on a single connection" "SECID144"
24057 The sending of multiple messages over a single TCP/IP connection can arise in
24058 two ways:
24059
24060 .ilist
24061 If a message contains more than &%max_rcpt%& (see below) addresses that are
24062 routed to the same host, more than one copy of the message has to be sent to
24063 that host. In this situation, multiple copies may be sent in a single run of
24064 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24065 does when it has too many addresses to send in one message also depends on the
24066 value of the global &%remote_max_parallel%& option. Details are given in
24067 section &<<SECToutSMTPTCP>>&.)
24068 .next
24069 .cindex "hints database" "remembering routing"
24070 When a message has been successfully delivered over a TCP/IP connection, Exim
24071 looks in its hints database to see if there are any other messages awaiting a
24072 connection to the same host. If there are, a new delivery process is started
24073 for one of them, and the current TCP/IP connection is passed on to it. The new
24074 process may in turn send multiple copies and possibly create yet another
24075 process.
24076 .endlist
24077
24078
24079 For each copy sent over the same TCP/IP connection, a sequence counter is
24080 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24081 no further messages are sent over that connection.
24082
24083
24084
24085 .section "Use of the $host and $host_address variables" "SECID145"
24086 .vindex "&$host$&"
24087 .vindex "&$host_address$&"
24088 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24089 &$host_address$& are the name and IP address of the first host on the host list
24090 passed by the router. However, when the transport is about to connect to a
24091 specific host, and while it is connected to that host, &$host$& and
24092 &$host_address$& are set to the values for that host. These are the values
24093 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24094 &%serialize_hosts%&, and the various TLS options are expanded.
24095
24096
24097 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24098 .vindex &$tls_bits$&
24099 .vindex &$tls_cipher$&
24100 .vindex &$tls_peerdn$&
24101 .vindex &$tls_sni$&
24102 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24103 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24104 are the values that were set when the message was received.
24105 These are the values that are used for options that are expanded before any
24106 SMTP connections are made. Just before each connection is made, these four
24107 variables are emptied. If TLS is subsequently started, they are set to the
24108 appropriate values for the outgoing connection, and these are the values that
24109 are in force when any authenticators are run and when the
24110 &%authenticated_sender%& option is expanded.
24111
24112 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24113 and will be removed in a future release.
24114
24115
24116 .section "Private options for smtp" "SECID146"
24117 .cindex "options" "&(smtp)& transport"
24118 The private options of the &(smtp)& transport are as follows:
24119
24120
24121 .option address_retry_include_sender smtp boolean true
24122 .cindex "4&'xx'& responses" "retrying after"
24123 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24124 is the combination of sender and recipient that is delayed in subsequent queue
24125 runs until the retry time is reached. You can delay the recipient without
24126 reference to the sender (which is what earlier versions of Exim did), by
24127 setting &%address_retry_include_sender%& false. However, this can lead to
24128 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24129
24130 .option allow_localhost smtp boolean false
24131 .cindex "local host" "sending to"
24132 .cindex "fallback" "hosts specified on transport"
24133 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24134 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24135 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24136 the delivery anyway. This should be used only in special cases when the
24137 configuration ensures that no looping will result (for example, a differently
24138 configured Exim is listening on the port to which the message is sent).
24139
24140
24141 .option authenticated_sender smtp string&!! unset
24142 .cindex "Cyrus"
24143 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24144 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24145 overriding any existing authenticated sender value. If the string expansion is
24146 forced to fail, the option is ignored. Other expansion failures cause delivery
24147 to be deferred. If the result of expansion is an empty string, that is also
24148 ignored.
24149
24150 The expansion happens after the outgoing connection has been made and TLS
24151 started, if required. This means that the &$host$&, &$host_address$&,
24152 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24153 particular connection.
24154
24155 If the SMTP session is not authenticated, the expansion of
24156 &%authenticated_sender%& still happens (and can cause the delivery to be
24157 deferred if it fails), but no AUTH= item is added to MAIL commands
24158 unless &%authenticated_sender_force%& is true.
24159
24160 This option allows you to use the &(smtp)& transport in LMTP mode to
24161 deliver mail to Cyrus IMAP and provide the proper local part as the
24162 &"authenticated sender"&, via a setting such as:
24163 .code
24164 authenticated_sender = $local_part
24165 .endd
24166 This removes the need for IMAP subfolders to be assigned special ACLs to
24167 allow direct delivery to those subfolders.
24168
24169 Because of expected uses such as that just described for Cyrus (when no
24170 domain is involved), there is no checking on the syntax of the provided
24171 value.
24172
24173
24174 .option authenticated_sender_force smtp boolean false
24175 If this option is set true, the &%authenticated_sender%& option's value
24176 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24177 authenticated as a client.
24178
24179
24180 .option command_timeout smtp time 5m
24181 This sets a timeout for receiving a response to an SMTP command that has been
24182 sent out. It is also used when waiting for the initial banner line from the
24183 remote host. Its value must not be zero.
24184
24185
24186 .option connect_timeout smtp time 5m
24187 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24188 to a remote host. A setting of zero allows the system timeout (typically
24189 several minutes) to act. To have any effect, the value of this option must be
24190 less than the system timeout. However, it has been observed that on some
24191 systems there is no system timeout, which is why the default value for this
24192 option is 5 minutes, a value recommended by RFC 1123.
24193
24194
24195 .option connection_max_messages smtp integer 500
24196 .cindex "SMTP" "passed connection"
24197 .cindex "SMTP" "multiple deliveries"
24198 .cindex "multiple SMTP deliveries"
24199 This controls the maximum number of separate message deliveries that are sent
24200 over a single TCP/IP connection. If the value is zero, there is no limit.
24201 For testing purposes, this value can be overridden by the &%-oB%& command line
24202 option.
24203
24204
24205 .option dane_require_tls_ciphers smtp string&!! unset
24206 .cindex "TLS" "requiring specific ciphers for DANE"
24207 .cindex "cipher" "requiring specific"
24208 .cindex DANE "TLS ciphers"
24209 This option may be used to override &%tls_require_ciphers%& for connections
24210 where DANE has been determined to be in effect.
24211 If not set, then &%tls_require_ciphers%& will be used.
24212 Normal SMTP delivery is not able to make strong demands of TLS cipher
24213 configuration, because delivery will fall back to plaintext.  Once DANE has
24214 been determined to be in effect, there is no plaintext fallback and making the
24215 TLS cipherlist configuration stronger will increase security, rather than
24216 counter-intuitively decreasing it.
24217 If the option expands to be empty or is forced to fail, then it will
24218 be treated as unset and &%tls_require_ciphers%& will be used instead.
24219
24220
24221 .option data_timeout smtp time 5m
24222 This sets a timeout for the transmission of each block in the data portion of
24223 the message. As a result, the overall timeout for a message depends on the size
24224 of the message. Its value must not be zero. See also &%final_timeout%&.
24225
24226
24227 .option dkim_canon smtp string&!! unset
24228 .option dkim_domain smtp string list&!! unset
24229 .option dkim_hash smtp string&!! sha256
24230 .option dkim_identity smtp string&!! unset
24231 .option dkim_private_key smtp string&!! unset
24232 .option dkim_selector smtp string&!! unset
24233 .option dkim_strict smtp string&!! unset
24234 .option dkim_sign_headers smtp string&!! "per RFC"
24235 .option dkim_timestamps smtp string&!! unset
24236 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
24237
24238
24239 .option delay_after_cutoff smtp boolean true
24240 .cindex "final cutoff" "retries, controlling"
24241 .cindex retry "final cutoff"
24242 This option controls what happens when all remote IP addresses for a given
24243 domain have been inaccessible for so long that they have passed their retry
24244 cutoff times.
24245
24246 In the default state, if the next retry time has not been reached for any of
24247 them, the address is bounced without trying any deliveries. In other words,
24248 Exim delays retrying an IP address after the final cutoff time until a new
24249 retry time is reached, and can therefore bounce an address without ever trying
24250 a delivery, when machines have been down for a long time. Some people are
24251 unhappy at this prospect, so...
24252
24253 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24254 addresses are past their final cutoff time, Exim tries to deliver to those
24255 IP addresses that have not been tried since the message arrived. If there are
24256 none, of if they all fail, the address is bounced. In other words, it does not
24257 delay when a new message arrives, but immediately tries those expired IP
24258 addresses that haven't been tried since the message arrived. If there is a
24259 continuous stream of messages for the dead hosts, unsetting
24260 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24261 to them.
24262
24263
24264 .option dns_qualify_single smtp boolean true
24265 If the &%hosts%& or &%fallback_hosts%& option is being used,
24266 and the &%gethostbyname%& option is false,
24267 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24268 in chapter &<<CHAPdnslookup>>& for more details.
24269
24270
24271 .option dns_search_parents smtp boolean false
24272 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24273 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24274 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24275 details.
24276
24277
24278 .option dnssec_request_domains smtp "domain list&!!" unset
24279 .cindex "MX record" "security"
24280 .cindex "DNSSEC" "MX lookup"
24281 .cindex "security" "MX lookup"
24282 .cindex "DNS" "DNSSEC"
24283 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24284 the dnssec request bit set.
24285 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24286
24287
24288
24289 .option dnssec_require_domains smtp "domain list&!!" unset
24290 .cindex "MX record" "security"
24291 .cindex "DNSSEC" "MX lookup"
24292 .cindex "security" "MX lookup"
24293 .cindex "DNS" "DNSSEC"
24294 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24295 the dnssec request bit set.  Any returns not having the Authenticated Data bit
24296 (AD bit) set will be ignored and logged as a host-lookup failure.
24297 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24298
24299
24300
24301 .option dscp smtp string&!! unset
24302 .cindex "DCSP" "outbound"
24303 This option causes the DSCP value associated with a socket to be set to one
24304 of a number of fixed strings or to numeric value.
24305 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24306 Common values include &`throughput`&, &`mincost`&, and on newer systems
24307 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24308
24309 The outbound packets from Exim will be marked with this value in the header
24310 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24311 that these values will have any effect, not be stripped by networking
24312 equipment, or do much of anything without cooperation with your Network
24313 Engineer and those of all network operators between the source and destination.
24314
24315
24316 .option fallback_hosts smtp "string list" unset
24317 .cindex "fallback" "hosts specified on transport"
24318 String expansion is not applied to this option. The argument must be a
24319 colon-separated list of host names or IP addresses, optionally also including
24320 port numbers, though the separator can be changed, as described in section
24321 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24322 item in a &%route_list%& setting for the &(manualroute)& router, as described
24323 in section &<<SECTformatonehostitem>>&.
24324
24325 Fallback hosts can also be specified on routers, which associate them with the
24326 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24327 &%fallback_hosts%& specified on the transport is used only if the address does
24328 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24329 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24330 However, &%hosts_randomize%& does apply to fallback host lists.
24331
24332 If Exim is unable to deliver to any of the hosts for a particular address, and
24333 the errors are not permanent rejections, the address is put on a separate
24334 transport queue with its host list replaced by the fallback hosts, unless the
24335 address was routed via MX records and the current host was in the original MX
24336 list. In that situation, the fallback host list is not used.
24337
24338 Once normal deliveries are complete, the fallback queue is delivered by
24339 re-running the same transports with the new host lists. If several failing
24340 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24341 copy of the message is sent.
24342
24343 The resolution of the host names on the fallback list is controlled by the
24344 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24345 both to cases when the host list comes with the address and when it is taken
24346 from &%hosts%&. This option provides a &"use a smart host only if delivery
24347 fails"& facility.
24348
24349
24350 .option final_timeout smtp time 10m
24351 This is the timeout that applies while waiting for the response to the final
24352 line containing just &"."& that terminates a message. Its value must not be
24353 zero.
24354
24355 .option gethostbyname smtp boolean false
24356 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24357 being used, names are looked up using &[gethostbyname()]&
24358 (or &[getipnodebyname()]& when available)
24359 instead of using the DNS. Of course, that function may in fact use the DNS, but
24360 it may also consult other sources of information such as &_/etc/hosts_&.
24361
24362 .option gnutls_compat_mode smtp boolean unset
24363 This option controls whether GnuTLS is used in compatibility mode in an Exim
24364 server. This reduces security slightly, but improves interworking with older
24365 implementations of TLS.
24366
24367 .option helo_data smtp string&!! "see below"
24368 .cindex "HELO" "argument, setting"
24369 .cindex "EHLO" "argument, setting"
24370 .cindex "LHLO argument setting"
24371 The value of this option is expanded after a connection to a another host has
24372 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24373 command that starts the outgoing SMTP or LMTP session. The default value of the
24374 option is:
24375 .code
24376 $primary_hostname
24377 .endd
24378 During the expansion, the variables &$host$& and &$host_address$& are set to
24379 the identity of the remote host, and the variables &$sending_ip_address$& and
24380 &$sending_port$& are set to the local IP address and port number that are being
24381 used. These variables can be used to generate different values for different
24382 servers or different local IP addresses. For example, if you want the string
24383 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24384 interface address, you could use this:
24385 .code
24386 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24387   {$primary_hostname}}
24388 .endd
24389 The use of &%helo_data%& applies both to sending messages and when doing
24390 callouts.
24391
24392 .option hosts smtp "string list&!!" unset
24393 Hosts are associated with an address by a router such as &(dnslookup)&, which
24394 finds the hosts by looking up the address domain in the DNS, or by
24395 &(manualroute)&, which has lists of hosts in its configuration. However,
24396 email addresses can be passed to the &(smtp)& transport by any router, and not
24397 all of them can provide an associated list of hosts.
24398
24399 The &%hosts%& option specifies a list of hosts to be used if the address being
24400 processed does not have any hosts associated with it. The hosts specified by
24401 &%hosts%& are also used, whether or not the address has its own hosts, if
24402 &%hosts_override%& is set.
24403
24404 The string is first expanded, before being interpreted as a colon-separated
24405 list of host names or IP addresses, possibly including port numbers. The
24406 separator may be changed to something other than colon, as described in section
24407 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24408 item in a &%route_list%& setting for the &(manualroute)& router, as described
24409 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24410 of the &(manualroute)& router is not available here.
24411
24412 If the expansion fails, delivery is deferred. Unless the failure was caused by
24413 the inability to complete a lookup, the error is logged to the panic log as
24414 well as the main log. Host names are looked up either by searching directly for
24415 address records in the DNS or by calling &[gethostbyname()]& (or
24416 &[getipnodebyname()]& when available), depending on the setting of the
24417 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24418 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24419 address are used.
24420
24421 During delivery, the hosts are tried in order, subject to their retry status,
24422 unless &%hosts_randomize%& is set.
24423
24424
24425 .option hosts_avoid_esmtp smtp "host list&!!" unset
24426 .cindex "ESMTP, avoiding use of"
24427 .cindex "HELO" "forcing use of"
24428 .cindex "EHLO" "avoiding use of"
24429 .cindex "PIPELINING" "avoiding the use of"
24430 This option is for use with broken hosts that announce ESMTP facilities (for
24431 example, PIPELINING) and then fail to implement them properly. When a host
24432 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24433 start of the SMTP session. This means that it cannot use any of the ESMTP
24434 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24435
24436
24437 .option hosts_avoid_pipelining smtp "host list&!!" unset
24438 .cindex "PIPELINING" "avoiding the use of"
24439 Exim will not use the SMTP PIPELINING extension when delivering to any host
24440 that matches this list, even if the server host advertises PIPELINING support.
24441
24442
24443 .option hosts_avoid_tls smtp "host list&!!" unset
24444 .cindex "TLS" "avoiding for certain hosts"
24445 Exim will not try to start a TLS session when delivering to any host that
24446 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24447
24448 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24449 .cindex "TLS" "avoiding for certain hosts"
24450 Exim will not try to start a TLS session for a verify callout,
24451 or when delivering in cutthrough mode,
24452 to any host that matches this list.
24453
24454
24455 .option hosts_max_try smtp integer 5
24456 .cindex "host" "maximum number to try"
24457 .cindex "limit" "number of hosts tried"
24458 .cindex "limit" "number of MX tried"
24459 .cindex "MX record" "maximum tried"
24460 This option limits the number of IP addresses that are tried for any one
24461 delivery in cases where there are temporary delivery errors. Section
24462 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24463
24464
24465 .option hosts_max_try_hardlimit smtp integer 50
24466 This is an additional check on the maximum number of IP addresses that Exim
24467 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24468 why it exists.
24469
24470
24471
24472 .option hosts_nopass_tls smtp "host list&!!" unset
24473 .cindex "TLS" "passing connection"
24474 .cindex "multiple SMTP deliveries"
24475 .cindex "TLS" "multiple message deliveries"
24476 For any host that matches this list, a connection on which a TLS session has
24477 been started will not be passed to a new delivery process for sending another
24478 message on the same connection. See section &<<SECTmulmessam>>& for an
24479 explanation of when this might be needed.
24480
24481 .option hosts_noproxy_tls smtp "host list&!!" *
24482 .cindex "TLS" "passing connection"
24483 .cindex "multiple SMTP deliveries"
24484 .cindex "TLS" "multiple message deliveries"
24485 For any host that matches this list, a TLS session which has
24486 been started will not be passed to a new delivery process for sending another
24487 message on the same session.
24488
24489 The traditional implementation closes down TLS and re-starts it in the new
24490 process, on the same open TCP connection, for each successive message
24491 sent.  If permitted by this option a pipe to to the new process is set up
24492 instead, and the original process maintains the TLS connection and proxies
24493 the SMTP connection from and to the new process and any subsequents.
24494 The new process has no access to TLS information, so cannot include it in
24495 logging.
24496
24497
24498
24499 .option hosts_override smtp boolean false
24500 If this option is set and the &%hosts%& option is also set, any hosts that are
24501 attached to the address are ignored, and instead the hosts specified by the
24502 &%hosts%& option are always used. This option does not apply to
24503 &%fallback_hosts%&.
24504
24505
24506 .option hosts_randomize smtp boolean false
24507 .cindex "randomized host list"
24508 .cindex "host" "list of; randomized"
24509 .cindex "fallback" "randomized hosts"
24510 If this option is set, and either the list of hosts is taken from the
24511 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24512 were not obtained from MX records (this includes fallback hosts from the
24513 router), and were not randomized by the router, the order of trying the hosts
24514 is randomized each time the transport runs. Randomizing the order of a host
24515 list can be used to do crude load sharing.
24516
24517 When &%hosts_randomize%& is true, a host list may be split into groups whose
24518 order is separately randomized. This makes it possible to set up MX-like
24519 behaviour. The boundaries between groups are indicated by an item that is just
24520 &`+`& in the host list. For example:
24521 .code
24522 hosts = host1:host2:host3:+:host4:host5
24523 .endd
24524 The order of the first three hosts and the order of the last two hosts is
24525 randomized for each use, but the first three always end up before the last two.
24526 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24527
24528 .option hosts_require_auth smtp "host list&!!" unset
24529 .cindex "authentication" "required by client"
24530 This option provides a list of servers for which authentication must succeed
24531 before Exim will try to transfer a message. If authentication fails for
24532 servers which are not in this list, Exim tries to send unauthenticated. If
24533 authentication fails for one of these servers, delivery is deferred. This
24534 temporary error is detectable in the retry rules, so it can be turned into a
24535 hard failure if required. See also &%hosts_try_auth%&, and chapter
24536 &<<CHAPSMTPAUTH>>& for details of authentication.
24537
24538
24539 .option hosts_request_ocsp smtp "host list&!!" *
24540 .cindex "TLS" "requiring for certain servers"
24541 Exim will request a Certificate Status on a
24542 TLS session for any host that matches this list.
24543 &%tls_verify_certificates%& should also be set for the transport.
24544
24545 .option hosts_require_dane smtp "host list&!!" unset
24546 .cindex DANE "transport options"
24547 .cindex DANE "requiring for certain servers"
24548 If built with DANE support, Exim  will require that a DNSSEC-validated
24549 TLSA record is present for any host matching the list,
24550 and that a DANE-verified TLS connection is made.
24551 There will be no fallback to in-clear communication.
24552 See section &<<SECDANE>>&.
24553
24554 .option hosts_require_ocsp smtp "host list&!!" unset
24555 .cindex "TLS" "requiring for certain servers"
24556 Exim will request, and check for a valid Certificate Status being given, on a
24557 TLS session for any host that matches this list.
24558 &%tls_verify_certificates%& should also be set for the transport.
24559
24560 .option hosts_require_tls smtp "host list&!!" unset
24561 .cindex "TLS" "requiring for certain servers"
24562 Exim will insist on using a TLS session when delivering to any host that
24563 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24564 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24565 incoming messages, use an appropriate ACL.
24566
24567 .option hosts_try_auth smtp "host list&!!" unset
24568 .cindex "authentication" "optional in client"
24569 This option provides a list of servers to which, provided they announce
24570 authentication support, Exim will attempt to authenticate as a client when it
24571 connects. If authentication fails, Exim will try to transfer the message
24572 unauthenticated. See also &%hosts_require_auth%&, and chapter
24573 &<<CHAPSMTPAUTH>>& for details of authentication.
24574
24575 .option hosts_try_chunking smtp "host list&!!" *
24576 .cindex CHUNKING "enabling, in client"
24577 .cindex BDAT "SMTP command"
24578 .cindex "RFC 3030" "CHUNKING"
24579 This option provides a list of servers to which, provided they announce
24580 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24581 BDAT will not be used in conjunction with a transport filter.
24582
24583 .option hosts_try_dane smtp "host list&!!" unset
24584 .cindex DANE "transport options"
24585 .cindex DANE "attempting for certain servers"
24586 If built with DANE support, Exim  will lookup a
24587 TLSA record for any host matching the list.
24588 If found and verified by DNSSEC,
24589 a DANE-verified TLS connection is made to that host;
24590 there will be no fallback to in-clear communication.
24591 See section &<<SECDANE>>&.
24592
24593 .option hosts_try_fastopen smtp "host list&!!" unset
24594 .cindex "fast open, TCP" "enabling, in client"
24595 .cindex "TCP Fast Open" "enabling, in client"
24596 .cindex "RFC 7413" "TCP Fast Open"
24597 This option provides a list of servers to which, provided
24598 the facility is supported by this system, Exim will attempt to
24599 perform a TCP Fast Open.
24600 No data is sent on the SYN segment but, if the remote server also
24601 supports the facility, it can send its SMTP banner immediately after
24602 the SYN,ACK segment.  This can save up to one round-trip time.
24603
24604 The facility is only active for previously-contacted servers,
24605 as the initiator must present a cookie in the SYN segment.
24606
24607 On (at least some) current Linux distributions the facility must be enabled
24608 in the kernel by the sysadmin before the support is usable.
24609 There is no option for control of the server side; if the system supports
24610 it it is always enabled.  Note that lengthy operations in the connect ACL,
24611 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24612
24613 .option hosts_try_prdr smtp "host list&!!" *
24614 .cindex "PRDR" "enabling, optional in client"
24615 This option provides a list of servers to which, provided they announce
24616 PRDR support, Exim will attempt to negotiate PRDR
24617 for multi-recipient messages.
24618 The option can usually be left as default.
24619
24620 .option interface smtp "string list&!!" unset
24621 .cindex "bind IP address"
24622 .cindex "IP address" "binding"
24623 .vindex "&$host$&"
24624 .vindex "&$host_address$&"
24625 This option specifies which interface to bind to when making an outgoing SMTP
24626 call. The value is an IP address, not an interface name such as
24627 &`eth0`&. Do not confuse this with the interface address that was used when a
24628 message was received, which is in &$received_ip_address$&, formerly known as
24629 &$interface_address$&. The name was changed to minimize confusion with the
24630 outgoing interface address. There is no variable that contains an outgoing
24631 interface address because, unless it is set by this option, its value is
24632 unknown.
24633
24634 During the expansion of the &%interface%& option the variables &$host$& and
24635 &$host_address$& refer to the host to which a connection is about to be made
24636 during the expansion of the string. Forced expansion failure, or an empty
24637 string result causes the option to be ignored. Otherwise, after expansion, the
24638 string must be a list of IP addresses, colon-separated by default, but the
24639 separator can be changed in the usual way. For example:
24640 .code
24641 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24642 .endd
24643 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24644 connection. If none of them are the correct type, the option is ignored. If
24645 &%interface%& is not set, or is ignored, the system's IP functions choose which
24646 interface to use if the host has more than one.
24647
24648
24649 .option keepalive smtp boolean true
24650 .cindex "keepalive" "on outgoing connection"
24651 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24652 connections. When set, it causes the kernel to probe idle connections
24653 periodically, by sending packets with &"old"& sequence numbers. The other end
24654 of the connection should send a acknowledgment if the connection is still okay
24655 or a reset if the connection has been aborted. The reason for doing this is
24656 that it has the beneficial effect of freeing up certain types of connection
24657 that can get stuck when the remote host is disconnected without tidying up the
24658 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24659 unreachable hosts.
24660
24661
24662 .option lmtp_ignore_quota smtp boolean false
24663 .cindex "LMTP" "ignoring quota errors"
24664 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24665 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24666 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24667
24668 .option max_rcpt smtp integer 100
24669 .cindex "RCPT" "maximum number of outgoing"
24670 This option limits the number of RCPT commands that are sent in a single
24671 SMTP message transaction. Each set of addresses is treated independently, and
24672 so can cause parallel connections to the same host if &%remote_max_parallel%&
24673 permits this.
24674
24675
24676 .option multi_domain smtp boolean&!! true
24677 .vindex "&$domain$&"
24678 When this option is set, the &(smtp)& transport can handle a number of
24679 addresses containing a mixture of different domains provided they all resolve
24680 to the same list of hosts. Turning the option off restricts the transport to
24681 handling only one domain at a time. This is useful if you want to use
24682 &$domain$& in an expansion for the transport, because it is set only when there
24683 is a single domain involved in a remote delivery.
24684
24685 It is expanded per-address and can depend on any of
24686 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24687 &$host$&, &$host_address$& and &$host_port$&.
24688
24689 .option port smtp string&!! "see below"
24690 .cindex "port" "sending TCP/IP"
24691 .cindex "TCP/IP" "setting outgoing port"
24692 This option specifies the TCP/IP port on the server to which Exim connects.
24693 &*Note:*& Do not confuse this with the port that was used when a message was
24694 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24695 The name was changed to minimize confusion with the outgoing port. There is no
24696 variable that contains an outgoing port.
24697
24698 If the value of this option begins with a digit it is taken as a port number;
24699 otherwise it is looked up using &[getservbyname()]&. The default value is
24700 normally &"smtp"&,
24701 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
24702 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
24703 If the expansion fails, or if a port number cannot be found, delivery
24704 is deferred.
24705
24706 .new
24707 Note that at least one Linux distribution has been seen failing
24708 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
24709 .wen
24710
24711
24712
24713 .option protocol smtp string smtp
24714 .cindex "LMTP" "over TCP/IP"
24715 .cindex "ssmtp protocol" "outbound"
24716 .cindex "TLS" "SSL-on-connect outbound"
24717 .vindex "&$port$&"
24718 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24719 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24720 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24721 deliveries into closed message stores. Exim also has support for running LMTP
24722 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24723
24724 If this option is set to &"smtps"&, the default value for the &%port%& option
24725 changes to &"smtps"&, and the transport initiates TLS immediately after
24726 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24727 .new
24728 The Internet standards bodies used to strongly discourage use of this mode,
24729 but as of RFC 8314 it is perferred over STARTTLS for message submission
24730 (as distinct from MTA-MTA communication).
24731 .wen
24732
24733
24734 .option retry_include_ip_address smtp boolean&!! true
24735 Exim normally includes both the host name and the IP address in the key it
24736 constructs for indexing retry data after a temporary delivery failure. This
24737 means that when one of several IP addresses for a host is failing, it gets
24738 tried periodically (controlled by the retry rules), but use of the other IP
24739 addresses is not affected.
24740
24741 However, in some dialup environments hosts are assigned a different IP address
24742 each time they connect. In this situation the use of the IP address as part of
24743 the retry key leads to undesirable behaviour. Setting this option false causes
24744 Exim to use only the host name.
24745 Since it is expanded it can be made to depend on the host or domain.
24746
24747
24748 .option serialize_hosts smtp "host list&!!" unset
24749 .cindex "serializing connections"
24750 .cindex "host" "serializing connections"
24751 Because Exim operates in a distributed manner, if several messages for the same
24752 host arrive at around the same time, more than one simultaneous connection to
24753 the remote host can occur. This is not usually a problem except when there is a
24754 slow link between the hosts. In that situation it may be helpful to restrict
24755 Exim to one connection at a time. This can be done by setting
24756 &%serialize_hosts%& to match the relevant hosts.
24757
24758 .cindex "hints database" "serializing deliveries to a host"
24759 Exim implements serialization by means of a hints database in which a record is
24760 written whenever a process connects to one of the restricted hosts. The record
24761 is deleted when the connection is completed. Obviously there is scope for
24762 records to get left lying around if there is a system or program crash. To
24763 guard against this, Exim ignores any records that are more than six hours old.
24764
24765 If you set up this kind of serialization, you should also arrange to delete the
24766 relevant hints database whenever your system reboots. The names of the files
24767 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24768 may be one or two files, depending on the type of DBM in use. The same files
24769 are used for ETRN serialization.
24770
24771 See also the &%max_parallel%& generic transport option.
24772
24773
24774 .option size_addition smtp integer 1024
24775 .cindex "SMTP" "SIZE"
24776 .cindex "message" "size issue for transport filter"
24777 .cindex "size" "of message"
24778 .cindex "transport" "filter"
24779 .cindex "filter" "transport filter"
24780 If a remote SMTP server indicates that it supports the SIZE option of the
24781 MAIL command, Exim uses this to pass over the message size at the start of
24782 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24783 sends, to allow for headers and other text that may be added during delivery by
24784 configuration options or in a transport filter. It may be necessary to increase
24785 this if a lot of text is added to messages.
24786
24787 Alternatively, if the value of &%size_addition%& is set negative, it disables
24788 the use of the SIZE option altogether.
24789
24790
24791 .option socks_proxy smtp string&!! unset
24792 .cindex proxy SOCKS
24793 This option enables use of SOCKS proxies for connections made by the
24794 transport.  For details see section &<<SECTproxySOCKS>>&.
24795
24796
24797 .option tls_certificate smtp string&!! unset
24798 .cindex "TLS" "client certificate, location of"
24799 .cindex "certificate" "client, location of"
24800 .vindex "&$host$&"
24801 .vindex "&$host_address$&"
24802 The value of this option must be the absolute path to a file which contains the
24803 client's certificate, for possible use when sending a message over an encrypted
24804 connection. The values of &$host$& and &$host_address$& are set to the name and
24805 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24806 details of TLS.
24807
24808 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24809 certificate when sending messages as a client. The global option of the same
24810 name specifies the certificate for Exim as a server; it is not automatically
24811 assumed that the same certificate should be used when Exim is operating as a
24812 client.
24813
24814
24815 .option tls_crl smtp string&!! unset
24816 .cindex "TLS" "client certificate revocation list"
24817 .cindex "certificate" "revocation list for client"
24818 This option specifies a certificate revocation list. The expanded value must
24819 be the name of a file that contains a CRL in PEM format.
24820
24821
24822 .option tls_dh_min_bits smtp integer 1024
24823 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24824 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24825 key agreement is negotiated, the server will provide a large prime number
24826 for use.  This option establishes the minimum acceptable size of that number.
24827 If the parameter offered by the server is too small, then the TLS handshake
24828 will fail.
24829
24830 Only supported when using GnuTLS.
24831
24832
24833 .option tls_privatekey smtp string&!! unset
24834 .cindex "TLS" "client private key, location of"
24835 .vindex "&$host$&"
24836 .vindex "&$host_address$&"
24837 The value of this option must be the absolute path to a file which contains the
24838 client's private key. This is used when sending a message over an encrypted
24839 connection using a client certificate. The values of &$host$& and
24840 &$host_address$& are set to the name and address of the server during the
24841 expansion. If this option is unset, or the expansion is forced to fail, or the
24842 result is an empty string, the private key is assumed to be in the same file as
24843 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24844
24845
24846 .option tls_require_ciphers smtp string&!! unset
24847 .cindex "TLS" "requiring specific ciphers"
24848 .cindex "cipher" "requiring specific"
24849 .vindex "&$host$&"
24850 .vindex "&$host_address$&"
24851 The value of this option must be a list of permitted cipher suites, for use
24852 when setting up an outgoing encrypted connection. (There is a global option of
24853 the same name for controlling incoming connections.) The values of &$host$& and
24854 &$host_address$& are set to the name and address of the server during the
24855 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24856 is used in different ways by OpenSSL and GnuTLS (see sections
24857 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24858 ciphers is a preference order.
24859
24860
24861
24862 .option tls_sni smtp string&!! unset
24863 .cindex "TLS" "Server Name Indication"
24864 .vindex "&$tls_sni$&"
24865 If this option is set then it sets the $tls_out_sni variable and causes any
24866 TLS session to pass this value as the Server Name Indication extension to
24867 the remote side, which can be used by the remote side to select an appropriate
24868 certificate and private key for the session.
24869
24870 See &<<SECTtlssni>>& for more information.
24871
24872 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24873 TLS extensions.
24874
24875
24876
24877
24878 .option tls_tempfail_tryclear smtp boolean true
24879 .cindex "4&'xx'& responses" "to STARTTLS"
24880 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24881 setting up a TLS session, this option determines whether or not Exim should try
24882 to deliver the message unencrypted. If it is set false, delivery to the
24883 current host is deferred; if there are other hosts, they are tried. If this
24884 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24885 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24886 TLS negotiation fails, Exim closes the current connection (because it is in an
24887 unknown state), opens a new one to the same host, and then tries the delivery
24888 in clear.
24889
24890
24891 .option tls_try_verify_hosts smtp "host list&!!" *
24892 .cindex "TLS" "server certificate verification"
24893 .cindex "certificate" "verification of server"
24894 This option gives a list of hosts for which, on encrypted connections,
24895 certificate verification will be tried but need not succeed.
24896 The &%tls_verify_certificates%& option must also be set.
24897 Note that unless the host is in this list
24898 TLS connections will be denied to hosts using self-signed certificates
24899 when &%tls_verify_certificates%& is matched.
24900 The &$tls_out_certificate_verified$& variable is set when
24901 certificate verification succeeds.
24902
24903
24904 .option tls_verify_cert_hostnames smtp "host list&!!" *
24905 .cindex "TLS" "server certificate hostname verification"
24906 .cindex "certificate" "verification of server"
24907 This option give a list of hosts for which,
24908 while verifying the server certificate,
24909 checks will be included on the host name
24910 (note that this will generally be the result of a DNS MX lookup)
24911 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24912 limited to being the initial component of a 3-or-more component FQDN.
24913
24914 There is no equivalent checking on client certificates.
24915
24916
24917 .option tls_verify_certificates smtp string&!! system
24918 .cindex "TLS" "server certificate verification"
24919 .cindex "certificate" "verification of server"
24920 .vindex "&$host$&"
24921 .vindex "&$host_address$&"
24922 The value of this option must be either the
24923 word "system"
24924 or the absolute path to
24925 a file or directory containing permitted certificates for servers,
24926 for use when setting up an encrypted connection.
24927
24928 The "system" value for the option will use a location compiled into the SSL library.
24929 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24930 is taken as empty and an explicit location
24931 must be specified.
24932
24933 The use of a directory for the option value is not available for GnuTLS versions
24934 preceding 3.3.6 and a single file must be used.
24935
24936 With OpenSSL the certificates specified
24937 explicitly
24938 either by file or directory
24939 are added to those given by the system default location.
24940
24941 The values of &$host$& and
24942 &$host_address$& are set to the name and address of the server during the
24943 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24944
24945 For back-compatibility,
24946 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24947 (a single-colon empty list counts as being set)
24948 and certificate verification fails the TLS connection is closed.
24949
24950
24951 .option tls_verify_hosts smtp "host list&!!" unset
24952 .cindex "TLS" "server certificate verification"
24953 .cindex "certificate" "verification of server"
24954 This option gives a list of hosts for which, on encrypted connections,
24955 certificate verification must succeed.
24956 The &%tls_verify_certificates%& option must also be set.
24957 If both this option and &%tls_try_verify_hosts%& are unset
24958 operation is as if this option selected all hosts.
24959
24960 .new
24961 .option utf8_downconvert smtp integer!! unset
24962 .cindex utf8 "address downconversion"
24963 .cindex i18n "utf8 address downconversion"
24964 If built with internationalization support,
24965 this option controls conversion of UTF-8 in message addresses
24966 to a-label form.
24967 For details see section &<<SECTi18nMTA>>&.
24968 .wen
24969
24970
24971
24972
24973 .section "How the limits for the number of hosts to try are used" &&&
24974          "SECTvalhosmax"
24975 .cindex "host" "maximum number to try"
24976 .cindex "limit" "hosts; maximum number tried"
24977 There are two options that are concerned with the number of hosts that are
24978 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24979 &%hosts_max_try_hardlimit%&.
24980
24981
24982 The &%hosts_max_try%& option limits the number of hosts that are tried
24983 for a single delivery. However, despite the term &"host"& in its name, the
24984 option actually applies to each IP address independently. In other words, a
24985 multihomed host is treated as several independent hosts, just as it is for
24986 retrying.
24987
24988 Many of the larger ISPs have multiple MX records which often point to
24989 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24990 created as a result of routing one of these domains.
24991
24992 Trying every single IP address on such a long list does not seem sensible; if
24993 several at the top of the list fail, it is reasonable to assume there is some
24994 problem that is likely to affect all of them. Roughly speaking, the value of
24995 &%hosts_max_try%& is the maximum number that are tried before deferring the
24996 delivery. However, the logic cannot be quite that simple.
24997
24998 Firstly, IP addresses that are skipped because their retry times have not
24999 arrived do not count, and in addition, addresses that are past their retry
25000 limits are also not counted, even when they are tried. This means that when
25001 some IP addresses are past their retry limits, more than the value of
25002 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25003 that all IP addresses are considered before timing out an email address (but
25004 see below for an exception).
25005
25006 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25007 list to see if there is a subsequent host with a different (higher valued) MX.
25008 If there is, that host is considered next, and the current IP address is used
25009 but not counted. This behaviour helps in the case of a domain with a retry rule
25010 that hardly ever delays any hosts, as is now explained:
25011
25012 Consider the case of a long list of hosts with one MX value, and a few with a
25013 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25014 hosts at the top of the list are tried at first. With the default retry rule,
25015 which specifies increasing retry times, the higher MX hosts are eventually
25016 tried when those at the top of the list are skipped because they have not
25017 reached their retry times.
25018
25019 However, it is common practice to put a fixed short retry time on domains for
25020 large ISPs, on the grounds that their servers are rarely down for very long.
25021 Unfortunately, these are exactly the domains that tend to resolve to long lists
25022 of hosts. The short retry time means that the lowest MX hosts are tried every
25023 time. The attempts may be in a different order because of random sorting, but
25024 without the special MX check, the higher MX hosts would never be tried until
25025 all the lower MX hosts had timed out (which might be several days), because
25026 there are always some lower MX hosts that have reached their retry times. With
25027 the special check, Exim considers at least one IP address from each MX value at
25028 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25029 reached.
25030
25031 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25032 particular, Exim normally eventually tries all the IP addresses before timing
25033 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25034 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25035 been set up with hundreds of IP addresses for some domains. It can
25036 take a very long time indeed for an address to time out in these cases.
25037
25038 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25039 Exim never tries more than this number of IP addresses; if it hits this limit
25040 and they are all timed out, the email address is bounced, even though not all
25041 possible IP addresses have been tried.
25042 .ecindex IIDsmttra1
25043 .ecindex IIDsmttra2
25044
25045
25046
25047
25048
25049 . ////////////////////////////////////////////////////////////////////////////
25050 . ////////////////////////////////////////////////////////////////////////////
25051
25052 .chapter "Address rewriting" "CHAPrewrite"
25053 .scindex IIDaddrew "rewriting" "addresses"
25054 There are some circumstances in which Exim automatically rewrites domains in
25055 addresses. The two most common are when an address is given without a domain
25056 (referred to as an &"unqualified address"&) or when an address contains an
25057 abbreviated domain that is expanded by DNS lookup.
25058
25059 Unqualified envelope addresses are accepted only for locally submitted
25060 messages, or for messages that are received from hosts matching
25061 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25062 appropriate. Unqualified addresses in header lines are qualified if they are in
25063 locally submitted messages, or messages from hosts that are permitted to send
25064 unqualified envelope addresses. Otherwise, unqualified addresses in header
25065 lines are neither qualified nor rewritten.
25066
25067 One situation in which Exim does &'not'& automatically rewrite a domain is
25068 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25069 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25070 do this. The new RFCs do not contain this suggestion.
25071
25072
25073 .section "Explicitly configured address rewriting" "SECID147"
25074 This chapter describes the rewriting rules that can be used in the
25075 main rewrite section of the configuration file, and also in the generic
25076 &%headers_rewrite%& option that can be set on any transport.
25077
25078 Some people believe that configured address rewriting is a Mortal Sin.
25079 Others believe that life is not possible without it. Exim provides the
25080 facility; you do not have to use it.
25081
25082 The main rewriting rules that appear in the &"rewrite"& section of the
25083 configuration file are applied to addresses in incoming messages, both envelope
25084 addresses and addresses in header lines. Each rule specifies the types of
25085 address to which it applies.
25086
25087 Whether or not addresses in header lines are rewritten depends on the origin of
25088 the headers and the type of rewriting. Global rewriting, that is, rewriting
25089 rules from the rewrite section of the configuration file, is applied only to
25090 those headers that were received with the message. Header lines that are added
25091 by ACLs or by a system filter or by individual routers or transports (which
25092 are specific to individual recipient addresses) are not rewritten by the global
25093 rules.
25094
25095 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25096 applies all headers except those added by routers and transports. That is, as
25097 well as the headers that were received with the message, it also applies to
25098 headers that were added by an ACL or a system filter.
25099
25100
25101 In general, rewriting addresses from your own system or domain has some
25102 legitimacy. Rewriting other addresses should be done only with great care and
25103 in special circumstances. The author of Exim believes that rewriting should be
25104 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25105 Although it can sometimes be used as a routing tool, this is very strongly
25106 discouraged.
25107
25108 There are two commonly encountered circumstances where rewriting is used, as
25109 illustrated by these examples:
25110
25111 .ilist
25112 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25113 exchange mail with each other behind a firewall, but there is only a single
25114 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25115 &'hitch.fict.example'& when sending mail off-site.
25116 .next
25117 A host rewrites the local parts of its own users so that, for example,
25118 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25119 .endlist
25120
25121
25122
25123 .section "When does rewriting happen?" "SECID148"
25124 .cindex "rewriting" "timing of"
25125 .cindex "&ACL;" "rewriting addresses in"
25126 Configured address rewriting can take place at several different stages of a
25127 message's processing.
25128
25129 .vindex "&$sender_address$&"
25130 At the start of an ACL for MAIL, the sender address may have been rewritten
25131 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25132 ordinary rewrite rules have yet been applied. If, however, the sender address
25133 is verified in the ACL, it is rewritten before verification, and remains
25134 rewritten thereafter. The subsequent value of &$sender_address$& is the
25135 rewritten address. This also applies if sender verification happens in a
25136 RCPT ACL. Otherwise, when the sender address is not verified, it is
25137 rewritten as soon as a message's header lines have been received.
25138
25139 .vindex "&$domain$&"
25140 .vindex "&$local_part$&"
25141 Similarly, at the start of an ACL for RCPT, the current recipient's address
25142 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25143 rewrite rules have yet been applied to it. However, the behaviour is different
25144 from the sender address when a recipient is verified. The address is rewritten
25145 for the verification, but the rewriting is not remembered at this stage. The
25146 value of &$local_part$& and &$domain$& after verification are always the same
25147 as they were before (that is, they contain the unrewritten &-- except for
25148 SMTP-time rewriting &-- address).
25149
25150 As soon as a message's header lines have been received, all the envelope
25151 recipient addresses are permanently rewritten, and rewriting is also applied to
25152 the addresses in the header lines (if configured). This happens before adding
25153 any header lines that were specified in MAIL or RCPT ACLs, and
25154 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25155 before the DATA ACL and &[local_scan()]& functions are run.
25156
25157 When an address is being routed, either for delivery or for verification,
25158 rewriting is applied immediately to child addresses that are generated by
25159 redirection, unless &%no_rewrite%& is set on the router.
25160
25161 .cindex "envelope sender" "rewriting at transport time"
25162 .cindex "rewriting" "at transport time"
25163 .cindex "header lines" "rewriting at transport time"
25164 At transport time, additional rewriting of addresses in header lines can be
25165 specified by setting the generic &%headers_rewrite%& option on a transport.
25166 This option contains rules that are identical in form to those in the rewrite
25167 section of the configuration file. They are applied to the original message
25168 header lines and any that were added by ACLs or a system filter. They are not
25169 applied to header lines that are added by routers or the transport.
25170
25171 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25172 transport option. However, it is not possible to rewrite envelope recipients at
25173 transport time.
25174
25175
25176
25177
25178 .section "Testing the rewriting rules that apply on input" "SECID149"
25179 .cindex "rewriting" "testing"
25180 .cindex "testing" "rewriting"
25181 Exim's input rewriting configuration appears in a part of the run time
25182 configuration file headed by &"begin rewrite"&. It can be tested by the
25183 &%-brw%& command line option. This takes an address (which can be a full RFC
25184 2822 address) as its argument. The output is a list of how the address would be
25185 transformed by the rewriting rules for each of the different places it might
25186 appear in an incoming message, that is, for each different header and for the
25187 envelope sender and recipient fields. For example,
25188 .code
25189 exim -brw ph10@exim.workshop.example
25190 .endd
25191 might produce the output
25192 .code
25193 sender: Philip.Hazel@exim.workshop.example
25194 from: Philip.Hazel@exim.workshop.example
25195 to: ph10@exim.workshop.example
25196 cc: ph10@exim.workshop.example
25197 bcc: ph10@exim.workshop.example
25198 reply-to: Philip.Hazel@exim.workshop.example
25199 env-from: Philip.Hazel@exim.workshop.example
25200 env-to: ph10@exim.workshop.example
25201 .endd
25202 which shows that rewriting has been set up for that address when used in any of
25203 the source fields, but not when it appears as a recipient address. At the
25204 present time, there is no equivalent way of testing rewriting rules that are
25205 set for a particular transport.
25206
25207
25208 .section "Rewriting rules" "SECID150"
25209 .cindex "rewriting" "rules"
25210 The rewrite section of the configuration file consists of lines of rewriting
25211 rules in the form
25212 .display
25213 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25214 .endd
25215 Rewriting rules that are specified for the &%headers_rewrite%& generic
25216 transport option are given as a colon-separated list. Each item in the list
25217 takes the same form as a line in the main rewriting configuration (except that
25218 any colons must be doubled, of course).
25219
25220 The formats of source patterns and replacement strings are described below.
25221 Each is terminated by white space, unless enclosed in double quotes, in which
25222 case normal quoting conventions apply inside the quotes. The flags are single
25223 characters which may appear in any order. Spaces and tabs between them are
25224 ignored.
25225
25226 For each address that could potentially be rewritten, the rules are scanned in
25227 order, and replacements for the address from earlier rules can themselves be
25228 replaced by later rules (but see the &"q"& and &"R"& flags).
25229
25230 The order in which addresses are rewritten is undefined, may change between
25231 releases, and must not be relied on, with one exception: when a message is
25232 received, the envelope sender is always rewritten first, before any header
25233 lines are rewritten. For example, the replacement string for a rewrite of an
25234 address in &'To:'& must not assume that the message's address in &'From:'& has
25235 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25236 that the envelope sender has already been rewritten.
25237
25238 .vindex "&$domain$&"
25239 .vindex "&$local_part$&"
25240 The variables &$local_part$& and &$domain$& can be used in the replacement
25241 string to refer to the address that is being rewritten. Note that lookup-driven
25242 rewriting can be done by a rule of the form
25243 .code
25244 *@*   ${lookup ...
25245 .endd
25246 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25247 refer to the address that is being rewritten.
25248
25249
25250 .section "Rewriting patterns" "SECID151"
25251 .cindex "rewriting" "patterns"
25252 .cindex "address list" "in a rewriting pattern"
25253 The source pattern in a rewriting rule is any item which may appear in an
25254 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25255 single-item address list, which means that it is expanded before being tested
25256 against the address. As always, if you use a regular expression as a pattern,
25257 you must take care to escape dollar and backslash characters, or use the &`\N`&
25258 facility to suppress string expansion within the regular expression.
25259
25260 Domains in patterns should be given in lower case. Local parts in patterns are
25261 case-sensitive. If you want to do case-insensitive matching of local parts, you
25262 can use a regular expression that starts with &`^(?i)`&.
25263
25264 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25265 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25266 depending on the type of match which occurred. These can be used in the
25267 replacement string to insert portions of the incoming address. &$0$& always
25268 refers to the complete incoming address. When a regular expression is used, the
25269 numerical variables are set from its capturing subexpressions. For other types
25270 of pattern they are set as follows:
25271
25272 .ilist
25273 If a local part or domain starts with an asterisk, the numerical variables
25274 refer to the character strings matched by asterisks, with &$1$& associated with
25275 the first asterisk, and &$2$& with the second, if present. For example, if the
25276 pattern
25277 .code
25278 *queen@*.fict.example
25279 .endd
25280 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25281 .code
25282 $0 = hearts-queen@wonderland.fict.example
25283 $1 = hearts-
25284 $2 = wonderland
25285 .endd
25286 Note that if the local part does not start with an asterisk, but the domain
25287 does, it is &$1$& that contains the wild part of the domain.
25288
25289 .next
25290 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25291 of the domain are placed in the next available numerical variables. Suppose,
25292 for example, that the address &'foo@bar.baz.example'& is processed by a
25293 rewriting rule of the form
25294 .display
25295 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25296 .endd
25297 and the key in the file that matches the domain is &`*.baz.example`&. Then
25298 .code
25299 $1 = foo
25300 $2 = bar
25301 $3 = baz.example
25302 .endd
25303 If the address &'foo@baz.example'& is looked up, this matches the same
25304 wildcard file entry, and in this case &$2$& is set to the empty string, but
25305 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25306 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25307 whole domain. For non-partial domain lookups, no numerical variables are set.
25308 .endlist
25309
25310
25311 .section "Rewriting replacements" "SECID152"
25312 .cindex "rewriting" "replacements"
25313 If the replacement string for a rule is a single asterisk, addresses that
25314 match the pattern and the flags are &'not'& rewritten, and no subsequent
25315 rewriting rules are scanned. For example,
25316 .code
25317 hatta@lookingglass.fict.example  *  f
25318 .endd
25319 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25320 &'From:'& headers.
25321
25322 .vindex "&$domain$&"
25323 .vindex "&$local_part$&"
25324 If the replacement string is not a single asterisk, it is expanded, and must
25325 yield a fully qualified address. Within the expansion, the variables
25326 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25327 Any letters they contain retain their original case &-- they are not lower
25328 cased. The numerical variables are set up according to the type of pattern that
25329 matched the address, as described above. If the expansion is forced to fail by
25330 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25331 current rule is abandoned, but subsequent rules may take effect. Any other
25332 expansion failure causes the entire rewriting operation to be abandoned, and an
25333 entry written to the panic log.
25334
25335
25336
25337 .section "Rewriting flags" "SECID153"
25338 There are three different kinds of flag that may appear on rewriting rules:
25339
25340 .ilist
25341 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25342 c, f, h, r, s, t.
25343 .next
25344 A flag that specifies rewriting at SMTP time: S.
25345 .next
25346 Flags that control the rewriting process: Q, q, R, w.
25347 .endlist
25348
25349 For rules that are part of the &%headers_rewrite%& generic transport option,
25350 E, F, T, and S are not permitted.
25351
25352
25353
25354 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25355          "SECID154"
25356 .cindex "rewriting" "flags"
25357 If none of the following flag letters, nor the &"S"& flag (see section
25358 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25359 and to both the sender and recipient fields of the envelope, whereas a
25360 transport-time rewriting rule just applies to all headers. Otherwise, the
25361 rewriting rule is skipped unless the relevant addresses are being processed.
25362 .display
25363 &`E`&       rewrite all envelope fields
25364 &`F`&       rewrite the envelope From field
25365 &`T`&       rewrite the envelope To field
25366 &`b`&       rewrite the &'Bcc:'& header
25367 &`c`&       rewrite the &'Cc:'& header
25368 &`f`&       rewrite the &'From:'& header
25369 &`h`&       rewrite all headers
25370 &`r`&       rewrite the &'Reply-To:'& header
25371 &`s`&       rewrite the &'Sender:'& header
25372 &`t`&       rewrite the &'To:'& header
25373 .endd
25374 "All headers" means all of the headers listed above that can be selected
25375 individually, plus their &'Resent-'& versions. It does not include
25376 other headers such as &'Subject:'& etc.
25377
25378 You should be particularly careful about rewriting &'Sender:'& headers, and
25379 restrict this to special known cases in your own domains.
25380
25381
25382 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25383 .cindex "SMTP" "rewriting malformed addresses"
25384 .cindex "RCPT" "rewriting argument of"
25385 .cindex "MAIL" "rewriting argument of"
25386 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25387 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25388 before any other processing; even before syntax checking. The pattern is
25389 required to be a regular expression, and it is matched against the whole of the
25390 data for the command, including any surrounding angle brackets.
25391
25392 .vindex "&$domain$&"
25393 .vindex "&$local_part$&"
25394 This form of rewrite rule allows for the handling of addresses that are not
25395 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25396 input). Because the input is not required to be a syntactically valid address,
25397 the variables &$local_part$& and &$domain$& are not available during the
25398 expansion of the replacement string. The result of rewriting replaces the
25399 original address in the MAIL or RCPT command.
25400
25401
25402 .section "Flags controlling the rewriting process" "SECID155"
25403 There are four flags which control the way the rewriting process works. These
25404 take effect only when a rule is invoked, that is, when the address is of the
25405 correct type (matches the flags) and matches the pattern:
25406
25407 .ilist
25408 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25409 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25410 absence of &"Q"& the rewritten address must always include a domain.
25411 .next
25412 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25413 even if no rewriting actually takes place because of a &"fail"& in the
25414 expansion. The &"q"& flag is not effective if the address is of the wrong type
25415 (does not match the flags) or does not match the pattern.
25416 .next
25417 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25418 address, up to ten times. It can be combined with the &"q"& flag, to stop
25419 rewriting once it fails to match (after at least one successful rewrite).
25420 .next
25421 .cindex "rewriting" "whole addresses"
25422 When an address in a header is rewritten, the rewriting normally applies only
25423 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25424 left unchanged. For example, rewriting might change
25425 .code
25426 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25427 .endd
25428 into
25429 .code
25430 From: Ford Prefect <prefectf@hitch.fict.example>
25431 .endd
25432 .cindex "RFC 2047"
25433 Sometimes there is a need to replace the whole address item, and this can be
25434 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25435 causes an address in a header line to be rewritten, the entire address is
25436 replaced, not just the working part. The replacement must be a complete RFC
25437 2822 address, including the angle brackets if necessary. If text outside angle
25438 brackets contains a character whose value is greater than 126 or less than 32
25439 (except for tab), the text is encoded according to RFC 2047. The character set
25440 is taken from &%headers_charset%&, which gets its default at build time.
25441
25442 When the &"w"& flag is set on a rule that causes an envelope address to be
25443 rewritten, all but the working part of the replacement address is discarded.
25444 .endlist
25445
25446
25447 .section "Rewriting examples" "SECID156"
25448 Here is an example of the two common rewriting paradigms:
25449 .code
25450 *@*.hitch.fict.example  $1@hitch.fict.example
25451 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25452                      {$value}fail}@hitch.fict.example bctfrF
25453 .endd
25454 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25455 the string expansion to fail if the lookup does not succeed. In this context it
25456 has the effect of leaving the original address unchanged, but Exim goes on to
25457 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25458 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25459 explicitly, which would cause the rewritten address to be the same as before,
25460 at the cost of a small bit of processing. Not supplying either of these is an
25461 error, since the rewritten address would then contain no local part.
25462
25463 The first example above replaces the domain with a superior, more general
25464 domain. This may not be desirable for certain local parts. If the rule
25465 .code
25466 root@*.hitch.fict.example  *
25467 .endd
25468 were inserted before the first rule, rewriting would be suppressed for the
25469 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25470
25471 Rewriting can be made conditional on a number of tests, by making use of
25472 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25473 messages that originate outside the local host:
25474 .code
25475 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25476                          {$1@hitch.fict.example}fail}"
25477 .endd
25478 The replacement string is quoted in this example because it contains white
25479 space.
25480
25481 .cindex "rewriting" "bang paths"
25482 .cindex "bang paths" "rewriting"
25483 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25484 an address it treats it as an unqualified local part which it qualifies with
25485 the local qualification domain (if the source of the message is local or if the
25486 remote host is permitted to send unqualified addresses). Rewriting can
25487 sometimes be used to handle simple bang paths with a fixed number of
25488 components. For example, the rule
25489 .code
25490 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25491 .endd
25492 rewrites a two-component bang path &'host.name!user'& as the domain address
25493 &'user@host.name'&. However, there is a security implication in using this as
25494 a global rewriting rule for envelope addresses. It can provide a backdoor
25495 method for using your system as a relay, because the incoming addresses appear
25496 to be local. If the bang path addresses are received via SMTP, it is safer to
25497 use the &"S"& flag to rewrite them as they are received, so that relay checking
25498 can be done on the rewritten addresses.
25499 .ecindex IIDaddrew
25500
25501
25502
25503
25504
25505 . ////////////////////////////////////////////////////////////////////////////
25506 . ////////////////////////////////////////////////////////////////////////////
25507
25508 .chapter "Retry configuration" "CHAPretry"
25509 .scindex IIDretconf1 "retry" "configuration, description of"
25510 .scindex IIDregconf2 "configuration file" "retry section"
25511 The &"retry"& section of the runtime configuration file contains a list of
25512 retry rules that control how often Exim tries to deliver messages that cannot
25513 be delivered at the first attempt. If there are no retry rules (the section is
25514 empty or not present), there are no retries. In this situation, temporary
25515 errors are treated as permanent. The default configuration contains a single,
25516 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25517 line option can be used to test which retry rule will be used for a given
25518 address, domain and error.
25519
25520 The most common cause of retries is temporary failure to deliver to a remote
25521 host because the host is down, or inaccessible because of a network problem.
25522 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25523 address) basis, not on a per-message basis. Thus, if one message has recently
25524 been delayed, delivery of a new message to the same host is not immediately
25525 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25526 log selector is set, the message
25527 .cindex "retry" "time not reached"
25528 &"retry time not reached"& is written to the main log whenever a delivery is
25529 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25530 the handling of errors during remote deliveries.
25531
25532 Retry processing applies to routing as well as to delivering, except as covered
25533 in the next paragraph. The retry rules do not distinguish between these
25534 actions. It is not possible, for example, to specify different behaviour for
25535 failures to route the domain &'snark.fict.example'& and failures to deliver to
25536 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25537 added complication, so did not implement it. However, although they share the
25538 same retry rule, the actual retry times for routing and transporting a given
25539 domain are maintained independently.
25540
25541 When a delivery is not part of a queue run (typically an immediate delivery on
25542 receipt of a message), the routers are always run, and local deliveries are
25543 always attempted, even if retry times are set for them. This makes for better
25544 behaviour if one particular message is causing problems (for example, causing
25545 quota overflow, or provoking an error in a filter file). If such a delivery
25546 suffers a temporary failure, the retry data is updated as normal, and
25547 subsequent delivery attempts from queue runs occur only when the retry time for
25548 the local address is reached.
25549
25550 .section "Changing retry rules" "SECID157"
25551 If you change the retry rules in your configuration, you should consider
25552 whether or not to delete the retry data that is stored in Exim's spool area in
25553 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25554 always safe; that is why they are called &"hints"&.
25555
25556 The hints retry data contains suggested retry times based on the previous
25557 rules. In the case of a long-running problem with a remote host, it might
25558 record the fact that the host has timed out. If your new rules increase the
25559 timeout time for such a host, you should definitely remove the old retry data
25560 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25561 messages that it should now be retaining.
25562
25563
25564
25565 .section "Format of retry rules" "SECID158"
25566 .cindex "retry" "rules"
25567 Each retry rule occupies one line and consists of three or four parts,
25568 separated by white space: a pattern, an error name, an optional list of sender
25569 addresses, and a list of retry parameters. The pattern and sender lists must be
25570 enclosed in double quotes if they contain white space. The rules are searched
25571 in order until one is found where the pattern, error name, and sender list (if
25572 present) match the failing host or address, the error that occurred, and the
25573 message's sender, respectively.
25574
25575
25576 The pattern is any single item that may appear in an address list (see section
25577 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25578 which means that it is expanded before being tested against the address that
25579 has been delayed. A negated address list item is permitted. Address
25580 list processing treats a plain domain name as if it were preceded by &"*@"&,
25581 which makes it possible for many retry rules to start with just a domain. For
25582 example,
25583 .code
25584 lookingglass.fict.example        *  F,24h,30m;
25585 .endd
25586 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25587 whereas
25588 .code
25589 alice@lookingglass.fict.example  *  F,24h,30m;
25590 .endd
25591 applies only to temporary failures involving the local part &%alice%&.
25592 In practice, almost all rules start with a domain name pattern without a local
25593 part.
25594
25595 .cindex "regular expressions" "in retry rules"
25596 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25597 must match a complete address, not just a domain, because that is how regular
25598 expressions work in address lists.
25599 .display
25600 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25601 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25602 .endd
25603
25604
25605 .section "Choosing which retry rule to use for address errors" "SECID159"
25606 When Exim is looking for a retry rule after a routing attempt has failed (for
25607 example, after a DNS timeout), each line in the retry configuration is tested
25608 against the complete address only if &%retry_use_local_part%& is set for the
25609 router. Otherwise, only the domain is used, except when matching against a
25610 regular expression, when the local part of the address is replaced with &"*"&.
25611 A domain on its own can match a domain pattern, or a pattern that starts with
25612 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25613 &%check_local_user%& is true, and false for other routers.
25614
25615 Similarly, when Exim is looking for a retry rule after a local delivery has
25616 failed (for example, after a mailbox full error), each line in the retry
25617 configuration is tested against the complete address only if
25618 &%retry_use_local_part%& is set for the transport (it defaults true for all
25619 local transports).
25620
25621 .cindex "4&'xx'& responses" "retry rules for"
25622 However, when Exim is looking for a retry rule after a remote delivery attempt
25623 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25624 whole address is always used as the key when searching the retry rules. The
25625 rule that is found is used to create a retry time for the combination of the
25626 failing address and the message's sender. It is the combination of sender and
25627 recipient that is delayed in subsequent queue runs until its retry time is
25628 reached. You can delay the recipient without regard to the sender by setting
25629 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25630 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25631 commands.
25632
25633
25634
25635 .section "Choosing which retry rule to use for host and message errors" &&&
25636          "SECID160"
25637 For a temporary error that is not related to an individual address (for
25638 example, a connection timeout), each line in the retry configuration is checked
25639 twice. First, the name of the remote host is used as a domain name (preceded by
25640 &"*@"& when matching a regular expression). If this does not match the line,
25641 the domain from the email address is tried in a similar fashion. For example,
25642 suppose the MX records for &'a.b.c.example'& are
25643 .code
25644 a.b.c.example  MX  5  x.y.z.example
25645                MX  6  p.q.r.example
25646                MX  7  m.n.o.example
25647 .endd
25648 and the retry rules are
25649 .code
25650 p.q.r.example    *      F,24h,30m;
25651 a.b.c.example    *      F,4d,45m;
25652 .endd
25653 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25654 first rule matches neither the host nor the domain, so Exim looks at the second
25655 rule. This does not match the host, but it does match the domain, so it is used
25656 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25657 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25658 first retry rule is used, because it matches the host.
25659
25660 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25661 first rule to determine retry times, but for all the other hosts for the domain
25662 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25663 routing to &'a.b.c.example'& suffers a temporary failure.
25664
25665 &*Note*&: The host name is used when matching the patterns, not its IP address.
25666 However, if a message is routed directly to an IP address without the use of a
25667 host name, for example, if a &(manualroute)& router contains a setting such as:
25668 .code
25669 route_list = *.a.example  192.168.34.23
25670 .endd
25671 then the &"host name"& that is used when searching for a retry rule is the
25672 textual form of the IP address.
25673
25674 .section "Retry rules for specific errors" "SECID161"
25675 .cindex "retry" "specific errors; specifying"
25676 The second field in a retry rule is the name of a particular error, or an
25677 asterisk, which matches any error. The errors that can be tested for are:
25678
25679 .vlist
25680 .vitem &%auth_failed%&
25681 Authentication failed when trying to send to a host in the
25682 &%hosts_require_auth%& list in an &(smtp)& transport.
25683
25684 .vitem &%data_4xx%&
25685 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25686 after the command, or after sending the message's data.
25687
25688 .vitem &%mail_4xx%&
25689 A 4&'xx'& error was received for an outgoing MAIL command.
25690
25691 .vitem &%rcpt_4xx%&
25692 A 4&'xx'& error was received for an outgoing RCPT command.
25693 .endlist
25694
25695 For the three 4&'xx'& errors, either the first or both of the x's can be given
25696 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25697 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25698 and have retries every ten minutes with a one-hour timeout, you could set up a
25699 retry rule of this form:
25700 .code
25701 the.domain.name  rcpt_452   F,1h,10m
25702 .endd
25703 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25704 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25705
25706 .vlist
25707 .vitem &%lost_connection%&
25708 A server unexpectedly closed the SMTP connection. There may, of course,
25709 legitimate reasons for this (host died, network died), but if it repeats a lot
25710 for the same host, it indicates something odd.
25711
25712 .vitem &%lookup%&
25713 A DNS lookup for a host failed.
25714 Note that a &%dnslookup%& router will need to have matched
25715 its &%fail_defer_domains%& option for this retry type to be usable.
25716 Also note that a &%manualroute%& router will probably need
25717 its &%host_find_failed%& option set to &%defer%&.
25718
25719 .vitem &%refused_MX%&
25720 A connection to a host obtained from an MX record was refused.
25721
25722 .vitem &%refused_A%&
25723 A connection to a host not obtained from an MX record was refused.
25724
25725 .vitem &%refused%&
25726 A connection was refused.
25727
25728 .vitem &%timeout_connect_MX%&
25729 A connection attempt to a host obtained from an MX record timed out.
25730
25731 .vitem &%timeout_connect_A%&
25732 A connection attempt to a host not obtained from an MX record timed out.
25733
25734 .vitem &%timeout_connect%&
25735 A connection attempt timed out.
25736
25737 .vitem &%timeout_MX%&
25738 There was a timeout while connecting or during an SMTP session with a host
25739 obtained from an MX record.
25740
25741 .vitem &%timeout_A%&
25742 There was a timeout while connecting or during an SMTP session with a host not
25743 obtained from an MX record.
25744
25745 .vitem &%timeout%&
25746 There was a timeout while connecting or during an SMTP session.
25747
25748 .vitem &%tls_required%&
25749 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25750 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25751 to STARTTLS, or there was a problem setting up the TLS connection.
25752
25753 .vitem &%quota%&
25754 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25755 transport.
25756
25757 .vitem &%quota_%&<&'time'&>
25758 .cindex "quota" "error testing in retry rule"
25759 .cindex "retry" "quota error testing"
25760 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25761 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25762 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25763 for four days.
25764 .endlist
25765
25766 .cindex "mailbox" "time of last read"
25767 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25768 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25769 it should be based on the last time that the user accessed the mailbox.
25770 However, it is not always possible to determine this. Exim uses the following
25771 heuristic rules:
25772
25773 .ilist
25774 If the mailbox is a single file, the time of last access (the &"atime"&) is
25775 used. As no new messages are being delivered (because the mailbox is over
25776 quota), Exim does not access the file, so this is the time of last user access.
25777 .next
25778 .cindex "maildir format" "time of last read"
25779 For a maildir delivery, the time of last modification of the &_new_&
25780 subdirectory is used. As the mailbox is over quota, no new files are created in
25781 the &_new_& subdirectory, because no new messages are being delivered. Any
25782 change to the &_new_& subdirectory is therefore assumed to be the result of an
25783 MUA moving a new message to the &_cur_& directory when it is first read. The
25784 time that is used is therefore the last time that the user read a new message.
25785 .next
25786 For other kinds of multi-file mailbox, the time of last access cannot be
25787 obtained, so a retry rule that uses this type of error field is never matched.
25788 .endlist
25789
25790 The quota errors apply both to system-enforced quotas and to Exim's own quota
25791 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25792 when a local delivery is deferred because a partition is full (the ENOSPC
25793 error).
25794
25795
25796
25797 .section "Retry rules for specified senders" "SECID162"
25798 .cindex "retry" "rules; sender-specific"
25799 You can specify retry rules that apply only when the failing message has a
25800 specific sender. In particular, this can be used to define retry rules that
25801 apply only to bounce messages. The third item in a retry rule can be of this
25802 form:
25803 .display
25804 &`senders=`&<&'address list'&>
25805 .endd
25806 The retry timings themselves are then the fourth item. For example:
25807 .code
25808 *   rcpt_4xx   senders=:   F,1h,30m
25809 .endd
25810 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25811 host. If the address list contains white space, it must be enclosed in quotes.
25812 For example:
25813 .code
25814 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25815 .endd
25816 &*Warning*&: This facility can be unhelpful if it is used for host errors
25817 (which do not depend on the recipient). The reason is that the sender is used
25818 only to match the retry rule. Once the rule has been found for a host error,
25819 its contents are used to set a retry time for the host, and this will apply to
25820 all messages, not just those with specific senders.
25821
25822 When testing retry rules using &%-brt%&, you can supply a sender using the
25823 &%-f%& command line option, like this:
25824 .code
25825 exim -f "" -brt user@dom.ain
25826 .endd
25827 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25828 list is never matched.
25829
25830
25831
25832
25833
25834 .section "Retry parameters" "SECID163"
25835 .cindex "retry" "parameters in rules"
25836 The third (or fourth, if a senders list is present) field in a retry rule is a
25837 sequence of retry parameter sets, separated by semicolons. Each set consists of
25838 .display
25839 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25840 .endd
25841 The letter identifies the algorithm for computing a new retry time; the cutoff
25842 time is the time beyond which this algorithm no longer applies, and the
25843 arguments vary the algorithm's action. The cutoff time is measured from the
25844 time that the first failure for the domain (combined with the local part if
25845 relevant) was detected, not from the time the message was received.
25846
25847 .cindex "retry" "algorithms"
25848 .cindex "retry" "fixed intervals"
25849 .cindex "retry" "increasing intervals"
25850 .cindex "retry" "random intervals"
25851 The available algorithms are:
25852
25853 .ilist
25854 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25855 the interval.
25856 .next
25857 &'G'&: retry at geometrically increasing intervals. The first argument
25858 specifies a starting value for the interval, and the second a multiplier, which
25859 is used to increase the size of the interval at each retry.
25860 .next
25861 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25862 retry, the previous interval is multiplied by the factor in order to get a
25863 maximum for the next interval. The minimum interval is the first argument of
25864 the parameter, and an actual interval is chosen randomly between them. Such a
25865 rule has been found to be helpful in cluster configurations when all the
25866 members of the cluster restart at once, and may therefore synchronize their
25867 queue processing times.
25868 .endlist
25869
25870 When computing the next retry time, the algorithm definitions are scanned in
25871 order until one whose cutoff time has not yet passed is reached. This is then
25872 used to compute a new retry time that is later than the current time. In the
25873 case of fixed interval retries, this simply means adding the interval to the
25874 current time. For geometrically increasing intervals, retry intervals are
25875 computed from the rule's parameters until one that is greater than the previous
25876 interval is found. The main configuration variable
25877 .cindex "limit" "retry interval"
25878 .cindex "retry" "interval, maximum"
25879 .oindex "&%retry_interval_max%&"
25880 &%retry_interval_max%& limits the maximum interval between retries. It
25881 cannot be set greater than &`24h`&, which is its default value.
25882
25883 A single remote domain may have a number of hosts associated with it, and each
25884 host may have more than one IP address. Retry algorithms are selected on the
25885 basis of the domain name, but are applied to each IP address independently. If,
25886 for example, a host has two IP addresses and one is unusable, Exim will
25887 generate retry times for it and will not try to use it until its next retry
25888 time comes. Thus the good IP address is likely to be tried first most of the
25889 time.
25890
25891 .cindex "hints database" "use for retrying"
25892 Retry times are hints rather than promises. Exim does not make any attempt to
25893 run deliveries exactly at the computed times. Instead, a queue runner process
25894 starts delivery processes for delayed messages periodically, and these attempt
25895 new deliveries only for those addresses that have passed their next retry time.
25896 If a new message arrives for a deferred address, an immediate delivery attempt
25897 occurs only if the address has passed its retry time. In the absence of new
25898 messages, the minimum time between retries is the interval between queue runner
25899 processes. There is not much point in setting retry times of five minutes if
25900 your queue runners happen only once an hour, unless there are a significant
25901 number of incoming messages (which might be the case on a system that is
25902 sending everything to a smart host, for example).
25903
25904 The data in the retry hints database can be inspected by using the
25905 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25906 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25907 &'exinext'& utility script can be used to find out what the next retry times
25908 are for the hosts associated with a particular mail domain, and also for local
25909 deliveries that have been deferred.
25910
25911
25912 .section "Retry rule examples" "SECID164"
25913 Here are some example retry rules:
25914 .code
25915 alice@wonderland.fict.example quota_5d  F,7d,3h
25916 wonderland.fict.example       quota_5d
25917 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25918 lookingglass.fict.example     *         F,24h,30m;
25919 *                 refused_A   F,2h,20m;
25920 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25921 .endd
25922 The first rule sets up special handling for mail to
25923 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25924 mailbox has not been read for at least 5 days. Retries continue every three
25925 hours for 7 days. The second rule handles over-quota errors for all other local
25926 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25927 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25928 fail are bounced immediately if the mailbox has not been read for at least 5
25929 days.
25930
25931 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25932 happen every 15 minutes for an hour, then with geometrically increasing
25933 intervals until two days have passed since a delivery first failed. After the
25934 first hour there is a delay of one hour, then two hours, then four hours, and
25935 so on (this is a rather extreme example).
25936
25937 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25938 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25939 all other domains, with special action for connection refusal from hosts that
25940 were not obtained from an MX record.
25941
25942 The final rule in a retry configuration should always have asterisks in the
25943 first two fields so as to provide a general catch-all for any addresses that do
25944 not have their own special handling. This example tries every 15 minutes for 2
25945 hours, then with intervals starting at one hour and increasing by a factor of
25946 1.5 up to 16 hours, then every 8 hours up to 5 days.
25947
25948
25949
25950 .section "Timeout of retry data" "SECID165"
25951 .cindex "timeout" "of retry data"
25952 .oindex "&%retry_data_expire%&"
25953 .cindex "hints database" "data expiry"
25954 .cindex "retry" "timeout of data"
25955 Exim timestamps the data that it writes to its retry hints database. When it
25956 consults the data during a delivery it ignores any that is older than the value
25957 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25958 been tried for 7 days, Exim will try to deliver to it immediately a message
25959 arrives, and if that fails, it will calculate a retry time as if it were
25960 failing for the first time.
25961
25962 This improves the behaviour for messages routed to rarely-used hosts such as MX
25963 backups. If such a host was down at one time, and happens to be down again when
25964 Exim tries a month later, using the old retry data would imply that it had been
25965 down all the time, which is not a justified assumption.
25966
25967 If a host really is permanently dead, this behaviour causes a burst of retries
25968 every now and again, but only if messages routed to it are rare. If there is a
25969 message at least once every 7 days the retry data never expires.
25970
25971
25972
25973
25974 .section "Long-term failures" "SECID166"
25975 .cindex "delivery failure, long-term"
25976 .cindex "retry" "after long-term failure"
25977 Special processing happens when an email address has been failing for so long
25978 that the cutoff time for the last algorithm is reached. For example, using the
25979 default retry rule:
25980 .code
25981 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25982 .endd
25983 the cutoff time is four days. Reaching the retry cutoff is independent of how
25984 long any specific message has been failing; it is the length of continuous
25985 failure for the recipient address that counts.
25986
25987 When the cutoff time is reached for a local delivery, or for all the IP
25988 addresses associated with a remote delivery, a subsequent delivery failure
25989 causes Exim to give up on the address, and a bounce message is generated.
25990 In order to cater for new messages that use the failing address, a next retry
25991 time is still computed from the final algorithm, and is used as follows:
25992
25993 For local deliveries, one delivery attempt is always made for any subsequent
25994 messages. If this delivery fails, the address fails immediately. The
25995 post-cutoff retry time is not used.
25996
25997 .cindex "final cutoff" "retries, controlling"
25998 .cindex retry "final cutoff"
25999 If the delivery is remote, there are two possibilities, controlled by the
26000 .oindex "&%delay_after_cutoff%&"
26001 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26002 default. Until the post-cutoff retry time for one of the IP addresses,
26003 as set by the &%retry_data_expire%& option, is
26004 reached, the failing email address is bounced immediately, without a delivery
26005 attempt taking place. After that time, one new delivery attempt is made to
26006 those IP addresses that are past their retry times, and if that still fails,
26007 the address is bounced and new retry times are computed.
26008
26009 In other words, when all the hosts for a given email address have been failing
26010 for a long time, Exim bounces rather then defers until one of the hosts' retry
26011 times is reached. Then it tries once, and bounces if that attempt fails. This
26012 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26013 to a broken destination, but if the host does recover, Exim will eventually
26014 notice.
26015
26016 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26017 addresses are past their final cutoff time, Exim tries to deliver to those IP
26018 addresses that have not been tried since the message arrived. If there are
26019 no suitable IP addresses, or if they all fail, the address is bounced. In other
26020 words, it does not delay when a new message arrives, but tries the expired
26021 addresses immediately, unless they have been tried since the message arrived.
26022 If there is a continuous stream of messages for the failing domains, setting
26023 &%delay_after_cutoff%& false means that there will be many more attempts to
26024 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26025 true.
26026
26027 .section "Deliveries that work intermittently" "SECID167"
26028 .cindex "retry" "intermittently working deliveries"
26029 Some additional logic is needed to cope with cases where a host is
26030 intermittently available, or when a message has some attribute that prevents
26031 its delivery when others to the same address get through. In this situation,
26032 because some messages are successfully delivered, the &"retry clock"& for the
26033 host or address keeps getting reset by the successful deliveries, and so
26034 failing messages remain on the queue for ever because the cutoff time is never
26035 reached.
26036
26037 Two exceptional actions are applied to prevent this happening. The first
26038 applies to errors that are related to a message rather than a remote host.
26039 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26040 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26041 commands, and quota failures. For this type of error, if a message's arrival
26042 time is earlier than the &"first failed"& time for the error, the earlier time
26043 is used when scanning the retry rules to decide when to try next and when to
26044 time out the address.
26045
26046 The exceptional second action applies in all cases. If a message has been on
26047 the queue for longer than the cutoff time of any applicable retry rule for a
26048 given address, a delivery is attempted for that address, even if it is not yet
26049 time, and if this delivery fails, the address is timed out. A new retry time is
26050 not computed in this case, so that other messages for the same address are
26051 considered immediately.
26052 .ecindex IIDretconf1
26053 .ecindex IIDregconf2
26054
26055
26056
26057
26058
26059
26060 . ////////////////////////////////////////////////////////////////////////////
26061 . ////////////////////////////////////////////////////////////////////////////
26062
26063 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26064 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26065 .scindex IIDauthconf2 "authentication"
26066 The &"authenticators"& section of Exim's run time configuration is concerned
26067 with SMTP authentication. This facility is an extension to the SMTP protocol,
26068 described in RFC 2554, which allows a client SMTP host to authenticate itself
26069 to a server. This is a common way for a server to recognize clients that are
26070 permitted to use it as a relay. SMTP authentication is not of relevance to the
26071 transfer of mail between servers that have no managerial connection with each
26072 other.
26073
26074 .cindex "AUTH" "description of"
26075 Very briefly, the way SMTP authentication works is as follows:
26076
26077 .ilist
26078 The server advertises a number of authentication &'mechanisms'& in response to
26079 the client's EHLO command.
26080 .next
26081 The client issues an AUTH command, naming a specific mechanism. The command
26082 may, optionally, contain some authentication data.
26083 .next
26084 The server may issue one or more &'challenges'&, to which the client must send
26085 appropriate responses. In simple authentication mechanisms, the challenges are
26086 just prompts for user names and passwords. The server does not have to issue
26087 any challenges &-- in some mechanisms the relevant data may all be transmitted
26088 with the AUTH command.
26089 .next
26090 The server either accepts or denies authentication.
26091 .next
26092 If authentication succeeds, the client may optionally make use of the AUTH
26093 option on the MAIL command to pass an authenticated sender in subsequent
26094 mail transactions. Authentication lasts for the remainder of the SMTP
26095 connection.
26096 .next
26097 If authentication fails, the client may give up, or it may try a different
26098 authentication mechanism, or it may try transferring mail over the
26099 unauthenticated connection.
26100 .endlist
26101
26102 If you are setting up a client, and want to know which authentication
26103 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26104 SMTP port) on the server, and issue an EHLO command. The response to this
26105 includes the list of supported mechanisms. For example:
26106 .display
26107 &`$ `&&*&`telnet server.example 25`&*&
26108 &`Trying 192.168.34.25...`&
26109 &`Connected to server.example.`&
26110 &`Escape character is &#x0027;^]&#x0027;.`&
26111 &`220 server.example ESMTP Exim 4.20 ...`&
26112 &*&`ehlo client.example`&*&
26113 &`250-server.example Hello client.example [10.8.4.5]`&
26114 &`250-SIZE 52428800`&
26115 &`250-PIPELINING`&
26116 &`250-AUTH PLAIN`&
26117 &`250 HELP`&
26118 .endd
26119 The second-last line of this example output shows that the server supports
26120 authentication using the PLAIN mechanism. In Exim, the different authentication
26121 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26122 routers and transports, which authenticators are included in the binary is
26123 controlled by build-time definitions. The following are currently available,
26124 included by setting
26125 .code
26126 AUTH_CRAM_MD5=yes
26127 AUTH_CYRUS_SASL=yes
26128 AUTH_DOVECOT=yes
26129 AUTH_GSASL=yes
26130 AUTH_HEIMDAL_GSSAPI=yes
26131 AUTH_PLAINTEXT=yes
26132 AUTH_SPA=yes
26133 AUTH_TLS=yes
26134 .endd
26135 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26136 authentication mechanism (RFC 2195), and the second provides an interface to
26137 the Cyrus SASL authentication library.
26138 The third is an interface to Dovecot's authentication system, delegating the
26139 work via a socket interface.
26140 The fourth provides an interface to the GNU SASL authentication library, which
26141 provides mechanisms but typically not data sources.
26142 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26143 supporting setting a server keytab.
26144 The sixth can be configured to support
26145 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26146 not formally documented, but used by several MUAs. The seventh authenticator
26147 supports Microsoft's &'Secure Password Authentication'& mechanism.
26148 The eighth is an Exim authenticator but not an SMTP one;
26149 instead it can use information from a TLS negotiation.
26150
26151 The authenticators are configured using the same syntax as other drivers (see
26152 section &<<SECTfordricon>>&). If no authenticators are required, no
26153 authentication section need be present in the configuration file. Each
26154 authenticator can in principle have both server and client functions. When Exim
26155 is receiving SMTP mail, it is acting as a server; when it is sending out
26156 messages over SMTP, it is acting as a client. Authenticator configuration
26157 options are provided for use in both these circumstances.
26158
26159 To make it clear which options apply to which situation, the prefixes
26160 &%server_%& and &%client_%& are used on option names that are specific to
26161 either the server or the client function, respectively. Server and client
26162 functions are disabled if none of their options are set. If an authenticator is
26163 to be used for both server and client functions, a single definition, using
26164 both sets of options, is required. For example:
26165 .code
26166 cram:
26167   driver = cram_md5
26168   public_name = CRAM-MD5
26169   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26170   client_name = ph10
26171   client_secret = secret2
26172 .endd
26173 The &%server_%& option is used when Exim is acting as a server, and the
26174 &%client_%& options when it is acting as a client.
26175
26176 Descriptions of the individual authenticators are given in subsequent chapters.
26177 The remainder of this chapter covers the generic options for the
26178 authenticators, followed by general discussion of the way authentication works
26179 in Exim.
26180
26181 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26182 per-mechanism basis.  Please read carefully to determine which variables hold
26183 account labels such as usercodes and which hold passwords or other
26184 authenticating data.
26185
26186 Note that some mechanisms support two different identifiers for accounts: the
26187 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26188 and &'authz'& are commonly encountered.  The American spelling is standard here.
26189 Conceptually, authentication data such as passwords are tied to the identifier
26190 used to authenticate; servers may have rules to permit one user to act as a
26191 second user, so that after login the session is treated as though that second
26192 user had logged in.  That second user is the &'authorization id'&.  A robust
26193 configuration might confirm that the &'authz'& field is empty or matches the
26194 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26195 as verified data, the &'authz'& as an unverified request which the server might
26196 choose to honour.
26197
26198 A &'realm'& is a text string, typically a domain name, presented by a server
26199 to a client to help it select an account and credentials to use.  In some
26200 mechanisms, the client and server provably agree on the realm, but clients
26201 typically can not treat the realm as secure data to be blindly trusted.
26202
26203
26204
26205 .section "Generic options for authenticators" "SECID168"
26206 .cindex "authentication" "generic options"
26207 .cindex "options" "generic; for authenticators"
26208
26209 .option client_condition authenticators string&!! unset
26210 When Exim is authenticating as a client, it skips any authenticator whose
26211 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26212 used, for example, to skip plain text authenticators when the connection is not
26213 encrypted by a setting such as:
26214 .code
26215 client_condition = ${if !eq{$tls_out_cipher}{}}
26216 .endd
26217
26218
26219 .option client_set_id authenticators string&!! unset
26220 When client authentication succeeds, this condition is expanded; the
26221 result is used in the log lines for outbound messages.
26222 Typically it will be the user name used for authentication.
26223
26224
26225 .option driver authenticators string unset
26226 This option must always be set. It specifies which of the available
26227 authenticators is to be used.
26228
26229
26230 .option public_name authenticators string unset
26231 This option specifies the name of the authentication mechanism that the driver
26232 implements, and by which it is known to the outside world. These names should
26233 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26234 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26235 defaults to the driver's instance name.
26236
26237
26238 .option server_advertise_condition authenticators string&!! unset
26239 When a server is about to advertise an authentication mechanism, the condition
26240 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26241 mechanism is not advertised.
26242 If the expansion fails, the mechanism is not advertised. If the failure was not
26243 forced, and was not caused by a lookup defer, the incident is logged.
26244 See section &<<SECTauthexiser>>& below for further discussion.
26245
26246
26247 .option server_condition authenticators string&!! unset
26248 This option must be set for a &%plaintext%& server authenticator, where it
26249 is used directly to control authentication. See section &<<SECTplainserver>>&
26250 for details.
26251
26252 For the &(gsasl)& authenticator, this option is required for various
26253 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26254
26255 For the other authenticators, &%server_condition%& can be used as an additional
26256 authentication or authorization mechanism that is applied after the other
26257 authenticator conditions succeed. If it is set, it is expanded when the
26258 authenticator would otherwise return a success code. If the expansion is forced
26259 to fail, authentication fails. Any other expansion failure causes a temporary
26260 error code to be returned. If the result of a successful expansion is an empty
26261 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26262 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26263 other result, a temporary error code is returned, with the expanded string as
26264 the error text.
26265
26266
26267 .option server_debug_print authenticators string&!! unset
26268 If this option is set and authentication debugging is enabled (see the &%-d%&
26269 command line option), the string is expanded and included in the debugging
26270 output when the authenticator is run as a server. This can help with checking
26271 out the values of variables.
26272 If expansion of the string fails, the error message is written to the debugging
26273 output, and Exim carries on processing.
26274
26275
26276 .option server_set_id authenticators string&!! unset
26277 .vindex "&$authenticated_id$&"
26278 .vindex "&$authenticated_fail_id$&"
26279 When an Exim server successfully authenticates a client, this string is
26280 expanded using data from the authentication, and preserved for any incoming
26281 messages in the variable &$authenticated_id$&. It is also included in the log
26282 lines for incoming messages. For example, a user/password authenticator
26283 configuration might preserve the user name that was used to authenticate, and
26284 refer to it subsequently during delivery of the message.
26285 On a failing authentication the expansion result is instead saved in
26286 the &$authenticated_fail_id$& variable.
26287 If expansion fails, the option is ignored.
26288
26289
26290 .option server_mail_auth_condition authenticators string&!! unset
26291 This option allows a server to discard authenticated sender addresses supplied
26292 as part of MAIL commands in SMTP connections that are authenticated by the
26293 driver on which &%server_mail_auth_condition%& is set. The option is not used
26294 as part of the authentication process; instead its (unexpanded) value is
26295 remembered for later use.
26296 How it is used is described in the following section.
26297
26298
26299
26300
26301
26302 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26303 .cindex "authentication" "sender; authenticated"
26304 .cindex "AUTH" "on MAIL command"
26305 When a client supplied an AUTH= item on a MAIL command, Exim applies
26306 the following checks before accepting it as the authenticated sender of the
26307 message:
26308
26309 .ilist
26310 If the connection is not using extended SMTP (that is, HELO was used rather
26311 than EHLO), the use of AUTH= is a syntax error.
26312 .next
26313 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26314 .next
26315 .vindex "&$authenticated_sender$&"
26316 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26317 running, the value of &$authenticated_sender$& is set to the value obtained
26318 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26319 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26320 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26321 given for the MAIL command.
26322 .next
26323 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26324 is accepted and placed in &$authenticated_sender$& only if the client has
26325 authenticated.
26326 .next
26327 If the AUTH= value was accepted by either of the two previous rules, and
26328 the client has authenticated, and the authenticator has a setting for the
26329 &%server_mail_auth_condition%&, the condition is checked at this point. The
26330 valued that was saved from the authenticator is expanded. If the expansion
26331 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26332 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26333 the value of &$authenticated_sender$& is retained and passed on with the
26334 message.
26335 .endlist
26336
26337
26338 When &$authenticated_sender$& is set for a message, it is passed on to other
26339 hosts to which Exim authenticates as a client. Do not confuse this value with
26340 &$authenticated_id$&, which is a string obtained from the authentication
26341 process, and which is not usually a complete email address.
26342
26343 .vindex "&$sender_address$&"
26344 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26345 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26346 therefore make use of &$authenticated_sender$&. The converse is not true: the
26347 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26348 ACL is run.
26349
26350
26351
26352 .section "Authentication on an Exim server" "SECTauthexiser"
26353 .cindex "authentication" "on an Exim server"
26354 When Exim receives an EHLO command, it advertises the public names of those
26355 authenticators that are configured as servers, subject to the following
26356 conditions:
26357
26358 .ilist
26359 The client host must match &%auth_advertise_hosts%& (default *).
26360 .next
26361 It the &%server_advertise_condition%& option is set, its expansion must not
26362 yield the empty string, &"0"&, &"no"&, or &"false"&.
26363 .endlist
26364
26365 The order in which the authenticators are defined controls the order in which
26366 the mechanisms are advertised.
26367
26368 Some mail clients (for example, some versions of Netscape) require the user to
26369 provide a name and password for authentication whenever AUTH is advertised,
26370 even though authentication may not in fact be needed (for example, Exim may be
26371 set up to allow unconditional relaying from the client by an IP address check).
26372 You can make such clients more friendly by not advertising AUTH to them.
26373 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26374 that runs for RCPT) to relay without authentication, you should set
26375 .code
26376 auth_advertise_hosts = ! 10.9.8.0/24
26377 .endd
26378 so that no authentication mechanisms are advertised to them.
26379
26380 The &%server_advertise_condition%& controls the advertisement of individual
26381 authentication mechanisms. For example, it can be used to restrict the
26382 advertisement of a particular mechanism to encrypted connections, by a setting
26383 such as:
26384 .code
26385 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26386 .endd
26387 .vindex "&$tls_in_cipher$&"
26388 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26389 yields &"yes"&, which allows the advertisement to happen.
26390
26391 When an Exim server receives an AUTH command from a client, it rejects it
26392 immediately if AUTH was not advertised in response to an earlier EHLO
26393 command. This is the case if
26394
26395 .ilist
26396 The client host does not match &%auth_advertise_hosts%&; or
26397 .next
26398 No authenticators are configured with server options; or
26399 .next
26400 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26401 server authenticators.
26402 .endlist
26403
26404
26405 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26406 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26407 AUTH is accepted from any client host.
26408
26409 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26410 server authentication mechanism that was advertised in response to EHLO and
26411 that matches the one named in the AUTH command. If it finds one, it runs
26412 the appropriate authentication protocol, and authentication either succeeds or
26413 fails. If there is no matching advertised mechanism, the AUTH command is
26414 rejected with a 504 error.
26415
26416 .vindex "&$received_protocol$&"
26417 .vindex "&$sender_host_authenticated$&"
26418 When a message is received from an authenticated host, the value of
26419 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26420 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26421 public name) of the authenticator driver that successfully authenticated the
26422 client from which the message was received. This variable is empty if there was
26423 no successful authentication.
26424
26425 .cindex authentication "expansion item"
26426 Successful authentication sets up information used by the
26427 &$authresults$& expansion item.
26428
26429
26430
26431
26432 .section "Testing server authentication" "SECID169"
26433 .cindex "authentication" "testing a server"
26434 .cindex "AUTH" "testing a server"
26435 .cindex "base64 encoding" "creating authentication test data"
26436 Exim's &%-bh%& option can be useful for testing server authentication
26437 configurations. The data for the AUTH command has to be sent using base64
26438 encoding. A quick way to produce such data for testing is the following Perl
26439 script:
26440 .code
26441 use MIME::Base64;
26442 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26443 .endd
26444 .cindex "binary zero" "in authentication data"
26445 This interprets its argument as a Perl string, and then encodes it. The
26446 interpretation as a Perl string allows binary zeros, which are required for
26447 some kinds of authentication, to be included in the data. For example, a
26448 command line to run this script on such data might be
26449 .code
26450 encode '\0user\0password'
26451 .endd
26452 Note the use of single quotes to prevent the shell interpreting the
26453 backslashes, so that they can be interpreted by Perl to specify characters
26454 whose code value is zero.
26455
26456 &*Warning 1*&: If either of the user or password strings starts with an octal
26457 digit, you must use three zeros instead of one after the leading backslash. If
26458 you do not, the octal digit that starts your string will be incorrectly
26459 interpreted as part of the code for the first character.
26460
26461 &*Warning 2*&: If there are characters in the strings that Perl interprets
26462 specially, you must use a Perl escape to prevent them being misinterpreted. For
26463 example, a command such as
26464 .code
26465 encode '\0user@domain.com\0pas$$word'
26466 .endd
26467 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26468
26469 If you have the &%mimencode%& command installed, another way to do produce
26470 base64-encoded strings is to run the command
26471 .code
26472 echo -e -n `\0user\0password' | mimencode
26473 .endd
26474 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26475 in the argument, and the &%-n%& option specifies no newline at the end of its
26476 output. However, not all versions of &%echo%& recognize these options, so you
26477 should check your version before relying on this suggestion.
26478
26479
26480
26481 .section "Authentication by an Exim client" "SECID170"
26482 .cindex "authentication" "on an Exim client"
26483 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26484 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26485 announces support for authentication, and the host matches an entry in either
26486 of these options, Exim (as a client) tries to authenticate as follows:
26487
26488 .ilist
26489 For each authenticator that is configured as a client, in the order in which
26490 they are defined in the configuration, it searches the authentication
26491 mechanisms announced by the server for one whose name matches the public name
26492 of the authenticator.
26493 .next
26494 .vindex "&$host$&"
26495 .vindex "&$host_address$&"
26496 When it finds one that matches, it runs the authenticator's client code. The
26497 variables &$host$& and &$host_address$& are available for any string expansions
26498 that the client might do. They are set to the server's name and IP address. If
26499 any expansion is forced to fail, the authentication attempt is abandoned, and
26500 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26501 delivery to be deferred.
26502 .next
26503 If the result of the authentication attempt is a temporary error or a timeout,
26504 Exim abandons trying to send the message to the host for the moment. It will
26505 try again later. If there are any backup hosts available, they are tried in the
26506 usual way.
26507 .next
26508 If the response to authentication is a permanent error (5&'xx'& code), Exim
26509 carries on searching the list of authenticators and tries another one if
26510 possible. If all authentication attempts give permanent errors, or if there are
26511 no attempts because no mechanisms match (or option expansions force failure),
26512 what happens depends on whether the host matches &%hosts_require_auth%& or
26513 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26514 delivery is deferred. The error can be detected in the retry rules, and thereby
26515 turned into a permanent error if you wish. In the second case, Exim tries to
26516 deliver the message unauthenticated.
26517 .endlist
26518
26519 Note that the hostlist test for whether to do authentication can be
26520 confused if name-IP lookups change between the time the peer is decided
26521 upon and the time that the transport runs.  For example, with a manualroute
26522 router given a host name, and with DNS "round-robin" used by that name: if
26523 the local resolver cache times out between the router and the transport
26524 running, the transport may get an IP for the name for its authentication
26525 check which does not match the connection peer IP.
26526 No authentication will then be done, despite the names being identical.
26527
26528 For such cases use a separate transport which always authenticates.
26529
26530 .cindex "AUTH" "on MAIL command"
26531 When Exim has authenticated itself to a remote server, it adds the AUTH
26532 parameter to the MAIL commands it sends, if it has an authenticated sender for
26533 the message. If the message came from a remote host, the authenticated sender
26534 is the one that was receiving on an incoming MAIL command, provided that the
26535 incoming connection was authenticated and the &%server_mail_auth%& condition
26536 allowed the authenticated sender to be retained. If a local process calls Exim
26537 to send a message, the sender address that is built from the login name and
26538 &%qualify_domain%& is treated as authenticated. However, if the
26539 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26540 the authenticated sender that was received with the message.
26541 .ecindex IIDauthconf1
26542 .ecindex IIDauthconf2
26543
26544
26545
26546
26547
26548
26549 . ////////////////////////////////////////////////////////////////////////////
26550 . ////////////////////////////////////////////////////////////////////////////
26551
26552 .chapter "The plaintext authenticator" "CHAPplaintext"
26553 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26554 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26555 The &(plaintext)& authenticator can be configured to support the PLAIN and
26556 LOGIN authentication mechanisms, both of which transfer authentication data as
26557 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26558 security risk; you are strongly advised to insist on the use of SMTP encryption
26559 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26560 use unencrypted plain text, you should not use the same passwords for SMTP
26561 connections as you do for login accounts.
26562
26563 .section "Plaintext options" "SECID171"
26564 .cindex "options" "&(plaintext)& authenticator (server)"
26565 When configured as a server, &(plaintext)& uses the following options:
26566
26567 .option server_condition authenticators string&!! unset
26568 This is actually a global authentication option, but it must be set in order to
26569 configure the &(plaintext)& driver as a server. Its use is described below.
26570
26571 .option server_prompts plaintext string&!! unset
26572 The contents of this option, after expansion, must be a colon-separated list of
26573 prompt strings. If expansion fails, a temporary authentication rejection is
26574 given.
26575
26576 .section "Using plaintext in a server" "SECTplainserver"
26577 .cindex "AUTH" "in &(plaintext)& authenticator"
26578 .cindex "binary zero" "in &(plaintext)& authenticator"
26579 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26580         "in &(plaintext)& authenticator"
26581 .vindex "&$auth1$&, &$auth2$&, etc"
26582 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26583
26584 When running as a server, &(plaintext)& performs the authentication test by
26585 expanding a string. The data sent by the client with the AUTH command, or in
26586 response to subsequent prompts, is base64 encoded, and so may contain any byte
26587 values when decoded. If any data is supplied with the command, it is treated as
26588 a list of strings, separated by NULs (binary zeros), the first three of which
26589 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26590 (neither LOGIN nor PLAIN uses more than three strings).
26591
26592 For compatibility with previous releases of Exim, the values are also placed in
26593 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26594 variables for this purpose is now deprecated, as it can lead to confusion in
26595 string expansions that also use them for other things.
26596
26597 If there are more strings in &%server_prompts%& than the number of strings
26598 supplied with the AUTH command, the remaining prompts are used to obtain more
26599 data. Each response from the client may be a list of NUL-separated strings.
26600
26601 .vindex "&$authenticated_id$&"
26602 Once a sufficient number of data strings have been received,
26603 &%server_condition%& is expanded. If the expansion is forced to fail,
26604 authentication fails. Any other expansion failure causes a temporary error code
26605 to be returned. If the result of a successful expansion is an empty string,
26606 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26607 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26608 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26609 For any other result, a temporary error code is returned, with the expanded
26610 string as the error text
26611
26612 &*Warning*&: If you use a lookup in the expansion to find the user's
26613 password, be sure to make the authentication fail if the user is unknown.
26614 There are good and bad examples at the end of the next section.
26615
26616
26617
26618 .section "The PLAIN authentication mechanism" "SECID172"
26619 .cindex "PLAIN authentication mechanism"
26620 .cindex "authentication" "PLAIN mechanism"
26621 .cindex "binary zero" "in &(plaintext)& authenticator"
26622 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26623 sent as one item of data (that is, one combined string containing two NUL
26624 separators). The data is sent either as part of the AUTH command, or
26625 subsequently in response to an empty prompt from the server.
26626
26627 The second and third strings are a user name and a corresponding password.
26628 Using a single fixed user name and password as an example, this could be
26629 configured as follows:
26630 .code
26631 fixed_plain:
26632   driver = plaintext
26633   public_name = PLAIN
26634   server_prompts = :
26635   server_condition = \
26636     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26637   server_set_id = $auth2
26638 .endd
26639 Note that the default result strings from &%if%& (&"true"& or an empty string)
26640 are exactly what we want here, so they need not be specified. Obviously, if the
26641 password contains expansion-significant characters such as dollar, backslash,
26642 or closing brace, they have to be escaped.
26643
26644 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26645 the end of a string list are ignored). If all the data comes as part of the
26646 AUTH command, as is commonly the case, the prompt is not used. This
26647 authenticator is advertised in the response to EHLO as
26648 .code
26649 250-AUTH PLAIN
26650 .endd
26651 and a client host can authenticate itself by sending the command
26652 .code
26653 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26654 .endd
26655 As this contains three strings (more than the number of prompts), no further
26656 data is required from the client. Alternatively, the client may just send
26657 .code
26658 AUTH PLAIN
26659 .endd
26660 to initiate authentication, in which case the server replies with an empty
26661 prompt. The client must respond with the combined data string.
26662
26663 The data string is base64 encoded, as required by the RFC. This example,
26664 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26665 represents a zero byte. This is split up into three strings, the first of which
26666 is empty. The &%server_condition%& option in the authenticator checks that the
26667 second two are &`username`& and &`mysecret`& respectively.
26668
26669 Having just one fixed user name and password, as in this example, is not very
26670 realistic, though for a small organization with only a handful of
26671 authenticating clients it could make sense.
26672
26673 A more sophisticated instance of this authenticator could use the user name in
26674 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26675 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26676 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26677 This is an incorrect example:
26678 .code
26679 server_condition = \
26680   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26681 .endd
26682 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26683 which it then compares to the supplied password (&$auth3$&). Why is this example
26684 incorrect? It works fine for existing users, but consider what happens if a
26685 non-existent user name is given. The lookup fails, but as no success/failure
26686 strings are given for the lookup, it yields an empty string. Thus, to defeat
26687 the authentication, all a client has to do is to supply a non-existent user
26688 name and an empty password. The correct way of writing this test is:
26689 .code
26690 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26691   {${if eq{$value}{$auth3}}} {false}}
26692 .endd
26693 In this case, if the lookup succeeds, the result is checked; if the lookup
26694 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26695 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26696 always fails if its second argument is empty. However, the second way of
26697 writing the test makes the logic clearer.
26698
26699
26700 .section "The LOGIN authentication mechanism" "SECID173"
26701 .cindex "LOGIN authentication mechanism"
26702 .cindex "authentication" "LOGIN mechanism"
26703 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26704 in a number of programs. No data is sent with the AUTH command. Instead, a
26705 user name and password are supplied separately, in response to prompts. The
26706 plaintext authenticator can be configured to support this as in this example:
26707 .code
26708 fixed_login:
26709   driver = plaintext
26710   public_name = LOGIN
26711   server_prompts = User Name : Password
26712   server_condition = \
26713     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26714   server_set_id = $auth1
26715 .endd
26716 Because of the way plaintext operates, this authenticator accepts data supplied
26717 with the AUTH command (in contravention of the specification of LOGIN), but
26718 if the client does not supply it (as is the case for LOGIN clients), the prompt
26719 strings are used to obtain two data items.
26720
26721 Some clients are very particular about the precise text of the prompts. For
26722 example, Outlook Express is reported to recognize only &"Username:"& and
26723 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26724 strings. It uses the &%ldapauth%& expansion condition to check the user
26725 name and password by binding to an LDAP server:
26726 .code
26727 login:
26728   driver = plaintext
26729   public_name = LOGIN
26730   server_prompts = Username:: : Password::
26731   server_condition = ${if and{{ \
26732     !eq{}{$auth1} }{ \
26733     ldapauth{\
26734       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26735       pass=${quote:$auth2} \
26736       ldap://ldap.example.org/} }} }
26737   server_set_id = uid=$auth1,ou=people,o=example.org
26738 .endd
26739 We have to check that the username is not empty before using it, because LDAP
26740 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26741 operator to correctly quote the DN for authentication. However, the basic
26742 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26743 correct one to use for the password, because quoting is needed only to make
26744 the password conform to the Exim syntax. At the LDAP level, the password is an
26745 uninterpreted string.
26746
26747
26748 .section "Support for different kinds of authentication" "SECID174"
26749 A number of string expansion features are provided for the purpose of
26750 interfacing to different ways of user authentication. These include checking
26751 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26752 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26753 &<<SECTexpcond>>&.
26754
26755
26756
26757
26758 .section "Using plaintext in a client" "SECID175"
26759 .cindex "options" "&(plaintext)& authenticator (client)"
26760 The &(plaintext)& authenticator has two client options:
26761
26762 .option client_ignore_invalid_base64 plaintext boolean false
26763 If the client receives a server prompt that is not a valid base64 string,
26764 authentication is abandoned by default. However, if this option is set true,
26765 the error in the challenge is ignored and the client sends the response as
26766 usual.
26767
26768 .option client_send plaintext string&!! unset
26769 The string is a colon-separated list of authentication data strings. Each
26770 string is independently expanded before being sent to the server. The first
26771 string is sent with the AUTH command; any more strings are sent in response
26772 to prompts from the server. Before each string is expanded, the value of the
26773 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26774 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26775 way. Thus, the prompt that is received in response to sending the first string
26776 (with the AUTH command) can be used in the expansion of the second string, and
26777 so on. If an invalid base64 string is received when
26778 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26779 &$auth$&<&'n'&> variable.
26780
26781 &*Note*&: You cannot use expansion to create multiple strings, because
26782 splitting takes priority and happens first.
26783
26784 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26785 the data, further processing is applied to each string before it is sent. If
26786 there are any single circumflex characters in the string, they are converted to
26787 NULs. Should an actual circumflex be required as data, it must be doubled in
26788 the string.
26789
26790 This is an example of a client configuration that implements the PLAIN
26791 authentication mechanism with a fixed user name and password:
26792 .code
26793 fixed_plain:
26794   driver = plaintext
26795   public_name = PLAIN
26796   client_send = ^username^mysecret
26797 .endd
26798 The lack of colons means that the entire text is sent with the AUTH
26799 command, with the circumflex characters converted to NULs. A similar example
26800 that uses the LOGIN mechanism is:
26801 .code
26802 fixed_login:
26803   driver = plaintext
26804   public_name = LOGIN
26805   client_send = : username : mysecret
26806 .endd
26807 The initial colon means that the first string is empty, so no data is sent with
26808 the AUTH command itself. The remaining strings are sent in response to
26809 prompts.
26810 .ecindex IIDplaiauth1
26811 .ecindex IIDplaiauth2
26812
26813
26814
26815
26816 . ////////////////////////////////////////////////////////////////////////////
26817 . ////////////////////////////////////////////////////////////////////////////
26818
26819 .chapter "The cram_md5 authenticator" "CHID9"
26820 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26821 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26822 .cindex "CRAM-MD5 authentication mechanism"
26823 .cindex "authentication" "CRAM-MD5 mechanism"
26824 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26825 sends a challenge string to the client, and the response consists of a user
26826 name and the CRAM-MD5 digest of the challenge string combined with a secret
26827 string (password) which is known to both server and client. Thus, the secret
26828 is not sent over the network as plain text, which makes this authenticator more
26829 secure than &(plaintext)&. However, the downside is that the secret has to be
26830 available in plain text at either end.
26831
26832
26833 .section "Using cram_md5 as a server" "SECID176"
26834 .cindex "options" "&(cram_md5)& authenticator (server)"
26835 This authenticator has one server option, which must be set to configure the
26836 authenticator as a server:
26837
26838 .option server_secret cram_md5 string&!! unset
26839 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26840 When the server receives the client's response, the user name is placed in
26841 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26842 obtain the password for that user. The server then computes the CRAM-MD5 digest
26843 that the client should have sent, and checks that it received the correct
26844 string. If the expansion of &%server_secret%& is forced to fail, authentication
26845 fails. If the expansion fails for some other reason, a temporary error code is
26846 returned to the client.
26847
26848 For compatibility with previous releases of Exim, the user name is also placed
26849 in &$1$&. However, the use of this variables for this purpose is now
26850 deprecated, as it can lead to confusion in string expansions that also use
26851 numeric variables for other things.
26852
26853 For example, the following authenticator checks that the user name given by the
26854 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26855 user name, authentication fails.
26856 .code
26857 fixed_cram:
26858   driver = cram_md5
26859   public_name = CRAM-MD5
26860   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26861   server_set_id = $auth1
26862 .endd
26863 .vindex "&$authenticated_id$&"
26864 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26865 name in &$authenticated_id$&. A more typical configuration might look up the
26866 secret string in a file, using the user name as the key. For example:
26867 .code
26868 lookup_cram:
26869   driver = cram_md5
26870   public_name = CRAM-MD5
26871   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26872                   {$value}fail}
26873   server_set_id = $auth1
26874 .endd
26875 Note that this expansion explicitly forces failure if the lookup fails
26876 because &$auth1$& contains an unknown user name.
26877
26878 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26879 using the relevant libraries, you need to know the realm to specify in the
26880 lookup and then ask for the &"userPassword"& attribute for that user in that
26881 realm, with:
26882 .code
26883 cyrusless_crammd5:
26884   driver = cram_md5
26885   public_name = CRAM-MD5
26886   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26887                   dbmjz{/etc/sasldb2}{$value}fail}
26888   server_set_id = $auth1
26889 .endd
26890
26891 .section "Using cram_md5 as a client" "SECID177"
26892 .cindex "options" "&(cram_md5)& authenticator (client)"
26893 When used as a client, the &(cram_md5)& authenticator has two options:
26894
26895
26896
26897 .option client_name cram_md5 string&!! "the primary host name"
26898 This string is expanded, and the result used as the user name data when
26899 computing the response to the server's challenge.
26900
26901
26902 .option client_secret cram_md5 string&!! unset
26903 This option must be set for the authenticator to work as a client. Its value is
26904 expanded and the result used as the secret string when computing the response.
26905
26906
26907 .vindex "&$host$&"
26908 .vindex "&$host_address$&"
26909 Different user names and secrets can be used for different servers by referring
26910 to &$host$& or &$host_address$& in the options. Forced failure of either
26911 expansion string is treated as an indication that this authenticator is not
26912 prepared to handle this case. Exim moves on to the next configured client
26913 authenticator. Any other expansion failure causes Exim to give up trying to
26914 send the message to the current server.
26915
26916 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26917 strings, is:
26918 .code
26919 fixed_cram:
26920   driver = cram_md5
26921   public_name = CRAM-MD5
26922   client_name = ph10
26923   client_secret = secret
26924 .endd
26925 .ecindex IIDcramauth1
26926 .ecindex IIDcramauth2
26927
26928
26929
26930 . ////////////////////////////////////////////////////////////////////////////
26931 . ////////////////////////////////////////////////////////////////////////////
26932
26933 .chapter "The cyrus_sasl authenticator" "CHID10"
26934 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26935 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26936 .cindex "Cyrus" "SASL library"
26937 .cindex "Kerberos"
26938 The code for this authenticator was provided by Matthew Byng-Maddick while
26939 at A L Digital Ltd.
26940
26941 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26942 library implementation of the RFC 2222 (&"Simple Authentication and Security
26943 Layer"&). This library supports a number of authentication mechanisms,
26944 including PLAIN and LOGIN, but also several others that Exim does not support
26945 directly. In particular, there is support for Kerberos authentication.
26946
26947 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26948 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26949 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26950 name of the driver to determine which mechanism to support.
26951
26952 Where access to some kind of secret file is required, for example in GSSAPI
26953 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26954 user, and that the Cyrus SASL library has no way of escalating privileges
26955 by default. You may also find you need to set environment variables,
26956 depending on the driver you are using.
26957
26958 The application name provided by Exim is &"exim"&, so various SASL options may
26959 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26960 Kerberos, note that because of limitations in the GSSAPI interface,
26961 changing the server keytab might need to be communicated down to the Kerberos
26962 layer independently. The mechanism for doing so is dependent upon the Kerberos
26963 implementation.
26964
26965 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26966 may be set to point to an alternative keytab file. Exim will pass this
26967 variable through from its own inherited environment when started as root or the
26968 Exim user. The keytab file needs to be readable by the Exim user.
26969 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26970 environment variable.  In practice, for those releases, the Cyrus authenticator
26971 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26972 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26973
26974
26975 .section "Using cyrus_sasl as a server" "SECID178"
26976 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26977 (on a successful authentication) into &$auth1$&. For compatibility with
26978 previous releases of Exim, the username is also placed in &$1$&. However, the
26979 use of this variable for this purpose is now deprecated, as it can lead to
26980 confusion in string expansions that also use numeric variables for other
26981 things.
26982
26983
26984 .option server_hostname cyrus_sasl string&!! "see below"
26985 This option selects the hostname that is used when communicating with the
26986 library. The default value is &`$primary_hostname`&. It is up to the underlying
26987 SASL plug-in what it does with this data.
26988
26989
26990 .option server_mech cyrus_sasl string "see below"
26991 This option selects the authentication mechanism this driver should use. The
26992 default is the value of the generic &%public_name%& option. This option allows
26993 you to use a different underlying mechanism from the advertised name. For
26994 example:
26995 .code
26996 sasl:
26997   driver = cyrus_sasl
26998   public_name = X-ANYTHING
26999   server_mech = CRAM-MD5
27000   server_set_id = $auth1
27001 .endd
27002
27003 .option server_realm cyrus_sasl string&!! unset
27004 This specifies the SASL realm that the server claims to be in.
27005
27006
27007 .option server_service cyrus_sasl string &`smtp`&
27008 This is the SASL service that the server claims to implement.
27009
27010
27011 For straightforward cases, you do not need to set any of the authenticator's
27012 private options. All you need to do is to specify an appropriate mechanism as
27013 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27014 PLAIN, you could have two authenticators as follows:
27015 .code
27016 sasl_cram_md5:
27017   driver = cyrus_sasl
27018   public_name = CRAM-MD5
27019   server_set_id = $auth1
27020
27021 sasl_plain:
27022   driver = cyrus_sasl
27023   public_name = PLAIN
27024   server_set_id = $auth2
27025 .endd
27026 Cyrus SASL does implement the LOGIN authentication method, even though it is
27027 not a standard method. It is disabled by default in the source distribution,
27028 but it is present in many binary distributions.
27029 .ecindex IIDcyrauth1
27030 .ecindex IIDcyrauth2
27031
27032
27033
27034
27035 . ////////////////////////////////////////////////////////////////////////////
27036 . ////////////////////////////////////////////////////////////////////////////
27037 .chapter "The dovecot authenticator" "CHAPdovecot"
27038 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27039 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27040 This authenticator is an interface to the authentication facility of the
27041 Dovecot POP/IMAP server, which can support a number of authentication methods.
27042 Note that Dovecot must be configured to use auth-client not auth-userdb.
27043 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27044 to use the same mechanisms for SMTP authentication. This is a server
27045 authenticator only. There is only one option:
27046
27047 .option server_socket dovecot string unset
27048
27049 This option must specify the UNIX socket that is the interface to Dovecot
27050 authentication. The &%public_name%& option must specify an authentication
27051 mechanism that Dovecot is configured to support. You can have several
27052 authenticators for different mechanisms. For example:
27053 .code
27054 dovecot_plain:
27055   driver = dovecot
27056   public_name = PLAIN
27057   server_socket = /var/run/dovecot/auth-client
27058   server_set_id = $auth1
27059
27060 dovecot_ntlm:
27061   driver = dovecot
27062   public_name = NTLM
27063   server_socket = /var/run/dovecot/auth-client
27064   server_set_id = $auth1
27065 .endd
27066 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27067 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27068 option is passed in the Dovecot authentication command. If, for a TLS
27069 connection, a client certificate has been verified, the &"valid-client-cert"&
27070 option is passed. When authentication succeeds, the identity of the user
27071 who authenticated is placed in &$auth1$&.
27072 .ecindex IIDdcotauth1
27073 .ecindex IIDdcotauth2
27074
27075
27076 . ////////////////////////////////////////////////////////////////////////////
27077 . ////////////////////////////////////////////////////////////////////////////
27078 .chapter "The gsasl authenticator" "CHAPgsasl"
27079 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27080 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27081 .cindex "authentication" "GNU SASL"
27082 .cindex "authentication" "SASL"
27083 .cindex "authentication" "EXTERNAL"
27084 .cindex "authentication" "ANONYMOUS"
27085 .cindex "authentication" "PLAIN"
27086 .cindex "authentication" "LOGIN"
27087 .cindex "authentication" "DIGEST-MD5"
27088 .cindex "authentication" "CRAM-MD5"
27089 .cindex "authentication" "SCRAM-SHA-1"
27090 The &(gsasl)& authenticator provides server integration for the GNU SASL
27091 library and the mechanisms it provides.  This is new as of the 4.80 release
27092 and there are a few areas where the library does not let Exim smoothly
27093 scale to handle future authentication mechanisms, so no guarantee can be
27094 made that any particular new authentication mechanism will be supported
27095 without code changes in Exim.
27096
27097 Exim's &(gsasl)& authenticator does not have client-side support at this
27098 time; only the server-side support is implemented.  Patches welcome.
27099
27100
27101 .option server_channelbinding gsasl boolean false
27102 Do not set this true without consulting a cryptographic engineer.
27103
27104 Some authentication mechanisms are able to use external context at both ends
27105 of the session to bind the authentication to that context, and fail the
27106 authentication process if that context differs.  Specifically, some TLS
27107 ciphersuites can provide identifying information about the cryptographic
27108 context.
27109
27110 This should have meant that certificate identity and verification becomes a
27111 non-issue, as a man-in-the-middle attack will cause the correct client and
27112 server to see different identifiers and authentication will fail.
27113
27114 This is currently only supported when using the GnuTLS library.  This is
27115 only usable by mechanisms which support "channel binding"; at time of
27116 writing, that's the SCRAM family.
27117
27118 This defaults off to ensure smooth upgrade across Exim releases, in case
27119 this option causes some clients to start failing.  Some future release
27120 of Exim might have switched the default to be true.
27121
27122 However, Channel Binding in TLS has proven to be broken in current versions.
27123 Do not plan to rely upon this feature for security, ever, without consulting
27124 with a subject matter expert (a cryptographic engineer).
27125
27126
27127 .option server_hostname gsasl string&!! "see below"
27128 This option selects the hostname that is used when communicating with the
27129 library. The default value is &`$primary_hostname`&.
27130 Some mechanisms will use this data.
27131
27132
27133 .option server_mech gsasl string "see below"
27134 This option selects the authentication mechanism this driver should use. The
27135 default is the value of the generic &%public_name%& option. This option allows
27136 you to use a different underlying mechanism from the advertised name. For
27137 example:
27138 .code
27139 sasl:
27140   driver = gsasl
27141   public_name = X-ANYTHING
27142   server_mech = CRAM-MD5
27143   server_set_id = $auth1
27144 .endd
27145
27146
27147 .option server_password gsasl string&!! unset
27148 Various mechanisms need access to the cleartext password on the server, so
27149 that proof-of-possession can be demonstrated on the wire, without sending
27150 the password itself.
27151
27152 The data available for lookup varies per mechanism.
27153 In all cases, &$auth1$& is set to the &'authentication id'&.
27154 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27155 if available, else the empty string.
27156 The &$auth3$& variable will always be the &'realm'& if available,
27157 else the empty string.
27158
27159 A forced failure will cause authentication to defer.
27160
27161 If using this option, it may make sense to set the &%server_condition%&
27162 option to be simply "true".
27163
27164
27165 .option server_realm gsasl string&!! unset
27166 This specifies the SASL realm that the server claims to be in.
27167 Some mechanisms will use this data.
27168
27169
27170 .option server_scram_iter gsasl string&!! unset
27171 This option provides data for the SCRAM family of mechanisms.
27172 &$auth1$& is not available at evaluation time.
27173 (This may change, as we receive feedback on use)
27174
27175
27176 .option server_scram_salt gsasl string&!! unset
27177 This option provides data for the SCRAM family of mechanisms.
27178 &$auth1$& is not available at evaluation time.
27179 (This may change, as we receive feedback on use)
27180
27181
27182 .option server_service gsasl string &`smtp`&
27183 This is the SASL service that the server claims to implement.
27184 Some mechanisms will use this data.
27185
27186
27187 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27188 .vindex "&$auth1$&, &$auth2$&, etc"
27189 These may be set when evaluating specific options, as detailed above.
27190 They will also be set when evaluating &%server_condition%&.
27191
27192 Unless otherwise stated below, the &(gsasl)& integration will use the following
27193 meanings for these variables:
27194
27195 .ilist
27196 .vindex "&$auth1$&"
27197 &$auth1$&: the &'authentication id'&
27198 .next
27199 .vindex "&$auth2$&"
27200 &$auth2$&: the &'authorization id'&
27201 .next
27202 .vindex "&$auth3$&"
27203 &$auth3$&: the &'realm'&
27204 .endlist
27205
27206 On a per-mechanism basis:
27207
27208 .ilist
27209 .cindex "authentication" "EXTERNAL"
27210 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27211 the &%server_condition%& option must be present.
27212 .next
27213 .cindex "authentication" "ANONYMOUS"
27214 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27215 the &%server_condition%& option must be present.
27216 .next
27217 .cindex "authentication" "GSSAPI"
27218 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27219 &$auth2$& will be set to the &'authorization id'&,
27220 the &%server_condition%& option must be present.
27221 .endlist
27222
27223 An &'anonymous token'& is something passed along as an unauthenticated
27224 identifier; this is analogous to FTP anonymous authentication passing an
27225 email address, or software-identifier@, as the "password".
27226
27227
27228 An example showing the password having the realm specified in the callback
27229 and demonstrating a Cyrus SASL to GSASL migration approach is:
27230 .code
27231 gsasl_cyrusless_crammd5:
27232   driver = gsasl
27233   public_name = CRAM-MD5
27234   server_realm = imap.example.org
27235   server_password = ${lookup{$auth1:$auth3:userPassword}\
27236                     dbmjz{/etc/sasldb2}{$value}fail}
27237   server_set_id = ${quote:$auth1}
27238   server_condition = yes
27239 .endd
27240
27241
27242 . ////////////////////////////////////////////////////////////////////////////
27243 . ////////////////////////////////////////////////////////////////////////////
27244
27245 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27246 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27247 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27248 .cindex "authentication" "GSSAPI"
27249 .cindex "authentication" "Kerberos"
27250 The &(heimdal_gssapi)& authenticator provides server integration for the
27251 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27252 reliably.
27253
27254 .option server_hostname heimdal_gssapi string&!! "see below"
27255 This option selects the hostname that is used, with &%server_service%&,
27256 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27257 identifier.  The default value is &`$primary_hostname`&.
27258
27259 .option server_keytab heimdal_gssapi string&!! unset
27260 If set, then Heimdal will not use the system default keytab (typically
27261 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27262 The value should be a pathname, with no &"file:"& prefix.
27263
27264 .option server_service heimdal_gssapi string&!! "smtp"
27265 This option specifies the service identifier used, in conjunction with
27266 &%server_hostname%&, for building the identifier for finding credentials
27267 from the keytab.
27268
27269
27270 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27271 Beware that these variables will typically include a realm, thus will appear
27272 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27273 not verified, so a malicious client can set it to anything.
27274
27275 The &$auth1$& field should be safely trustable as a value from the Key
27276 Distribution Center.  Note that these are not quite email addresses.
27277 Each identifier is for a role, and so the left-hand-side may include a
27278 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27279
27280 .vindex "&$auth1$&, &$auth2$&, etc"
27281 .ilist
27282 .vindex "&$auth1$&"
27283 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27284 .next
27285 .vindex "&$auth2$&"
27286 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27287 authentication.  If that was empty, this will also be set to the
27288 GSS Display Name.
27289 .endlist
27290
27291
27292 . ////////////////////////////////////////////////////////////////////////////
27293 . ////////////////////////////////////////////////////////////////////////////
27294
27295 .chapter "The spa authenticator" "CHAPspa"
27296 .scindex IIDspaauth1 "&(spa)& authenticator"
27297 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27298 .cindex "authentication" "Microsoft Secure Password"
27299 .cindex "authentication" "NTLM"
27300 .cindex "Microsoft Secure Password Authentication"
27301 .cindex "NTLM authentication"
27302 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27303 Password Authentication'& mechanism,
27304 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27305 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27306 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27307 server side was subsequently contributed by Tom Kistner. The mechanism works as
27308 follows:
27309
27310 .ilist
27311 After the AUTH command has been accepted, the client sends an SPA
27312 authentication request based on the user name and optional domain.
27313 .next
27314 The server sends back a challenge.
27315 .next
27316 The client builds a challenge response which makes use of the user's password
27317 and sends it to the server, which then accepts or rejects it.
27318 .endlist
27319
27320 Encryption is used to protect the password in transit.
27321
27322
27323
27324 .section "Using spa as a server" "SECID179"
27325 .cindex "options" "&(spa)& authenticator (server)"
27326 The &(spa)& authenticator has just one server option:
27327
27328 .option server_password spa string&!! unset
27329 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27330 This option is expanded, and the result must be the cleartext password for the
27331 authenticating user, whose name is at this point in &$auth1$&. For
27332 compatibility with previous releases of Exim, the user name is also placed in
27333 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27334 it can lead to confusion in string expansions that also use numeric variables
27335 for other things. For example:
27336 .code
27337 spa:
27338   driver = spa
27339   public_name = NTLM
27340   server_password = \
27341     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27342 .endd
27343 If the expansion is forced to fail, authentication fails. Any other expansion
27344 failure causes a temporary error code to be returned.
27345
27346
27347
27348
27349
27350 .section "Using spa as a client" "SECID180"
27351 .cindex "options" "&(spa)& authenticator (client)"
27352 The &(spa)& authenticator has the following client options:
27353
27354
27355
27356 .option client_domain spa string&!! unset
27357 This option specifies an optional domain for the authentication.
27358
27359
27360 .option client_password spa string&!! unset
27361 This option specifies the user's password, and must be set.
27362
27363
27364 .option client_username spa string&!! unset
27365 This option specifies the user name, and must be set. Here is an example of a
27366 configuration of this authenticator for use with the mail servers at
27367 &'msn.com'&:
27368 .code
27369 msn:
27370   driver = spa
27371   public_name = MSN
27372   client_username = msn/msn_username
27373   client_password = msn_plaintext_password
27374   client_domain = DOMAIN_OR_UNSET
27375 .endd
27376 .ecindex IIDspaauth1
27377 .ecindex IIDspaauth2
27378
27379
27380
27381
27382
27383 . ////////////////////////////////////////////////////////////////////////////
27384 . ////////////////////////////////////////////////////////////////////////////
27385
27386 .chapter "The tls authenticator" "CHAPtlsauth"
27387 .scindex IIDtlsauth1 "&(tls)& authenticator"
27388 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27389 .cindex "authentication" "Client Certificate"
27390 .cindex "authentication" "X509"
27391 .cindex "Certificate-based authentication"
27392 The &(tls)& authenticator provides server support for
27393 authentication based on client certificates.
27394
27395 It is not an SMTP authentication mechanism and is not
27396 advertised by the server as part of the SMTP EHLO response.
27397 It is an Exim authenticator in the sense that it affects
27398 the protocol element of the log line, can be tested for
27399 by the &%authenticated%& ACL condition, and can set
27400 the &$authenticated_id$& variable.
27401
27402 The client must present a verifiable certificate,
27403 for which it must have been requested via the
27404 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27405 (see &<<CHAPTLS>>&).
27406
27407 If an authenticator of this type is configured it is
27408 run before any SMTP-level communication is done,
27409 and can authenticate the connection.
27410 If it does, SMTP authentication is not offered.
27411
27412 A maximum of one authenticator of this type may be present.
27413
27414
27415 .cindex "options" "&(tls)& authenticator (server)"
27416 The &(tls)& authenticator has three server options:
27417
27418 .option server_param1 tls string&!! unset
27419 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27420 This option is expanded after the TLS negotiation and
27421 the result is placed in &$auth1$&.
27422 If the expansion is forced to fail, authentication fails. Any other expansion
27423 failure causes a temporary error code to be returned.
27424
27425 .option server_param2 tls string&!! unset
27426 .option server_param3 tls string&!! unset
27427 As above, for &$auth2$& and &$auth3$&.
27428
27429 &%server_param1%& may also be spelled &%server_param%&.
27430
27431
27432 Example:
27433 .code
27434 tls:
27435   driver = tls
27436   server_param1 =     ${certextract {subj_altname,mail,>:} \
27437                                     {$tls_in_peercert}}
27438   server_condition =  ${if forany {$auth1} \
27439                             {!= {0} \
27440                                 {${lookup ldap{ldap:///\
27441                          mailname=${quote_ldap_dn:${lc:$item}},\
27442                          ou=users,LDAP_DC?mailid} {$value}{0} \
27443                        }    }   } }
27444   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27445 .endd
27446 This accepts a client certificate that is verifiable against any
27447 of your configured trust-anchors
27448 (which usually means the full set of public CAs)
27449 and which has a SAN with a good account name.
27450 Note that the client cert is on the wire in-clear, including the SAN,
27451 whereas a plaintext SMTP AUTH done inside TLS is not.
27452
27453 . An alternative might use
27454 . .code
27455 .   server_param1 = ${sha256:$tls_in_peercert}
27456 . .endd
27457 . to require one of a set of specific certs that define a given account
27458 . (the verification is still required, but mostly irrelevant).
27459 . This would help for per-device use.
27460 .
27461 . However, for the future we really need support for checking a
27462 . user cert in LDAP - which probably wants a base-64 DER.
27463
27464 .ecindex IIDtlsauth1
27465 .ecindex IIDtlsauth2
27466
27467
27468 Note that because authentication is traditionally an SMTP operation,
27469 the &%authenticated%& ACL condition cannot be used in
27470 a connect- or helo-ACL.
27471
27472
27473
27474 . ////////////////////////////////////////////////////////////////////////////
27475 . ////////////////////////////////////////////////////////////////////////////
27476
27477 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27478          "Encrypted SMTP connections"
27479 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27480 .scindex IIDencsmtp2 "SMTP" "encryption"
27481 .cindex "TLS" "on SMTP connection"
27482 .cindex "OpenSSL"
27483 .cindex "GnuTLS"
27484 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27485 Sockets Layer), is implemented by making use of the OpenSSL library or the
27486 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27487 cryptographic code in the Exim distribution itself for implementing TLS. In
27488 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27489 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27490 You also need to understand the basic concepts of encryption at a managerial
27491 level, and in particular, the way that public keys, private keys, and
27492 certificates are used.
27493
27494 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27495 connection is established, the client issues a STARTTLS command. If the
27496 server accepts this, the client and the server negotiate an encryption
27497 mechanism. If the negotiation succeeds, the data that subsequently passes
27498 between them is encrypted.
27499
27500 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27501 and if so, what cipher suite is in use, whether the client supplied a
27502 certificate, and whether or not that certificate was verified. This makes it
27503 possible for an Exim server to deny or accept certain commands based on the
27504 encryption state.
27505
27506 &*Warning*&: Certain types of firewall and certain anti-virus products can
27507 disrupt TLS connections. You need to turn off SMTP scanning for these products
27508 in order to get TLS to work.
27509
27510
27511
27512 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27513          "SECID284"
27514 .cindex "submissions protocol"
27515 .cindex "ssmtp protocol"
27516 .cindex "smtps protocol"
27517 .cindex "SMTP" "submissions protocol"
27518 .cindex "SMTP" "ssmtp protocol"
27519 .cindex "SMTP" "smtps protocol"
27520 The history of port numbers for TLS in SMTP is a little messy and has been
27521 contentious.  As of RFC 8314, the common practice of using the historically
27522 allocated port 465 for "email submission but with TLS immediately upon connect
27523 instead of using STARTTLS" is officially blessed by the IETF, and recommended
27524 by them in preference to STARTTLS.
27525
27526 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
27527 clarity emerged over the dual roles of SMTP, for MX delivery and Email
27528 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
27529
27530 This approach was, for a while, officially abandoned when encrypted SMTP was
27531 standardized, but many clients kept using it, even as the TCP port number was
27532 reassigned for other use.
27533 Thus you may encounter guidance claiming that you shouldn't enable use of
27534 this port.
27535 In practice, a number of mail-clients have only ever supported submissions,
27536 not submission with STARTTLS upgrade.
27537 Ideally, offer both submission (587) and submissions (465) service.
27538
27539 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
27540 global option. Its value must be a list of port numbers;
27541 the most common use is expected to be:
27542 .code
27543 tls_on_connect_ports = 465
27544 .endd
27545 The port numbers specified by this option apply to all SMTP connections, both
27546 via the daemon and via &'inetd'&. You still need to specify all the ports that
27547 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27548 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27549 an extra port &-- rather, it specifies different behaviour on a port that is
27550 defined elsewhere.
27551
27552 There is also a &%-tls-on-connect%& command line option. This overrides
27553 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
27554
27555
27556
27557
27558
27559
27560 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27561 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27562 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27563 followed later, when the first versions of GnuTLS were released. To build Exim
27564 to use GnuTLS, you need to set
27565 .code
27566 USE_GNUTLS=yes
27567 .endd
27568 in Local/Makefile, in addition to
27569 .code
27570 SUPPORT_TLS=yes
27571 .endd
27572 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27573 include files and libraries for GnuTLS can be found.
27574
27575 There are some differences in usage when using GnuTLS instead of OpenSSL:
27576
27577 .ilist
27578 The &%tls_verify_certificates%& option
27579 cannot be the path of a directory
27580 for GnuTLS versions before 3.3.6
27581 (for later versions, or OpenSSL, it can be either).
27582 .next
27583 The default value for &%tls_dhparam%& differs for historical reasons.
27584 .next
27585 .vindex "&$tls_in_peerdn$&"
27586 .vindex "&$tls_out_peerdn$&"
27587 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27588 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27589 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27590 .next
27591 OpenSSL identifies cipher suites using hyphens as separators, for example:
27592 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27593 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27594 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27595 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27596 to handle its own older variants) when processing lists of cipher suites in the
27597 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27598 option).
27599 .next
27600 The &%tls_require_ciphers%& options operate differently, as described in the
27601 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27602 .next
27603 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27604 When using OpenSSL, this option is ignored.
27605 (If an API is found to let OpenSSL be configured in this way,
27606 let the Exim Maintainers know and we'll likely use it).
27607 .next
27608 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
27609 main option, it must be ordered to match the &%tls_certificate%& list.
27610 .next
27611 Some other recently added features may only be available in one or the other.
27612 This should be documented with the feature.  If the documentation does not
27613 explicitly state that the feature is infeasible in the other TLS
27614 implementation, then patches are welcome.
27615 .endlist
27616
27617
27618 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27619 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27620 an explicit path; if the latter, then the text about generation still applies,
27621 but not the chosen filename.
27622 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27623 See the documentation of &%tls_dhparam%& for more information.
27624
27625 GnuTLS uses D-H parameters that may take a substantial amount of time
27626 to compute. It is unreasonable to re-compute them for every TLS session.
27627 Therefore, Exim keeps this data in a file in its spool directory, called
27628 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27629 of bits requested.
27630 The file is owned by the Exim user and is readable only by
27631 its owner. Every Exim process that start up GnuTLS reads the D-H
27632 parameters from this file. If the file does not exist, the first Exim process
27633 that needs it computes the data and writes it to a temporary file which is
27634 renamed once it is complete. It does not matter if several Exim processes do
27635 this simultaneously (apart from wasting a few resources). Once a file is in
27636 place, new Exim processes immediately start using it.
27637
27638 For maximum security, the parameters that are stored in this file should be
27639 recalculated periodically, the frequency depending on your paranoia level.
27640 If you are avoiding using the fixed D-H primes published in RFCs, then you
27641 are concerned about some advanced attacks and will wish to do this; if you do
27642 not regenerate then you might as well stick to the standard primes.
27643
27644 Arranging this is easy in principle; just delete the file when you want new
27645 values to be computed. However, there may be a problem. The calculation of new
27646 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27647 If the system is not very active, &_/dev/random_& may delay returning data
27648 until enough randomness (entropy) is available. This may cause Exim to hang for
27649 a substantial amount of time, causing timeouts on incoming connections.
27650
27651 The solution is to generate the parameters externally to Exim. They are stored
27652 in &_gnutls-params-N_& in PEM format, which means that they can be
27653 generated externally using the &(certtool)& command that is part of GnuTLS.
27654
27655 To replace the parameters with new ones, instead of deleting the file
27656 and letting Exim re-create it, you can generate new parameters using
27657 &(certtool)& and, when this has been done, replace Exim's cache file by
27658 renaming. The relevant commands are something like this:
27659 .code
27660 # ls
27661 [ look for file; assume gnutls-params-2236 is the most recent ]
27662 # rm -f new-params
27663 # touch new-params
27664 # chown exim:exim new-params
27665 # chmod 0600 new-params
27666 # certtool --generate-dh-params --bits 2236 >>new-params
27667 # openssl dhparam -noout -text -in new-params | head
27668 [ check the first line, make sure it's not more than 2236;
27669   if it is, then go back to the start ("rm") and repeat
27670   until the size generated is at most the size requested ]
27671 # chmod 0400 new-params
27672 # mv new-params gnutls-params-2236
27673 .endd
27674 If Exim never has to generate the parameters itself, the possibility of
27675 stalling is removed.
27676
27677 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27678 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27679 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27680 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27681 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27682 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27683 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27684 which applies to all D-H usage, client or server.  If the value returned by
27685 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27686 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27687 limit, which is still much higher than Exim historically used.
27688
27689 The filename and bits used will change as the GnuTLS maintainers change the
27690 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27691 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27692 2432 bits, while NSS is limited to 2236 bits.
27693
27694 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27695 increase the chance of the generated prime actually being within acceptable
27696 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27697 procedure above.  There is no sane procedure available to Exim to double-check
27698 the size of the generated prime, so it might still be too large.
27699
27700
27701 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27702 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27703 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27704 There is a function in the OpenSSL library that can be passed a list of cipher
27705 suites before the cipher negotiation takes place. This specifies which ciphers
27706 .new
27707 are acceptable for TLS versions prior to 1.3.
27708 .wen
27709 The list is colon separated and may contain names like
27710 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27711 directly to this function call.
27712 Many systems will install the OpenSSL manual-pages, so you may have
27713 &'ciphers(1)'& available to you.
27714 The following quotation from the OpenSSL
27715 documentation specifies what forms of item are allowed in the cipher string:
27716
27717 .ilist
27718 It can consist of a single cipher suite such as RC4-SHA.
27719 .next
27720 It can represent a list of cipher suites containing a certain algorithm,
27721 or cipher suites of a certain type. For example SHA1 represents all
27722 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27723 SSL v3 algorithms.
27724 .next
27725 Lists of cipher suites can be combined in a single cipher string using
27726 the + character. This is used as a logical and operation. For example
27727 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27728 algorithms.
27729 .endlist
27730
27731 Each cipher string can be optionally preceded by one of the characters &`!`&,
27732 &`-`& or &`+`&.
27733 .ilist
27734 If &`!`& is used, the ciphers are permanently deleted from the list. The
27735 ciphers deleted can never reappear in the list even if they are explicitly
27736 stated.
27737 .next
27738 If &`-`& is used, the ciphers are deleted from the list, but some or all
27739 of the ciphers can be added again by later options.
27740 .next
27741 If &`+`& is used, the ciphers are moved to the end of the list. This
27742 option does not add any new ciphers; it just moves matching existing ones.
27743 .endlist
27744
27745 If none of these characters is present, the string is interpreted as
27746 a list of ciphers to be appended to the current preference list. If the list
27747 includes any ciphers already present they will be ignored: that is, they will
27748 not be moved to the end of the list.
27749 .endlist
27750
27751 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27752 string:
27753 .code
27754 # note single-quotes to get ! past any shell history expansion
27755 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27756 .endd
27757
27758 This example will let the library defaults be permitted on the MX port, where
27759 there's probably no identity verification anyway, but ups the ante on the
27760 submission ports where the administrator might have some influence on the
27761 choice of clients used:
27762 .code
27763 # OpenSSL variant; see man ciphers(1)
27764 tls_require_ciphers = ${if =={$received_port}{25}\
27765                            {DEFAULT}\
27766                            {HIGH:!MD5:!SHA1}}
27767 .endd
27768
27769 This example will prefer ECDSA-authenticated ciphers over RSA ones:
27770 .code
27771 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
27772 .endd
27773
27774 .new
27775 For TLS version 1.3 the control available is less fine-grained
27776 and Exim does not provide access to it at present.
27777 The value of the &%tls_require_ciphers%& option is ignored when
27778 TLS version 1.3 is negotiated.
27779
27780 As of writing the library default cipher suite list for TLSv1.3 is
27781 .code
27782 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
27783 .endd
27784 .wen
27785
27786
27787 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27788          "SECTreqciphgnu"
27789 .cindex "GnuTLS" "specifying parameters for"
27790 .cindex "TLS" "specifying ciphers (GnuTLS)"
27791 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27792 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27793 .cindex "TLS" "specifying protocols (GnuTLS)"
27794 .cindex "TLS" "specifying priority string (GnuTLS)"
27795 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27796 The GnuTLS library allows the caller to provide a "priority string", documented
27797 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27798 ciphersuite specification in OpenSSL.
27799
27800 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27801 and controls both protocols and ciphers.
27802
27803 The &%tls_require_ciphers%& option is available both as an global option,
27804 controlling how Exim behaves as a server, and also as an option of the
27805 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27806 the value is string expanded.  The resulting string is not an Exim list and
27807 the string is given to the GnuTLS library, so that Exim does not need to be
27808 aware of future feature enhancements of GnuTLS.
27809
27810 Documentation of the strings accepted may be found in the GnuTLS manual, under
27811 "Priority strings".  This is online as
27812 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
27813 but beware that this relates to GnuTLS 3, which may be newer than the version
27814 installed on your system.  If you are using GnuTLS 3,
27815 then the example code
27816 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27817 on that site can be used to test a given string.
27818
27819 For example:
27820 .code
27821 # Disable older versions of protocols
27822 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27823 .endd
27824
27825 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27826 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27827 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27828
27829 This example will let the library defaults be permitted on the MX port, where
27830 there's probably no identity verification anyway, and lowers security further
27831 by increasing compatibility; but this ups the ante on the submission ports
27832 where the administrator might have some influence on the choice of clients
27833 used:
27834 .code
27835 # GnuTLS variant
27836 tls_require_ciphers = ${if =={$received_port}{25}\
27837                            {NORMAL:%COMPAT}\
27838                            {SECURE128}}
27839 .endd
27840
27841
27842 .section "Configuring an Exim server to use TLS" "SECID182"
27843 .cindex "TLS" "configuring an Exim server"
27844 When Exim has been built with TLS support, it advertises the availability of
27845 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27846 but not to any others. The default value of this option is *, which means
27847 that STARTTLS is always advertised.  Set it to blank to never advertise;
27848 this is reasonable for systems that want to use TLS only as a client.
27849
27850 If STARTTLS is to be used you
27851 need to set some other options in order to make TLS available.
27852
27853 If a client issues a STARTTLS command and there is some configuration
27854 problem in the server, the command is rejected with a 454 error. If the client
27855 persists in trying to issue SMTP commands, all except QUIT are rejected
27856 with the error
27857 .code
27858 554 Security failure
27859 .endd
27860 If a STARTTLS command is issued within an existing TLS session, it is
27861 rejected with a 554 error code.
27862
27863 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27864 must be set to match some hosts. The default is * which matches all hosts.
27865
27866 If this is all you do, TLS encryption will be enabled but not authentication -
27867 meaning that the peer has no assurance it is actually you he is talking to.
27868 You gain protection from a passive sniffer listening on the wire but not
27869 from someone able to intercept the communication.
27870
27871 Further protection requires some further configuration at the server end.
27872
27873 To make TLS work you need to set, in the server,
27874 .code
27875 tls_certificate = /some/file/name
27876 tls_privatekey = /some/file/name
27877 .endd
27878 These options are, in fact, expanded strings, so you can make them depend on
27879 the identity of the client that is connected if you wish. The first file
27880 contains the server's X509 certificate, and the second contains the private key
27881 that goes with it. These files need to be
27882 PEM format and readable by the Exim user, and must
27883 always be given as full path names.
27884 The key must not be password-protected.
27885 They can be the same file if both the
27886 certificate and the key are contained within it. If &%tls_privatekey%& is not
27887 set, or if its expansion is forced to fail or results in an empty string, this
27888 is assumed to be the case. The certificate file may also contain intermediate
27889 certificates that need to be sent to the client to enable it to authenticate
27890 the server's certificate.
27891
27892 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
27893 colon-separated lists of file paths.  Ciphers using given authentication
27894 algorithms require the presence of a suitable certificate to supply the
27895 public-key.  The server selects among the certificates to present to the
27896 client depending on the selected cipher, hence the priority ordering for
27897 ciphers will affect which certificate is used.
27898
27899 If you do not understand about certificates and keys, please try to find a
27900 source of this background information, which is not Exim-specific. (There are a
27901 few comments below in section &<<SECTcerandall>>&.)
27902
27903 &*Note*&: These options do not apply when Exim is operating as a client &--
27904 they apply only in the case of a server. If you need to use a certificate in an
27905 Exim client, you must set the options of the same names in an &(smtp)&
27906 transport.
27907
27908 With just these options, an Exim server will be able to use TLS. It does not
27909 require the client to have a certificate (but see below for how to insist on
27910 this). There is one other option that may be needed in other situations. If
27911 .code
27912 tls_dhparam = /some/file/name
27913 .endd
27914 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27915 with the parameters contained in the file.
27916 Set this to &`none`& to disable use of DH entirely, by making no prime
27917 available:
27918 .code
27919 tls_dhparam = none
27920 .endd
27921 This may also be set to a string identifying a standard prime to be used for
27922 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27923 used is &`ike23`&.  There are a few standard primes available, see the
27924 documentation for &%tls_dhparam%& for the complete list.
27925
27926 See the command
27927 .code
27928 openssl dhparam
27929 .endd
27930 for a way of generating file data.
27931
27932 The strings supplied for these three options are expanded every time a client
27933 host connects. It is therefore possible to use different certificates and keys
27934 for different hosts, if you so wish, by making use of the client's IP address
27935 in &$sender_host_address$& to control the expansion. If a string expansion is
27936 forced to fail, Exim behaves as if the option is not set.
27937
27938 .cindex "cipher" "logging"
27939 .cindex "log" "TLS cipher"
27940 .vindex "&$tls_in_cipher$&"
27941 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27942 an incoming TLS connection. It is included in the &'Received:'& header of an
27943 incoming message (by default &-- you can, of course, change this), and it is
27944 also included in the log line that records a message's arrival, keyed by
27945 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27946 condition can be used to test for specific cipher suites in ACLs.
27947
27948 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27949 can check the name of the cipher suite and vary their actions accordingly. The
27950 cipher suite names vary, depending on which TLS library is being used. For
27951 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27952 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27953 documentation for more details.
27954
27955 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27956 (again depending on the &%tls_cipher%& log selector).
27957
27958
27959 .section "Requesting and verifying client certificates" "SECID183"
27960 .cindex "certificate" "verification of client"
27961 .cindex "TLS" "client certificate verification"
27962 If you want an Exim server to request a certificate when negotiating a TLS
27963 session with a client, you must set either &%tls_verify_hosts%& or
27964 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27965 apply to all TLS connections. For any host that matches one of these options,
27966 Exim requests a certificate as part of the setup of the TLS session. The
27967 contents of the certificate are verified by comparing it with a list of
27968 expected trust-anchors or certificates.
27969 These may be the system default set (depending on library version),
27970 an explicit file or,
27971 depending on library version, a directory, identified by
27972 &%tls_verify_certificates%&.
27973
27974 A file can contain multiple certificates, concatenated end to end. If a
27975 directory is used
27976 (OpenSSL only),
27977 each certificate must be in a separate file, with a name (or a symbolic link)
27978 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27979 certificate. You can compute the relevant hash by running the command
27980 .code
27981 openssl x509 -hash -noout -in /cert/file
27982 .endd
27983 where &_/cert/file_& contains a single certificate.
27984
27985 There is no checking of names of the client against the certificate
27986 Subject Name or Subject Alternate Names.
27987
27988 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27989 what happens if the client does not supply a certificate, or if the certificate
27990 does not match any of the certificates in the collection named by
27991 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27992 attempt to set up a TLS session is aborted, and the incoming connection is
27993 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27994 session continues. ACLs that run for subsequent SMTP commands can detect the
27995 fact that no certificate was verified, and vary their actions accordingly. For
27996 example, you can insist on a certificate before accepting a message for
27997 relaying, but not when the message is destined for local delivery.
27998
27999 .vindex "&$tls_in_peerdn$&"
28000 When a client supplies a certificate (whether it verifies or not), the value of
28001 the Distinguished Name of the certificate is made available in the variable
28002 &$tls_in_peerdn$& during subsequent processing of the message.
28003
28004 .cindex "log" "distinguished name"
28005 Because it is often a long text string, it is not included in the log line or
28006 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28007 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28008 &%received_header_text%& to change the &'Received:'& header. When no
28009 certificate is supplied, &$tls_in_peerdn$& is empty.
28010
28011
28012 .section "Revoked certificates" "SECID184"
28013 .cindex "TLS" "revoked certificates"
28014 .cindex "revocation list"
28015 .cindex "certificate" "revocation list"
28016 .cindex "OCSP" "stapling"
28017 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28018 certificates are revoked. If you have such a list, you can pass it to an Exim
28019 server using the global option called &%tls_crl%& and to an Exim client using
28020 an identically named option for the &(smtp)& transport. In each case, the value
28021 of the option is expanded and must then be the name of a file that contains a
28022 CRL in PEM format.
28023 The downside is that clients have to periodically re-download a potentially huge
28024 file from every certificate authority they know of.
28025
28026 The way with most moving parts at query time is Online Certificate
28027 Status Protocol (OCSP), where the client verifies the certificate
28028 against an OCSP server run by the CA.  This lets the CA track all
28029 usage of the certs.  It requires running software with access to the
28030 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28031 is based on HTTP and can be proxied accordingly.
28032
28033 The only widespread OCSP server implementation (known to this writer)
28034 comes as part of OpenSSL and aborts on an invalid request, such as
28035 connecting to the port and then disconnecting.  This requires
28036 re-entering the passphrase each time some random client does this.
28037
28038 The third way is OCSP Stapling; in this, the server using a certificate
28039 issued by the CA periodically requests an OCSP proof of validity from
28040 the OCSP server, then serves it up inline as part of the TLS
28041 negotiation.   This approach adds no extra round trips, does not let the
28042 CA track users, scales well with number of certs issued by the CA and is
28043 resilient to temporary OCSP server failures, as long as the server
28044 starts retrying to fetch an OCSP proof some time before its current
28045 proof expires.  The downside is that it requires server support.
28046
28047 Unless Exim is built with the support disabled,
28048 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28049 support for OCSP stapling is included.
28050
28051 There is a global option called &%tls_ocsp_file%&.
28052 The file specified therein is expected to be in DER format, and contain
28053 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28054 option will be re-expanded for SNI, if the &%tls_certificate%& option
28055 contains &`tls_in_sni`&, as per other TLS options.
28056
28057 Exim does not at this time implement any support for fetching a new OCSP
28058 proof.  The burden is on the administrator to handle this, outside of
28059 Exim.  The file specified should be replaced atomically, so that the
28060 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28061 on each connection, so a new file will be handled transparently on the
28062 next connection.
28063
28064 When built with OpenSSL Exim will check for a valid next update timestamp
28065 in the OCSP proof; if not present, or if the proof has expired, it will be
28066 ignored.
28067
28068 For the client to be able to verify the stapled OCSP the server must
28069 also supply, in its stapled information, any intermediate
28070 certificates for the chain leading to the OCSP proof from the signer
28071 of the server certificate.  There may be zero or one such. These
28072 intermediate certificates should be added to the server OCSP stapling
28073 file named by &%tls_ocsp_file%&.
28074
28075 Note that the proof only covers the terminal server certificate,
28076 not any of the chain from CA to it.
28077
28078 There is no current way to staple a proof for a client certificate.
28079
28080 .code
28081   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28082   OCSP server is supplied.  The server URL may be included in the
28083   server certificate, if the CA is helpful.
28084
28085   One failure mode seen was the OCSP Signer cert expiring before the end
28086   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28087   noted this as invalid overall, but the re-fetch script did not.
28088 .endd
28089
28090
28091
28092
28093 .section "Configuring an Exim client to use TLS" "SECID185"
28094 .cindex "cipher" "logging"
28095 .cindex "log" "TLS cipher"
28096 .cindex "log" "distinguished name"
28097 .cindex "TLS" "configuring an Exim client"
28098 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28099 deliveries as well as to incoming, the latter one causing logging of the
28100 server certificate's DN. The remaining client configuration for TLS is all
28101 within the &(smtp)& transport.
28102
28103 It is not necessary to set any options to have TLS work in the &(smtp)&
28104 transport. If Exim is built with TLS support, and TLS is advertised by a
28105 server, the &(smtp)& transport always tries to start a TLS session. However,
28106 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28107 transport) to a list of server hosts for which TLS should not be used.
28108
28109 If you do not want Exim to attempt to send messages unencrypted when an attempt
28110 to set up an encrypted connection fails in any way, you can set
28111 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28112 those hosts, delivery is always deferred if an encrypted connection cannot be
28113 set up. If there are any other hosts for the address, they are tried in the
28114 usual way.
28115
28116 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28117 the message unencrypted. It always does this if the response to STARTTLS is
28118 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28119 session after a success response code, what happens is controlled by the
28120 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28121 delivery to this host is deferred, and other hosts (if available) are tried. If
28122 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28123 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28124 negotiation fails, Exim closes the current connection (because it is in an
28125 unknown state), opens a new one to the same host, and then tries the delivery
28126 unencrypted.
28127
28128 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28129 transport provide the client with a certificate, which is passed to the server
28130 if it requests it. If the server is Exim, it will request a certificate only if
28131 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28132
28133 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28134 specifies a collection of expected server certificates.
28135 These may be
28136 the system default set (depending on library version),
28137 a file,
28138 or (depending on library version) a directory.
28139 The client verifies the server's certificate
28140 against this collection, taking into account any revoked certificates that are
28141 in the list defined by &%tls_crl%&.
28142 Failure to verify fails the TLS connection unless either of the
28143 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28144
28145 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28146 certificate verification to the listed servers.  Verification either must
28147 or need not succeed respectively.
28148
28149 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28150 checks are made: that the host name (the one in the DNS A record)
28151 is valid for the certificate.
28152 The option defaults to always checking.
28153
28154 The &(smtp)& transport has two OCSP-related options:
28155 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28156 is requested and required for the connection to proceed.  The default
28157 value is empty.
28158 &%hosts_request_ocsp%&; a host-list for which (additionally)
28159 a Certificate Status is requested (but not necessarily verified).  The default
28160 value is "*" meaning that requests are made unless configured
28161 otherwise.
28162
28163 The host(s) should also be in &%hosts_require_tls%&, and
28164 &%tls_verify_certificates%& configured for the transport,
28165 for OCSP to be relevant.
28166
28167 If
28168 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28169 list of permitted cipher suites. If either of these checks fails, delivery to
28170 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28171 alternative hosts, if any.
28172
28173  &*Note*&:
28174 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28175 is operating as a client. Exim does not assume that a server certificate (set
28176 by the global options of the same name) should also be used when operating as a
28177 client.
28178
28179 .vindex "&$host$&"
28180 .vindex "&$host_address$&"
28181 All the TLS options in the &(smtp)& transport are expanded before use, with
28182 &$host$& and &$host_address$& containing the name and address of the server to
28183 which the client is connected. Forced failure of an expansion causes Exim to
28184 behave as if the relevant option were unset.
28185
28186 .vindex &$tls_out_bits$&
28187 .vindex &$tls_out_cipher$&
28188 .vindex &$tls_out_peerdn$&
28189 .vindex &$tls_out_sni$&
28190 Before an SMTP connection is established, the
28191 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28192 variables are emptied. (Until the first connection, they contain the values
28193 that were set when the message was received.) If STARTTLS is subsequently
28194 successfully obeyed, these variables are set to the relevant values for the
28195 outgoing connection.
28196
28197
28198
28199 .section "Use of TLS Server Name Indication" "SECTtlssni"
28200 .cindex "TLS" "Server Name Indication"
28201 .vindex "&$tls_in_sni$&"
28202 .oindex "&%tls_in_sni%&"
28203 With TLS1.0 or above, there is an extension mechanism by which extra
28204 information can be included at various points in the protocol.  One of these
28205 extensions, documented in RFC 6066 (and before that RFC 4366) is
28206 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28207 client in the initial handshake, so that the server can examine the servername
28208 within and possibly choose to use different certificates and keys (and more)
28209 for this session.
28210
28211 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28212 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28213 address.
28214
28215 With SMTP to MX, there are the same problems here as in choosing the identity
28216 against which to validate a certificate: you can't rely on insecure DNS to
28217 provide the identity which you then cryptographically verify.  So this will
28218 be of limited use in that environment.
28219
28220 With SMTP to Submission, there is a well-defined hostname which clients are
28221 connecting to and can validate certificates against.  Thus clients &*can*&
28222 choose to include this information in the TLS negotiation.  If this becomes
28223 wide-spread, then hosters can choose to present different certificates to
28224 different clients.  Or even negotiate different cipher suites.
28225
28226 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28227 if not empty, will be sent on a TLS session as part of the handshake.  There's
28228 nothing more to it.  Choosing a sensible value not derived insecurely is the
28229 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28230 for the lifetime of the client connection (including during authentication).
28231
28232 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28233 received from a client.
28234 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28235
28236 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28237 option (prior to expansion) then the following options will be re-expanded
28238 during TLS session handshake, to permit alternative values to be chosen:
28239
28240 .ilist
28241 &%tls_certificate%&
28242 .next
28243 &%tls_crl%&
28244 .next
28245 &%tls_privatekey%&
28246 .next
28247 &%tls_verify_certificates%&
28248 .next
28249 &%tls_ocsp_file%&
28250 .endlist
28251
28252 Great care should be taken to deal with matters of case, various injection
28253 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28254 can always be referenced; it is important to remember that &$tls_in_sni$& is
28255 arbitrary unverified data provided prior to authentication.
28256 Further, the initial certificate is loaded before SNI is arrived, so
28257 an expansion for &%tls_certificate%& must have a default which is used
28258 when &$tls_in_sni$& is empty.
28259
28260 The Exim developers are proceeding cautiously and so far no other TLS options
28261 are re-expanded.
28262
28263 When Exim is built against OpenSSL, OpenSSL must have been built with support
28264 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28265 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28266 see &`-servername`& in the output, then OpenSSL has support.
28267
28268 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28269 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28270 built, then you have SNI support).
28271
28272
28273
28274 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28275          "SECTmulmessam"
28276 .cindex "multiple SMTP deliveries with TLS"
28277 .cindex "TLS" "multiple message deliveries"
28278 Exim sends multiple messages down the same TCP/IP connection by starting up
28279 an entirely new delivery process for each message, passing the socket from
28280 one process to the next. This implementation does not fit well with the use
28281 of TLS, because there is quite a lot of state information associated with a TLS
28282 connection, not just a socket identification. Passing all the state information
28283 to a new process is not feasible. Consequently, for sending using TLS Exim
28284 starts an additional proxy process for handling the encryption, piping the
28285 unencrypted data stream from and to the delivery processes.
28286
28287 An older mode of operation can be enabled on a per-host basis by the
28288 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28289 this list the proxy process described above is not used; instead Exim
28290 shuts down an existing TLS session being run by the delivery process
28291 before passing the socket to a new process. The new process may then
28292 try to start a new TLS session, and if successful, may try to re-authenticate
28293 if AUTH is in use, before sending the next message.
28294
28295 The RFC is not clear as to whether or not an SMTP session continues in clear
28296 after TLS has been shut down, or whether TLS may be restarted again later, as
28297 just described. However, if the server is Exim, this shutdown and
28298 reinitialization works. It is not known which (if any) other servers operate
28299 successfully if the client closes a TLS session and continues with unencrypted
28300 SMTP, but there are certainly some that do not work. For such servers, Exim
28301 should not pass the socket to another process, because the failure of the
28302 subsequent attempt to use it would cause Exim to record a temporary host error,
28303 and delay other deliveries to that host.
28304
28305 To test for this case, Exim sends an EHLO command to the server after
28306 closing down the TLS session. If this fails in any way, the connection is
28307 closed instead of being passed to a new delivery process, but no retry
28308 information is recorded.
28309
28310 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28311 &(smtp)& transport to match those hosts for which Exim should not pass
28312 connections to new processes if TLS has been used.
28313
28314
28315
28316
28317 .section "Certificates and all that" "SECTcerandall"
28318 .cindex "certificate" "references to discussion"
28319 In order to understand fully how TLS works, you need to know about
28320 certificates, certificate signing, and certificate authorities.
28321 This is a large topic and an introductory guide is unsuitable for the Exim
28322 reference manual, so instead we provide pointers to existing documentation.
28323
28324 The Apache web-server was for a long time the canonical guide, so their
28325 documentation is a good place to start; their SSL module's Introduction
28326 document is currently at
28327 .display
28328 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28329 .endd
28330 and their FAQ is at
28331 .display
28332 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28333 .endd
28334
28335 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28336 0-201-61598-3) in 2001, contains both introductory and more in-depth
28337 descriptions.
28338 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28339 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28340 Ivan is the author of the popular TLS testing tools at
28341 &url(https://www.ssllabs.com/).
28342
28343
28344 .section "Certificate chains" "SECID186"
28345 The file named by &%tls_certificate%& may contain more than one
28346 certificate. This is useful in the case where the certificate that is being
28347 sent is validated by an intermediate certificate which the other end does
28348 not have. Multiple certificates must be in the correct order in the file.
28349 First the host's certificate itself, then the first intermediate
28350 certificate to validate the issuer of the host certificate, then the next
28351 intermediate certificate to validate the issuer of the first intermediate
28352 certificate, and so on, until finally (optionally) the root certificate.
28353 The root certificate must already be trusted by the recipient for
28354 validation to succeed, of course, but if it's not preinstalled, sending the
28355 root certificate along with the rest makes it available for the user to
28356 install if the receiving end is a client MUA that can interact with a user.
28357
28358 Note that certificates using MD5 are unlikely to work on today's Internet;
28359 even if your libraries allow loading them for use in Exim when acting as a
28360 server, increasingly clients will not accept such certificates.  The error
28361 diagnostics in such a case can be frustratingly vague.
28362
28363
28364
28365 .section "Self-signed certificates" "SECID187"
28366 .cindex "certificate" "self-signed"
28367 You can create a self-signed certificate using the &'req'& command provided
28368 with OpenSSL, like this:
28369 . ==== Do not shorten the duration here without reading and considering
28370 . ==== the text below.  Please leave it at 9999 days.
28371 .code
28372 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28373             -days 9999 -nodes
28374 .endd
28375 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28376 delimited and so can be identified independently. The &%-days%& option
28377 specifies a period for which the certificate is valid. The &%-nodes%& option is
28378 important: if you do not set it, the key is encrypted with a passphrase
28379 that you are prompted for, and any use that is made of the key causes more
28380 prompting for the passphrase. This is not helpful if you are going to use
28381 this certificate and key in an MTA, where prompting is not possible.
28382
28383 . ==== I expect to still be working 26 years from now.  The less technical
28384 . ==== debt I create, in terms of storing up trouble for my later years, the
28385 . ==== happier I will be then.  We really have reached the point where we
28386 . ==== should start, at the very least, provoking thought and making folks
28387 . ==== pause before proceeding, instead of leaving all the fixes until two
28388 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28389 . ==== -pdp, 2012
28390 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28391 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28392 the above command might produce a date in the past.  Think carefully about
28393 the lifetime of the systems you're deploying, and either reduce the duration
28394 of the certificate or reconsider your platform deployment.  (At time of
28395 writing, reducing the duration is the most likely choice, but the inexorable
28396 progression of time takes us steadily towards an era where this will not
28397 be a sensible resolution).
28398
28399 A self-signed certificate made in this way is sufficient for testing, and
28400 may be adequate for all your requirements if you are mainly interested in
28401 encrypting transfers, and not in secure identification.
28402
28403 However, many clients require that the certificate presented by the server be a
28404 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28405 certificate. In this situation, the self-signed certificate described above
28406 must be installed on the client host as a trusted root &'certification
28407 authority'& (CA), and the certificate used by Exim must be a user certificate
28408 signed with that self-signed certificate.
28409
28410 For information on creating self-signed CA certificates and using them to sign
28411 user certificates, see the &'General implementation overview'& chapter of the
28412 Open-source PKI book, available online at
28413 &url(https://sourceforge.net/projects/ospkibook/).
28414 .ecindex IIDencsmtp1
28415 .ecindex IIDencsmtp2
28416
28417
28418
28419 .section DANE "SECDANE"
28420 .cindex DANE
28421 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28422 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28423 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28424 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28425 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28426 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28427
28428 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28429 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28430 by (a) is thought to be smaller than that of the set of root CAs.
28431
28432 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28433 fail to pass on a server's STARTTLS.
28434
28435 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28436 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28437 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28438
28439 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28440 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28441 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28442 DNSSEC.
28443 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28444 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28445
28446 There are no changes to Exim specific to server-side operation of DANE.
28447 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28448 in &_Local/Makefile_&.
28449 If it has been included, the macro "_HAVE_DANE" will be defined.
28450
28451 The TLSA record for the server may have "certificate usage" of DANE-TA(2) or DANE-EE(3).
28452 These are the "Trust Anchor" and "End Entity" variants.
28453 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28454 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28455 this is appropriate for a single system, using a self-signed certificate.
28456 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28457 well-known one.
28458 A private CA at simplest is just a self-signed certificate (with certain
28459 attributes) which is used to sign server certificates, but running one securely
28460 does require careful arrangement.
28461 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28462 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28463 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28464 all of which point to a single TLSA record.
28465 DANE-TA and DANE-EE can both be used together.
28466
28467 .new
28468 Our recommendation is to use DANE with a certificate from a public CA,
28469 because this enables a variety of strategies for remote clients to verify
28470 your certificate.
28471 You can then publish information both via DANE and another technology,
28472 "MTA-STS", described below.
28473
28474 When you use DANE-TA to publish trust anchor information, you ask entities
28475 outside your administrative control to trust the Certificate Authority for
28476 connections to you.
28477 If using a private CA then you should expect others to still apply the
28478 technical criteria they'd use for a public CA to your certificates.
28479 In particular, you should probably try to follow current best practices for CA
28480 operation around hash algorithms and key sizes.
28481 Do not expect other organizations to lower their security expectations just
28482 because a particular profile might be reasonable for your own internal use.
28483
28484 When this text was last updated, this in practice means to avoid use of SHA-1
28485 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28486 than 4096, for interoperability); to use keyUsage fields correctly; to use
28487 random serial numbers.
28488 The list of requirements is subject to change as best practices evolve.
28489 If you're not already using a private CA, or it doesn't meet these
28490 requirements, then we encourage you to avoid all these issues and use a public
28491 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28492 .wen
28493
28494 The TLSA record should have a Selector field of SPKI(1) and a Matching Type field of SHA2-512(2).
28495
28496 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28497 is useful for quickly generating TLSA records; and commands like
28498
28499 .code
28500   openssl x509 -in -pubkey -noout <certificate.pem \
28501   | openssl rsa -outform der -pubin 2>/dev/null \
28502   | openssl sha512 \
28503   | awk '{print $2}'
28504 .endd
28505
28506 are workable for 4th-field hashes.
28507
28508 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
28509
28510 .new
28511 The Certificate issued by the CA published in the DANE-TA model should be
28512 issued using a strong hash algorithm.
28513 Exim, and importantly various other MTAs sending to you, will not
28514 re-enable hash algorithms which have been disabled by default in TLS
28515 libraries.
28516 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
28517 interoperability (and probably the maximum too, in 2018).
28518 .wen
28519
28520 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
28521 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
28522 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
28523
28524 .code
28525   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
28526                                  {= {4}{$tls_out_tlsa_usage}} } \
28527                          {*}{}}
28528 .endd
28529
28530 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
28531 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
28532 found. If the definition of &%hosts_request_ocsp%& includes the
28533 string "tls_out_tlsa_usage", they are re-expanded in time to
28534 control the OCSP request.
28535
28536 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
28537 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
28538
28539
28540 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
28541 and &%dane_require_tls_ciphers%&.
28542 The require variant will result in failure if the target host is not DNSSEC-secured.
28543
28544 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
28545
28546 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
28547 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
28548 will be required for the host.  If it does not, the host will not
28549 be used; there is no fallback to non-DANE or non-TLS.
28550
28551 If DANE is requested and usable, then the TLS cipher list configuration
28552 prefers to use the option &%dane_require_tls_ciphers%& and falls
28553 back to &%tls_require_ciphers%& only if that is unset.
28554 This lets you configure "decent crypto" for DANE and "better than nothing
28555 crypto" as the default.  Note though that while GnuTLS lets the string control
28556 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
28557 limited to ciphersuite constraints.
28558
28559 If DANE is requested and useable (see above) the following transport options are ignored:
28560 .code
28561   hosts_require_tls
28562   tls_verify_hosts
28563   tls_try_verify_hosts
28564   tls_verify_certificates
28565   tls_crl
28566   tls_verify_cert_hostnames
28567 .endd
28568
28569 If DANE is not usable, whether requested or not, and CA-anchored
28570 verification evaluation is wanted, the above variables should be set appropriately.
28571
28572 Currently the &%dnssec_request_domains%& must be active and &%dnssec_require_domains%& is ignored.
28573
28574 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
28575
28576 There is a new variable &$tls_out_dane$& which will have "yes" if
28577 verification succeeded using DANE and "no" otherwise (only useful
28578 in combination with events; see &<<CHAPevents>>&),
28579 and a new variable &$tls_out_tlsa_usage$& (detailed above).
28580
28581 .cindex DANE reporting
28582 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
28583 to achieve DANE-verified connection, if one was either requested and offered, or
28584 required.  This is intended to support TLS-reporting as defined in
28585 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
28586 The &$event_data$& will be one of the Result Types defined in
28587 Section 4.3 of that document.
28588
28589 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
28590
28591 DANE is specified in published RFCs and decouples certificate authority trust
28592 selection from a "race to the bottom" of "you must trust everything for mail
28593 to get through".  There is an alternative technology called MTA-STS, which
28594 instead publishes MX trust anchor information on an HTTPS website.  At the
28595 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
28596 Exim has no support for MTA-STS as a client, but Exim mail server operators
28597 can choose to publish information describing their TLS configuration using
28598 MTA-STS to let those clients who do use that protocol derive trust
28599 information.
28600
28601 The MTA-STS design requires a certificate from a public Certificate Authority
28602 which is recognized by clients sending to you.
28603 That selection of which CAs are trusted by others is outside your control.
28604
28605 The most interoperable course of action is probably to use
28606 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
28607 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
28608 records for DANE clients (such as Exim and Postfix) and to publish anchor
28609 information for MTA-STS as well.  This is what is done for the &'exim.org'&
28610 domain itself (with caveats around occasionally broken MTA-STS because of
28611 incompatible specification changes prior to reaching RFC status).
28612
28613
28614
28615 . ////////////////////////////////////////////////////////////////////////////
28616 . ////////////////////////////////////////////////////////////////////////////
28617
28618 .chapter "Access control lists" "CHAPACL"
28619 .scindex IIDacl "&ACL;" "description"
28620 .cindex "control of incoming mail"
28621 .cindex "message" "controlling incoming"
28622 .cindex "policy control" "access control lists"
28623 Access Control Lists (ACLs) are defined in a separate section of the run time
28624 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
28625 name, terminated by a colon. Here is a complete ACL section that contains just
28626 one very small ACL:
28627 .code
28628 begin acl
28629 small_acl:
28630   accept   hosts = one.host.only
28631 .endd
28632 You can have as many lists as you like in the ACL section, and the order in
28633 which they appear does not matter. The lists are self-terminating.
28634
28635 The majority of ACLs are used to control Exim's behaviour when it receives
28636 certain SMTP commands. This applies both to incoming TCP/IP connections, and
28637 when a local process submits a message using SMTP by specifying the &%-bs%&
28638 option. The most common use is for controlling which recipients are accepted
28639 in incoming messages. In addition, you can define an ACL that is used to check
28640 local non-SMTP messages. The default configuration file contains an example of
28641 a realistic ACL for checking RCPT commands. This is discussed in chapter
28642 &<<CHAPdefconfil>>&.
28643
28644
28645 .section "Testing ACLs" "SECID188"
28646 The &%-bh%& command line option provides a way of testing your ACL
28647 configuration locally by running a fake SMTP session with which you interact.
28648
28649
28650 .section "Specifying when ACLs are used" "SECID189"
28651 .cindex "&ACL;" "options for specifying"
28652 In order to cause an ACL to be used, you have to name it in one of the relevant
28653 options in the main part of the configuration. These options are:
28654 .cindex "AUTH" "ACL for"
28655 .cindex "DATA" "ACLs for"
28656 .cindex "ETRN" "ACL for"
28657 .cindex "EXPN" "ACL for"
28658 .cindex "HELO" "ACL for"
28659 .cindex "EHLO" "ACL for"
28660 .cindex "DKIM" "ACL for"
28661 .cindex "MAIL" "ACL for"
28662 .cindex "QUIT, ACL for"
28663 .cindex "RCPT" "ACL for"
28664 .cindex "STARTTLS, ACL for"
28665 .cindex "VRFY" "ACL for"
28666 .cindex "SMTP" "connection, ACL for"
28667 .cindex "non-SMTP messages" "ACLs for"
28668 .cindex "MIME content scanning" "ACL for"
28669 .cindex "PRDR" "ACL for"
28670
28671 .table2 140pt
28672 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
28673 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
28674 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
28675 .irow &%acl_smtp_auth%&        "ACL for AUTH"
28676 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
28677 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
28678 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
28679 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
28680 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
28681 .irow &%acl_smtp_expn%&        "ACL for EXPN"
28682 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
28683 .irow &%acl_smtp_mail%&        "ACL for MAIL"
28684 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
28685 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
28686 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
28687 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
28688 .irow &%acl_smtp_quit%&        "ACL for QUIT"
28689 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
28690 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
28691 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
28692 .endtable
28693
28694 For example, if you set
28695 .code
28696 acl_smtp_rcpt = small_acl
28697 .endd
28698 the little ACL defined above is used whenever Exim receives a RCPT command
28699 in an SMTP dialogue. The majority of policy tests on incoming messages can be
28700 done when RCPT commands arrive. A rejection of RCPT should cause the
28701 sending MTA to give up on the recipient address contained in the RCPT
28702 command, whereas rejection at other times may cause the client MTA to keep on
28703 trying to deliver the message. It is therefore recommended that you do as much
28704 testing as possible at RCPT time.
28705
28706
28707 .section "The non-SMTP ACLs" "SECID190"
28708 .cindex "non-SMTP messages" "ACLs for"
28709 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
28710 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
28711 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
28712 the state of the SMTP connection such as encryption and authentication) are not
28713 relevant and are forbidden in these ACLs. However, the sender and recipients
28714 are known, so the &%senders%& and &%sender_domains%& conditions and the
28715 &$sender_address$& and &$recipients$& variables can be used. Variables such as
28716 &$authenticated_sender$& are also available. You can specify added header lines
28717 in any of these ACLs.
28718
28719 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
28720 non-SMTP message, before any of the message has been read. (This is the
28721 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
28722 batched SMTP input, it runs after the DATA command has been reached. The
28723 result of this ACL is ignored; it cannot be used to reject a message. If you
28724 really need to, you could set a value in an ACL variable here and reject based
28725 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
28726 controls, and in particular, it can be used to set
28727 .code
28728 control = suppress_local_fixups
28729 .endd
28730 This cannot be used in the other non-SMTP ACLs because by the time they are
28731 run, it is too late.
28732
28733 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
28734 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28735
28736 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
28737 kind of rejection is treated as permanent, because there is no way of sending a
28738 temporary error for these kinds of message.
28739
28740
28741 .section "The SMTP connect ACL" "SECID191"
28742 .cindex "SMTP" "connection, ACL for"
28743 .oindex &%smtp_banner%&
28744 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
28745 session, after the test specified by &%host_reject_connection%& (which is now
28746 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
28747 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
28748 the message override the banner message that is otherwise specified by the
28749 &%smtp_banner%& option.
28750
28751
28752 .section "The EHLO/HELO ACL" "SECID192"
28753 .cindex "EHLO" "ACL for"
28754 .cindex "HELO" "ACL for"
28755 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
28756 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
28757 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
28758 Note that a client may issue more than one EHLO or HELO command in an SMTP
28759 session, and indeed is required to issue a new EHLO or HELO after successfully
28760 setting up encryption following a STARTTLS command.
28761
28762 Note also that a deny neither forces the client to go away nor means that
28763 mail will be refused on the connection.  Consider checking for
28764 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
28765
28766 If the command is accepted by an &%accept%& verb that has a &%message%&
28767 modifier, the message may not contain more than one line (it will be truncated
28768 at the first newline and a panic logged if it does). Such a message cannot
28769 affect the EHLO options that are listed on the second and subsequent lines of
28770 an EHLO response.
28771
28772
28773 .section "The DATA ACLs" "SECID193"
28774 .cindex "DATA" "ACLs for"
28775 Two ACLs are associated with the DATA command, because it is two-stage
28776 command, with two responses being sent to the client.
28777 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
28778 is obeyed. This gives you control after all the RCPT commands, but before
28779 the message itself is received. It offers the opportunity to give a negative
28780 response to the DATA command before the data is transmitted. Header lines
28781 added by MAIL or RCPT ACLs are not visible at this time, but any that
28782 are defined here are visible when the &%acl_smtp_data%& ACL is run.
28783
28784 You cannot test the contents of the message, for example, to verify addresses
28785 in the headers, at RCPT time or when the DATA command is received. Such
28786 tests have to appear in the ACL that is run after the message itself has been
28787 received, before the final response to the DATA command is sent. This is
28788 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
28789 associated with the DATA command.
28790
28791 .cindex CHUNKING "BDAT command"
28792 .cindex BDAT "SMTP command"
28793 .cindex "RFC 3030" CHUNKING
28794 If CHUNKING was advertised and a BDAT command sequence is received,
28795 the &%acl_smtp_predata%& ACL is not run.
28796 . XXX why not?  It should be possible, for the first BDAT.
28797 The &%acl_smtp_data%& is run after the last BDAT command and all of
28798 the data specified is received.
28799
28800 For both of these ACLs, it is not possible to reject individual recipients. An
28801 error response rejects the entire message. Unfortunately, it is known that some
28802 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
28803 before or after the data) correctly &-- they keep the message on their queues
28804 and try again later, but that is their problem, though it does waste some of
28805 your resources.
28806
28807 The &%acl_smtp_data%& ACL is run after
28808 the &%acl_smtp_data_prdr%&,
28809 the &%acl_smtp_dkim%&
28810 and the &%acl_smtp_mime%& ACLs.
28811
28812 .section "The SMTP DKIM ACL" "SECTDKIMACL"
28813 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
28814 enabled (which is the default).
28815
28816 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
28817 received, and is executed for each DKIM signature found in a message.  If not
28818 otherwise specified, the default action is to accept.
28819
28820 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
28821
28822 For details on the operation of DKIM, see section &<<SECDKIM>>&.
28823
28824
28825 .section "The SMTP MIME ACL" "SECID194"
28826 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
28827 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28828
28829 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28830
28831
28832 .section "The SMTP PRDR ACL" "SECTPRDRACL"
28833 .cindex "PRDR" "ACL for"
28834 .oindex "&%prdr_enable%&"
28835 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
28836 with PRDR support enabled (which is the default).
28837 It becomes active only when the PRDR feature is negotiated between
28838 client and server for a message, and more than one recipient
28839 has been accepted.
28840
28841 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
28842 has been received, and is executed once for each recipient of the message
28843 with &$local_part$& and &$domain$& valid.
28844 The test may accept, defer or deny for individual recipients.
28845 The &%acl_smtp_data%& will still be called after this ACL and
28846 can reject the message overall, even if this ACL has accepted it
28847 for some or all recipients.
28848
28849 PRDR may be used to support per-user content filtering.  Without it
28850 one must defer any recipient after the first that has a different
28851 content-filter configuration.  With PRDR, the RCPT-time check
28852 .cindex "PRDR" "variable for"
28853 for this can be disabled when the variable &$prdr_requested$&
28854 is &"yes"&.
28855 Any required difference in behaviour of the main DATA-time
28856 ACL should however depend on the PRDR-time ACL having run, as Exim
28857 will avoid doing so in some situations (e.g.  single-recipient mails).
28858
28859 See also the &%prdr_enable%& global option
28860 and the &%hosts_try_prdr%& smtp transport option.
28861
28862 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28863 If the ACL is not defined, processing completes as if
28864 the feature was not requested by the client.
28865
28866 .section "The QUIT ACL" "SECTQUITACL"
28867 .cindex "QUIT, ACL for"
28868 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
28869 does not affect the response code to QUIT, which is always 221. Thus, the ACL
28870 does not in fact control any access.
28871 For this reason, it may only accept
28872 or warn as its final result.
28873
28874 This ACL can be used for tasks such as custom logging at the end of an SMTP
28875 session. For example, you can use ACL variables in other ACLs to count
28876 messages, recipients, etc., and log the totals at QUIT time using one or
28877 more &%logwrite%& modifiers on a &%warn%& verb.
28878
28879 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
28880 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
28881
28882 You do not need to have a final &%accept%&, but if you do, you can use a
28883 &%message%& modifier to specify custom text that is sent as part of the 221
28884 response to QUIT.
28885
28886 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28887 failure (for example, failure to open a log file, or when Exim is bombing out
28888 because it has detected an unrecoverable error), all SMTP commands from the
28889 client are given temporary error responses until QUIT is received or the
28890 connection is closed. In these special cases, the QUIT ACL does not run.
28891
28892
28893 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28894 .vindex &$acl_smtp_notquit$&
28895 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28896 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28897 trouble, such as being unable to write to its log files, this ACL is not run,
28898 because it might try to do things (such as write to log files) that make the
28899 situation even worse.
28900
28901 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28902 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28903 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28904 and &%warn%&.
28905
28906 .vindex &$smtp_notquit_reason$&
28907 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28908 to a string that indicates the reason for the termination of the SMTP
28909 connection. The possible values are:
28910 .table2
28911 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28912 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28913 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28914 .irow &`connection-lost`&          "The SMTP connection has been lost"
28915 .irow &`data-timeout`&             "Timeout while reading message data"
28916 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28917 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28918 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28919 .irow &`synchronization-error`&    "SMTP synchronization error"
28920 .irow &`tls-failed`&               "TLS failed to start"
28921 .endtable
28922 In most cases when an SMTP connection is closed without having received QUIT,
28923 Exim sends an SMTP response message before actually closing the connection.
28924 With the exception of the &`acl-drop`& case, the default message can be
28925 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28926 &%drop%& verb in another ACL, it is the message from the other ACL that is
28927 used.
28928
28929
28930 .section "Finding an ACL to use" "SECID195"
28931 .cindex "&ACL;" "finding which to use"
28932 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28933 you can use different ACLs in different circumstances. For example,
28934 .code
28935 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28936                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28937 .endd
28938 In the default configuration file there are some example settings for
28939 providing an RFC 4409 message &"submission"& service on port 587 and
28940 an RFC 8314 &"submissions"& service on port 465. You can use a string
28941 expansion like this to choose an ACL for MUAs on these ports which is
28942 more appropriate for this purpose than the default ACL on port 25.
28943
28944 The expanded string does not have to be the name of an ACL in the
28945 configuration file; there are other possibilities. Having expanded the
28946 string, Exim searches for an ACL as follows:
28947
28948 .ilist
28949 If the string begins with a slash, Exim uses it as a file name, and reads its
28950 contents as an ACL. The lines are processed in the same way as lines in the
28951 Exim configuration file. In particular, continuation lines are supported, blank
28952 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28953 If the file does not exist or cannot be read, an error occurs (typically
28954 causing a temporary failure of whatever caused the ACL to be run). For example:
28955 .code
28956 acl_smtp_data = /etc/acls/\
28957   ${lookup{$sender_host_address}lsearch\
28958   {/etc/acllist}{$value}{default}}
28959 .endd
28960 This looks up an ACL file to use on the basis of the host's IP address, falling
28961 back to a default if the lookup fails. If an ACL is successfully read from a
28962 file, it is retained in memory for the duration of the Exim process, so that it
28963 can be re-used without having to re-read the file.
28964 .next
28965 If the string does not start with a slash, and does not contain any spaces,
28966 Exim searches the ACL section of the configuration for an ACL whose name
28967 matches the string.
28968 .next
28969 If no named ACL is found, or if the string contains spaces, Exim parses
28970 the string as an inline ACL. This can save typing in cases where you just
28971 want to have something like
28972 .code
28973 acl_smtp_vrfy = accept
28974 .endd
28975 in order to allow free use of the VRFY command. Such a string may contain
28976 newlines; it is processed in the same way as an ACL that is read from a file.
28977 .endlist
28978
28979
28980
28981
28982 .section "ACL return codes" "SECID196"
28983 .cindex "&ACL;" "return codes"
28984 Except for the QUIT ACL, which does not affect the SMTP return code (see
28985 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28986 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28987 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28988 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28989 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28990 This also causes a 4&'xx'& return code.
28991
28992 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28993 &"deny"&, because there is no mechanism for passing temporary errors to the
28994 submitters of non-SMTP messages.
28995
28996
28997 ACLs that are relevant to message reception may also return &"discard"&. This
28998 has the effect of &"accept"&, but causes either the entire message or an
28999 individual recipient address to be discarded. In other words, it is a
29000 blackholing facility. Use it with care.
29001
29002 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29003 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29004 RCPT ACL is to discard just the one recipient address. If there are no
29005 recipients left when the message's data is received, the DATA ACL is not
29006 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29007 remaining recipients. The &"discard"& return is not permitted for the
29008 &%acl_smtp_predata%& ACL.
29009
29010 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29011 is done on the address and the result determines the SMTP response.
29012
29013
29014 .cindex "&[local_scan()]& function" "when all recipients discarded"
29015 The &[local_scan()]& function is always run, even if there are no remaining
29016 recipients; it may create new recipients.
29017
29018
29019
29020 .section "Unset ACL options" "SECID197"
29021 .cindex "&ACL;" "unset options"
29022 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29023 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29024 not defined at all. For any defined ACL, the default action when control
29025 reaches the end of the ACL statements is &"deny"&.
29026
29027 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29028 these two are ACLs that are used only for their side effects. They cannot be
29029 used to accept or reject anything.
29030
29031 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29032 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29033 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29034 when the ACL is not defined is &"accept"&.
29035
29036 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29037 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29038 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29039 messages over an SMTP connection. For an example, see the ACL in the default
29040 configuration file.
29041
29042
29043
29044
29045 .section "Data for message ACLs" "SECID198"
29046 .cindex "&ACL;" "data for message ACL"
29047 .vindex &$domain$&
29048 .vindex &$local_part$&
29049 .vindex &$sender_address$&
29050 .vindex &$sender_host_address$&
29051 .vindex &$smtp_command$&
29052 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29053 that contain information about the host and the message's sender (for example,
29054 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29055 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29056 &$local_part$& are set from the argument address. The entire SMTP command
29057 is available in &$smtp_command$&.
29058
29059 When an ACL for the AUTH parameter of MAIL is running, the variables that
29060 contain information about the host are set, but &$sender_address$& is not yet
29061 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29062 how it is used.
29063
29064 .vindex "&$message_size$&"
29065 The &$message_size$& variable is set to the value of the SIZE parameter on
29066 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29067 that parameter is not given. The value is updated to the true message size by
29068 the time the final DATA ACL is run (after the message data has been
29069 received).
29070
29071 .vindex "&$rcpt_count$&"
29072 .vindex "&$recipients_count$&"
29073 The &$rcpt_count$& variable increases by one for each RCPT command received.
29074 The &$recipients_count$& variable increases by one each time a RCPT command is
29075 accepted, so while an ACL for RCPT is being processed, it contains the number
29076 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29077 &$rcpt_count$& contains the total number of RCPT commands, and
29078 &$recipients_count$& contains the total number of accepted recipients.
29079
29080
29081
29082
29083
29084 .section "Data for non-message ACLs" "SECTdatfornon"
29085 .cindex "&ACL;" "data for non-message ACL"
29086 .vindex &$smtp_command_argument$&
29087 .vindex &$smtp_command$&
29088 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29089 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29090 and the entire SMTP command is available in &$smtp_command$&.
29091 These variables can be tested using a &%condition%& condition. For example,
29092 here is an ACL for use with AUTH, which insists that either the session is
29093 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29094 does not permit authentication methods that use cleartext passwords on
29095 unencrypted connections.
29096 .code
29097 acl_check_auth:
29098   accept encrypted = *
29099   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29100                      {CRAM-MD5}}
29101   deny   message   = TLS encryption or CRAM-MD5 required
29102 .endd
29103 (Another way of applying this restriction is to arrange for the authenticators
29104 that use cleartext passwords not to be advertised when the connection is not
29105 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29106 option to do this.)
29107
29108
29109
29110 .section "Format of an ACL" "SECID199"
29111 .cindex "&ACL;" "format of"
29112 .cindex "&ACL;" "verbs, definition of"
29113 An individual ACL consists of a number of statements. Each statement starts
29114 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29115 Modifiers can change the way the verb operates, define error and log messages,
29116 set variables, insert delays, and vary the processing of accepted messages.
29117
29118 If all the conditions are met, the verb is obeyed. The same condition may be
29119 used (with different arguments) more than once in the same statement. This
29120 provides a means of specifying an &"and"& conjunction between conditions. For
29121 example:
29122 .code
29123 deny  dnslists = list1.example
29124       dnslists = list2.example
29125 .endd
29126 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29127 the conditions and modifiers when it reaches a condition that fails. What
29128 happens then depends on the verb (and in one case, on a special modifier). Not
29129 all the conditions make sense at every testing point. For example, you cannot
29130 test a sender address in the ACL that is run for a VRFY command.
29131
29132
29133 .section "ACL verbs" "SECID200"
29134 The ACL verbs are as follows:
29135
29136 .ilist
29137 .cindex "&%accept%& ACL verb"
29138 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29139 of the conditions are not met, what happens depends on whether &%endpass%&
29140 appears among the conditions (for syntax see below). If the failing condition
29141 is before &%endpass%&, control is passed to the next ACL statement; if it is
29142 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29143 check a RCPT command:
29144 .code
29145 accept domains = +local_domains
29146        endpass
29147        verify = recipient
29148 .endd
29149 If the recipient domain does not match the &%domains%& condition, control
29150 passes to the next statement. If it does match, the recipient is verified, and
29151 the command is accepted if verification succeeds. However, if verification
29152 fails, the ACL yields &"deny"&, because the failing condition is after
29153 &%endpass%&.
29154
29155 The &%endpass%& feature has turned out to be confusing to many people, so its
29156 use is not recommended nowadays. It is always possible to rewrite an ACL so
29157 that &%endpass%& is not needed, and it is no longer used in the default
29158 configuration.
29159
29160 .cindex "&%message%& ACL modifier" "with &%accept%&"
29161 If a &%message%& modifier appears on an &%accept%& statement, its action
29162 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29163 (when an &%accept%& verb either accepts or passes control to the next
29164 statement), &%message%& can be used to vary the message that is sent when an
29165 SMTP command is accepted. For example, in a RCPT ACL you could have:
29166 .display
29167 &`accept  `&<&'some conditions'&>
29168 &`        message = OK, I will allow you through today`&
29169 .endd
29170 You can specify an SMTP response code, optionally followed by an &"extended
29171 response code"& at the start of the message, but the first digit must be the
29172 same as would be sent by default, which is 2 for an &%accept%& verb.
29173
29174 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29175 an error message that is used when access is denied. This behaviour is retained
29176 for backward compatibility, but current &"best practice"& is to avoid the use
29177 of &%endpass%&.
29178
29179
29180 .next
29181 .cindex "&%defer%& ACL verb"
29182 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29183 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29184 &%defer%& is the same as &%deny%&, because there is no way of sending a
29185 temporary error. For a RCPT command, &%defer%& is much the same as using a
29186 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29187 be used in any ACL, and even for a recipient it might be a simpler approach.
29188
29189
29190 .next
29191 .cindex "&%deny%& ACL verb"
29192 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29193 the conditions are not met, control is passed to the next ACL statement. For
29194 example,
29195 .code
29196 deny dnslists = blackholes.mail-abuse.org
29197 .endd
29198 rejects commands from hosts that are on a DNS black list.
29199
29200
29201 .next
29202 .cindex "&%discard%& ACL verb"
29203 &%discard%&: This verb behaves like &%accept%&, except that it returns
29204 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29205 that are concerned with receiving messages. When all the conditions are true,
29206 the sending entity receives a &"success"& response. However, &%discard%& causes
29207 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29208 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29209 message's recipients are discarded. Recipients that are discarded before DATA
29210 do not appear in the log line when the &%received_recipients%& log selector is set.
29211
29212 If the &%log_message%& modifier is set when &%discard%& operates,
29213 its contents are added to the line that is automatically written to the log.
29214 The &%message%& modifier operates exactly as it does for &%accept%&.
29215
29216
29217 .next
29218 .cindex "&%drop%& ACL verb"
29219 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29220 forcibly closed after the 5&'xx'& error message has been sent. For example:
29221 .code
29222 drop   message   = I don't take more than 20 RCPTs
29223        condition = ${if > {$rcpt_count}{20}}
29224 .endd
29225 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29226 The connection is always dropped after sending a 550 response.
29227
29228 .next
29229 .cindex "&%require%& ACL verb"
29230 &%require%&: If all the conditions are met, control is passed to the next ACL
29231 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29232 example, when checking a RCPT command,
29233 .code
29234 require message = Sender did not verify
29235         verify  = sender
29236 .endd
29237 passes control to subsequent statements only if the message's sender can be
29238 verified. Otherwise, it rejects the command. Note the positioning of the
29239 &%message%& modifier, before the &%verify%& condition. The reason for this is
29240 discussed in section &<<SECTcondmodproc>>&.
29241
29242 .next
29243 .cindex "&%warn%& ACL verb"
29244 &%warn%&: If all the conditions are true, a line specified by the
29245 &%log_message%& modifier is written to Exim's main log. Control always passes
29246 to the next ACL statement. If any condition is false, the log line is not
29247 written. If an identical log line is requested several times in the same
29248 message, only one copy is actually written to the log. If you want to force
29249 duplicates to be written, use the &%logwrite%& modifier instead.
29250
29251 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29252 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29253 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29254 first failing condition. There is more about adding header lines in section
29255 &<<SECTaddheadacl>>&.
29256
29257 If any condition on a &%warn%& statement cannot be completed (that is, there is
29258 some sort of defer), the log line specified by &%log_message%& is not written.
29259 This does not include the case of a forced failure from a lookup, which
29260 is considered to be a successful completion. After a defer, no further
29261 conditions or modifiers in the &%warn%& statement are processed. The incident
29262 is logged, and the ACL continues to be processed, from the next statement
29263 onwards.
29264
29265
29266 .vindex "&$acl_verify_message$&"
29267 When one of the &%warn%& conditions is an address verification that fails, the
29268 text of the verification failure message is in &$acl_verify_message$&. If you
29269 want this logged, you must set it up explicitly. For example:
29270 .code
29271 warn   !verify = sender
29272        log_message = sender verify failed: $acl_verify_message
29273 .endd
29274 .endlist
29275
29276 At the end of each ACL there is an implicit unconditional &%deny%&.
29277
29278 As you can see from the examples above, the conditions and modifiers are
29279 written one to a line, with the first one on the same line as the verb, and
29280 subsequent ones on following lines. If you have a very long condition, you can
29281 continue it onto several physical lines by the usual backslash continuation
29282 mechanism. It is conventional to align the conditions vertically.
29283
29284
29285
29286 .section "ACL variables" "SECTaclvariables"
29287 .cindex "&ACL;" "variables"
29288 There are some special variables that can be set during ACL processing. They
29289 can be used to pass information between different ACLs, different invocations
29290 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29291 transports, and filters that are used to deliver a message. The names of these
29292 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29293 an underscore, but the remainder of the name can be any sequence of
29294 alphanumeric characters and underscores that you choose. There is no limit on
29295 the number of ACL variables. The two sets act as follows:
29296 .ilist
29297 The values of those variables whose names begin with &$acl_c$& persist
29298 throughout an SMTP connection. They are never reset. Thus, a value that is set
29299 while receiving one message is still available when receiving the next message
29300 on the same SMTP connection.
29301 .next
29302 The values of those variables whose names begin with &$acl_m$& persist only
29303 while a message is being received. They are reset afterwards. They are also
29304 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29305 .endlist
29306
29307 When a message is accepted, the current values of all the ACL variables are
29308 preserved with the message and are subsequently made available at delivery
29309 time. The ACL variables are set by a modifier called &%set%&. For example:
29310 .code
29311 accept hosts = whatever
29312        set acl_m4 = some value
29313 accept authenticated = *
29314        set acl_c_auth = yes
29315 .endd
29316 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29317 be set. If you want to set a variable without taking any action, you can use a
29318 &%warn%& verb without any other modifiers or conditions.
29319
29320 .oindex &%strict_acl_vars%&
29321 What happens if a syntactically valid but undefined ACL variable is
29322 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29323 false (the default), an empty string is substituted; if it is true, an
29324 error is generated.
29325
29326 Versions of Exim before 4.64 have a limited set of numbered variables, but
29327 their names are compatible, so there is no problem with upgrading.
29328
29329
29330 .section "Condition and modifier processing" "SECTcondmodproc"
29331 .cindex "&ACL;" "conditions; processing"
29332 .cindex "&ACL;" "modifiers; processing"
29333 An exclamation mark preceding a condition negates its result. For example:
29334 .code
29335 deny   domains = *.dom.example
29336       !verify  = recipient
29337 .endd
29338 causes the ACL to return &"deny"& if the recipient domain ends in
29339 &'dom.example'& and the recipient address cannot be verified. Sometimes
29340 negation can be used on the right-hand side of a condition. For example, these
29341 two statements are equivalent:
29342 .code
29343 deny  hosts = !192.168.3.4
29344 deny !hosts =  192.168.3.4
29345 .endd
29346 However, for many conditions (&%verify%& being a good example), only left-hand
29347 side negation of the whole condition is possible.
29348
29349 The arguments of conditions and modifiers are expanded. A forced failure
29350 of an expansion causes a condition to be ignored, that is, it behaves as if the
29351 condition is true. Consider these two statements:
29352 .code
29353 accept  senders = ${lookup{$host_name}lsearch\
29354                   {/some/file}{$value}fail}
29355 accept  senders = ${lookup{$host_name}lsearch\
29356                   {/some/file}{$value}{}}
29357 .endd
29358 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29359 the returned list is searched, but if the lookup fails the behaviour is
29360 different in the two cases. The &%fail%& in the first statement causes the
29361 condition to be ignored, leaving no further conditions. The &%accept%& verb
29362 therefore succeeds. The second statement, however, generates an empty list when
29363 the lookup fails. No sender can match an empty list, so the condition fails,
29364 and therefore the &%accept%& also fails.
29365
29366 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29367 specify actions that are taken as the conditions for a statement are checked;
29368 others specify text for messages that are used when access is denied or a
29369 warning is generated. The &%control%& modifier affects the way an incoming
29370 message is handled.
29371
29372 The positioning of the modifiers in an ACL statement is important, because the
29373 processing of a verb ceases as soon as its outcome is known. Only those
29374 modifiers that have already been encountered will take effect. For example,
29375 consider this use of the &%message%& modifier:
29376 .code
29377 require message = Can't verify sender
29378         verify  = sender
29379         message = Can't verify recipient
29380         verify  = recipient
29381         message = This message cannot be used
29382 .endd
29383 If sender verification fails, Exim knows that the result of the statement is
29384 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29385 so its text is used as the error message. If sender verification succeeds, but
29386 recipient verification fails, the second message is used. If recipient
29387 verification succeeds, the third message becomes &"current"&, but is never used
29388 because there are no more conditions to cause failure.
29389
29390 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29391 modifier that is used, because all the conditions must be true for rejection to
29392 happen. Specifying more than one &%message%& modifier does not make sense, and
29393 the message can even be specified after all the conditions. For example:
29394 .code
29395 deny   hosts = ...
29396       !senders = *@my.domain.example
29397        message = Invalid sender from client host
29398 .endd
29399 The &"deny"& result does not happen until the end of the statement is reached,
29400 by which time Exim has set up the message.
29401
29402
29403
29404 .section "ACL modifiers" "SECTACLmodi"
29405 .cindex "&ACL;" "modifiers; list of"
29406 The ACL modifiers are as follows:
29407
29408 .vlist
29409 .vitem &*add_header*&&~=&~<&'text'&>
29410 This modifier specifies one or more header lines that are to be added to an
29411 incoming message, assuming, of course, that the message is ultimately
29412 accepted. For details, see section &<<SECTaddheadacl>>&.
29413
29414 .vitem &*continue*&&~=&~<&'text'&>
29415 .cindex "&%continue%& ACL modifier"
29416 .cindex "database" "updating in ACL"
29417 This modifier does nothing of itself, and processing of the ACL always
29418 continues with the next condition or modifier. The value of &%continue%& is in
29419 the side effects of expanding its argument. Typically this could be used to
29420 update a database. It is really just a syntactic tidiness, to avoid having to
29421 write rather ugly lines like this:
29422 .display
29423 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29424 .endd
29425 Instead, all you need is
29426 .display
29427 &`continue = `&<&'some expansion'&>
29428 .endd
29429
29430 .vitem &*control*&&~=&~<&'text'&>
29431 .cindex "&%control%& ACL modifier"
29432 This modifier affects the subsequent processing of the SMTP connection or of an
29433 incoming message that is accepted. The effect of the first type of control
29434 lasts for the duration of the connection, whereas the effect of the second type
29435 lasts only until the current message has been received. The message-specific
29436 controls always apply to the whole message, not to individual recipients,
29437 even if the &%control%& modifier appears in a RCPT ACL.
29438
29439 As there are now quite a few controls that can be applied, they are described
29440 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29441 in several different ways. For example:
29442
29443 . ==== As this is a nested list, any displays it contains must be indented
29444 . ==== as otherwise they are too far to the left. That comment applies only
29445 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29446 . ==== way.
29447
29448 .ilist
29449 It can be at the end of an &%accept%& statement:
29450 .code
29451     accept  ...some conditions
29452             control = queue_only
29453 .endd
29454 In this case, the control is applied when this statement yields &"accept"&, in
29455 other words, when the conditions are all true.
29456
29457 .next
29458 It can be in the middle of an &%accept%& statement:
29459 .code
29460     accept  ...some conditions...
29461             control = queue_only
29462             ...some more conditions...
29463 .endd
29464 If the first set of conditions are true, the control is applied, even if the
29465 statement does not accept because one of the second set of conditions is false.
29466 In this case, some subsequent statement must yield &"accept"& for the control
29467 to be relevant.
29468
29469 .next
29470 It can be used with &%warn%& to apply the control, leaving the
29471 decision about accepting or denying to a subsequent verb. For
29472 example:
29473 .code
29474     warn    ...some conditions...
29475             control = freeze
29476     accept  ...
29477 .endd
29478 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29479 &%logwrite%&, so it does not add anything to the message and does not write a
29480 log entry.
29481
29482 .next
29483 If you want to apply a control unconditionally, you can use it with a
29484 &%require%& verb. For example:
29485 .code
29486     require  control = no_multiline_responses
29487 .endd
29488 .endlist
29489
29490 .vitem &*delay*&&~=&~<&'time'&>
29491 .cindex "&%delay%& ACL modifier"
29492 .oindex "&%-bh%&"
29493 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29494 the time interval before proceeding. However, when testing Exim using the
29495 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29496 output instead). The time is given in the usual Exim notation, and the delay
29497 happens as soon as the modifier is processed. In an SMTP session, pending
29498 output is flushed before the delay is imposed.
29499
29500 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29501 example:
29502 .code
29503 deny    ...some conditions...
29504         delay = 30s
29505 .endd
29506 The delay happens if all the conditions are true, before the statement returns
29507 &"deny"&. Compare this with:
29508 .code
29509 deny    delay = 30s
29510         ...some conditions...
29511 .endd
29512 which waits for 30s before processing the conditions. The &%delay%& modifier
29513 can also be used with &%warn%& and together with &%control%&:
29514 .code
29515 warn    ...some conditions...
29516         delay = 2m
29517         control = freeze
29518 accept  ...
29519 .endd
29520
29521 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
29522 responses to several commands are no longer buffered and sent in one packet (as
29523 they would normally be) because all output is flushed before imposing the
29524 delay. This optimization is disabled so that a number of small delays do not
29525 appear to the client as one large aggregated delay that might provoke an
29526 unwanted timeout. You can, however, disable output flushing for &%delay%& by
29527 using a &%control%& modifier to set &%no_delay_flush%&.
29528
29529
29530 .vitem &*endpass*&
29531 .cindex "&%endpass%& ACL modifier"
29532 This modifier, which has no argument, is recognized only in &%accept%& and
29533 &%discard%& statements. It marks the boundary between the conditions whose
29534 failure causes control to pass to the next statement, and the conditions whose
29535 failure causes the ACL to return &"deny"&. This concept has proved to be
29536 confusing to some people, so the use of &%endpass%& is no longer recommended as
29537 &"best practice"&. See the description of &%accept%& above for more details.
29538
29539
29540 .vitem &*log_message*&&~=&~<&'text'&>
29541 .cindex "&%log_message%& ACL modifier"
29542 This modifier sets up a message that is used as part of the log message if the
29543 ACL denies access or a &%warn%& statement's conditions are true. For example:
29544 .code
29545 require log_message = wrong cipher suite $tls_in_cipher
29546         encrypted   = DES-CBC3-SHA
29547 .endd
29548 &%log_message%& is also used when recipients are discarded by &%discard%&. For
29549 example:
29550 .display
29551 &`discard `&<&'some conditions'&>
29552 &`        log_message = Discarded $local_part@$domain because...`&
29553 .endd
29554 When access is denied, &%log_message%& adds to any underlying error message
29555 that may exist because of a condition failure. For example, while verifying a
29556 recipient address, a &':fail:'& redirection might have already set up a
29557 message.
29558
29559 The message may be defined before the conditions to which it applies, because
29560 the string expansion does not happen until Exim decides that access is to be
29561 denied. This means that any variables that are set by the condition are
29562 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
29563 variables are set after a DNS black list lookup succeeds. If the expansion of
29564 &%log_message%& fails, or if the result is an empty string, the modifier is
29565 ignored.
29566
29567 .vindex "&$acl_verify_message$&"
29568 If you want to use a &%warn%& statement to log the result of an address
29569 verification, you can use &$acl_verify_message$& to include the verification
29570 error message.
29571
29572 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
29573 the start of the logged message. If the same warning log message is requested
29574 more than once while receiving  a single email message, only one copy is
29575 actually logged. If you want to log multiple copies, use &%logwrite%& instead
29576 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
29577 is logged for a successful &%warn%& statement.
29578
29579 If &%log_message%& is not present and there is no underlying error message (for
29580 example, from the failure of address verification), but &%message%& is present,
29581 the &%message%& text is used for logging rejections. However, if any text for
29582 logging contains newlines, only the first line is logged. In the absence of
29583 both &%log_message%& and &%message%&, a default built-in message is used for
29584 logging rejections.
29585
29586
29587 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
29588 .cindex "&%log_reject_target%& ACL modifier"
29589 .cindex "logging in ACL" "specifying which log"
29590 This modifier makes it possible to specify which logs are used for messages
29591 about ACL rejections. Its argument is a colon-separated list of words that can
29592 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
29593 may be empty, in which case a rejection is not logged at all. For example, this
29594 ACL fragment writes no logging information when access is denied:
29595 .display
29596 &`deny `&<&'some conditions'&>
29597 &`     log_reject_target =`&
29598 .endd
29599 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
29600 permanent and temporary rejections. Its effect lasts for the rest of the
29601 current ACL.
29602
29603
29604 .vitem &*logwrite*&&~=&~<&'text'&>
29605 .cindex "&%logwrite%& ACL modifier"
29606 .cindex "logging in ACL" "immediate"
29607 This modifier writes a message to a log file as soon as it is encountered when
29608 processing an ACL. (Compare &%log_message%&, which, except in the case of
29609 &%warn%& and &%discard%&, is used only if the ACL statement denies
29610 access.) The &%logwrite%& modifier can be used to log special incidents in
29611 ACLs. For example:
29612 .display
29613 &`accept `&<&'some special conditions'&>
29614 &`       control  = freeze`&
29615 &`       logwrite = froze message because ...`&
29616 .endd
29617 By default, the message is written to the main log. However, it may begin
29618 with a colon, followed by a comma-separated list of log names, and then
29619 another colon, to specify exactly which logs are to be written. For
29620 example:
29621 .code
29622 logwrite = :main,reject: text for main and reject logs
29623 logwrite = :panic: text for panic log only
29624 .endd
29625
29626
29627 .vitem &*message*&&~=&~<&'text'&>
29628 .cindex "&%message%& ACL modifier"
29629 This modifier sets up a text string that is expanded and used as a response
29630 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
29631 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
29632 there is some complication if &%endpass%& is involved; see the description of
29633 &%accept%& for details.)
29634
29635 The expansion of the message happens at the time Exim decides that the ACL is
29636 to end, not at the time it processes &%message%&. If the expansion fails, or
29637 generates an empty string, the modifier is ignored. Here is an example where
29638 &%message%& must be specified first, because the ACL ends with a rejection if
29639 the &%hosts%& condition fails:
29640 .code
29641 require  message = Host not recognized
29642          hosts = 10.0.0.0/8
29643 .endd
29644 (Once a condition has failed, no further conditions or modifiers are
29645 processed.)
29646
29647 .cindex "SMTP" "error codes"
29648 .oindex "&%smtp_banner%&
29649 For ACLs that are triggered by SMTP commands, the message is returned as part
29650 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
29651 is meaningful only for SMTP, as no message is returned when a non-SMTP message
29652 is accepted. In the case of the connect ACL, accepting with a message modifier
29653 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
29654 accept message may not contain more than one line (otherwise it will be
29655 truncated at the first newline and a panic logged), and it cannot affect the
29656 EHLO options.
29657
29658 When SMTP is involved, the message may begin with an overriding response code,
29659 consisting of three digits optionally followed by an &"extended response code"&
29660 of the form &'n.n.n'&, each code being followed by a space. For example:
29661 .code
29662 deny  message = 599 1.2.3 Host not welcome
29663       hosts = 192.168.34.0/24
29664 .endd
29665 The first digit of the supplied response code must be the same as would be sent
29666 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
29667 access, but for the predata ACL, note that the default success code is 354, not
29668 2&'xx'&.
29669
29670 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
29671 the message modifier cannot override the 221 response code.
29672
29673 The text in a &%message%& modifier is literal; any quotes are taken as
29674 literals, but because the string is expanded, backslash escapes are processed
29675 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
29676 response.
29677
29678 .vindex "&$acl_verify_message$&"
29679 For ACLs that are called by an &%acl =%& ACL condition, the message is
29680 stored in &$acl_verify_message$&, from which the calling ACL may use it.
29681
29682 If &%message%& is used on a statement that verifies an address, the message
29683 specified overrides any message that is generated by the verification process.
29684 However, the original message is available in the variable
29685 &$acl_verify_message$&, so you can incorporate it into your message if you
29686 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
29687 routers to be passed back as part of the SMTP response, you should either not
29688 use a &%message%& modifier, or make use of &$acl_verify_message$&.
29689
29690 For compatibility with previous releases of Exim, a &%message%& modifier that
29691 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
29692 modifier, but this usage is now deprecated. However, &%message%& acts only when
29693 all the conditions are true, wherever it appears in an ACL command, whereas
29694 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
29695 &%warn%& in an ACL that is not concerned with receiving a message, it has no
29696 effect.
29697
29698
29699 .vitem &*queue*&&~=&~<&'text'&>
29700 .cindex "&%queue%& ACL modifier"
29701 .cindex "named queues" "selecting in ACL"
29702 This modifier specifies the use of a named queue for spool files
29703 for the message.
29704 It can only be used before the message is received (i.e. not in
29705 the DATA ACL).
29706 This could be used, for example, for known high-volume burst sources
29707 of traffic, or for quarantine of messages.
29708 Separate queue-runner processes will be needed for named queues.
29709 If the text after expansion is empty, the default queue is used.
29710
29711
29712 .vitem &*remove_header*&&~=&~<&'text'&>
29713 This modifier specifies one or more header names in a colon-separated list
29714  that are to be removed from an incoming message, assuming, of course, that
29715 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
29716
29717
29718 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
29719 .cindex "&%set%& ACL modifier"
29720 This modifier puts a value into one of the ACL variables (see section
29721 &<<SECTaclvariables>>&).
29722
29723
29724 .vitem &*udpsend*&&~=&~<&'parameters'&>
29725 .cindex "UDP communications"
29726 This modifier sends a UDP packet, for purposes such as statistics
29727 collection or behaviour monitoring. The parameters are expanded, and
29728 the result of the expansion must be a colon-separated list consisting
29729 of a destination server, port number, and the packet contents. The
29730 server can be specified as a host name or IPv4 or IPv6 address. The
29731 separator can be changed with the usual angle bracket syntax. For
29732 example, you might want to collect information on which hosts connect
29733 when:
29734 .code
29735 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
29736              $tod_zulu $sender_host_address
29737 .endd
29738 .endlist
29739
29740
29741
29742
29743 .section "Use of the control modifier" "SECTcontrols"
29744 .cindex "&%control%& ACL modifier"
29745 The &%control%& modifier supports the following settings:
29746
29747 .vlist
29748 .vitem &*control&~=&~allow_auth_unadvertised*&
29749 This modifier allows a client host to use the SMTP AUTH command even when it
29750 has not been advertised in response to EHLO. Furthermore, because there are
29751 apparently some really broken clients that do this, Exim will accept AUTH after
29752 HELO (rather than EHLO) when this control is set. It should be used only if you
29753 really need it, and you should limit its use to those broken clients that do
29754 not work without it. For example:
29755 .code
29756 warn hosts   = 192.168.34.25
29757      control = allow_auth_unadvertised
29758 .endd
29759 Normally, when an Exim server receives an AUTH command, it checks the name of
29760 the authentication mechanism that is given in the command to ensure that it
29761 matches an advertised mechanism. When this control is set, the check that a
29762 mechanism has been advertised is bypassed. Any configured mechanism can be used
29763 by the client. This control is permitted only in the connection and HELO ACLs.
29764
29765
29766 .vitem &*control&~=&~caseful_local_part*& &&&
29767        &*control&~=&~caselower_local_part*&
29768 .cindex "&ACL;" "case of local part in"
29769 .cindex "case of local parts"
29770 .vindex "&$local_part$&"
29771 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
29772 (that is, during RCPT processing). By default, the contents of &$local_part$&
29773 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
29774 any uppercase letters in the original local part are restored in &$local_part$&
29775 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
29776 is encountered.
29777
29778 These controls affect only the current recipient. Moreover, they apply only to
29779 local part handling that takes place directly in the ACL (for example, as a key
29780 in lookups). If a test to verify the recipient is obeyed, the case-related
29781 handling of the local part during the verification is controlled by the router
29782 configuration (see the &%caseful_local_part%& generic router option).
29783
29784 This facility could be used, for example, to add a spam score to local parts
29785 containing upper case letters. For example, using &$acl_m4$& to accumulate the
29786 spam score:
29787 .code
29788 warn  control = caseful_local_part
29789       set acl_m4 = ${eval:\
29790                      $acl_m4 + \
29791                      ${if match{$local_part}{[A-Z]}{1}{0}}\
29792                     }
29793       control = caselower_local_part
29794 .endd
29795 Notice that we put back the lower cased version afterwards, assuming that
29796 is what is wanted for subsequent tests.
29797
29798
29799 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
29800 .cindex "&ACL;" "cutthrough routing"
29801 .cindex "cutthrough" "requesting"
29802 This option requests delivery be attempted while the item is being received.
29803
29804 The option is usable in the RCPT ACL.
29805 If enabled for a message received via smtp and routed to an smtp transport,
29806 and only one transport, interface, destination host and port combination
29807 is used for all recipients of the message,
29808 then the delivery connection is made while the receiving connection is open
29809 and data is copied from one to the other.
29810
29811 An attempt to set this option for any recipient but the first
29812 for a mail will be quietly ignored.
29813 If a recipient-verify callout
29814 (with use_sender)
29815 connection is subsequently
29816 requested in the same ACL it is held open and used for
29817 any subsequent recipients and the data,
29818 otherwise one is made after the initial RCPT ACL completes.
29819
29820 Note that routers are used in verify mode,
29821 and cannot depend on content of received headers.
29822 Note also that headers cannot be
29823 modified by any of the post-data ACLs (DATA, MIME and DKIM).
29824 Headers may be modified by routers (subject to the above) and transports.
29825 The &'Received-By:'& header is generated as soon as the body reception starts,
29826 rather than the traditional time after the full message is received;
29827 this will affect the timestamp.
29828
29829 All the usual ACLs are called; if one results in the message being
29830 rejected, all effort spent in delivery (including the costs on
29831 the ultimate destination) will be wasted.
29832 Note that in the case of data-time ACLs this includes the entire
29833 message body.
29834
29835 Cutthrough delivery is not supported via transport-filters or when DKIM signing
29836 of outgoing messages is done, because it sends data to the ultimate destination
29837 before the entire message has been received from the source.
29838 It is not supported for messages received with the SMTP PRDR
29839 or CHUNKING
29840 options in use.
29841
29842 Should the ultimate destination system positively accept or reject the mail,
29843 a corresponding indication is given to the source system and nothing is queued.
29844 If the item is successfully delivered in cutthrough mode
29845 the delivery log lines are tagged with ">>" rather than "=>" and appear
29846 before the acceptance "<=" line.
29847
29848 If there is a temporary error the item is queued for later delivery in the
29849 usual fashion.
29850 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
29851 to the control; the default value is &"spool"& and the alternate value
29852 &"pass"& copies an SMTP defer response from the target back to the initiator
29853 and does not queue the message.
29854 Note that this is independent of any recipient verify conditions in the ACL.
29855
29856 Delivery in this mode avoids the generation of a bounce mail to a
29857 (possibly faked)
29858 sender when the destination system is doing content-scan based rejection.
29859
29860
29861 .vitem &*control&~=&~debug/*&<&'options'&>
29862 .cindex "&ACL;" "enabling debug logging"
29863 .cindex "debugging" "enabling from an ACL"
29864 This control turns on debug logging, almost as though Exim had been invoked
29865 with &`-d`&, with the output going to a new logfile in the usual logs directory,
29866 by default called &'debuglog'&.
29867 The filename can be adjusted with the &'tag'& option, which
29868 may access any variables already defined.  The logging may be adjusted with
29869 the &'opts'& option, which takes the same values as the &`-d`& command-line
29870 option.
29871 Logging started this way may be stopped, and the file removed,
29872 with the &'kill'& option.
29873 Some examples (which depend on variables that don't exist in all
29874 contexts):
29875 .code
29876       control = debug
29877       control = debug/tag=.$sender_host_address
29878       control = debug/opts=+expand+acl
29879       control = debug/tag=.$message_exim_id/opts=+expand
29880       control = debug/kill
29881 .endd
29882
29883
29884 .vitem &*control&~=&~dkim_disable_verify*&
29885 .cindex "disable DKIM verify"
29886 .cindex "DKIM" "disable verify"
29887 This control turns off DKIM verification processing entirely.  For details on
29888 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
29889
29890
29891 .vitem &*control&~=&~dscp/*&<&'value'&>
29892 .cindex "&ACL;" "setting DSCP value"
29893 .cindex "DSCP" "inbound"
29894 This option causes the DSCP value associated with the socket for the inbound
29895 connection to be adjusted to a given value, given as one of a number of fixed
29896 strings or to numeric value.
29897 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29898 Common values include &`throughput`&, &`mincost`&, and on newer systems
29899 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29900
29901 The outbound packets from Exim will be marked with this value in the header
29902 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29903 that these values will have any effect, not be stripped by networking
29904 equipment, or do much of anything without cooperation with your Network
29905 Engineer and those of all network operators between the source and destination.
29906
29907
29908 .vitem &*control&~=&~enforce_sync*& &&&
29909        &*control&~=&~no_enforce_sync*&
29910 .cindex "SMTP" "synchronization checking"
29911 .cindex "synchronization checking in SMTP"
29912 These controls make it possible to be selective about when SMTP synchronization
29913 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29914 state of the switch (it is true by default). See the description of this option
29915 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29916
29917 The effect of these two controls lasts for the remainder of the SMTP
29918 connection. They can appear in any ACL except the one for the non-SMTP
29919 messages. The most straightforward place to put them is in the ACL defined by
29920 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29921 before the first synchronization check. The expected use is to turn off the
29922 synchronization checks for badly-behaved hosts that you nevertheless need to
29923 work with.
29924
29925
29926 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29927 .cindex "fake defer"
29928 .cindex "defer, fake"
29929 This control works in exactly the same way as &%fakereject%& (described below)
29930 except that it causes an SMTP 450 response after the message data instead of a
29931 550 response. You must take care when using &%fakedefer%& because it causes the
29932 messages to be duplicated when the sender retries. Therefore, you should not
29933 use &%fakedefer%& if the message is to be delivered normally.
29934
29935 .vitem &*control&~=&~fakereject/*&<&'message'&>
29936 .cindex "fake rejection"
29937 .cindex "rejection, fake"
29938 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29939 words, only when an SMTP message is being received. If Exim accepts the
29940 message, instead the final 250 response, a 550 rejection message is sent.
29941 However, Exim proceeds to deliver the message as normal. The control applies
29942 only to the current message, not to any subsequent ones that may be received in
29943 the same SMTP connection.
29944
29945 The text for the 550 response is taken from the &%control%& modifier. If no
29946 message is supplied, the following is used:
29947 .code
29948 550-Your message has been rejected but is being
29949 550-kept for evaluation.
29950 550-If it was a legitimate message, it may still be
29951 550 delivered to the target recipient(s).
29952 .endd
29953 This facility should be used with extreme caution.
29954
29955 .vitem &*control&~=&~freeze*&
29956 .cindex "frozen messages" "forcing in ACL"
29957 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29958 other words, only when a message is being received. If the message is accepted,
29959 it is placed on Exim's queue and frozen. The control applies only to the
29960 current message, not to any subsequent ones that may be received in the same
29961 SMTP connection.
29962
29963 This modifier can optionally be followed by &`/no_tell`&. If the global option
29964 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29965 is told about the freezing), provided all the &*control=freeze*& modifiers that
29966 are obeyed for the current message have the &`/no_tell`& option.
29967
29968 .vitem &*control&~=&~no_delay_flush*&
29969 .cindex "SMTP" "output flushing, disabling for delay"
29970 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29971 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29972 use. This control, as long as it is encountered before the &%delay%& modifier,
29973 disables such output flushing.
29974
29975 .vitem &*control&~=&~no_callout_flush*&
29976 .cindex "SMTP" "output flushing, disabling for callout"
29977 Exim normally flushes SMTP output before performing a callout in an ACL, to
29978 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29979 use. This control, as long as it is encountered before the &%verify%& condition
29980 that causes the callout, disables such output flushing.
29981
29982 .vitem &*control&~=&~no_mbox_unspool*&
29983 This control is available when Exim is compiled with the content scanning
29984 extension. Content scanning may require a copy of the current message, or parts
29985 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29986 or spam scanner. Normally, such copies are deleted when they are no longer
29987 needed. If this control is set, the copies are not deleted. The control applies
29988 only to the current message, not to any subsequent ones that may be received in
29989 the same SMTP connection. It is provided for debugging purposes and is unlikely
29990 to be useful in production.
29991
29992 .vitem &*control&~=&~no_multiline_responses*&
29993 .cindex "multiline responses, suppressing"
29994 This control is permitted for any ACL except the one for non-SMTP messages.
29995 It seems that there are broken clients in use that cannot handle multiline
29996 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29997
29998 If this control is set, multiline SMTP responses from ACL rejections are
29999 suppressed. One way of doing this would have been to put out these responses as
30000 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30001 (&"use multiline responses for more"& it says &-- ha!), and some of the
30002 responses might get close to that. So this facility, which is after all only a
30003 sop to broken clients, is implemented by doing two very easy things:
30004
30005 .ilist
30006 Extra information that is normally output as part of a rejection caused by
30007 sender verification failure is omitted. Only the final line (typically &"sender
30008 verification failed"&) is sent.
30009 .next
30010 If a &%message%& modifier supplies a multiline response, only the first
30011 line is output.
30012 .endlist
30013
30014 The setting of the switch can, of course, be made conditional on the
30015 calling host. Its effect lasts until the end of the SMTP connection.
30016
30017 .vitem &*control&~=&~no_pipelining*&
30018 .cindex "PIPELINING" "suppressing advertising"
30019 This control turns off the advertising of the PIPELINING extension to SMTP in
30020 the current session. To be useful, it must be obeyed before Exim sends its
30021 response to an EHLO command. Therefore, it should normally appear in an ACL
30022 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30023 &%pipelining_advertise_hosts%&.
30024
30025 .vitem &*control&~=&~queue_only*&
30026 .oindex "&%queue_only%&"
30027 .cindex "queueing incoming messages"
30028 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30029 other words, only when a message is being received. If the message is accepted,
30030 it is placed on Exim's queue and left there for delivery by a subsequent queue
30031 runner. No immediate delivery process is started. In other words, it has the
30032 effect as the &%queue_only%& global option. However, the control applies only
30033 to the current message, not to any subsequent ones that may be received in the
30034 same SMTP connection.
30035
30036 .vitem &*control&~=&~submission/*&<&'options'&>
30037 .cindex "message" "submission"
30038 .cindex "submission mode"
30039 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30040 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30041 the current message is a submission from a local MUA. In this case, Exim
30042 operates in &"submission mode"&, and applies certain fixups to the message if
30043 necessary. For example, it adds a &'Date:'& header line if one is not present.
30044 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30045 late (the message has already been created).
30046
30047 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30048 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30049 submission mode; the available options for this control are described there.
30050 The control applies only to the current message, not to any subsequent ones
30051 that may be received in the same SMTP connection.
30052
30053 .vitem &*control&~=&~suppress_local_fixups*&
30054 .cindex "submission fixups, suppressing"
30055 This control applies to locally submitted (non TCP/IP) messages, and is the
30056 complement of &`control = submission`&. It disables the fixups that are
30057 normally applied to locally-submitted messages. Specifically:
30058
30059 .ilist
30060 Any &'Sender:'& header line is left alone (in this respect, it is a
30061 dynamic version of &%local_sender_retain%&).
30062 .next
30063 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30064 .next
30065 There is no check that &'From:'& corresponds to the actual sender.
30066 .endlist ilist
30067
30068 This control may be useful when a remotely-originated message is accepted,
30069 passed to some scanning program, and then re-submitted for delivery. It can be
30070 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30071 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30072 data is read.
30073
30074 &*Note:*& This control applies only to the current message, not to any others
30075 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30076
30077 .vitem &*control&~=&~utf8_downconvert*&
30078 This control enables conversion of UTF-8 in message addresses
30079 to a-label form.
30080 For details see section &<<SECTi18nMTA>>&.
30081 .endlist vlist
30082
30083
30084 .section "Summary of message fixup control" "SECTsummesfix"
30085 All four possibilities for message fixups can be specified:
30086
30087 .ilist
30088 Locally submitted, fixups applied: the default.
30089 .next
30090 Locally submitted, no fixups applied: use
30091 &`control = suppress_local_fixups`&.
30092 .next
30093 Remotely submitted, no fixups applied: the default.
30094 .next
30095 Remotely submitted, fixups applied: use &`control = submission`&.
30096 .endlist
30097
30098
30099
30100 .section "Adding header lines in ACLs" "SECTaddheadacl"
30101 .cindex "header lines" "adding in an ACL"
30102 .cindex "header lines" "position of added lines"
30103 .cindex "&%add_header%& ACL modifier"
30104 The &%add_header%& modifier can be used to add one or more extra header lines
30105 to an incoming message, as in this example:
30106 .code
30107 warn dnslists = sbl.spamhaus.org : \
30108                 dialup.mail-abuse.org
30109      add_header = X-blacklisted-at: $dnslist_domain
30110 .endd
30111 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30112 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30113 receiving a message). The message must ultimately be accepted for
30114 &%add_header%& to have any significant effect. You can use &%add_header%& with
30115 any ACL verb, including &%deny%& (though this is potentially useful only in a
30116 RCPT ACL).
30117
30118 Headers will not be added to the message if the modifier is used in
30119 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30120
30121 Leading and trailing newlines are removed from
30122 the data for the &%add_header%& modifier; if it then
30123 contains one or more newlines that
30124 are not followed by a space or a tab, it is assumed to contain multiple header
30125 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30126 front of any line that is not a valid header line.
30127
30128 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30129 They are added to the message before processing the DATA and MIME ACLs.
30130 However, if an identical header line is requested more than once, only one copy
30131 is actually added to the message. Further header lines may be accumulated
30132 during the DATA and MIME ACLs, after which they are added to the message, again
30133 with duplicates suppressed. Thus, it is possible to add two identical header
30134 lines to an SMTP message, but only if one is added before DATA and one after.
30135 In the case of non-SMTP messages, new headers are accumulated during the
30136 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30137 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30138 are included in the entry that is written to the reject log.
30139
30140 .cindex "header lines" "added; visibility of"
30141 Header lines are not visible in string expansions
30142 of message headers
30143 until they are added to the
30144 message. It follows that header lines defined in the MAIL, RCPT, and predata
30145 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30146 header lines that are added by the DATA or MIME ACLs are not visible in those
30147 ACLs. Because of this restriction, you cannot use header lines as a way of
30148 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30149 this, you can use ACL variables, as described in section
30150 &<<SECTaclvariables>>&.
30151
30152 The list of headers yet to be added is given by the &%$headers_added%& variable.
30153
30154 The &%add_header%& modifier acts immediately as it is encountered during the
30155 processing of an ACL. Notice the difference between these two cases:
30156 .display
30157 &`accept add_header = ADDED: some text`&
30158 &`       `&<&'some condition'&>
30159
30160 &`accept `&<&'some condition'&>
30161 &`       add_header = ADDED: some text`&
30162 .endd
30163 In the first case, the header line is always added, whether or not the
30164 condition is true. In the second case, the header line is added only if the
30165 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30166 ACL statement. All those that are encountered before a condition fails are
30167 honoured.
30168
30169 .cindex "&%warn%& ACL verb"
30170 For compatibility with previous versions of Exim, a &%message%& modifier for a
30171 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30172 effect only if all the conditions are true, even if it appears before some of
30173 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30174 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30175 are present on a &%warn%& verb, both are processed according to their
30176 specifications.
30177
30178 By default, new header lines are added to a message at the end of the existing
30179 header lines. However, you can specify that any particular header line should
30180 be added right at the start (before all the &'Received:'& lines), immediately
30181 after the first block of &'Received:'& lines, or immediately before any line
30182 that is not a &'Received:'& or &'Resent-something:'& header.
30183
30184 This is done by specifying &":at_start:"&, &":after_received:"&, or
30185 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30186 header line, respectively. (Header text cannot start with a colon, as there has
30187 to be a header name first.) For example:
30188 .code
30189 warn add_header = \
30190        :after_received:X-My-Header: something or other...
30191 .endd
30192 If more than one header line is supplied in a single &%add_header%& modifier,
30193 each one is treated independently and can therefore be placed differently. If
30194 you add more than one line at the start, or after the Received: block, they end
30195 up in reverse order.
30196
30197 &*Warning*&: This facility currently applies only to header lines that are
30198 added in an ACL. It does NOT work for header lines that are added in a
30199 system filter or in a router or transport.
30200
30201
30202
30203 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30204 .cindex "header lines" "removing in an ACL"
30205 .cindex "header lines" "position of removed lines"
30206 .cindex "&%remove_header%& ACL modifier"
30207 The &%remove_header%& modifier can be used to remove one or more header lines
30208 from an incoming message, as in this example:
30209 .code
30210 warn   message        = Remove internal headers
30211        remove_header  = x-route-mail1 : x-route-mail2
30212 .endd
30213 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30214 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30215 receiving a message). The message must ultimately be accepted for
30216 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30217 with any ACL verb, including &%deny%&, though this is really not useful for
30218 any verb that doesn't result in a delivered message.
30219
30220 Headers will not be removed from the message if the modifier is used in
30221 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30222
30223 More than one header can be removed at the same time by using a colon separated
30224 list of header names. The header matching is case insensitive. Wildcards are
30225 not permitted, nor is list expansion performed, so you cannot use hostlists to
30226 create a list of headers, however both connection and message variable expansion
30227 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30228 .code
30229 warn   hosts           = +internal_hosts
30230        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30231 warn   message         = Remove internal headers
30232        remove_header   = $acl_c_ihdrs
30233 .endd
30234 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30235 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30236 If multiple header lines match, all are removed.
30237 There is no harm in attempting to remove the same header twice nor in removing
30238 a non-existent header. Further header lines to be removed may be accumulated
30239 during the DATA and MIME ACLs, after which they are removed from the message,
30240 if present. In the case of non-SMTP messages, headers to be removed are
30241 accumulated during the non-SMTP ACLs, and are removed from the message after
30242 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30243 ACL, there really is no effect because there is no logging of what headers
30244 would have been removed.
30245
30246 .cindex "header lines" "removed; visibility of"
30247 Header lines are not visible in string expansions until the DATA phase when it
30248 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30249 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30250 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30251 this restriction, you cannot use header lines as a way of controlling data
30252 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30253 you should instead use ACL variables, as described in section
30254 &<<SECTaclvariables>>&.
30255
30256 The &%remove_header%& modifier acts immediately as it is encountered during the
30257 processing of an ACL. Notice the difference between these two cases:
30258 .display
30259 &`accept remove_header = X-Internal`&
30260 &`       `&<&'some condition'&>
30261
30262 &`accept `&<&'some condition'&>
30263 &`       remove_header = X-Internal`&
30264 .endd
30265 In the first case, the header line is always removed, whether or not the
30266 condition is true. In the second case, the header line is removed only if the
30267 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30268 same ACL statement. All those that are encountered before a condition fails
30269 are honoured.
30270
30271 &*Warning*&: This facility currently applies only to header lines that are
30272 present during ACL processing. It does NOT remove header lines that are added
30273 in a system filter or in a router or transport.
30274
30275
30276
30277
30278 .section "ACL conditions" "SECTaclconditions"
30279 .cindex "&ACL;" "conditions; list of"
30280 Some of the conditions listed in this section are available only when Exim is
30281 compiled with the content-scanning extension. They are included here briefly
30282 for completeness. More detailed descriptions can be found in the discussion on
30283 content scanning in chapter &<<CHAPexiscan>>&.
30284
30285 Not all conditions are relevant in all circumstances. For example, testing
30286 senders and recipients does not make sense in an ACL that is being run as the
30287 result of the arrival of an ETRN command, and checks on message headers can be
30288 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30289 can use the same condition (with different parameters) more than once in the
30290 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30291 The conditions are as follows:
30292
30293
30294 .vlist
30295 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30296 .cindex "&ACL;" "nested"
30297 .cindex "&ACL;" "indirect"
30298 .cindex "&ACL;" "arguments"
30299 .cindex "&%acl%& ACL condition"
30300 The possible values of the argument are the same as for the
30301 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30302 &"accept"& the condition is true; if it returns &"deny"& the condition is
30303 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30304 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30305 condition false. This means that further processing of the &%warn%& verb
30306 ceases, but processing of the ACL continues.
30307
30308 If the argument is a named ACL, up to nine space-separated optional values
30309 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30310 and $acl_narg is set to the count of values.
30311 Previous values of these variables are restored after the call returns.
30312 The name and values are expanded separately.
30313 Note that spaces in complex expansions which are used as arguments
30314 will act as argument separators.
30315
30316 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30317 the connection is dropped. If it returns &"discard"&, the verb must be
30318 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30319 conditions are tested.
30320
30321 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30322 loops. This condition allows you to use different ACLs in different
30323 circumstances. For example, different ACLs can be used to handle RCPT commands
30324 for different local users or different local domains.
30325
30326 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30327 .cindex "&%authenticated%& ACL condition"
30328 .cindex "authentication" "ACL checking"
30329 .cindex "&ACL;" "testing for authentication"
30330 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30331 the name of the authenticator is tested against the list. To test for
30332 authentication by any authenticator, you can set
30333 .code
30334 authenticated = *
30335 .endd
30336
30337 .vitem &*condition&~=&~*&<&'string'&>
30338 .cindex "&%condition%& ACL condition"
30339 .cindex "customizing" "ACL condition"
30340 .cindex "&ACL;" "customized test"
30341 .cindex "&ACL;" "testing, customized"
30342 This feature allows you to make up custom conditions. If the result of
30343 expanding the string is an empty string, the number zero, or one of the strings
30344 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30345 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30346 any other value, some error is assumed to have occurred, and the ACL returns
30347 &"defer"&. However, if the expansion is forced to fail, the condition is
30348 ignored. The effect is to treat it as true, whether it is positive or
30349 negative.
30350
30351 .vitem &*decode&~=&~*&<&'location'&>
30352 .cindex "&%decode%& ACL condition"
30353 This condition is available only when Exim is compiled with the
30354 content-scanning extension, and it is allowed only in the ACL defined by
30355 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30356 If all goes well, the condition is true. It is false only if there are
30357 problems such as a syntax error or a memory shortage. For more details, see
30358 chapter &<<CHAPexiscan>>&.
30359
30360 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30361 .cindex "&%dnslists%& ACL condition"
30362 .cindex "DNS list" "in ACL"
30363 .cindex "black list (DNS)"
30364 .cindex "&ACL;" "testing a DNS list"
30365 This condition checks for entries in DNS black lists. These are also known as
30366 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30367 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30368 different variants of this condition to describe briefly here. See sections
30369 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30370
30371 .vitem &*domains&~=&~*&<&'domain&~list'&>
30372 .cindex "&%domains%& ACL condition"
30373 .cindex "domain" "ACL checking"
30374 .cindex "&ACL;" "testing a recipient domain"
30375 .vindex "&$domain_data$&"
30376 This condition is relevant only after a RCPT command. It checks that the domain
30377 of the recipient address is in the domain list. If percent-hack processing is
30378 enabled, it is done before this test is done. If the check succeeds with a
30379 lookup, the result of the lookup is placed in &$domain_data$& until the next
30380 &%domains%& test.
30381
30382 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30383 use &%domains%& in a DATA ACL.
30384
30385
30386 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30387 .cindex "&%encrypted%& ACL condition"
30388 .cindex "encryption" "checking in an ACL"
30389 .cindex "&ACL;" "testing for encryption"
30390 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30391 name of the cipher suite in use is tested against the list. To test for
30392 encryption without testing for any specific cipher suite(s), set
30393 .code
30394 encrypted = *
30395 .endd
30396
30397
30398 .vitem &*hosts&~=&~*&<&'host&~list'&>
30399 .cindex "&%hosts%& ACL condition"
30400 .cindex "host" "ACL checking"
30401 .cindex "&ACL;" "testing the client host"
30402 This condition tests that the calling host matches the host list. If you have
30403 name lookups or wildcarded host names and IP addresses in the same host list,
30404 you should normally put the IP addresses first. For example, you could have:
30405 .code
30406 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30407 .endd
30408 The lookup in this example uses the host name for its key. This is implied by
30409 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30410 and it wouldn't matter which way round you had these two items.)
30411
30412 The reason for the problem with host names lies in the left-to-right way that
30413 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30414 but when it reaches an item that requires a host name, it fails if it cannot
30415 find a host name to compare with the pattern. If the above list is given in the
30416 opposite order, the &%accept%& statement fails for a host whose name cannot be
30417 found, even if its IP address is 10.9.8.7.
30418
30419 If you really do want to do the name check first, and still recognize the IP
30420 address even if the name lookup fails, you can rewrite the ACL like this:
30421 .code
30422 accept hosts = dbm;/etc/friendly/hosts
30423 accept hosts = 10.9.8.7
30424 .endd
30425 The default action on failing to find the host name is to assume that the host
30426 is not in the list, so the first &%accept%& statement fails. The second
30427 statement can then check the IP address.
30428
30429 .vindex "&$host_data$&"
30430 If a &%hosts%& condition is satisfied by means of a lookup, the result
30431 of the lookup is made available in the &$host_data$& variable. This
30432 allows you, for example, to set up a statement like this:
30433 .code
30434 deny  hosts = net-lsearch;/some/file
30435 message = $host_data
30436 .endd
30437 which gives a custom error message for each denied host.
30438
30439 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30440 .cindex "&%local_parts%& ACL condition"
30441 .cindex "local part" "ACL checking"
30442 .cindex "&ACL;" "testing a local part"
30443 .vindex "&$local_part_data$&"
30444 This condition is relevant only after a RCPT command. It checks that the local
30445 part of the recipient address is in the list. If percent-hack processing is
30446 enabled, it is done before this test. If the check succeeds with a lookup, the
30447 result of the lookup is placed in &$local_part_data$&, which remains set until
30448 the next &%local_parts%& test.
30449
30450 .vitem &*malware&~=&~*&<&'option'&>
30451 .cindex "&%malware%& ACL condition"
30452 .cindex "&ACL;" "virus scanning"
30453 .cindex "&ACL;" "scanning for viruses"
30454 This condition is available only when Exim is compiled with the
30455 content-scanning extension. It causes the incoming message to be scanned for
30456 viruses. For details, see chapter &<<CHAPexiscan>>&.
30457
30458 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30459 .cindex "&%mime_regex%& ACL condition"
30460 .cindex "&ACL;" "testing by regex matching"
30461 This condition is available only when Exim is compiled with the
30462 content-scanning extension, and it is allowed only in the ACL defined by
30463 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30464 with any of the regular expressions. For details, see chapter
30465 &<<CHAPexiscan>>&.
30466
30467 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30468 .cindex "rate limiting"
30469 This condition can be used to limit the rate at which a user or host submits
30470 messages. Details are given in section &<<SECTratelimiting>>&.
30471
30472 .vitem &*recipients&~=&~*&<&'address&~list'&>
30473 .cindex "&%recipients%& ACL condition"
30474 .cindex "recipient" "ACL checking"
30475 .cindex "&ACL;" "testing a recipient"
30476 This condition is relevant only after a RCPT command. It checks the entire
30477 recipient address against a list of recipients.
30478
30479 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30480 .cindex "&%regex%& ACL condition"
30481 .cindex "&ACL;" "testing by regex matching"
30482 This condition is available only when Exim is compiled with the
30483 content-scanning extension, and is available only in the DATA, MIME, and
30484 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30485 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30486
30487 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30488 .cindex "&%sender_domains%& ACL condition"
30489 .cindex "sender" "ACL checking"
30490 .cindex "&ACL;" "testing a sender domain"
30491 .vindex "&$domain$&"
30492 .vindex "&$sender_address_domain$&"
30493 This condition tests the domain of the sender of the message against the given
30494 domain list. &*Note*&: The domain of the sender address is in
30495 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30496 of this condition. This is an exception to the general rule for testing domain
30497 lists. It is done this way so that, if this condition is used in an ACL for a
30498 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30499 influence the sender checking.
30500
30501 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30502 relaying, because sender addresses are easily, and commonly, forged.
30503
30504 .vitem &*senders&~=&~*&<&'address&~list'&>
30505 .cindex "&%senders%& ACL condition"
30506 .cindex "sender" "ACL checking"
30507 .cindex "&ACL;" "testing a sender"
30508 This condition tests the sender of the message against the given list. To test
30509 for a bounce message, which has an empty sender, set
30510 .code
30511 senders = :
30512 .endd
30513 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30514 relaying, because sender addresses are easily, and commonly, forged.
30515
30516 .vitem &*spam&~=&~*&<&'username'&>
30517 .cindex "&%spam%& ACL condition"
30518 .cindex "&ACL;" "scanning for spam"
30519 This condition is available only when Exim is compiled with the
30520 content-scanning extension. It causes the incoming message to be scanned by
30521 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
30522
30523 .vitem &*verify&~=&~certificate*&
30524 .cindex "&%verify%& ACL condition"
30525 .cindex "TLS" "client certificate verification"
30526 .cindex "certificate" "verification of client"
30527 .cindex "&ACL;" "certificate verification"
30528 .cindex "&ACL;" "testing a TLS certificate"
30529 This condition is true in an SMTP session if the session is encrypted, and a
30530 certificate was received from the client, and the certificate was verified. The
30531 server requests a certificate only if the client matches &%tls_verify_hosts%&
30532 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
30533
30534 .vitem &*verify&~=&~csa*&
30535 .cindex "CSA verification"
30536 This condition checks whether the sending host (the client) is authorized to
30537 send email. Details of how this works are given in section
30538 &<<SECTverifyCSA>>&.
30539
30540 .vitem &*verify&~=&~header_names_ascii*&
30541 .cindex "&%verify%& ACL condition"
30542 .cindex "&ACL;" "verifying header names only ASCII"
30543 .cindex "header lines" "verifying header names only ASCII"
30544 .cindex "verifying" "header names only ASCII"
30545 This condition is relevant only in an ACL that is run after a message has been
30546 received, that is, in an ACL specified by &%acl_smtp_data%& or
30547 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
30548 there are no non-ASCII characters, also excluding control characters.  The
30549 allowable characters are decimal ASCII values 33 through 126.
30550
30551 Exim itself will handle headers with non-ASCII characters, but it can cause
30552 problems for downstream applications, so this option will allow their
30553 detection and rejection in the DATA ACL's.
30554
30555 .vitem &*verify&~=&~header_sender/*&<&'options'&>
30556 .cindex "&%verify%& ACL condition"
30557 .cindex "&ACL;" "verifying sender in the header"
30558 .cindex "header lines" "verifying the sender in"
30559 .cindex "sender" "verifying in header"
30560 .cindex "verifying" "sender in header"
30561 This condition is relevant only in an ACL that is run after a message has been
30562 received, that is, in an ACL specified by &%acl_smtp_data%& or
30563 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
30564 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
30565 is loosely thought of as a &"sender"& address (hence the name of the test).
30566 However, an address that appears in one of these headers need not be an address
30567 that accepts bounce messages; only sender addresses in envelopes are required
30568 to accept bounces. Therefore, if you use the callout option on this check, you
30569 might want to arrange for a non-empty address in the MAIL command.
30570
30571 Details of address verification and the options are given later, starting at
30572 section &<<SECTaddressverification>>& (callouts are described in section
30573 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
30574 condition to restrict it to bounce messages only:
30575 .code
30576 deny    senders = :
30577         message = A valid sender header is required for bounces
30578        !verify  = header_sender
30579 .endd
30580
30581 .vitem &*verify&~=&~header_syntax*&
30582 .cindex "&%verify%& ACL condition"
30583 .cindex "&ACL;" "verifying header syntax"
30584 .cindex "header lines" "verifying syntax"
30585 .cindex "verifying" "header syntax"
30586 This condition is relevant only in an ACL that is run after a message has been
30587 received, that is, in an ACL specified by &%acl_smtp_data%& or
30588 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
30589 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
30590 and &'Bcc:'&), returning true if there are no problems.
30591 Unqualified addresses (local parts without domains) are
30592 permitted only in locally generated messages and from hosts that match
30593 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
30594 appropriate.
30595
30596 Note that this condition is a syntax check only. However, a common spamming
30597 ploy used to be to send syntactically invalid headers such as
30598 .code
30599 To: @
30600 .endd
30601 and this condition can be used to reject such messages, though they are not as
30602 common as they used to be.
30603
30604 .vitem &*verify&~=&~helo*&
30605 .cindex "&%verify%& ACL condition"
30606 .cindex "&ACL;" "verifying HELO/EHLO"
30607 .cindex "HELO" "verifying"
30608 .cindex "EHLO" "verifying"
30609 .cindex "verifying" "EHLO"
30610 .cindex "verifying" "HELO"
30611 This condition is true if a HELO or EHLO command has been received from the
30612 client host, and its contents have been verified. If there has been no previous
30613 attempt to verify the HELO/EHLO contents, it is carried out when this
30614 condition is encountered. See the description of the &%helo_verify_hosts%& and
30615 &%helo_try_verify_hosts%& options for details of how to request verification
30616 independently of this condition.
30617
30618 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
30619 option), this condition is always true.
30620
30621
30622 .vitem &*verify&~=&~not_blind*&
30623 .cindex "verifying" "not blind"
30624 .cindex "bcc recipients, verifying none"
30625 This condition checks that there are no blind (bcc) recipients in the message.
30626 Every envelope recipient must appear either in a &'To:'& header line or in a
30627 &'Cc:'& header line for this condition to be true. Local parts are checked
30628 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
30629 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
30630 used only in a DATA or non-SMTP ACL.
30631
30632 There are, of course, many legitimate messages that make use of blind (bcc)
30633 recipients. This check should not be used on its own for blocking messages.
30634
30635
30636 .vitem &*verify&~=&~recipient/*&<&'options'&>
30637 .cindex "&%verify%& ACL condition"
30638 .cindex "&ACL;" "verifying recipient"
30639 .cindex "recipient" "verifying"
30640 .cindex "verifying" "recipient"
30641 .vindex "&$address_data$&"
30642 This condition is relevant only after a RCPT command. It verifies the current
30643 recipient. Details of address verification are given later, starting at section
30644 &<<SECTaddressverification>>&. After a recipient has been verified, the value
30645 of &$address_data$& is the last value that was set while routing the address.
30646 This applies even if the verification fails. When an address that is being
30647 verified is redirected to a single address, verification continues with the new
30648 address, and in that case, the subsequent value of &$address_data$& is the
30649 value for the child address.
30650
30651 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
30652 .cindex "&%verify%& ACL condition"
30653 .cindex "&ACL;" "verifying host reverse lookup"
30654 .cindex "host" "verifying reverse lookup"
30655 This condition ensures that a verified host name has been looked up from the IP
30656 address of the client host. (This may have happened already if the host name
30657 was needed for checking a host list, or if the host matched &%host_lookup%&.)
30658 Verification ensures that the host name obtained from a reverse DNS lookup, or
30659 one of its aliases, does, when it is itself looked up in the DNS, yield the
30660 original IP address.
30661
30662 There is one possible option, &`defer_ok`&.  If this is present and a
30663 DNS operation returns a temporary error, the verify condition succeeds.
30664
30665 If this condition is used for a locally generated message (that is, when there
30666 is no client host involved), it always succeeds.
30667
30668 .vitem &*verify&~=&~sender/*&<&'options'&>
30669 .cindex "&%verify%& ACL condition"
30670 .cindex "&ACL;" "verifying sender"
30671 .cindex "sender" "verifying"
30672 .cindex "verifying" "sender"
30673 This condition is relevant only after a MAIL or RCPT command, or after a
30674 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
30675 the message's sender is empty (that is, this is a bounce message), the
30676 condition is true. Otherwise, the sender address is verified.
30677
30678 .vindex "&$address_data$&"
30679 .vindex "&$sender_address_data$&"
30680 If there is data in the &$address_data$& variable at the end of routing, its
30681 value is placed in &$sender_address_data$& at the end of verification. This
30682 value can be used in subsequent conditions and modifiers in the same ACL
30683 statement. It does not persist after the end of the current statement. If you
30684 want to preserve the value for longer, you can save it in an ACL variable.
30685
30686 Details of verification are given later, starting at section
30687 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
30688 to avoid doing it more than once per message.
30689
30690 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
30691 .cindex "&%verify%& ACL condition"
30692 This is a variation of the previous option, in which a modified address is
30693 verified as a sender.
30694
30695 Note that '/' is legal in local-parts; if the address may have such
30696 (eg. is generated from the received message)
30697 they must be protected from the options parsing by doubling:
30698 .code
30699 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
30700 .endd
30701 .endlist
30702
30703
30704
30705 .section "Using DNS lists" "SECTmorednslists"
30706 .cindex "DNS list" "in ACL"
30707 .cindex "black list (DNS)"
30708 .cindex "&ACL;" "testing a DNS list"
30709 In its simplest form, the &%dnslists%& condition tests whether the calling host
30710 is on at least one of a number of DNS lists by looking up the inverted IP
30711 address in one or more DNS domains. (Note that DNS list domains are not mail
30712 domains, so the &`+`& syntax for named lists doesn't work - it is used for
30713 special options instead.) For example, if the calling host's IP
30714 address is 192.168.62.43, and the ACL statement is
30715 .code
30716 deny dnslists = blackholes.mail-abuse.org : \
30717                 dialups.mail-abuse.org
30718 .endd
30719 the following records are looked up:
30720 .code
30721 43.62.168.192.blackholes.mail-abuse.org
30722 43.62.168.192.dialups.mail-abuse.org
30723 .endd
30724 As soon as Exim finds an existing DNS record, processing of the list stops.
30725 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
30726 to test that a host is on more than one list (an &"and"& conjunction), you can
30727 use two separate conditions:
30728 .code
30729 deny dnslists = blackholes.mail-abuse.org
30730      dnslists = dialups.mail-abuse.org
30731 .endd
30732 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
30733 behaves as if the host does not match the list item, that is, as if the DNS
30734 record does not exist. If there are further items in the DNS list, they are
30735 processed.
30736
30737 This is usually the required action when &%dnslists%& is used with &%deny%&
30738 (which is the most common usage), because it prevents a DNS failure from
30739 blocking mail. However, you can change this behaviour by putting one of the
30740 following special items in the list:
30741 .display
30742 &`+include_unknown `&   behave as if the item is on the list
30743 &`+exclude_unknown `&   behave as if the item is not on the list (default)
30744 &`+defer_unknown   `&   give a temporary error
30745 .endd
30746 .cindex "&`+include_unknown`&"
30747 .cindex "&`+exclude_unknown`&"
30748 .cindex "&`+defer_unknown`&"
30749 Each of these applies to any subsequent items on the list. For example:
30750 .code
30751 deny dnslists = +defer_unknown : foo.bar.example
30752 .endd
30753 Testing the list of domains stops as soon as a match is found. If you want to
30754 warn for one list and block for another, you can use two different statements:
30755 .code
30756 deny  dnslists = blackholes.mail-abuse.org
30757 warn  message  = X-Warn: sending host is on dialups list
30758       dnslists = dialups.mail-abuse.org
30759 .endd
30760 .cindex caching "of dns lookup"
30761 .cindex DNS TTL
30762 DNS list lookups are cached by Exim for the duration of the SMTP session
30763 (but limited by the DNS return TTL value),
30764 so a lookup based on the IP address is done at most once for any incoming
30765 connection (assuming long-enough TTL).
30766 Exim does not share information between multiple incoming
30767 connections (but your local name server cache should be active).
30768
30769 There are a number of DNS lists to choose from, some commercial, some free,
30770 or free for small deployments.  An overview can be found at
30771 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
30772
30773
30774
30775 .section "Specifying the IP address for a DNS list lookup" "SECID201"
30776 .cindex "DNS list" "keyed by explicit IP address"
30777 By default, the IP address that is used in a DNS list lookup is the IP address
30778 of the calling host. However, you can specify another IP address by listing it
30779 after the domain name, introduced by a slash. For example:
30780 .code
30781 deny dnslists = black.list.tld/192.168.1.2
30782 .endd
30783 This feature is not very helpful with explicit IP addresses; it is intended for
30784 use with IP addresses that are looked up, for example, the IP addresses of the
30785 MX hosts or nameservers of an email sender address. For an example, see section
30786 &<<SECTmulkeyfor>>& below.
30787
30788
30789
30790
30791 .section "DNS lists keyed on domain names" "SECID202"
30792 .cindex "DNS list" "keyed by domain name"
30793 There are some lists that are keyed on domain names rather than inverted IP
30794 addresses.  No reversing of components is used
30795 with these lists. You can change the name that is looked up in a DNS list by
30796 listing it after the domain name, introduced by a slash. For example,
30797 .code
30798 deny  message  = Sender's domain is listed at $dnslist_domain
30799       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
30800 .endd
30801 This particular example is useful only in ACLs that are obeyed after the
30802 RCPT or DATA commands, when a sender address is available. If (for
30803 example) the message's sender is &'user@tld.example'& the name that is looked
30804 up by this example is
30805 .code
30806 tld.example.dsn.rfc-ignorant.org
30807 .endd
30808 A single &%dnslists%& condition can contain entries for both names and IP
30809 addresses. For example:
30810 .code
30811 deny dnslists = sbl.spamhaus.org : \
30812                 dsn.rfc-ignorant.org/$sender_address_domain
30813 .endd
30814 The first item checks the sending host's IP address; the second checks a domain
30815 name. The whole condition is true if either of the DNS lookups succeeds.
30816
30817
30818
30819
30820 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
30821 .cindex "DNS list" "multiple keys for"
30822 The syntax described above for looking up explicitly-defined values (either
30823 names or IP addresses) in a DNS blacklist is a simplification. After the domain
30824 name for the DNS list, what follows the slash can in fact be a list of items.
30825 As with all lists in Exim, the default separator is a colon. However, because
30826 this is a sublist within the list of DNS blacklist domains, it is necessary
30827 either to double the separators like this:
30828 .code
30829 dnslists = black.list.tld/name.1::name.2
30830 .endd
30831 or to change the separator character, like this:
30832 .code
30833 dnslists = black.list.tld/<;name.1;name.2
30834 .endd
30835 If an item in the list is an IP address, it is inverted before the DNS
30836 blacklist domain is appended. If it is not an IP address, no inversion
30837 occurs. Consider this condition:
30838 .code
30839 dnslists = black.list.tld/<;192.168.1.2;a.domain
30840 .endd
30841 The DNS lookups that occur are:
30842 .code
30843 2.1.168.192.black.list.tld
30844 a.domain.black.list.tld
30845 .endd
30846 Once a DNS record has been found (that matches a specific IP return
30847 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
30848 are done. If there is a temporary DNS error, the rest of the sublist of domains
30849 or IP addresses is tried. A temporary error for the whole dnslists item occurs
30850 only if no other DNS lookup in this sublist succeeds. In other words, a
30851 successful lookup for any of the items in the sublist overrides a temporary
30852 error for a previous item.
30853
30854 The ability to supply a list of items after the slash is in some sense just a
30855 syntactic convenience. These two examples have the same effect:
30856 .code
30857 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
30858 dnslists = black.list.tld/a.domain::b.domain
30859 .endd
30860 However, when the data for the list is obtained from a lookup, the second form
30861 is usually much more convenient. Consider this example:
30862 .code
30863 deny message  = The mail servers for the domain \
30864                 $sender_address_domain \
30865                 are listed at $dnslist_domain ($dnslist_value); \
30866                 see $dnslist_text.
30867      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
30868                                    ${lookup dnsdb {>|mxh=\
30869                                    $sender_address_domain} }} }
30870 .endd
30871 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
30872 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
30873 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
30874 of expanding the condition might be something like this:
30875 .code
30876 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
30877 .endd
30878 Thus, this example checks whether or not the IP addresses of the sender
30879 domain's mail servers are on the Spamhaus black list.
30880
30881 The key that was used for a successful DNS list lookup is put into the variable
30882 &$dnslist_matched$& (see section &<<SECID204>>&).
30883
30884
30885
30886
30887 .section "Data returned by DNS lists" "SECID203"
30888 .cindex "DNS list" "data returned from"
30889 DNS lists are constructed using address records in the DNS. The original RBL
30890 just used the address 127.0.0.1 on the right hand side of each record, but the
30891 RBL+ list and some other lists use a number of values with different meanings.
30892 The values used on the RBL+ list are:
30893 .display
30894 127.1.0.1  RBL
30895 127.1.0.2  DUL
30896 127.1.0.3  DUL and RBL
30897 127.1.0.4  RSS
30898 127.1.0.5  RSS and RBL
30899 127.1.0.6  RSS and DUL
30900 127.1.0.7  RSS and DUL and RBL
30901 .endd
30902 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30903 different values. Some DNS lists may return more than one address record;
30904 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30905
30906
30907 .section "Variables set from DNS lists" "SECID204"
30908 .cindex "expansion" "variables, set from DNS list"
30909 .cindex "DNS list" "variables set from"
30910 .vindex "&$dnslist_domain$&"
30911 .vindex "&$dnslist_matched$&"
30912 .vindex "&$dnslist_text$&"
30913 .vindex "&$dnslist_value$&"
30914 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30915 the name of the overall domain that matched (for example,
30916 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30917 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30918 the DNS record. When the key is an IP address, it is not reversed in
30919 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30920 cases, for example:
30921 .code
30922 deny dnslists = spamhaus.example
30923 .endd
30924 the key is also available in another variable (in this case,
30925 &$sender_host_address$&). In more complicated cases, however, this is not true.
30926 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30927 might generate a dnslists lookup like this:
30928 .code
30929 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30930 .endd
30931 If this condition succeeds, the value in &$dnslist_matched$& might be
30932 &`192.168.6.7`& (for example).
30933
30934 If more than one address record is returned by the DNS lookup, all the IP
30935 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30936 The variable &$dnslist_text$& contains the contents of any associated TXT
30937 record. For lists such as RBL+ the TXT record for a merged entry is often not
30938 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30939 information.
30940
30941 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30942 &-- although these appear before the condition in the ACL, they are not
30943 expanded until after it has failed. For example:
30944 .code
30945 deny    hosts = !+local_networks
30946         message = $sender_host_address is listed \
30947                   at $dnslist_domain
30948         dnslists = rbl-plus.mail-abuse.example
30949 .endd
30950
30951
30952
30953 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30954 .cindex "DNS list" "matching specific returned data"
30955 You can add an equals sign and an IP address after a &%dnslists%& domain name
30956 in order to restrict its action to DNS records with a matching right hand side.
30957 For example,
30958 .code
30959 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30960 .endd
30961 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30962 any address record is considered to be a match. For the moment, we assume
30963 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30964 describes how multiple records are handled.
30965
30966 More than one IP address may be given for checking, using a comma as a
30967 separator. These are alternatives &-- if any one of them matches, the
30968 &%dnslists%& condition is true. For example:
30969 .code
30970 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30971 .endd
30972 If you want to specify a constraining address list and also specify names or IP
30973 addresses to be looked up, the constraining address list must be specified
30974 first. For example:
30975 .code
30976 deny dnslists = dsn.rfc-ignorant.org\
30977                 =127.0.0.2/$sender_address_domain
30978 .endd
30979
30980 If the character &`&&`& is used instead of &`=`&, the comparison for each
30981 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30982 In other words, the listed addresses are used as bit masks. The comparison is
30983 true if all the bits in the mask are present in the address that is being
30984 tested. For example:
30985 .code
30986 dnslists = a.b.c&0.0.0.3
30987 .endd
30988 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30989 want to test whether one bit or another bit is present (as opposed to both
30990 being present), you must use multiple values. For example:
30991 .code
30992 dnslists = a.b.c&0.0.0.1,0.0.0.2
30993 .endd
30994 matches if the final component of the address is an odd number or two times
30995 an odd number.
30996
30997
30998
30999 .section "Negated DNS matching conditions" "SECID205"
31000 You can supply a negative list of IP addresses as part of a &%dnslists%&
31001 condition. Whereas
31002 .code
31003 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31004 .endd
31005 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31006 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31007 .code
31008 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31009 .endd
31010 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31011 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31012 words, the result of the test is inverted if an exclamation mark appears before
31013 the &`=`& (or the &`&&`&) sign.
31014
31015 &*Note*&: This kind of negation is not the same as negation in a domain,
31016 host, or address list (which is why the syntax is different).
31017
31018 If you are using just one list, the negation syntax does not gain you much. The
31019 previous example is precisely equivalent to
31020 .code
31021 deny  dnslists = a.b.c
31022      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31023 .endd
31024 However, if you are using multiple lists, the negation syntax is clearer.
31025 Consider this example:
31026 .code
31027 deny  dnslists = sbl.spamhaus.org : \
31028                  list.dsbl.org : \
31029                  dnsbl.njabl.org!=127.0.0.3 : \
31030                  relays.ordb.org
31031 .endd
31032 Using only positive lists, this would have to be:
31033 .code
31034 deny  dnslists = sbl.spamhaus.org : \
31035                  list.dsbl.org
31036 deny  dnslists = dnsbl.njabl.org
31037      !dnslists = dnsbl.njabl.org=127.0.0.3
31038 deny  dnslists = relays.ordb.org
31039 .endd
31040 which is less clear, and harder to maintain.
31041
31042
31043
31044
31045 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31046 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31047 thereby providing more than one IP address. When an item in a &%dnslists%& list
31048 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31049 the match to specific results from the DNS lookup, there are two ways in which
31050 the checking can be handled. For example, consider the condition:
31051 .code
31052 dnslists = a.b.c=127.0.0.1
31053 .endd
31054 What happens if the DNS lookup for the incoming IP address yields both
31055 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31056 condition true because at least one given value was found, or is it false
31057 because at least one of the found values was not listed? And how does this
31058 affect negated conditions? Both possibilities are provided for with the help of
31059 additional separators &`==`& and &`=&&`&.
31060
31061 .ilist
31062 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31063 IP addresses matches one of the listed addresses. For the example above, the
31064 condition is true because 127.0.0.1 matches.
31065 .next
31066 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31067 looked up IP addresses matches one of the listed addresses. If the condition is
31068 changed to:
31069 .code
31070 dnslists = a.b.c==127.0.0.1
31071 .endd
31072 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31073 false because 127.0.0.2 is not listed. You would need to have:
31074 .code
31075 dnslists = a.b.c==127.0.0.1,127.0.0.2
31076 .endd
31077 for the condition to be true.
31078 .endlist
31079
31080 When &`!`& is used to negate IP address matching, it inverts the result, giving
31081 the precise opposite of the behaviour above. Thus:
31082 .ilist
31083 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31084 addresses matches one of the listed addresses. Consider:
31085 .code
31086 dnslists = a.b.c!&0.0.0.1
31087 .endd
31088 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31089 false because 127.0.0.1 matches.
31090 .next
31091 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31092 looked up IP address that does not match. Consider:
31093 .code
31094 dnslists = a.b.c!=&0.0.0.1
31095 .endd
31096 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31097 true, because 127.0.0.2 does not match. You would need to have:
31098 .code
31099 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31100 .endd
31101 for the condition to be false.
31102 .endlist
31103 When the DNS lookup yields only a single IP address, there is no difference
31104 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31105
31106
31107
31108
31109 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31110 .cindex "DNS list" "information from merged"
31111 When the facility for restricting the matching IP values in a DNS list is used,
31112 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31113 the true reason for rejection. This happens when lists are merged and the IP
31114 address in the A record is used to distinguish them; unfortunately there is
31115 only one TXT record. One way round this is not to use merged lists, but that
31116 can be inefficient because it requires multiple DNS lookups where one would do
31117 in the vast majority of cases when the host of interest is not on any of the
31118 lists.
31119
31120 A less inefficient way of solving this problem is available. If
31121 two domain names, comma-separated, are given, the second is used first to
31122 do an initial check, making use of any IP value restrictions that are set.
31123 If there is a match, the first domain is used, without any IP value
31124 restrictions, to get the TXT record. As a byproduct of this, there is also
31125 a check that the IP being tested is indeed on the first list. The first
31126 domain is the one that is put in &$dnslist_domain$&. For example:
31127 .code
31128 deny message  = \
31129          rejected because $sender_host_address is blacklisted \
31130          at $dnslist_domain\n$dnslist_text
31131        dnslists = \
31132          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31133          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31134 .endd
31135 For the first blacklist item, this starts by doing a lookup in
31136 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31137 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31138 value, and as long as something is found, it looks for the corresponding TXT
31139 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31140 The second blacklist item is processed similarly.
31141
31142 If you are interested in more than one merged list, the same list must be
31143 given several times, but because the results of the DNS lookups are cached,
31144 the DNS calls themselves are not repeated. For example:
31145 .code
31146 deny dnslists = \
31147          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31148          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31149          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31150          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31151 .endd
31152 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31153 values matches (or if no record is found), this is the only lookup that is
31154 done. Only if there is a match is one of the more specific lists consulted.
31155
31156
31157
31158 .section "DNS lists and IPv6" "SECTmorednslistslast"
31159 .cindex "IPv6" "DNS black lists"
31160 .cindex "DNS list" "IPv6 usage"
31161 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31162 nibble by nibble. For example, if the calling host's IP address is
31163 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31164 .code
31165 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31166   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31167 .endd
31168 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31169 lists contain wildcard records, intended for IPv4, that interact badly with
31170 IPv6. For example, the DNS entry
31171 .code
31172 *.3.some.list.example.    A    127.0.0.1
31173 .endd
31174 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31175 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31176
31177 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31178 &%condition%& condition, as in this example:
31179 .code
31180 deny   condition = ${if isip4{$sender_host_address}}
31181        dnslists  = some.list.example
31182 .endd
31183
31184 If an explicit key is being used for a DNS lookup and it may be an IPv6
31185 address you should specify alternate list separators for both the outer
31186 (DNS list name) list and inner (lookup keys) list:
31187 .code
31188        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31189 .endd
31190
31191 .section "Rate limiting incoming messages" "SECTratelimiting"
31192 .cindex "rate limiting" "client sending"
31193 .cindex "limiting client sending rates"
31194 .oindex "&%smtp_ratelimit_*%&"
31195 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31196 which clients can send email. This is more powerful than the
31197 &%smtp_ratelimit_*%& options, because those options control the rate of
31198 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31199 works across all connections (concurrent and sequential) from the same client
31200 host. The syntax of the &%ratelimit%& condition is:
31201 .display
31202 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31203 .endd
31204 If the average client sending rate is less than &'m'& messages per time
31205 period &'p'& then the condition is false; otherwise it is true.
31206
31207 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31208 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31209 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31210 of &'p'&.
31211
31212 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31213 time interval, for example, &`8h`& for eight hours. A larger time constant
31214 means that it takes Exim longer to forget a client's past behaviour. The
31215 parameter &'m'& is the maximum number of messages that a client is permitted to
31216 send in each time interval. It also specifies the number of messages permitted
31217 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31218 constant, you can allow a client to send more messages in a burst without
31219 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31220 both small, messages must be sent at an even rate.
31221
31222 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31223 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31224 when deploying the &%ratelimit%& ACL condition. The script prints usage
31225 instructions when it is run with no arguments.
31226
31227 The key is used to look up the data for calculating the client's average
31228 sending rate. This data is stored in Exim's spool directory, alongside the
31229 retry and other hints databases. The default key is &$sender_host_address$&,
31230 which means Exim computes the sending rate of each client host IP address.
31231 By changing the key you can change how Exim identifies clients for the purpose
31232 of ratelimiting. For example, to limit the sending rate of each authenticated
31233 user, independent of the computer they are sending from, set the key to
31234 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31235 example, &$authenticated_id$& is only meaningful if the client has
31236 authenticated (which you can check with the &%authenticated%& ACL condition).
31237
31238 The lookup key does not have to identify clients: If you want to limit the
31239 rate at which a recipient receives messages, you can use the key
31240 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31241 ACL.
31242
31243 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31244 specifies what Exim measures the rate of, for example messages or recipients
31245 or bytes. You can adjust the measurement using the &%unique=%& and/or
31246 &%count=%& options. You can also control when Exim updates the recorded rate
31247 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31248 separated by a slash, like the other parameters. They may appear in any order.
31249
31250 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31251 any options that alter the meaning of the stored data. The limit &'m'& is not
31252 stored, so you can alter the configured maximum rate and Exim will still
31253 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31254 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31255 behaviour. The lookup key is not affected by changes to the update mode and
31256 the &%count=%& option.
31257
31258
31259 .section "Ratelimit options for what is being measured" "ratoptmea"
31260 .cindex "rate limiting" "per_* options"
31261 The &%per_conn%& option limits the client's connection rate. It is not
31262 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31263 &%acl_not_smtp_start%& ACLs.
31264
31265 The &%per_mail%& option limits the client's rate of sending messages. This is
31266 the default if none of the &%per_*%& options is specified. It can be used in
31267 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31268 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31269
31270 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31271 the same ACLs as the &%per_mail%& option, though it is best to use this option
31272 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31273 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31274 in its MAIL command, which may be inaccurate or completely missing. You can
31275 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31276 in kilobytes, megabytes, or gigabytes, respectively.
31277
31278 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31279 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31280 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31281 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31282 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31283 in either case the rate limiting engine will see a message with many
31284 recipients as a large high-speed burst.
31285
31286 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31287 number of different recipients that the client has sent messages to in the
31288 last time period. That is, if the client repeatedly sends messages to the same
31289 recipient, its measured rate is not increased. This option can only be used in
31290 &%acl_smtp_rcpt%&.
31291
31292 The &%per_cmd%& option causes Exim to recompute the rate every time the
31293 condition is processed. This can be used to limit the rate of any SMTP
31294 command. If it is used in multiple ACLs it can limit the aggregate rate of
31295 multiple different commands.
31296
31297 The &%count=%& option can be used to alter how much Exim adds to the client's
31298 measured rate. For example, the &%per_byte%& option is equivalent to
31299 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31300 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31301 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31302
31303 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31304
31305
31306 .section "Ratelimit update modes" "ratoptupd"
31307 .cindex "rate limiting" "reading data without updating"
31308 You can specify one of three options with the &%ratelimit%& condition to
31309 control when its database is updated. This section describes the &%readonly%&
31310 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31311
31312 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31313 previously-computed rate to check against the limit.
31314
31315 For example, you can test the client's sending rate and deny it access (when
31316 it is too fast) in the connect ACL. If the client passes this check then it
31317 can go on to send a message, in which case its recorded rate will be updated
31318 in the MAIL ACL. Subsequent connections from the same client will check this
31319 new rate.
31320 .code
31321 acl_check_connect:
31322  deny ratelimit = 100 / 5m / readonly
31323     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31324                   (max $sender_rate_limit)
31325 # ...
31326 acl_check_mail:
31327  warn ratelimit = 100 / 5m / strict
31328     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31329                   (max $sender_rate_limit)
31330 .endd
31331
31332 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31333 processing a message then it may increase the client's measured rate more than
31334 it should. For example, this will happen if you check the &%per_rcpt%& option
31335 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31336 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31337 multiple update problems by using the &%readonly%& option on later ratelimit
31338 checks.
31339
31340 The &%per_*%& options described above do not make sense in some ACLs. If you
31341 use a &%per_*%& option in an ACL where it is not normally permitted then the
31342 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31343 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31344 next section) so you must specify the &%readonly%& option explicitly.
31345
31346
31347 .section "Ratelimit options for handling fast clients" "ratoptfast"
31348 .cindex "rate limiting" "strict and leaky modes"
31349 If a client's average rate is greater than the maximum, the rate limiting
31350 engine can react in two possible ways, depending on the presence of the
31351 &%strict%& or &%leaky%& update modes. This is independent of the other
31352 counter-measures (such as rejecting the message) that may be specified by the
31353 rest of the ACL.
31354
31355 The &%leaky%& (default) option means that the client's recorded rate is not
31356 updated if it is above the limit. The effect of this is that Exim measures the
31357 client's average rate of successfully sent email,
31358 .new
31359 up to the given limit.
31360 This is appropriate if the countermeasure when the condition is true
31361 consists of refusing the message, and
31362 is generally the better choice if you have clients that retry automatically.
31363 If the action when true is anything more complex then this option is
31364 likely not what is wanted.
31365 .wen
31366
31367 The &%strict%& option means that the client's recorded rate is always
31368 updated. The effect of this is that Exim measures the client's average rate
31369 of attempts to send email, which can be much higher than the maximum it is
31370 actually allowed. If the client is over the limit it may be subjected to
31371 counter-measures by the ACL. It must slow down and allow sufficient time to
31372 pass that its computed rate falls below the maximum before it can send email
31373 again. The time (the number of smoothing periods) it must wait and not
31374 attempt to send mail can be calculated with this formula:
31375 .code
31376         ln(peakrate/maxrate)
31377 .endd
31378
31379
31380 .section "Limiting the rate of different events" "ratoptuniq"
31381 .cindex "rate limiting" "counting unique events"
31382 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31383 rate of different events. For example, the &%per_addr%& option uses this
31384 mechanism to count the number of different recipients that the client has
31385 sent messages to in the last time period; it is equivalent to
31386 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31387 measure the rate that a client uses different sender addresses with the
31388 options &`per_mail/unique=$sender_address`&.
31389
31390 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31391 has seen for that key. The whole set is thrown away when it is older than the
31392 rate smoothing period &'p'&, so each different event is counted at most once
31393 per period. In the &%leaky%& update mode, an event that causes the client to
31394 go over the limit is not added to the set, in the same way that the client's
31395 recorded rate is not updated in the same situation.
31396
31397 When you combine the &%unique=%& and &%readonly%& options, the specific
31398 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31399 rate.
31400
31401 The &%unique=%& mechanism needs more space in the ratelimit database than the
31402 other &%ratelimit%& options in order to store the event set. The number of
31403 unique values is potentially as large as the rate limit, so the extra space
31404 required increases with larger limits.
31405
31406 The uniqueification is not perfect: there is a small probability that Exim
31407 will think a new event has happened before. If the sender's rate is less than
31408 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31409 the measured rate can go above the limit, in which case Exim may under-count
31410 events by a significant margin. Fortunately, if the rate is high enough (2.7
31411 times the limit) that the false positive rate goes above 9%, then Exim will
31412 throw away the over-full event set before the measured rate falls below the
31413 limit. Therefore the only harm should be that exceptionally high sending rates
31414 are logged incorrectly; any countermeasures you configure will be as effective
31415 as intended.
31416
31417
31418 .section "Using rate limiting" "useratlim"
31419 Exim's other ACL facilities are used to define what counter-measures are taken
31420 when the rate limit is exceeded. This might be anything from logging a warning
31421 (for example, while measuring existing sending rates in order to define
31422 policy), through time delays to slow down fast senders, up to rejecting the
31423 message. For example:
31424 .code
31425 # Log all senders' rates
31426 warn ratelimit = 0 / 1h / strict
31427      log_message = Sender rate $sender_rate / $sender_rate_period
31428
31429 # Slow down fast senders; note the need to truncate $sender_rate
31430 # at the decimal point.
31431 warn ratelimit = 100 / 1h / per_rcpt / strict
31432      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31433                    $sender_rate_limit }s
31434
31435 # Keep authenticated users under control
31436 deny authenticated = *
31437      ratelimit = 100 / 1d / strict / $authenticated_id
31438
31439 # System-wide rate limit
31440 defer message = Sorry, too busy. Try again later.
31441      ratelimit = 10 / 1s / $primary_hostname
31442
31443 # Restrict incoming rate from each host, with a default
31444 # set using a macro and special cases looked up in a table.
31445 defer message = Sender rate exceeds $sender_rate_limit \
31446                messages per $sender_rate_period
31447      ratelimit = ${lookup {$sender_host_address} \
31448                    cdb {DB/ratelimits.cdb} \
31449                    {$value} {RATELIMIT} }
31450 .endd
31451 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31452 especially with the &%per_rcpt%& option, you may suffer from a performance
31453 bottleneck caused by locking on the ratelimit hints database. Apart from
31454 making your ACLs less complicated, you can reduce the problem by using a
31455 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31456 this means that Exim will lose its hints data after a reboot (including retry
31457 hints, the callout cache, and ratelimit data).
31458
31459
31460
31461 .section "Address verification" "SECTaddressverification"
31462 .cindex "verifying address" "options for"
31463 .cindex "policy control" "address verification"
31464 Several of the &%verify%& conditions described in section
31465 &<<SECTaclconditions>>& cause addresses to be verified. Section
31466 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31467 The verification conditions can be followed by options that modify the
31468 verification process. The options are separated from the keyword and from each
31469 other by slashes, and some of them contain parameters. For example:
31470 .code
31471 verify = sender/callout
31472 verify = recipient/defer_ok/callout=10s,defer_ok
31473 .endd
31474 The first stage of address verification, which always happens, is to run the
31475 address through the routers, in &"verify mode"&. Routers can detect the
31476 difference between verification and routing for delivery, and their actions can
31477 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31478 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31479 The available options are as follows:
31480
31481 .ilist
31482 If the &%callout%& option is specified, successful routing to one or more
31483 remote hosts is followed by a &"callout"& to those hosts as an additional
31484 check. Callouts and their sub-options are discussed in the next section.
31485 .next
31486 If there is a defer error while doing verification routing, the ACL
31487 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31488 options, the condition is forced to be true instead. Note that this is a main
31489 verification option as well as a suboption for callouts.
31490 .next
31491 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31492 discusses the reporting of sender address verification failures.
31493 .next
31494 The &%success_on_redirect%& option causes verification always to succeed
31495 immediately after a successful redirection. By default, if a redirection
31496 generates just one address, that address is also verified. See further
31497 discussion in section &<<SECTredirwhilveri>>&.
31498 .endlist
31499
31500 .cindex "verifying address" "differentiating failures"
31501 .vindex "&$recipient_verify_failure$&"
31502 .vindex "&$sender_verify_failure$&"
31503 .vindex "&$acl_verify_message$&"
31504 After an address verification failure, &$acl_verify_message$& contains the
31505 error message that is associated with the failure. It can be preserved by
31506 coding like this:
31507 .code
31508 warn  !verify = sender
31509        set acl_m0 = $acl_verify_message
31510 .endd
31511 If you are writing your own custom rejection message or log message when
31512 denying access, you can use this variable to include information about the
31513 verification failure.
31514
31515 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
31516 appropriate) contains one of the following words:
31517
31518 .ilist
31519 &%qualify%&: The address was unqualified (no domain), and the message
31520 was neither local nor came from an exempted host.
31521 .next
31522 &%route%&: Routing failed.
31523 .next
31524 &%mail%&: Routing succeeded, and a callout was attempted; rejection
31525 occurred at or before the MAIL command (that is, on initial
31526 connection, HELO, or MAIL).
31527 .next
31528 &%recipient%&: The RCPT command in a callout was rejected.
31529 .next
31530 &%postmaster%&: The postmaster check in a callout was rejected.
31531 .endlist
31532
31533 The main use of these variables is expected to be to distinguish between
31534 rejections of MAIL and rejections of RCPT in callouts.
31535
31536 .new
31537 The above variables may also be set after a &*successful*&
31538 address verification to:
31539
31540 .ilist
31541 &%random%&: A random local-part callout succeeded
31542 .endlist
31543 .wen
31544
31545
31546
31547
31548 .section "Callout verification" "SECTcallver"
31549 .cindex "verifying address" "by callout"
31550 .cindex "callout" "verification"
31551 .cindex "SMTP" "callout verification"
31552 For non-local addresses, routing verifies the domain, but is unable to do any
31553 checking of the local part. There are situations where some means of verifying
31554 the local part is desirable. One way this can be done is to make an SMTP
31555 &'callback'& to a delivery host for the sender address or a &'callforward'& to
31556 a subsequent host for a recipient address, to see if the host accepts the
31557 address. We use the term &'callout'& to cover both cases. Note that for a
31558 sender address, the callback is not to the client host that is trying to
31559 deliver the message, but to one of the hosts that accepts incoming mail for the
31560 sender's domain.
31561
31562 Exim does not do callouts by default. If you want them to happen, you must
31563 request them by setting appropriate options on the &%verify%& condition, as
31564 described below. This facility should be used with care, because it can add a
31565 lot of resource usage to the cost of verifying an address. However, Exim does
31566 cache the results of callouts, which helps to reduce the cost. Details of
31567 caching are in section &<<SECTcallvercache>>&.
31568
31569 Recipient callouts are usually used only between hosts that are controlled by
31570 the same administration. For example, a corporate gateway host could use
31571 callouts to check for valid recipients on an internal mailserver. A successful
31572 callout does not guarantee that a real delivery to the address would succeed;
31573 on the other hand, a failing callout does guarantee that a delivery would fail.
31574
31575 If the &%callout%& option is present on a condition that verifies an address, a
31576 second stage of verification occurs if the address is successfully routed to
31577 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
31578 &(manualroute)& router, where the router specifies the hosts. However, if a
31579 router that does not set up hosts routes to an &(smtp)& transport with a
31580 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
31581 &%hosts_override%& set, its hosts are always used, whether or not the router
31582 supplies a host list.
31583 Callouts are only supported on &(smtp)& transports.
31584
31585 The port that is used is taken from the transport, if it is specified and is a
31586 remote transport. (For routers that do verification only, no transport need be
31587 specified.) Otherwise, the default SMTP port is used. If a remote transport
31588 specifies an outgoing interface, this is used; otherwise the interface is not
31589 specified. Likewise, the text that is used for the HELO command is taken from
31590 the transport's &%helo_data%& option; if there is no transport, the value of
31591 &$smtp_active_hostname$& is used.
31592
31593 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
31594 test whether a bounce message could be delivered to the sender address. The
31595 following SMTP commands are sent:
31596 .display
31597 &`HELO `&<&'local host name'&>
31598 &`MAIL FROM:<>`&
31599 &`RCPT TO:`&<&'the address to be tested'&>
31600 &`QUIT`&
31601 .endd
31602 LHLO is used instead of HELO if the transport's &%protocol%& option is
31603 set to &"lmtp"&.
31604
31605 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
31606 settings.
31607
31608 A recipient callout check is similar. By default, it also uses an empty address
31609 for the sender. This default is chosen because most hosts do not make use of
31610 the sender address when verifying a recipient. Using the same address means
31611 that a single cache entry can be used for each recipient. Some sites, however,
31612 do make use of the sender address when verifying. These are catered for by the
31613 &%use_sender%& and &%use_postmaster%& options, described in the next section.
31614
31615 If the response to the RCPT command is a 2&'xx'& code, the verification
31616 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
31617 Exim tries the next host, if any. If there is a problem with all the remote
31618 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
31619 &%callout%& option is given, in which case the condition is forced to succeed.
31620
31621 .cindex "SMTP" "output flushing, disabling for callout"
31622 A callout may take a little time. For this reason, Exim normally flushes SMTP
31623 output before performing a callout in an ACL, to avoid unexpected timeouts in
31624 clients when the SMTP PIPELINING extension is in use. The flushing can be
31625 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
31626
31627
31628
31629
31630 .section "Additional parameters for callouts" "CALLaddparcall"
31631 .cindex "callout" "additional parameters for"
31632 The &%callout%& option can be followed by an equals sign and a number of
31633 optional parameters, separated by commas. For example:
31634 .code
31635 verify = recipient/callout=10s,defer_ok
31636 .endd
31637 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
31638 separate verify options, is retained for backwards compatibility, but is now
31639 deprecated. The additional parameters for &%callout%& are as follows:
31640
31641
31642 .vlist
31643 .vitem <&'a&~time&~interval'&>
31644 .cindex "callout" "timeout, specifying"
31645 This specifies the timeout that applies for the callout attempt to each host.
31646 For example:
31647 .code
31648 verify = sender/callout=5s
31649 .endd
31650 The default is 30 seconds. The timeout is used for each response from the
31651 remote host. It is also used for the initial connection, unless overridden by
31652 the &%connect%& parameter.
31653
31654
31655 .vitem &*connect&~=&~*&<&'time&~interval'&>
31656 .cindex "callout" "connection timeout, specifying"
31657 This parameter makes it possible to set a different (usually smaller) timeout
31658 for making the SMTP connection. For example:
31659 .code
31660 verify = sender/callout=5s,connect=1s
31661 .endd
31662 If not specified, this timeout defaults to the general timeout value.
31663
31664 .vitem &*defer_ok*&
31665 .cindex "callout" "defer, action on"
31666 When this parameter is present, failure to contact any host, or any other kind
31667 of temporary error, is treated as success by the ACL. However, the cache is not
31668 updated in this circumstance.
31669
31670 .vitem &*fullpostmaster*&
31671 .cindex "callout" "full postmaster check"
31672 This operates like the &%postmaster%& option (see below), but if the check for
31673 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
31674 accordance with the specification in RFC 2821. The RFC states that the
31675 unqualified address &'postmaster'& should be accepted.
31676
31677
31678 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
31679 .cindex "callout" "sender when verifying header"
31680 When verifying addresses in header lines using the &%header_sender%&
31681 verification option, Exim behaves by default as if the addresses are envelope
31682 sender addresses from a message. Callout verification therefore tests to see
31683 whether a bounce message could be delivered, by using an empty address in the
31684 MAIL command. However, it is arguable that these addresses might never be used
31685 as envelope senders, and could therefore justifiably reject bounce messages
31686 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
31687 address to use in the MAIL command. For example:
31688 .code
31689 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
31690 .endd
31691 This parameter is available only for the &%header_sender%& verification option.
31692
31693
31694 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
31695 .cindex "callout" "overall timeout, specifying"
31696 This parameter sets an overall timeout for performing a callout verification.
31697 For example:
31698 .code
31699 verify = sender/callout=5s,maxwait=30s
31700 .endd
31701 This timeout defaults to four times the callout timeout for individual SMTP
31702 commands. The overall timeout applies when there is more than one host that can
31703 be tried. The timeout is checked before trying the next host. This prevents
31704 very long delays if there are a large number of hosts and all are timing out
31705 (for example, when network connections are timing out).
31706
31707
31708 .vitem &*no_cache*&
31709 .cindex "callout" "cache, suppressing"
31710 .cindex "caching callout, suppressing"
31711 When this parameter is given, the callout cache is neither read nor updated.
31712
31713 .vitem &*postmaster*&
31714 .cindex "callout" "postmaster; checking"
31715 When this parameter is set, a successful callout check is followed by a similar
31716 check for the local part &'postmaster'& at the same domain. If this address is
31717 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
31718 the postmaster check is recorded in a cache record; if it is a failure, this is
31719 used to fail subsequent callouts for the domain without a connection being
31720 made, until the cache record expires.
31721
31722 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
31723 The postmaster check uses an empty sender in the MAIL command by default.
31724 You can use this parameter to do a postmaster check using a different address.
31725 For example:
31726 .code
31727 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
31728 .endd
31729 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
31730 one overrides. The &%postmaster%& parameter is equivalent to this example:
31731 .code
31732 require  verify = sender/callout=postmaster_mailfrom=
31733 .endd
31734 &*Warning*&: The caching arrangements for postmaster checking do not take
31735 account of the sender address. It is assumed that either the empty address or
31736 a fixed non-empty address will be used. All that Exim remembers is that the
31737 postmaster check for the domain succeeded or failed.
31738
31739
31740 .vitem &*random*&
31741 .cindex "callout" "&""random""& check"
31742 When this parameter is set, before doing the normal callout check, Exim does a
31743 check for a &"random"& local part at the same domain. The local part is not
31744 really random &-- it is defined by the expansion of the option
31745 &%callout_random_local_part%&, which defaults to
31746 .code
31747 $primary_hostname-$tod_epoch-testing
31748 .endd
31749 The idea here is to try to determine whether the remote host accepts all local
31750 parts without checking. If it does, there is no point in doing callouts for
31751 specific local parts. If the &"random"& check succeeds, the result is saved in
31752 a cache record, and used to force the current and subsequent callout checks to
31753 succeed without a connection being made, until the cache record expires.
31754
31755 .vitem &*use_postmaster*&
31756 .cindex "callout" "sender for recipient check"
31757 This parameter applies to recipient callouts only. For example:
31758 .code
31759 deny  !verify = recipient/callout=use_postmaster
31760 .endd
31761 .vindex "&$qualify_domain$&"
31762 It causes a non-empty postmaster address to be used in the MAIL command when
31763 performing the callout for the recipient, and also for a &"random"& check if
31764 that is configured. The local part of the address is &`postmaster`& and the
31765 domain is the contents of &$qualify_domain$&.
31766
31767 .vitem &*use_sender*&
31768 This option applies to recipient callouts only. For example:
31769 .code
31770 require  verify = recipient/callout=use_sender
31771 .endd
31772 It causes the message's actual sender address to be used in the MAIL
31773 command when performing the callout, instead of an empty address. There is no
31774 need to use this option unless you know that the called hosts make use of the
31775 sender when checking recipients. If used indiscriminately, it reduces the
31776 usefulness of callout caching.
31777
31778 .vitem &*hold*&
31779 This option applies to recipient callouts only. For example:
31780 .code
31781 require  verify = recipient/callout=use_sender,hold
31782 .endd
31783 It causes the connection to be held open and used for any further recipients
31784 and for eventual delivery (should that be done quickly).
31785 Doing this saves on TCP and SMTP startup costs, and TLS costs also
31786 when that is used for the connections.
31787 The advantage is only gained if there are no callout cache hits
31788 (which could be enforced by the no_cache option),
31789 if the use_sender option is used,
31790 if neither the random nor the use_postmaster option is used,
31791 and if no other callouts intervene.
31792 .endlist
31793
31794 If you use any of the parameters that set a non-empty sender for the MAIL
31795 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
31796 &%use_sender%&), you should think about possible loops. Recipient checking is
31797 usually done between two hosts that are under the same management, and the host
31798 that receives the callouts is not normally configured to do callouts itself.
31799 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
31800 these circumstances.
31801
31802 However, if you use a non-empty sender address for a callout to an arbitrary
31803 host, there is the likelihood that the remote host will itself initiate a
31804 callout check back to your host. As it is checking what appears to be a message
31805 sender, it is likely to use an empty address in MAIL, thus avoiding a
31806 callout loop. However, to be on the safe side it would be best to set up your
31807 own ACLs so that they do not do sender verification checks when the recipient
31808 is the address you use for header sender or postmaster callout checking.
31809
31810 Another issue to think about when using non-empty senders for callouts is
31811 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
31812 by the sender/recipient combination; thus, for any given recipient, many more
31813 actual callouts are performed than when an empty sender or postmaster is used.
31814
31815
31816
31817
31818 .section "Callout caching" "SECTcallvercache"
31819 .cindex "hints database" "callout cache"
31820 .cindex "callout" "cache, description of"
31821 .cindex "caching" "callout"
31822 Exim caches the results of callouts in order to reduce the amount of resources
31823 used, unless you specify the &%no_cache%& parameter with the &%callout%&
31824 option. A hints database called &"callout"& is used for the cache. Two
31825 different record types are used: one records the result of a callout check for
31826 a specific address, and the other records information that applies to the
31827 entire domain (for example, that it accepts the local part &'postmaster'&).
31828
31829 When an original callout fails, a detailed SMTP error message is given about
31830 the failure. However, for subsequent failures use the cache data, this message
31831 is not available.
31832
31833 The expiry times for negative and positive address cache records are
31834 independent, and can be set by the global options &%callout_negative_expire%&
31835 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
31836
31837 If a host gives a negative response to an SMTP connection, or rejects any
31838 commands up to and including
31839 .code
31840 MAIL FROM:<>
31841 .endd
31842 (but not including the MAIL command with a non-empty address),
31843 any callout attempt is bound to fail. Exim remembers such failures in a
31844 domain cache record, which it uses to fail callouts for the domain without
31845 making new connections, until the domain record times out. There are two
31846 separate expiry times for domain cache records:
31847 &%callout_domain_negative_expire%& (default 3h) and
31848 &%callout_domain_positive_expire%& (default 7d).
31849
31850 Domain records expire when the negative expiry time is reached if callouts
31851 cannot be made for the domain, or if the postmaster check failed.
31852 Otherwise, they expire when the positive expiry time is reached. This
31853 ensures that, for example, a host that stops accepting &"random"& local parts
31854 will eventually be noticed.
31855
31856 The callout caching mechanism is based on the domain of the address that is
31857 being tested. If the domain routes to several hosts, it is assumed that their
31858 behaviour will be the same.
31859
31860
31861
31862 .section "Sender address verification reporting" "SECTsenaddver"
31863 .cindex "verifying" "suppressing error details"
31864 See section &<<SECTaddressverification>>& for a general discussion of
31865 verification. When sender verification fails in an ACL, the details of the
31866 failure are given as additional output lines before the 550 response to the
31867 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
31868 you might see:
31869 .code
31870 MAIL FROM:<xyz@abc.example>
31871 250 OK
31872 RCPT TO:<pqr@def.example>
31873 550-Verification failed for <xyz@abc.example>
31874 550-Called:   192.168.34.43
31875 550-Sent:     RCPT TO:<xyz@abc.example>
31876 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
31877 550 Sender verification failed
31878 .endd
31879 If more than one RCPT command fails in the same way, the details are given
31880 only for the first of them. However, some administrators do not want to send
31881 out this much information. You can suppress the details by adding
31882 &`/no_details`& to the ACL statement that requests sender verification. For
31883 example:
31884 .code
31885 verify = sender/no_details
31886 .endd
31887
31888 .section "Redirection while verifying" "SECTredirwhilveri"
31889 .cindex "verifying" "redirection while"
31890 .cindex "address redirection" "while verifying"
31891 A dilemma arises when a local address is redirected by aliasing or forwarding
31892 during verification: should the generated addresses themselves be verified,
31893 or should the successful expansion of the original address be enough to verify
31894 it? By default, Exim takes the following pragmatic approach:
31895
31896 .ilist
31897 When an incoming address is redirected to just one child address, verification
31898 continues with the child address, and if that fails to verify, the original
31899 verification also fails.
31900 .next
31901 When an incoming address is redirected to more than one child address,
31902 verification does not continue. A success result is returned.
31903 .endlist
31904
31905 This seems the most reasonable behaviour for the common use of aliasing as a
31906 way of redirecting different local parts to the same mailbox. It means, for
31907 example, that a pair of alias entries of the form
31908 .code
31909 A.Wol:   aw123
31910 aw123:   :fail: Gone away, no forwarding address
31911 .endd
31912 work as expected, with both local parts causing verification failure. When a
31913 redirection generates more than one address, the behaviour is more like a
31914 mailing list, where the existence of the alias itself is sufficient for
31915 verification to succeed.
31916
31917 It is possible, however, to change the default behaviour so that all successful
31918 redirections count as successful verifications, however many new addresses are
31919 generated. This is specified by the &%success_on_redirect%& verification
31920 option. For example:
31921 .code
31922 require verify = recipient/success_on_redirect/callout=10s
31923 .endd
31924 In this example, verification succeeds if a router generates a new address, and
31925 the callout does not occur, because no address was routed to a remote host.
31926
31927 When verification is being tested via the &%-bv%& option, the treatment of
31928 redirections is as just described, unless the &%-v%& or any debugging option is
31929 also specified. In that case, full verification is done for every generated
31930 address and a report is output for each of them.
31931
31932
31933
31934 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31935 .cindex "CSA" "verifying"
31936 Client SMTP Authorization is a system that allows a site to advertise
31937 which machines are and are not permitted to send email. This is done by placing
31938 special SRV records in the DNS; these are looked up using the client's HELO
31939 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31940 Authorization checks in Exim are performed by the ACL condition:
31941 .code
31942 verify = csa
31943 .endd
31944 This fails if the client is not authorized. If there is a DNS problem, or if no
31945 valid CSA SRV record is found, or if the client is authorized, the condition
31946 succeeds. These three cases can be distinguished using the expansion variable
31947 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31948 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31949 be likely to cause problems for legitimate email.
31950
31951 The error messages produced by the CSA code include slightly more
31952 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31953 looking up the CSA SRV record, or problems looking up the CSA target
31954 address record. There are four reasons for &$csa_status$& being &"fail"&:
31955
31956 .ilist
31957 The client's host name is explicitly not authorized.
31958 .next
31959 The client's IP address does not match any of the CSA target IP addresses.
31960 .next
31961 The client's host name is authorized but it has no valid target IP addresses
31962 (for example, the target's addresses are IPv6 and the client is using IPv4).
31963 .next
31964 The client's host name has no CSA SRV record but a parent domain has asserted
31965 that all subdomains must be explicitly authorized.
31966 .endlist
31967
31968 The &%csa%& verification condition can take an argument which is the domain to
31969 use for the DNS query. The default is:
31970 .code
31971 verify = csa/$sender_helo_name
31972 .endd
31973 This implementation includes an extension to CSA. If the query domain
31974 is an address literal such as [192.0.2.95], or if it is a bare IP
31975 address, Exim searches for CSA SRV records in the reverse DNS as if
31976 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31977 meaningful to say:
31978 .code
31979 verify = csa/$sender_host_address
31980 .endd
31981 In fact, this is the check that Exim performs if the client does not say HELO.
31982 This extension can be turned off by setting the main configuration option
31983 &%dns_csa_use_reverse%& to be false.
31984
31985 If a CSA SRV record is not found for the domain itself, a search
31986 is performed through its parent domains for a record which might be
31987 making assertions about subdomains. The maximum depth of this search is limited
31988 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31989 default. Exim does not look for CSA SRV records in a top level domain, so the
31990 default settings handle HELO domains as long as seven
31991 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31992 of legitimate HELO domains.
31993
31994 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31995 direct SRV lookups, this is not sufficient because of the extra parent domain
31996 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31997 addresses into lookups in the reverse DNS space. The result of a successful
31998 lookup such as:
31999 .code
32000 ${lookup dnsdb {csa=$sender_helo_name}}
32001 .endd
32002 has two space-separated fields: an authorization code and a target host name.
32003 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32004 authorization required but absent, or &"?"& for unknown.
32005
32006
32007
32008
32009 .section "Bounce address tag validation" "SECTverifyPRVS"
32010 .cindex "BATV, verifying"
32011 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32012 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32013 Genuine incoming bounce messages should therefore always be addressed to
32014 recipients that have a valid tag. This scheme is a way of detecting unwanted
32015 bounce messages caused by sender address forgeries (often called &"collateral
32016 spam"&), because the recipients of such messages do not include valid tags.
32017
32018 There are two expansion items to help with the implementation of the BATV
32019 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32020 the original envelope sender address by using a simple key to add a hash of the
32021 address and some time-based randomizing information. The &%prvs%& expansion
32022 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32023 The syntax of these expansion items is described in section
32024 &<<SECTexpansionitems>>&.
32025 The validity period on signed addresses is seven days.
32026
32027 As an example, suppose the secret per-address keys are stored in an MySQL
32028 database. A query to look up the key for an address could be defined as a macro
32029 like this:
32030 .code
32031 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32032                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32033                 }{$value}}
32034 .endd
32035 Suppose also that the senders who make use of BATV are defined by an address
32036 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32037 use this:
32038 .code
32039 # Bounces: drop unsigned addresses for BATV senders
32040 deny message = This address does not send an unsigned reverse path
32041      senders = :
32042      recipients = +batv_senders
32043
32044 # Bounces: In case of prvs-signed address, check signature.
32045 deny message = Invalid reverse path signature.
32046      senders = :
32047      condition  = ${prvscheck {$local_part@$domain}\
32048                   {PRVSCHECK_SQL}{1}}
32049      !condition = $prvscheck_result
32050 .endd
32051 The first statement rejects recipients for bounce messages that are addressed
32052 to plain BATV sender addresses, because it is known that BATV senders do not
32053 send out messages with plain sender addresses. The second statement rejects
32054 recipients that are prvs-signed, but with invalid signatures (either because
32055 the key is wrong, or the signature has timed out).
32056
32057 A non-prvs-signed address is not rejected by the second statement, because the
32058 &%prvscheck%& expansion yields an empty string if its first argument is not a
32059 prvs-signed address, thus causing the &%condition%& condition to be false. If
32060 the first argument is a syntactically valid prvs-signed address, the yield is
32061 the third string (in this case &"1"&), whether or not the cryptographic and
32062 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32063 of the checks (empty for failure, &"1"& for success).
32064
32065 There is one more issue you must consider when implementing prvs-signing:
32066 you have to ensure that the routers accept prvs-signed addresses and
32067 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32068 router to remove the signature with a configuration along these lines:
32069 .code
32070 batv_redirect:
32071   driver = redirect
32072   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32073 .endd
32074 This works because, if the third argument of &%prvscheck%& is empty, the result
32075 of the expansion of a prvs-signed address is the decoded value of the original
32076 address. This router should probably be the first of your routers that handles
32077 local addresses.
32078
32079 To create BATV-signed addresses in the first place, a transport of this form
32080 can be used:
32081 .code
32082 external_smtp_batv:
32083   driver = smtp
32084   return_path = ${prvs {$return_path} \
32085                        {${lookup mysql{SELECT \
32086                        secret FROM batv_prvs WHERE \
32087                        sender='${quote_mysql:$sender_address}'} \
32088                        {$value}fail}}}
32089 .endd
32090 If no key can be found for the existing return path, no signing takes place.
32091
32092
32093
32094 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32095 .cindex "&ACL;" "relay control"
32096 .cindex "relaying" "control by ACL"
32097 .cindex "policy control" "relay control"
32098 An MTA is said to &'relay'& a message if it receives it from some host and
32099 delivers it directly to another host as a result of a remote address contained
32100 within it. Redirecting a local address via an alias or forward file and then
32101 passing the message on to another host is not relaying,
32102 .cindex "&""percent hack""&"
32103 but a redirection as a result of the &"percent hack"& is.
32104
32105 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32106 A host which is acting as a gateway or an MX backup is concerned with incoming
32107 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32108 a host which is acting as a smart host for a number of clients is concerned
32109 with outgoing relaying from those clients to the Internet at large. Often the
32110 same host is fulfilling both functions,
32111 . ///
32112 . as illustrated in the diagram below,
32113 . ///
32114 but in principle these two kinds of relaying are entirely independent. What is
32115 not wanted is the transmission of mail from arbitrary remote hosts through your
32116 system to arbitrary domains.
32117
32118
32119 You can implement relay control by means of suitable statements in the ACL that
32120 runs for each RCPT command. For convenience, it is often easiest to use
32121 Exim's named list facility to define the domains and hosts involved. For
32122 example, suppose you want to do the following:
32123
32124 .ilist
32125 Deliver a number of domains to mailboxes on the local host (or process them
32126 locally in some other way). Let's say these are &'my.dom1.example'& and
32127 &'my.dom2.example'&.
32128 .next
32129 Relay mail for a number of other domains for which you are the secondary MX.
32130 These might be &'friend1.example'& and &'friend2.example'&.
32131 .next
32132 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32133 Suppose your LAN is 192.168.45.0/24.
32134 .endlist
32135
32136
32137 In the main part of the configuration, you put the following definitions:
32138 .code
32139 domainlist local_domains    = my.dom1.example : my.dom2.example
32140 domainlist relay_to_domains = friend1.example : friend2.example
32141 hostlist   relay_from_hosts = 192.168.45.0/24
32142 .endd
32143 Now you can use these definitions in the ACL that is run for every RCPT
32144 command:
32145 .code
32146 acl_check_rcpt:
32147   accept domains = +local_domains : +relay_to_domains
32148   accept hosts   = +relay_from_hosts
32149 .endd
32150 The first statement accepts any RCPT command that contains an address in
32151 the local or relay domains. For any other domain, control passes to the second
32152 statement, which accepts the command only if it comes from one of the relay
32153 hosts. In practice, you will probably want to make your ACL more sophisticated
32154 than this, for example, by including sender and recipient verification. The
32155 default configuration includes a more comprehensive example, which is described
32156 in chapter &<<CHAPdefconfil>>&.
32157
32158
32159
32160 .section "Checking a relay configuration" "SECTcheralcon"
32161 .cindex "relaying" "checking control of"
32162 You can check the relay characteristics of your configuration in the same way
32163 that you can test any ACL behaviour for an incoming SMTP connection, by using
32164 the &%-bh%& option to run a fake SMTP session with which you interact.
32165 .ecindex IIDacl
32166
32167
32168
32169 . ////////////////////////////////////////////////////////////////////////////
32170 . ////////////////////////////////////////////////////////////////////////////
32171
32172 .chapter "Content scanning at ACL time" "CHAPexiscan"
32173 .scindex IIDcosca "content scanning" "at ACL time"
32174 The extension of Exim to include content scanning at ACL time, formerly known
32175 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32176 was integrated into the main source for Exim release 4.50, and Tom continues to
32177 maintain it. Most of the wording of this chapter is taken from Tom's
32178 specification.
32179
32180 It is also possible to scan the content of messages at other times. The
32181 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32182 scanning after all the ACLs have run. A transport filter can be used to scan
32183 messages at delivery time (see the &%transport_filter%& option, described in
32184 chapter &<<CHAPtransportgeneric>>&).
32185
32186 If you want to include the ACL-time content-scanning features when you compile
32187 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32188 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32189
32190 .ilist
32191 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32192 for all MIME parts for SMTP and non-SMTP messages, respectively.
32193 .next
32194 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32195 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32196 run at the end of message reception (the &%acl_smtp_data%& ACL).
32197 .next
32198 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32199 of messages, or parts of messages, for debugging purposes.
32200 .next
32201 Additional expansion variables that are set in the new ACL and by the new
32202 conditions.
32203 .next
32204 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32205 .endlist
32206
32207 Content-scanning is continually evolving, and new features are still being
32208 added. While such features are still unstable and liable to incompatible
32209 changes, they are made available in Exim by setting options whose names begin
32210 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32211 this manual. You can find out about them by reading the file called
32212 &_doc/experimental.txt_&.
32213
32214 All the content-scanning facilities work on a MBOX copy of the message that is
32215 temporarily created in a file called:
32216 .display
32217 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32218 .endd
32219 The &_.eml_& extension is a friendly hint to virus scanners that they can
32220 expect an MBOX-like structure inside that file. The file is created when the
32221 first content scanning facility is called. Subsequent calls to content
32222 scanning conditions open the same file again. The directory is recursively
32223 removed when the &%acl_smtp_data%& ACL has finished running, unless
32224 .code
32225 control = no_mbox_unspool
32226 .endd
32227 has been encountered. When the MIME ACL decodes files, they are put into the
32228 same directory by default.
32229
32230
32231
32232 .section "Scanning for viruses" "SECTscanvirus"
32233 .cindex "virus scanning"
32234 .cindex "content scanning" "for viruses"
32235 .cindex "content scanning" "the &%malware%& condition"
32236 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32237 It supports a &"generic"& interface to scanners called via the shell, and
32238 specialized interfaces for &"daemon"& type virus scanners, which are resident
32239 in memory and thus are much faster.
32240
32241 A timeout of 2 minutes is applied to a scanner call (by default);
32242 if it expires then a defer action is taken.
32243
32244 .oindex "&%av_scanner%&"
32245 You can set the &%av_scanner%& option in the main part of the configuration
32246 to specify which scanner to use, together with any additional options that
32247 are needed. The basic syntax is as follows:
32248 .display
32249 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32250 .endd
32251 If you do not set &%av_scanner%&, it defaults to
32252 .code
32253 av_scanner = sophie:/var/run/sophie
32254 .endd
32255 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32256 before use.
32257 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32258 The following scanner types are supported in this release,
32259 though individual ones can be included or not at build time:
32260
32261 .vlist
32262 .vitem &%avast%&
32263 .cindex "virus scanners" "avast"
32264 This is the scanner daemon of Avast. It has been tested with Avast Core
32265 Security (currently at version 2.2.0).
32266 You can get a trial version at &url(https://www.avast.com) or for Linux
32267 at &url(https://www.avast.com/linux-server-antivirus).
32268 This scanner type takes one option,
32269 which can be either a full path to a UNIX socket,
32270 or host and port specifiers separated by white space.
32271 The host may be a name or an IP address; the port is either a
32272 single number or a pair of numbers with a dash between.
32273 A list of options may follow. These options are interpreted on the
32274 Exim's side of the malware scanner, or are given on separate lines to
32275 the daemon as options before the main scan command.
32276
32277 .cindex &`pass_unscanned`& "avast"
32278 If &`pass_unscanned`&
32279 is set, any files the Avast scanner can't scan (e.g.
32280 decompression bombs, or invalid archives) are considered clean. Use with
32281 care.
32282
32283 For example:
32284 .code
32285 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32286 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32287 av_scanner = avast:192.168.2.22 5036
32288 .endd
32289 If you omit the argument, the default path
32290 &_/var/run/avast/scan.sock_&
32291 is used.
32292 If you use a remote host,
32293 you need to make Exim's spool directory available to it,
32294 as the scanner is passed a file path, not file contents.
32295 For information about available commands and their options you may use
32296 .code
32297 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32298     FLAGS
32299     SENSITIVITY
32300     PACK
32301 .endd
32302
32303 If the scanner returns a temporary failure (e.g. license issues, or
32304 permission problems), the message is deferred and a paniclog entry is
32305 written.  The usual &`defer_ok`& option is available.
32306
32307 .vitem &%aveserver%&
32308 .cindex "virus scanners" "Kaspersky"
32309 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32310 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32311 which is the path to the daemon's UNIX socket. The default is shown in this
32312 example:
32313 .code
32314 av_scanner = aveserver:/var/run/aveserver
32315 .endd
32316
32317
32318 .vitem &%clamd%&
32319 .cindex "virus scanners" "clamd"
32320 This daemon-type scanner is GPL and free. You can get it at
32321 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32322 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32323 in the MIME ACL. This is no longer believed to be necessary.
32324
32325 The options are a list of server specifiers, which may be
32326 a UNIX socket specification,
32327 a TCP socket specification,
32328 or a (global) option.
32329
32330 A socket specification consists of a space-separated list.
32331 For a Unix socket the first element is a full path for the socket,
32332 for a TCP socket the first element is the IP address
32333 and the second a port number,
32334 Any further elements are per-server (non-global) options.
32335 These per-server options are supported:
32336 .code
32337 retry=<timespec>        Retry on connect fail
32338 .endd
32339
32340 The &`retry`& option specifies a time after which a single retry for
32341 a failed connect is made.  The default is to not retry.
32342
32343 If a Unix socket file is specified, only one server is supported.
32344
32345 Examples:
32346 .code
32347 av_scanner = clamd:/opt/clamd/socket
32348 av_scanner = clamd:192.0.2.3 1234
32349 av_scanner = clamd:192.0.2.3 1234:local
32350 av_scanner = clamd:192.0.2.3 1234 retry=10s
32351 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32352 .endd
32353 If the value of av_scanner points to a UNIX socket file or contains the
32354 &`local`&
32355 option, then the ClamAV interface will pass a filename containing the data
32356 to be scanned, which should normally result in less I/O happening and be
32357 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32358 Exim does not assume that there is a common filesystem with the remote host.
32359
32360 The final example shows that multiple TCP targets can be specified.  Exim will
32361 randomly use one for each incoming email (i.e. it load balances them).  Note
32362 that only TCP targets may be used if specifying a list of scanners; a UNIX
32363 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32364 unavailable, Exim will try the remaining one(s) until it finds one that works.
32365 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32366 not keep track of scanner state between multiple messages, and the scanner
32367 selection is random, so the message will get logged in the mainlog for each
32368 email that the down scanner gets chosen first (message wrapped to be readable):
32369 .code
32370 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32371    clamd: connection to localhost, port 3310 failed
32372    (Connection refused)
32373 .endd
32374
32375 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32376 contributing the code for this scanner.
32377
32378 .vitem &%cmdline%&
32379 .cindex "virus scanners" "command line interface"
32380 This is the keyword for the generic command line scanner interface. It can be
32381 used to attach virus scanners that are invoked from the shell. This scanner
32382 type takes 3 mandatory options:
32383
32384 .olist
32385 The full path and name of the scanner binary, with all command line options,
32386 and a placeholder (&`%s`&) for the directory to scan.
32387
32388 .next
32389 A regular expression to match against the STDOUT and STDERR output of the
32390 virus scanner. If the expression matches, a virus was found. You must make
32391 absolutely sure that this expression matches on &"virus found"&. This is called
32392 the &"trigger"& expression.
32393
32394 .next
32395 Another regular expression, containing exactly one pair of parentheses, to
32396 match the name of the virus found in the scanners output. This is called the
32397 &"name"& expression.
32398 .endlist olist
32399
32400 For example, Sophos Sweep reports a virus on a line like this:
32401 .code
32402 Virus 'W32/Magistr-B' found in file ./those.bat
32403 .endd
32404 For the trigger expression, we can match the phrase &"found in file"&. For the
32405 name expression, we want to extract the W32/Magistr-B string, so we can match
32406 for the single quotes left and right of it. Altogether, this makes the
32407 configuration setting:
32408 .code
32409 av_scanner = cmdline:\
32410              /path/to/sweep -ss -all -rec -archive %s:\
32411              found in file:'(.+)'
32412 .endd
32413 .vitem &%drweb%&
32414 .cindex "virus scanners" "DrWeb"
32415 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32416 takes one option,
32417 either a full path to a UNIX socket,
32418 or host and port specifiers separated by white space.
32419 The host may be a name or an IP address; the port is either a
32420 single number or a pair of numbers with a dash between.
32421 For example:
32422 .code
32423 av_scanner = drweb:/var/run/drwebd.sock
32424 av_scanner = drweb:192.168.2.20 31337
32425 .endd
32426 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32427 is used. Thanks to Alex Miller for contributing the code for this scanner.
32428
32429 .vitem &%f-protd%&
32430 .cindex "virus scanners" "f-protd"
32431 The f-protd scanner is accessed via HTTP over TCP.
32432 One argument is taken, being a space-separated hostname and port number
32433 (or port-range).
32434 For example:
32435 .code
32436 av_scanner = f-protd:localhost 10200-10204
32437 .endd
32438 If you omit the argument, the default values shown above are used.
32439
32440 .vitem &%f-prot6d%&
32441 .cindex "virus scanners" "f-prot6d"
32442 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32443 One argument is taken, being a space-separated hostname and port number.
32444 For example:
32445 .code
32446 av_scanner = f-prot6d:localhost 10200
32447 .endd
32448 If you omit the argument, the default values show above are used.
32449
32450 .vitem &%fsecure%&
32451 .cindex "virus scanners" "F-Secure"
32452 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32453 argument which is the path to a UNIX socket. For example:
32454 .code
32455 av_scanner = fsecure:/path/to/.fsav
32456 .endd
32457 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32458 Thelmen for contributing the code for this scanner.
32459
32460 .vitem &%kavdaemon%&
32461 .cindex "virus scanners" "Kaspersky"
32462 This is the scanner daemon of Kaspersky Version 4. This version of the
32463 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32464 scanner type takes one option, which is the path to the daemon's UNIX socket.
32465 For example:
32466 .code
32467 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32468 .endd
32469 The default path is &_/var/run/AvpCtl_&.
32470
32471 .vitem &%mksd%&
32472 .cindex "virus scanners" "mksd"
32473 This was a daemon type scanner that is aimed mainly at Polish users,
32474 though some documentation was available in English.
32475 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32476 and this appears to be a candidate for removal from Exim, unless
32477 we are informed of other virus scanners which use the same protocol
32478 to integrate.
32479 The only option for this scanner type is
32480 the maximum number of processes used simultaneously to scan the attachments,
32481 provided that mksd has
32482 been run with at least the same number of child processes. For example:
32483 .code
32484 av_scanner = mksd:2
32485 .endd
32486 You can safely omit this option (the default value is 1).
32487
32488 .vitem &%sock%&
32489 .cindex "virus scanners" "simple socket-connected"
32490 This is a general-purpose way of talking to simple scanner daemons
32491 running on the local machine.
32492 There are four options:
32493 an address (which may be an IP address and port, or the path of a Unix socket),
32494 a commandline to send (may include a single %s which will be replaced with
32495 the path to the mail file to be scanned),
32496 an RE to trigger on from the returned data,
32497 and an RE to extract malware_name from the returned data.
32498 For example:
32499 .code
32500 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
32501 .endd
32502 Note that surrounding whitespace is stripped from each option, meaning
32503 there is no way to specify a trailing newline.
32504 The socket specifier and both regular-expressions are required.
32505 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
32506 specify an empty element to get this.
32507
32508 .vitem &%sophie%&
32509 .cindex "virus scanners" "Sophos and Sophie"
32510 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
32511 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
32512 for this scanner type is the path to the UNIX socket that Sophie uses for
32513 client communication. For example:
32514 .code
32515 av_scanner = sophie:/tmp/sophie
32516 .endd
32517 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
32518 the option.
32519 .endlist
32520
32521 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
32522 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
32523 ACL.
32524
32525 The &%av_scanner%& option is expanded each time &%malware%& is called. This
32526 makes it possible to use different scanners. See further below for an example.
32527 The &%malware%& condition caches its results, so when you use it multiple times
32528 for the same message, the actual scanning process is only carried out once.
32529 However, using expandable items in &%av_scanner%& disables this caching, in
32530 which case each use of the &%malware%& condition causes a new scan of the
32531 message.
32532
32533 The &%malware%& condition takes a right-hand argument that is expanded before
32534 use and taken as a list, slash-separated by default.
32535 The first element can then be one of
32536
32537 .ilist
32538 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
32539 The condition succeeds if a virus was found, and fail otherwise. This is the
32540 recommended usage.
32541 .next
32542 &"false"& or &"0"& or an empty string, in which case no scanning is done and
32543 the condition fails immediately.
32544 .next
32545 A regular expression, in which case the message is scanned for viruses. The
32546 condition succeeds if a virus is found and its name matches the regular
32547 expression. This allows you to take special actions on certain types of virus.
32548 Note that &"/"& characters in the RE must be doubled due to the list-processing,
32549 unless the separator is changed (in the usual way).
32550 .endlist
32551
32552 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
32553 messages even if there is a problem with the virus scanner.
32554 Otherwise, such a problem causes the ACL to defer.
32555
32556 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
32557 specify a non-default timeout.  The default is two minutes.
32558 For example:
32559 .code
32560 malware = * / defer_ok / tmo=10s
32561 .endd
32562 A timeout causes the ACL to defer.
32563
32564 .vindex "&$callout_address$&"
32565 When a connection is made to the scanner the expansion variable &$callout_address$&
32566 is set to record the actual address used.
32567
32568 .vindex "&$malware_name$&"
32569 When a virus is found, the condition sets up an expansion variable called
32570 &$malware_name$& that contains the name of the virus. You can use it in a
32571 &%message%& modifier that specifies the error returned to the sender, and/or in
32572 logging data.
32573
32574 Beware the interaction of Exim's &%message_size_limit%& with any size limits
32575 imposed by your anti-virus scanner.
32576
32577 Here is a very simple scanning example:
32578 .code
32579 deny message = This message contains malware ($malware_name)
32580      malware = *
32581 .endd
32582 The next example accepts messages when there is a problem with the scanner:
32583 .code
32584 deny message = This message contains malware ($malware_name)
32585      malware = */defer_ok
32586 .endd
32587 The next example shows how to use an ACL variable to scan with both sophie and
32588 aveserver. It assumes you have set:
32589 .code
32590 av_scanner = $acl_m0
32591 .endd
32592 in the main Exim configuration.
32593 .code
32594 deny message = This message contains malware ($malware_name)
32595      set acl_m0 = sophie
32596      malware = *
32597
32598 deny message = This message contains malware ($malware_name)
32599      set acl_m0 = aveserver
32600      malware = *
32601 .endd
32602
32603
32604 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
32605 .cindex "content scanning" "for spam"
32606 .cindex "spam scanning"
32607 .cindex "SpamAssassin"
32608 .cindex "Rspamd"
32609 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
32610 score and a report for the message.
32611 Support is also provided for Rspamd.
32612
32613 For more information about installation and configuration of SpamAssassin or
32614 Rspamd refer to their respective websites at
32615 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
32616
32617 SpamAssassin can be installed with CPAN by running:
32618 .code
32619 perl -MCPAN -e 'install Mail::SpamAssassin'
32620 .endd
32621 SpamAssassin has its own set of configuration files. Please review its
32622 documentation to see how you can tweak it. The default installation should work
32623 nicely, however.
32624
32625 .oindex "&%spamd_address%&"
32626 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
32627 intend to use an instance running on the local host you do not need to set
32628 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
32629 you must set the &%spamd_address%& option in the global part of the Exim
32630 configuration as follows (example):
32631 .code
32632 spamd_address = 192.168.99.45 387
32633 .endd
32634 The SpamAssassin protocol relies on a TCP half-close from the client.
32635 If your SpamAssassin client side is running a Linux system with an
32636 iptables firewall, consider setting
32637 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
32638 timeout, Exim uses when waiting for a response from the SpamAssassin
32639 server (currently defaulting to 120s).  With a lower value the Linux
32640 connection tracking may consider your half-closed connection as dead too
32641 soon.
32642
32643
32644 To use Rspamd (which by default listens on all local addresses
32645 on TCP port 11333)
32646 you should add &%variant=rspamd%& after the address/port pair, for example:
32647 .code
32648 spamd_address = 127.0.0.1 11333 variant=rspamd
32649 .endd
32650
32651 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
32652 sockets. If you want to us these, supply &%spamd_address%& with an absolute
32653 file name instead of an address/port pair:
32654 .code
32655 spamd_address = /var/run/spamd_socket
32656 .endd
32657 You can have multiple &%spamd%& servers to improve scalability. These can
32658 reside on other hardware reachable over the network. To specify multiple
32659 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
32660 option, separated with colons (the separator can be changed in the usual way):
32661 .code
32662 spamd_address = 192.168.2.10 783 : \
32663                 192.168.2.11 783 : \
32664                 192.168.2.12 783
32665 .endd
32666 Up to 32 &%spamd%& servers are supported.
32667 When a server fails to respond to the connection attempt, all other
32668 servers are tried until one succeeds. If no server responds, the &%spam%&
32669 condition defers.
32670
32671 Unix and TCP socket specifications may be mixed in any order.
32672 Each element of the list is a list itself, space-separated by default
32673 and changeable in the usual way; take care to not double the separator.
32674
32675 For TCP socket specifications a host name or IP (v4 or v6, but
32676 subject to list-separator quoting rules) address can be used,
32677 and the port can be one or a dash-separated pair.
32678 In the latter case, the range is tried in strict order.
32679
32680 Elements after the first for Unix sockets, or second for TCP socket,
32681 are options.
32682 The supported options are:
32683 .code
32684 pri=<priority>      Selection priority
32685 weight=<value>      Selection bias
32686 time=<start>-<end>  Use only between these times of day
32687 retry=<timespec>    Retry on connect fail
32688 tmo=<timespec>      Connection time limit
32689 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
32690 .endd
32691
32692 The &`pri`& option specifies a priority for the server within the list,
32693 higher values being tried first.
32694 The default priority is 1.
32695
32696 The &`weight`& option specifies a selection bias.
32697 Within a priority set
32698 servers are queried in a random fashion, weighted by this value.
32699 The default value for selection bias is 1.
32700
32701 Time specifications for the &`time`& option are <hour>.<minute>.<second>
32702 in the local time zone; each element being one or more digits.
32703 Either the seconds or both minutes and seconds, plus the leading &`.`&
32704 characters, may be omitted and will be taken as zero.
32705
32706 Timeout specifications for the &`retry`& and &`tmo`& options
32707 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
32708
32709 The &`tmo`& option specifies an overall timeout for communication.
32710 The default value is two minutes.
32711
32712 The &`retry`& option specifies a time after which a single retry for
32713 a failed connect is made.
32714 The default is to not retry.
32715
32716 The &%spamd_address%& variable is expanded before use if it starts with
32717 a dollar sign. In this case, the expansion may return a string that is
32718 used as the list so that multiple spamd servers can be the result of an
32719 expansion.
32720
32721 .vindex "&$callout_address$&"
32722 When a connection is made to the server the expansion variable &$callout_address$&
32723 is set to record the actual address used.
32724
32725 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
32726 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
32727 .code
32728 deny message = This message was classified as SPAM
32729      spam = joe
32730 .endd
32731 The right-hand side of the &%spam%& condition specifies a name. This is
32732 relevant if you have set up multiple SpamAssassin profiles. If you do not want
32733 to scan using a specific profile, but rather use the SpamAssassin system-wide
32734 default profile, you can scan for an unknown name, or simply use &"nobody"&.
32735 Rspamd does not use this setting. However, you must put something on the
32736 right-hand side.
32737
32738 The name allows you to use per-domain or per-user antispam profiles in
32739 principle, but this is not straightforward in practice, because a message may
32740 have multiple recipients, not necessarily all in the same domain. Because the
32741 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
32742 read the contents of the message, the variables &$local_part$& and &$domain$&
32743 are not set.
32744 Careful enforcement of single-recipient messages
32745 (e.g. by responding with defer in the recipient ACL for all recipients
32746 after the first),
32747 or the use of PRDR,
32748 .cindex "PRDR" "use for per-user SpamAssassin profiles"
32749 are needed to use this feature.
32750
32751 The right-hand side of the &%spam%& condition is expanded before being used, so
32752 you can put lookups or conditions there. When the right-hand side evaluates to
32753 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
32754
32755
32756 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
32757 large ones may cause significant performance degradation. As most spam messages
32758 are quite small, it is recommended that you do not scan the big ones. For
32759 example:
32760 .code
32761 deny message = This message was classified as SPAM
32762      condition = ${if < {$message_size}{10K}}
32763      spam = nobody
32764 .endd
32765
32766 The &%spam%& condition returns true if the threshold specified in the user's
32767 SpamAssassin profile has been matched or exceeded. If you want to use the
32768 &%spam%& condition for its side effects (see the variables below), you can make
32769 it always return &"true"& by appending &`:true`& to the username.
32770
32771 .cindex "spam scanning" "returned variables"
32772 When the &%spam%& condition is run, it sets up a number of expansion
32773 variables.
32774 Except for &$spam_report$&,
32775 these variables are saved with the received message so are
32776 available for use at delivery time.
32777
32778 .vlist
32779 .vitem &$spam_score$&
32780 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
32781 for inclusion in log or reject messages.
32782
32783 .vitem &$spam_score_int$&
32784 The spam score of the message, multiplied by ten, as an integer value. For
32785 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
32786 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
32787 The integer value is useful for numeric comparisons in conditions.
32788
32789 .vitem &$spam_bar$&
32790 A string consisting of a number of &"+"& or &"-"& characters, representing the
32791 integer part of the spam score value. A spam score of 4.4 would have a
32792 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
32793 headers, since MUAs can match on such strings. The maximum length of the
32794 spam bar is 50 characters.
32795
32796 .vitem &$spam_report$&
32797 A multiline text table, containing the full SpamAssassin report for the
32798 message. Useful for inclusion in headers or reject messages.
32799 This variable is only usable in a DATA-time ACL.
32800 Beware that SpamAssassin may return non-ASCII characters, especially
32801 when running in country-specific locales, which are not legal
32802 unencoded in headers.
32803
32804 .vitem &$spam_action$&
32805 For SpamAssassin either 'reject' or 'no action' depending on the
32806 spam score versus threshold.
32807 For Rspamd, the recommended action.
32808
32809 .endlist
32810
32811 The &%spam%& condition caches its results unless expansion in
32812 spamd_address was used. If you call it again with the same user name, it
32813 does not scan again, but rather returns the same values as before.
32814
32815 The &%spam%& condition returns DEFER if there is any error while running
32816 the message through SpamAssassin or if the expansion of spamd_address
32817 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
32818 statement block), append &`/defer_ok`& to the right-hand side of the
32819 spam condition, like this:
32820 .code
32821 deny message = This message was classified as SPAM
32822      spam    = joe/defer_ok
32823 .endd
32824 This causes messages to be accepted even if there is a problem with &%spamd%&.
32825
32826 Here is a longer, commented example of the use of the &%spam%&
32827 condition:
32828 .code
32829 # put headers in all messages (no matter if spam or not)
32830 warn  spam = nobody:true
32831       add_header = X-Spam-Score: $spam_score ($spam_bar)
32832       add_header = X-Spam-Report: $spam_report
32833
32834 # add second subject line with *SPAM* marker when message
32835 # is over threshold
32836 warn  spam = nobody
32837       add_header = Subject: *SPAM* $h_Subject:
32838
32839 # reject spam at high scores (> 12)
32840 deny  message = This message scored $spam_score spam points.
32841       spam = nobody:true
32842       condition = ${if >{$spam_score_int}{120}{1}{0}}
32843 .endd
32844
32845
32846
32847 .section "Scanning MIME parts" "SECTscanmimepart"
32848 .cindex "content scanning" "MIME parts"
32849 .cindex "MIME content scanning"
32850 .oindex "&%acl_smtp_mime%&"
32851 .oindex "&%acl_not_smtp_mime%&"
32852 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
32853 each MIME part of an SMTP message, including multipart types, in the sequence
32854 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
32855 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
32856 options may both refer to the same ACL if you want the same processing in both
32857 cases.
32858
32859 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
32860 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
32861 the case of a non-SMTP message. However, a MIME ACL is called only if the
32862 message contains a &'Content-Type:'& header line. When a call to a MIME
32863 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
32864 result code is sent to the client. In the case of an SMTP message, the
32865 &%acl_smtp_data%& ACL is not called when this happens.
32866
32867 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
32868 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
32869 condition to match against the raw MIME part. You can also use the
32870 &%mime_regex%& condition to match against the decoded MIME part (see section
32871 &<<SECTscanregex>>&).
32872
32873 At the start of a MIME ACL, a number of variables are set from the header
32874 information for the relevant MIME part. These are described below. The contents
32875 of the MIME part are not by default decoded into a disk file except for MIME
32876 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
32877 part into a disk file, you can use the &%decode%& condition. The general
32878 syntax is:
32879 .display
32880 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
32881 .endd
32882 The right hand side is expanded before use. After expansion,
32883 the value can be:
32884
32885 .olist
32886 &"0"& or &"false"&, in which case no decoding is done.
32887 .next
32888 The string &"default"&. In that case, the file is put in the temporary
32889 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
32890 a sequential file name consisting of the message id and a sequence number. The
32891 full path and name is available in &$mime_decoded_filename$& after decoding.
32892 .next
32893 A full path name starting with a slash. If the full name is an existing
32894 directory, it is used as a replacement for the default directory. The filename
32895 is then sequentially assigned. If the path does not exist, it is used as
32896 the full path and file name.
32897 .next
32898 If the string does not start with a slash, it is used as the
32899 filename, and the default path is then used.
32900 .endlist
32901 The &%decode%& condition normally succeeds. It is only false for syntax
32902 errors or unusual circumstances such as memory shortages. You can easily decode
32903 a file with its original, proposed filename using
32904 .code
32905 decode = $mime_filename
32906 .endd
32907 However, you should keep in mind that &$mime_filename$& might contain
32908 anything. If you place files outside of the default path, they are not
32909 automatically unlinked.
32910
32911 For RFC822 attachments (these are messages attached to messages, with a
32912 content-type of &"message/rfc822"&), the ACL is called again in the same manner
32913 as for the primary message, only that the &$mime_is_rfc822$& expansion
32914 variable is set (see below). Attached messages are always decoded to disk
32915 before being checked, and the files are unlinked once the check is done.
32916
32917 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
32918 used to match regular expressions against raw and decoded MIME parts,
32919 respectively. They are described in section &<<SECTscanregex>>&.
32920
32921 .cindex "MIME content scanning" "returned variables"
32922 The following list describes all expansion variables that are
32923 available in the MIME ACL:
32924
32925 .vlist
32926 .vitem &$mime_boundary$&
32927 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
32928 have a boundary string, which is stored in this variable. If the current part
32929 has no boundary parameter in the &'Content-Type:'& header, this variable
32930 contains the empty string.
32931
32932 .vitem &$mime_charset$&
32933 This variable contains the character set identifier, if one was found in the
32934 &'Content-Type:'& header. Examples for charset identifiers are:
32935 .code
32936 us-ascii
32937 gb2312 (Chinese)
32938 iso-8859-1
32939 .endd
32940 Please note that this value is not normalized, so you should do matches
32941 case-insensitively.
32942
32943 .vitem &$mime_content_description$&
32944 This variable contains the normalized content of the &'Content-Description:'&
32945 header. It can contain a human-readable description of the parts content. Some
32946 implementations repeat the filename for attachments here, but they are usually
32947 only used for display purposes.
32948
32949 .vitem &$mime_content_disposition$&
32950 This variable contains the normalized content of the &'Content-Disposition:'&
32951 header. You can expect strings like &"attachment"& or &"inline"& here.
32952
32953 .vitem &$mime_content_id$&
32954 This variable contains the normalized content of the &'Content-ID:'& header.
32955 This is a unique ID that can be used to reference a part from another part.
32956
32957 .vitem &$mime_content_size$&
32958 This variable is set only after the &%decode%& modifier (see above) has been
32959 successfully run. It contains the size of the decoded part in kilobytes. The
32960 size is always rounded up to full kilobytes, so only a completely empty part
32961 has a &$mime_content_size$& of zero.
32962
32963 .vitem &$mime_content_transfer_encoding$&
32964 This variable contains the normalized content of the
32965 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32966 type. Typical values are &"base64"& and &"quoted-printable"&.
32967
32968 .vitem &$mime_content_type$&
32969 If the MIME part has a &'Content-Type:'& header, this variable contains its
32970 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32971 are some examples of popular MIME types, as they may appear in this variable:
32972 .code
32973 text/plain
32974 text/html
32975 application/octet-stream
32976 image/jpeg
32977 audio/midi
32978 .endd
32979 If the MIME part has no &'Content-Type:'& header, this variable contains the
32980 empty string.
32981
32982 .vitem &$mime_decoded_filename$&
32983 This variable is set only after the &%decode%& modifier (see above) has been
32984 successfully run. It contains the full path and file name of the file
32985 containing the decoded data.
32986 .endlist
32987
32988 .cindex "RFC 2047"
32989 .vlist
32990 .vitem &$mime_filename$&
32991 This is perhaps the most important of the MIME variables. It contains a
32992 proposed filename for an attachment, if one was found in either the
32993 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32994 RFC2047
32995 or RFC2231
32996 decoded, but no additional sanity checks are done.
32997  If no filename was
32998 found, this variable contains the empty string.
32999
33000 .vitem &$mime_is_coverletter$&
33001 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33002 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33003 content in the cover letter, while not restricting attachments at all.
33004
33005 The variable contains 1 (true) for a MIME part believed to be part of the
33006 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33007 follows:
33008
33009 .olist
33010 The outermost MIME part of a message is always a cover letter.
33011
33012 .next
33013 If a multipart/alternative or multipart/related MIME part is a cover letter,
33014 so are all MIME subparts within that multipart.
33015
33016 .next
33017 If any other multipart is a cover letter, the first subpart is a cover letter,
33018 and the rest are attachments.
33019
33020 .next
33021 All parts contained within an attachment multipart are attachments.
33022 .endlist olist
33023
33024 As an example, the following will ban &"HTML mail"& (including that sent with
33025 alternative plain text), while allowing HTML files to be attached. HTML
33026 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33027 .code
33028 deny message = HTML mail is not accepted here
33029 !condition = $mime_is_rfc822
33030 condition = $mime_is_coverletter
33031 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33032 .endd
33033 .vitem &$mime_is_multipart$&
33034 This variable has the value 1 (true) when the current part has the main type
33035 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
33036 Since multipart entities only serve as containers for other parts, you may not
33037 want to carry out specific actions on them.
33038
33039 .vitem &$mime_is_rfc822$&
33040 This variable has the value 1 (true) if the current part is not a part of the
33041 checked message itself, but part of an attached message. Attached message
33042 decoding is fully recursive.
33043
33044 .vitem &$mime_part_count$&
33045 This variable is a counter that is raised for each processed MIME part. It
33046 starts at zero for the very first part (which is usually a multipart). The
33047 counter is per-message, so it is reset when processing RFC822 attachments (see
33048 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33049 complete, so you can use it in the DATA ACL to determine the number of MIME
33050 parts of a message. For non-MIME messages, this variable contains the value -1.
33051 .endlist
33052
33053
33054
33055 .section "Scanning with regular expressions" "SECTscanregex"
33056 .cindex "content scanning" "with regular expressions"
33057 .cindex "regular expressions" "content scanning with"
33058 You can specify your own custom regular expression matches on the full body of
33059 the message, or on individual MIME parts.
33060
33061 The &%regex%& condition takes one or more regular expressions as arguments and
33062 matches them against the full message (when called in the DATA ACL) or a raw
33063 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33064 linewise, with a maximum line length of 32K characters. That means you cannot
33065 have multiline matches with the &%regex%& condition.
33066
33067 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33068 to 32K of decoded content (the whole content at once, not linewise). If the
33069 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33070 is decoded automatically when &%mime_regex%& is executed (using default path
33071 and filename values). If the decoded data is larger than  32K, only the first
33072 32K characters are checked.
33073
33074 The regular expressions are passed as a colon-separated list. To include a
33075 literal colon, you must double it. Since the whole right-hand side string is
33076 expanded before being used, you must also escape dollar signs and backslashes
33077 with more backslashes, or use the &`\N`& facility to disable expansion.
33078 Here is a simple example that contains two regular expressions:
33079 .code
33080 deny message = contains blacklisted regex ($regex_match_string)
33081      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33082 .endd
33083 The conditions returns true if any one of the regular expressions matches. The
33084 &$regex_match_string$& expansion variable is then set up and contains the
33085 matching regular expression.
33086 The expansion variables &$regex1$& &$regex2$& etc
33087 are set to any substrings captured by the regular expression.
33088
33089 &*Warning*&: With large messages, these conditions can be fairly
33090 CPU-intensive.
33091
33092 .ecindex IIDcosca
33093
33094
33095
33096
33097 . ////////////////////////////////////////////////////////////////////////////
33098 . ////////////////////////////////////////////////////////////////////////////
33099
33100 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33101          "Local scan function"
33102 .scindex IIDlosca "&[local_scan()]& function" "description of"
33103 .cindex "customizing" "input scan using C function"
33104 .cindex "policy control" "by local scan function"
33105 In these days of email worms, viruses, and ever-increasing spam, some sites
33106 want to apply a lot of checking to messages before accepting them.
33107
33108 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33109 passing messages to external virus and spam scanning software. You can also do
33110 a certain amount in Exim itself through string expansions and the &%condition%&
33111 condition in the ACL that runs after the SMTP DATA command or the ACL for
33112 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33113
33114 To allow for further customization to a site's own requirements, there is the
33115 possibility of linking Exim with a private message scanning function, written
33116 in C. If you want to run code that is written in something other than C, you
33117 can of course use a little C stub to call it.
33118
33119 The local scan function is run once for every incoming message, at the point
33120 when Exim is just about to accept the message.
33121 It can therefore be used to control non-SMTP messages from local processes as
33122 well as messages arriving via SMTP.
33123
33124 Exim applies a timeout to calls of the local scan function, and there is an
33125 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33126 Zero means &"no timeout"&.
33127 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33128 before calling the local scan function, so that the most common types of crash
33129 are caught. If the timeout is exceeded or one of those signals is caught, the
33130 incoming message is rejected with a temporary error if it is an SMTP message.
33131 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33132 code. The incident is logged on the main and reject logs.
33133
33134
33135
33136 .section "Building Exim to use a local scan function" "SECID207"
33137 .cindex "&[local_scan()]& function" "building Exim to use"
33138 To make use of the local scan function feature, you must tell Exim where your
33139 function is before building Exim, by setting
33140 .new
33141 both HAVE_LOCAL_SCAN and
33142 .wen
33143 LOCAL_SCAN_SOURCE in your
33144 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33145 directory, so you might set
33146 .code
33147 HAVE_LOCAL_SCAN=yes
33148 LOCAL_SCAN_SOURCE=Local/local_scan.c
33149 .endd
33150 for example. The function must be called &[local_scan()]&. It is called by
33151 Exim after it has received a message, when the success return code is about to
33152 be sent. This is after all the ACLs have been run. The return code from your
33153 function controls whether the message is actually accepted or not. There is a
33154 commented template function (that just accepts the message) in the file
33155 _src/local_scan.c_.
33156
33157 If you want to make use of Exim's run time configuration file to set options
33158 for your &[local_scan()]& function, you must also set
33159 .code
33160 LOCAL_SCAN_HAS_OPTIONS=yes
33161 .endd
33162 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33163
33164
33165
33166
33167 .section "API for local_scan()" "SECTapiforloc"
33168 .cindex "&[local_scan()]& function" "API description"
33169 You must include this line near the start of your code:
33170 .code
33171 #include "local_scan.h"
33172 .endd
33173 This header file defines a number of variables and other values, and the
33174 prototype for the function itself. Exim is coded to use unsigned char values
33175 almost exclusively, and one of the things this header defines is a shorthand
33176 for &`unsigned char`& called &`uschar`&.
33177 It also contains the following macro definitions, to simplify casting character
33178 strings and pointers to character strings:
33179 .code
33180 #define CS   (char *)
33181 #define CCS  (const char *)
33182 #define CSS  (char **)
33183 #define US   (unsigned char *)
33184 #define CUS  (const unsigned char *)
33185 #define USS  (unsigned char **)
33186 .endd
33187 The function prototype for &[local_scan()]& is:
33188 .code
33189 extern int local_scan(int fd, uschar **return_text);
33190 .endd
33191 The arguments are as follows:
33192
33193 .ilist
33194 &%fd%& is a file descriptor for the file that contains the body of the message
33195 (the -D file). The file is open for reading and writing, but updating it is not
33196 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33197
33198 The descriptor is positioned at character 19 of the file, which is the first
33199 character of the body itself, because the first 19 characters are the message
33200 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33201 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33202 case this changes in some future version.
33203 .next
33204 &%return_text%& is an address which you can use to return a pointer to a text
33205 string at the end of the function. The value it points to on entry is NULL.
33206 .endlist
33207
33208 The function must return an &%int%& value which is one of the following macros:
33209
33210 .vlist
33211 .vitem &`LOCAL_SCAN_ACCEPT`&
33212 .vindex "&$local_scan_data$&"
33213 The message is accepted. If you pass back a string of text, it is saved with
33214 the message, and made available in the variable &$local_scan_data$&. No
33215 newlines are permitted (if there are any, they are turned into spaces) and the
33216 maximum length of text is 1000 characters.
33217
33218 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33219 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33220 queued without immediate delivery, and is frozen.
33221
33222 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33223 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33224 queued without immediate delivery.
33225
33226 .vitem &`LOCAL_SCAN_REJECT`&
33227 The message is rejected; the returned text is used as an error message which is
33228 passed back to the sender and which is also logged. Newlines are permitted &--
33229 they cause a multiline response for SMTP rejections, but are converted to
33230 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33231 used.
33232
33233 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33234 The message is temporarily rejected; the returned text is used as an error
33235 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33236 problem"& is used.
33237
33238 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33239 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33240 message is not written to the reject log. It has the effect of unsetting the
33241 &%rejected_header%& log selector for just this rejection. If
33242 &%rejected_header%& is already unset (see the discussion of the
33243 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33244 same as LOCAL_SCAN_REJECT.
33245
33246 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33247 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33248 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33249 .endlist
33250
33251 If the message is not being received by interactive SMTP, rejections are
33252 reported by writing to &%stderr%& or by sending an email, as configured by the
33253 &%-oe%& command line options.
33254
33255
33256
33257 .section "Configuration options for local_scan()" "SECTconoptloc"
33258 .cindex "&[local_scan()]& function" "configuration options"
33259 It is possible to have option settings in the main configuration file
33260 that set values in static variables in the &[local_scan()]& module. If you
33261 want to do this, you must have the line
33262 .code
33263 LOCAL_SCAN_HAS_OPTIONS=yes
33264 .endd
33265 in your &_Local/Makefile_& when you build Exim. (This line is in
33266 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33267 file, you must define static variables to hold the option values, and a table
33268 to define them.
33269
33270 The table must be a vector called &%local_scan_options%&, of type
33271 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33272 and a pointer to the variable that holds the value. The entries must appear in
33273 alphabetical order. Following &%local_scan_options%& you must also define a
33274 variable called &%local_scan_options_count%& that contains the number of
33275 entries in the table. Here is a short example, showing two kinds of option:
33276 .code
33277 static int my_integer_option = 42;
33278 static uschar *my_string_option = US"a default string";
33279
33280 optionlist local_scan_options[] = {
33281   { "my_integer", opt_int,       &my_integer_option },
33282   { "my_string",  opt_stringptr, &my_string_option }
33283 };
33284
33285 int local_scan_options_count =
33286   sizeof(local_scan_options)/sizeof(optionlist);
33287 .endd
33288 The values of the variables can now be changed from Exim's runtime
33289 configuration file by including a local scan section as in this example:
33290 .code
33291 begin local_scan
33292 my_integer = 99
33293 my_string = some string of text...
33294 .endd
33295 The available types of option data are as follows:
33296
33297 .vlist
33298 .vitem &*opt_bool*&
33299 This specifies a boolean (true/false) option. The address should point to a
33300 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33301 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33302 whether such a variable has been set at all, you can initialize it to
33303 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33304 values.)
33305
33306 .vitem &*opt_fixed*&
33307 This specifies a fixed point number, such as is used for load averages.
33308 The address should point to a variable of type &`int`&. The value is stored
33309 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33310
33311 .vitem &*opt_int*&
33312 This specifies an integer; the address should point to a variable of type
33313 &`int`&. The value may be specified in any of the integer formats accepted by
33314 Exim.
33315
33316 .vitem &*opt_mkint*&
33317 This is the same as &%opt_int%&, except that when such a value is output in a
33318 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33319 printed with the suffix K or M.
33320
33321 .vitem &*opt_octint*&
33322 This also specifies an integer, but the value is always interpreted as an
33323 octal integer, whether or not it starts with the digit zero, and it is
33324 always output in octal.
33325
33326 .vitem &*opt_stringptr*&
33327 This specifies a string value; the address must be a pointer to a
33328 variable that points to a string (for example, of type &`uschar *`&).
33329
33330 .vitem &*opt_time*&
33331 This specifies a time interval value. The address must point to a variable of
33332 type &`int`&. The value that is placed there is a number of seconds.
33333 .endlist
33334
33335 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33336 out the values of all the &[local_scan()]& options.
33337
33338
33339
33340 .section "Available Exim variables" "SECID208"
33341 .cindex "&[local_scan()]& function" "available Exim variables"
33342 The header &_local_scan.h_& gives you access to a number of C variables. These
33343 are the only ones that are guaranteed to be maintained from release to release.
33344 Note, however, that you can obtain the value of any Exim expansion variable,
33345 including &$recipients$&, by calling &'expand_string()'&. The exported
33346 C variables are as follows:
33347
33348 .vlist
33349 .vitem &*int&~body_linecount*&
33350 This variable contains the number of lines in the message's body.
33351 It is not valid if the &%spool_files_wireformat%& option is used.
33352
33353 .vitem &*int&~body_zerocount*&
33354 This variable contains the number of binary zero bytes in the message's body.
33355 It is not valid if the &%spool_files_wireformat%& option is used.
33356
33357 .vitem &*unsigned&~int&~debug_selector*&
33358 This variable is set to zero when no debugging is taking place. Otherwise, it
33359 is a bitmap of debugging selectors. Two bits are identified for use in
33360 &[local_scan()]&; they are defined as macros:
33361
33362 .ilist
33363 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33364 testing option that is not privileged &-- any caller may set it. All the
33365 other selector bits can be set only by admin users.
33366
33367 .next
33368 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33369 by the &`+local_scan`& debug selector. It is not included in the default set
33370 of debugging bits.
33371 .endlist ilist
33372
33373 Thus, to write to the debugging output only when &`+local_scan`& has been
33374 selected, you should use code like this:
33375 .code
33376 if ((debug_selector & D_local_scan) != 0)
33377   debug_printf("xxx", ...);
33378 .endd
33379 .vitem &*uschar&~*expand_string_message*&
33380 After a failing call to &'expand_string()'& (returned value NULL), the
33381 variable &%expand_string_message%& contains the error message, zero-terminated.
33382
33383 .vitem &*header_line&~*header_list*&
33384 A pointer to a chain of header lines. The &%header_line%& structure is
33385 discussed below.
33386
33387 .vitem &*header_line&~*header_last*&
33388 A pointer to the last of the header lines.
33389
33390 .vitem &*uschar&~*headers_charset*&
33391 The value of the &%headers_charset%& configuration option.
33392
33393 .vitem &*BOOL&~host_checking*&
33394 This variable is TRUE during a host checking session that is initiated by the
33395 &%-bh%& command line option.
33396
33397 .vitem &*uschar&~*interface_address*&
33398 The IP address of the interface that received the message, as a string. This
33399 is NULL for locally submitted messages.
33400
33401 .vitem &*int&~interface_port*&
33402 The port on which this message was received. When testing with the &%-bh%&
33403 command line option, the value of this variable is -1 unless a port has been
33404 specified via the &%-oMi%& option.
33405
33406 .vitem &*uschar&~*message_id*&
33407 This variable contains Exim's message id for the incoming message (the value of
33408 &$message_exim_id$&) as a zero-terminated string.
33409
33410 .vitem &*uschar&~*received_protocol*&
33411 The name of the protocol by which the message was received.
33412
33413 .vitem &*int&~recipients_count*&
33414 The number of accepted recipients.
33415
33416 .vitem &*recipient_item&~*recipients_list*&
33417 .cindex "recipient" "adding in local scan"
33418 .cindex "recipient" "removing in local scan"
33419 The list of accepted recipients, held in a vector of length
33420 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33421 can add additional recipients by calling &'receive_add_recipient()'& (see
33422 below). You can delete recipients by removing them from the vector and
33423 adjusting the value in &%recipients_count%&. In particular, by setting
33424 &%recipients_count%& to zero you remove all recipients. If you then return the
33425 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33426 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33427 and then call &'receive_add_recipient()'& as often as needed.
33428
33429 .vitem &*uschar&~*sender_address*&
33430 The envelope sender address. For bounce messages this is the empty string.
33431
33432 .vitem &*uschar&~*sender_host_address*&
33433 The IP address of the sending host, as a string. This is NULL for
33434 locally-submitted messages.
33435
33436 .vitem &*uschar&~*sender_host_authenticated*&
33437 The name of the authentication mechanism that was used, or NULL if the message
33438 was not received over an authenticated SMTP connection.
33439
33440 .vitem &*uschar&~*sender_host_name*&
33441 The name of the sending host, if known.
33442
33443 .vitem &*int&~sender_host_port*&
33444 The port on the sending host.
33445
33446 .vitem &*BOOL&~smtp_input*&
33447 This variable is TRUE for all SMTP input, including BSMTP.
33448
33449 .vitem &*BOOL&~smtp_batched_input*&
33450 This variable is TRUE for BSMTP input.
33451
33452 .vitem &*int&~store_pool*&
33453 The contents of this variable control which pool of memory is used for new
33454 requests. See section &<<SECTmemhanloc>>& for details.
33455 .endlist
33456
33457
33458 .section "Structure of header lines" "SECID209"
33459 The &%header_line%& structure contains the members listed below.
33460 You can add additional header lines by calling the &'header_add()'& function
33461 (see below). You can cause header lines to be ignored (deleted) by setting
33462 their type to *.
33463
33464
33465 .vlist
33466 .vitem &*struct&~header_line&~*next*&
33467 A pointer to the next header line, or NULL for the last line.
33468
33469 .vitem &*int&~type*&
33470 A code identifying certain headers that Exim recognizes. The codes are printing
33471 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33472 Notice in particular that any header line whose type is * is not transmitted
33473 with the message. This flagging is used for header lines that have been
33474 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33475 lines.) Effectively, * means &"deleted"&.
33476
33477 .vitem &*int&~slen*&
33478 The number of characters in the header line, including the terminating and any
33479 internal newlines.
33480
33481 .vitem &*uschar&~*text*&
33482 A pointer to the text of the header. It always ends with a newline, followed by
33483 a zero byte. Internal newlines are preserved.
33484 .endlist
33485
33486
33487
33488 .section "Structure of recipient items" "SECID210"
33489 The &%recipient_item%& structure contains these members:
33490
33491 .vlist
33492 .vitem &*uschar&~*address*&
33493 This is a pointer to the recipient address as it was received.
33494
33495 .vitem &*int&~pno*&
33496 This is used in later Exim processing when top level addresses are created by
33497 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
33498 and must always contain -1 at this stage.
33499
33500 .vitem &*uschar&~*errors_to*&
33501 If this value is not NULL, bounce messages caused by failing to deliver to the
33502 recipient are sent to the address it contains. In other words, it overrides the
33503 envelope sender for this one recipient. (Compare the &%errors_to%& generic
33504 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
33505 an unqualified address, Exim qualifies it using the domain from
33506 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
33507 is NULL for all recipients.
33508 .endlist
33509
33510
33511
33512 .section "Available Exim functions" "SECID211"
33513 .cindex "&[local_scan()]& function" "available Exim functions"
33514 The header &_local_scan.h_& gives you access to a number of Exim functions.
33515 These are the only ones that are guaranteed to be maintained from release to
33516 release:
33517
33518 .vlist
33519 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
33520        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
33521
33522 This function creates a child process that runs the command specified by
33523 &%argv%&. The environment for the process is specified by &%envp%&, which can
33524 be NULL if no environment variables are to be passed. A new umask is supplied
33525 for the process in &%newumask%&.
33526
33527 Pipes to the standard input and output of the new process are set up
33528 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
33529 standard error is cloned to the standard output. If there are any file
33530 descriptors &"in the way"& in the new process, they are closed. If the final
33531 argument is TRUE, the new process is made into a process group leader.
33532
33533 The function returns the pid of the new process, or -1 if things go wrong.
33534
33535 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
33536 This function waits for a child process to terminate, or for a timeout (in
33537 seconds) to expire. A timeout value of zero means wait as long as it takes. The
33538 return value is as follows:
33539
33540 .ilist
33541 >= 0
33542
33543 The process terminated by a normal exit and the value is the process
33544 ending status.
33545
33546 .next
33547 < 0 and > &--256
33548
33549 The process was terminated by a signal and the value is the negation of the
33550 signal number.
33551
33552 .next
33553 &--256
33554
33555 The process timed out.
33556 .next
33557 &--257
33558
33559 The was some other error in wait(); &%errno%& is still set.
33560 .endlist
33561
33562 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
33563 This function provide you with a means of submitting a new message to
33564 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
33565 want, but this packages it all up for you.) The function creates a pipe,
33566 forks a subprocess that is running
33567 .code
33568 exim -t -oem -oi -f <>
33569 .endd
33570 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
33571 that is connected to the standard input. The yield of the function is the PID
33572 of the subprocess. You can then write a message to the file descriptor, with
33573 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
33574
33575 When you have finished, call &'child_close()'& to wait for the process to
33576 finish and to collect its ending status. A timeout value of zero is usually
33577 fine in this circumstance. Unless you have made a mistake with the recipient
33578 addresses, you should get a return code of zero.
33579
33580
33581 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
33582        *sender_authentication)*&
33583 This function is a more sophisticated version of &'child_open()'&. The command
33584 that it runs is:
33585 .display
33586 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
33587 .endd
33588 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
33589
33590
33591 .vitem &*void&~debug_printf(char&~*,&~...)*&
33592 This is Exim's debugging function, with arguments as for &'(printf()'&. The
33593 output is written to the standard error stream. If no debugging is selected,
33594 calls to &'debug_printf()'& have no effect. Normally, you should make calls
33595 conditional on the &`local_scan`& debug selector by coding like this:
33596 .code
33597 if ((debug_selector & D_local_scan) != 0)
33598   debug_printf("xxx", ...);
33599 .endd
33600
33601 .vitem &*uschar&~*expand_string(uschar&~*string)*&
33602 This is an interface to Exim's string expansion code. The return value is the
33603 expanded string, or NULL if there was an expansion failure.
33604 The C variable &%expand_string_message%& contains an error message after an
33605 expansion failure. If expansion does not change the string, the return value is
33606 the pointer to the input string. Otherwise, the return value points to a new
33607 block of memory that was obtained by a call to &'store_get()'&. See section
33608 &<<SECTmemhanloc>>& below for a discussion of memory handling.
33609
33610 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
33611 This function allows you to an add additional header line at the end of the
33612 existing ones. The first argument is the type, and should normally be a space
33613 character. The second argument is a format string and any number of
33614 substitution arguments as for &[sprintf()]&. You may include internal newlines
33615 if you want, and you must ensure that the string ends with a newline.
33616
33617 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
33618         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
33619 This function adds a new header line at a specified point in the header
33620 chain. The header itself is specified as for &'header_add()'&.
33621
33622 If &%name%& is NULL, the new header is added at the end of the chain if
33623 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
33624 NULL, the header lines are searched for the first non-deleted header that
33625 matches the name. If one is found, the new header is added before it if
33626 &%after%& is false. If &%after%& is true, the new header is added after the
33627 found header and any adjacent subsequent ones with the same name (even if
33628 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
33629 option controls where the header is added. If it is true, addition is at the
33630 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
33631 headers, or at the top if there are no &'Received:'& headers, you could use
33632 .code
33633 header_add_at_position(TRUE, US"Received", TRUE,
33634   ' ', "X-xxx: ...");
33635 .endd
33636 Normally, there is always at least one non-deleted &'Received:'& header, but
33637 there may not be if &%received_header_text%& expands to an empty string.
33638
33639
33640 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
33641 This function removes header lines. If &%occurrence%& is zero or negative, all
33642 occurrences of the header are removed. If occurrence is greater than zero, that
33643 particular instance of the header is removed. If no header(s) can be found that
33644 match the specification, the function does nothing.
33645
33646
33647 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
33648         int&~length,&~BOOL&~notdel)*&"
33649 This function tests whether the given header has the given name. It is not just
33650 a string comparison, because white space is permitted between the name and the
33651 colon. If the &%notdel%& argument is true, a false return is forced for all
33652 &"deleted"& headers; otherwise they are not treated specially. For example:
33653 .code
33654 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
33655 .endd
33656 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
33657 .cindex "base64 encoding" "functions for &[local_scan()]& use"
33658 This function base64-encodes a string, which is passed by address and length.
33659 The text may contain bytes of any value, including zero. The result is passed
33660 back in dynamic memory that is obtained by calling &'store_get()'&. It is
33661 zero-terminated.
33662
33663 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
33664 This function decodes a base64-encoded string. Its arguments are a
33665 zero-terminated base64-encoded string and the address of a variable that is set
33666 to point to the result, which is in dynamic memory. The length of the decoded
33667 string is the yield of the function. If the input is invalid base64 data, the
33668 yield is -1. A zero byte is added to the end of the output string to make it
33669 easy to interpret as a C string (assuming it contains no zeros of its own). The
33670 added zero byte is not included in the returned count.
33671
33672 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
33673 This function checks for a match in a domain list. Domains are always
33674 matched caselessly. The return value is one of the following:
33675 .display
33676 &`OK     `& match succeeded
33677 &`FAIL   `& match failed
33678 &`DEFER  `& match deferred
33679 .endd
33680 DEFER is usually caused by some kind of lookup defer, such as the
33681 inability to contact a database.
33682
33683 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
33684         BOOL&~caseless)*&"
33685 This function checks for a match in a local part list. The third argument
33686 controls case-sensitivity. The return values are as for
33687 &'lss_match_domain()'&.
33688
33689 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
33690         BOOL&~caseless)*&"
33691 This function checks for a match in an address list. The third argument
33692 controls the case-sensitivity of the local part match. The domain is always
33693 matched caselessly. The return values are as for &'lss_match_domain()'&.
33694
33695 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
33696         uschar&~*list)*&"
33697 This function checks for a match in a host list. The most common usage is
33698 expected to be
33699 .code
33700 lss_match_host(sender_host_name, sender_host_address, ...)
33701 .endd
33702 .vindex "&$sender_host_address$&"
33703 An empty address field matches an empty item in the host list. If the host name
33704 is NULL, the name corresponding to &$sender_host_address$& is automatically
33705 looked up if a host name is required to match an item in the list. The return
33706 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
33707 returns ERROR in the case when it had to look up a host name, but the lookup
33708 failed.
33709
33710 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
33711         *format,&~...)*&"
33712 This function writes to Exim's log files. The first argument should be zero (it
33713 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
33714 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
33715 them. It specifies to which log or logs the message is written. The remaining
33716 arguments are a format and relevant insertion arguments. The string should not
33717 contain any newlines, not even at the end.
33718
33719
33720 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
33721 This function adds an additional recipient to the message. The first argument
33722 is the recipient address. If it is unqualified (has no domain), it is qualified
33723 with the &%qualify_recipient%& domain. The second argument must always be -1.
33724
33725 This function does not allow you to specify a private &%errors_to%& address (as
33726 described with the structure of &%recipient_item%& above), because it pre-dates
33727 the addition of that field to the structure. However, it is easy to add such a
33728 value afterwards. For example:
33729 .code
33730  receive_add_recipient(US"monitor@mydom.example", -1);
33731  recipients_list[recipients_count-1].errors_to =
33732    US"postmaster@mydom.example";
33733 .endd
33734
33735 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
33736 This is a convenience function to remove a named recipient from the list of
33737 recipients. It returns true if a recipient was removed, and false if no
33738 matching recipient could be found. The argument must be a complete email
33739 address.
33740 .endlist
33741
33742
33743 .cindex "RFC 2047"
33744 .vlist
33745 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
33746   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
33747 This function decodes strings that are encoded according to RFC 2047. Typically
33748 these are the contents of header lines. First, each &"encoded word"& is decoded
33749 from the Q or B encoding into a byte-string. Then, if provided with the name of
33750 a charset encoding, and if the &[iconv()]& function is available, an attempt is
33751 made  to translate the result to the named character set. If this fails, the
33752 binary string is returned with an error message.
33753
33754 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
33755 maximum MIME word length is enforced. The third argument is the target
33756 encoding, or NULL if no translation is wanted.
33757
33758 .cindex "binary zero" "in RFC 2047 decoding"
33759 .cindex "RFC 2047" "binary zero in"
33760 If a binary zero is encountered in the decoded string, it is replaced by the
33761 contents of the &%zeroval%& argument. For use with Exim headers, the value must
33762 not be 0 because header lines are handled as zero-terminated strings.
33763
33764 The function returns the result of processing the string, zero-terminated; if
33765 &%lenptr%& is not NULL, the length of the result is set in the variable to
33766 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
33767
33768 If an error is encountered, the function returns NULL and uses the &%error%&
33769 argument to return an error message. The variable pointed to by &%error%& is
33770 set to NULL if there is no error; it may be set non-NULL even when the function
33771 returns a non-NULL value if decoding was successful, but there was a problem
33772 with translation.
33773
33774
33775 .vitem &*int&~smtp_fflush(void)*&
33776 This function is used in conjunction with &'smtp_printf()'&, as described
33777 below.
33778
33779 .vitem &*void&~smtp_printf(char&~*,&~...)*&
33780 The arguments of this function are like &[printf()]&; it writes to the SMTP
33781 output stream. You should use this function only when there is an SMTP output
33782 stream, that is, when the incoming message is being received via interactive
33783 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
33784 is FALSE. If you want to test for an incoming message from another host (as
33785 opposed to a local process that used the &%-bs%& command line option), you can
33786 test the value of &%sender_host_address%&, which is non-NULL when a remote host
33787 is involved.
33788
33789 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
33790 output function, so it can be used for all forms of SMTP connection.
33791
33792 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
33793 must start with an appropriate response code: 550 if you are going to return
33794 LOCAL_SCAN_REJECT, 451 if you are going to return
33795 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
33796 initial lines of a multi-line response, the code must be followed by a hyphen
33797 to indicate that the line is not the final response line. You must also ensure
33798 that the lines you write terminate with CRLF. For example:
33799 .code
33800 smtp_printf("550-this is some extra info\r\n");
33801 return LOCAL_SCAN_REJECT;
33802 .endd
33803 Note that you can also create multi-line responses by including newlines in
33804 the data returned via the &%return_text%& argument. The added value of using
33805 &'smtp_printf()'& is that, for instance, you could introduce delays between
33806 multiple output lines.
33807
33808 The &'smtp_printf()'& function does not return any error indication, because it
33809 does not automatically flush pending output, and therefore does not test
33810 the state of the stream. (In the main code of Exim, flushing and error
33811 detection is done when Exim is ready for the next SMTP input command.) If
33812 you want to flush the output and check for an error (for example, the
33813 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
33814 arguments. It flushes the output stream, and returns a non-zero value if there
33815 is an error.
33816
33817 .vitem &*void&~*store_get(int)*&
33818 This function accesses Exim's internal store (memory) manager. It gets a new
33819 chunk of memory whose size is given by the argument. Exim bombs out if it ever
33820 runs out of memory. See the next section for a discussion of memory handling.
33821
33822 .vitem &*void&~*store_get_perm(int)*&
33823 This function is like &'store_get()'&, but it always gets memory from the
33824 permanent pool. See the next section for a discussion of memory handling.
33825
33826 .vitem &*uschar&~*string_copy(uschar&~*string)*&
33827 See below.
33828
33829 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
33830 See below.
33831
33832 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
33833 These three functions create strings using Exim's dynamic memory facilities.
33834 The first makes a copy of an entire string. The second copies up to a maximum
33835 number of characters, indicated by the second argument. The third uses a format
33836 and insertion arguments to create a new string. In each case, the result is a
33837 pointer to a new string in the current memory pool. See the next section for
33838 more discussion.
33839 .endlist
33840
33841
33842
33843 .section "More about Exim's memory handling" "SECTmemhanloc"
33844 .cindex "&[local_scan()]& function" "memory handling"
33845 No function is provided for freeing memory, because that is never needed.
33846 The dynamic memory that Exim uses when receiving a message is automatically
33847 recycled if another message is received by the same process (this applies only
33848 to incoming SMTP connections &-- other input methods can supply only one
33849 message at a time). After receiving the last message, a reception process
33850 terminates.
33851
33852 Because it is recycled, the normal dynamic memory cannot be used for holding
33853 data that must be preserved over a number of incoming messages on the same SMTP
33854 connection. However, Exim in fact uses two pools of dynamic memory; the second
33855 one is not recycled, and can be used for this purpose.
33856
33857 If you want to allocate memory that remains available for subsequent messages
33858 in the same SMTP connection, you should set
33859 .code
33860 store_pool = POOL_PERM
33861 .endd
33862 before calling the function that does the allocation. There is no need to
33863 restore the value if you do not need to; however, if you do want to revert to
33864 the normal pool, you can either restore the previous value of &%store_pool%& or
33865 set it explicitly to POOL_MAIN.
33866
33867 The pool setting applies to all functions that get dynamic memory, including
33868 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
33869 There is also a convenience function called &'store_get_perm()'& that gets a
33870 block of memory from the permanent pool while preserving the value of
33871 &%store_pool%&.
33872 .ecindex IIDlosca
33873
33874
33875
33876
33877 . ////////////////////////////////////////////////////////////////////////////
33878 . ////////////////////////////////////////////////////////////////////////////
33879
33880 .chapter "System-wide message filtering" "CHAPsystemfilter"
33881 .scindex IIDsysfil1 "filter" "system filter"
33882 .scindex IIDsysfil2 "filtering all mail"
33883 .scindex IIDsysfil3 "system filter"
33884 The previous chapters (on ACLs and the local scan function) describe checks
33885 that can be applied to messages before they are accepted by a host. There is
33886 also a mechanism for checking messages once they have been received, but before
33887 they are delivered. This is called the &'system filter'&.
33888
33889 The system filter operates in a similar manner to users' filter files, but it
33890 is run just once per message (however many recipients the message has).
33891 It should not normally be used as a substitute for routing, because &%deliver%&
33892 commands in a system router provide new envelope recipient addresses.
33893 The system filter must be an Exim filter. It cannot be a Sieve filter.
33894
33895 The system filter is run at the start of a delivery attempt, before any routing
33896 is done. If a message fails to be completely delivered at the first attempt,
33897 the system filter is run again at the start of every retry.
33898 If you want your filter to do something only once per message, you can make use
33899 of the &%first_delivery%& condition in an &%if%& command in the filter to
33900 prevent it happening on retries.
33901
33902 .vindex "&$domain$&"
33903 .vindex "&$local_part$&"
33904 &*Warning*&: Because the system filter runs just once, variables that are
33905 specific to individual recipient addresses, such as &$local_part$& and
33906 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
33907 you want to run a centrally-specified filter for each recipient address
33908 independently, you can do so by setting up a suitable &(redirect)& router, as
33909 described in section &<<SECTperaddfil>>& below.
33910
33911
33912 .section "Specifying a system filter" "SECID212"
33913 .cindex "uid (user id)" "system filter"
33914 .cindex "gid (group id)" "system filter"
33915 The name of the file that contains the system filter must be specified by
33916 setting &%system_filter%&. If you want the filter to run under a uid and gid
33917 other than root, you must also set &%system_filter_user%& and
33918 &%system_filter_group%& as appropriate. For example:
33919 .code
33920 system_filter = /etc/mail/exim.filter
33921 system_filter_user = exim
33922 .endd
33923 If a system filter generates any deliveries directly to files or pipes (via the
33924 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
33925 specified by setting &%system_filter_file_transport%& and
33926 &%system_filter_pipe_transport%&, respectively. Similarly,
33927 &%system_filter_reply_transport%& must be set to handle any messages generated
33928 by the &%reply%& command.
33929
33930
33931 .section "Testing a system filter" "SECID213"
33932 You can run simple tests of a system filter in the same way as for a user
33933 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
33934 are permitted only in system filters are recognized.
33935
33936 If you want to test the combined effect of a system filter and a user filter,
33937 you can use both &%-bF%& and &%-bf%& on the same command line.
33938
33939
33940
33941 .section "Contents of a system filter" "SECID214"
33942 The language used to specify system filters is the same as for users' filter
33943 files. It is described in the separate end-user document &'Exim's interface to
33944 mail filtering'&. However, there are some additional features that are
33945 available only in system filters; these are described in subsequent sections.
33946 If they are encountered in a user's filter file or when testing with &%-bf%&,
33947 they cause errors.
33948
33949 .cindex "frozen messages" "manual thaw; testing in filter"
33950 There are two special conditions which, though available in users' filter
33951 files, are designed for use in system filters. The condition &%first_delivery%&
33952 is true only for the first attempt at delivering a message, and
33953 &%manually_thawed%& is true only if the message has been frozen, and
33954 subsequently thawed by an admin user. An explicit forced delivery counts as a
33955 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33956
33957 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33958 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33959 succeed, it will not be tried again.
33960 If you want Exim to retry an unseen delivery until it succeeds, you should
33961 arrange to set it up every time the filter runs.
33962
33963 When a system filter finishes running, the values of the variables &$n0$& &--
33964 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33965 users' filter files. Thus a system filter can, for example, set up &"scores"&
33966 to which users' filter files can refer.
33967
33968
33969
33970 .section "Additional variable for system filters" "SECID215"
33971 .vindex "&$recipients$&"
33972 The expansion variable &$recipients$&, containing a list of all the recipients
33973 of the message (separated by commas and white space), is available in system
33974 filters. It is not available in users' filters for privacy reasons.
33975
33976
33977
33978 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33979 .cindex "freezing messages"
33980 .cindex "message" "freezing"
33981 .cindex "message" "forced failure"
33982 .cindex "&%fail%&" "in system filter"
33983 .cindex "&%freeze%& in system filter"
33984 .cindex "&%defer%& in system filter"
33985 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33986 always available in system filters, but are not normally enabled in users'
33987 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33988 for the &(redirect)& router.) These commands can optionally be followed by the
33989 word &%text%& and a string containing an error message, for example:
33990 .code
33991 fail text "this message looks like spam to me"
33992 .endd
33993 The keyword &%text%& is optional if the next character is a double quote.
33994
33995 The &%defer%& command defers delivery of the original recipients of the
33996 message. The &%fail%& command causes all the original recipients to be failed,
33997 and a bounce message to be created. The &%freeze%& command suspends all
33998 delivery attempts for the original recipients. In all cases, any new deliveries
33999 that are specified by the filter are attempted as normal after the filter has
34000 run.
34001
34002 The &%freeze%& command is ignored if the message has been manually unfrozen and
34003 not manually frozen since. This means that automatic freezing by a system
34004 filter can be used as a way of checking out suspicious messages. If a message
34005 is found to be all right, manually unfreezing it allows it to be delivered.
34006
34007 .cindex "log" "&%fail%& command log line"
34008 .cindex "&%fail%&" "log line; reducing"
34009 The text given with a fail command is used as part of the bounce message as
34010 well as being written to the log. If the message is quite long, this can fill
34011 up a lot of log space when such failures are common. To reduce the size of the
34012 log message, Exim interprets the text in a special way if it starts with the
34013 two characters &`<<`& and contains &`>>`& later. The text between these two
34014 strings is written to the log, and the rest of the text is used in the bounce
34015 message. For example:
34016 .code
34017 fail "<<filter test 1>>Your message is rejected \
34018      because it contains attachments that we are \
34019      not prepared to receive."
34020 .endd
34021
34022 .cindex "loop" "caused by &%fail%&"
34023 Take great care with the &%fail%& command when basing the decision to fail on
34024 the contents of the message, because the bounce message will of course include
34025 the contents of the original message and will therefore trigger the &%fail%&
34026 command again (causing a mail loop) unless steps are taken to prevent this.
34027 Testing the &%error_message%& condition is one way to prevent this. You could
34028 use, for example
34029 .code
34030 if $message_body contains "this is spam" and not error_message
34031 then fail text "spam is not wanted here" endif
34032 .endd
34033 though of course that might let through unwanted bounce messages. The
34034 alternative is clever checking of the body and/or headers to detect bounces
34035 generated by the filter.
34036
34037 The interpretation of a system filter file ceases after a
34038 &%defer%&,
34039 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34040 set up earlier in the filter file are honoured, so you can use a sequence such
34041 as
34042 .code
34043 mail ...
34044 freeze
34045 .endd
34046 to send a specified message when the system filter is freezing (or deferring or
34047 failing) a message. The normal deliveries for the message do not, of course,
34048 take place.
34049
34050
34051
34052 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34053 .cindex "header lines" "adding; in system filter"
34054 .cindex "header lines" "removing; in system filter"
34055 .cindex "filter" "header lines; adding/removing"
34056 Two filter commands that are available only in system filters are:
34057 .code
34058 headers add <string>
34059 headers remove <string>
34060 .endd
34061 The argument for the &%headers add%& is a string that is expanded and then
34062 added to the end of the message's headers. It is the responsibility of the
34063 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34064 space is ignored, and if the string is otherwise empty, or if the expansion is
34065 forced to fail, the command has no effect.
34066
34067 You can use &"\n"& within the string, followed by white space, to specify
34068 continued header lines. More than one header may be added in one command by
34069 including &"\n"& within the string without any following white space. For
34070 example:
34071 .code
34072 headers add "X-header-1: ....\n  \
34073              continuation of X-header-1 ...\n\
34074              X-header-2: ...."
34075 .endd
34076 Note that the header line continuation white space after the first newline must
34077 be placed before the backslash that continues the input string, because white
34078 space after input continuations is ignored.
34079
34080 The argument for &%headers remove%& is a colon-separated list of header names.
34081 This command applies only to those headers that are stored with the message;
34082 those that are added at delivery time (such as &'Envelope-To:'& and
34083 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34084 header with the same name, they are all removed.
34085
34086 The &%headers%& command in a system filter makes an immediate change to the set
34087 of header lines that was received with the message (with possible additions
34088 from ACL processing). Subsequent commands in the system filter operate on the
34089 modified set, which also forms the basis for subsequent message delivery.
34090 Unless further modified during routing or transporting, this set of headers is
34091 used for all recipients of the message.
34092
34093 During routing and transporting, the variables that refer to the contents of
34094 header lines refer only to those lines that are in this set. Thus, header lines
34095 that are added by a system filter are visible to users' filter files and to all
34096 routers and transports. This contrasts with the manipulation of header lines by
34097 routers and transports, which is not immediate, but which instead is saved up
34098 until the message is actually being written (see section
34099 &<<SECTheadersaddrem>>&).
34100
34101 If the message is not delivered at the first attempt, header lines that were
34102 added by the system filter are stored with the message, and so are still
34103 present at the next delivery attempt. Header lines that were removed are still
34104 present, but marked &"deleted"& so that they are not transported with the
34105 message. For this reason, it is usual to make the &%headers%& command
34106 conditional on &%first_delivery%& so that the set of header lines is not
34107 modified more than once.
34108
34109 Because header modification in a system filter acts immediately, you have to
34110 use an indirect approach if you want to modify the contents of a header line.
34111 For example:
34112 .code
34113 headers add "Old-Subject: $h_subject:"
34114 headers remove "Subject"
34115 headers add "Subject: new subject (was: $h_old-subject:)"
34116 headers remove "Old-Subject"
34117 .endd
34118
34119
34120
34121 .section "Setting an errors address in a system filter" "SECID217"
34122 .cindex "envelope sender"
34123 In a system filter, if a &%deliver%& command is followed by
34124 .code
34125 errors_to <some address>
34126 .endd
34127 in order to change the envelope sender (and hence the error reporting) for that
34128 delivery, any address may be specified. (In a user filter, only the current
34129 user's address can be set.) For example, if some mail is being monitored, you
34130 might use
34131 .code
34132 unseen deliver monitor@spying.example errors_to root@local.example
34133 .endd
34134 to take a copy which would not be sent back to the normal error reporting
34135 address if its delivery failed.
34136
34137
34138
34139 .section "Per-address filtering" "SECTperaddfil"
34140 .vindex "&$domain$&"
34141 .vindex "&$local_part$&"
34142 In contrast to the system filter, which is run just once per message for each
34143 delivery attempt, it is also possible to set up a system-wide filtering
34144 operation that runs once for each recipient address. In this case, variables
34145 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34146 filter file could be made dependent on them. This is an example of a router
34147 which implements such a filter:
34148 .code
34149 central_filter:
34150   check_local_user
34151   driver = redirect
34152   domains = +local_domains
34153   file = /central/filters/$local_part
34154   no_verify
34155   allow_filter
34156   allow_freeze
34157 .endd
34158 The filter is run in a separate process under its own uid. Therefore, either
34159 &%check_local_user%& must be set (as above), in which case the filter is run as
34160 the local user, or the &%user%& option must be used to specify which user to
34161 use. If both are set, &%user%& overrides.
34162
34163 Care should be taken to ensure that none of the commands in the filter file
34164 specify a significant delivery if the message is to go on to be delivered to
34165 its intended recipient. The router will not then claim to have dealt with the
34166 address, so it will be passed on to subsequent routers to be delivered in the
34167 normal way.
34168 .ecindex IIDsysfil1
34169 .ecindex IIDsysfil2
34170 .ecindex IIDsysfil3
34171
34172
34173
34174
34175
34176
34177 . ////////////////////////////////////////////////////////////////////////////
34178 . ////////////////////////////////////////////////////////////////////////////
34179
34180 .chapter "Message processing" "CHAPmsgproc"
34181 .scindex IIDmesproc "message" "general processing"
34182 Exim performs various transformations on the sender and recipient addresses of
34183 all messages that it handles, and also on the messages' header lines. Some of
34184 these are optional and configurable, while others always take place. All of
34185 this processing, except rewriting as a result of routing, and the addition or
34186 removal of header lines while delivering, happens when a message is received,
34187 before it is placed on Exim's queue.
34188
34189 Some of the automatic processing takes place by default only for
34190 &"locally-originated"& messages. This adjective is used to describe messages
34191 that are not received over TCP/IP, but instead are passed to an Exim process on
34192 its standard input. This includes the interactive &"local SMTP"& case that is
34193 set up by the &%-bs%& command line option.
34194
34195 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34196 or ::1) are not considered to be locally-originated. Exim does not treat the
34197 loopback interface specially in any way.
34198
34199 If you want the loopback interface to be treated specially, you must ensure
34200 that there are appropriate entries in your ACLs.
34201
34202
34203
34204
34205 .section "Submission mode for non-local messages" "SECTsubmodnon"
34206 .cindex "message" "submission"
34207 .cindex "submission mode"
34208 Processing that happens automatically for locally-originated messages (unless
34209 &%suppress_local_fixups%& is set) can also be requested for messages that are
34210 received over TCP/IP. The term &"submission mode"& is used to describe this
34211 state. Submission mode is set by the modifier
34212 .code
34213 control = submission
34214 .endd
34215 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34216 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34217 a local submission, and is normally used when the source of the message is
34218 known to be an MUA running on a client host (as opposed to an MTA). For
34219 example, to set submission mode for messages originating on the IPv4 loopback
34220 interface, you could include the following in the MAIL ACL:
34221 .code
34222 warn  hosts = 127.0.0.1
34223       control = submission
34224 .endd
34225 .cindex "&%sender_retain%& submission option"
34226 There are some options that can be used when setting submission mode. A slash
34227 is used to separate options. For example:
34228 .code
34229 control = submission/sender_retain
34230 .endd
34231 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34232 true and &%local_from_check%& false for the current incoming message. The first
34233 of these allows an existing &'Sender:'& header in the message to remain, and
34234 the second suppresses the check to ensure that &'From:'& matches the
34235 authenticated sender. With this setting, Exim still fixes up messages by adding
34236 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34237 attempt to check sender authenticity in header lines.
34238
34239 When &%sender_retain%& is not set, a submission mode setting may specify a
34240 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34241 example:
34242 .code
34243 control = submission/domain=some.domain
34244 .endd
34245 The domain may be empty. How this value is used is described in sections
34246 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34247 that allows you to specify the user's full name for inclusion in a created
34248 &'Sender:'& or &'From:'& header line. For example:
34249 .code
34250 accept authenticated = *
34251        control = submission/domain=wonderland.example/\
34252                             name=${lookup {$authenticated_id} \
34253                                    lsearch {/etc/exim/namelist}}
34254 .endd
34255 Because the name may contain any characters, including slashes, the &%name%&
34256 option must be given last. The remainder of the string is used as the name. For
34257 the example above, if &_/etc/exim/namelist_& contains:
34258 .code
34259 bigegg:  Humpty Dumpty
34260 .endd
34261 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34262 line would be:
34263 .code
34264 Sender: Humpty Dumpty <bigegg@wonderland.example>
34265 .endd
34266 .cindex "return path" "in submission mode"
34267 By default, submission mode forces the return path to the same address as is
34268 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34269 specified, the return path is also left unchanged.
34270
34271 &*Note*&: The changes caused by submission mode take effect after the predata
34272 ACL. This means that any sender checks performed before the fix-ups use the
34273 untrusted sender address specified by the user, not the trusted sender address
34274 specified by submission mode. Although this might be slightly unexpected, it
34275 does mean that you can configure ACL checks to spot that a user is trying to
34276 spoof another's address.
34277
34278 .section "Line endings" "SECTlineendings"
34279 .cindex "line endings"
34280 .cindex "carriage return"
34281 .cindex "linefeed"
34282 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34283 linefeed) is the line ending for messages transmitted over the Internet using
34284 SMTP over TCP/IP. However, within individual operating systems, different
34285 conventions are used. For example, Unix-like systems use just LF, but others
34286 use CRLF or just CR.
34287
34288 Exim was designed for Unix-like systems, and internally, it stores messages
34289 using the system's convention of a single LF as a line terminator. When
34290 receiving a message, all line endings are translated to this standard format.
34291 Originally, it was thought that programs that passed messages directly to an
34292 MTA within an operating system would use that system's convention. Experience
34293 has shown that this is not the case; for example, there are Unix applications
34294 that use CRLF in this circumstance. For this reason, and for compatibility with
34295 other MTAs, the way Exim handles line endings for all messages is now as
34296 follows:
34297
34298 .ilist
34299 LF not preceded by CR is treated as a line ending.
34300 .next
34301 CR is treated as a line ending; if it is immediately followed by LF, the LF
34302 is ignored.
34303 .next
34304 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34305 nor a local message in the state where a line containing only a dot is a
34306 terminator.
34307 .next
34308 If a bare CR is encountered within a header line, an extra space is added after
34309 the line terminator so as not to end the header line. The reasoning behind this
34310 is that bare CRs in header lines are most likely either to be mistakes, or
34311 people trying to play silly games.
34312 .next
34313 If the first header line received in a message ends with CRLF, a subsequent
34314 bare LF in a header line is treated in the same way as a bare CR in a header
34315 line.
34316 .endlist
34317
34318
34319
34320
34321
34322 .section "Unqualified addresses" "SECID218"
34323 .cindex "unqualified addresses"
34324 .cindex "address" "qualification"
34325 By default, Exim expects every envelope address it receives from an external
34326 host to be fully qualified. Unqualified addresses cause negative responses to
34327 SMTP commands. However, because SMTP is used as a means of transporting
34328 messages from MUAs running on personal workstations, there is sometimes a
34329 requirement to accept unqualified addresses from specific hosts or IP networks.
34330
34331 Exim has two options that separately control which hosts may send unqualified
34332 sender or recipient addresses in SMTP commands, namely
34333 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34334 cases, if an unqualified address is accepted, it is qualified by adding the
34335 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34336
34337 .oindex "&%qualify_domain%&"
34338 .oindex "&%qualify_recipient%&"
34339 Unqualified addresses in header lines are automatically qualified for messages
34340 that are locally originated, unless the &%-bnq%& option is given on the command
34341 line. For messages received over SMTP, unqualified addresses in header lines
34342 are qualified only if unqualified addresses are permitted in SMTP commands. In
34343 other words, such qualification is also controlled by
34344 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34345
34346
34347
34348
34349 .section "The UUCP From line" "SECID219"
34350 .cindex "&""From""& line"
34351 .cindex "UUCP" "&""From""& line"
34352 .cindex "sender" "address"
34353 .oindex "&%uucp_from_pattern%&"
34354 .oindex "&%uucp_from_sender%&"
34355 .cindex "envelope sender"
34356 .cindex "Sendmail compatibility" "&""From""& line"
34357 Messages that have come from UUCP (and some other applications) often begin
34358 with a line containing the envelope sender and a timestamp, following the word
34359 &"From"&. Examples of two common formats are:
34360 .code
34361 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34362 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34363 .endd
34364 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34365 Exim recognizes such lines at the start of messages that are submitted to it
34366 via the command line (that is, on the standard input). It does not recognize
34367 such lines in incoming SMTP messages, unless the sending host matches
34368 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34369 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34370 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34371 default value matches the two common cases shown above and puts the address
34372 that follows &"From"& into &$1$&.
34373
34374 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34375 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34376 a trusted user, the message's sender address is constructed by expanding the
34377 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34378 then parsed as an RFC 2822 address. If there is no domain, the local part is
34379 qualified with &%qualify_domain%& unless it is the empty string. However, if
34380 the command line &%-f%& option is used, it overrides the &"From"& line.
34381
34382 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34383 sender address is not changed. This is also the case for incoming SMTP messages
34384 that are permitted to contain &"From"& lines.
34385
34386 Only one &"From"& line is recognized. If there is more than one, the second is
34387 treated as a data line that starts the body of the message, as it is not valid
34388 as a header line. This also happens if a &"From"& line is present in an
34389 incoming SMTP message from a source that is not permitted to send them.
34390
34391
34392
34393 .section "Resent- header lines" "SECID220"
34394 .cindex "&%Resent-%& header lines"
34395 .cindex "header lines" "Resent-"
34396 RFC 2822 makes provision for sets of header lines starting with the string
34397 &`Resent-`& to be added to a message when it is resent by the original
34398 recipient to somebody else. These headers are &'Resent-Date:'&,
34399 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34400 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34401
34402 .blockquote
34403 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34404 processing of replies or other such automatic actions on messages.'&
34405 .endblockquote
34406
34407 This leaves things a bit vague as far as other processing actions such as
34408 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34409 follows:
34410
34411 .ilist
34412 A &'Resent-From:'& line that just contains the login id of the submitting user
34413 is automatically rewritten in the same way as &'From:'& (see below).
34414 .next
34415 If there's a rewriting rule for a particular header line, it is also applied to
34416 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34417 &'From:'& also rewrites &'Resent-From:'&.
34418 .next
34419 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34420 also removed.
34421 .next
34422 For a locally-submitted message,
34423 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34424 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34425 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34426 included in log lines in this case.
34427 .next
34428 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34429 &%Resent-%& header lines are present.
34430 .endlist
34431
34432
34433
34434
34435 .section "The Auto-Submitted: header line" "SECID221"
34436 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34437 includes the header line:
34438 .code
34439 Auto-Submitted: auto-replied
34440 .endd
34441
34442 .section "The Bcc: header line" "SECID222"
34443 .cindex "&'Bcc:'& header line"
34444 If Exim is called with the &%-t%& option, to take recipient addresses from a
34445 message's header, it removes any &'Bcc:'& header line that may exist (after
34446 extracting its addresses). If &%-t%& is not present on the command line, any
34447 existing &'Bcc:'& is not removed.
34448
34449
34450 .section "The Date: header line" "SECID223"
34451 .cindex "&'Date:'& header line"
34452 .cindex "header lines" "Date:"
34453 If a locally-generated or submission-mode message has no &'Date:'& header line,
34454 Exim adds one, using the current date and time, unless the
34455 &%suppress_local_fixups%& control has been specified.
34456
34457 .section "The Delivery-date: header line" "SECID224"
34458 .cindex "&'Delivery-date:'& header line"
34459 .oindex "&%delivery_date_remove%&"
34460 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34461 set. Exim can be configured to add them to the final delivery of messages. (See
34462 the generic &%delivery_date_add%& transport option.) They should not be present
34463 in messages in transit. If the &%delivery_date_remove%& configuration option is
34464 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34465 messages.
34466
34467
34468 .section "The Envelope-to: header line" "SECID225"
34469 .cindex "&'Envelope-to:'& header line"
34470 .cindex "header lines" "Envelope-to:"
34471 .oindex "&%envelope_to_remove%&"
34472 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34473 Exim can be configured to add them to the final delivery of messages. (See the
34474 generic &%envelope_to_add%& transport option.) They should not be present in
34475 messages in transit. If the &%envelope_to_remove%& configuration option is set
34476 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34477 messages.
34478
34479
34480 .section "The From: header line" "SECTthefrohea"
34481 .cindex "&'From:'& header line"
34482 .cindex "header lines" "From:"
34483 .cindex "Sendmail compatibility" "&""From""& line"
34484 .cindex "message" "submission"
34485 .cindex "submission mode"
34486 If a submission-mode message does not contain a &'From:'& header line, Exim
34487 adds one if either of the following conditions is true:
34488
34489 .ilist
34490 The envelope sender address is not empty (that is, this is not a bounce
34491 message). The added header line copies the envelope sender address.
34492 .next
34493 .vindex "&$authenticated_id$&"
34494 The SMTP session is authenticated and &$authenticated_id$& is not empty.
34495 .olist
34496 .vindex "&$qualify_domain$&"
34497 If no domain is specified by the submission control, the local part is
34498 &$authenticated_id$& and the domain is &$qualify_domain$&.
34499 .next
34500 If a non-empty domain is specified by the submission control, the local
34501 part is &$authenticated_id$&, and the domain is the specified domain.
34502 .next
34503 If an empty domain is specified by the submission control,
34504 &$authenticated_id$& is assumed to be the complete address.
34505 .endlist
34506 .endlist
34507
34508 A non-empty envelope sender takes precedence.
34509
34510 If a locally-generated incoming message does not contain a &'From:'& header
34511 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
34512 containing the sender's address. The calling user's login name and full name
34513 are used to construct the address, as described in section &<<SECTconstr>>&.
34514 They are obtained from the password data by calling &[getpwuid()]& (but see the
34515 &%unknown_login%& configuration option). The address is qualified with
34516 &%qualify_domain%&.
34517
34518 For compatibility with Sendmail, if an incoming, non-SMTP message has a
34519 &'From:'& header line containing just the unqualified login name of the calling
34520 user, this is replaced by an address containing the user's login name and full
34521 name as described in section &<<SECTconstr>>&.
34522
34523
34524 .section "The Message-ID: header line" "SECID226"
34525 .cindex "&'Message-ID:'& header line"
34526 .cindex "header lines" "Message-ID:"
34527 .cindex "message" "submission"
34528 .oindex "&%message_id_header_text%&"
34529 If a locally-generated or submission-mode incoming message does not contain a
34530 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
34531 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
34532 to the message. If there are any &'Resent-:'& headers in the message, it
34533 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
34534 message id, preceded by the letter E to ensure it starts with a letter, and
34535 followed by @ and the primary host name. Additional information can be included
34536 in this header line by setting the &%message_id_header_text%& and/or
34537 &%message_id_header_domain%& options.
34538
34539
34540 .section "The Received: header line" "SECID227"
34541 .cindex "&'Received:'& header line"
34542 .cindex "header lines" "Received:"
34543 A &'Received:'& header line is added at the start of every message. The
34544 contents are defined by the &%received_header_text%& configuration option, and
34545 Exim automatically adds a semicolon and a timestamp to the configured string.
34546
34547 The &'Received:'& header is generated as soon as the message's header lines
34548 have been received. At this stage, the timestamp in the &'Received:'& header
34549 line is the time that the message started to be received. This is the value
34550 that is seen by the DATA ACL and by the &[local_scan()]& function.
34551
34552 Once a message is accepted, the timestamp in the &'Received:'& header line is
34553 changed to the time of acceptance, which is (apart from a small delay while the
34554 -H spool file is written) the earliest time at which delivery could start.
34555
34556
34557 .section "The References: header line" "SECID228"
34558 .cindex "&'References:'& header line"
34559 .cindex "header lines" "References:"
34560 Messages created by the &(autoreply)& transport include a &'References:'&
34561 header line. This is constructed according to the rules that are described in
34562 section 3.64 of RFC 2822 (which states that replies should contain such a
34563 header line), and section 3.14 of RFC 3834 (which states that automatic
34564 responses are not different in this respect). However, because some mail
34565 processing software does not cope well with very long header lines, no more
34566 than 12 message IDs are copied from the &'References:'& header line in the
34567 incoming message. If there are more than 12, the first one and then the final
34568 11 are copied, before adding the message ID of the incoming message.
34569
34570
34571
34572 .section "The Return-path: header line" "SECID229"
34573 .cindex "&'Return-path:'& header line"
34574 .cindex "header lines" "Return-path:"
34575 .oindex "&%return_path_remove%&"
34576 &'Return-path:'& header lines are defined as something an MTA may insert when
34577 it does the final delivery of messages. (See the generic &%return_path_add%&
34578 transport option.) Therefore, they should not be present in messages in
34579 transit. If the &%return_path_remove%& configuration option is set (the
34580 default), Exim removes &'Return-path:'& header lines from incoming messages.
34581
34582
34583
34584 .section "The Sender: header line" "SECTthesenhea"
34585 .cindex "&'Sender:'& header line"
34586 .cindex "message" "submission"
34587 .cindex "header lines" "Sender:"
34588 For a locally-originated message from an untrusted user, Exim may remove an
34589 existing &'Sender:'& header line, and it may add a new one. You can modify
34590 these actions by setting the &%local_sender_retain%& option true, the
34591 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
34592 control setting.
34593
34594 When a local message is received from an untrusted user and
34595 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
34596 control has not been set, a check is made to see if the address given in the
34597 &'From:'& header line is the correct (local) sender of the message. The address
34598 that is expected has the login name as the local part and the value of
34599 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
34600 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
34601 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
34602 line is added to the message.
34603
34604 If you set &%local_from_check%& false, this checking does not occur. However,
34605 the removal of an existing &'Sender:'& line still happens, unless you also set
34606 &%local_sender_retain%& to be true. It is not possible to set both of these
34607 options true at the same time.
34608
34609 .cindex "submission mode"
34610 By default, no processing of &'Sender:'& header lines is done for messages
34611 received over TCP/IP or for messages submitted by trusted users. However, when
34612 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
34613 not specified on the submission control, the following processing takes place:
34614
34615 .vindex "&$authenticated_id$&"
34616 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
34617 authenticated, and &$authenticated_id$& is not empty, a sender address is
34618 created as follows:
34619
34620 .ilist
34621 .vindex "&$qualify_domain$&"
34622 If no domain is specified by the submission control, the local part is
34623 &$authenticated_id$& and the domain is &$qualify_domain$&.
34624 .next
34625 If a non-empty domain is specified by the submission control, the local part
34626 is &$authenticated_id$&, and the domain is the specified domain.
34627 .next
34628 If an empty domain is specified by the submission control,
34629 &$authenticated_id$& is assumed to be the complete address.
34630 .endlist
34631
34632 This address is compared with the address in the &'From:'& header line. If they
34633 are different, a &'Sender:'& header line containing the created address is
34634 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
34635 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
34636
34637 .cindex "return path" "created from &'Sender:'&"
34638 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
34639 the message (the envelope sender address) is changed to be the same address,
34640 except in the case of submission mode when &%sender_retain%& is specified.
34641
34642
34643
34644 .section "Adding and removing header lines in routers and transports" &&&
34645          "SECTheadersaddrem"
34646 .cindex "header lines" "adding; in router or transport"
34647 .cindex "header lines" "removing; in router or transport"
34648 When a message is delivered, the addition and removal of header lines can be
34649 specified in a system filter, or on any of the routers and transports that
34650 process the message. Section &<<SECTaddremheasys>>& contains details about
34651 modifying headers in a system filter. Header lines can also be added in an ACL
34652 as a message is received (see section &<<SECTaddheadacl>>&).
34653
34654 In contrast to what happens in a system filter, header modifications that are
34655 specified on routers and transports apply only to the particular recipient
34656 addresses that are being processed by those routers and transports. These
34657 changes do not actually take place until a copy of the message is being
34658 transported. Therefore, they do not affect the basic set of header lines, and
34659 they do not affect the values of the variables that refer to header lines.
34660
34661 &*Note*&: In particular, this means that any expansions in the configuration of
34662 the transport cannot refer to the modified header lines, because such
34663 expansions all occur before the message is actually transported.
34664
34665 For both routers and transports, the argument of a &%headers_add%&
34666 option must be in the form of one or more RFC 2822 header lines, separated by
34667 newlines (coded as &"\n"&). For example:
34668 .code
34669 headers_add = X-added-header: added by $primary_hostname\n\
34670               X-added-second: another added header line
34671 .endd
34672 Exim does not check the syntax of these added header lines.
34673
34674 Multiple &%headers_add%& options for a single router or transport can be
34675 specified; the values will append to a single list of header lines.
34676 Each header-line is separately expanded.
34677
34678 The argument of a &%headers_remove%& option must consist of a colon-separated
34679 list of header names. This is confusing, because header names themselves are
34680 often terminated by colons. In this case, the colons are the list separators,
34681 not part of the names. For example:
34682 .code
34683 headers_remove = return-receipt-to:acknowledge-to
34684 .endd
34685
34686 Multiple &%headers_remove%& options for a single router or transport can be
34687 specified; the arguments will append to a single header-names list.
34688 Each item is separately expanded.
34689 Note that colons in complex expansions which are used to
34690 form all or part of a &%headers_remove%& list
34691 will act as list separators.
34692
34693 When &%headers_add%& or &%headers_remove%& is specified on a router,
34694 items are expanded at routing time,
34695 and then associated with all addresses that are
34696 accepted by that router, and also with any new addresses that it generates. If
34697 an address passes through several routers as a result of aliasing or
34698 forwarding, the changes are cumulative.
34699
34700 .oindex "&%unseen%&"
34701 However, this does not apply to multiple routers that result from the use of
34702 the &%unseen%& option. Any header modifications that were specified by the
34703 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
34704
34705 Addresses that end up with different &%headers_add%& or &%headers_remove%&
34706 settings cannot be delivered together in a batch, so a transport is always
34707 dealing with a set of addresses that have the same header-processing
34708 requirements.
34709
34710 The transport starts by writing the original set of header lines that arrived
34711 with the message, possibly modified by the system filter. As it writes out
34712 these lines, it consults the list of header names that were attached to the
34713 recipient address(es) by &%headers_remove%& options in routers, and it also
34714 consults the transport's own &%headers_remove%& option. Header lines whose
34715 names are on either of these lists are not written out. If there are multiple
34716 instances of any listed header, they are all skipped.
34717
34718 After the remaining original header lines have been written, new header
34719 lines that were specified by routers' &%headers_add%& options are written, in
34720 the order in which they were attached to the address. These are followed by any
34721 header lines specified by the transport's &%headers_add%& option.
34722
34723 This way of handling header line modifications in routers and transports has
34724 the following consequences:
34725
34726 .ilist
34727 The original set of header lines, possibly modified by the system filter,
34728 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
34729 to it, at all times.
34730 .next
34731 Header lines that are added by a router's
34732 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
34733 expansion syntax in subsequent routers or the transport.
34734 .next
34735 Conversely, header lines that are specified for removal by &%headers_remove%&
34736 in a router remain visible to subsequent routers and the transport.
34737 .next
34738 Headers added to an address by &%headers_add%& in a router cannot be removed by
34739 a later router or by a transport.
34740 .next
34741 An added header can refer to the contents of an original header that is to be
34742 removed, even it has the same name as the added header. For example:
34743 .code
34744 headers_remove = subject
34745 headers_add = Subject: new subject (was: $h_subject:)
34746 .endd
34747 .endlist
34748
34749 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
34750 for a &(redirect)& router that has the &%one_time%& option set.
34751
34752
34753
34754
34755
34756 .section "Constructed addresses" "SECTconstr"
34757 .cindex "address" "constructed"
34758 .cindex "constructed address"
34759 When Exim constructs a sender address for a locally-generated message, it uses
34760 the form
34761 .display
34762 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
34763 .endd
34764 For example:
34765 .code
34766 Zaphod Beeblebrox <zaphod@end.univ.example>
34767 .endd
34768 The user name is obtained from the &%-F%& command line option if set, or
34769 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
34770 &"gecos"& field from the password entry. If the &"gecos"& field contains an
34771 ampersand character, this is replaced by the login name with the first letter
34772 upper cased, as is conventional in a number of operating systems. See the
34773 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
34774 The &%unknown_username%& option can be used to specify user names in cases when
34775 there is no password file entry.
34776
34777 .cindex "RFC 2047"
34778 In all cases, the user name is made to conform to RFC 2822 by quoting all or
34779 parts of it if necessary. In addition, if it contains any non-printing
34780 characters, it is encoded as described in RFC 2047, which defines a way of
34781 including non-ASCII characters in header lines. The value of the
34782 &%headers_charset%& option specifies the name of the encoding that is used (the
34783 characters are assumed to be in this encoding). The setting of
34784 &%print_topbitchars%& controls whether characters with the top bit set (that
34785 is, with codes greater than 127) count as printing characters or not.
34786
34787
34788
34789 .section "Case of local parts" "SECID230"
34790 .cindex "case of local parts"
34791 .cindex "local part" "case of"
34792 RFC 2822 states that the case of letters in the local parts of addresses cannot
34793 be assumed to be non-significant. Exim preserves the case of local parts of
34794 addresses, but by default it uses a lower-cased form when it is routing,
34795 because on most Unix systems, usernames are in lower case and case-insensitive
34796 routing is required. However, any particular router can be made to use the
34797 original case for local parts by setting the &%caseful_local_part%& generic
34798 router option.
34799
34800 .cindex "mixed-case login names"
34801 If you must have mixed-case user names on your system, the best way to proceed,
34802 assuming you want case-independent handling of incoming email, is to set up
34803 your first router to convert incoming local parts in your domains to the
34804 correct case by means of a file lookup. For example:
34805 .code
34806 correct_case:
34807   driver = redirect
34808   domains = +local_domains
34809   data = ${lookup{$local_part}cdb\
34810               {/etc/usercased.cdb}{$value}fail}\
34811               @$domain
34812 .endd
34813 For this router, the local part is forced to lower case by the default action
34814 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
34815 up a new local part in the correct case. If you then set &%caseful_local_part%&
34816 on any subsequent routers which process your domains, they will operate on
34817 local parts with the correct case in a case-sensitive manner.
34818
34819
34820
34821 .section "Dots in local parts" "SECID231"
34822 .cindex "dot" "in local part"
34823 .cindex "local part" "dots in"
34824 RFC 2822 forbids empty components in local parts. That is, an unquoted local
34825 part may not begin or end with a dot, nor have two consecutive dots in the
34826 middle. However, it seems that many MTAs do not enforce this, so Exim permits
34827 empty components for compatibility.
34828
34829
34830
34831 .section "Rewriting addresses" "SECID232"
34832 .cindex "rewriting" "addresses"
34833 Rewriting of sender and recipient addresses, and addresses in headers, can
34834 happen automatically, or as the result of configuration options, as described
34835 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
34836 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
34837
34838 Automatic rewriting includes qualification, as mentioned above. The other case
34839 in which it can happen is when an incomplete non-local domain is given. The
34840 routing process may cause this to be expanded into the full domain name. For
34841 example, a header such as
34842 .code
34843 To: hare@teaparty
34844 .endd
34845 might get rewritten as
34846 .code
34847 To: hare@teaparty.wonderland.fict.example
34848 .endd
34849 Rewriting as a result of routing is the one kind of message processing that
34850 does not happen at input time, as it cannot be done until the address has
34851 been routed.
34852
34853 Strictly, one should not do &'any'& deliveries of a message until all its
34854 addresses have been routed, in case any of the headers get changed as a
34855 result of routing. However, doing this in practice would hold up many
34856 deliveries for unreasonable amounts of time, just because one address could not
34857 immediately be routed. Exim therefore does not delay other deliveries when
34858 routing of one or more addresses is deferred.
34859 .ecindex IIDmesproc
34860
34861
34862
34863 . ////////////////////////////////////////////////////////////////////////////
34864 . ////////////////////////////////////////////////////////////////////////////
34865
34866 .chapter "SMTP processing" "CHAPSMTP"
34867 .scindex IIDsmtpproc1 "SMTP" "processing details"
34868 .scindex IIDsmtpproc2 "LMTP" "processing details"
34869 Exim supports a number of different ways of using the SMTP protocol, and its
34870 LMTP variant, which is an interactive protocol for transferring messages into a
34871 closed mail store application. This chapter contains details of how SMTP is
34872 processed. For incoming mail, the following are available:
34873
34874 .ilist
34875 SMTP over TCP/IP (Exim daemon or &'inetd'&);
34876 .next
34877 SMTP over the standard input and output (the &%-bs%& option);
34878 .next
34879 Batched SMTP on the standard input (the &%-bS%& option).
34880 .endlist
34881
34882 For mail delivery, the following are available:
34883
34884 .ilist
34885 SMTP over TCP/IP (the &(smtp)& transport);
34886 .next
34887 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
34888 &"lmtp"&);
34889 .next
34890 LMTP over a pipe to a process running in the local host (the &(lmtp)&
34891 transport);
34892 .next
34893 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
34894 the &%use_bsmtp%& option set).
34895 .endlist
34896
34897 &'Batched SMTP'& is the name for a process in which batches of messages are
34898 stored in or read from files (or pipes), in a format in which SMTP commands are
34899 used to contain the envelope information.
34900
34901
34902
34903 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
34904 .cindex "SMTP" "outgoing over TCP/IP"
34905 .cindex "outgoing SMTP over TCP/IP"
34906 .cindex "LMTP" "over TCP/IP"
34907 .cindex "outgoing LMTP over TCP/IP"
34908 .cindex "EHLO"
34909 .cindex "HELO"
34910 .cindex "SIZE option on MAIL command"
34911 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
34912 The &%protocol%& option selects which protocol is to be used, but the actual
34913 processing is the same in both cases.
34914
34915 If, in response to its EHLO command, Exim is told that the SIZE
34916 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
34917 command. The value of <&'n'&> is the message size plus the value of the
34918 &%size_addition%& option (default 1024) to allow for additions to the message
34919 such as per-transport header lines, or changes made in a
34920 .cindex "transport" "filter"
34921 .cindex "filter" "transport filter"
34922 transport filter. If &%size_addition%& is set negative, the use of SIZE is
34923 suppressed.
34924
34925 If the remote server advertises support for PIPELINING, Exim uses the
34926 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
34927 required for the transaction.
34928
34929 If the remote server advertises support for the STARTTLS command, and Exim
34930 was built to support TLS encryption, it tries to start a TLS session unless the
34931 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
34932 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
34933 is called for verification.
34934
34935 If the remote server advertises support for the AUTH command, Exim scans
34936 the authenticators configuration for any suitable client settings, as described
34937 in chapter &<<CHAPSMTPAUTH>>&.
34938
34939 .cindex "carriage return"
34940 .cindex "linefeed"
34941 Responses from the remote host are supposed to be terminated by CR followed by
34942 LF. However, there are known to be hosts that do not send CR characters, so in
34943 order to be able to interwork with such hosts, Exim treats LF on its own as a
34944 line terminator.
34945
34946 If a message contains a number of different addresses, all those with the same
34947 characteristics (for example, the same envelope sender) that resolve to the
34948 same set of hosts, in the same order, are sent in a single SMTP transaction,
34949 even if they are for different domains, unless there are more than the setting
34950 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
34951 they are split into groups containing no more than &%max_rcpt%&s addresses
34952 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
34953 in parallel sessions. The order of hosts with identical MX values is not
34954 significant when checking whether addresses can be batched in this way.
34955
34956 When the &(smtp)& transport suffers a temporary failure that is not
34957 message-related, Exim updates its transport-specific database, which contains
34958 records indexed by host name that remember which messages are waiting for each
34959 particular host. It also updates the retry database with new retry times.
34960
34961 .cindex "hints database" "retry keys"
34962 Exim's retry hints are based on host name plus IP address, so if one address of
34963 a multi-homed host is broken, it will soon be skipped most of the time.
34964 See the next section for more detail about error handling.
34965
34966 .cindex "SMTP" "passed connection"
34967 .cindex "SMTP" "batching over TCP/IP"
34968 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34969 looks in the hints database for the transport to see if there are any queued
34970 messages waiting for the host to which it is connected. If it finds one, it
34971 creates a new Exim process using the &%-MC%& option (which can only be used by
34972 a process running as root or the Exim user) and passes the TCP/IP socket to it
34973 so that it can deliver another message using the same socket. The new process
34974 does only those deliveries that are routed to the connected host, and may in
34975 turn pass the socket on to a third process, and so on.
34976
34977 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34978 limit the number of messages sent down a single TCP/IP connection.
34979
34980 .cindex "asterisk" "after IP address"
34981 The second and subsequent messages delivered down an existing connection are
34982 identified in the main log by the addition of an asterisk after the closing
34983 square bracket of the IP address.
34984
34985
34986
34987
34988 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34989 .cindex "error" "in outgoing SMTP"
34990 .cindex "SMTP" "errors in outgoing"
34991 .cindex "host" "error"
34992 Three different kinds of error are recognized for outgoing SMTP: host errors,
34993 message errors, and recipient errors.
34994
34995 .vlist
34996 .vitem "&*Host errors*&"
34997 A host error is not associated with a particular message or with a
34998 particular recipient of a message. The host errors are:
34999
35000 .ilist
35001 Connection refused or timed out,
35002 .next
35003 Any error response code on connection,
35004 .next
35005 Any error response code to EHLO or HELO,
35006 .next
35007 Loss of connection at any time, except after &"."&,
35008 .next
35009 I/O errors at any time,
35010 .next
35011 Timeouts during the session, other than in response to MAIL, RCPT or
35012 the &"."& at the end of the data.
35013 .endlist ilist
35014
35015 For a host error, a permanent error response on connection, or in response to
35016 EHLO, causes all addresses routed to the host to be failed. Any other host
35017 error causes all addresses to be deferred, and retry data to be created for the
35018 host. It is not tried again, for any message, until its retry time arrives. If
35019 the current set of addresses are not all delivered in this run (to some
35020 alternative host), the message is added to the list of those waiting for this
35021 host, so if it is still undelivered when a subsequent successful delivery is
35022 made to the host, it will be sent down the same SMTP connection.
35023
35024 .vitem "&*Message errors*&"
35025 .cindex "message" "error"
35026 A message error is associated with a particular message when sent to a
35027 particular host, but not with a particular recipient of the message. The
35028 message errors are:
35029
35030 .ilist
35031 Any error response code to MAIL, DATA, or the &"."& that terminates
35032 the data,
35033 .next
35034 Timeout after MAIL,
35035 .next
35036 Timeout or loss of connection after the &"."& that terminates the data. A
35037 timeout after the DATA command itself is treated as a host error, as is loss of
35038 connection at any other time.
35039 .endlist ilist
35040
35041 For a message error, a permanent error response (5&'xx'&) causes all addresses
35042 to be failed, and a delivery error report to be returned to the sender. A
35043 temporary error response (4&'xx'&), or one of the timeouts, causes all
35044 addresses to be deferred. Retry data is not created for the host, but instead,
35045 a retry record for the combination of host plus message id is created. The
35046 message is not added to the list of those waiting for this host. This ensures
35047 that the failing message will not be sent to this host again until the retry
35048 time arrives. However, other messages that are routed to the host are not
35049 affected, so if it is some property of the message that is causing the error,
35050 it will not stop the delivery of other mail.
35051
35052 If the remote host specified support for the SIZE parameter in its response
35053 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35054 over-large message will cause a message error because the error arrives as a
35055 response to MAIL.
35056
35057 .vitem "&*Recipient errors*&"
35058 .cindex "recipient" "error"
35059 A recipient error is associated with a particular recipient of a message. The
35060 recipient errors are:
35061
35062 .ilist
35063 Any error response to RCPT,
35064 .next
35065 Timeout after RCPT.
35066 .endlist
35067
35068 For a recipient error, a permanent error response (5&'xx'&) causes the
35069 recipient address to be failed, and a bounce message to be returned to the
35070 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35071 address to be deferred, and routing retry data to be created for it. This is
35072 used to delay processing of the address in subsequent queue runs, until its
35073 routing retry time arrives. This applies to all messages, but because it
35074 operates only in queue runs, one attempt will be made to deliver a new message
35075 to the failing address before the delay starts to operate. This ensures that,
35076 if the failure is really related to the message rather than the recipient
35077 (&"message too big for this recipient"& is a possible example), other messages
35078 have a chance of getting delivered. If a delivery to the address does succeed,
35079 the retry information gets cleared, so all stuck messages get tried again, and
35080 the retry clock is reset.
35081
35082 The message is not added to the list of those waiting for this host. Use of the
35083 host for other messages is unaffected, and except in the case of a timeout,
35084 other recipients are processed independently, and may be successfully delivered
35085 in the current SMTP session. After a timeout it is of course impossible to
35086 proceed with the session, so all addresses get deferred. However, those other
35087 than the one that failed do not suffer any subsequent retry delays. Therefore,
35088 if one recipient is causing trouble, the others have a chance of getting
35089 through when a subsequent delivery attempt occurs before the failing
35090 recipient's retry time.
35091 .endlist
35092
35093 In all cases, if there are other hosts (or IP addresses) available for the
35094 current set of addresses (for example, from multiple MX records), they are
35095 tried in this run for any undelivered addresses, subject of course to their
35096 own retry data. In other words, recipient error retry data does not take effect
35097 until the next delivery attempt.
35098
35099 Some hosts have been observed to give temporary error responses to every
35100 MAIL command at certain times (&"insufficient space"& has been seen). It
35101 would be nice if such circumstances could be recognized, and defer data for the
35102 host itself created, but this is not possible within the current Exim design.
35103 What actually happens is that retry data for every (host, message) combination
35104 is created.
35105
35106 The reason that timeouts after MAIL and RCPT are treated specially is that
35107 these can sometimes arise as a result of the remote host's verification
35108 procedures. Exim makes this assumption, and treats them as if a temporary error
35109 response had been received. A timeout after &"."& is treated specially because
35110 it is known that some broken implementations fail to recognize the end of the
35111 message if the last character of the last line is a binary zero. Thus, it is
35112 helpful to treat this case as a message error.
35113
35114 Timeouts at other times are treated as host errors, assuming a problem with the
35115 host, or the connection to it. If a timeout after MAIL, RCPT,
35116 or &"."& is really a connection problem, the assumption is that at the next try
35117 the timeout is likely to occur at some other point in the dialogue, causing it
35118 then to be treated as a host error.
35119
35120 There is experimental evidence that some MTAs drop the connection after the
35121 terminating &"."& if they do not like the contents of the message for some
35122 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35123 should be given. That is why Exim treats this case as a message rather than a
35124 host error, in order not to delay other messages to the same host.
35125
35126
35127
35128
35129 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35130 .cindex "SMTP" "incoming over TCP/IP"
35131 .cindex "incoming SMTP over TCP/IP"
35132 .cindex "inetd"
35133 .cindex "daemon"
35134 Incoming SMTP messages can be accepted in one of two ways: by running a
35135 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35136 &_/etc/inetd.conf_& should be like this:
35137 .code
35138 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35139 .endd
35140 Exim distinguishes between this case and the case of a locally running user
35141 agent using the &%-bs%& option by checking whether or not the standard input is
35142 a socket. When it is, either the port must be privileged (less than 1024), or
35143 the caller must be root or the Exim user. If any other user passes a socket
35144 with an unprivileged port number, Exim prints a message on the standard error
35145 stream and exits with an error code.
35146
35147 By default, Exim does not make a log entry when a remote host connects or
35148 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35149 unexpected. It can be made to write such log entries by setting the
35150 &%smtp_connection%& log selector.
35151
35152 .cindex "carriage return"
35153 .cindex "linefeed"
35154 Commands from the remote host are supposed to be terminated by CR followed by
35155 LF. However, there are known to be hosts that do not send CR characters. In
35156 order to be able to interwork with such hosts, Exim treats LF on its own as a
35157 line terminator.
35158 Furthermore, because common code is used for receiving messages from all
35159 sources, a CR on its own is also interpreted as a line terminator. However, the
35160 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35161
35162 .cindex "EHLO" "invalid data"
35163 .cindex "HELO" "invalid data"
35164 One area that sometimes gives rise to problems concerns the EHLO or
35165 HELO commands. Some clients send syntactically invalid versions of these
35166 commands, which Exim rejects by default. (This is nothing to do with verifying
35167 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35168 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35169 match the broken hosts that send invalid commands.
35170
35171 .cindex "SIZE option on MAIL command"
35172 .cindex "MAIL" "SIZE option"
35173 The amount of disk space available is checked whenever SIZE is received on
35174 a MAIL command, independently of whether &%message_size_limit%& or
35175 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35176 false. A temporary error is given if there is not enough space. If
35177 &%check_spool_space%& is set, the check is for that amount of space plus the
35178 value given with SIZE, that is, it checks that the addition of the incoming
35179 message will not reduce the space below the threshold.
35180
35181 When a message is successfully received, Exim includes the local message id in
35182 its response to the final &"."& that terminates the data. If the remote host
35183 logs this text it can help with tracing what has happened to a message.
35184
35185 The Exim daemon can limit the number of simultaneous incoming connections it is
35186 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35187 number of simultaneous incoming connections from a single remote host (see the
35188 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35189 rejected using the SMTP temporary error code 421.
35190
35191 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35192 subprocess has finished, as this can get lost at busy times. Instead, it looks
35193 for completed subprocesses every time it wakes up. Provided there are other
35194 things happening (new incoming calls, starts of queue runs), completed
35195 processes will be noticed and tidied away. On very quiet systems you may
35196 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35197 it will be noticed when the daemon next wakes up.
35198
35199 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35200 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35201 high system load &-- for details see the &%smtp_accept_reserve%&,
35202 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35203 applies in both the daemon and &'inetd'& cases.
35204
35205 Exim normally starts a delivery process for each message received, though this
35206 can be varied by means of the &%-odq%& command line option and the
35207 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35208 number of simultaneously running delivery processes started in this way from
35209 SMTP input can be limited by the &%smtp_accept_queue%& and
35210 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35211 subsequently received messages are just put on the input queue without starting
35212 a delivery process.
35213
35214 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35215 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35216 started up from the &'inetd'& daemon, because in that case each connection is
35217 handled by an entirely independent Exim process. Control by load average is,
35218 however, available with &'inetd'&.
35219
35220 Exim can be configured to verify addresses in incoming SMTP commands as they
35221 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35222 to rewrite addresses at this time &-- before any syntax checking is done. See
35223 section &<<SECTrewriteS>>&.
35224
35225 Exim can also be configured to limit the rate at which a client host submits
35226 MAIL and RCPT commands in a single SMTP session. See the
35227 &%smtp_ratelimit_hosts%& option.
35228
35229
35230
35231 .section "Unrecognized SMTP commands" "SECID234"
35232 .cindex "SMTP" "unrecognized commands"
35233 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35234 commands during a single SMTP connection, it drops the connection after sending
35235 the error response to the last command. The default value for
35236 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35237 abuse that subvert web servers into making connections to SMTP ports; in these
35238 circumstances, a number of non-SMTP lines are sent first.
35239
35240
35241 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35242 .cindex "SMTP" "syntax errors"
35243 .cindex "SMTP" "protocol errors"
35244 A syntax error is detected if an SMTP command is recognized, but there is
35245 something syntactically wrong with its data, for example, a malformed email
35246 address in a RCPT command. Protocol errors include invalid command
35247 sequencing such as RCPT before MAIL. If Exim receives more than
35248 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35249 drops the connection after sending the error response to the last command. The
35250 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35251 broken clients that loop sending bad commands (yes, it has been seen).
35252
35253
35254
35255 .section "Use of non-mail SMTP commands" "SECID236"
35256 .cindex "SMTP" "non-mail commands"
35257 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35258 DATA. Exim counts such commands, and drops the connection if there are too
35259 many of them in a single SMTP session. This action catches some
35260 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35261 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35262 defines what &"too many"& means. Its default value is 10.
35263
35264 When a new message is expected, one occurrence of RSET is not counted. This
35265 allows a client to send one RSET between messages (this is not necessary,
35266 but some clients do it). Exim also allows one uncounted occurrence of HELO
35267 or EHLO, and one occurrence of STARTTLS between messages. After
35268 starting up a TLS session, another EHLO is expected, and so it too is not
35269 counted.
35270
35271 The first occurrence of AUTH in a connection, or immediately following
35272 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35273 RCPT, DATA, and QUIT are counted.
35274
35275 You can control which hosts are subject to the limit set by
35276 &%smtp_accept_max_nonmail%& by setting
35277 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35278 the limit apply to all hosts. This option means that you can exclude any
35279 specific badly-behaved hosts that you have to live with.
35280
35281
35282
35283
35284 .section "The VRFY and EXPN commands" "SECID237"
35285 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35286 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35287 appropriate) in order to decide whether the command should be accepted or not.
35288
35289 .cindex "VRFY" "processing"
35290 When no ACL is defined for VRFY, or if it rejects without
35291 setting an explicit response code, the command is accepted
35292 (with a 252 SMTP response code)
35293 in order to support awkward clients that do a VRFY before every RCPT.
35294 When VRFY is accepted, it runs exactly the same code as when Exim is
35295 called with the &%-bv%& option, and returns 250/451/550
35296 SMTP response codes.
35297
35298 .cindex "EXPN" "processing"
35299 If no ACL for EXPN is defined, the command is rejected.
35300 When EXPN is accepted, a single-level expansion of the address is done.
35301 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35302 than a verification (the &%-bv%& option). If an unqualified local part is given
35303 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35304 of VRFY and EXPN commands are logged on the main and reject logs, and
35305 VRFY verification failures are logged on the main log for consistency with
35306 RCPT failures.
35307
35308
35309
35310 .section "The ETRN command" "SECTETRN"
35311 .cindex "ETRN" "processing"
35312 RFC 1985 describes an SMTP command called ETRN that is designed to
35313 overcome the security problems of the TURN command (which has fallen into
35314 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35315 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35316 should be accepted or not. If no ACL is defined, the command is rejected.
35317
35318 The ETRN command is concerned with &"releasing"& messages that are awaiting
35319 delivery to certain hosts. As Exim does not organize its message queue by host,
35320 the only form of ETRN that is supported by default is the one where the
35321 text starts with the &"#"& prefix, in which case the remainder of the text is
35322 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35323 the &%-R%& option to happen, with the remainder of the ETRN text as its
35324 argument. For example,
35325 .code
35326 ETRN #brigadoon
35327 .endd
35328 runs the command
35329 .code
35330 exim -R brigadoon
35331 .endd
35332 which causes a delivery attempt on all messages with undelivered addresses
35333 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35334 default), Exim prevents the simultaneous execution of more than one queue run
35335 for the same argument string as a result of an ETRN command. This stops
35336 a misbehaving client from starting more than one queue runner at once.
35337
35338 .cindex "hints database" "ETRN serialization"
35339 Exim implements the serialization by means of a hints database in which a
35340 record is written whenever a process is started by ETRN, and deleted when
35341 the process completes. However, Exim does not keep the SMTP session waiting for
35342 the ETRN process to complete. Once ETRN is accepted, the client is sent
35343 a &"success"& return code. Obviously there is scope for hints records to get
35344 left lying around if there is a system or program crash. To guard against this,
35345 Exim ignores any records that are more than six hours old.
35346
35347 .oindex "&%smtp_etrn_command%&"
35348 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35349 used. This specifies a command that is run whenever ETRN is received,
35350 whatever the form of its argument. For
35351 example:
35352 .code
35353 smtp_etrn_command = /etc/etrn_command $domain \
35354                     $sender_host_address
35355 .endd
35356 .vindex "&$domain$&"
35357 The string is split up into arguments which are independently expanded. The
35358 expansion variable &$domain$& is set to the argument of the ETRN command,
35359 and no syntax checking is done on the contents of this argument. Exim does not
35360 wait for the command to complete, so its status code is not checked. Exim runs
35361 under its own uid and gid when receiving incoming SMTP, so it is not possible
35362 for it to change them before running the command.
35363
35364
35365
35366 .section "Incoming local SMTP" "SECID238"
35367 .cindex "SMTP" "local incoming"
35368 Some user agents use SMTP to pass messages to their local MTA using the
35369 standard input and output, as opposed to passing the envelope on the command
35370 line and writing the message to the standard input. This is supported by the
35371 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35372 messages over TCP/IP (including the use of ACLs), except that the envelope
35373 sender given in a MAIL command is ignored unless the caller is trusted. In
35374 an ACL you can detect this form of SMTP input by testing for an empty host
35375 identification. It is common to have this as the first line in the ACL that
35376 runs for RCPT commands:
35377 .code
35378 accept hosts = :
35379 .endd
35380 This accepts SMTP messages from local processes without doing any other tests.
35381
35382
35383
35384 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35385 .cindex "SMTP" "batched outgoing"
35386 .cindex "batched SMTP output"
35387 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35388 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35389 be output in BSMTP format. No SMTP responses are possible for this form of
35390 delivery. All it is doing is using SMTP commands as a way of transmitting the
35391 envelope along with the message.
35392
35393 The message is written to the file or pipe preceded by the SMTP commands
35394 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35395 the message that start with a dot have an extra dot added. The SMTP command
35396 HELO is not normally used. If it is required, the &%message_prefix%& option
35397 can be used to specify it.
35398
35399 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35400 one recipient address at a time by default. However, you can arrange for them
35401 to handle several addresses at once by setting the &%batch_max%& option. When
35402 this is done for BSMTP, messages may contain multiple RCPT commands. See
35403 chapter &<<CHAPbatching>>& for more details.
35404
35405 .vindex "&$host$&"
35406 When one or more addresses are routed to a BSMTP transport by a router that
35407 sets up a host list, the name of the first host on the list is available to the
35408 transport in the variable &$host$&. Here is an example of such a transport and
35409 router:
35410 .code
35411 begin routers
35412 route_append:
35413   driver = manualroute
35414   transport = smtp_appendfile
35415   route_list = domain.example  batch.host.example
35416
35417 begin transports
35418 smtp_appendfile:
35419   driver = appendfile
35420   directory = /var/bsmtp/$host
35421   batch_max = 1000
35422   use_bsmtp
35423   user = exim
35424 .endd
35425 This causes messages addressed to &'domain.example'& to be written in BSMTP
35426 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35427 message (unless there are more than 1000 recipients).
35428
35429
35430
35431 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35432 .cindex "SMTP" "batched incoming"
35433 .cindex "batched SMTP input"
35434 The &%-bS%& command line option causes Exim to accept one or more messages by
35435 reading SMTP on the standard input, but to generate no responses. If the caller
35436 is trusted, the senders in the MAIL commands are believed; otherwise the
35437 sender is always the caller of Exim. Unqualified senders and receivers are not
35438 rejected (there seems little point) but instead just get qualified. HELO
35439 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35440 as NOOP; QUIT quits.
35441
35442 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35443 ACL is run in the same way as for non-SMTP local input.
35444
35445 If an error is detected while reading a message, including a missing &"."& at
35446 the end, Exim gives up immediately. It writes details of the error to the
35447 standard output in a stylized way that the calling program should be able to
35448 make some use of automatically, for example:
35449 .code
35450 554 Unexpected end of file
35451 Transaction started in line 10
35452 Error detected in line 14
35453 .endd
35454 It writes a more verbose version, for human consumption, to the standard error
35455 file, for example:
35456 .code
35457 An error was detected while processing a file of BSMTP input.
35458 The error message was:
35459
35460 501 '>' missing at end of address
35461
35462 The SMTP transaction started in line 10.
35463 The error was detected in line 12.
35464 The SMTP command at fault was:
35465
35466 rcpt to:<malformed@in.com.plete
35467
35468 1 previous message was successfully processed.
35469 The rest of the batch was abandoned.
35470 .endd
35471 The return code from Exim is zero only if there were no errors. It is 1 if some
35472 messages were accepted before an error was detected, and 2 if no messages were
35473 accepted.
35474 .ecindex IIDsmtpproc1
35475 .ecindex IIDsmtpproc2
35476
35477
35478
35479 . ////////////////////////////////////////////////////////////////////////////
35480 . ////////////////////////////////////////////////////////////////////////////
35481
35482 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35483          "Customizing messages"
35484 When a message fails to be delivered, or remains on the queue for more than a
35485 configured amount of time, Exim sends a message to the original sender, or
35486 to an alternative configured address. The text of these messages is built into
35487 the code of Exim, but it is possible to change it, either by adding a single
35488 string, or by replacing each of the paragraphs by text supplied in a file.
35489
35490 The &'From:'& and &'To:'& header lines are automatically generated; you can
35491 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
35492 option. Exim also adds the line
35493 .code
35494 Auto-Submitted: auto-generated
35495 .endd
35496 to all warning and bounce messages,
35497
35498
35499 .section "Customizing bounce messages" "SECID239"
35500 .cindex "customizing" "bounce message"
35501 .cindex "bounce message" "customizing"
35502 If &%bounce_message_text%& is set, its contents are included in the default
35503 message immediately after &"This message was created automatically by mail
35504 delivery software."& The string is not expanded. It is not used if
35505 &%bounce_message_file%& is set.
35506
35507 When &%bounce_message_file%& is set, it must point to a template file for
35508 constructing error messages. The file consists of a series of text items,
35509 separated by lines consisting of exactly four asterisks. If the file cannot be
35510 opened, default text is used and a message is written to the main and panic
35511 logs. If any text item in the file is empty, default text is used for that
35512 item.
35513
35514 .vindex "&$bounce_recipient$&"
35515 .vindex "&$bounce_return_size_limit$&"
35516 Each item of text that is read from the file is expanded, and there are two
35517 expansion variables which can be of use here: &$bounce_recipient$& is set to
35518 the recipient of an error message while it is being created, and
35519 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
35520 option, rounded to a whole number.
35521
35522 The items must appear in the file in the following order:
35523
35524 .ilist
35525 The first item is included in the headers, and should include at least a
35526 &'Subject:'& header. Exim does not check the syntax of these headers.
35527 .next
35528 The second item forms the start of the error message. After it, Exim lists the
35529 failing addresses with their error messages.
35530 .next
35531 The third item is used to introduce any text from pipe transports that is to be
35532 returned to the sender. It is omitted if there is no such text.
35533 .next
35534 The fourth, fifth and sixth items will be ignored and may be empty.
35535 The fields exist for back-compatibility
35536 .endlist
35537
35538 The default state (&%bounce_message_file%& unset) is equivalent to the
35539 following file, in which the sixth item is empty. The &'Subject:'& and some
35540 other lines have been split in order to fit them on the page:
35541 .code
35542 Subject: Mail delivery failed
35543   ${if eq{$sender_address}{$bounce_recipient}
35544   {: returning message to sender}}
35545 ****
35546 This message was created automatically by mail delivery software.
35547
35548 A message ${if eq{$sender_address}{$bounce_recipient}
35549   {that you sent }{sent by
35550
35551 <$sender_address>
35552
35553 }}could not be delivered to all of its recipients.
35554 This is a permanent error. The following address(es) failed:
35555 ****
35556 The following text was generated during the delivery attempt(s):
35557 ****
35558 ------ This is a copy of the message, including all the headers.
35559   ------
35560 ****
35561 ------ The body of the message is $message_size characters long;
35562   only the first
35563 ------ $bounce_return_size_limit or so are included here.
35564 ****
35565 .endd
35566 .section "Customizing warning messages" "SECTcustwarn"
35567 .cindex "customizing" "warning message"
35568 .cindex "warning of delay" "customizing the message"
35569 The option &%warn_message_file%& can be pointed at a template file for use when
35570 warnings about message delays are created. In this case there are only three
35571 text sections:
35572
35573 .ilist
35574 The first item is included in the headers, and should include at least a
35575 &'Subject:'& header. Exim does not check the syntax of these headers.
35576 .next
35577 The second item forms the start of the warning message. After it, Exim lists
35578 the delayed addresses.
35579 .next
35580 The third item then ends the message.
35581 .endlist
35582
35583 The default state is equivalent to the following file, except that some lines
35584 have been split here, in order to fit them on the page:
35585 .code
35586 Subject: Warning: message $message_exim_id delayed
35587   $warn_message_delay
35588 ****
35589 This message was created automatically by mail delivery software.
35590
35591 A message ${if eq{$sender_address}{$warn_message_recipients}
35592 {that you sent }{sent by
35593
35594 <$sender_address>
35595
35596 }}has not been delivered to all of its recipients after
35597 more than $warn_message_delay on the queue on $primary_hostname.
35598
35599 The message identifier is:     $message_exim_id
35600 The subject of the message is: $h_subject
35601 The date of the message is:    $h_date
35602
35603 The following address(es) have not yet been delivered:
35604 ****
35605 No action is required on your part. Delivery attempts will
35606 continue for some time, and this warning may be repeated at
35607 intervals if the message remains undelivered. Eventually the
35608 mail delivery software will give up, and when that happens,
35609 the message will be returned to you.
35610 .endd
35611 .vindex "&$warn_message_delay$&"
35612 .vindex "&$warn_message_recipients$&"
35613 However, in the default state the subject and date lines are omitted if no
35614 appropriate headers exist. During the expansion of this file,
35615 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
35616 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
35617 of recipients for the warning message. There may be more than one if there are
35618 multiple addresses with different &%errors_to%& settings on the routers that
35619 handled them.
35620
35621
35622
35623
35624 . ////////////////////////////////////////////////////////////////////////////
35625 . ////////////////////////////////////////////////////////////////////////////
35626
35627 .chapter "Some common configuration settings" "CHAPcomconreq"
35628 This chapter discusses some configuration settings that seem to be fairly
35629 common. More examples and discussion can be found in the Exim book.
35630
35631
35632
35633 .section "Sending mail to a smart host" "SECID240"
35634 .cindex "smart host" "example router"
35635 If you want to send all mail for non-local domains to a &"smart host"&, you
35636 should replace the default &(dnslookup)& router with a router which does the
35637 routing explicitly:
35638 .code
35639 send_to_smart_host:
35640   driver = manualroute
35641   route_list = !+local_domains smart.host.name
35642   transport = remote_smtp
35643 .endd
35644 You can use the smart host's IP address instead of the name if you wish.
35645 If you are using Exim only to submit messages to a smart host, and not for
35646 receiving incoming messages, you can arrange for it to do the submission
35647 synchronously by setting the &%mua_wrapper%& option (see chapter
35648 &<<CHAPnonqueueing>>&).
35649
35650
35651
35652
35653 .section "Using Exim to handle mailing lists" "SECTmailinglists"
35654 .cindex "mailing lists"
35655 Exim can be used to run simple mailing lists, but for large and/or complicated
35656 requirements, the use of additional specialized mailing list software such as
35657 Majordomo or Mailman is recommended.
35658
35659 The &(redirect)& router can be used to handle mailing lists where each list
35660 is maintained in a separate file, which can therefore be managed by an
35661 independent manager. The &%domains%& router option can be used to run these
35662 lists in a separate domain from normal mail. For example:
35663 .code
35664 lists:
35665   driver = redirect
35666   domains = lists.example
35667   file = /usr/lists/$local_part
35668   forbid_pipe
35669   forbid_file
35670   errors_to = $local_part-request@lists.example
35671   no_more
35672 .endd
35673 This router is skipped for domains other than &'lists.example'&. For addresses
35674 in that domain, it looks for a file that matches the local part. If there is no
35675 such file, the router declines, but because &%no_more%& is set, no subsequent
35676 routers are tried, and so the whole delivery fails.
35677
35678 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
35679 expanded into a file name or a pipe delivery, which is usually inappropriate in
35680 a mailing list.
35681
35682 .oindex "&%errors_to%&"
35683 The &%errors_to%& option specifies that any delivery errors caused by addresses
35684 taken from a mailing list are to be sent to the given address rather than the
35685 original sender of the message. However, before acting on this, Exim verifies
35686 the error address, and ignores it if verification fails.
35687
35688 For example, using the configuration above, mail sent to
35689 &'dicts@lists.example'& is passed on to those addresses contained in
35690 &_/usr/lists/dicts_&, with error reports directed to
35691 &'dicts-request@lists.example'&, provided that this address can be verified.
35692 There could be a file called &_/usr/lists/dicts-request_& containing
35693 the address(es) of this particular list's manager(s), but other approaches,
35694 such as setting up an earlier router (possibly using the &%local_part_prefix%&
35695 or &%local_part_suffix%& options) to handle addresses of the form
35696 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
35697
35698
35699
35700 .section "Syntax errors in mailing lists" "SECID241"
35701 .cindex "mailing lists" "syntax errors in"
35702 If an entry in redirection data contains a syntax error, Exim normally defers
35703 delivery of the original address. That means that a syntax error in a mailing
35704 list holds up all deliveries to the list. This may not be appropriate when a
35705 list is being maintained automatically from data supplied by users, and the
35706 addresses are not rigorously checked.
35707
35708 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
35709 entries that fail to parse, noting the incident in the log. If in addition
35710 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
35711 whenever a broken address is skipped. It is usually appropriate to set
35712 &%syntax_errors_to%& to the same address as &%errors_to%&.
35713
35714
35715
35716 .section "Re-expansion of mailing lists" "SECID242"
35717 .cindex "mailing lists" "re-expansion of"
35718 Exim remembers every individual address to which a message has been delivered,
35719 in order to avoid duplication, but it normally stores only the original
35720 recipient addresses with a message. If all the deliveries to a mailing list
35721 cannot be done at the first attempt, the mailing list is re-expanded when the
35722 delivery is next tried. This means that alterations to the list are taken into
35723 account at each delivery attempt, so addresses that have been added to
35724 the list since the message arrived will therefore receive a copy of the
35725 message, even though it pre-dates their subscription.
35726
35727 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
35728 on the &(redirect)& router. If this is done, any addresses generated by the
35729 router that fail to deliver at the first attempt are added to the message as
35730 &"top level"& addresses, and the parent address that generated them is marked
35731 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
35732 subsequent delivery attempts. The disadvantage of this is that if any of the
35733 failing addresses are incorrect, correcting them in the file has no effect on
35734 pre-existing messages.
35735
35736 The original top-level address is remembered with each of the generated
35737 addresses, and is output in any log messages. However, any intermediate parent
35738 addresses are not recorded. This makes a difference to the log only if the
35739 &%all_parents%& selector is set, but for mailing lists there is normally only
35740 one level of expansion anyway.
35741
35742
35743
35744 .section "Closed mailing lists" "SECID243"
35745 .cindex "mailing lists" "closed"
35746 The examples so far have assumed open mailing lists, to which anybody may
35747 send mail. It is also possible to set up closed lists, where mail is accepted
35748 from specified senders only. This is done by making use of the generic
35749 &%senders%& option to restrict the router that handles the list.
35750
35751 The following example uses the same file as a list of recipients and as a list
35752 of permitted senders. It requires three routers:
35753 .code
35754 lists_request:
35755   driver = redirect
35756   domains = lists.example
35757   local_part_suffix = -request
35758   file = /usr/lists/$local_part$local_part_suffix
35759   no_more
35760
35761 lists_post:
35762   driver = redirect
35763   domains = lists.example
35764   senders = ${if exists {/usr/lists/$local_part}\
35765              {lsearch;/usr/lists/$local_part}{*}}
35766   file = /usr/lists/$local_part
35767   forbid_pipe
35768   forbid_file
35769   errors_to = $local_part-request@lists.example
35770   no_more
35771
35772 lists_closed:
35773   driver = redirect
35774   domains = lists.example
35775   allow_fail
35776   data = :fail: $local_part@lists.example is a closed mailing list
35777 .endd
35778 All three routers have the same &%domains%& setting, so for any other domains,
35779 they are all skipped. The first router runs only if the local part ends in
35780 &%-request%&. It handles messages to the list manager(s) by means of an open
35781 mailing list.
35782
35783 The second router runs only if the &%senders%& precondition is satisfied. It
35784 checks for the existence of a list that corresponds to the local part, and then
35785 checks that the sender is on the list by means of a linear search. It is
35786 necessary to check for the existence of the file before trying to search it,
35787 because otherwise Exim thinks there is a configuration error. If the file does
35788 not exist, the expansion of &%senders%& is *, which matches all senders. This
35789 means that the router runs, but because there is no list, declines, and
35790 &%no_more%& ensures that no further routers are run. The address fails with an
35791 &"unrouteable address"& error.
35792
35793 The third router runs only if the second router is skipped, which happens when
35794 a mailing list exists, but the sender is not on it. This router forcibly fails
35795 the address, giving a suitable error message.
35796
35797
35798
35799
35800 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
35801 .cindex "VERP"
35802 .cindex "Variable Envelope Return Paths"
35803 .cindex "envelope sender"
35804 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
35805 are a way of helping mailing list administrators discover which subscription
35806 address is the cause of a particular delivery failure. The idea is to encode
35807 the original recipient address in the outgoing envelope sender address, so that
35808 if the message is forwarded by another host and then subsequently bounces, the
35809 original recipient can be extracted from the recipient address of the bounce.
35810
35811 .oindex &%errors_to%&
35812 .oindex &%return_path%&
35813 Envelope sender addresses can be modified by Exim using two different
35814 facilities: the &%errors_to%& option on a router (as shown in previous mailing
35815 list examples), or the &%return_path%& option on a transport. The second of
35816 these is effective only if the message is successfully delivered to another
35817 host; it is not used for errors detected on the local host (see the description
35818 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
35819 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
35820 .code
35821 verp_smtp:
35822   driver = smtp
35823   max_rcpt = 1
35824   return_path = \
35825     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35826       {$1-request+$local_part=$domain@your.dom.example}fail}
35827 .endd
35828 This has the effect of rewriting the return path (envelope sender) on outgoing
35829 SMTP messages, if the local part of the original return path ends in
35830 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
35831 local part and domain of the recipient into the return path. Suppose, for
35832 example, that a message whose return path has been set to
35833 &'somelist-request@your.dom.example'& is sent to
35834 &'subscriber@other.dom.example'&. In the transport, the return path is
35835 rewritten as
35836 .code
35837 somelist-request+subscriber=other.dom.example@your.dom.example
35838 .endd
35839 .vindex "&$local_part$&"
35840 For this to work, you must tell Exim to send multiple copies of messages that
35841 have more than one recipient, so that each copy has just one recipient. This is
35842 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
35843 might be sent to several different recipients in the same domain, in which case
35844 &$local_part$& is not available in the transport, because it is not unique.
35845
35846 Unless your host is doing nothing but mailing list deliveries, you should
35847 probably use a separate transport for the VERP deliveries, so as not to use
35848 extra resources in making one-per-recipient copies for other deliveries. This
35849 can easily be done by expanding the &%transport%& option in the router:
35850 .code
35851 dnslookup:
35852   driver = dnslookup
35853   domains = ! +local_domains
35854   transport = \
35855     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35856       {verp_smtp}{remote_smtp}}
35857   no_more
35858 .endd
35859 If you want to change the return path using &%errors_to%& in a router instead
35860 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
35861 routers that handle mailing list addresses. This will ensure that all delivery
35862 errors, including those detected on the local host, are sent to the VERP
35863 address.
35864
35865 On a host that does no local deliveries and has no manual routing, only the
35866 &(dnslookup)& router needs to be changed. A special transport is not needed for
35867 SMTP deliveries. Every mailing list recipient has its own return path value,
35868 and so Exim must hand them to the transport one at a time. Here is an example
35869 of a &(dnslookup)& router that implements VERP:
35870 .code
35871 verp_dnslookup:
35872   driver = dnslookup
35873   domains = ! +local_domains
35874   transport = remote_smtp
35875   errors_to = \
35876     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
35877      {$1-request+$local_part=$domain@your.dom.example}fail}
35878   no_more
35879 .endd
35880 Before you start sending out messages with VERPed return paths, you must also
35881 configure Exim to accept the bounce messages that come back to those paths.
35882 Typically this is done by setting a &%local_part_suffix%& option for a
35883 router, and using this to route the messages to wherever you want to handle
35884 them.
35885
35886 The overhead incurred in using VERP depends very much on the size of the
35887 message, the number of recipient addresses that resolve to the same remote
35888 host, and the speed of the connection over which the message is being sent. If
35889 a lot of addresses resolve to the same host and the connection is slow, sending
35890 a separate copy of the message for each address may take substantially longer
35891 than sending a single copy with many recipients (for which VERP cannot be
35892 used).
35893
35894
35895
35896
35897
35898
35899 .section "Virtual domains" "SECTvirtualdomains"
35900 .cindex "virtual domains"
35901 .cindex "domain" "virtual"
35902 The phrase &'virtual domain'& is unfortunately used with two rather different
35903 meanings:
35904
35905 .ilist
35906 A domain for which there are no real mailboxes; all valid local parts are
35907 aliases for other email addresses. Common examples are organizational
35908 top-level domains and &"vanity"& domains.
35909 .next
35910 One of a number of independent domains that are all handled by the same host,
35911 with mailboxes on that host, but where the mailbox owners do not necessarily
35912 have login accounts on that host.
35913 .endlist
35914
35915 The first usage is probably more common, and does seem more &"virtual"& than
35916 the second. This kind of domain can be handled in Exim with a straightforward
35917 aliasing router. One approach is to create a separate alias file for each
35918 virtual domain. Exim can test for the existence of the alias file to determine
35919 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
35920 to a router of this form:
35921 .code
35922 virtual:
35923   driver = redirect
35924   domains = dsearch;/etc/mail/virtual
35925   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
35926   no_more
35927 .endd
35928 The &%domains%& option specifies that the router is to be skipped, unless there
35929 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
35930 domain that is being processed. When the router runs, it looks up the local
35931 part in the file to find a new address (or list of addresses). The &%no_more%&
35932 setting ensures that if the lookup fails (leading to &%data%& being an empty
35933 string), Exim gives up on the address without trying any subsequent routers.
35934
35935 This one router can handle all the virtual domains because the alias file names
35936 follow a fixed pattern. Permissions can be arranged so that appropriate people
35937 can edit the different alias files. A successful aliasing operation results in
35938 a new envelope recipient address, which is then routed from scratch.
35939
35940 The other kind of &"virtual"& domain can also be handled in a straightforward
35941 way. One approach is to create a file for each domain containing a list of
35942 valid local parts, and use it in a router like this:
35943 .code
35944 my_domains:
35945   driver = accept
35946   domains = dsearch;/etc/mail/domains
35947   local_parts = lsearch;/etc/mail/domains/$domain
35948   transport = my_mailboxes
35949 .endd
35950 The address is accepted if there is a file for the domain, and the local part
35951 can be found in the file. The &%domains%& option is used to check for the
35952 file's existence because &%domains%& is tested before the &%local_parts%&
35953 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35954 because that option is tested after &%local_parts%&. The transport is as
35955 follows:
35956 .code
35957 my_mailboxes:
35958   driver = appendfile
35959   file = /var/mail/$domain/$local_part
35960   user = mail
35961 .endd
35962 This uses a directory of mailboxes for each domain. The &%user%& setting is
35963 required, to specify which uid is to be used for writing to the mailboxes.
35964
35965 The configuration shown here is just one example of how you might support this
35966 requirement. There are many other ways this kind of configuration can be set
35967 up, for example, by using a database instead of separate files to hold all the
35968 information about the domains.
35969
35970
35971
35972 .section "Multiple user mailboxes" "SECTmulbox"
35973 .cindex "multiple mailboxes"
35974 .cindex "mailbox" "multiple"
35975 .cindex "local part" "prefix"
35976 .cindex "local part" "suffix"
35977 Heavy email users often want to operate with multiple mailboxes, into which
35978 incoming mail is automatically sorted. A popular way of handling this is to
35979 allow users to use multiple sender addresses, so that replies can easily be
35980 identified. Users are permitted to add prefixes or suffixes to their local
35981 parts for this purpose. The wildcard facility of the generic router options
35982 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35983 example, consider this router:
35984 .code
35985 userforward:
35986   driver = redirect
35987   check_local_user
35988   file = $home/.forward
35989   local_part_suffix = -*
35990   local_part_suffix_optional
35991   allow_filter
35992 .endd
35993 .vindex "&$local_part_suffix$&"
35994 It runs a user's &_.forward_& file for all local parts of the form
35995 &'username-*'&. Within the filter file the user can distinguish different
35996 cases by testing the variable &$local_part_suffix$&. For example:
35997 .code
35998 if $local_part_suffix contains -special then
35999 save /home/$local_part/Mail/special
36000 endif
36001 .endd
36002 If the filter file does not exist, or does not deal with such addresses, they
36003 fall through to subsequent routers, and, assuming no subsequent use of the
36004 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36005 control over which suffixes are valid.
36006
36007 Alternatively, a suffix can be used to trigger the use of a different
36008 &_.forward_& file &-- which is the way a similar facility is implemented in
36009 another MTA:
36010 .code
36011 userforward:
36012   driver = redirect
36013   check_local_user
36014   file = $home/.forward$local_part_suffix
36015   local_part_suffix = -*
36016   local_part_suffix_optional
36017   allow_filter
36018 .endd
36019 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36020 example, &_.forward-special_& is used. Once again, if the appropriate file
36021 does not exist, or does not deal with the address, it is passed on to
36022 subsequent routers, which could, if required, look for an unqualified
36023 &_.forward_& file to use as a default.
36024
36025
36026
36027 .section "Simplified vacation processing" "SECID244"
36028 .cindex "vacation processing"
36029 The traditional way of running the &'vacation'& program is for a user to set up
36030 a pipe command in a &_.forward_& file
36031 (see section &<<SECTspecitredli>>& for syntax details).
36032 This is prone to error by inexperienced users. There are two features of Exim
36033 that can be used to make this process simpler for users:
36034
36035 .ilist
36036 A local part prefix such as &"vacation-"& can be specified on a router which
36037 can cause the message to be delivered directly to the &'vacation'& program, or
36038 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36039 &_.forward_& file are then much simpler. For example:
36040 .code
36041 spqr, vacation-spqr
36042 .endd
36043 .next
36044 The &%require_files%& generic router option can be used to trigger a
36045 vacation delivery by checking for the existence of a certain file in the
36046 user's home directory. The &%unseen%& generic option should also be used, to
36047 ensure that the original delivery also proceeds. In this case, all the user has
36048 to do is to create a file called, say, &_.vacation_&, containing a vacation
36049 message.
36050 .endlist
36051
36052 Another advantage of both these methods is that they both work even when the
36053 use of arbitrary pipes by users is locked out.
36054
36055
36056
36057 .section "Taking copies of mail" "SECID245"
36058 .cindex "message" "copying every"
36059 Some installations have policies that require archive copies of all messages to
36060 be made. A single copy of each message can easily be taken by an appropriate
36061 command in a system filter, which could, for example, use a different file for
36062 each day's messages.
36063
36064 There is also a shadow transport mechanism that can be used to take copies of
36065 messages that are successfully delivered by local transports, one copy per
36066 delivery. This could be used, &'inter alia'&, to implement automatic
36067 notification of delivery by sites that insist on doing such things.
36068
36069
36070
36071 .section "Intermittently connected hosts" "SECID246"
36072 .cindex "intermittently connected hosts"
36073 It has become quite common (because it is cheaper) for hosts to connect to the
36074 Internet periodically rather than remain connected all the time. The normal
36075 arrangement is that mail for such hosts accumulates on a system that is
36076 permanently connected.
36077
36078 Exim was designed for use on permanently connected hosts, and so it is not
36079 particularly well-suited to use in an intermittently connected environment.
36080 Nevertheless there are some features that can be used.
36081
36082
36083 .section "Exim on the upstream server host" "SECID247"
36084 It is tempting to arrange for incoming mail for the intermittently connected
36085 host to remain on Exim's queue until the client connects. However, this
36086 approach does not scale very well. Two different kinds of waiting message are
36087 being mixed up in the same queue &-- those that cannot be delivered because of
36088 some temporary problem, and those that are waiting for their destination host
36089 to connect. This makes it hard to manage the queue, as well as wasting
36090 resources, because each queue runner scans the entire queue.
36091
36092 A better approach is to separate off those messages that are waiting for an
36093 intermittently connected host. This can be done by delivering these messages
36094 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36095 format, from where they are transmitted by other software when their
36096 destination connects. This makes it easy to collect all the mail for one host
36097 in a single directory, and to apply local timeout rules on a per-message basis
36098 if required.
36099
36100 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36101 you are doing this, you should configure Exim with a long retry period for the
36102 intermittent host. For example:
36103 .code
36104 cheshire.wonderland.fict.example    *   F,5d,24h
36105 .endd
36106 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36107 which messages it has queued up for that host. Once the intermittent host comes
36108 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36109 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36110 causes all the queued up messages to be delivered, often down a single SMTP
36111 connection. While the host remains connected, any new messages get delivered
36112 immediately.
36113
36114 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36115 issued with a different IP address each time it connects, Exim's retry
36116 mechanisms on the holding host get confused, because the IP address is normally
36117 used as part of the key string for holding retry information. This can be
36118 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36119 Since this has disadvantages for permanently connected hosts, it is best to
36120 arrange a separate transport for the intermittently connected ones.
36121
36122
36123
36124 .section "Exim on the intermittently connected client host" "SECID248"
36125 The value of &%smtp_accept_queue_per_connection%& should probably be
36126 increased, or even set to zero (that is, disabled) on the intermittently
36127 connected host, so that all incoming messages down a single connection get
36128 delivered immediately.
36129
36130 .cindex "SMTP" "passed connection"
36131 .cindex "SMTP" "multiple deliveries"
36132 .cindex "multiple SMTP deliveries"
36133 Mail waiting to be sent from an intermittently connected host will probably
36134 not have been routed, because without a connection DNS lookups are not
36135 possible. This means that if a normal queue run is done at connection time,
36136 each message is likely to be sent in a separate SMTP session. This can be
36137 avoided by starting the queue run with a command line option beginning with
36138 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36139 first pass, routing is done but no deliveries take place. The second pass is a
36140 normal queue run; since all the messages have been previously routed, those
36141 destined for the same host are likely to get sent as multiple deliveries in a
36142 single SMTP connection.
36143
36144
36145
36146 . ////////////////////////////////////////////////////////////////////////////
36147 . ////////////////////////////////////////////////////////////////////////////
36148
36149 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36150          "Exim as a non-queueing client"
36151 .cindex "client, non-queueing"
36152 .cindex "smart host" "suppressing queueing"
36153 On a personal computer, it is a common requirement for all
36154 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36155 configured to operate that way, for all the popular operating systems.
36156 However, there are some MUAs for Unix-like systems that cannot be so
36157 configured: they submit messages using the command line interface of
36158 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36159 messages this way.
36160
36161 If the personal computer runs continuously, there is no problem, because it can
36162 run a conventional MTA that handles delivery to the smart host, and deal with
36163 any delays via its queueing mechanism. However, if the computer does not run
36164 continuously or runs different operating systems at different times, queueing
36165 email is not desirable.
36166
36167 There is therefore a requirement for something that can provide the
36168 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36169 any queueing or retrying facilities. Furthermore, the delivery to the smart
36170 host should be synchronous, so that if it fails, the sending MUA is immediately
36171 informed. In other words, we want something that extends an MUA that submits
36172 to a local MTA via the command line so that it behaves like one that submits
36173 to a remote smart host using TCP/SMTP.
36174
36175 There are a number of applications (for example, there is one called &'ssmtp'&)
36176 that do this job. However, people have found them to be lacking in various
36177 ways. For instance, you might want to allow aliasing and forwarding to be done
36178 before sending a message to the smart host.
36179
36180 Exim already had the necessary infrastructure for doing this job. Just a few
36181 tweaks were needed to make it behave as required, though it is somewhat of an
36182 overkill to use a fully-featured MTA for this purpose.
36183
36184 .oindex "&%mua_wrapper%&"
36185 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36186 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36187 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36188 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36189 compatible router and transport configuration. Typically there will be just one
36190 router and one transport, sending everything to a smart host.
36191
36192 When run in MUA wrapping mode, the behaviour of Exim changes in the
36193 following ways:
36194
36195 .ilist
36196 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36197 In other words, the only way to submit messages is via the command line.
36198 .next
36199 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36200 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36201 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36202 does not finish until the delivery attempt is complete. If the delivery is
36203 successful, a zero return code is given.
36204 .next
36205 Address redirection is permitted, but the final routing for all addresses must
36206 be to the same remote transport, and to the same list of hosts. Furthermore,
36207 the return address (envelope sender) must be the same for all recipients, as
36208 must any added or deleted header lines. In other words, it must be possible to
36209 deliver the message in a single SMTP transaction, however many recipients there
36210 are.
36211 .next
36212 If these conditions are not met, or if routing any address results in a
36213 failure or defer status, or if Exim is unable to deliver all the recipients
36214 successfully to one of the smart hosts, delivery of the entire message fails.
36215 .next
36216 Because no queueing is allowed, all failures are treated as permanent; there
36217 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36218 smart host. Furthermore, because only a single yes/no response can be given to
36219 the caller, it is not possible to deliver to some recipients and not others. If
36220 there is an error (temporary or permanent) for any recipient, all are failed.
36221 .next
36222 If more than one smart host is listed, Exim will try another host after a
36223 connection failure or a timeout, in the normal way. However, if this kind of
36224 failure happens for all the hosts, the delivery fails.
36225 .next
36226 When delivery fails, an error message is written to the standard error stream
36227 (as well as to Exim's log), and Exim exits to the caller with a return code
36228 value 1. The message is expunged from Exim's spool files. No bounce messages
36229 are ever generated.
36230 .next
36231 No retry data is maintained, and any retry rules are ignored.
36232 .next
36233 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36234 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36235 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36236 .endlist
36237
36238 The overall effect is that Exim makes a single synchronous attempt to deliver
36239 the message, failing if there is any kind of problem. Because no local
36240 deliveries are done and no daemon can be run, Exim does not need root
36241 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36242 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36243 the advantages and disadvantages of running without root privilege.
36244
36245
36246
36247
36248 . ////////////////////////////////////////////////////////////////////////////
36249 . ////////////////////////////////////////////////////////////////////////////
36250
36251 .chapter "Log files" "CHAPlog"
36252 .scindex IIDloggen "log" "general description"
36253 .cindex "log" "types of"
36254 Exim writes three different logs, referred to as the main log, the reject log,
36255 and the panic log:
36256
36257 .ilist
36258 .cindex "main log"
36259 The main log records the arrival of each message and each delivery in a single
36260 line in each case. The format is as compact as possible, in an attempt to keep
36261 down the size of log files. Two-character flag sequences make it easy to pick
36262 out these lines. A number of other events are recorded in the main log. Some of
36263 them are optional, in which case the &%log_selector%& option controls whether
36264 they are included or not. A Perl script called &'eximstats'&, which does simple
36265 analysis of main log files, is provided in the Exim distribution (see section
36266 &<<SECTmailstat>>&).
36267 .next
36268 .cindex "reject log"
36269 The reject log records information from messages that are rejected as a result
36270 of a configuration option (that is, for policy reasons).
36271 The first line of each rejection is a copy of the line that is also written to
36272 the main log. Then, if the message's header has been read at the time the log
36273 is written, its contents are written to this log. Only the original header
36274 lines are available; header lines added by ACLs are not logged. You can use the
36275 reject log to check that your policy controls are working correctly; on a busy
36276 host this may be easier than scanning the main log for rejection messages. You
36277 can suppress the writing of the reject log by setting &%write_rejectlog%&
36278 false.
36279 .next
36280 .cindex "panic log"
36281 .cindex "system log"
36282 When certain serious errors occur, Exim writes entries to its panic log. If the
36283 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36284 are usually written to the main log as well, but can get lost amid the mass of
36285 other entries. The panic log should be empty under normal circumstances. It is
36286 therefore a good idea to check it (or to have a &'cron'& script check it)
36287 regularly, in order to become aware of any problems. When Exim cannot open its
36288 panic log, it tries as a last resort to write to the system log (syslog). This
36289 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36290 message itself is written at priority LOG_CRIT.
36291 .endlist
36292
36293 Every log line starts with a timestamp, in the format shown in the following
36294 example. Note that many of the examples shown in this chapter are line-wrapped.
36295 In the log file, this would be all on one line:
36296 .code
36297 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36298   by QUIT
36299 .endd
36300 By default, the timestamps are in the local timezone. There are two
36301 ways of changing this:
36302
36303 .ilist
36304 You can set the &%timezone%& option to a different time zone; in particular, if
36305 you set
36306 .code
36307 timezone = UTC
36308 .endd
36309 the timestamps will be in UTC (aka GMT).
36310 .next
36311 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36312 example:
36313 .code
36314 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36315 .endd
36316 .endlist
36317
36318 .cindex "log" "process ids in"
36319 .cindex "pid (process id)" "in log lines"
36320 Exim does not include its process id in log lines by default, but you can
36321 request that it does so by specifying the &`pid`& log selector (see section
36322 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36323 brackets, immediately after the time and date.
36324
36325
36326
36327
36328 .section "Where the logs are written" "SECTwhelogwri"
36329 .cindex "log" "destination"
36330 .cindex "log" "to file"
36331 .cindex "log" "to syslog"
36332 .cindex "syslog"
36333 The logs may be written to local files, or to syslog, or both. However, it
36334 should be noted that many syslog implementations use UDP as a transport, and
36335 are therefore unreliable in the sense that messages are not guaranteed to
36336 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36337 It has also been reported that on large log files (tens of megabytes) you may
36338 need to tweak syslog to prevent it syncing the file with each write &-- on
36339 Linux this has been seen to make syslog take 90% plus of CPU time.
36340
36341 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36342 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
36343 configuration. This latter string is expanded, so it can contain, for example,
36344 references to the host name:
36345 .code
36346 log_file_path = /var/log/$primary_hostname/exim_%slog
36347 .endd
36348 It is generally advisable, however, to set the string in &_Local/Makefile_&
36349 rather than at run time, because then the setting is available right from the
36350 start of Exim's execution. Otherwise, if there's something it wants to log
36351 before it has read the configuration file (for example, an error in the
36352 configuration file) it will not use the path you want, and may not be able to
36353 log at all.
36354
36355 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36356 list, currently limited to at most two items. This is one option where the
36357 facility for changing a list separator may not be used. The list must always be
36358 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36359 otherwise the item must either be an absolute path, containing &`%s`& at the
36360 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36361 implying the use of a default path.
36362
36363 When Exim encounters an empty item in the list, it searches the list defined by
36364 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36365 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36366 mean &"use the path specified at build time"&. It no such item exists, log
36367 files are written in the &_log_& subdirectory of the spool directory. This is
36368 equivalent to the setting:
36369 .code
36370 log_file_path = $spool_directory/log/%slog
36371 .endd
36372 If you do not specify anything at build time or run time,
36373 or if you unset the option at run time (i.e. &`log_file_path = `&),
36374 that is where the logs are written.
36375
36376 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
36377 are in use &-- see section &<<SECTdatlogfil>>& below.
36378
36379 Here are some examples of possible settings:
36380 .display
36381 &`LOG_FILE_PATH=syslog                    `& syslog only
36382 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36383 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36384 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36385 .endd
36386 If there are more than two paths in the list, the first is used and a panic
36387 error is logged.
36388
36389
36390
36391 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36392 .cindex "log" "cycling local files"
36393 .cindex "cycling logs"
36394 .cindex "&'exicyclog'&"
36395 .cindex "log" "local files; writing to"
36396 Some operating systems provide centralized and standardized methods for cycling
36397 log files. For those that do not, a utility script called &'exicyclog'& is
36398 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36399 main and reject logs each time it is called. The maximum number of old logs to
36400 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36401
36402 An Exim delivery process opens the main log when it first needs to write to it,
36403 and it keeps the file open in case subsequent entries are required &-- for
36404 example, if a number of different deliveries are being done for the same
36405 message. However, remote SMTP deliveries can take a long time, and this means
36406 that the file may be kept open long after it is renamed if &'exicyclog'& or
36407 something similar is being used to rename log files on a regular basis. To
36408 ensure that a switch of log files is noticed as soon as possible, Exim calls
36409 &[stat()]& on the main log's name before reusing an open file, and if the file
36410 does not exist, or its inode has changed, the old file is closed and Exim
36411 tries to open the main log from scratch. Thus, an old log file may remain open
36412 for quite some time, but no Exim processes should write to it once it has been
36413 renamed.
36414
36415
36416
36417 .section "Datestamped log files" "SECTdatlogfil"
36418 .cindex "log" "datestamped files"
36419 Instead of cycling the main and reject log files by renaming them
36420 periodically, some sites like to use files whose names contain a datestamp,
36421 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36422 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36423 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36424 point where the datestamp is required. For example:
36425 .code
36426 log_file_path = /var/spool/exim/log/%slog-%D
36427 log_file_path = /var/log/exim-%s-%D.log
36428 log_file_path = /var/spool/exim/log/%D-%slog
36429 log_file_path = /var/log/exim/%s.%M
36430 .endd
36431 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36432 examples of names generated by the above examples:
36433 .code
36434 /var/spool/exim/log/mainlog-20021225
36435 /var/log/exim-reject-20021225.log
36436 /var/spool/exim/log/20021225-mainlog
36437 /var/log/exim/main.200212
36438 .endd
36439 When this form of log file is specified, Exim automatically switches to new
36440 files at midnight. It does not make any attempt to compress old logs; you
36441 will need to write your own script if you require this. You should not
36442 run &'exicyclog'& with this form of logging.
36443
36444 The location of the panic log is also determined by &%log_file_path%&, but it
36445 is not datestamped, because rotation of the panic log does not make sense.
36446 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36447 the string. In addition, if it immediately follows a slash, a following
36448 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36449 character is removed. Thus, the four examples above would give these panic
36450 log names:
36451 .code
36452 /var/spool/exim/log/paniclog
36453 /var/log/exim-panic.log
36454 /var/spool/exim/log/paniclog
36455 /var/log/exim/panic
36456 .endd
36457
36458
36459 .section "Logging to syslog" "SECID249"
36460 .cindex "log" "syslog; writing to"
36461 The use of syslog does not change what Exim logs or the format of its messages,
36462 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36463 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36464 that, the same strings are written to syslog as to log files. The syslog
36465 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36466 by default, but you can change these by setting the &%syslog_facility%& and
36467 &%syslog_processname%& options, respectively. If Exim was compiled with
36468 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36469 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36470 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36471 the time and host name to each line.
36472 The three log streams are mapped onto syslog priorities as follows:
36473
36474 .ilist
36475 &'mainlog'& is mapped to LOG_INFO
36476 .next
36477 &'rejectlog'& is mapped to LOG_NOTICE
36478 .next
36479 &'paniclog'& is mapped to LOG_ALERT
36480 .endlist
36481
36482 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36483 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36484 these are routed by syslog to the same place. You can suppress this duplication
36485 by setting &%syslog_duplication%& false.
36486
36487 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36488 entries contain multiple lines when headers are included. To cope with both
36489 these cases, entries written to syslog are split into separate &[syslog()]&
36490 calls at each internal newline, and also after a maximum of
36491 870 data characters. (This allows for a total syslog line length of 1024, when
36492 additions such as timestamps are added.) If you are running a syslog
36493 replacement that can handle lines longer than the 1024 characters allowed by
36494 RFC 3164, you should set
36495 .code
36496 SYSLOG_LONG_LINES=yes
36497 .endd
36498 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
36499 lines, but it still splits at internal newlines in &'reject'& log entries.
36500
36501 To make it easy to re-assemble split lines later, each component of a split
36502 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
36503 where <&'n'&> is the component number and <&'m'&> is the total number of
36504 components in the entry. The / delimiter is used when the line was split
36505 because it was too long; if it was split because of an internal newline, the \
36506 delimiter is used. For example, supposing the length limit to be 50 instead of
36507 870, the following would be the result of a typical rejection message to
36508 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
36509 name, and pid as added by syslog:
36510 .code
36511 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
36512 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
36513 [3/5]  when scanning for sender: missing or malformed lo
36514 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
36515 [5/5] mple>)
36516 .endd
36517 The same error might cause the following lines to be written to &"rejectlog"&
36518 (LOG_NOTICE):
36519 .code
36520 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
36521 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
36522 [3/18] er when scanning for sender: missing or malformed
36523 [4/18]  local part in "<>" (envelope sender is <ph10@cam
36524 [5\18] .example>)
36525 [6\18] Recipients: ph10@some.domain.cam.example
36526 [7\18] P Received: from [127.0.0.1] (ident=ph10)
36527 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
36528 [9\18]        id 16RdAL-0006pc-00
36529 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
36530 [11\18] 09:43 +0100
36531 [12\18] F From: <>
36532 [13\18]   Subject: this is a test header
36533 [18\18]   X-something: this is another header
36534 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
36535 [16\18] le>
36536 [17\18] B Bcc:
36537 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
36538 .endd
36539 Log lines that are neither too long nor contain newlines are written to syslog
36540 without modification.
36541
36542 If only syslog is being used, the Exim monitor is unable to provide a log tail
36543 display, unless syslog is routing &'mainlog'& to a file on the local host and
36544 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
36545 where it is.
36546
36547
36548
36549 .section "Log line flags" "SECID250"
36550 One line is written to the main log for each message received, and for each
36551 successful, unsuccessful, and delayed delivery. These lines can readily be
36552 picked out by the distinctive two-character flags that immediately follow the
36553 timestamp. The flags are:
36554 .display
36555 &`<=`&     message arrival
36556 &`(=`&     message fakereject
36557 &`=>`&     normal message delivery
36558 &`->`&     additional address in same delivery
36559 &`>>`&     cutthrough message delivery
36560 &`*>`&     delivery suppressed by &%-N%&
36561 &`**`&     delivery failed; address bounced
36562 &`==`&     delivery deferred; temporary problem
36563 .endd
36564
36565
36566 .section "Logging message reception" "SECID251"
36567 .cindex "log" "reception line"
36568 The format of the single-line entry in the main log that is written for every
36569 message received is shown in the basic example below, which is split over
36570 several lines in order to fit it on the page:
36571 .code
36572 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
36573   H=mailer.fict.example [192.168.123.123] U=exim
36574   P=smtp S=5678 id=<incoming message id>
36575 .endd
36576 The address immediately following &"<="& is the envelope sender address. A
36577 bounce message is shown with the sender address &"<>"&, and if it is locally
36578 generated, this is followed by an item of the form
36579 .code
36580 R=<message id>
36581 .endd
36582 which is a reference to the message that caused the bounce to be sent.
36583
36584 .cindex "HELO"
36585 .cindex "EHLO"
36586 For messages from other hosts, the H and U fields identify the remote host and
36587 record the RFC 1413 identity of the user that sent the message, if one was
36588 received. The number given in square brackets is the IP address of the sending
36589 host. If there is a single, unparenthesized  host name in the H field, as
36590 above, it has been verified to correspond to the IP address (see the
36591 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
36592 by the remote host in the SMTP HELO or EHLO command, and has not been
36593 verified. If verification yields a different name to that given for HELO or
36594 EHLO, the verified name appears first, followed by the HELO or EHLO
36595 name in parentheses.
36596
36597 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
36598 without brackets, in the HELO or EHLO command, leading to entries in
36599 the log containing text like these examples:
36600 .code
36601 H=(10.21.32.43) [192.168.8.34]
36602 H=([10.21.32.43]) [192.168.8.34]
36603 .endd
36604 This can be confusing. Only the final address in square brackets can be relied
36605 on.
36606
36607 For locally generated messages (that is, messages not received over TCP/IP),
36608 the H field is omitted, and the U field contains the login name of the caller
36609 of Exim.
36610
36611 .cindex "authentication" "logging"
36612 .cindex "AUTH" "logging"
36613 For all messages, the P field specifies the protocol used to receive the
36614 message. This is the value that is stored in &$received_protocol$&. In the case
36615 of incoming SMTP messages, the value indicates whether or not any SMTP
36616 extensions (ESMTP), encryption, or authentication were used. If the SMTP
36617 session was encrypted, there is an additional X field that records the cipher
36618 suite that was used.
36619
36620 .cindex log protocol
36621 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
36622 hosts that have authenticated themselves using the SMTP AUTH command. The first
36623 value is used when the SMTP connection was encrypted (&"secure"&). In this case
36624 there is an additional item A= followed by the name of the authenticator that
36625 was used. If an authenticated identification was set up by the authenticator's
36626 &%server_set_id%& option, this is logged too, separated by a colon from the
36627 authenticator name.
36628
36629 .cindex "size" "of message"
36630 The id field records the existing message id, if present. The size of the
36631 received message is given by the S field. When the message is delivered,
36632 headers may be removed or added, so that the size of delivered copies of the
36633 message may not correspond with this value (and indeed may be different to each
36634 other).
36635
36636 The &%log_selector%& option can be used to request the logging of additional
36637 data when a message is received. See section &<<SECTlogselector>>& below.
36638
36639
36640
36641 .section "Logging deliveries" "SECID252"
36642 .cindex "log" "delivery line"
36643 The format of the single-line entry in the main log that is written for every
36644 delivery is shown in one of the examples below, for local and remote
36645 deliveries, respectively. Each example has been split into multiple lines in order
36646 to fit it on the page:
36647 .code
36648 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
36649   <marv@hitch.fict.example> R=localuser T=local_delivery
36650 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
36651   monk@holistic.fict.example R=dnslookup T=remote_smtp
36652   H=holistic.fict.example [192.168.234.234]
36653 .endd
36654 For ordinary local deliveries, the original address is given in angle brackets
36655 after the final delivery address, which might be a pipe or a file. If
36656 intermediate address(es) exist between the original and the final address, the
36657 last of these is given in parentheses after the final address. The R and T
36658 fields record the router and transport that were used to process the address.
36659
36660 If SMTP AUTH was used for the delivery there is an additional item A=
36661 followed by the name of the authenticator that was used.
36662 If an authenticated identification was set up by the authenticator's &%client_set_id%&
36663 option, this is logged too, separated by a colon from the authenticator name.
36664
36665 If a shadow transport was run after a successful local delivery, the log line
36666 for the successful delivery has an item added on the end, of the form
36667 .display
36668 &`ST=<`&&'shadow transport name'&&`>`&
36669 .endd
36670 If the shadow transport did not succeed, the error message is put in
36671 parentheses afterwards.
36672
36673 .cindex "asterisk" "after IP address"
36674 When more than one address is included in a single delivery (for example, two
36675 SMTP RCPT commands in one transaction) the second and subsequent addresses are
36676 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
36677 down a single SMTP connection, an asterisk follows the IP address in the log
36678 lines for the second and subsequent messages.
36679 When two or more messages are delivered down a single TLS connection, the
36680 DNS and some TLS-related information logged for the first message delivered
36681 will not be present in the log lines for the second and subsequent messages.
36682 TLS cipher information is still available.
36683
36684 .cindex "delivery" "cutthrough; logging"
36685 .cindex "cutthrough" "logging"
36686 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
36687 line precedes the reception line, since cutthrough waits for a possible
36688 rejection from the destination in case it can reject the sourced item.
36689
36690 The generation of a reply message by a filter file gets logged as a
36691 &"delivery"& to the addressee, preceded by &">"&.
36692
36693 The &%log_selector%& option can be used to request the logging of additional
36694 data when a message is delivered. See section &<<SECTlogselector>>& below.
36695
36696
36697 .section "Discarded deliveries" "SECID253"
36698 .cindex "discarded messages"
36699 .cindex "message" "discarded"
36700 .cindex "delivery" "discarded; logging"
36701 When a message is discarded as a result of the command &"seen finish"& being
36702 obeyed in a filter file which generates no deliveries, a log entry of the form
36703 .code
36704 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
36705   <low.club@bridge.example> R=userforward
36706 .endd
36707 is written, to record why no deliveries are logged. When a message is discarded
36708 because it is aliased to &":blackhole:"& the log line is like this:
36709 .code
36710 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
36711   <hole@nowhere.example> R=blackhole_router
36712 .endd
36713
36714
36715 .section "Deferred deliveries" "SECID254"
36716 When a delivery is deferred, a line of the following form is logged:
36717 .code
36718 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
36719   R=dnslookup T=smtp defer (146): Connection refused
36720 .endd
36721 In the case of remote deliveries, the error is the one that was given for the
36722 last IP address that was tried. Details of individual SMTP failures are also
36723 written to the log, so the above line would be preceded by something like
36724 .code
36725 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
36726   mail1.endrest.example [192.168.239.239]: Connection refused
36727 .endd
36728 When a deferred address is skipped because its retry time has not been reached,
36729 a message is written to the log, but this can be suppressed by setting an
36730 appropriate value in &%log_selector%&.
36731
36732
36733
36734 .section "Delivery failures" "SECID255"
36735 .cindex "delivery" "failure; logging"
36736 If a delivery fails because an address cannot be routed, a line of the
36737 following form is logged:
36738 .code
36739 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
36740   <jim@trek99.example>: unknown mail domain
36741 .endd
36742 If a delivery fails at transport time, the router and transport are shown, and
36743 the response from the remote host is included, as in this example:
36744 .code
36745 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
36746   R=dnslookup T=remote_smtp: SMTP error from remote mailer
36747   after pipelined RCPT TO:<ace400@pb.example>: host
36748   pbmail3.py.example [192.168.63.111]: 553 5.3.0
36749   <ace400@pb.example>...Addressee unknown
36750 .endd
36751 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
36752 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
36753 disabling PIPELINING. The log lines for all forms of delivery failure are
36754 flagged with &`**`&.
36755
36756
36757
36758 .section "Fake deliveries" "SECID256"
36759 .cindex "delivery" "fake; logging"
36760 If a delivery does not actually take place because the &%-N%& option has been
36761 used to suppress it, a normal delivery line is written to the log, except that
36762 &"=>"& is replaced by &"*>"&.
36763
36764
36765
36766 .section "Completion" "SECID257"
36767 A line of the form
36768 .code
36769 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
36770 .endd
36771 is written to the main log when a message is about to be removed from the spool
36772 at the end of its processing.
36773
36774
36775
36776
36777 .section "Summary of Fields in Log Lines" "SECID258"
36778 .cindex "log" "summary of fields"
36779 A summary of the field identifiers that are used in log lines is shown in
36780 the following table:
36781 .display
36782 &`A   `&        authenticator name (and optional id and sender)
36783 &`C   `&        SMTP confirmation on delivery
36784 &`    `&        command list for &"no mail in SMTP session"&
36785 &`CV  `&        certificate verification status
36786 &`D   `&        duration of &"no mail in SMTP session"&
36787 &`DKIM`&        domain verified in incoming message
36788 &`DN  `&        distinguished name from peer certificate
36789 &`DS  `&        DNSSEC secured lookups
36790 &`DT  `&        on &`=>`& lines: time taken for a delivery
36791 &`F   `&        sender address (on delivery lines)
36792 &`H   `&        host name and IP address
36793 &`I   `&        local interface used
36794 &`id  `&        message id for incoming message
36795 &`K   `&        CHUNKING extension used
36796 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
36797 &`M8S `&        8BITMIME status for incoming message
36798 &`P   `&        on &`<=`& lines: protocol used
36799 &`    `&        on &`=>`& and &`**`& lines: return path
36800 &`PRDR`&        PRDR extension used
36801 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
36802 &`Q   `&        alternate queue name
36803 &`QT  `&        on &`=>`& lines: time spent on queue so far
36804 &`    `&        on &"Completed"& lines: time spent on queue
36805 &`R   `&        on &`<=`& lines: reference for local bounce
36806 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
36807 &`RT  `&        on &`<=`& lines: time taken for reception
36808 &`S   `&        size of message in bytes
36809 &`SNI `&        server name indication from TLS client hello
36810 &`ST  `&        shadow transport name
36811 &`T   `&        on &`<=`& lines: message subject (topic)
36812 &`TFO `&        connection took advantage of TCP Fast Open
36813 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
36814 &`U   `&        local user or RFC 1413 identity
36815 &`X   `&        TLS cipher suite
36816 .endd
36817
36818
36819 .section "Other log entries" "SECID259"
36820 Various other types of log entry are written from time to time. Most should be
36821 self-explanatory. Among the more common are:
36822
36823 .ilist
36824 .cindex "retry" "time not reached"
36825 &'retry time not reached'&&~&~An address previously suffered a temporary error
36826 during routing or local delivery, and the time to retry has not yet arrived.
36827 This message is not written to an individual message log file unless it happens
36828 during the first delivery attempt.
36829 .next
36830 &'retry time not reached for any host'&&~&~An address previously suffered
36831 temporary errors during remote delivery, and the retry time has not yet arrived
36832 for any of the hosts to which it is routed.
36833 .next
36834 .cindex "spool directory" "file locked"
36835 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
36836 some other Exim process is already working on the message. This can be quite
36837 common if queue running processes are started at frequent intervals. The
36838 &'exiwhat'& utility script can be used to find out what Exim processes are
36839 doing.
36840 .next
36841 .cindex "error" "ignored"
36842 &'error ignored'&&~&~There are several circumstances that give rise to this
36843 message:
36844 .olist
36845 Exim failed to deliver a bounce message whose age was greater than
36846 &%ignore_bounce_errors_after%&. The bounce was discarded.
36847 .next
36848 A filter file set up a delivery using the &"noerror"& option, and the delivery
36849 failed. The delivery was discarded.
36850 .next
36851 A delivery set up by a router configured with
36852 . ==== As this is a nested list, any displays it contains must be indented
36853 . ==== as otherwise they are too far to the left.
36854 .code
36855     errors_to = <>
36856 .endd
36857 failed. The delivery was discarded.
36858 .endlist olist
36859 .next
36860 .cindex DKIM "log line"
36861 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
36862 logging and the message has a DKIM signature header.
36863 .endlist ilist
36864
36865
36866
36867
36868
36869 .section "Reducing or increasing what is logged" "SECTlogselector"
36870 .cindex "log" "selectors"
36871 By setting the &%log_selector%& global option, you can disable some of Exim's
36872 default logging, or you can request additional logging. The value of
36873 &%log_selector%& is made up of names preceded by plus or minus characters. For
36874 example:
36875 .code
36876 log_selector = +arguments -retry_defer
36877 .endd
36878 The list of optional log items is in the following table, with the default
36879 selection marked by asterisks:
36880 .display
36881 &` 8bitmime                   `&  received 8BITMIME status
36882 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
36883 &` address_rewrite            `&  address rewriting
36884 &` all_parents                `&  all parents in => lines
36885 &` arguments                  `&  command line arguments
36886 &`*connection_reject          `&  connection rejections
36887 &`*delay_delivery             `&  immediate delivery delayed
36888 &` deliver_time               `&  time taken to perform delivery
36889 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
36890 &`*dkim                       `&  DKIM verified domain on <= lines
36891 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
36892 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
36893 &` dnssec                     `&  DNSSEC secured lookups
36894 &`*etrn                       `&  ETRN commands
36895 &`*host_lookup_failed         `&  as it says
36896 &` ident_timeout              `&  timeout for ident connection
36897 &` incoming_interface         `&  local interface on <= and => lines
36898 &` incoming_port              `&  remote port on <= lines
36899 &`*lost_incoming_connection   `&  as it says (includes timeouts)
36900 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
36901 &` outgoing_interface         `&  local interface on => lines
36902 &` outgoing_port              `&  add remote port to => lines
36903 &`*queue_run                  `&  start and end queue runs
36904 &` queue_time                 `&  time on queue for one recipient
36905 &` queue_time_overall         `&  time on queue for whole message
36906 &` pid                        `&  Exim process id
36907 &` pipelining                 `&  PIPELINING use, on <= and => lines
36908 &` proxy                      `&  proxy address on <= and => lines
36909 &` receive_time               `&  time taken to receive message
36910 &` received_recipients        `&  recipients on <= lines
36911 &` received_sender            `&  sender on <= lines
36912 &`*rejected_header            `&  header contents on reject log
36913 &`*retry_defer                `&  &"retry time not reached"&
36914 &` return_path_on_delivery    `&  put return path on => and ** lines
36915 &` sender_on_delivery         `&  add sender to => lines
36916 &`*sender_verify_fail         `&  sender verification failures
36917 &`*size_reject                `&  rejection because too big
36918 &`*skip_delivery              `&  delivery skipped in a queue run
36919 &`*smtp_confirmation          `&  SMTP confirmation on => lines
36920 &` smtp_connection            `&  incoming SMTP connections
36921 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
36922 &` smtp_mailauth              `&  AUTH argument to MAIL commands
36923 &` smtp_no_mail               `&  session with no MAIL commands
36924 &` smtp_protocol_error        `&  SMTP protocol errors
36925 &` smtp_syntax_error          `&  SMTP syntax errors
36926 &` subject                    `&  contents of &'Subject:'& on <= lines
36927 &`*tls_certificate_verified   `&  certificate verification status
36928 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
36929 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
36930 &` tls_sni                    `&  TLS SNI on <= lines
36931 &` unknown_in_list            `&  DNS lookup failed in list match
36932
36933 &` all                        `&  all of the above
36934 .endd
36935 See also the &%slow_lookup_log%& main configuration option,
36936 section &<<SECID99>>&
36937
36938 More details on each of these items follows:
36939
36940 .ilist
36941 .cindex "8BITMIME"
36942 .cindex "log" "8BITMIME"
36943 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
36944 which may help in tracking down interoperability issues with ancient MTAs
36945 that are not 8bit clean.  This is added to the &"<="& line, tagged with
36946 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
36947 &`7BIT`& and &`8BITMIME`& respectively.
36948 .next
36949 .cindex "&%warn%& ACL verb" "log when skipping"
36950 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
36951 its conditions cannot be evaluated, a log line to this effect is written if
36952 this log selector is set.
36953 .next
36954 .cindex "log" "rewriting"
36955 .cindex "rewriting" "logging"
36956 &%address_rewrite%&: This applies both to global rewrites and per-transport
36957 rewrites, but not to rewrites in filters run as an unprivileged user (because
36958 such users cannot access the log).
36959 .next
36960 .cindex "log" "full parentage"
36961 &%all_parents%&: Normally only the original and final addresses are logged on
36962 delivery lines; with this selector, intermediate parents are given in
36963 parentheses between them.
36964 .next
36965 .cindex "log" "Exim arguments"
36966 .cindex "Exim arguments, logging"
36967 &%arguments%&: This causes Exim to write the arguments with which it was called
36968 to the main log, preceded by the current working directory. This is a debugging
36969 feature, added to make it easier to find out how certain MUAs call
36970 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
36971 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36972 that are empty or that contain white space are quoted. Non-printing characters
36973 are shown as escape sequences. This facility cannot log unrecognized arguments,
36974 because the arguments are checked before the configuration file is read. The
36975 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36976 between the caller and Exim.
36977 .next
36978 .cindex "log" "connection rejections"
36979 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36980 connection is rejected, for whatever reason.
36981 .next
36982 .cindex "log" "delayed delivery"
36983 .cindex "delayed delivery, logging"
36984 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36985 started for an incoming message because the load is too high or too many
36986 messages were received on one connection. Logging does not occur if no delivery
36987 process is started because &%queue_only%& is set or &%-odq%& was used.
36988 .next
36989 .cindex "log" "delivery duration"
36990 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36991 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36992 If millisecond logging is enabled, short times will be shown with greater
36993 precision, eg. &`DT=0.304s`&.
36994 .next
36995 .cindex "log" "message size on delivery"
36996 .cindex "size" "of message"
36997 &%delivery_size%&: For each delivery, the size of message delivered is added to
36998 the &"=>"& line, tagged with S=.
36999 .next
37000 .cindex log "DKIM verification"
37001 .cindex DKIM "verification logging"
37002 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37003 verifies successfully a tag of DKIM is added, with one of the verified domains.
37004 .next
37005 .cindex log "DKIM verification"
37006 .cindex DKIM "verification logging"
37007 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37008 .next
37009 .cindex "log" "dnslist defer"
37010 .cindex "DNS list" "logging defer"
37011 .cindex "black list (DNS)"
37012 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37013 DNS black list suffers a temporary error.
37014 .next
37015 .cindex log dnssec
37016 .cindex dnssec logging
37017 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37018 dns lookups gave secure results a tag of DS is added.
37019 For acceptance this covers the reverse and forward lookups for host name verification.
37020 It does not cover helo-name verification.
37021 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37022 .next
37023 .cindex "log" "ETRN commands"
37024 .cindex "ETRN" "logging"
37025 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37026 is run to determine whether or not it is actually accepted. An invalid ETRN
37027 command, or one received within a message transaction is not logged by this
37028 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37029 .next
37030 .cindex "log" "host lookup failure"
37031 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37032 any addresses, or when a lookup of an IP address fails to find a host name, a
37033 log line is written. This logging does not apply to direct DNS lookups when
37034 routing email addresses, but it does apply to &"byname"& lookups.
37035 .next
37036 .cindex "log" "ident timeout"
37037 .cindex "RFC 1413" "logging timeout"
37038 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37039 client's ident port times out.
37040 .next
37041 .cindex "log" "incoming interface"
37042 .cindex "log" "local interface"
37043 .cindex "log" "local address and port"
37044 .cindex "TCP/IP" "logging local address and port"
37045 .cindex "interface" "logging"
37046 &%incoming_interface%&: The interface on which a message was received is added
37047 to the &"<="& line as an IP address in square brackets, tagged by I= and
37048 followed by a colon and the port number. The local interface and port are also
37049 added to other SMTP log lines, for example &"SMTP connection from"&, to
37050 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37051 The latter can be disabled by turning off the &%outgoing_interface%& option.
37052 .next
37053 .cindex log "incoming proxy address"
37054 .cindex proxy "logging proxy address"
37055 .cindex "TCP/IP" "logging proxy address"
37056 &%proxy%&: The internal (closest to the system running Exim) IP address
37057 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37058 on a proxied connection
37059 or the &"=>"& line for a message delivered on a proxied connection.
37060 See &<<SECTproxyInbound>>& for more information.
37061 .next
37062 .cindex "log" "incoming remote port"
37063 .cindex "port" "logging remote"
37064 .cindex "TCP/IP" "logging incoming remote port"
37065 .vindex "&$sender_fullhost$&"
37066 .vindex "&$sender_rcvhost$&"
37067 &%incoming_port%&: The remote port number from which a message was received is
37068 added to log entries and &'Received:'& header lines, following the IP address
37069 in square brackets, and separated from it by a colon. This is implemented by
37070 changing the value that is put in the &$sender_fullhost$& and
37071 &$sender_rcvhost$& variables. Recording the remote port number has become more
37072 important with the widening use of NAT (see RFC 2505).
37073 .next
37074 .cindex "log" "dropped connection"
37075 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37076 connection is unexpectedly dropped.
37077 .next
37078 .cindex "log" "millisecond timestamps"
37079 .cindex millisecond logging
37080 .cindex timestamps "millisecond, in logs"
37081 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37082 appended to the seconds value.
37083 .next
37084 .cindex "log" "outgoing interface"
37085 .cindex "log" "local interface"
37086 .cindex "log" "local address and port"
37087 .cindex "TCP/IP" "logging local address and port"
37088 .cindex "interface" "logging"
37089 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37090 interface on which a message was sent is added to delivery lines as an I= tag
37091 followed by IP address in square brackets. You can disable this by turning
37092 off the &%outgoing_interface%& option.
37093 .next
37094 .cindex "log" "outgoing remote port"
37095 .cindex "port" "logging outgoing remote"
37096 .cindex "TCP/IP" "logging outgoing remote port"
37097 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37098 containing => tags) following the IP address.
37099 The local port is also added if &%incoming_interface%& and
37100 &%outgoing_interface%& are both enabled.
37101 This option is not included in the default setting, because for most ordinary
37102 configurations, the remote port number is always 25 (the SMTP port), and the
37103 local port is a random ephemeral port.
37104 .next
37105 .cindex "log" "process ids in"
37106 .cindex "pid (process id)" "in log lines"
37107 &%pid%&: The current process id is added to every log line, in square brackets,
37108 immediately after the time and date.
37109 .next
37110 .new
37111 .cindex log pipelining
37112 .cindex pipelining "logging outgoing"
37113 &%pipelining%&: A field is added to delivery and accept
37114 log lines when the ESMTP PIPELINING extension was used.
37115 The field is a single "L".
37116
37117 On accept lines, where PIPELINING was offered but not used by the client,
37118 the field has a minus appended.
37119 .next
37120 .cindex "log" "queue run"
37121 .cindex "queue runner" "logging"
37122 &%queue_run%&: The start and end of every queue run are logged.
37123 .next
37124 .cindex "log" "queue time"
37125 &%queue_time%&: The amount of time the message has been in the queue on the
37126 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37127 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37128 includes reception time as well as the delivery time for the current address.
37129 This means that it may be longer than the difference between the arrival and
37130 delivery log line times, because the arrival log line is not written until the
37131 message has been successfully received.
37132 If millisecond logging is enabled, short times will be shown with greater
37133 precision, eg. &`QT=1.578s`&.
37134 .next
37135 &%queue_time_overall%&: The amount of time the message has been in the queue on
37136 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37137 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37138 message, so it includes reception time as well as the total delivery time.
37139 .next
37140 .cindex "log" "receive duration"
37141 &%receive_time%&: For each message, the amount of real time it has taken to
37142 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37143 If millisecond logging is enabled, short times will be shown with greater
37144 precision, eg. &`RT=0.204s`&.
37145 .next
37146 .cindex "log" "recipients"
37147 &%received_recipients%&: The recipients of a message are listed in the main log
37148 as soon as the message is received. The list appears at the end of the log line
37149 that is written when a message is received, preceded by the word &"for"&. The
37150 addresses are listed after they have been qualified, but before any rewriting
37151 has taken place.
37152 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37153 in the list.
37154 .next
37155 .cindex "log" "sender reception"
37156 &%received_sender%&: The unrewritten original sender of a message is added to
37157 the end of the log line that records the message's arrival, after the word
37158 &"from"& (before the recipients if &%received_recipients%& is also set).
37159 .next
37160 .cindex "log" "header lines for rejection"
37161 &%rejected_header%&: If a message's header has been received at the time a
37162 rejection is written to the reject log, the complete header is added to the
37163 log. Header logging can be turned off individually for messages that are
37164 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37165 .next
37166 .cindex "log" "retry defer"
37167 &%retry_defer%&: A log line is written if a delivery is deferred because a
37168 retry time has not yet been reached. However, this &"retry time not reached"&
37169 message is always omitted from individual message logs after the first delivery
37170 attempt.
37171 .next
37172 .cindex "log" "return path"
37173 &%return_path_on_delivery%&: The return path that is being transmitted with
37174 the message is included in delivery and bounce lines, using the tag P=.
37175 This is omitted if no delivery actually happens, for example, if routing fails,
37176 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37177 .next
37178 .cindex "log" "sender on delivery"
37179 &%sender_on_delivery%&: The message's sender address is added to every delivery
37180 and bounce line, tagged by F= (for &"from"&).
37181 This is the original sender that was received with the message; it is not
37182 necessarily the same as the outgoing return path.
37183 .next
37184 .cindex "log" "sender verify failure"
37185 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37186 gives details of a sender verification failure is not written. Log lines for
37187 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37188 detail is lost.
37189 .next
37190 .cindex "log" "size rejection"
37191 &%size_reject%&: A log line is written whenever a message is rejected because
37192 it is too big.
37193 .next
37194 .cindex "log" "frozen messages; skipped"
37195 .cindex "frozen messages" "logging skipping"
37196 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37197 queue run because it is frozen or because another process is already delivering
37198 it.
37199 .cindex "&""spool file is locked""&"
37200 The message that is written is &"spool file is locked"&.
37201 .next
37202 .cindex "log" "smtp confirmation"
37203 .cindex "SMTP" "logging confirmation"
37204 .cindex "LMTP" "logging confirmation"
37205 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37206 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37207 A number of MTAs (including Exim) return an identifying string in this
37208 response.
37209 .next
37210 .cindex "log" "SMTP connections"
37211 .cindex "SMTP" "logging connections"
37212 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37213 established or closed, unless the connection is from a host that matches
37214 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37215 only when the closure is unexpected.) This applies to connections from local
37216 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37217 dropped in the middle of a message, a log line is always written, whether or
37218 not this selector is set, but otherwise nothing is written at the start and end
37219 of connections unless this selector is enabled.
37220
37221 For TCP/IP connections to an Exim daemon, the current number of connections is
37222 included in the log message for each new connection, but note that the count is
37223 reset if the daemon is restarted.
37224 Also, because connections are closed (and the closure is logged) in
37225 subprocesses, the count may not include connections that have been closed but
37226 whose termination the daemon has not yet noticed. Thus, while it is possible to
37227 match up the opening and closing of connections in the log, the value of the
37228 logged counts may not be entirely accurate.
37229 .next
37230 .cindex "log" "SMTP transaction; incomplete"
37231 .cindex "SMTP" "logging incomplete transactions"
37232 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37233 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37234 and the message sender plus any accepted recipients are included in the log
37235 line. This can provide evidence of dictionary attacks.
37236 .next
37237 .cindex "log" "non-MAIL SMTP sessions"
37238 .cindex "MAIL" "logging session without"
37239 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37240 connection terminates without having issued a MAIL command. This includes both
37241 the case when the connection is dropped, and the case when QUIT is used. It
37242 does not include cases where the connection is rejected right at the start (by
37243 an ACL, or because there are too many connections, or whatever). These cases
37244 already have their own log lines.
37245
37246 The log line that is written contains the identity of the client in the usual
37247 way, followed by D= and a time, which records the duration of the connection.
37248 If the connection was authenticated, this fact is logged exactly as it is for
37249 an incoming message, with an A= item. If the connection was encrypted, CV=,
37250 DN=, and X= items may appear as they do for an incoming message, controlled by
37251 the same logging options.
37252
37253 Finally, if any SMTP commands were issued during the connection, a C= item
37254 is added to the line, listing the commands that were used. For example,
37255 .code
37256 C=EHLO,QUIT
37257 .endd
37258 shows that the client issued QUIT straight after EHLO. If there were fewer
37259 than 20 commands, they are all listed. If there were more than 20 commands,
37260 the last 20 are listed, preceded by &"..."&. However, with the default
37261 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37262 have been aborted before 20 non-mail commands are processed.
37263 .next
37264 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37265 colon-separated, is appended to the A= item for a message arrival or delivery
37266 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37267 was accepted or used.
37268 .next
37269 .cindex "log" "SMTP protocol error"
37270 .cindex "SMTP" "logging protocol error"
37271 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37272 encountered. Exim does not have perfect detection of all protocol errors
37273 because of transmission delays and the use of pipelining. If PIPELINING has
37274 been advertised to a client, an Exim server assumes that the client will use
37275 it, and therefore it does not count &"expected"& errors (for example, RCPT
37276 received after rejecting MAIL) as protocol errors.
37277 .next
37278 .cindex "SMTP" "logging syntax errors"
37279 .cindex "SMTP" "syntax errors; logging"
37280 .cindex "SMTP" "unknown command; logging"
37281 .cindex "log" "unknown SMTP command"
37282 .cindex "log" "SMTP syntax error"
37283 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37284 encountered. An unrecognized command is treated as a syntax error. For an
37285 external connection, the host identity is given; for an internal connection
37286 using &%-bs%& the sender identification (normally the calling user) is given.
37287 .next
37288 .cindex "log" "subject"
37289 .cindex "subject, logging"
37290 &%subject%&: The subject of the message is added to the arrival log line,
37291 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37292 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37293 specifies whether characters with values greater than 127 should be logged
37294 unchanged, or whether they should be rendered as escape sequences.
37295 .next
37296 .cindex "log" "certificate verification"
37297 .cindex log DANE
37298 .cindex DANE logging
37299 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37300 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37301 verified
37302 using a CA trust anchor,
37303 &`CA=dane`& if using a DNS trust anchor,
37304 and &`CV=no`& if not.
37305 .next
37306 .cindex "log" "TLS cipher"
37307 .cindex "TLS" "logging cipher"
37308 &%tls_cipher%&: When a message is sent or received over an encrypted
37309 connection, the cipher suite used is added to the log line, preceded by X=.
37310 .next
37311 .cindex "log" "TLS peer DN"
37312 .cindex "TLS" "logging peer DN"
37313 &%tls_peerdn%&: When a message is sent or received over an encrypted
37314 connection, and a certificate is supplied by the remote host, the peer DN is
37315 added to the log line, preceded by DN=.
37316 .next
37317 .cindex "log" "TLS SNI"
37318 .cindex "TLS" "logging SNI"
37319 &%tls_sni%&: When a message is received over an encrypted connection, and
37320 the remote host provided the Server Name Indication extension, the SNI is
37321 added to the log line, preceded by SNI=.
37322 .next
37323 .cindex "log" "DNS failure in list"
37324 &%unknown_in_list%&: This setting causes a log entry to be written when the
37325 result of a list match is failure because a DNS lookup failed.
37326 .endlist
37327
37328
37329 .section "Message log" "SECID260"
37330 .cindex "message" "log file for"
37331 .cindex "log" "message log; description of"
37332 .cindex "&_msglog_& directory"
37333 .oindex "&%preserve_message_logs%&"
37334 In addition to the general log files, Exim writes a log file for each message
37335 that it handles. The names of these per-message logs are the message ids, and
37336 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37337 message log contains copies of the log lines that apply to the message. This
37338 makes it easier to inspect the status of an individual message without having
37339 to search the main log. A message log is deleted when processing of the message
37340 is complete, unless &%preserve_message_logs%& is set, but this should be used
37341 only with great care because they can fill up your disk very quickly.
37342
37343 On a heavily loaded system, it may be desirable to disable the use of
37344 per-message logs, in order to reduce disk I/O. This can be done by setting the
37345 &%message_logs%& option false.
37346 .ecindex IIDloggen
37347
37348
37349
37350
37351 . ////////////////////////////////////////////////////////////////////////////
37352 . ////////////////////////////////////////////////////////////////////////////
37353
37354 .chapter "Exim utilities" "CHAPutils"
37355 .scindex IIDutils "utilities"
37356 A number of utility scripts and programs are supplied with Exim and are
37357 described in this chapter. There is also the Exim Monitor, which is covered in
37358 the next chapter. The utilities described here are:
37359
37360 .itable none 0 0 3  7* left  15* left  40* left
37361 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37362   "list what Exim processes are doing"
37363 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37364 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37365 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37366 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37367                                                 various criteria"
37368 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37369 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37370   "extract statistics from the log"
37371 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37372   "check address acceptance from given IP"
37373 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37374 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37375 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37376 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37377 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37378 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37379 .endtable
37380
37381 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37382 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37383 &url(https://duncanthrax.net/exilog/) for details.
37384
37385
37386
37387
37388 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37389 .cindex "&'exiwhat'&"
37390 .cindex "process, querying"
37391 .cindex "SIGUSR1"
37392 On operating systems that can restart a system call after receiving a signal
37393 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37394 a line describing what it is doing to the file &_exim-process.info_& in the
37395 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37396 processes it can find, having first emptied the file. It then waits for one
37397 second to allow the Exim processes to react before displaying the results. In
37398 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37399 send the signal to the Exim processes, so it is normally run as root.
37400
37401 &*Warning*&: This is not an efficient process. It is intended for occasional
37402 use by system administrators. It is not sensible, for example, to set up a
37403 script that sends SIGUSR1 signals to Exim processes at short intervals.
37404
37405
37406 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37407 varies in different operating systems. Not only are different options used,
37408 but the format of the output is different. For this reason, there are some
37409 system configuration options that configure exactly how &'exiwhat'& works. If
37410 it doesn't seem to be working for you, check the following compile-time
37411 options:
37412 .display
37413 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37414 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37415 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37416 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37417 .endd
37418 An example of typical output from &'exiwhat'& is
37419 .code
37420 164 daemon: -q1h, listening on port 25
37421 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37422 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37423   [10.19.42.42] (editor@ref.example)
37424 10592 handling incoming call from [192.168.243.242]
37425 10628 accepting a local non-SMTP message
37426 .endd
37427 The first number in the output line is the process number. The third line has
37428 been split here, in order to fit it on the page.
37429
37430
37431
37432 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37433 .cindex "&'exiqgrep'&"
37434 .cindex "queue" "grepping"
37435 This utility is a Perl script contributed by Matt Hubbard. It runs
37436 .code
37437 exim -bpu
37438 .endd
37439 or (in case &*-a*& switch is specified)
37440 .code
37441 exim -bp
37442 .endd
37443 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37444 contain alternate exim configuration the queue management might be using.
37445
37446 to obtain a queue listing, and then greps the output to select messages
37447 that match given criteria. The following selection options are available:
37448
37449 .vlist
37450 .vitem &*-f*&&~<&'regex'&>
37451 Match the sender address using a case-insensitive search. The field that is
37452 tested is enclosed in angle brackets, so you can test for bounce messages with
37453 .code
37454 exiqgrep -f '^<>$'
37455 .endd
37456 .vitem &*-r*&&~<&'regex'&>
37457 Match a recipient address using a case-insensitive search. The field that is
37458 tested is not enclosed in angle brackets.
37459
37460 .vitem &*-s*&&~<&'regex'&>
37461 Match against the size field.
37462
37463 .vitem &*-y*&&~<&'seconds'&>
37464 Match messages that are younger than the given time.
37465
37466 .vitem &*-o*&&~<&'seconds'&>
37467 Match messages that are older than the given time.
37468
37469 .vitem &*-z*&
37470 Match only frozen messages.
37471
37472 .vitem &*-x*&
37473 Match only non-frozen messages.
37474 .endlist
37475
37476 The following options control the format of the output:
37477
37478 .vlist
37479 .vitem &*-c*&
37480 Display only the count of matching messages.
37481
37482 .vitem &*-l*&
37483 Long format &-- display the full message information as output by Exim. This is
37484 the default.
37485
37486 .vitem &*-i*&
37487 Display message ids only.
37488
37489 .vitem &*-b*&
37490 Brief format &-- one line per message.
37491
37492 .vitem &*-R*&
37493 Display messages in reverse order.
37494
37495 .vitem &*-a*&
37496 Include delivered recipients in queue listing.
37497 .endlist
37498
37499 There is one more option, &%-h%&, which outputs a list of options.
37500
37501
37502
37503 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
37504 .cindex "&'exiqsumm'&"
37505 .cindex "queue" "summary"
37506 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
37507 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
37508 running a command such as
37509 .code
37510 exim -bp | exiqsumm
37511 .endd
37512 The output consists of one line for each domain that has messages waiting for
37513 it, as in the following example:
37514 .code
37515 3   2322   74m   66m  msn.com.example
37516 .endd
37517 Each line lists the number of pending deliveries for a domain, their total
37518 volume, and the length of time that the oldest and the newest messages have
37519 been waiting. Note that the number of pending deliveries is greater than the
37520 number of messages when messages have more than one recipient.
37521
37522 A summary line is output at the end. By default the output is sorted on the
37523 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
37524 the output to be sorted by oldest message and by count of messages,
37525 respectively. There are also three options that split the messages for each
37526 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
37527 separates frozen messages, and &%-s%& separates messages according to their
37528 sender.
37529
37530 The output of &'exim -bp'& contains the original addresses in the message, so
37531 this also applies to the output from &'exiqsumm'&. No domains from addresses
37532 generated by aliasing or forwarding are included (unless the &%one_time%&
37533 option of the &(redirect)& router has been used to convert them into &"top
37534 level"& addresses).
37535
37536
37537
37538
37539 .section "Extracting specific information from the log (exigrep)" &&&
37540          "SECTextspeinf"
37541 .cindex "&'exigrep'&"
37542 .cindex "log" "extracts; grepping for"
37543 The &'exigrep'& utility is a Perl script that searches one or more main log
37544 files for entries that match a given pattern. When it finds a match, it
37545 extracts all the log entries for the relevant message, not just those that
37546 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
37547 given message, or all mail for a given user, or for a given host, for example.
37548 The input files can be in Exim log format or syslog format.
37549 If a matching log line is not associated with a specific message, it is
37550 included in &'exigrep'&'s output without any additional lines. The usage is:
37551 .display
37552 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
37553 .endd
37554 If no log file names are given on the command line, the standard input is read.
37555
37556 The &%-t%& argument specifies a number of seconds. It adds an additional
37557 condition for message selection. Messages that are complete are shown only if
37558 they spent more than <&'n'&> seconds on the queue.
37559
37560 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
37561 makes it case-sensitive. This may give a performance improvement when searching
37562 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
37563 option; with &%-I%& they do not. In both cases it is possible to change the
37564 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
37565
37566 The &%-l%& option means &"literal"&, that is, treat all characters in the
37567 pattern as standing for themselves. Otherwise the pattern must be a Perl
37568 regular expression.
37569
37570 The &%-v%& option inverts the matching condition. That is, a line is selected
37571 if it does &'not'& match the pattern.
37572
37573 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
37574 that are generated as a result/response to a message that &'exigrep'& matched
37575 normally.
37576
37577 Example of &%-M%&:
37578 user_a sends a message to user_b, which generates a bounce back to user_b. If
37579 &'exigrep'& is used to search for &"user_a"&, only the first message will be
37580 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
37581 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
37582 when searching for &"user_a"& will show both messages since the bounce is
37583 &"related"& to or a &"result"& of the first message that was found by the
37584 search term.
37585
37586 If the location of a &'zcat'& command is known from the definition of
37587 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
37588 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
37589 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
37590 autodetection of some well known compression extensions.
37591
37592
37593 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
37594 .cindex "&'exipick'&"
37595 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
37596 lists messages from the queue according to a variety of criteria. For details
37597 of &'exipick'&'s facilities, run &'exipick'& with
37598 the &%--help%& option.
37599
37600
37601 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
37602 .cindex "log" "cycling local files"
37603 .cindex "cycling logs"
37604 .cindex "&'exicyclog'&"
37605 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
37606 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
37607 you are using log files with datestamps in their names (see section
37608 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
37609 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
37610 There are two command line options for &'exicyclog'&:
37611 .ilist
37612 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
37613 default that is set when Exim is built. The default default is 10.
37614 .next
37615 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
37616 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
37617 overriding the script's default, which is to find the setting from Exim's
37618 configuration.
37619 .endlist
37620
37621 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
37622 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
37623 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
37624 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
37625 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
37626 logs are handled similarly.
37627
37628 If the limit is greater than 99, the script uses 3-digit numbers such as
37629 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
37630 to one that is greater, or &'vice versa'&, you will have to fix the names of
37631 any existing log files.
37632
37633 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
37634 the end are deleted. All files with numbers greater than 01 are compressed,
37635 using a compression command which is configured by the COMPRESS_COMMAND
37636 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
37637 root &%crontab%& entry of the form
37638 .code
37639 1 0 * * * su exim -c /usr/exim/bin/exicyclog
37640 .endd
37641 assuming you have used the name &"exim"& for the Exim user. You can run
37642 &'exicyclog'& as root if you wish, but there is no need.
37643
37644
37645
37646 .section "Mail statistics (eximstats)" "SECTmailstat"
37647 .cindex "statistics"
37648 .cindex "&'eximstats'&"
37649 A Perl script called &'eximstats'& is provided for extracting statistical
37650 information from log files. The output is either plain text, or HTML.
37651 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
37652 . --- 404 error and everything else points to that.
37653
37654 The &'eximstats'& script has been hacked about quite a bit over time. The
37655 latest version is the result of some extensive revision by Steve Campbell. A
37656 lot of information is given by default, but there are options for suppressing
37657 various parts of it. Following any options, the arguments to the script are a
37658 list of files, which should be main log files. For example:
37659 .code
37660 eximstats -nr /var/spool/exim/log/mainlog.01
37661 .endd
37662 By default, &'eximstats'& extracts information about the number and volume of
37663 messages received from or delivered to various hosts. The information is sorted
37664 both by message count and by volume, and the top fifty hosts in each category
37665 are listed on the standard output. Similar information, based on email
37666 addresses or domains instead of hosts can be requested by means of various
37667 options. For messages delivered and received locally, similar statistics are
37668 also produced per user.
37669
37670 The output also includes total counts and statistics about delivery errors, and
37671 histograms showing the number of messages received and deliveries made in each
37672 hour of the day. A delivery with more than one address in its envelope (for
37673 example, an SMTP transaction with more than one RCPT command) is counted
37674 as a single delivery by &'eximstats'&.
37675
37676 Though normally more deliveries than receipts are reported (as messages may
37677 have multiple recipients), it is possible for &'eximstats'& to report more
37678 messages received than delivered, even though the queue is empty at the start
37679 and end of the period in question. If an incoming message contains no valid
37680 recipients, no deliveries are recorded for it. A bounce message is handled as
37681 an entirely separate message.
37682
37683 &'eximstats'& always outputs a grand total summary giving the volume and number
37684 of messages received and deliveries made, and the number of hosts involved in
37685 each case. It also outputs the number of messages that were delayed (that is,
37686 not completely delivered at the first attempt), and the number that had at
37687 least one address that failed.
37688
37689 The remainder of the output is in sections that can be independently disabled
37690 or modified by various options. It consists of a summary of deliveries by
37691 transport, histograms of messages received and delivered per time interval
37692 (default per hour), information about the time messages spent on the queue,
37693 a list of relayed messages, lists of the top fifty sending hosts, local
37694 senders, destination hosts, and destination local users by count and by volume,
37695 and a list of delivery errors that occurred.
37696
37697 The relay information lists messages that were actually relayed, that is, they
37698 came from a remote host and were directly delivered to some other remote host,
37699 without being processed (for example, for aliasing or forwarding) locally.
37700
37701 There are quite a few options for &'eximstats'& to control exactly what it
37702 outputs. These are documented in the Perl script itself, and can be extracted
37703 by running the command &(perldoc)& on the script. For example:
37704 .code
37705 perldoc /usr/exim/bin/eximstats
37706 .endd
37707
37708 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
37709 .cindex "&'exim_checkaccess'&"
37710 .cindex "policy control" "checking access"
37711 .cindex "checking access"
37712 The &%-bh%& command line argument allows you to run a fake SMTP session with
37713 debugging output, in order to check what Exim is doing when it is applying
37714 policy controls to incoming SMTP mail. However, not everybody is sufficiently
37715 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
37716 sometimes you just want to answer the question &"Does this address have
37717 access?"& without bothering with any further details.
37718
37719 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
37720 two arguments, an IP address and an email address:
37721 .code
37722 exim_checkaccess 10.9.8.7 A.User@a.domain.example
37723 .endd
37724 The utility runs a call to Exim with the &%-bh%& option, to test whether the
37725 given email address would be accepted in a RCPT command in a TCP/IP
37726 connection from the host with the given IP address. The output of the utility
37727 is either the word &"accepted"&, or the SMTP error response, for example:
37728 .code
37729 Rejected:
37730 550 Relay not permitted
37731 .endd
37732 When running this test, the utility uses &`<>`& as the envelope sender address
37733 for the MAIL command, but you can change this by providing additional
37734 options. These are passed directly to the Exim command. For example, to specify
37735 that the test is to be run with the sender address &'himself@there.example'&
37736 you can use:
37737 .code
37738 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
37739                  -f himself@there.example
37740 .endd
37741 Note that these additional Exim command line items must be given after the two
37742 mandatory arguments.
37743
37744 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
37745 while running its checks. You can run checks that include callouts by using
37746 &%-bhc%&, but this is not yet available in a &"packaged"& form.
37747
37748
37749
37750 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
37751 .cindex "DBM" "building dbm files"
37752 .cindex "building DBM files"
37753 .cindex "&'exim_dbmbuild'&"
37754 .cindex "lower casing"
37755 .cindex "binary zero" "in lookup key"
37756 The &'exim_dbmbuild'& program reads an input file containing keys and data in
37757 the format used by the &(lsearch)& lookup (see section
37758 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
37759 names as keys and the remainder of the information as data. The lower-casing
37760 can be prevented by calling the program with the &%-nolc%& option.
37761
37762 A terminating zero is included as part of the key string. This is expected by
37763 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
37764 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
37765 strings or the data strings. The &(dbmnz)& lookup type can be used with such
37766 files.
37767
37768 The program requires two arguments: the name of the input file (which can be a
37769 single hyphen to indicate the standard input), and the name of the output file.
37770 It creates the output under a temporary name, and then renames it if all went
37771 well.
37772
37773 .cindex "USE_DB"
37774 If the native DB interface is in use (USE_DB is set in a compile-time
37775 configuration file &-- this is common in free versions of Unix) the two file
37776 names must be different, because in this mode the Berkeley DB functions create
37777 a single output file using exactly the name given. For example,
37778 .code
37779 exim_dbmbuild /etc/aliases /etc/aliases.db
37780 .endd
37781 reads the system alias file and creates a DBM version of it in
37782 &_/etc/aliases.db_&.
37783
37784 In systems that use the &'ndbm'& routines (mostly proprietary versions of
37785 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
37786 environment, the suffixes are added to the second argument of
37787 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
37788 when the Berkeley functions are used in compatibility mode (though this is not
37789 recommended), because in that case it adds a &_.db_& suffix to the file name.
37790
37791 If a duplicate key is encountered, the program outputs a warning, and when it
37792 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
37793 option is used. By default, only the first of a set of duplicates is used &--
37794 this makes it compatible with &(lsearch)& lookups. There is an option
37795 &%-lastdup%& which causes it to use the data for the last duplicate instead.
37796 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
37797 &%stderr%&. For other errors, where it doesn't actually make a new file, the
37798 return code is 2.
37799
37800
37801
37802
37803 .section "Finding individual retry times (exinext)" "SECTfinindret"
37804 .cindex "retry" "times"
37805 .cindex "&'exinext'&"
37806 A utility called &'exinext'& (mostly a Perl script) provides the ability to
37807 fish specific information out of the retry database. Given a mail domain (or a
37808 complete address), it looks up the hosts for that domain, and outputs any retry
37809 information for the hosts or for the domain. At present, the retry information
37810 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
37811 output. For example:
37812 .code
37813 $ exinext piglet@milne.fict.example
37814 kanga.milne.example:192.168.8.1 error 146: Connection refused
37815   first failed: 21-Feb-1996 14:57:34
37816   last tried:   21-Feb-1996 14:57:34
37817   next try at:  21-Feb-1996 15:02:34
37818 roo.milne.example:192.168.8.3 error 146: Connection refused
37819   first failed: 20-Jan-1996 13:12:08
37820   last tried:   21-Feb-1996 11:42:03
37821   next try at:  21-Feb-1996 19:42:03
37822   past final cutoff time
37823 .endd
37824 You can also give &'exinext'& a local part, without a domain, and it
37825 will give any retry information for that local part in your default domain.
37826 A message id can be used to obtain retry information pertaining to a specific
37827 message. This exists only when an attempt to deliver a message to a remote host
37828 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
37829 &'exinext'& is not particularly efficient, but then it is not expected to be
37830 run very often.
37831
37832 The &'exinext'& utility calls Exim to find out information such as the location
37833 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
37834 passed on to the &'exim'& commands. The first specifies an alternate Exim
37835 configuration file, and the second sets macros for use within the configuration
37836 file. These features are mainly to help in testing, but might also be useful in
37837 environments where more than one configuration file is in use.
37838
37839
37840
37841 .section "Hints database maintenance" "SECThindatmai"
37842 .cindex "hints database" "maintenance"
37843 .cindex "maintaining Exim's hints database"
37844 Three utility programs are provided for maintaining the DBM files that Exim
37845 uses to contain its delivery hint information. Each program requires two
37846 arguments. The first specifies the name of Exim's spool directory, and the
37847 second is the name of the database it is to operate on. These are as follows:
37848
37849 .ilist
37850 &'retry'&: the database of retry information
37851 .next
37852 &'wait-'&<&'transport name'&>: databases of information about messages waiting
37853 for remote hosts
37854 .next
37855 &'callout'&: the callout cache
37856 .next
37857 &'ratelimit'&: the data for implementing the ratelimit ACL condition
37858 .next
37859 &'misc'&: other hints data
37860 .endlist
37861
37862 The &'misc'& database is used for
37863
37864 .ilist
37865 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
37866 .next
37867 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
37868 &(smtp)& transport)
37869 .next
37870 Limiting the concurrency of specific transports (when &%max_parallel%& is set
37871 in a transport)
37872 .endlist
37873
37874
37875
37876 .section "exim_dumpdb" "SECID261"
37877 .cindex "&'exim_dumpdb'&"
37878 The entire contents of a database are written to the standard output by the
37879 &'exim_dumpdb'& program, which has no options or arguments other than the
37880 spool and database names. For example, to dump the retry database:
37881 .code
37882 exim_dumpdb /var/spool/exim retry
37883 .endd
37884 Two lines of output are produced for each entry:
37885 .code
37886 T:mail.ref.example:192.168.242.242 146 77 Connection refused
37887 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
37888 .endd
37889 The first item on the first line is the key of the record. It starts with one
37890 of the letters R, or T, depending on whether it refers to a routing or
37891 transport retry. For a local delivery, the next part is the local address; for
37892 a remote delivery it is the name of the remote host, followed by its failing IP
37893 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
37894 transport). If the remote port is not the standard one (port 25), it is added
37895 to the IP address. Then there follows an error code, an additional error code,
37896 and a textual description of the error.
37897
37898 The three times on the second line are the time of first failure, the time of
37899 the last delivery attempt, and the computed time for the next attempt. The line
37900 ends with an asterisk if the cutoff time for the last retry rule has been
37901 exceeded.
37902
37903 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
37904 consists of a host name followed by a list of ids for messages that are or were
37905 waiting to be delivered to that host. If there are a very large number for any
37906 one host, continuation records, with a sequence number added to the host name,
37907 may be seen. The data in these records is often out of date, because a message
37908 may be routed to several alternative hosts, and Exim makes no effort to keep
37909 cross-references.
37910
37911
37912
37913 .section "exim_tidydb" "SECID262"
37914 .cindex "&'exim_tidydb'&"
37915 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
37916 database. If run with no options, it removes all records that are more than 30
37917 days old. The age is calculated from the date and time that the record was last
37918 updated. Note that, in the case of the retry database, it is &'not'& the time
37919 since the first delivery failure. Information about a host that has been down
37920 for more than 30 days will remain in the database, provided that the record is
37921 updated sufficiently often.
37922
37923 The cutoff date can be altered by means of the &%-t%& option, which must be
37924 followed by a time. For example, to remove all records older than a week from
37925 the retry database:
37926 .code
37927 exim_tidydb -t 7d /var/spool/exim retry
37928 .endd
37929 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
37930 message ids. In the former these appear as data in records keyed by host &--
37931 they were messages that were waiting for that host &-- and in the latter they
37932 are the keys for retry information for messages that have suffered certain
37933 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
37934 message ids in database records are those of messages that are still on the
37935 queue. Message ids for messages that no longer exist are removed from
37936 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
37937 For the &'retry'& database, records whose keys are non-existent message ids are
37938 removed. The &'exim_tidydb'& utility outputs comments on the standard output
37939 whenever it removes information from the database.
37940
37941 Certain records are automatically removed by Exim when they are no longer
37942 needed, but others are not. For example, if all the MX hosts for a domain are
37943 down, a retry record is created for each one. If the primary MX host comes back
37944 first, its record is removed when Exim successfully delivers to it, but the
37945 records for the others remain because Exim has not tried to use those hosts.
37946
37947 It is important, therefore, to run &'exim_tidydb'& periodically on all the
37948 hints databases. You should do this at a quiet time of day, because it requires
37949 a database to be locked (and therefore inaccessible to Exim) while it does its
37950 work. Removing records from a DBM file does not normally make the file smaller,
37951 but all the common DBM libraries are able to re-use the space that is released.
37952 After an initial phase of increasing in size, the databases normally reach a
37953 point at which they no longer get any bigger, as long as they are regularly
37954 tidied.
37955
37956 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
37957 databases is likely to keep on increasing.
37958
37959
37960
37961
37962 .section "exim_fixdb" "SECID263"
37963 .cindex "&'exim_fixdb'&"
37964 The &'exim_fixdb'& program is a utility for interactively modifying databases.
37965 Its main use is for testing Exim, but it might also be occasionally useful for
37966 getting round problems in a live system. It has no options, and its interface
37967 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
37968 key of a database record can then be entered, and the data for that record is
37969 displayed.
37970
37971 If &"d"& is typed at the next prompt, the entire record is deleted. For all
37972 except the &'retry'& database, that is the only operation that can be carried
37973 out. For the &'retry'& database, each field is output preceded by a number, and
37974 data for individual fields can be changed by typing the field number followed
37975 by new data, for example:
37976 .code
37977 > 4 951102:1000
37978 .endd
37979 resets the time of the next delivery attempt. Time values are given as a
37980 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
37981 used as optional separators.
37982
37983
37984
37985
37986 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
37987 .cindex "mailbox" "maintenance"
37988 .cindex "&'exim_lock'&"
37989 .cindex "locking mailboxes"
37990 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
37991 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
37992 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
37993 a user agent while investigating a problem. The utility requires the name of
37994 the file as its first argument. If the locking is successful, the second
37995 argument is run as a command (using C's &[system()]& function); if there is no
37996 second argument, the value of the SHELL environment variable is used; if this
37997 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
37998 is unlocked and the utility ends. The following options are available:
37999
38000 .vlist
38001 .vitem &%-fcntl%&
38002 Use &[fcntl()]& locking on the open mailbox.
38003
38004 .vitem &%-flock%&
38005 Use &[flock()]& locking on the open mailbox, provided the operating system
38006 supports it.
38007
38008 .vitem &%-interval%&
38009 This must be followed by a number, which is a number of seconds; it sets the
38010 interval to sleep between retries (default 3).
38011
38012 .vitem &%-lockfile%&
38013 Create a lock file before opening the mailbox.
38014
38015 .vitem &%-mbx%&
38016 Lock the mailbox using MBX rules.
38017
38018 .vitem &%-q%&
38019 Suppress verification output.
38020
38021 .vitem &%-retries%&
38022 This must be followed by a number; it sets the number of times to try to get
38023 the lock (default 10).
38024
38025 .vitem &%-restore_time%&
38026 This option causes &%exim_lock%& to restore the modified and read times to the
38027 locked file before exiting. This allows you to access a locked mailbox (for
38028 example, to take a backup copy) without disturbing the times that the user
38029 subsequently sees.
38030
38031 .vitem &%-timeout%&
38032 This must be followed by a number, which is a number of seconds; it sets a
38033 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38034 default), a non-blocking call is used.
38035
38036 .vitem &%-v%&
38037 Generate verbose output.
38038 .endlist
38039
38040 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38041 default is to create a lock file and also to use &[fcntl()]& locking on the
38042 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38043 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38044 requires that the directory containing the file be writeable. Locking by lock
38045 file does not last for ever; Exim assumes that a lock file is expired if it is
38046 more than 30 minutes old.
38047
38048 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38049 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38050 to be taken out on the open mailbox, and an exclusive lock on the file
38051 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38052 number of the mailbox file. When the locking is released, if an exclusive lock
38053 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38054
38055 The default output contains verification of the locking that takes place. The
38056 &%-v%& option causes some additional information to be given. The &%-q%& option
38057 suppresses all output except error messages.
38058
38059 A command such as
38060 .code
38061 exim_lock /var/spool/mail/spqr
38062 .endd
38063 runs an interactive shell while the file is locked, whereas
38064 .display
38065 &`exim_lock -q /var/spool/mail/spqr <<End`&
38066 <&'some commands'&>
38067 &`End`&
38068 .endd
38069 runs a specific non-interactive sequence of commands while the file is locked,
38070 suppressing all verification output. A single command can be run by a command
38071 such as
38072 .code
38073 exim_lock -q /var/spool/mail/spqr \
38074   "cp /var/spool/mail/spqr /some/where"
38075 .endd
38076 Note that if a command is supplied, it must be entirely contained within the
38077 second argument &-- hence the quotes.
38078 .ecindex IIDutils
38079
38080
38081 . ////////////////////////////////////////////////////////////////////////////
38082 . ////////////////////////////////////////////////////////////////////////////
38083
38084 .chapter "The Exim monitor" "CHAPeximon"
38085 .scindex IIDeximon "Exim monitor" "description"
38086 .cindex "X-windows"
38087 .cindex "&'eximon'&"
38088 .cindex "Local/eximon.conf"
38089 .cindex "&_exim_monitor/EDITME_&"
38090 The Exim monitor is an application which displays in an X window information
38091 about the state of Exim's queue and what Exim is doing. An admin user can
38092 perform certain operations on messages from this GUI interface; however all
38093 such facilities are also available from the command line, and indeed, the
38094 monitor itself makes use of the command line to perform any actions requested.
38095
38096
38097
38098 .section "Running the monitor" "SECID264"
38099 The monitor is started by running the script called &'eximon'&. This is a shell
38100 script that sets up a number of environment variables, and then runs the
38101 binary called &_eximon.bin_&. The default appearance of the monitor window can
38102 be changed by editing the &_Local/eximon.conf_& file created by editing
38103 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38104 parameters are for.
38105
38106 The parameters that get built into the &'eximon'& script can be overridden for
38107 a particular invocation by setting up environment variables of the same names,
38108 preceded by &`EXIMON_`&. For example, a shell command such as
38109 .code
38110 EXIMON_LOG_DEPTH=400 eximon
38111 .endd
38112 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38113 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38114 overrides the Exim log file configuration. This makes it possible to have
38115 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38116 syslog messages are routed to a file on the local host.
38117
38118 X resources can be used to change the appearance of the window in the normal
38119 way. For example, a resource setting of the form
38120 .code
38121 Eximon*background: gray94
38122 .endd
38123 changes the colour of the background to light grey rather than white. The
38124 stripcharts are drawn with both the data lines and the reference lines in
38125 black. This means that the reference lines are not visible when on top of the
38126 data. However, their colour can be changed by setting a resource called
38127 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38128 For example, if your X server is running Unix, you could set up lighter
38129 reference lines in the stripcharts by obeying
38130 .code
38131 xrdb -merge <<End
38132 Eximon*highlight: gray
38133 End
38134 .endd
38135 .cindex "admin user"
38136 In order to see the contents of messages on the queue, and to operate on them,
38137 &'eximon'& must either be run as root or by an admin user.
38138
38139 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38140 contain X11 resource parameters interpreted by the X11 library.  In addition,
38141 if the first parameter starts with the string "gdb" then it is removed and the
38142 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38143 versioned variants of gdb can be invoked).
38144
38145 The monitor's window is divided into three parts. The first contains one or
38146 more stripcharts and two action buttons, the second contains a &"tail"& of the
38147 main log file, and the third is a display of the queue of messages awaiting
38148 delivery, with two more action buttons. The following sections describe these
38149 different parts of the display.
38150
38151
38152
38153
38154 .section "The stripcharts" "SECID265"
38155 .cindex "stripchart"
38156 The first stripchart is always a count of messages on the queue. Its name can
38157 be configured by setting QUEUE_STRIPCHART_NAME in the
38158 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38159 configuration script by regular expression matches on log file entries, making
38160 it possible to display, for example, counts of messages delivered to certain
38161 hosts or using certain transports. The supplied defaults display counts of
38162 received and delivered messages, and of local and SMTP deliveries. The default
38163 period between stripchart updates is one minute; this can be adjusted by a
38164 parameter in the &_Local/eximon.conf_& file.
38165
38166 The stripchart displays rescale themselves automatically as the value they are
38167 displaying changes. There are always 10 horizontal lines in each chart; the
38168 title string indicates the value of each division when it is greater than one.
38169 For example, &"x2"& means that each division represents a value of 2.
38170
38171 It is also possible to have a stripchart which shows the percentage fullness of
38172 a particular disk partition, which is useful when local deliveries are confined
38173 to a single partition.
38174
38175 .cindex "&%statvfs%& function"
38176 This relies on the availability of the &[statvfs()]& function or equivalent in
38177 the operating system. Most, but not all versions of Unix that support Exim have
38178 this. For this particular stripchart, the top of the chart always represents
38179 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38180 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38181 &_Local/eximon.conf_& file.
38182
38183
38184
38185
38186 .section "Main action buttons" "SECID266"
38187 .cindex "size" "of monitor window"
38188 .cindex "Exim monitor" "window size"
38189 .cindex "window size"
38190 Below the stripcharts there is an action button for quitting the monitor. Next
38191 to this is another button marked &"Size"&. They are placed here so that
38192 shrinking the window to its default minimum size leaves just the queue count
38193 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38194 the window to expand to its maximum size, unless it is already at the maximum,
38195 in which case it is reduced to its minimum.
38196
38197 When expanding to the maximum, if the window cannot be fully seen where it
38198 currently is, it is moved back to where it was the last time it was at full
38199 size. When it is expanding from its minimum size, the old position is
38200 remembered, and next time it is reduced to the minimum it is moved back there.
38201
38202 The idea is that you can keep a reduced window just showing one or two
38203 stripcharts at a convenient place on your screen, easily expand it to show
38204 the full window when required, and just as easily put it back to what it was.
38205 The idea is copied from what the &'twm'& window manager does for its
38206 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38207 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38208
38209 Normally, the monitor starts up with the window at its full size, but it can be
38210 built so that it starts up with the window at its smallest size, by setting
38211 START_SMALL=yes in &_Local/eximon.conf_&.
38212
38213
38214
38215 .section "The log display" "SECID267"
38216 .cindex "log" "tail of; in monitor"
38217 The second section of the window is an area in which a display of the tail of
38218 the main log is maintained.
38219 To save space on the screen, the timestamp on each log line is shortened by
38220 removing the date and, if &%log_timezone%& is set, the timezone.
38221 The log tail is not available when the only destination for logging data is
38222 syslog, unless the syslog lines are routed to a local file whose name is passed
38223 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38224
38225 The log sub-window has a scroll bar at its lefthand side which can be used to
38226 move back to look at earlier text, and the up and down arrow keys also have a
38227 scrolling effect. The amount of log that is kept depends on the setting of
38228 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38229 to use. When this is full, the earlier 50% of data is discarded &-- this is
38230 much more efficient than throwing it away line by line. The sub-window also has
38231 a horizontal scroll bar for accessing the ends of long log lines. This is the
38232 only means of horizontal scrolling; the right and left arrow keys are not
38233 available. Text can be cut from this part of the window using the mouse in the
38234 normal way. The size of this subwindow is controlled by parameters in the
38235 configuration file &_Local/eximon.conf_&.
38236
38237 Searches of the text in the log window can be carried out by means of the ^R
38238 and ^S keystrokes, which default to a reverse and a forward search,
38239 respectively. The search covers only the text that is displayed in the window.
38240 It cannot go further back up the log.
38241
38242 The point from which the search starts is indicated by a caret marker. This is
38243 normally at the end of the text in the window, but can be positioned explicitly
38244 by pointing and clicking with the left mouse button, and is moved automatically
38245 by a successful search. If new text arrives in the window when it is scrolled
38246 back, the caret remains where it is, but if the window is not scrolled back,
38247 the caret is moved to the end of the new text.
38248
38249 Pressing ^R or ^S pops up a window into which the search text can be typed.
38250 There are buttons for selecting forward or reverse searching, for carrying out
38251 the search, and for cancelling. If the &"Search"& button is pressed, the search
38252 happens and the window remains so that further searches can be done. If the
38253 &"Return"& key is pressed, a single search is done and the window is closed. If
38254 ^C is typed the search is cancelled.
38255
38256 The searching facility is implemented using the facilities of the Athena text
38257 widget. By default this pops up a window containing both &"search"& and
38258 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38259 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38260 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38261 provided version of &%TextPop%& when the remaining parts of the text widget
38262 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38263 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38264 on these systems, at the expense of having unwanted items in the search popup
38265 window.
38266
38267
38268
38269 .section "The queue display" "SECID268"
38270 .cindex "queue" "display in monitor"
38271 The bottom section of the monitor window contains a list of all messages that
38272 are on the queue, which includes those currently being received or delivered,
38273 as well as those awaiting delivery. The size of this subwindow is controlled by
38274 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38275 at which it is updated is controlled by another parameter in the same file &--
38276 the default is 5 minutes, since queue scans can be quite expensive. However,
38277 there is an &"Update"& action button just above the display which can be used
38278 to force an update of the queue display at any time.
38279
38280 When a host is down for some time, a lot of pending mail can build up for it,
38281 and this can make it hard to deal with other messages on the queue. To help
38282 with this situation there is a button next to &"Update"& called &"Hide"&. If
38283 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38284 type anything in here and press &"Return"&, the text is added to a chain of
38285 such texts, and if every undelivered address in a message matches at least one
38286 of the texts, the message is not displayed.
38287
38288 If there is an address that does not match any of the texts, all the addresses
38289 are displayed as normal. The matching happens on the ends of addresses so, for
38290 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38291 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38292 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38293 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38294 a hide request is automatically cancelled after one hour.
38295
38296 While the dialogue box is displayed, you can't press any buttons or do anything
38297 else to the monitor window. For this reason, if you want to cut text from the
38298 queue display to use in the dialogue box, you have to do the cutting before
38299 pressing the &"Hide"& button.
38300
38301 The queue display contains, for each unhidden queued message, the length of
38302 time it has been on the queue, the size of the message, the message id, the
38303 message sender, and the first undelivered recipient, all on one line. If it is
38304 a bounce message, the sender is shown as &"<>"&. If there is more than one
38305 recipient to which the message has not yet been delivered, subsequent ones are
38306 listed on additional lines, up to a maximum configured number, following which
38307 an ellipsis is displayed. Recipients that have already received the message are
38308 not shown.
38309
38310 .cindex "frozen messages" "display"
38311 If a message is frozen, an asterisk is displayed at the left-hand side.
38312
38313 The queue display has a vertical scroll bar, and can also be scrolled by means
38314 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38315 The text searching facilities, as described above for the log window, are also
38316 available, but the caret is always moved to the end of the text when the queue
38317 display is updated.
38318
38319
38320
38321 .section "The queue menu" "SECID269"
38322 .cindex "queue" "menu in monitor"
38323 If the &%shift%& key is held down and the left button is clicked when the mouse
38324 pointer is over the text for any message, an action menu pops up, and the first
38325 line of the queue display for the message is highlighted. This does not affect
38326 any selected text.
38327
38328 If you want to use some other event for popping up the menu, you can set the
38329 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38330 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38331 value set in this parameter is a standard X event description. For example, to
38332 run eximon using &%ctrl%& rather than &%shift%& you could use
38333 .code
38334 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38335 .endd
38336 The title of the menu is the message id, and it contains entries which act as
38337 follows:
38338
38339 .ilist
38340 &'message log'&: The contents of the message log for the message are displayed
38341 in a new text window.
38342 .next
38343 &'headers'&: Information from the spool file that contains the envelope
38344 information and headers is displayed in a new text window. See chapter
38345 &<<CHAPspool>>& for a description of the format of spool files.
38346 .next
38347 &'body'&: The contents of the spool file containing the body of the message are
38348 displayed in a new text window. There is a default limit of 20,000 bytes to the
38349 amount of data displayed. This can be changed by setting the BODY_MAX
38350 option at compile time, or the EXIMON_BODY_MAX option at run time.
38351 .next
38352 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38353 delivery of the message. This causes an automatic thaw if the message is
38354 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38355 a new text window. The delivery is run in a separate process, to avoid holding
38356 up the monitor while the delivery proceeds.
38357 .next
38358 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38359 that the message be frozen.
38360 .next
38361 .cindex "thawing messages"
38362 .cindex "unfreezing messages"
38363 .cindex "frozen messages" "thawing"
38364 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38365 that the message be thawed.
38366 .next
38367 .cindex "delivery" "forcing failure"
38368 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38369 that Exim gives up trying to deliver the message. A bounce message is generated
38370 for any remaining undelivered addresses.
38371 .next
38372 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38373 that the message be deleted from the system without generating a bounce
38374 message.
38375 .next
38376 &'add recipient'&: A dialog box is displayed into which a recipient address can
38377 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38378 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38379 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38380 causes a call to Exim to be made using the &%-Mar%& option to request that an
38381 additional recipient be added to the message, unless the entry box is empty, in
38382 which case no action is taken.
38383 .next
38384 &'mark delivered'&: A dialog box is displayed into which a recipient address
38385 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38386 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38387 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38388 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38389 recipient address as already delivered, unless the entry box is empty, in which
38390 case no action is taken.
38391 .next
38392 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38393 mark all recipient addresses as already delivered.
38394 .next
38395 &'edit sender'&: A dialog box is displayed initialized with the current
38396 sender's address. Pressing RETURN causes a call to Exim to be made using the
38397 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38398 in which case no action is taken. If you want to set an empty sender (as in
38399 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38400 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38401 the address is qualified with that domain.
38402 .endlist
38403
38404 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38405 other cases when a call to Exim is made, if there is any output from Exim (in
38406 particular, if the command fails) a window containing the command and the
38407 output is displayed. Otherwise, the results of the action are normally apparent
38408 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38409 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38410 if no output is generated.
38411
38412 The queue display is automatically updated for actions such as freezing and
38413 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38414 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38415 force an update of the display after one of these actions.
38416
38417 In any text window that is displayed as result of a menu action, the normal
38418 cut-and-paste facility is available, and searching can be carried out using ^R
38419 and ^S, as described above for the log tail window.
38420 .ecindex IIDeximon
38421
38422
38423
38424
38425
38426 . ////////////////////////////////////////////////////////////////////////////
38427 . ////////////////////////////////////////////////////////////////////////////
38428
38429 .chapter "Security considerations" "CHAPsecurity"
38430 .scindex IIDsecurcon "security" "discussion of"
38431 This chapter discusses a number of issues concerned with security, some of
38432 which are also covered in other parts of this manual.
38433
38434 For reasons that this author does not understand, some people have promoted
38435 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38436 existence of this chapter in the documentation. However, the intent of the
38437 chapter is simply to describe the way Exim works in relation to certain
38438 security concerns, not to make any specific claims about the effectiveness of
38439 its security as compared with other MTAs.
38440
38441 What follows is a description of the way Exim is supposed to be. Best efforts
38442 have been made to try to ensure that the code agrees with the theory, but an
38443 absence of bugs can never be guaranteed. Any that are reported will get fixed
38444 as soon as possible.
38445
38446
38447 .section "Building a more &""hardened""& Exim" "SECID286"
38448 .cindex "security" "build-time features"
38449 There are a number of build-time options that can be set in &_Local/Makefile_&
38450 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38451 Exim administrator who does not have the root password, or by someone who has
38452 penetrated the Exim (but not the root) account. These options are as follows:
38453
38454 .ilist
38455 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38456 start of any file names used with the &%-C%& option. When it is set, these file
38457 names are also not allowed to contain the sequence &"/../"&. (However, if the
38458 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38459 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38460 default setting for &%ALT_CONFIG_PREFIX%&.
38461
38462 If the permitted configuration files are confined to a directory to
38463 which only root has access, this guards against someone who has broken
38464 into the Exim account from running a privileged Exim with an arbitrary
38465 configuration file, and using it to break into other accounts.
38466 .next
38467
38468 If a non-trusted configuration file (i.e. not the default configuration file
38469 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
38470 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
38471 the next item), then root privilege is retained only if the caller of Exim is
38472 root. This locks out the possibility of testing a configuration using &%-C%&
38473 right through message reception and delivery, even if the caller is root. The
38474 reception works, but by that time, Exim is running as the Exim user, so when
38475 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
38476 privilege to be lost. However, root can test reception and delivery using two
38477 separate commands.
38478
38479 .next
38480 The WHITELIST_D_MACROS build option declares some macros to be safe to override
38481 with &%-D%& if the real uid is one of root, the Exim run-time user or the
38482 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
38483 requiring the run-time value supplied to &%-D%& to match a regex that errs on
38484 the restrictive side.  Requiring build-time selection of safe macros is onerous
38485 but this option is intended solely as a transition mechanism to permit
38486 previously-working configurations to continue to work after release 4.73.
38487 .next
38488 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
38489 is disabled.
38490 .next
38491 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
38492 never to be used for any deliveries. This is like the &%never_users%& runtime
38493 option, but it cannot be overridden; the runtime option adds additional users
38494 to the list. The default setting is &"root"&; this prevents a non-root user who
38495 is permitted to modify the runtime file from using Exim as a way to get root.
38496 .endlist
38497
38498
38499
38500 .section "Root privilege" "SECID270"
38501 .cindex "setuid"
38502 .cindex "root privilege"
38503 The Exim binary is normally setuid to root, which means that it gains root
38504 privilege (runs as root) when it starts execution. In some special cases (for
38505 example, when the daemon is not in use and there are no local deliveries), it
38506 may be possible to run Exim setuid to some user other than root. This is
38507 discussed in the next section. However, in most installations, root privilege
38508 is required for two things:
38509
38510 .ilist
38511 To set up a socket connected to the standard SMTP port (25) when initialising
38512 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
38513 not required.
38514 .next
38515 To be able to change uid and gid in order to read users' &_.forward_& files and
38516 perform local deliveries as the receiving user or as specified in the
38517 configuration.
38518 .endlist
38519
38520 It is not necessary to be root to do any of the other things Exim does, such as
38521 receiving messages and delivering them externally over SMTP, and it is
38522 obviously more secure if Exim does not run as root except when necessary.
38523 For this reason, a user and group for Exim to use must be defined in
38524 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
38525 group"&. Their values can be changed by the run time configuration, though this
38526 is not recommended. Often a user called &'exim'& is used, but some sites use
38527 &'mail'& or another user name altogether.
38528
38529 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
38530 abdication; the process cannot regain root afterwards. Prior to release 4.00,
38531 &[seteuid()]& was used in some circumstances, but this is no longer the case.
38532
38533 After a new Exim process has interpreted its command line options, it changes
38534 uid and gid in the following cases:
38535
38536 .ilist
38537 .oindex "&%-C%&"
38538 .oindex "&%-D%&"
38539 If the &%-C%& option is used to specify an alternate configuration file, or if
38540 the &%-D%& option is used to define macro values for the configuration, and the
38541 calling process is not running as root, the uid and gid are changed to those of
38542 the calling process.
38543 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
38544 option may not be used at all.
38545 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
38546 can be supplied if the calling process is running as root, the Exim run-time
38547 user or CONFIGURE_OWNER, if defined.
38548 .next
38549 .oindex "&%-be%&"
38550 .oindex "&%-bf%&"
38551 .oindex "&%-bF%&"
38552 If the expansion test option (&%-be%&) or one of the filter testing options
38553 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
38554 calling process.
38555 .next
38556 If the process is not a daemon process or a queue runner process or a delivery
38557 process or a process for testing address routing (started with &%-bt%&), the
38558 uid and gid are changed to the Exim user and group. This means that Exim always
38559 runs under its own uid and gid when receiving messages. This also applies when
38560 testing address verification
38561 .oindex "&%-bv%&"
38562 .oindex "&%-bh%&"
38563 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
38564 option).
38565 .next
38566 For a daemon, queue runner, delivery, or address testing process, the uid
38567 remains as root at this stage, but the gid is changed to the Exim group.
38568 .endlist
38569
38570 The processes that initially retain root privilege behave as follows:
38571
38572 .ilist
38573 A daemon process changes the gid to the Exim group and the uid to the Exim
38574 user after setting up one or more listening sockets. The &[initgroups()]&
38575 function is called, so that if the Exim user is in any additional groups, they
38576 will be used during message reception.
38577 .next
38578 A queue runner process retains root privilege throughout its execution. Its
38579 job is to fork a controlled sequence of delivery processes.
38580 .next
38581 A delivery process retains root privilege throughout most of its execution,
38582 but any actual deliveries (that is, the transports themselves) are run in
38583 subprocesses which always change to a non-root uid and gid. For local
38584 deliveries this is typically the uid and gid of the owner of the mailbox; for
38585 remote deliveries, the Exim uid and gid are used. Once all the delivery
38586 subprocesses have been run, a delivery process changes to the Exim uid and gid
38587 while doing post-delivery tidying up such as updating the retry database and
38588 generating bounce and warning messages.
38589
38590 While the recipient addresses in a message are being routed, the delivery
38591 process runs as root. However, if a user's filter file has to be processed,
38592 this is done in a subprocess that runs under the individual user's uid and
38593 gid. A system filter is run as root unless &%system_filter_user%& is set.
38594 .next
38595 A process that is testing addresses (the &%-bt%& option) runs as root so that
38596 the routing is done in the same environment as a message delivery.
38597 .endlist
38598
38599
38600
38601
38602 .section "Running Exim without privilege" "SECTrunexiwitpri"
38603 .cindex "privilege, running without"
38604 .cindex "unprivileged running"
38605 .cindex "root privilege" "running without"
38606 Some installations like to run Exim in an unprivileged state for more of its
38607 operation, for added security. Support for this mode of operation is provided
38608 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
38609 gid are changed to the Exim user and group at the start of a delivery process
38610 (and also queue runner and address testing processes). This means that address
38611 routing is no longer run as root, and the deliveries themselves cannot change
38612 to any other uid.
38613
38614 .cindex SIGHUP
38615 .cindex "daemon" "restarting"
38616 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
38617 that the daemon can still be started in the usual way, and it can respond
38618 correctly to SIGHUP because the re-invocation regains root privilege.
38619
38620 An alternative approach is to make Exim setuid to the Exim user and also setgid
38621 to the Exim group. If you do this, the daemon must be started from a root
38622 process. (Calling Exim from a root process makes it behave in the way it does
38623 when it is setuid root.) However, the daemon cannot restart itself after a
38624 SIGHUP signal because it cannot regain privilege.
38625
38626 It is still useful to set &%deliver_drop_privilege%& in this case, because it
38627 stops Exim from trying to re-invoke itself to do a delivery after a message has
38628 been received. Such a re-invocation is a waste of resources because it has no
38629 effect.
38630
38631 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
38632 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
38633 to the Exim user seems a clean approach, but there is one complication:
38634
38635 In this style of operation, Exim is running with the real uid and gid set to
38636 those of the calling process, and the effective uid/gid set to Exim's values.
38637 Ideally, any association with the calling process' uid/gid should be dropped,
38638 that is, the real uid/gid should be reset to the effective values so as to
38639 discard any privileges that the caller may have. While some operating systems
38640 have a function that permits this action for a non-root effective uid, quite a
38641 number of them do not. Because of this lack of standardization, Exim does not
38642 address this problem at this time.
38643
38644 For this reason, the recommended approach for &"mostly unprivileged"& running
38645 is to keep the Exim binary setuid to root, and to set
38646 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
38647 be used in the most straightforward way.
38648
38649 If you configure Exim not to run delivery processes as root, there are a
38650 number of restrictions on what you can do:
38651
38652 .ilist
38653 You can deliver only as the Exim user/group. You should  explicitly use the
38654 &%user%& and &%group%& options to override routers or local transports that
38655 normally deliver as the recipient. This makes sure that configurations that
38656 work in this mode function the same way in normal mode. Any implicit or
38657 explicit specification of another user causes an error.
38658 .next
38659 Use of &_.forward_& files is severely restricted, such that it is usually
38660 not worthwhile to include them in the configuration.
38661 .next
38662 Users who wish to use &_.forward_& would have to make their home directory and
38663 the file itself accessible to the Exim user. Pipe and append-to-file entries,
38664 and their equivalents in Exim filters, cannot be used. While they could be
38665 enabled in the Exim user's name, that would be insecure and not very useful.
38666 .next
38667 Unless the local user mailboxes are all owned by the Exim user (possible in
38668 some POP3 or IMAP-only environments):
38669
38670 .olist
38671 They must be owned by the Exim group and be writeable by that group. This
38672 implies you must set &%mode%& in the appendfile configuration, as well as the
38673 mode of the mailbox files themselves.
38674 .next
38675 You must set &%no_check_owner%&, since most or all of the files will not be
38676 owned by the Exim user.
38677 .next
38678 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
38679 on a newly created mailbox when unprivileged. This also implies that new
38680 mailboxes need to be created manually.
38681 .endlist olist
38682 .endlist ilist
38683
38684
38685 These restrictions severely restrict what can be done in local deliveries.
38686 However, there are no restrictions on remote deliveries. If you are running a
38687 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
38688 gives more security at essentially no cost.
38689
38690 If you are using the &%mua_wrapper%& facility (see chapter
38691 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
38692
38693
38694
38695
38696 .section "Delivering to local files" "SECID271"
38697 Full details of the checks applied by &(appendfile)& before it writes to a file
38698 are given in chapter &<<CHAPappendfile>>&.
38699
38700
38701
38702 .section "Running local commands" "SECTsecconslocalcmds"
38703 .cindex "security" "local commands"
38704 .cindex "security" "command injection attacks"
38705 There are a number of ways in which an administrator can configure Exim to run
38706 commands based upon received, untrustworthy, data. Further, in some
38707 configurations a user who can control a &_.forward_& file can also arrange to
38708 run commands. Configuration to check includes, but is not limited to:
38709
38710 .ilist
38711 Use of &%use_shell%& in the pipe transport: various forms of shell command
38712 injection may be possible with this option present. It is dangerous and should
38713 be used only with considerable caution. Consider constraints which whitelist
38714 allowed characters in a variable which is to be used in a pipe transport that
38715 has &%use_shell%& enabled.
38716 .next
38717 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
38718 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
38719 &_.forward_& files in a redirect router. If Exim is running on a central mail
38720 hub to which ordinary users do not have shell access, but home directories are
38721 NFS mounted (for instance) then administrators should review the list of these
38722 forbid options available, and should bear in mind that the options that may
38723 need forbidding can change as new features are added between releases.
38724 .next
38725 The &%${run...}%& expansion item does not use a shell by default, but
38726 administrators can configure use of &_/bin/sh_& as part of the command.
38727 Such invocations should be viewed with prejudicial suspicion.
38728 .next
38729 Administrators who use embedded Perl are advised to explore how Perl's
38730 taint checking might apply to their usage.
38731 .next
38732 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
38733 administrators are well advised to view its use with suspicion, in case (for
38734 instance) it allows a local-part to contain embedded Exim directives.
38735 .next
38736 Use of &%${match_local_part...}%& and friends becomes more dangerous if
38737 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
38738 each can reference arbitrary lists and files, rather than just being a list
38739 of opaque strings.
38740 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
38741 real-world security vulnerabilities caused by its use with untrustworthy data
38742 injected in, for SQL injection attacks.
38743 Consider the use of the &%inlisti%& expansion condition instead.
38744 .endlist
38745
38746
38747
38748
38749 .section "Trust in configuration data" "SECTsecconfdata"
38750 .cindex "security" "data sources"
38751 .cindex "security" "regular expressions"
38752 .cindex "regular expressions" "security"
38753 .cindex "PCRE" "security"
38754 If configuration data for Exim can come from untrustworthy sources, there
38755 are some issues to be aware of:
38756
38757 .ilist
38758 Use of &%${expand...}%& may provide a path for shell injection attacks.
38759 .next
38760 Letting untrusted data provide a regular expression is unwise.
38761 .next
38762 Using &%${match...}%& to apply a fixed regular expression against untrusted
38763 data may result in pathological behaviour within PCRE.  Be aware of what
38764 "backtracking" means and consider options for being more strict with a regular
38765 expression. Avenues to explore include limiting what can match (avoiding &`.`&
38766 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
38767 possessive quantifiers or just not using regular expressions against untrusted
38768 data.
38769 .next
38770 It can be important to correctly use &%${quote:...}%&,
38771 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
38772 items to ensure that data is correctly constructed.
38773 .next
38774 Some lookups might return multiple results, even though normal usage is only
38775 expected to yield one result.
38776 .endlist
38777
38778
38779
38780
38781 .section "IPv4 source routing" "SECID272"
38782 .cindex "source routing" "in IP packets"
38783 .cindex "IP source routing"
38784 Many operating systems suppress IP source-routed packets in the kernel, but
38785 some cannot be made to do this, so Exim does its own check. It logs incoming
38786 IPv4 source-routed TCP calls, and then drops them. Things are all different in
38787 IPv6. No special checking is currently done.
38788
38789
38790
38791 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
38792 Support for these SMTP commands is disabled by default. If required, they can
38793 be enabled by defining suitable ACLs.
38794
38795
38796
38797
38798 .section "Privileged users" "SECID274"
38799 .cindex "trusted users"
38800 .cindex "admin user"
38801 .cindex "privileged user"
38802 .cindex "user" "trusted"
38803 .cindex "user" "admin"
38804 Exim recognizes two sets of users with special privileges. Trusted users are
38805 able to submit new messages to Exim locally, but supply their own sender
38806 addresses and information about a sending host. For other users submitting
38807 local messages, Exim sets up the sender address from the uid, and doesn't
38808 permit a remote host to be specified.
38809
38810 .oindex "&%-f%&"
38811 However, an untrusted user is permitted to use the &%-f%& command line option
38812 in the special form &%-f <>%& to indicate that a delivery failure for the
38813 message should not cause an error report. This affects the message's envelope,
38814 but it does not affect the &'Sender:'& header. Untrusted users may also be
38815 permitted to use specific forms of address with the &%-f%& option by setting
38816 the &%untrusted_set_sender%& option.
38817
38818 Trusted users are used to run processes that receive mail messages from some
38819 other mail domain and pass them on to Exim for delivery either locally, or over
38820 the Internet. Exim trusts a caller that is running as root, as the Exim user,
38821 as any user listed in the &%trusted_users%& configuration option, or under any
38822 group listed in the &%trusted_groups%& option.
38823
38824 Admin users are permitted to do things to the messages on Exim's queue. They
38825 can freeze or thaw messages, cause them to be returned to their senders, remove
38826 them entirely, or modify them in various ways. In addition, admin users can run
38827 the Exim monitor and see all the information it is capable of providing, which
38828 includes the contents of files on the spool.
38829
38830 .oindex "&%-M%&"
38831 .oindex "&%-q%&"
38832 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
38833 delivery of messages on its queue is restricted to admin users. This
38834 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
38835 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
38836 queue is also restricted to admin users. This restriction can be relaxed by
38837 setting &%no_queue_list_requires_admin%&.
38838
38839 Exim recognizes an admin user if the calling process is running as root or as
38840 the Exim user or if any of the groups associated with the calling process is
38841 the Exim group. It is not necessary actually to be running under the Exim
38842 group. However, if admin users who are not root or the Exim user are to access
38843 the contents of files on the spool via the Exim monitor (which runs
38844 unprivileged), Exim must be built to allow group read access to its spool
38845 files.
38846
38847 By default, regular users are trusted to perform basic testing and
38848 introspection commands, as themselves.  This setting can be tightened by
38849 setting the &%commandline_checks_require_admin%& option.
38850 This affects most of the checking options,
38851 such as &%-be%& and anything else &%-b*%&.
38852
38853
38854 .section "Spool files" "SECID275"
38855 .cindex "spool directory" "files"
38856 Exim's spool directory and everything it contains is owned by the Exim user and
38857 set to the Exim group. The mode for spool files is defined in the
38858 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
38859 any user who is a member of the Exim group can access these files.
38860
38861
38862
38863 .section "Use of argv[0]" "SECID276"
38864 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
38865 of specific strings, Exim assumes certain options. For example, calling Exim
38866 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
38867 to calling it with the option &%-bS%&. There are no security implications in
38868 this.
38869
38870
38871
38872 .section "Use of %f formatting" "SECID277"
38873 The only use made of &"%f"& by Exim is in formatting load average values. These
38874 are actually stored in integer variables as 1000 times the load average.
38875 Consequently, their range is limited and so therefore is the length of the
38876 converted output.
38877
38878
38879
38880 .section "Embedded Exim path" "SECID278"
38881 Exim uses its own path name, which is embedded in the code, only when it needs
38882 to re-exec in order to regain root privilege. Therefore, it is not root when it
38883 does so. If some bug allowed the path to get overwritten, it would lead to an
38884 arbitrary program's being run as exim, not as root.
38885
38886
38887
38888 .section "Dynamic module directory" "SECTdynmoddir"
38889 Any dynamically loadable modules must be installed into the directory
38890 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
38891 loading it.
38892
38893
38894 .section "Use of sprintf()" "SECID279"
38895 .cindex "&[sprintf()]&"
38896 A large number of occurrences of &"sprintf"& in the code are actually calls to
38897 &'string_sprintf()'&, a function that returns the result in malloc'd store.
38898 The intermediate formatting is done into a large fixed buffer by a function
38899 that runs through the format string itself, and checks the length of each
38900 conversion before performing it, thus preventing buffer overruns.
38901
38902 The remaining uses of &[sprintf()]& happen in controlled circumstances where
38903 the output buffer is known to be sufficiently long to contain the converted
38904 string.
38905
38906
38907
38908 .section "Use of debug_printf() and log_write()" "SECID280"
38909 Arbitrary strings are passed to both these functions, but they do their
38910 formatting by calling the function &'string_vformat()'&, which runs through
38911 the format string itself, and checks the length of each conversion.
38912
38913
38914
38915 .section "Use of strcat() and strcpy()" "SECID281"
38916 These are used only in cases where the output buffer is known to be large
38917 enough to hold the result.
38918 .ecindex IIDsecurcon
38919
38920
38921
38922
38923 . ////////////////////////////////////////////////////////////////////////////
38924 . ////////////////////////////////////////////////////////////////////////////
38925
38926 .chapter "Format of spool files" "CHAPspool"
38927 .scindex IIDforspo1 "format" "spool files"
38928 .scindex IIDforspo2 "spool directory" "format of files"
38929 .scindex IIDforspo3 "spool files" "format of"
38930 .cindex "spool files" "editing"
38931 A message on Exim's queue consists of two files, whose names are the message id
38932 followed by -D and -H, respectively. The data portion of the message is kept in
38933 the -D file on its own. The message's envelope, status, and headers are all
38934 kept in the -H file, whose format is described in this chapter. Each of these
38935 two files contains the final component of its own name as its first line. This
38936 is insurance against disk crashes where the directory is lost but the files
38937 themselves are recoverable.
38938
38939 .new
38940 The file formats may be changed, or new formats added, at any release.
38941 Spool files are not intended as an interface to other programs
38942 and should not be used as such.
38943 .wen
38944
38945 Some people are tempted into editing -D files in order to modify messages. You
38946 need to be extremely careful if you do this; it is not recommended and you are
38947 on your own if you do it. Here are some of the pitfalls:
38948
38949 .ilist
38950 You must ensure that Exim does not try to deliver the message while you are
38951 fiddling with it. The safest way is to take out a write lock on the -D file,
38952 which is what Exim itself does, using &[fcntl()]&. If you update the file in
38953 place, the lock will be retained. If you write a new file and rename it, the
38954 lock will be lost at the instant of rename.
38955 .next
38956 .vindex "&$body_linecount$&"
38957 If you change the number of lines in the file, the value of
38958 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
38959 cause incomplete transmission of messages or undeliverable messages.
38960 .next
38961 If the message is in MIME format, you must take care not to break it.
38962 .next
38963 If the message is cryptographically signed, any change will invalidate the
38964 signature.
38965 .endlist
38966 All in all, modifying -D files is fraught with danger.
38967
38968 Files whose names end with -J may also be seen in the &_input_& directory (or
38969 its subdirectories when &%split_spool_directory%& is set). These are journal
38970 files, used to record addresses to which the message has been delivered during
38971 the course of a delivery attempt. If there are still undelivered recipients at
38972 the end, the -H file is updated, and the -J file is deleted. If, however, there
38973 is some kind of crash (for example, a power outage) before this happens, the -J
38974 file remains in existence. When Exim next processes the message, it notices the
38975 -J file and uses it to update the -H file before starting the next delivery
38976 attempt.
38977
38978 Files whose names end with -K or .eml may also be seen in the spool.
38979 These are temporaries used for DKIM or malware processing, when that is used.
38980 They should be tidied up by normal operations; any old ones are probably
38981 relics of crashes and can be removed.
38982
38983 .section "Format of the -H file" "SECID282"
38984 .cindex "uid (user id)" "in spool file"
38985 .cindex "gid (group id)" "in spool file"
38986 The second line of the -H file contains the login name for the uid of the
38987 process that called Exim to read the message, followed by the numerical uid and
38988 gid. For a locally generated message, this is normally the user who sent the
38989 message. For a message received over TCP/IP via the daemon, it is
38990 normally the Exim user.
38991
38992 The third line of the file contains the address of the message's sender as
38993 transmitted in the envelope, contained in angle brackets. The sender address is
38994 empty for bounce messages. For incoming SMTP mail, the sender address is given
38995 in the MAIL command. For locally generated mail, the sender address is
38996 created by Exim from the login name of the current user and the configured
38997 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
38998 leading &"From&~"& line if the caller is trusted, or if the supplied address is
38999 &"<>"& or an address that matches &%untrusted_set_senders%&.
39000
39001 The fourth line contains two numbers. The first is the time that the message
39002 was received, in the conventional Unix form &-- the number of seconds since the
39003 start of the epoch. The second number is a count of the number of messages
39004 warning of delayed delivery that have been sent to the sender.
39005
39006 There follow a number of lines starting with a hyphen. These can appear in any
39007 order, and are omitted when not relevant:
39008
39009 .vlist
39010 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39011 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39012 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39013 recognized, to provide backward compatibility. In the old format, a line of
39014 this form is present for every ACL variable that is not empty. The number
39015 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39016 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39017 the data string for the variable. The string itself starts at the beginning of
39018 the next line, and is followed by a newline character. It may contain internal
39019 newlines.
39020
39021 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39022 A line of this form is present for every ACL connection variable that is
39023 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39024 The length is the length of the data string for the variable. The string itself
39025 starts at the beginning of the next line, and is followed by a newline
39026 character. It may contain internal newlines.
39027
39028 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39029 A line of this form is present for every ACL message variable that is defined.
39030 Note that there is a space between &%-aclm%& and the rest of the name. The
39031 length is the length of the data string for the variable. The string itself
39032 starts at the beginning of the next line, and is followed by a newline
39033 character. It may contain internal newlines.
39034
39035 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39036 This is present if, when the message was received over SMTP, the value of
39037 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39038
39039 .vitem &%-allow_unqualified_recipient%&
39040 This is present if unqualified recipient addresses are permitted in header
39041 lines (to stop such addresses from being qualified if rewriting occurs at
39042 transport time). Local messages that were input using &%-bnq%& and remote
39043 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39044
39045 .vitem &%-allow_unqualified_sender%&
39046 This is present if unqualified sender addresses are permitted in header lines
39047 (to stop such addresses from being qualified if rewriting occurs at transport
39048 time). Local messages that were input using &%-bnq%& and remote messages from
39049 hosts that match &%sender_unqualified_hosts%& set this flag.
39050
39051 .vitem "&%-auth_id%&&~<&'text'&>"
39052 The id information for a message received on an authenticated SMTP connection
39053 &-- the value of the &$authenticated_id$& variable.
39054
39055 .vitem "&%-auth_sender%&&~<&'address'&>"
39056 The address of an authenticated sender &-- the value of the
39057 &$authenticated_sender$& variable.
39058
39059 .vitem "&%-body_linecount%&&~<&'number'&>"
39060 This records the number of lines in the body of the message, and is
39061 present unless &%-spool_file_wireformat%& is.
39062
39063 .vitem "&%-body_zerocount%&&~<&'number'&>"
39064 This records the number of binary zero bytes in the body of the message, and is
39065 present if the number is greater than zero.
39066
39067 .vitem &%-deliver_firsttime%&
39068 This is written when a new message is first added to the spool. When the spool
39069 file is updated after a deferral, it is omitted.
39070
39071 .vitem "&%-frozen%&&~<&'time'&>"
39072 .cindex "frozen messages" "spool data"
39073 The message is frozen, and the freezing happened at <&'time'&>.
39074
39075 .vitem "&%-helo_name%&&~<&'text'&>"
39076 This records the host name as specified by a remote host in a HELO or EHLO
39077 command.
39078
39079 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39080 This records the IP address of the host from which the message was received and
39081 the remote port number that was used. It is omitted for locally generated
39082 messages.
39083
39084 .vitem "&%-host_auth%&&~<&'text'&>"
39085 If the message was received on an authenticated SMTP connection, this records
39086 the name of the authenticator &-- the value of the
39087 &$sender_host_authenticated$& variable.
39088
39089 .vitem &%-host_lookup_failed%&
39090 This is present if an attempt to look up the sending host's name from its IP
39091 address failed. It corresponds to the &$host_lookup_failed$& variable.
39092
39093 .vitem "&%-host_name%&&~<&'text'&>"
39094 .cindex "reverse DNS lookup"
39095 .cindex "DNS" "reverse lookup"
39096 This records the name of the remote host from which the message was received,
39097 if the host name was looked up from the IP address when the message was being
39098 received. It is not present if no reverse lookup was done.
39099
39100 .vitem "&%-ident%&&~<&'text'&>"
39101 For locally submitted messages, this records the login of the originating user,
39102 unless it was a trusted user and the &%-oMt%& option was used to specify an
39103 ident value. For messages received over TCP/IP, this records the ident string
39104 supplied by the remote host, if any.
39105
39106 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39107 This records the IP address of the local interface and the port number through
39108 which a message was received from a remote host. It is omitted for locally
39109 generated messages.
39110
39111 .vitem &%-local%&
39112 The message is from a local sender.
39113
39114 .vitem &%-localerror%&
39115 The message is a locally-generated bounce message.
39116
39117 .vitem "&%-local_scan%&&~<&'string'&>"
39118 This records the data string that was returned by the &[local_scan()]& function
39119 when the message was received &-- the value of the &$local_scan_data$&
39120 variable. It is omitted if no data was returned.
39121
39122 .vitem &%-manual_thaw%&
39123 The message was frozen but has been thawed manually, that is, by an explicit
39124 Exim command rather than via the auto-thaw process.
39125
39126 .vitem &%-N%&
39127 A testing delivery process was started using the &%-N%& option to suppress any
39128 actual deliveries, but delivery was deferred. At any further delivery attempts,
39129 &%-N%& is assumed.
39130
39131 .vitem &%-received_protocol%&
39132 This records the value of the &$received_protocol$& variable, which contains
39133 the name of the protocol by which the message was received.
39134
39135 .vitem &%-sender_set_untrusted%&
39136 The envelope sender of this message was set by an untrusted local caller (used
39137 to ensure that the caller is displayed in queue listings).
39138
39139 .vitem "&%-spam_score_int%&&~<&'number'&>"
39140 If a message was scanned by SpamAssassin, this is present. It records the value
39141 of &$spam_score_int$&.
39142
39143 .vitem &%-spool_file_wireformat%&
39144 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39145 rather than Unix-format.
39146 The line-ending is CRLF rather than newline.
39147 There is still, however, no leading-dot-stuffing.
39148
39149 .vitem &%-tls_certificate_verified%&
39150 A TLS certificate was received from the client that sent this message, and the
39151 certificate was verified by the server.
39152
39153 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39154 When the message was received over an encrypted connection, this records the
39155 name of the cipher suite that was used.
39156
39157 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39158 When the message was received over an encrypted connection, and a certificate
39159 was received from the client, this records the Distinguished Name from that
39160 certificate.
39161 .endlist
39162
39163 Following the options there is a list of those addresses to which the message
39164 is not to be delivered. This set of addresses is initialized from the command
39165 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39166 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39167 the address is added to this set. The addresses are kept internally as a
39168 balanced binary tree, and it is a representation of that tree which is written
39169 to the spool file. If an address is expanded via an alias or forward file, the
39170 original address is added to the tree when deliveries to all its child
39171 addresses are complete.
39172
39173 If the tree is empty, there is a single line in the spool file containing just
39174 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39175 Y or N, followed by an address. The address is the value for the node of the
39176 tree, and the letters indicate whether the node has a left branch and/or a
39177 right branch attached to it, respectively. If branches exist, they immediately
39178 follow. Here is an example of a three-node tree:
39179 .code
39180 YY darcy@austen.fict.example
39181 NN alice@wonderland.fict.example
39182 NN editor@thesaurus.ref.example
39183 .endd
39184 After the non-recipients tree, there is a list of the message's recipients.
39185 This is a simple list, preceded by a count. It includes all the original
39186 recipients of the message, including those to whom the message has already been
39187 delivered. In the simplest case, the list contains one address per line. For
39188 example:
39189 .code
39190 4
39191 editor@thesaurus.ref.example
39192 darcy@austen.fict.example
39193 rdo@foundation
39194 alice@wonderland.fict.example
39195 .endd
39196 However, when a child address has been added to the top-level addresses as a
39197 result of the use of the &%one_time%& option on a &(redirect)& router, each
39198 line is of the following form:
39199 .display
39200 <&'top-level address'&> <&'errors_to address'&> &&&
39201   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39202 .endd
39203 The 01 flag bit indicates the presence of the three other fields that follow
39204 the top-level address. Other bits may be used in future to support additional
39205 fields. The <&'parent number'&> is the offset in the recipients list of the
39206 original parent of the &"one time"& address. The first two fields are the
39207 envelope sender that is associated with this address and its length. If the
39208 length is zero, there is no special envelope sender (there are then two space
39209 characters in the line). A non-empty field can arise from a &(redirect)& router
39210 that has an &%errors_to%& setting.
39211
39212
39213 A blank line separates the envelope and status information from the headers
39214 which follow. A header may occupy several lines of the file, and to save effort
39215 when reading it in, each header is preceded by a number and an identifying
39216 character. The number is the number of characters in the header, including any
39217 embedded newlines and the terminating newline. The character is one of the
39218 following:
39219
39220 .table2 50pt
39221 .row <&'blank'&>         "header in which Exim has no special interest"
39222 .row &`B`&               "&'Bcc:'& header"
39223 .row &`C`&               "&'Cc:'& header"
39224 .row &`F`&               "&'From:'& header"
39225 .row &`I`&               "&'Message-id:'& header"
39226 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39227 .row &`R`&               "&'Reply-To:'& header"
39228 .row &`S`&               "&'Sender:'& header"
39229 .row &`T`&               "&'To:'& header"
39230 .row &`*`&               "replaced or deleted header"
39231 .endtable
39232
39233 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39234 purposes. They are not transmitted when the message is delivered. Here is a
39235 typical set of headers:
39236 .code
39237 111P Received: by hobbit.fict.example with local (Exim 4.00)
39238 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39239 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39240 038* X-rewrote-sender: bb@hobbit.fict.example
39241 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39242 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39243 099* To: alice@wonderland.fict.example, rdo@foundation,
39244 darcy@austen.fict.example, editor@thesaurus.ref.example
39245 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39246 darcy@austen.fict.example, editor@thesaurus.ref.example
39247 038  Date: Fri, 11 May 2001 10:28:59 +0100
39248 .endd
39249 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39250 &'To:'& header have been rewritten, the last one because routing expanded the
39251 unqualified domain &'foundation'&.
39252 .ecindex IIDforspo1
39253 .ecindex IIDforspo2
39254 .ecindex IIDforspo3
39255
39256 .section "Format of the -D file" "SECID282a"
39257 The data file is traditionally in Unix-standard format: lines are ended with
39258 an ASCII newline character.
39259 However, when the &%spool_wireformat%& main option is used some -D files
39260 can have an alternate format.
39261 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39262 The -D file lines (not including the first name-component line) are
39263 suitable for direct copying to the wire when transmitting using the
39264 ESMTP CHUNKING option, meaning lower processing overhead.
39265 Lines are terminated with an ASCII CRLF pair.
39266 There is no dot-stuffing (and no dot-termination).
39267
39268 . ////////////////////////////////////////////////////////////////////////////
39269 . ////////////////////////////////////////////////////////////////////////////
39270
39271 .chapter "DKIM and SPF" "CHAPdkim" &&&
39272          "DKIM and SPF Support"
39273 .cindex "DKIM"
39274
39275 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39276
39277 DKIM is a mechanism by which messages sent by some entity can be provably
39278 linked to a domain which that entity controls.  It permits reputation to
39279 be tracked on a per-domain basis, rather than merely upon source IP address.
39280 DKIM is documented in RFC 6376.
39281
39282 As DKIM relies on the message being unchanged in transit, messages handled
39283 by a mailing-list (which traditionally adds to the message) will not match
39284 any original DKIM signature.
39285
39286 DKIM support is compiled into Exim by default if TLS support is present.
39287 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39288
39289 Exim's DKIM implementation allows for
39290 .olist
39291 Signing outgoing messages: This function is implemented in the SMTP transport.
39292 It can co-exist with all other Exim features
39293 (including transport filters)
39294 except cutthrough delivery.
39295 .next
39296 Verifying signatures in incoming messages: This is implemented by an additional
39297 ACL (acl_smtp_dkim), which can be called several times per message, with
39298 different signature contexts.
39299 .endlist
39300
39301 In typical Exim style, the verification implementation does not include any
39302 default "policy". Instead it enables you to build your own policy using
39303 Exim's standard controls.
39304
39305 Please note that verification of DKIM signatures in incoming mail is turned
39306 on by default for logging (in the <= line) purposes.
39307
39308 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39309 When set, for each signature in incoming email,
39310 exim will log a line displaying the most important signature details, and the
39311 signature status. Here is an example (with line-breaks added for clarity):
39312 .code
39313 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39314     d=facebookmail.com s=q1-2009b
39315     c=relaxed/relaxed a=rsa-sha1
39316     i=@facebookmail.com t=1252484542 [verification succeeded]
39317 .endd
39318
39319 You might want to turn off DKIM verification processing entirely for internal
39320 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39321 control modifier. This should typically be done in the RCPT ACL, at points
39322 where you accept mail from relay sources (internal hosts or authenticated
39323 senders).
39324
39325
39326 .section "Signing outgoing messages" "SECDKIMSIGN"
39327 .cindex "DKIM" "signing"
39328
39329 For signing to be usable you must have published a DKIM record in DNS.
39330 Note that RFC 8301 says:
39331 .code
39332 rsa-sha1 MUST NOT be used for signing or verifying.
39333
39334 Signers MUST use RSA keys of at least 1024 bits for all keys.
39335 Signers SHOULD use RSA keys of at least 2048 bits.
39336 .endd
39337
39338 Note also that the key content (the 'p=' field)
39339 in the DNS record is different between RSA and EC keys;
39340 for the former it is the base64 of the ASN.1 for the RSA public key
39341 (equivalent to the private-key .pem with the header/trailer stripped)
39342 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39343
39344 Signing is enabled by setting private options on the SMTP transport.
39345 These options take (expandable) strings as arguments.
39346
39347 .option dkim_domain smtp string list&!! unset
39348 The domain(s) you want to sign with.
39349 After expansion, this can be a list.
39350 Each element in turn is put into the &%$dkim_domain%& expansion variable
39351 while expanding the remaining signing options.
39352 If it is empty after expansion, DKIM signing is not done,
39353 and no error will result even if &%dkim_strict%& is set.
39354
39355 .option dkim_selector smtp string list&!! unset
39356 This sets the key selector string.
39357 After expansion, which can use &$dkim_domain$&, this can be a list.
39358 Each element in turn is put in the expansion
39359 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39360 option along with &%$dkim_domain%&.
39361 If the option is empty after expansion, DKIM signing is not done for this domain,
39362 and no error will result even if &%dkim_strict%& is set.
39363
39364 .option dkim_private_key smtp string&!! unset
39365 This sets the private key to use.
39366 You can use the &%$dkim_domain%& and
39367 &%$dkim_selector%& expansion variables to determine the private key to use.
39368 The result can either
39369 .ilist
39370 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39371 .next
39372 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39373 be a valid Ed25519 private key (same format as above)
39374 .next
39375 start with a slash, in which case it is treated as a file that contains
39376 the private key
39377 .next
39378 be "0", "false" or the empty string, in which case the message will not
39379 be signed. This case will not result in an error, even if &%dkim_strict%&
39380 is set.
39381 .endlist
39382
39383 To generate keys under OpenSSL:
39384 .code
39385 openssl genrsa -out dkim_rsa.private 2048
39386 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39387 .endd
39388 Take the base-64 lines from the output of the second command, concatenated,
39389 for the DNS TXT record.
39390 See section 3.6 of RFC6376 for the record specification.
39391
39392 Under GnuTLS:
39393 .code
39394 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39395 certtool --load-privkey=dkim_rsa.private --pubkey-info
39396 .endd
39397
39398 Note that RFC 8301 says:
39399 .code
39400 Signers MUST use RSA keys of at least 1024 bits for all keys.
39401 Signers SHOULD use RSA keys of at least 2048 bits.
39402 .endd
39403
39404 Support for EC keys is being developed under
39405 &url(https://datatracker.ietf.org/doc/draft-ietf-dcrup-dkim-crypto/).
39406 They are considerably smaller than RSA keys for equivalent protection.
39407 As they are a recent development, users should consider dual-signing
39408 (by setting a list of selectors, and an expansion for this option)
39409 for some transition period.
39410 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39411 for EC keys.
39412
39413 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39414 .code
39415 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39416 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39417 .endd
39418
39419 To produce the required public key value for a DNS record:
39420 .code
39421 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39422 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39423 .endd
39424
39425 Note that the format
39426 of Ed25519 keys in DNS has not yet been decided; this release supports
39427 both of the leading candidates at this time, a future release will
39428 probably drop support for whichever proposal loses.
39429
39430 .option dkim_hash smtp string&!! sha256
39431 Can be set to any one of the supported hash methods, which are:
39432 .ilist
39433 &`sha1`& &-- should not be used, is old and insecure
39434 .next
39435 &`sha256`& &-- the default
39436 .next
39437 &`sha512`& &-- possibly more secure but less well supported
39438 .endlist
39439
39440 Note that RFC 8301 says:
39441 .code
39442 rsa-sha1 MUST NOT be used for signing or verifying.
39443 .endd
39444
39445 .option dkim_identity smtp string&!! unset
39446 If set after expansion, the value is used to set an "i=" tag in
39447 the signing header.  The DKIM standards restrict the permissible
39448 syntax of this optional tag to a mail address, with possibly-empty
39449 local part, an @, and a domain identical to or subdomain of the "d="
39450 tag value.  Note that Exim does not check the value.
39451
39452 .option dkim_canon smtp string&!! unset
39453 This option sets the canonicalization method used when signing a message.
39454 The DKIM RFC currently supports two methods: "simple" and "relaxed".
39455 The option defaults to "relaxed" when unset. Note: the current implementation
39456 only supports signing with the same canonicalization method for both headers and body.
39457
39458 .option dkim_strict smtp string&!! unset
39459 This  option  defines  how  Exim  behaves  when  signing a message that
39460 should be signed fails for some reason.  When the expansion evaluates to
39461 either "1" or "true", Exim will defer. Otherwise Exim will send the message
39462 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
39463 variables here.
39464
39465 .option dkim_sign_headers smtp string&!! "see below"
39466 If set, this option must expand to a colon-separated
39467 list of header names.
39468 Headers with these names, or the absence or such a header, will be included
39469 in the message signature.
39470 When unspecified, the header names listed in RFC4871 will be used,
39471 whether or not each header is present in the message.
39472 The default list is available for the expansion in the macro
39473 "_DKIM_SIGN_HEADERS".
39474
39475 If a name is repeated, multiple headers by that name (or the absence thereof)
39476 will be signed.  The textually later headers in the headers part of the
39477 message are signed first, if there are multiples.
39478
39479 A name can be prefixed with either an '=' or a '+' character.
39480 If an '=' prefix is used, all headers that are present with this name
39481 will be signed.
39482 If a '+' prefix if used, all headers that are present with this name
39483 will be signed, and one signature added for a missing header with the
39484 name will be appended.
39485
39486 .new
39487 .option dkim_timestamps smtp integer&!! unset
39488 This option controls the inclusion of timestamp information in the signature.
39489 If not set, no such information will be included.
39490 Otherwise, must be an unsigned number giving an offset in seconds from the current time
39491 for the expiry tag
39492 (eg. 1209600 for two weeks);
39493 both creation (t=) and expiry (x=) tags will be included.
39494
39495 RFC 6376 lists these tags as RECOMMENDED.
39496 .wen
39497
39498
39499 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
39500 .cindex "DKIM" "verification"
39501
39502 .new
39503 Verification of DKIM signatures in SMTP incoming email is done for all
39504 messages for which an ACL control &%dkim_disable_verify%& has not been set.
39505 .cindex authentication "expansion item"
39506 Performing verification sets up information used by the
39507 &$authresults$& expansion item.
39508 .wen
39509
39510 .new The results of that verification are then made available to the
39511 &%acl_smtp_dkim%& ACL, &new(which can examine and modify them).
39512 By default, this ACL is called once for each
39513 syntactically(!) correct signature in the incoming message.
39514 A missing ACL definition defaults to accept.
39515 If any ACL call does not accept, the message is not accepted.
39516 If a cutthrough delivery was in progress for the message, that is
39517 summarily dropped (having wasted the transmission effort).
39518
39519 To evaluate the &new(verification result) in the ACL
39520 a large number of expansion variables
39521 containing the signature status and its details are set up during the
39522 runtime of the ACL.
39523
39524 Calling the ACL only for existing signatures is not sufficient to build
39525 more advanced policies. For that reason, the global option
39526 &%dkim_verify_signers%&, and a global expansion variable
39527 &%$dkim_signers%& exist.
39528
39529 The global option &%dkim_verify_signers%& can be set to a colon-separated
39530 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
39531 called. It is expanded when the message has been received. At this point,
39532 the expansion variable &%$dkim_signers%& already contains a colon-separated
39533 list of signer domains and identities for the message. When
39534 &%dkim_verify_signers%& is not specified in the main configuration,
39535 it defaults as:
39536 .code
39537 dkim_verify_signers = $dkim_signers
39538 .endd
39539 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
39540 DKIM signature in the message. Current DKIM verifiers may want to explicitly
39541 call the ACL for known domains or identities. This would be achieved as follows:
39542 .code
39543 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
39544 .endd
39545 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
39546 and "ebay.com", plus all domains and identities that have signatures in the message.
39547 You can also be more creative in constructing your policy. For example:
39548 .code
39549 dkim_verify_signers = $sender_address_domain:$dkim_signers
39550 .endd
39551
39552 If a domain or identity is listed several times in the (expanded) value of
39553 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
39554
39555 If multiple signatures match a domain (or identity), the ACL is called once
39556 for each matching signature.
39557
39558
39559 Inside the &%acl_smtp_dkim%&, the following expansion variables are
39560 available (from most to least important):
39561
39562
39563 .vlist
39564 .vitem &%$dkim_cur_signer%&
39565 The signer that is being evaluated in this ACL run. This can be a domain or
39566 an identity. This is one of the list items from the expanded main option
39567 &%dkim_verify_signers%& (see above).
39568
39569 .vitem &%$dkim_verify_status%&
39570 Within the DKIM ACL,
39571 a string describing the general status of the signature. One of
39572 .ilist
39573 &%none%&: There is no signature in the message for the current domain or
39574 identity (as reflected by &%$dkim_cur_signer%&).
39575 .next
39576 &%invalid%&: The signature could not be verified due to a processing error.
39577 More detail is available in &%$dkim_verify_reason%&.
39578 .next
39579 &%fail%&: Verification of the signature failed.  More detail is
39580 available in &%$dkim_verify_reason%&.
39581 .next
39582 &%pass%&: The signature passed verification. It is valid.
39583 .endlist
39584
39585 This variable can be overwritten using an ACL 'set' modifier.
39586 This might, for instance, be done to enforce a policy restriction on
39587 hash-method or key-size:
39588 .code
39589   warn condition       = ${if eq {$dkim_verify_status}{pass}}
39590        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
39591        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
39592                                   {< {$dkim_key_length}{1024}}}}
39593        logwrite        = NOTE: forcing DKIM verify fail (was pass)
39594        set dkim_verify_status = fail
39595        set dkim_verify_reason = hash too weak or key too short
39596 .endd
39597
39598 So long as a DKIM ACL is defined (it need do no more than accept),
39599 after all the DKIM ACL runs have completed, the value becomes a
39600 colon-separated list of the values after each run.
39601 This is maintained for the mime, prdr and data ACLs.
39602
39603 .vitem &%$dkim_verify_reason%&
39604 A string giving a little bit more detail when &%$dkim_verify_status%& is either
39605 "fail" or "invalid". One of
39606 .ilist
39607 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
39608 key for the domain could not be retrieved. This may be a temporary problem.
39609 .next
39610 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
39611 record for the domain is syntactically invalid.
39612 .next
39613 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
39614 body hash does not match the one specified in the signature header. This
39615 means that the message body was modified in transit.
39616 .next
39617 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
39618 could not be verified. This may mean that headers were modified,
39619 re-written or otherwise changed in a way which is incompatible with
39620 DKIM verification. It may of course also mean that the signature is forged.
39621 .endlist
39622
39623 This variable can be overwritten, with any value, using an ACL 'set' modifier.
39624
39625 .vitem &%$dkim_domain%&
39626 The signing domain. IMPORTANT: This variable is only populated if there is
39627 an actual signature in the message for the current domain or identity (as
39628 reflected by &%$dkim_cur_signer%&).
39629
39630 .vitem &%$dkim_identity%&
39631 The signing identity, if present. IMPORTANT: This variable is only populated
39632 if there is an actual signature in the message for the current domain or
39633 identity (as reflected by &%$dkim_cur_signer%&).
39634
39635 .vitem &%$dkim_selector%&
39636 The key record selector string.
39637
39638 .vitem &%$dkim_algo%&
39639 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
39640 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39641 may also be 'ed25519-sha256'.
39642 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39643 for EC keys.
39644
39645 Note that RFC 8301 says:
39646 .code
39647 rsa-sha1 MUST NOT be used for signing or verifying.
39648
39649 DKIM signatures identified as having been signed with historic
39650 algorithms (currently, rsa-sha1) have permanently failed evaluation
39651 .endd
39652
39653 To enforce this you must have a DKIM ACL which checks this variable
39654 and overwrites the &$dkim_verify_status$& variable as discussed above.
39655
39656 .vitem &%$dkim_canon_body%&
39657 The body canonicalization method. One of 'relaxed' or 'simple'.
39658
39659 .vitem &%$dkim_canon_headers%&
39660 The header canonicalization method. One of 'relaxed' or 'simple'.
39661
39662 .vitem &%$dkim_copiedheaders%&
39663 A transcript of headers and their values which are included in the signature
39664 (copied from the 'z=' tag of the signature).
39665 Note that RFC6376 requires that verification fail if the From: header is
39666 not included in the signature.  Exim does not enforce this; sites wishing
39667 strict enforcement should code the check explicitly.
39668
39669 .vitem &%$dkim_bodylength%&
39670 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
39671 limit was set by the signer, "9999999999999" is returned. This makes sure
39672 that this variable always expands to an integer value.
39673 .new
39674 &*Note:*& The presence of the signature tag specifying a signing body length
39675 is one possible route to spoofing of valid DKIM signatures.
39676 A paranoid implementation might wish to regard signature where this variable
39677 shows less than the "no limit" return as being invalid.
39678 .wen
39679
39680 .vitem &%$dkim_created%&
39681 UNIX timestamp reflecting the date and time when the signature was created.
39682 When this was not specified by the signer, "0" is returned.
39683
39684 .vitem &%$dkim_expires%&
39685 UNIX timestamp reflecting the date and time when the signer wants the
39686 signature to be treated as "expired". When this was not specified by the
39687 signer, "9999999999999" is returned. This makes it possible to do useful
39688 integer size comparisons against this value.
39689 Note that Exim does not check this value.
39690
39691 .vitem &%$dkim_headernames%&
39692 A colon-separated list of names of headers included in the signature.
39693
39694 .vitem &%$dkim_key_testing%&
39695 "1" if the key record has the "testing" flag set, "0" if not.
39696
39697 .vitem &%$dkim_key_nosubdomains%&
39698 "1" if the key record forbids subdomaining, "0" otherwise.
39699
39700 .vitem &%$dkim_key_srvtype%&
39701 Service type (tag s=) from the key record. Defaults to "*" if not specified
39702 in the key record.
39703
39704 .vitem &%$dkim_key_granularity%&
39705 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
39706 in the key record.
39707
39708 .vitem &%$dkim_key_notes%&
39709 Notes from the key record (tag n=).
39710
39711 .vitem &%$dkim_key_length%&
39712 Number of bits in the key.
39713
39714 Note that RFC 8301 says:
39715 .code
39716 Verifiers MUST NOT consider signatures using RSA keys of
39717 less than 1024 bits as valid signatures.
39718 .endd
39719
39720 To enforce this you must have a DKIM ACL which checks this variable
39721 and overwrites the &$dkim_verify_status$& variable as discussed above.
39722 As EC keys are much smaller, the check should only do this for RSA keys.
39723
39724 .endlist
39725
39726 In addition, two ACL conditions are provided:
39727
39728 .vlist
39729 .vitem &%dkim_signers%&
39730 ACL condition that checks a colon-separated list of domains or identities
39731 for a match against the domain or identity that the ACL is currently verifying
39732 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
39733 verb to a group of domains or identities. For example:
39734
39735 .code
39736 # Warn when Mail purportedly from GMail has no gmail signature
39737 warn log_message = GMail sender without gmail.com DKIM signature
39738      sender_domains = gmail.com
39739      dkim_signers = gmail.com
39740      dkim_status = none
39741 .endd
39742
39743 Note that the above does not check for a total lack of DKIM signing;
39744 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
39745
39746 .vitem &%dkim_status%&
39747 ACL condition that checks a colon-separated list of possible DKIM verification
39748 results against the actual result of verification. This is typically used
39749 to restrict an ACL verb to a list of verification outcomes, for example:
39750
39751 .code
39752 deny message = Mail from Paypal with invalid/missing signature
39753      sender_domains = paypal.com:paypal.de
39754      dkim_signers = paypal.com:paypal.de
39755      dkim_status = none:invalid:fail
39756 .endd
39757
39758 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
39759 see the documentation of the &%$dkim_verify_status%& expansion variable above
39760 for more information of what they mean.
39761 .endlist
39762
39763
39764
39765
39766 .section "SPF (Sender Policy Framework)" SECSPF
39767 .cindex SPF verification
39768
39769 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
39770 messages with its domain in the envelope from, documented by RFC 7208.
39771 For more information on SPF see &url(http://www.openspf.org).
39772 . --- 2018-09-07: still not https
39773
39774 Messages sent by a system not authorised will fail checking of such assertions.
39775 This includes retransmissions done by traditional forwarders.
39776
39777 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
39778 &_Local/Makefile_&.  The support uses the &_libspf2_& library
39779 &url(https://www.libspf2.org/).
39780 There is no Exim involvement in the transmission of messages;
39781 publishing certain DNS records is all that is required.
39782
39783 For verification, an ACL condition and an expansion lookup are provided.
39784 .cindex authentication "expansion item"
39785 Performing verification sets up information used by the
39786 &$authresults$& expansion item.
39787
39788
39789 .cindex SPF "ACL condition"
39790 .cindex ACL "spf condition"
39791 The ACL condition "spf" can be used at or after the MAIL ACL.
39792 It takes as an argument a list of strings giving the outcome of the SPF check,
39793 and will succeed for any matching outcome.
39794 Valid strings are:
39795 .vlist
39796 .vitem &%pass%&
39797 The SPF check passed, the sending host is positively verified by SPF.
39798
39799 .vitem &%fail%&
39800 The SPF check failed, the sending host is NOT allowed to send mail for the
39801 domain in the envelope-from address.
39802
39803 .vitem &%softfail%&
39804 The SPF check failed, but the queried domain can't absolutely confirm that this
39805 is a forgery.
39806
39807 .vitem &%none%&
39808 The queried domain does not publish SPF records.
39809
39810 .vitem &%neutral%&
39811 The SPF check returned a "neutral" state.  This means the queried domain has
39812 published a SPF record, but wants to allow outside servers to send mail under
39813 its domain as well.  This should be treated like "none".
39814
39815 .vitem &%permerror%&
39816 This indicates a syntax error in the SPF record of the queried domain.
39817 You may deny messages when this occurs.
39818
39819 .vitem &%temperror%&
39820 This indicates a temporary error during all processing, including Exim's
39821 SPF processing.  You may defer messages when this occurs.
39822 .endlist
39823
39824 You can prefix each string with an exclamation mark to  invert
39825 its meaning,  for example  "!fail" will  match all  results but
39826 "fail".  The  string  list is  evaluated  left-to-right,  in a
39827 short-circuit fashion.
39828
39829 Example:
39830 .code
39831 deny spf = fail
39832      message = $sender_host_address is not allowed to send mail from \
39833                ${if def:sender_address_domain \
39834                     {$sender_address_domain}{$sender_helo_name}}.  \
39835                Please see http://www.openspf.org/Why?scope=\
39836                ${if def:sender_address_domain {mfrom}{helo}};\
39837                identity=${if def:sender_address_domain \
39838                              {$sender_address}{$sender_helo_name}};\
39839                ip=$sender_host_address
39840 .endd
39841
39842 When the spf condition has run, it sets up several expansion
39843 variables:
39844
39845 .cindex SPF "verification variables"
39846 .vlist
39847 .vitem &$spf_header_comment$&
39848 .vindex &$spf_header_comment$&
39849   This contains a human-readable string describing the outcome
39850   of the SPF check. You can add it to a custom header or use
39851   it for logging purposes.
39852
39853 .vitem &$spf_received$&
39854 .vindex &$spf_received$&
39855   This contains a complete Received-SPF: header that can be
39856   added to the message. Please note that according to the SPF
39857   draft, this header must be added at the top of the header
39858   list. Please see section 10 on how you can do this.
39859
39860   Note: in case of "Best-guess" (see below), the convention is
39861   to put this string in a header called X-SPF-Guess: instead.
39862
39863 .vitem &$spf_result$&
39864 .vindex &$spf_result$&
39865   This contains the outcome of the SPF check in string form,
39866   one of pass, fail, softfail, none, neutral, permerror or
39867   temperror.
39868
39869 .vitem &$spf_result_guessed$&
39870 .vindex &$spf_result_guessed$&
39871   This boolean is true only if a best-guess operation was used
39872   and required in order to obtain a result.
39873
39874 .vitem &$spf_smtp_comment$&
39875 .vindex &$spf_smtp_comment$&
39876   This contains a string that can be used in a SMTP response
39877   to the calling party. Useful for "fail".
39878 .endlist
39879
39880
39881 .cindex SPF "ACL condition"
39882 .cindex ACL "spf_guess condition"
39883 .cindex SPF "best guess"
39884 In addition to SPF, you can also perform checks for so-called
39885 "Best-guess".  Strictly speaking, "Best-guess" is not standard
39886 SPF, but it is supported by the same framework that enables SPF
39887 capability.
39888 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
39889 for a description of what it means.
39890 . --- 2018-09-07: still not https:
39891
39892 To access this feature, simply use the spf_guess condition in place
39893 of the spf one.  For example:
39894
39895 .code
39896 deny spf_guess = fail
39897      message = $sender_host_address doesn't look trustworthy to me
39898 .endd
39899
39900 In case you decide to reject messages based on this check, you
39901 should note that although it uses the same framework, "Best-guess"
39902 is not SPF, and therefore you should not mention SPF at all in your
39903 reject message.
39904
39905 When the spf_guess condition has run, it sets up the same expansion
39906 variables as when spf condition is run, described above.
39907
39908 Additionally, since Best-guess is not standardized, you may redefine
39909 what "Best-guess" means to you by redefining the main configuration
39910 &%spf_guess%& option.
39911 For example, the following:
39912
39913 .code
39914 spf_guess = v=spf1 a/16 mx/16 ptr ?all
39915 .endd
39916
39917 would relax host matching rules to a broader network range.
39918
39919
39920 .cindex SPF "lookup expansion"
39921 .cindex lookup spf
39922 A lookup expansion is also available. It takes an email
39923 address as the key and an IP address as the database:
39924
39925 .code
39926   ${lookup {username@domain} spf {ip.ip.ip.ip}}
39927 .endd
39928
39929 The lookup will return the same result strings as can appear in
39930 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
39931 Currently, only IPv4 addresses are supported.
39932
39933
39934
39935
39936 . ////////////////////////////////////////////////////////////////////////////
39937 . ////////////////////////////////////////////////////////////////////////////
39938
39939 .chapter "Proxies" "CHAPproxies" &&&
39940          "Proxy support"
39941 .cindex "proxy support"
39942 .cindex "proxy" "access via"
39943
39944 A proxy is an intermediate system through which communication is passed.
39945 Proxies may provide a security, availability or load-distribution function.
39946
39947
39948 .section "Inbound proxies" SECTproxyInbound
39949 .cindex proxy inbound
39950 .cindex proxy "server side"
39951 .cindex proxy "Proxy protocol"
39952 .cindex "Proxy protocol" proxy
39953
39954 Exim has support for receiving inbound SMTP connections via a proxy
39955 that uses &"Proxy Protocol"& to speak to it.
39956 To include this support, include &"SUPPORT_PROXY=yes"&
39957 in Local/Makefile.
39958
39959 It was built on the HAProxy specification, found at
39960 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
39961
39962 The purpose of this facility is so that an application load balancer,
39963 such as HAProxy, can sit in front of several Exim servers
39964 to distribute load.
39965 Exim uses the local protocol communication with the proxy to obtain
39966 the remote SMTP system IP address and port information.
39967 There is no logging if a host passes or
39968 fails Proxy Protocol negotiation, but it can easily be determined and
39969 recorded in an ACL (example is below).
39970
39971 Use of a proxy is enabled by setting the &%hosts_proxy%&
39972 main configuration option to a hostlist; connections from these
39973 hosts will use Proxy Protocol.
39974 Exim supports both version 1 and version 2 of the Proxy Protocol and
39975 automatically determines which version is in use.
39976
39977 The Proxy Protocol header is the first data received on a TCP connection
39978 and is inserted before any TLS-on-connect handshake from the client; Exim
39979 negotiates TLS between Exim-as-server and the remote client, not between
39980 Exim and the proxy server.
39981
39982 The following expansion variables are usable
39983 (&"internal"& and &"external"& here refer to the interfaces
39984 of the proxy):
39985 .display
39986 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
39987 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
39988 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
39989 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
39990 &'proxy_session            '& boolean: SMTP connection via proxy
39991 .endd
39992 If &$proxy_session$& is set but &$proxy_external_address$& is empty
39993 there was a protocol error.
39994
39995 Since the real connections are all coming from the proxy, and the
39996 per host connection tracking is done before Proxy Protocol is
39997 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
39998 handle all of the parallel volume you expect per inbound proxy.
39999 With the option set so high, you lose the ability
40000 to protect your server from many connections from one IP.
40001 In order to prevent your server from overload, you
40002 need to add a per connection ratelimit to your connect ACL.
40003 A possible solution is:
40004 .display
40005   # Set max number of connections per host
40006   LIMIT   = 5
40007   # Or do some kind of IP lookup in a flat file or database
40008   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40009
40010   defer   message        = Too many connections from this IP right now
40011           ratelimit      = LIMIT / 5s / per_conn / strict
40012 .endd
40013
40014
40015
40016 .section "Outbound proxies" SECTproxySOCKS
40017 .cindex proxy outbound
40018 .cindex proxy "client side"
40019 .cindex proxy SOCKS
40020 .cindex SOCKS proxy
40021 Exim has support for sending outbound SMTP via a proxy
40022 using a protocol called SOCKS5 (defined by RFC1928).
40023 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40024 Local/Makefile.
40025
40026 Use of a proxy is enabled by setting the &%socks_proxy%& option
40027 on an smtp transport.
40028 The option value is expanded and should then be a list
40029 (colon-separated by default) of proxy specifiers.
40030 Each proxy specifier is a list
40031 (space-separated by default) where the initial element
40032 is an IP address and any subsequent elements are options.
40033
40034 Options are a string <name>=<value>.
40035 The list of options is in the following table:
40036 .display
40037 &'auth   '& authentication method
40038 &'name   '& authentication username
40039 &'pass   '& authentication password
40040 &'port   '& tcp port
40041 &'tmo    '& connection timeout
40042 &'pri    '& priority
40043 &'weight '& selection bias
40044 .endd
40045
40046 More details on each of these options follows:
40047
40048 .ilist
40049 .cindex authentication "to proxy"
40050 .cindex proxy authentication
40051 &%auth%&: Either &"none"& (default) or &"name"&.
40052 Using &"name"& selects username/password authentication per RFC 1929
40053 for access to the proxy.
40054 Default is &"none"&.
40055 .next
40056 &%name%&: sets the username for the &"name"& authentication method.
40057 Default is empty.
40058 .next
40059 &%pass%&: sets the password for the &"name"& authentication method.
40060 Default is empty.
40061 .next
40062 &%port%&: the TCP port number to use for the connection to the proxy.
40063 Default is 1080.
40064 .next
40065 &%tmo%&: sets a connection timeout in seconds for this proxy.
40066 Default is 5.
40067 .next
40068 &%pri%&: specifies a priority for the proxy within the list,
40069 higher values being tried first.
40070 The default priority is 1.
40071 .next
40072 &%weight%&: specifies a selection bias.
40073 Within a priority set servers are queried in a random fashion,
40074 weighted by this value.
40075 The default value for selection bias is 1.
40076 .endlist
40077
40078 Proxies from the list are tried according to their priority
40079 and weight settings until one responds.  The timeout for the
40080 overall connection applies to the set of proxied attempts.
40081
40082 .section Logging SECTproxyLog
40083 To log the (local) IP of a proxy in the incoming or delivery logline,
40084 add &"+proxy"& to the &%log_selector%& option.
40085 This will add a component tagged with &"PRX="& to the line.
40086
40087 . ////////////////////////////////////////////////////////////////////////////
40088 . ////////////////////////////////////////////////////////////////////////////
40089
40090 .chapter "Internationalisation" "CHAPi18n" &&&
40091          "Internationalisation""
40092 .cindex internationalisation "email address"
40093 .cindex EAI
40094 .cindex i18n
40095 .cindex utf8 "mail name handling"
40096
40097 Exim has support for Internationalised mail names.
40098 To include this it must be built with SUPPORT_I18N and the libidn library.
40099 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40100
40101 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40102 instead of it) then IDNA2008 is supported; this adds an extra library
40103 requirement, upon libidn2.
40104
40105 .section "MTA operations" SECTi18nMTA
40106 .cindex SMTPUTF8 "ESMTP option"
40107 The main configuration option &%smtputf8_advertise_hosts%& specifies
40108 a host list.  If this matches the sending host and
40109 accept_8bitmime is true (the default) then the ESMTP option
40110 SMTPUTF8 will be advertised.
40111
40112 If the sender specifies the SMTPUTF8 option on a MAIL command
40113 international handling for the message is enabled and
40114 the expansion variable &$message_smtputf8$& will have value TRUE.
40115
40116 The option &%allow_utf8_domains%& is set to true for this
40117 message. All DNS lookups are converted to a-label form
40118 whatever the setting of &%allow_utf8_domains%&
40119 when Exim is built with SUPPORT_I18N.
40120
40121 Both localparts and domain are maintained as the original
40122 UTF-8 form internally; any comparison or regular-expression use will
40123 require appropriate care.  Filenames created, eg. by
40124 the appendfile transport, will have UTF-8 names.
40125
40126 HELO names sent by the smtp transport will have any UTF-8
40127 components expanded to a-label form,
40128 and any certificate name checks will be done using the a-label
40129 form of the name.
40130
40131 .cindex log protocol
40132 .cindex SMTPUTF8 logging
40133 .cindex i18n logging
40134 Log lines and Received-by: header lines will acquire a "utf8"
40135 prefix on the protocol element, eg. utf8esmtp.
40136
40137 The following expansion operators can be used:
40138 .code
40139 ${utf8_domain_to_alabel:str}
40140 ${utf8_domain_from_alabel:str}
40141 ${utf8_localpart_to_alabel:str}
40142 ${utf8_localpart_from_alabel:str}
40143 .endd
40144
40145 .cindex utf8 "address downconversion"
40146 .cindex i18n "utf8 address downconversion"
40147 The RCPT ACL
40148 may use the following modifier:
40149 .display
40150 control = utf8_downconvert
40151 control = utf8_downconvert/<value>
40152 .endd
40153 This sets a flag requiring that addresses are converted to
40154 a-label form before smtp delivery, for use in a
40155 Message Submission Agent context.
40156 If a value is appended it may be:
40157 .display
40158 &`1  `& (default) mandatory downconversion
40159 &`0  `& no downconversion
40160 &`-1 `& if SMTPUTF8 not supported by destination host
40161 .endd
40162
40163 If mua_wrapper is set, the utf8_downconvert control
40164 is initially set to -1.
40165
40166 .new
40167 The smtp transport has an option &%utf8_downconvert%&.
40168 If set it must expand to one of the three values described above,
40169 and it overrides any previously set value.
40170 .wen
40171
40172
40173 There is no explicit support for VRFY and EXPN.
40174 Configurations supporting these should inspect
40175 &$smtp_command_argument$& for an SMTPUTF8 argument.
40176
40177 There is no support for LMTP on Unix sockets.
40178 Using the "lmtp" protocol option on an smtp transport,
40179 for LMTP over TCP, should work as expected.
40180
40181 There is no support for DSN unitext handling,
40182 and no provision for converting logging from or to UTF-8.
40183
40184
40185
40186 .section "MDA operations" SECTi18nMDA
40187 To aid in constructing names suitable for IMAP folders
40188 the following expansion operator can be used:
40189 .code
40190 ${imapfolder {<string>} {<sep>} {<specials>}}
40191 .endd
40192
40193 The string is converted from the charset specified by
40194 the "headers charset" command (in a filter file)
40195 or &%headers_charset%& main configuration option (otherwise),
40196 to the
40197 modified UTF-7 encoding specified by RFC 2060,
40198 with the following exception: All occurrences of <sep>
40199 (which has to be a single character)
40200 are replaced with periods ("."), and all periods and slashes that are not
40201 <sep> and are not in the <specials> string are BASE64 encoded.
40202
40203 The third argument can be omitted, defaulting to an empty string.
40204 The second argument can be omitted, defaulting to "/".
40205
40206 This is the encoding used by Courier for Maildir names on disk, and followed
40207 by many other IMAP servers.
40208
40209 Examples:
40210 .display
40211 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
40212 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
40213 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
40214 .endd
40215
40216 Note that the source charset setting is vital, and also that characters
40217 must be representable in UTF-16.
40218
40219
40220 . ////////////////////////////////////////////////////////////////////////////
40221 . ////////////////////////////////////////////////////////////////////////////
40222
40223 .chapter "Events" "CHAPevents" &&&
40224          "Events"
40225 .cindex events
40226
40227 The events mechanism in Exim can be used to intercept processing at a number
40228 of points.  It was originally invented to give a way to do customised logging
40229 actions (for example, to a database) but can also be used to modify some
40230 processing actions.
40231
40232 Most installations will never need to use Events.
40233 The support can be left out of a build by defining DISABLE_EVENT=yes
40234 in &_Local/Makefile_&.
40235
40236 There are two major classes of events: main and transport.
40237 The main configuration option &%event_action%& controls reception events;
40238 a transport option &%event_action%& controls delivery events.
40239
40240 Both options are a string which is expanded when the event fires.
40241 An example might look like:
40242 .cindex logging custom
40243 .code
40244 event_action = ${if eq {msg:delivery}{$event_name} \
40245 {${lookup pgsql {SELECT * FROM record_Delivery( \
40246     '${quote_pgsql:$sender_address_domain}',\
40247     '${quote_pgsql:${lc:$sender_address_local_part}}', \
40248     '${quote_pgsql:$domain}', \
40249     '${quote_pgsql:${lc:$local_part}}', \
40250     '${quote_pgsql:$host_address}', \
40251     '${quote_pgsql:${lc:$host}}', \
40252     '${quote_pgsql:$message_exim_id}')}} \
40253 } {}}
40254 .endd
40255
40256 Events have names which correspond to the point in process at which they fire.
40257 The name is placed in the variable &$event_name$& and the event action
40258 expansion must check this, as it will be called for every possible event type.
40259
40260 The current list of events is:
40261 .display
40262 &`dane:fail              after    transport  `& per connection
40263 &`msg:complete           after    main       `& per message
40264 &`msg:delivery           after    transport  `& per recipient
40265 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
40266 &`msg:rcpt:defer         after    transport  `& per recipient
40267 &`msg:host:defer         after    transport  `& per attempt
40268 &`msg:fail:delivery      after    transport  `& per recipient
40269 &`msg:fail:internal      after    main       `& per recipient
40270 &`tcp:connect            before   transport  `& per connection
40271 &`tcp:close              after    transport  `& per connection
40272 &`tls:cert               before   both       `& per certificate in verification chain
40273 &`smtp:connect           after    transport  `& per connection
40274 .endd
40275 New event types may be added in future.
40276
40277 The event name is a colon-separated list, defining the type of
40278 event in a tree of possibilities.  It may be used as a list
40279 or just matched on as a whole.  There will be no spaces in the name.
40280
40281 The second column in the table above describes whether the event fires
40282 before or after the action is associates with.  Those which fire before
40283 can be used to affect that action (more on this below).
40284
40285 The third column in the table above says what section of the configuration
40286 should define the event action.
40287
40288 An additional variable, &$event_data$&, is filled with information varying
40289 with the event type:
40290 .display
40291 &`dane:fail            `& failure reason
40292 &`msg:delivery         `& smtp confirmation message
40293 &`msg:fail:internal    `& failure reason
40294 &`msg:fail:delivery    `& smtp error message
40295 &`msg:rcpt:host:defer  `& error string
40296 &`msg:rcpt:defer       `& error string
40297 &`msg:host:defer       `& error string
40298 &`tls:cert             `& verification chain depth
40299 &`smtp:connect         `& smtp banner
40300 .endd
40301
40302 The :defer events populate one extra variable: &$event_defer_errno$&.
40303
40304 For complex operations an ACL expansion can be used in &%event_action%&
40305 however due to the multiple contexts that Exim operates in during
40306 the course of its processing:
40307 .ilist
40308 variables set in transport events will not be visible outside that
40309 transport call
40310 .next
40311 acl_m variables in a server context are lost on a new connection,
40312 and after smtp helo/ehlo/mail/starttls/rset commands
40313 .endlist
40314 Using an ACL expansion with the logwrite modifier can be
40315 a useful way of writing to the main log.
40316
40317 The expansion of the event_action option should normally
40318 return an empty string.  Should it return anything else the
40319 following will be forced:
40320 .display
40321 &`tcp:connect      `&  do not connect
40322 &`tls:cert         `&  refuse verification
40323 &`smtp:connect     `&  close connection
40324 .endd
40325 All other message types ignore the result string, and
40326 no other use is made of it.
40327
40328 For a tcp:connect event, if the connection is being made to a proxy
40329 then the address and port variables will be that of the proxy and not
40330 the target system.
40331
40332 For tls:cert events, if GnuTLS is in use this will trigger only per
40333 chain element received on the connection.
40334 For OpenSSL it will trigger for every chain element including those
40335 loaded locally.
40336
40337 . ////////////////////////////////////////////////////////////////////////////
40338 . ////////////////////////////////////////////////////////////////////////////
40339
40340 .chapter "Adding new drivers or lookup types" "CHID13" &&&
40341          "Adding drivers or lookups"
40342 .cindex "adding drivers"
40343 .cindex "new drivers, adding"
40344 .cindex "drivers" "adding new"
40345 The following actions have to be taken in order to add a new router, transport,
40346 authenticator, or lookup type to Exim:
40347
40348 .olist
40349 Choose a name for the driver or lookup type that does not conflict with any
40350 existing name; I will use &"newdriver"& in what follows.
40351 .next
40352 Add to &_src/EDITME_& the line:
40353 .display
40354 <&'type'&>&`_NEWDRIVER=yes`&
40355 .endd
40356 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
40357 code is not to be included in the binary by default, comment this line out. You
40358 should also add any relevant comments about the driver or lookup type.
40359 .next
40360 Add to &_src/config.h.defaults_& the line:
40361 .code
40362 #define <type>_NEWDRIVER
40363 .endd
40364 .next
40365 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
40366 and create a table entry as is done for all the other drivers and lookup types.
40367 .next
40368 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
40369 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
40370 Add your &`NEWDRIVER`& to that list.
40371 As long as the dynamic module would be named &_newdriver.so_&, you can use the
40372 simple form that most lookups have.
40373 .next
40374 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
40375 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
40376 driver or lookup type and add it to the definition of OBJ.
40377 .next
40378 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
40379 &_src_&.
40380 .next
40381 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
40382 as for other drivers and lookups.
40383 .endlist
40384
40385 Then all you need to do is write the code! A good way to start is to make a
40386 proforma by copying an existing module of the same type, globally changing all
40387 occurrences of the name, and cutting out most of the code. Note that any
40388 options you create must be listed in alphabetical order, because the tables are
40389 searched using a binary chop procedure.
40390
40391 There is a &_README_& file in each of the sub-directories of &_src_& describing
40392 the interface that is expected.
40393
40394
40395
40396
40397 . ////////////////////////////////////////////////////////////////////////////
40398 . ////////////////////////////////////////////////////////////////////////////
40399
40400 . /////////////////////////////////////////////////////////////////////////////
40401 . These lines are processing instructions for the Simple DocBook Processor that
40402 . Philip Hazel has developed as a less cumbersome way of making PostScript and
40403 . PDFs than using xmlto and fop. They will be ignored by all other XML
40404 . processors.
40405 . /////////////////////////////////////////////////////////////////////////////
40406
40407 .literal xml
40408 <?sdop
40409   format="newpage"
40410   foot_right_recto="&chaptertitle;"
40411   foot_right_verso="&chaptertitle;"
40412 ?>
40413 .literal off
40414
40415 .makeindex "Options index"   "option"
40416 .makeindex "Variables index" "variable"
40417 .makeindex "Concept index"   "concept"
40418
40419
40420 . /////////////////////////////////////////////////////////////////////////////
40421 . /////////////////////////////////////////////////////////////////////////////